Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/lwip/include/netif/etharp.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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