1/* 2 * Copyright (c) 2001-2003 Swedish Institute of Computer Science. 3 * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv> 4 * Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without modification, 8 * are permitted provided that the following conditions are met: 9 * 10 * 1. Redistributions of source code must retain the above copyright notice, 11 * this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright notice, 13 * this list of conditions and the following disclaimer in the documentation 14 * and/or other materials provided with the distribution. 15 * 3. The name of the author may not be used to endorse or promote products 16 * derived from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 27 * OF SUCH DAMAGE. 28 * 29 * This file is part of the lwIP TCP/IP stack. 30 * 31 * Author: Adam Dunkels <adam@sics.se> 32 * 33 */ 34 35#ifndef __NETIF_ETHARP_H__ 36#define __NETIF_ETHARP_H__ 37 38#include "lwip/opt.h" 39 40#if LWIP_ARP /* don't build if not configured for use in lwipopts.h */ 41 42#include "lwip/pbuf.h" 43#include "lwip/ip_addr.h" 44#include "lwip/netif.h" 45#include "lwip/ip.h" 46#include <stdbool.h> 47 48#ifdef __cplusplus 49extern "C" { 50#endif 51 52#ifndef ETH_PAD_SIZE 53#define ETH_PAD_SIZE 0 54#endif 55 56#ifndef ETHARP_HWADDR_LEN 57#define ETHARP_HWADDR_LEN 6 58#endif 59 60#ifdef PACK_STRUCT_USE_INCLUDES 61#include "arch/bpstruct.h" 62#endif 63 PACK_STRUCT_BEGIN struct eth_addr { 64 PACK_STRUCT_FIELD(u8_t addr[ETHARP_HWADDR_LEN]); 65 } PACK_STRUCT_STRUCT; 66 PACK_STRUCT_END 67#ifdef PACK_STRUCT_USE_INCLUDES 68#include "arch/epstruct.h" 69#endif 70#ifdef PACK_STRUCT_USE_INCLUDES 71#include "arch/bpstruct.h" 72#endif 73 PACK_STRUCT_BEGIN struct eth_hdr { 74#if ETH_PAD_SIZE 75 PACK_STRUCT_FIELD(u8_t padding[ETH_PAD_SIZE]); 76#endif 77 PACK_STRUCT_FIELD(struct eth_addr dest); 78 PACK_STRUCT_FIELD(struct eth_addr src); 79 PACK_STRUCT_FIELD(u16_t type); 80 } PACK_STRUCT_STRUCT; 81 PACK_STRUCT_END 82#ifdef PACK_STRUCT_USE_INCLUDES 83#include "arch/epstruct.h" 84#endif 85#ifdef PACK_STRUCT_USE_INCLUDES 86#include "arch/bpstruct.h" 87#endif 88 PACK_STRUCT_BEGIN 89/** the ARP message */ 90 struct etharp_hdr { 91 PACK_STRUCT_FIELD(struct eth_hdr ethhdr); 92 PACK_STRUCT_FIELD(u16_t hwtype); 93 PACK_STRUCT_FIELD(u16_t proto); 94 PACK_STRUCT_FIELD(u16_t _hwlen_protolen); 95 PACK_STRUCT_FIELD(u16_t opcode); 96 PACK_STRUCT_FIELD(struct eth_addr shwaddr); 97 PACK_STRUCT_FIELD(struct ip_addr2 sipaddr); 98 PACK_STRUCT_FIELD(struct eth_addr dhwaddr); 99 PACK_STRUCT_FIELD(struct ip_addr2 dipaddr); 100 } PACK_STRUCT_STRUCT; 101 PACK_STRUCT_END 102#ifdef PACK_STRUCT_USE_INCLUDES 103#include "arch/epstruct.h" 104#endif 105#ifdef PACK_STRUCT_USE_INCLUDES 106#include "arch/bpstruct.h" 107#endif 108 PACK_STRUCT_BEGIN struct ethip_hdr { 109 PACK_STRUCT_FIELD(struct eth_hdr eth); 110 PACK_STRUCT_FIELD(struct ip_hdr ip); 111 } PACK_STRUCT_STRUCT; 112 PACK_STRUCT_END 113#ifdef PACK_STRUCT_USE_INCLUDES 114#include "arch/epstruct.h" 115#endif 116/** 5 seconds period */ 117#define ARP_TMR_INTERVAL 5000 118#define ETHTYPE_ARP 0x0806 119#define ETHTYPE_IP 0x0800 120#define ETHTYPE_PPPOEDISC 0x8863 /* PPP Over Ethernet Discovery Stage */ 121#define ETHTYPE_PPPOE 0x8864 /* PPP Over Ethernet Session Stage */ 122/** ARP message types (opcodes) */ 123#define ARP_REQUEST 1 124#define ARP_REPLY 2 125#if ARP_QUEUEING 126/** struct for queueing outgoing packets for unknown address 127 * defined here to be accessed by memp.h 128 */ 129 struct etharp_q_entry { 130 struct etharp_q_entry *next; 131 struct pbuf *p; 132 }; 133#endif /* ARP_QUEUEING */ 134 135#define etharp_init() /* Compatibility define, not init needed. */ 136 void etharp_tmr(void); 137 s8_t etharp_find_addr(struct netif *netif, struct ip_addr *ipaddr, 138 struct eth_addr **eth_ret, struct ip_addr **ip_ret); 139 void etharp_ip_input(struct netif *netif, struct pbuf *p); 140 void etharp_arp_input(struct netif *netif, struct eth_addr *ethaddr, 141 struct pbuf *p); 142 err_t etharp_output(struct netif *netif, struct pbuf *q, 143 struct ip_addr *ipaddr); 144 err_t etharp_query(struct netif *netif, struct ip_addr *ipaddr, 145 struct pbuf *q); 146 147 148 struct eth_addr convert_uint64_to_eth_addr(uint64_t given_mac); 149 bool is_ip_present_in_arp_cache(struct ip_addr *ipaddr); 150 uint64_t find_ip_arp_cache(struct ip_addr *ipaddr); 151 152 153 154 err_t etharp_request(struct netif *netif, struct ip_addr *ipaddr); 155/** For Ethernet network interfaces, we might want to send "gratuitous ARP"; 156 * this is an ARP packet sent by a node in order to spontaneously cause other 157 * nodes to update an entry in their ARP cache. 158 * From RFC 3220 "IP Mobility Support for IPv4" section 4.6. */ 159#define etharp_gratuitous(netif) etharp_request((netif), &(netif)->ip_addr) 160 161 err_t ethernet_input(struct pbuf *p, struct netif *netif); 162 163#if LWIP_AUTOIP 164 err_t etharp_raw(struct netif *netif, const struct eth_addr *ethsrc_addr, 165 const struct eth_addr *ethdst_addr, 166 const struct eth_addr *hwsrc_addr, 167 const struct ip_addr *ipsrc_addr, 168 const struct eth_addr *hwdst_addr, 169 const struct ip_addr *ipdst_addr, const u16_t opcode); 170#endif /* LWIP_AUTOIP */ 171 172#define eth_addr_cmp(addr1, addr2) (memcmp((addr1)->addr, (addr2)->addr, ETHARP_HWADDR_LEN) == 0) 173 174 extern const struct eth_addr ethbroadcast, ethzero; 175 176#ifdef __cplusplus 177} 178#endif 179#endif /* LWIP_ARP */ 180#endif /* __NETIF_ARP_H__ */ 181