sasa ivkovic / Mbed 2 deprecated LAN

testing of combination of LCS and LAN

Dependencies:   mbed

EthernetNetIf/LPC2368/lwip/include/netif/etharp.h@0:a7a6a692162f, 2015-01-14 (annotated)

Committer:
damir
Date:
Wed Jan 14 13:29:55 2015 +0000
Revision:
0:a7a6a692162f
Test of LAN

Who changed what in which revision?

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