Michael Spencer / Mbed 2 deprecated LaOS

Dependencies:   mbed

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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