Arlindo Montagnoli / Mbed 2 deprecated ProjetoBB

ProjetoBB

Dependencies:   F7_Ethernet WebSocketClient mbed mcp3008

Fork of Nucleo_F746ZG_Ethernet by Dieter Graef

F7_Ethernet/lwip/include/netif/etharp.h@0:f9b6112278fe, 2016-06-18 (annotated)

Committer:
DieterGraef
Date:
Sat Jun 18 10:49:12 2016 +0000
Revision:
0:f9b6112278fe
Ethernet for the NUCLEO STM32F746 Board Testprogram uses DHCP and NTP to set the clock

Who changed what in which revision?

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