Pranav Sawant
12Oct2012MbedLab
Fork of
EthernetNetIf
by 
Donatien Garnier
LPC2368/lwip/include/netif/etharp.h@5:bc7df6da7589, 2010-08-05 (annotated)
- Committer:
- donatien
- Date:
- Thu Aug 05 15:09:22 2010 +0000
- Revision:
- 5:bc7df6da7589
- Parent:
- 0:422060928e37
- Child:
- 6:22ce63eddd2b
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:422060928e37 | 1 | /* |
| donatien | 0:422060928e37 | 2 | * Copyright (c) 2001-2003 Swedish Institute of Computer Science. |
| donatien | 0:422060928e37 | 3 | * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv> |
| donatien | 0:422060928e37 | 4 | * Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands. |
| donatien | 0:422060928e37 | 5 | * All rights reserved. |
| donatien | 0:422060928e37 | 6 | * |
| donatien | 0:422060928e37 | 7 | * Redistribution and use in source and binary forms, with or without modification, |
| donatien | 0:422060928e37 | 8 | * are permitted provided that the following conditions are met: |
| donatien | 0:422060928e37 | 9 | * |
| donatien | 0:422060928e37 | 10 | * 1. Redistributions of source code must retain the above copyright notice, |
| donatien | 0:422060928e37 | 11 | * this list of conditions and the following disclaimer. |
| donatien | 0:422060928e37 | 12 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
| donatien | 0:422060928e37 | 13 | * this list of conditions and the following disclaimer in the documentation |
| donatien | 0:422060928e37 | 14 | * and/or other materials provided with the distribution. |
| donatien | 0:422060928e37 | 15 | * 3. The name of the author may not be used to endorse or promote products |
| donatien | 0:422060928e37 | 16 | * derived from this software without specific prior written permission. |
| donatien | 0:422060928e37 | 17 | * |
| donatien | 0:422060928e37 | 18 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| donatien | 0:422060928e37 | 19 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| donatien | 0:422060928e37 | 20 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| donatien | 0:422060928e37 | 21 | * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| donatien | 0:422060928e37 | 22 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| donatien | 0:422060928e37 | 23 | * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| donatien | 0:422060928e37 | 24 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| donatien | 0:422060928e37 | 25 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| donatien | 0:422060928e37 | 26 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| donatien | 0:422060928e37 | 27 | * OF SUCH DAMAGE. |
| donatien | 0:422060928e37 | 28 | * |
| donatien | 0:422060928e37 | 29 | * This file is part of the lwIP TCP/IP stack. |
| donatien | 0:422060928e37 | 30 | * |
| donatien | 0:422060928e37 | 31 | * Author: Adam Dunkels <adam@sics.se> |
| donatien | 0:422060928e37 | 32 | * |
| donatien | 0:422060928e37 | 33 | */ |
| donatien | 0:422060928e37 | 34 | |
| donatien | 0:422060928e37 | 35 | #ifndef __NETIF_ETHARP_H__ |
| donatien | 0:422060928e37 | 36 | #define __NETIF_ETHARP_H__ |
| donatien | 0:422060928e37 | 37 | |
| donatien | 0:422060928e37 | 38 | #include "lwip/opt.h" |
| donatien | 0:422060928e37 | 39 | |
| donatien | 0:422060928e37 | 40 | #if LWIP_ARP || LWIP_ETHERNET /* don't build if not configured for use in lwipopts.h */ |
| donatien | 0:422060928e37 | 41 | |
| donatien | 0:422060928e37 | 42 | #include "lwip/pbuf.h" |
| donatien | 0:422060928e37 | 43 | #include "lwip/ip_addr.h" |
| donatien | 0:422060928e37 | 44 | #include "lwip/netif.h" |
| donatien | 0:422060928e37 | 45 | #include "lwip/ip.h" |
| donatien | 0:422060928e37 | 46 | |
| donatien | 0:422060928e37 | 47 | #ifdef __cplusplus |
| donatien | 0:422060928e37 | 48 | extern "C" { |
| donatien | 0:422060928e37 | 49 | #endif |
| donatien | 0:422060928e37 | 50 | |
| donatien | 0:422060928e37 | 51 | #ifndef ETHARP_HWADDR_LEN |
| donatien | 0:422060928e37 | 52 | #define ETHARP_HWADDR_LEN 6 |
| donatien | 0:422060928e37 | 53 | #endif |
| donatien | 0:422060928e37 | 54 | |
| donatien | 0:422060928e37 | 55 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 56 | # include "arch/bpstruct.h" |
| donatien | 0:422060928e37 | 57 | #endif |
| donatien | 0:422060928e37 | 58 | PACK_STRUCT_BEGIN |
| donatien | 0:422060928e37 | 59 | struct eth_addr { |
| donatien | 0:422060928e37 | 60 | PACK_STRUCT_FIELD(u8_t addr[ETHARP_HWADDR_LEN]); |
| donatien | 0:422060928e37 | 61 | } PACK_STRUCT_STRUCT; |
| donatien | 0:422060928e37 | 62 | PACK_STRUCT_END |
| donatien | 0:422060928e37 | 63 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 64 | # include "arch/epstruct.h" |
| donatien | 0:422060928e37 | 65 | #endif |
| donatien | 0:422060928e37 | 66 | |
| donatien | 0:422060928e37 | 67 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 68 | # include "arch/bpstruct.h" |
| donatien | 0:422060928e37 | 69 | #endif |
| donatien | 0:422060928e37 | 70 | PACK_STRUCT_BEGIN |
| donatien | 5:bc7df6da7589 | 71 | /* Ethernet header */ |
| donatien | 0:422060928e37 | 72 | struct eth_hdr { |
| donatien | 0:422060928e37 | 73 | #if ETH_PAD_SIZE |
| donatien | 0:422060928e37 | 74 | PACK_STRUCT_FIELD(u8_t padding[ETH_PAD_SIZE]); |
| donatien | 0:422060928e37 | 75 | #endif |
| donatien | 0:422060928e37 | 76 | PACK_STRUCT_FIELD(struct eth_addr dest); |
| donatien | 0:422060928e37 | 77 | PACK_STRUCT_FIELD(struct eth_addr src); |
| donatien | 0:422060928e37 | 78 | PACK_STRUCT_FIELD(u16_t type); |
| donatien | 0:422060928e37 | 79 | } PACK_STRUCT_STRUCT; |
| donatien | 0:422060928e37 | 80 | PACK_STRUCT_END |
| donatien | 0:422060928e37 | 81 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 82 | # include "arch/epstruct.h" |
| donatien | 0:422060928e37 | 83 | #endif |
| donatien | 0:422060928e37 | 84 | |
| donatien | 0:422060928e37 | 85 | #define SIZEOF_ETH_HDR (14 + ETH_PAD_SIZE) |
| donatien | 0:422060928e37 | 86 | |
| donatien | 0:422060928e37 | 87 | #if ETHARP_SUPPORT_VLAN |
| donatien | 0:422060928e37 | 88 | |
| donatien | 0:422060928e37 | 89 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 90 | # include "arch/bpstruct.h" |
| donatien | 0:422060928e37 | 91 | #endif |
| donatien | 0:422060928e37 | 92 | PACK_STRUCT_BEGIN |
| donatien | 5:bc7df6da7589 | 93 | /* VLAN header inserted between ethernet header and payload |
| donatien | 0:422060928e37 | 94 | * if 'type' in ethernet header is ETHTYPE_VLAN. |
| donatien | 0:422060928e37 | 95 | * See IEEE802.Q */ |
| donatien | 0:422060928e37 | 96 | struct eth_vlan_hdr { |
| donatien | 0:422060928e37 | 97 | PACK_STRUCT_FIELD(u16_t tpid); |
| donatien | 0:422060928e37 | 98 | PACK_STRUCT_FIELD(u16_t prio_vid); |
| donatien | 0:422060928e37 | 99 | } PACK_STRUCT_STRUCT; |
| donatien | 0:422060928e37 | 100 | PACK_STRUCT_END |
| donatien | 0:422060928e37 | 101 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 102 | # include "arch/epstruct.h" |
| donatien | 0:422060928e37 | 103 | #endif |
| donatien | 0:422060928e37 | 104 | |
| donatien | 0:422060928e37 | 105 | #define SIZEOF_VLAN_HDR 4 |
| donatien | 0:422060928e37 | 106 | #define VLAN_ID(vlan_hdr) (htons((vlan_hdr)->prio_vid) & 0xFFF) |
| donatien | 0:422060928e37 | 107 | |
| donatien | 0:422060928e37 | 108 | #endif /* ETHARP_SUPPORT_VLAN */ |
| donatien | 0:422060928e37 | 109 | |
| donatien | 0:422060928e37 | 110 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 111 | # include "arch/bpstruct.h" |
| donatien | 0:422060928e37 | 112 | #endif |
| donatien | 0:422060928e37 | 113 | PACK_STRUCT_BEGIN |
| donatien | 5:bc7df6da7589 | 114 | /* the ARP message, see RFC 826 ("Packet format") */ |
| donatien | 0:422060928e37 | 115 | struct etharp_hdr { |
| donatien | 0:422060928e37 | 116 | PACK_STRUCT_FIELD(u16_t hwtype); |
| donatien | 0:422060928e37 | 117 | PACK_STRUCT_FIELD(u16_t proto); |
| donatien | 5:bc7df6da7589 | 118 | PACK_STRUCT_FIELD(u8_t hwlen); |
| donatien | 5:bc7df6da7589 | 119 | PACK_STRUCT_FIELD(u8_t protolen); |
| donatien | 0:422060928e37 | 120 | PACK_STRUCT_FIELD(u16_t opcode); |
| donatien | 0:422060928e37 | 121 | PACK_STRUCT_FIELD(struct eth_addr shwaddr); |
| donatien | 0:422060928e37 | 122 | PACK_STRUCT_FIELD(struct ip_addr2 sipaddr); |
| donatien | 0:422060928e37 | 123 | PACK_STRUCT_FIELD(struct eth_addr dhwaddr); |
| donatien | 0:422060928e37 | 124 | PACK_STRUCT_FIELD(struct ip_addr2 dipaddr); |
| donatien | 0:422060928e37 | 125 | } PACK_STRUCT_STRUCT; |
| donatien | 0:422060928e37 | 126 | PACK_STRUCT_END |
| donatien | 0:422060928e37 | 127 | #ifdef PACK_STRUCT_USE_INCLUDES |
| donatien | 0:422060928e37 | 128 | # include "arch/epstruct.h" |
| donatien | 0:422060928e37 | 129 | #endif |
| donatien | 0:422060928e37 | 130 | |
| donatien | 0:422060928e37 | 131 | #define SIZEOF_ETHARP_HDR 28 |
| donatien | 0:422060928e37 | 132 | #define SIZEOF_ETHARP_PACKET (SIZEOF_ETH_HDR + SIZEOF_ETHARP_HDR) |
| donatien | 0:422060928e37 | 133 | |
| donatien | 5:bc7df6da7589 | 134 | /* 5 seconds period */ |
| donatien | 0:422060928e37 | 135 | #define ARP_TMR_INTERVAL 5000 |
| donatien | 0:422060928e37 | 136 | |
| donatien | 0:422060928e37 | 137 | #define ETHTYPE_ARP 0x0806 |
| donatien | 0:422060928e37 | 138 | #define ETHTYPE_IP 0x0800 |
| donatien | 0:422060928e37 | 139 | #define ETHTYPE_VLAN 0x8100 |
| donatien | 0:422060928e37 | 140 | #define ETHTYPE_PPPOEDISC 0x8863 /* PPP Over Ethernet Discovery Stage */ |
| donatien | 0:422060928e37 | 141 | #define ETHTYPE_PPPOE 0x8864 /* PPP Over Ethernet Session Stage */ |
| donatien | 0:422060928e37 | 142 | |
| donatien | 5:bc7df6da7589 | 143 | /* MEMCPY-like macro to copy to/from struct eth_addr's that are local variables |
| donatien | 5:bc7df6da7589 | 144 | * or known to be 32-bit aligned within the protocol header. */ |
| donatien | 5:bc7df6da7589 | 145 | #ifndef ETHADDR32_COPY |
| donatien | 5:bc7df6da7589 | 146 | #define ETHADDR32_COPY(src, dst) SMEMCPY(src, dst, ETHARP_HWADDR_LEN) |
| donatien | 5:bc7df6da7589 | 147 | #endif |
| donatien | 5:bc7df6da7589 | 148 | |
| donatien | 5:bc7df6da7589 | 149 | /* MEMCPY-like macro to copy to/from struct eth_addr's that are no local |
| donatien | 5:bc7df6da7589 | 150 | * variables and known to be 16-bit aligned within the protocol header. */ |
| donatien | 5:bc7df6da7589 | 151 | #ifndef ETHADDR16_COPY |
| donatien | 5:bc7df6da7589 | 152 | #define ETHADDR16_COPY(src, dst) SMEMCPY(src, dst, ETHARP_HWADDR_LEN) |
| donatien | 5:bc7df6da7589 | 153 | #endif |
| donatien | 5:bc7df6da7589 | 154 | |
| donatien | 0:422060928e37 | 155 | #if LWIP_ARP /* don't build if not configured for use in lwipopts.h */ |
| donatien | 0:422060928e37 | 156 | |
| donatien | 5:bc7df6da7589 | 157 | /* ARP message types (opcodes) */ |
| donatien | 0:422060928e37 | 158 | #define ARP_REQUEST 1 |
| donatien | 0:422060928e37 | 159 | #define ARP_REPLY 2 |
| donatien | 0:422060928e37 | 160 | |
| donatien | 5:bc7df6da7589 | 161 | /* Define this to 1 and define LWIP_ARP_FILTER_NETIF_FN(pbuf, netif, type) |
| donatien | 5:bc7df6da7589 | 162 | * to a filter function that returns the correct netif when using multiple |
| donatien | 5:bc7df6da7589 | 163 | * netifs on one hardware interface where the netif's low-level receive |
| donatien | 5:bc7df6da7589 | 164 | * routine cannot decide for the correct netif (e.g. when mapping multiple |
| donatien | 5:bc7df6da7589 | 165 | * IP addresses to one hardware interface). |
| donatien | 5:bc7df6da7589 | 166 | */ |
| donatien | 5:bc7df6da7589 | 167 | #ifndef LWIP_ARP_FILTER_NETIF |
| donatien | 5:bc7df6da7589 | 168 | #define LWIP_ARP_FILTER_NETIF 0 |
| donatien | 5:bc7df6da7589 | 169 | #endif |
| donatien | 5:bc7df6da7589 | 170 | |
| donatien | 0:422060928e37 | 171 | #if ARP_QUEUEING |
| donatien | 5:bc7df6da7589 | 172 | /* struct for queueing outgoing packets for unknown address |
| donatien | 0:422060928e37 | 173 | * defined here to be accessed by memp.h |
| donatien | 0:422060928e37 | 174 | */ |
| donatien | 0:422060928e37 | 175 | struct etharp_q_entry { |
| donatien | 0:422060928e37 | 176 | struct etharp_q_entry *next; |
| donatien | 0:422060928e37 | 177 | struct pbuf *p; |
| donatien | 0:422060928e37 | 178 | }; |
| donatien | 0:422060928e37 | 179 | #endif /* ARP_QUEUEING */ |
| donatien | 0:422060928e37 | 180 | |
| donatien | 0:422060928e37 | 181 | #define etharp_init() /* Compatibility define, not init needed. */ |
| donatien | 0:422060928e37 | 182 | void etharp_tmr(void); |
| donatien | 0:422060928e37 | 183 | s8_t etharp_find_addr(struct netif *netif, ip_addr_t *ipaddr, |
| donatien | 0:422060928e37 | 184 | struct eth_addr **eth_ret, ip_addr_t **ip_ret); |
| donatien | 0:422060928e37 | 185 | err_t etharp_output(struct netif *netif, struct pbuf *q, ip_addr_t *ipaddr); |
| donatien | 0:422060928e37 | 186 | err_t etharp_query(struct netif *netif, ip_addr_t *ipaddr, struct pbuf *q); |
| donatien | 0:422060928e37 | 187 | err_t etharp_request(struct netif *netif, ip_addr_t *ipaddr); |
| donatien | 5:bc7df6da7589 | 188 | /* For Ethernet network interfaces, we might want to send "gratuitous ARP"; |
| donatien | 0:422060928e37 | 189 | * this is an ARP packet sent by a node in order to spontaneously cause other |
| donatien | 0:422060928e37 | 190 | * nodes to update an entry in their ARP cache. |
| donatien | 0:422060928e37 | 191 | * From RFC 3220 "IP Mobility Support for IPv4" section 4.6. */ |
| donatien | 0:422060928e37 | 192 | #define etharp_gratuitous(netif) etharp_request((netif), &(netif)->ip_addr) |
| donatien | 0:422060928e37 | 193 | |
| donatien | 5:bc7df6da7589 | 194 | #if ETHARP_SUPPORT_STATIC_ENTRIES |
| donatien | 5:bc7df6da7589 | 195 | err_t etharp_add_static_entry(ip_addr_t *ipaddr, struct eth_addr *ethaddr); |
| donatien | 5:bc7df6da7589 | 196 | err_t etharp_remove_static_entry(ip_addr_t *ipaddr); |
| donatien | 5:bc7df6da7589 | 197 | #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */ |
| donatien | 5:bc7df6da7589 | 198 | |
| donatien | 0:422060928e37 | 199 | #if LWIP_AUTOIP |
| donatien | 0:422060928e37 | 200 | err_t etharp_raw(struct netif *netif, const struct eth_addr *ethsrc_addr, |
| donatien | 0:422060928e37 | 201 | const struct eth_addr *ethdst_addr, |
| donatien | 0:422060928e37 | 202 | const struct eth_addr *hwsrc_addr, const ip_addr_t *ipsrc_addr, |
| donatien | 0:422060928e37 | 203 | const struct eth_addr *hwdst_addr, const ip_addr_t *ipdst_addr, |
| donatien | 0:422060928e37 | 204 | const u16_t opcode); |
| donatien | 0:422060928e37 | 205 | #endif /* LWIP_AUTOIP */ |
| donatien | 0:422060928e37 | 206 | |
| donatien | 0:422060928e37 | 207 | #endif /* LWIP_ARP */ |
| donatien | 0:422060928e37 | 208 | |
| donatien | 0:422060928e37 | 209 | err_t ethernet_input(struct pbuf *p, struct netif *netif); |
| donatien | 0:422060928e37 | 210 | |
| donatien | 0:422060928e37 | 211 | #define eth_addr_cmp(addr1, addr2) (memcmp((addr1)->addr, (addr2)->addr, ETHARP_HWADDR_LEN) == 0) |
| donatien | 0:422060928e37 | 212 | |
| donatien | 0:422060928e37 | 213 | extern const struct eth_addr ethbroadcast, ethzero; |
| donatien | 0:422060928e37 | 214 | |
| donatien | 0:422060928e37 | 215 | #ifdef __cplusplus |
| donatien | 0:422060928e37 | 216 | } |
| donatien | 0:422060928e37 | 217 | #endif |
| donatien | 0:422060928e37 | 218 | |
| donatien | 0:422060928e37 | 219 | #endif /* LWIP_ARP || LWIP_ETHERNET */ |
| donatien | 0:422060928e37 | 220 | |
| donatien | 0:422060928e37 | 221 | #endif /* __NETIF_ARP_H__ */ |