xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.0.2/src/include/lwip/prot/etharp.h (revision 042d53a763ad75cb1465103098bb88c245d95138)
1 /**
2  * @file
3  * ARP protocol definitions
4  */
5 
6 /*
7  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without modification,
11  * are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  *    this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  *    this list of conditions and the following disclaimer in the documentation
17  *    and/or other materials provided with the distribution.
18  * 3. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
22  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
23  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
24  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
26  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
29  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
30  * OF SUCH DAMAGE.
31  *
32  * This file is part of the lwIP TCP/IP stack.
33  *
34  * Author: Adam Dunkels <[email protected]>
35  *
36  */
37 #ifndef LWIP_HDR_PROT_ETHARP_H
38 #define LWIP_HDR_PROT_ETHARP_H
39 
40 #include "lwip/arch.h"
41 #include "lwip/prot/ethernet.h"
42 #include "lwip/ip4_addr.h"
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 #ifndef ETHARP_HWADDR_LEN
49 #define ETHARP_HWADDR_LEN     ETH_HWADDR_LEN
50 #endif
51 
52 #ifdef PACK_STRUCT_USE_INCLUDES
53 #  include "arch/bpstruct.h"
54 #endif
55 PACK_STRUCT_BEGIN
56 /** the ARP message, see RFC 826 ("Packet format") */
57 struct etharp_hdr {
58   PACK_STRUCT_FIELD(u16_t hwtype);
59   PACK_STRUCT_FIELD(u16_t proto);
60   PACK_STRUCT_FLD_8(u8_t  hwlen);
61   PACK_STRUCT_FLD_8(u8_t  protolen);
62   PACK_STRUCT_FIELD(u16_t opcode);
63   PACK_STRUCT_FLD_S(struct eth_addr shwaddr);
64   PACK_STRUCT_FLD_S(struct ip4_addr2 sipaddr);
65   PACK_STRUCT_FLD_S(struct eth_addr dhwaddr);
66   PACK_STRUCT_FLD_S(struct ip4_addr2 dipaddr);
67 } PACK_STRUCT_STRUCT;
68 PACK_STRUCT_END
69 #ifdef PACK_STRUCT_USE_INCLUDES
70 #  include "arch/epstruct.h"
71 #endif
72 
73 #define SIZEOF_ETHARP_HDR 28
74 
75 /* ARP hwtype values */
76 enum etharp_hwtype {
77   HWTYPE_ETHERNET = 1
78   /* others not used */
79 };
80 
81 /* ARP message types (opcodes) */
82 enum etharp_opcode {
83   ARP_REQUEST = 1,
84   ARP_REPLY   = 2
85 };
86 
87 #ifdef __cplusplus
88 }
89 #endif
90 
91 #endif /* LWIP_HDR_PROT_ETHARP_H */
92