etharp.h

00001 /*
00002  * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
00003  * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>
00004  * Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands.
00005  * All rights reserved. 
00006  * 
00007  * Redistribution and use in source and binary forms, with or without modification, 
00008  * are permitted provided that the following conditions are met:
00009  *
00010  * 1. Redistributions of source code must retain the above copyright notice,
00011  *    this list of conditions and the following disclaimer.
00012  * 2. Redistributions in binary form must reproduce the above copyright notice,
00013  *    this list of conditions and the following disclaimer in the documentation
00014  *    and/or other materials provided with the distribution.
00015  * 3. The name of the author may not be used to endorse or promote products
00016  *    derived from this software without specific prior written permission. 
00017  *
00018  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
00019  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
00020  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
00021  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
00022  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
00023  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
00026  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
00027  * OF SUCH DAMAGE.
00028  *
00029  * This file is part of the lwIP TCP/IP stack.
00030  * 
00031  * Author: Adam Dunkels <adam@sics.se>
00032  *
00033  */
00034 
00035 #ifndef __NETIF_ETHARP_H__
00036 #define __NETIF_ETHARP_H__
00037 
00038 #include "lwip/opt.h"
00039 
00040 #if LWIP_ARP || LWIP_ETHERNET /* don't build if not configured for use in lwipopts.h */
00041 
00042 #include "lwip/pbuf.h"
00043 #include "lwip/ip_addr.h"
00044 #include "lwip/netif.h"
00045 #include "lwip/ip.h"
00046 
00047 #ifdef __cplusplus
00048 extern "C" {
00049 #endif
00050 
00051 #ifndef ETHARP_HWADDR_LEN
00052 #define ETHARP_HWADDR_LEN     6
00053 #endif
00054 
00055 #ifdef PACK_STRUCT_USE_INCLUDES
00056 #  include "arch/bpstruct.h"
00057 #endif
00058 PACK_STRUCT_BEGIN
00059 struct eth_addr {
00060   PACK_STRUCT_FIELD(u8_t addr[ETHARP_HWADDR_LEN]);
00061 } PACK_STRUCT_STRUCT;
00062 PACK_STRUCT_END
00063 #ifdef PACK_STRUCT_USE_INCLUDES
00064 #  include "arch/epstruct.h"
00065 #endif
00066 
00067 #ifdef PACK_STRUCT_USE_INCLUDES
00068 #  include "arch/bpstruct.h"
00069 #endif
00070 PACK_STRUCT_BEGIN
00071 /** Ethernet header */
00072 struct eth_hdr {
00073 #if ETH_PAD_SIZE
00074   PACK_STRUCT_FIELD(u8_t padding[ETH_PAD_SIZE]);
00075 #endif
00076   PACK_STRUCT_FIELD(struct eth_addr dest);
00077   PACK_STRUCT_FIELD(struct eth_addr src);
00078   PACK_STRUCT_FIELD(u16_t type);
00079 } PACK_STRUCT_STRUCT;
00080 PACK_STRUCT_END
00081 #ifdef PACK_STRUCT_USE_INCLUDES
00082 #  include "arch/epstruct.h"
00083 #endif
00084 
00085 #define SIZEOF_ETH_HDR (14 + ETH_PAD_SIZE)
00086 
00087 #if ETHARP_SUPPORT_VLAN
00088 
00089 #ifdef PACK_STRUCT_USE_INCLUDES
00090 #  include "arch/bpstruct.h"
00091 #endif
00092 PACK_STRUCT_BEGIN
00093 /** VLAN header inserted between ethernet header and payload
00094  * if 'type' in ethernet header is ETHTYPE_VLAN.
00095  * See IEEE802.Q */
00096 struct eth_vlan_hdr {
00097   PACK_STRUCT_FIELD(u16_t prio_vid);
00098   PACK_STRUCT_FIELD(u16_t tpid);
00099 } PACK_STRUCT_STRUCT;
00100 PACK_STRUCT_END
00101 #ifdef PACK_STRUCT_USE_INCLUDES
00102 #  include "arch/epstruct.h"
00103 #endif
00104 
00105 #define SIZEOF_VLAN_HDR 4
00106 #define VLAN_ID(vlan_hdr) (htons((vlan_hdr)->prio_vid) & 0xFFF)
00107 
00108 #endif /* ETHARP_SUPPORT_VLAN */
00109 
00110 #ifdef PACK_STRUCT_USE_INCLUDES
00111 #  include "arch/bpstruct.h"
00112 #endif
00113 PACK_STRUCT_BEGIN
00114 /** the ARP message, see RFC 826 ("Packet format") */
00115 struct etharp_hdr {
00116   PACK_STRUCT_FIELD(u16_t hwtype);
00117   PACK_STRUCT_FIELD(u16_t proto);
00118   PACK_STRUCT_FIELD(u8_t  hwlen);
00119   PACK_STRUCT_FIELD(u8_t  protolen);
00120   PACK_STRUCT_FIELD(u16_t opcode);
00121   PACK_STRUCT_FIELD(struct eth_addr shwaddr);
00122   PACK_STRUCT_FIELD(struct ip_addr2 sipaddr);
00123   PACK_STRUCT_FIELD(struct eth_addr dhwaddr);
00124   PACK_STRUCT_FIELD(struct ip_addr2 dipaddr);
00125 } PACK_STRUCT_STRUCT;
00126 PACK_STRUCT_END
00127 #ifdef PACK_STRUCT_USE_INCLUDES
00128 #  include "arch/epstruct.h"
00129 #endif
00130 
00131 #define SIZEOF_ETHARP_HDR 28
00132 #define SIZEOF_ETHARP_PACKET (SIZEOF_ETH_HDR + SIZEOF_ETHARP_HDR)
00133 
00134 /** 5 seconds period */
00135 #define ARP_TMR_INTERVAL 5000
00136 
00137 #define ETHTYPE_ARP       0x0806U
00138 #define ETHTYPE_IP        0x0800U
00139 #define ETHTYPE_VLAN      0x8100U
00140 #define ETHTYPE_PPPOEDISC 0x8863U  /* PPP Over Ethernet Discovery Stage */
00141 #define ETHTYPE_PPPOE     0x8864U  /* PPP Over Ethernet Session Stage */
00142 
00143 /** MEMCPY-like macro to copy to/from struct eth_addr's that are local variables
00144  * or known to be 32-bit aligned within the protocol header. */
00145 #ifndef ETHADDR32_COPY
00146 #define ETHADDR32_COPY(src, dst)  SMEMCPY(src, dst, ETHARP_HWADDR_LEN)
00147 #endif
00148 
00149 /** MEMCPY-like macro to copy to/from struct eth_addr's that are no local
00150  * variables and known to be 16-bit aligned within the protocol header. */
00151 #ifndef ETHADDR16_COPY
00152 #define ETHADDR16_COPY(src, dst)  SMEMCPY(src, dst, ETHARP_HWADDR_LEN)
00153 #endif
00154 
00155 #if LWIP_ARP /* don't build if not configured for use in lwipopts.h */
00156 
00157 /** ARP message types (opcodes) */
00158 #define ARP_REQUEST 1
00159 #define ARP_REPLY   2
00160 
00161 /** Define this to 1 and define LWIP_ARP_FILTER_NETIF_FN(pbuf, netif, type)
00162  * to a filter function that returns the correct netif when using multiple
00163  * netifs on one hardware interface where the netif's low-level receive
00164  * routine cannot decide for the correct netif (e.g. when mapping multiple
00165  * IP addresses to one hardware interface).
00166  */
00167 #ifndef LWIP_ARP_FILTER_NETIF
00168 #define LWIP_ARP_FILTER_NETIF 0
00169 #endif
00170 
00171 #if ARP_QUEUEING
00172 /** struct for queueing outgoing packets for unknown address
00173   * defined here to be accessed by memp.h
00174   */
00175 struct etharp_q_entry {
00176   struct etharp_q_entry *next;
00177   struct pbuf *p;
00178 };
00179 #endif /* ARP_QUEUEING */
00180 
00181 #define etharp_init() /* Compatibility define, not init needed. */
00182 void etharp_tmr(void);
00183 s8_t etharp_find_addr(struct netif *netif, ip_addr_t *ipaddr,
00184          struct eth_addr **eth_ret, ip_addr_t **ip_ret);
00185 err_t etharp_output(struct netif *netif, struct pbuf *q, ip_addr_t *ipaddr);
00186 err_t etharp_query(struct netif *netif, ip_addr_t *ipaddr, struct pbuf *q);
00187 err_t etharp_request(struct netif *netif, ip_addr_t *ipaddr);
00188 /** For Ethernet network interfaces, we might want to send "gratuitous ARP";
00189  *  this is an ARP packet sent by a node in order to spontaneously cause other
00190  *  nodes to update an entry in their ARP cache.
00191  *  From RFC 3220 "IP Mobility Support for IPv4" section 4.6. */
00192 #define etharp_gratuitous(netif) etharp_request((netif), &(netif)->ip_addr)
00193 
00194 #if ETHARP_SUPPORT_STATIC_ENTRIES
00195 err_t etharp_add_static_entry(ip_addr_t *ipaddr, struct eth_addr *ethaddr);
00196 err_t etharp_remove_static_entry(ip_addr_t *ipaddr);
00197 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
00198 
00199 #if LWIP_AUTOIP
00200 err_t etharp_raw(struct netif *netif, const struct eth_addr *ethsrc_addr,
00201                  const struct eth_addr *ethdst_addr,
00202                  const struct eth_addr *hwsrc_addr, const ip_addr_t *ipsrc_addr,
00203                  const struct eth_addr *hwdst_addr, const ip_addr_t *ipdst_addr,
00204                  const u16_t opcode);
00205 #endif /* LWIP_AUTOIP */
00206 
00207 #endif /* LWIP_ARP */
00208 
00209 err_t ethernet_input(struct pbuf *p, struct netif *netif);
00210 
00211 #define eth_addr_cmp(addr1, addr2) (memcmp((addr1)->addr, (addr2)->addr, ETHARP_HWADDR_LEN) == 0)
00212 
00213 extern const struct eth_addr ethbroadcast, ethzero;
00214 
00215 #ifdef __cplusplus
00216 }
00217 #endif
00218 
00219 #endif /* LWIP_ARP || LWIP_ETHERNET */
00220 
00221 #endif /* __NETIF_ARP_H__ */