SiSK / EthernetInterface

fdsf

Dependents:   sisk_proj_stat MQTT Hello_FXOS8700Q WireFSHandControl ... more

lwip/netif/etharp.c@0:d7bd7384a37c, 2016-12-07 (annotated)

Committer:
grzemich
Date:
Wed Dec 07 23:47:50 2016 +0000
Revision:
0:d7bd7384a37c
dgd

Who changed what in which revision?

UserRevisionLine numberNew contents of line
grzemich 0:d7bd7384a37c 1 /**
grzemich 0:d7bd7384a37c 2 * @file
grzemich 0:d7bd7384a37c 3 * Address Resolution Protocol module for IP over Ethernet
grzemich 0:d7bd7384a37c 4 *
grzemich 0:d7bd7384a37c 5 * Functionally, ARP is divided into two parts. The first maps an IP address
grzemich 0:d7bd7384a37c 6 * to a physical address when sending a packet, and the second part answers
grzemich 0:d7bd7384a37c 7 * requests from other machines for our physical address.
grzemich 0:d7bd7384a37c 8 *
grzemich 0:d7bd7384a37c 9 * This implementation complies with RFC 826 (Ethernet ARP). It supports
grzemich 0:d7bd7384a37c 10 * Gratuitious ARP from RFC3220 (IP Mobility Support for IPv4) section 4.6
grzemich 0:d7bd7384a37c 11 * if an interface calls etharp_gratuitous(our_netif) upon address change.
grzemich 0:d7bd7384a37c 12 */
grzemich 0:d7bd7384a37c 13
grzemich 0:d7bd7384a37c 14 /*
grzemich 0:d7bd7384a37c 15 * Copyright (c) 2001-2003 Swedish Institute of Computer Science.
grzemich 0:d7bd7384a37c 16 * Copyright (c) 2003-2004 Leon Woestenberg <leon.woestenberg@axon.tv>
grzemich 0:d7bd7384a37c 17 * Copyright (c) 2003-2004 Axon Digital Design B.V., The Netherlands.
grzemich 0:d7bd7384a37c 18 * All rights reserved.
grzemich 0:d7bd7384a37c 19 *
grzemich 0:d7bd7384a37c 20 * Redistribution and use in source and binary forms, with or without modification,
grzemich 0:d7bd7384a37c 21 * are permitted provided that the following conditions are met:
grzemich 0:d7bd7384a37c 22 *
grzemich 0:d7bd7384a37c 23 * 1. Redistributions of source code must retain the above copyright notice,
grzemich 0:d7bd7384a37c 24 * this list of conditions and the following disclaimer.
grzemich 0:d7bd7384a37c 25 * 2. Redistributions in binary form must reproduce the above copyright notice,
grzemich 0:d7bd7384a37c 26 * this list of conditions and the following disclaimer in the documentation
grzemich 0:d7bd7384a37c 27 * and/or other materials provided with the distribution.
grzemich 0:d7bd7384a37c 28 * 3. The name of the author may not be used to endorse or promote products
grzemich 0:d7bd7384a37c 29 * derived from this software without specific prior written permission.
grzemich 0:d7bd7384a37c 30 *
grzemich 0:d7bd7384a37c 31 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
grzemich 0:d7bd7384a37c 32 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
grzemich 0:d7bd7384a37c 33 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
grzemich 0:d7bd7384a37c 34 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
grzemich 0:d7bd7384a37c 35 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
grzemich 0:d7bd7384a37c 36 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
grzemich 0:d7bd7384a37c 37 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
grzemich 0:d7bd7384a37c 38 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
grzemich 0:d7bd7384a37c 39 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
grzemich 0:d7bd7384a37c 40 * OF SUCH DAMAGE.
grzemich 0:d7bd7384a37c 41 *
grzemich 0:d7bd7384a37c 42 * This file is part of the lwIP TCP/IP stack.
grzemich 0:d7bd7384a37c 43 *
grzemich 0:d7bd7384a37c 44 */
grzemich 0:d7bd7384a37c 45
grzemich 0:d7bd7384a37c 46 #include "lwip/opt.h"
grzemich 0:d7bd7384a37c 47
grzemich 0:d7bd7384a37c 48 #if LWIP_ARP || LWIP_ETHERNET
grzemich 0:d7bd7384a37c 49
grzemich 0:d7bd7384a37c 50 #include "lwip/ip_addr.h"
grzemich 0:d7bd7384a37c 51 #include "lwip/def.h"
grzemich 0:d7bd7384a37c 52 #include "lwip/ip.h"
grzemich 0:d7bd7384a37c 53 #include "lwip/stats.h"
grzemich 0:d7bd7384a37c 54 #include "lwip/snmp.h"
grzemich 0:d7bd7384a37c 55 #include "lwip/dhcp.h"
grzemich 0:d7bd7384a37c 56 #include "lwip/autoip.h"
grzemich 0:d7bd7384a37c 57 #include "netif/etharp.h"
grzemich 0:d7bd7384a37c 58
grzemich 0:d7bd7384a37c 59 #if PPPOE_SUPPORT
grzemich 0:d7bd7384a37c 60 #include "netif/ppp_oe.h"
grzemich 0:d7bd7384a37c 61 #endif /* PPPOE_SUPPORT */
grzemich 0:d7bd7384a37c 62
grzemich 0:d7bd7384a37c 63 #include <string.h>
grzemich 0:d7bd7384a37c 64
grzemich 0:d7bd7384a37c 65 const struct eth_addr ethbroadcast = {{0xff,0xff,0xff,0xff,0xff,0xff}};
grzemich 0:d7bd7384a37c 66 const struct eth_addr ethzero = {{0,0,0,0,0,0}};
grzemich 0:d7bd7384a37c 67
grzemich 0:d7bd7384a37c 68 #if LWIP_ARP /* don't build if not configured for use in lwipopts.h */
grzemich 0:d7bd7384a37c 69
grzemich 0:d7bd7384a37c 70 /** the time an ARP entry stays valid after its last update,
grzemich 0:d7bd7384a37c 71 * for ARP_TMR_INTERVAL = 5000, this is
grzemich 0:d7bd7384a37c 72 * (240 * 5) seconds = 20 minutes.
grzemich 0:d7bd7384a37c 73 */
grzemich 0:d7bd7384a37c 74 #define ARP_MAXAGE 240
grzemich 0:d7bd7384a37c 75 /** the time an ARP entry stays pending after first request,
grzemich 0:d7bd7384a37c 76 * for ARP_TMR_INTERVAL = 5000, this is
grzemich 0:d7bd7384a37c 77 * (2 * 5) seconds = 10 seconds.
grzemich 0:d7bd7384a37c 78 *
grzemich 0:d7bd7384a37c 79 * @internal Keep this number at least 2, otherwise it might
grzemich 0:d7bd7384a37c 80 * run out instantly if the timeout occurs directly after a request.
grzemich 0:d7bd7384a37c 81 */
grzemich 0:d7bd7384a37c 82 #define ARP_MAXPENDING 2
grzemich 0:d7bd7384a37c 83
grzemich 0:d7bd7384a37c 84 #define HWTYPE_ETHERNET 1
grzemich 0:d7bd7384a37c 85
grzemich 0:d7bd7384a37c 86 enum etharp_state {
grzemich 0:d7bd7384a37c 87 ETHARP_STATE_EMPTY = 0,
grzemich 0:d7bd7384a37c 88 ETHARP_STATE_PENDING,
grzemich 0:d7bd7384a37c 89 ETHARP_STATE_STABLE
grzemich 0:d7bd7384a37c 90 };
grzemich 0:d7bd7384a37c 91
grzemich 0:d7bd7384a37c 92 struct etharp_entry {
grzemich 0:d7bd7384a37c 93 #if ARP_QUEUEING
grzemich 0:d7bd7384a37c 94 /** Pointer to queue of pending outgoing packets on this ARP entry. */
grzemich 0:d7bd7384a37c 95 struct etharp_q_entry *q;
grzemich 0:d7bd7384a37c 96 #else /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 97 /** Pointer to a single pending outgoing packet on this ARP entry. */
grzemich 0:d7bd7384a37c 98 struct pbuf *q;
grzemich 0:d7bd7384a37c 99 #endif /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 100 ip_addr_t ipaddr;
grzemich 0:d7bd7384a37c 101 struct eth_addr ethaddr;
grzemich 0:d7bd7384a37c 102 #if LWIP_SNMP
grzemich 0:d7bd7384a37c 103 struct netif *netif;
grzemich 0:d7bd7384a37c 104 #endif /* LWIP_SNMP */
grzemich 0:d7bd7384a37c 105 u8_t state;
grzemich 0:d7bd7384a37c 106 u8_t ctime;
grzemich 0:d7bd7384a37c 107 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 108 u8_t static_entry;
grzemich 0:d7bd7384a37c 109 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 110 };
grzemich 0:d7bd7384a37c 111
grzemich 0:d7bd7384a37c 112 static struct etharp_entry arp_table[ARP_TABLE_SIZE];
grzemich 0:d7bd7384a37c 113
grzemich 0:d7bd7384a37c 114 #if !LWIP_NETIF_HWADDRHINT
grzemich 0:d7bd7384a37c 115 static u8_t etharp_cached_entry;
grzemich 0:d7bd7384a37c 116 #endif /* !LWIP_NETIF_HWADDRHINT */
grzemich 0:d7bd7384a37c 117
grzemich 0:d7bd7384a37c 118 /** Try hard to create a new entry - we want the IP address to appear in
grzemich 0:d7bd7384a37c 119 the cache (even if this means removing an active entry or so). */
grzemich 0:d7bd7384a37c 120 #define ETHARP_FLAG_TRY_HARD 1
grzemich 0:d7bd7384a37c 121 #define ETHARP_FLAG_FIND_ONLY 2
grzemich 0:d7bd7384a37c 122 #define ETHARP_FLAG_STATIC_ENTRY 4
grzemich 0:d7bd7384a37c 123
grzemich 0:d7bd7384a37c 124 #if LWIP_NETIF_HWADDRHINT
grzemich 0:d7bd7384a37c 125 #define ETHARP_SET_HINT(netif, hint) if (((netif) != NULL) && ((netif)->addr_hint != NULL)) \
grzemich 0:d7bd7384a37c 126 *((netif)->addr_hint) = (hint);
grzemich 0:d7bd7384a37c 127 #else /* LWIP_NETIF_HWADDRHINT */
grzemich 0:d7bd7384a37c 128 #define ETHARP_SET_HINT(netif, hint) (etharp_cached_entry = (hint))
grzemich 0:d7bd7384a37c 129 #endif /* LWIP_NETIF_HWADDRHINT */
grzemich 0:d7bd7384a37c 130
grzemich 0:d7bd7384a37c 131 static err_t update_arp_entry(struct netif *netif, ip_addr_t *ipaddr, struct eth_addr *ethaddr, u8_t flags);
grzemich 0:d7bd7384a37c 132
grzemich 0:d7bd7384a37c 133
grzemich 0:d7bd7384a37c 134 /* Some checks, instead of etharp_init(): */
grzemich 0:d7bd7384a37c 135 #if (LWIP_ARP && (ARP_TABLE_SIZE > 0x7f))
grzemich 0:d7bd7384a37c 136 #error "ARP_TABLE_SIZE must fit in an s8_t, you have to reduce it in your lwipopts.h"
grzemich 0:d7bd7384a37c 137 #endif
grzemich 0:d7bd7384a37c 138
grzemich 0:d7bd7384a37c 139
grzemich 0:d7bd7384a37c 140 #if ARP_QUEUEING
grzemich 0:d7bd7384a37c 141 /**
grzemich 0:d7bd7384a37c 142 * Free a complete queue of etharp entries
grzemich 0:d7bd7384a37c 143 *
grzemich 0:d7bd7384a37c 144 * @param q a qeueue of etharp_q_entry's to free
grzemich 0:d7bd7384a37c 145 */
grzemich 0:d7bd7384a37c 146 static void
grzemich 0:d7bd7384a37c 147 free_etharp_q(struct etharp_q_entry *q)
grzemich 0:d7bd7384a37c 148 {
grzemich 0:d7bd7384a37c 149 struct etharp_q_entry *r;
grzemich 0:d7bd7384a37c 150 LWIP_ASSERT("q != NULL", q != NULL);
grzemich 0:d7bd7384a37c 151 LWIP_ASSERT("q->p != NULL", q->p != NULL);
grzemich 0:d7bd7384a37c 152 while (q) {
grzemich 0:d7bd7384a37c 153 r = q;
grzemich 0:d7bd7384a37c 154 q = q->next;
grzemich 0:d7bd7384a37c 155 LWIP_ASSERT("r->p != NULL", (r->p != NULL));
grzemich 0:d7bd7384a37c 156 pbuf_free(r->p);
grzemich 0:d7bd7384a37c 157 memp_free(MEMP_ARP_QUEUE, r);
grzemich 0:d7bd7384a37c 158 }
grzemich 0:d7bd7384a37c 159 }
grzemich 0:d7bd7384a37c 160 #else /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 161
grzemich 0:d7bd7384a37c 162 /** Compatibility define: free the queued pbuf */
grzemich 0:d7bd7384a37c 163 #define free_etharp_q(q) pbuf_free(q)
grzemich 0:d7bd7384a37c 164
grzemich 0:d7bd7384a37c 165 #endif /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 166
grzemich 0:d7bd7384a37c 167 /** Clean up ARP table entries */
grzemich 0:d7bd7384a37c 168 static void
grzemich 0:d7bd7384a37c 169 free_entry(int i)
grzemich 0:d7bd7384a37c 170 {
grzemich 0:d7bd7384a37c 171 /* remove from SNMP ARP index tree */
grzemich 0:d7bd7384a37c 172 snmp_delete_arpidx_tree(arp_table[i].netif, &arp_table[i].ipaddr);
grzemich 0:d7bd7384a37c 173 /* and empty packet queue */
grzemich 0:d7bd7384a37c 174 if (arp_table[i].q != NULL) {
grzemich 0:d7bd7384a37c 175 /* remove all queued packets */
grzemich 0:d7bd7384a37c 176 LWIP_DEBUGF(ETHARP_DEBUG, ("etharp_timer: freeing entry %"U16_F", packet queue %p.\n", (u16_t)i, (void *)(arp_table[i].q)));
grzemich 0:d7bd7384a37c 177 free_etharp_q(arp_table[i].q);
grzemich 0:d7bd7384a37c 178 arp_table[i].q = NULL;
grzemich 0:d7bd7384a37c 179 }
grzemich 0:d7bd7384a37c 180 /* recycle entry for re-use */
grzemich 0:d7bd7384a37c 181 arp_table[i].state = ETHARP_STATE_EMPTY;
grzemich 0:d7bd7384a37c 182 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 183 arp_table[i].static_entry = 0;
grzemich 0:d7bd7384a37c 184 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 185 #ifdef LWIP_DEBUG
grzemich 0:d7bd7384a37c 186 /* for debugging, clean out the complete entry */
grzemich 0:d7bd7384a37c 187 arp_table[i].ctime = 0;
grzemich 0:d7bd7384a37c 188 #if LWIP_SNMP
grzemich 0:d7bd7384a37c 189 arp_table[i].netif = NULL;
grzemich 0:d7bd7384a37c 190 #endif /* LWIP_SNMP */
grzemich 0:d7bd7384a37c 191 ip_addr_set_zero(&arp_table[i].ipaddr);
grzemich 0:d7bd7384a37c 192 arp_table[i].ethaddr = ethzero;
grzemich 0:d7bd7384a37c 193 #endif /* LWIP_DEBUG */
grzemich 0:d7bd7384a37c 194 }
grzemich 0:d7bd7384a37c 195
grzemich 0:d7bd7384a37c 196 /**
grzemich 0:d7bd7384a37c 197 * Clears expired entries in the ARP table.
grzemich 0:d7bd7384a37c 198 *
grzemich 0:d7bd7384a37c 199 * This function should be called every ETHARP_TMR_INTERVAL milliseconds (5 seconds),
grzemich 0:d7bd7384a37c 200 * in order to expire entries in the ARP table.
grzemich 0:d7bd7384a37c 201 */
grzemich 0:d7bd7384a37c 202 void
grzemich 0:d7bd7384a37c 203 etharp_tmr(void)
grzemich 0:d7bd7384a37c 204 {
grzemich 0:d7bd7384a37c 205 u8_t i;
grzemich 0:d7bd7384a37c 206
grzemich 0:d7bd7384a37c 207 LWIP_DEBUGF(ETHARP_DEBUG, ("etharp_timer\n"));
grzemich 0:d7bd7384a37c 208 /* remove expired entries from the ARP table */
grzemich 0:d7bd7384a37c 209 for (i = 0; i < ARP_TABLE_SIZE; ++i) {
grzemich 0:d7bd7384a37c 210 u8_t state = arp_table[i].state;
grzemich 0:d7bd7384a37c 211 if (state != ETHARP_STATE_EMPTY
grzemich 0:d7bd7384a37c 212 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 213 && (arp_table[i].static_entry == 0)
grzemich 0:d7bd7384a37c 214 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 215 ) {
grzemich 0:d7bd7384a37c 216 arp_table[i].ctime++;
grzemich 0:d7bd7384a37c 217 if ((arp_table[i].ctime >= ARP_MAXAGE) ||
grzemich 0:d7bd7384a37c 218 ((arp_table[i].state == ETHARP_STATE_PENDING) &&
grzemich 0:d7bd7384a37c 219 (arp_table[i].ctime >= ARP_MAXPENDING))) {
grzemich 0:d7bd7384a37c 220 /* pending or stable entry has become old! */
grzemich 0:d7bd7384a37c 221 LWIP_DEBUGF(ETHARP_DEBUG, ("etharp_timer: expired %s entry %"U16_F".\n",
grzemich 0:d7bd7384a37c 222 arp_table[i].state == ETHARP_STATE_STABLE ? "stable" : "pending", (u16_t)i));
grzemich 0:d7bd7384a37c 223 /* clean up entries that have just been expired */
grzemich 0:d7bd7384a37c 224 free_entry(i);
grzemich 0:d7bd7384a37c 225 }
grzemich 0:d7bd7384a37c 226 #if ARP_QUEUEING
grzemich 0:d7bd7384a37c 227 /* still pending entry? (not expired) */
grzemich 0:d7bd7384a37c 228 if (arp_table[i].state == ETHARP_STATE_PENDING) {
grzemich 0:d7bd7384a37c 229 /* resend an ARP query here? */
grzemich 0:d7bd7384a37c 230 }
grzemich 0:d7bd7384a37c 231 #endif /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 232 }
grzemich 0:d7bd7384a37c 233 }
grzemich 0:d7bd7384a37c 234 }
grzemich 0:d7bd7384a37c 235
grzemich 0:d7bd7384a37c 236 /**
grzemich 0:d7bd7384a37c 237 * Search the ARP table for a matching or new entry.
grzemich 0:d7bd7384a37c 238 *
grzemich 0:d7bd7384a37c 239 * If an IP address is given, return a pending or stable ARP entry that matches
grzemich 0:d7bd7384a37c 240 * the address. If no match is found, create a new entry with this address set,
grzemich 0:d7bd7384a37c 241 * but in state ETHARP_EMPTY. The caller must check and possibly change the
grzemich 0:d7bd7384a37c 242 * state of the returned entry.
grzemich 0:d7bd7384a37c 243 *
grzemich 0:d7bd7384a37c 244 * If ipaddr is NULL, return a initialized new entry in state ETHARP_EMPTY.
grzemich 0:d7bd7384a37c 245 *
grzemich 0:d7bd7384a37c 246 * In all cases, attempt to create new entries from an empty entry. If no
grzemich 0:d7bd7384a37c 247 * empty entries are available and ETHARP_FLAG_TRY_HARD flag is set, recycle
grzemich 0:d7bd7384a37c 248 * old entries. Heuristic choose the least important entry for recycling.
grzemich 0:d7bd7384a37c 249 *
grzemich 0:d7bd7384a37c 250 * @param ipaddr IP address to find in ARP cache, or to add if not found.
grzemich 0:d7bd7384a37c 251 * @param flags @see definition of ETHARP_FLAG_*
grzemich 0:d7bd7384a37c 252 * @param netif netif related to this address (used for NETIF_HWADDRHINT)
grzemich 0:d7bd7384a37c 253 *
grzemich 0:d7bd7384a37c 254 * @return The ARP entry index that matched or is created, ERR_MEM if no
grzemich 0:d7bd7384a37c 255 * entry is found or could be recycled.
grzemich 0:d7bd7384a37c 256 */
grzemich 0:d7bd7384a37c 257 static s8_t
grzemich 0:d7bd7384a37c 258 find_entry(ip_addr_t *ipaddr, u8_t flags)
grzemich 0:d7bd7384a37c 259 {
grzemich 0:d7bd7384a37c 260 s8_t old_pending = ARP_TABLE_SIZE, old_stable = ARP_TABLE_SIZE;
grzemich 0:d7bd7384a37c 261 s8_t empty = ARP_TABLE_SIZE;
grzemich 0:d7bd7384a37c 262 u8_t i = 0, age_pending = 0, age_stable = 0;
grzemich 0:d7bd7384a37c 263 /* oldest entry with packets on queue */
grzemich 0:d7bd7384a37c 264 s8_t old_queue = ARP_TABLE_SIZE;
grzemich 0:d7bd7384a37c 265 /* its age */
grzemich 0:d7bd7384a37c 266 u8_t age_queue = 0;
grzemich 0:d7bd7384a37c 267
grzemich 0:d7bd7384a37c 268 /**
grzemich 0:d7bd7384a37c 269 * a) do a search through the cache, remember candidates
grzemich 0:d7bd7384a37c 270 * b) select candidate entry
grzemich 0:d7bd7384a37c 271 * c) create new entry
grzemich 0:d7bd7384a37c 272 */
grzemich 0:d7bd7384a37c 273
grzemich 0:d7bd7384a37c 274 /* a) in a single search sweep, do all of this
grzemich 0:d7bd7384a37c 275 * 1) remember the first empty entry (if any)
grzemich 0:d7bd7384a37c 276 * 2) remember the oldest stable entry (if any)
grzemich 0:d7bd7384a37c 277 * 3) remember the oldest pending entry without queued packets (if any)
grzemich 0:d7bd7384a37c 278 * 4) remember the oldest pending entry with queued packets (if any)
grzemich 0:d7bd7384a37c 279 * 5) search for a matching IP entry, either pending or stable
grzemich 0:d7bd7384a37c 280 * until 5 matches, or all entries are searched for.
grzemich 0:d7bd7384a37c 281 */
grzemich 0:d7bd7384a37c 282
grzemich 0:d7bd7384a37c 283 for (i = 0; i < ARP_TABLE_SIZE; ++i) {
grzemich 0:d7bd7384a37c 284 u8_t state = arp_table[i].state;
grzemich 0:d7bd7384a37c 285 /* no empty entry found yet and now we do find one? */
grzemich 0:d7bd7384a37c 286 if ((empty == ARP_TABLE_SIZE) && (state == ETHARP_STATE_EMPTY)) {
grzemich 0:d7bd7384a37c 287 LWIP_DEBUGF(ETHARP_DEBUG, ("find_entry: found empty entry %"U16_F"\n", (u16_t)i));
grzemich 0:d7bd7384a37c 288 /* remember first empty entry */
grzemich 0:d7bd7384a37c 289 empty = i;
grzemich 0:d7bd7384a37c 290 } else if (state != ETHARP_STATE_EMPTY) {
grzemich 0:d7bd7384a37c 291 LWIP_ASSERT("state == ETHARP_STATE_PENDING || state == ETHARP_STATE_STABLE",
grzemich 0:d7bd7384a37c 292 state == ETHARP_STATE_PENDING || state == ETHARP_STATE_STABLE);
grzemich 0:d7bd7384a37c 293 /* if given, does IP address match IP address in ARP entry? */
grzemich 0:d7bd7384a37c 294 if (ipaddr && ip_addr_cmp(ipaddr, &arp_table[i].ipaddr)) {
grzemich 0:d7bd7384a37c 295 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: found matching entry %"U16_F"\n", (u16_t)i));
grzemich 0:d7bd7384a37c 296 /* found exact IP address match, simply bail out */
grzemich 0:d7bd7384a37c 297 return i;
grzemich 0:d7bd7384a37c 298 }
grzemich 0:d7bd7384a37c 299 /* pending entry? */
grzemich 0:d7bd7384a37c 300 if (state == ETHARP_STATE_PENDING) {
grzemich 0:d7bd7384a37c 301 /* pending with queued packets? */
grzemich 0:d7bd7384a37c 302 if (arp_table[i].q != NULL) {
grzemich 0:d7bd7384a37c 303 if (arp_table[i].ctime >= age_queue) {
grzemich 0:d7bd7384a37c 304 old_queue = i;
grzemich 0:d7bd7384a37c 305 age_queue = arp_table[i].ctime;
grzemich 0:d7bd7384a37c 306 }
grzemich 0:d7bd7384a37c 307 } else
grzemich 0:d7bd7384a37c 308 /* pending without queued packets? */
grzemich 0:d7bd7384a37c 309 {
grzemich 0:d7bd7384a37c 310 if (arp_table[i].ctime >= age_pending) {
grzemich 0:d7bd7384a37c 311 old_pending = i;
grzemich 0:d7bd7384a37c 312 age_pending = arp_table[i].ctime;
grzemich 0:d7bd7384a37c 313 }
grzemich 0:d7bd7384a37c 314 }
grzemich 0:d7bd7384a37c 315 /* stable entry? */
grzemich 0:d7bd7384a37c 316 } else if (state == ETHARP_STATE_STABLE) {
grzemich 0:d7bd7384a37c 317 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 318 /* don't record old_stable for static entries since they never expire */
grzemich 0:d7bd7384a37c 319 if (arp_table[i].static_entry == 0)
grzemich 0:d7bd7384a37c 320 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 321 {
grzemich 0:d7bd7384a37c 322 /* remember entry with oldest stable entry in oldest, its age in maxtime */
grzemich 0:d7bd7384a37c 323 if (arp_table[i].ctime >= age_stable) {
grzemich 0:d7bd7384a37c 324 old_stable = i;
grzemich 0:d7bd7384a37c 325 age_stable = arp_table[i].ctime;
grzemich 0:d7bd7384a37c 326 }
grzemich 0:d7bd7384a37c 327 }
grzemich 0:d7bd7384a37c 328 }
grzemich 0:d7bd7384a37c 329 }
grzemich 0:d7bd7384a37c 330 }
grzemich 0:d7bd7384a37c 331 /* { we have no match } => try to create a new entry */
grzemich 0:d7bd7384a37c 332
grzemich 0:d7bd7384a37c 333 /* don't create new entry, only search? */
grzemich 0:d7bd7384a37c 334 if (((flags & ETHARP_FLAG_FIND_ONLY) != 0) ||
grzemich 0:d7bd7384a37c 335 /* or no empty entry found and not allowed to recycle? */
grzemich 0:d7bd7384a37c 336 ((empty == ARP_TABLE_SIZE) && ((flags & ETHARP_FLAG_TRY_HARD) == 0))) {
grzemich 0:d7bd7384a37c 337 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: no empty entry found and not allowed to recycle\n"));
grzemich 0:d7bd7384a37c 338 return (s8_t)ERR_MEM;
grzemich 0:d7bd7384a37c 339 }
grzemich 0:d7bd7384a37c 340
grzemich 0:d7bd7384a37c 341 /* b) choose the least destructive entry to recycle:
grzemich 0:d7bd7384a37c 342 * 1) empty entry
grzemich 0:d7bd7384a37c 343 * 2) oldest stable entry
grzemich 0:d7bd7384a37c 344 * 3) oldest pending entry without queued packets
grzemich 0:d7bd7384a37c 345 * 4) oldest pending entry with queued packets
grzemich 0:d7bd7384a37c 346 *
grzemich 0:d7bd7384a37c 347 * { ETHARP_FLAG_TRY_HARD is set at this point }
grzemich 0:d7bd7384a37c 348 */
grzemich 0:d7bd7384a37c 349
grzemich 0:d7bd7384a37c 350 /* 1) empty entry available? */
grzemich 0:d7bd7384a37c 351 if (empty < ARP_TABLE_SIZE) {
grzemich 0:d7bd7384a37c 352 i = empty;
grzemich 0:d7bd7384a37c 353 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: selecting empty entry %"U16_F"\n", (u16_t)i));
grzemich 0:d7bd7384a37c 354 } else {
grzemich 0:d7bd7384a37c 355 /* 2) found recyclable stable entry? */
grzemich 0:d7bd7384a37c 356 if (old_stable < ARP_TABLE_SIZE) {
grzemich 0:d7bd7384a37c 357 /* recycle oldest stable*/
grzemich 0:d7bd7384a37c 358 i = old_stable;
grzemich 0:d7bd7384a37c 359 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: selecting oldest stable entry %"U16_F"\n", (u16_t)i));
grzemich 0:d7bd7384a37c 360 /* no queued packets should exist on stable entries */
grzemich 0:d7bd7384a37c 361 LWIP_ASSERT("arp_table[i].q == NULL", arp_table[i].q == NULL);
grzemich 0:d7bd7384a37c 362 /* 3) found recyclable pending entry without queued packets? */
grzemich 0:d7bd7384a37c 363 } else if (old_pending < ARP_TABLE_SIZE) {
grzemich 0:d7bd7384a37c 364 /* recycle oldest pending */
grzemich 0:d7bd7384a37c 365 i = old_pending;
grzemich 0:d7bd7384a37c 366 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: selecting oldest pending entry %"U16_F" (without queue)\n", (u16_t)i));
grzemich 0:d7bd7384a37c 367 /* 4) found recyclable pending entry with queued packets? */
grzemich 0:d7bd7384a37c 368 } else if (old_queue < ARP_TABLE_SIZE) {
grzemich 0:d7bd7384a37c 369 /* recycle oldest pending (queued packets are free in free_entry) */
grzemich 0:d7bd7384a37c 370 i = old_queue;
grzemich 0:d7bd7384a37c 371 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: selecting oldest pending entry %"U16_F", freeing packet queue %p\n", (u16_t)i, (void *)(arp_table[i].q)));
grzemich 0:d7bd7384a37c 372 /* no empty or recyclable entries found */
grzemich 0:d7bd7384a37c 373 } else {
grzemich 0:d7bd7384a37c 374 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("find_entry: no empty or recyclable entries found\n"));
grzemich 0:d7bd7384a37c 375 return (s8_t)ERR_MEM;
grzemich 0:d7bd7384a37c 376 }
grzemich 0:d7bd7384a37c 377
grzemich 0:d7bd7384a37c 378 /* { empty or recyclable entry found } */
grzemich 0:d7bd7384a37c 379 LWIP_ASSERT("i < ARP_TABLE_SIZE", i < ARP_TABLE_SIZE);
grzemich 0:d7bd7384a37c 380 free_entry(i);
grzemich 0:d7bd7384a37c 381 }
grzemich 0:d7bd7384a37c 382
grzemich 0:d7bd7384a37c 383 LWIP_ASSERT("i < ARP_TABLE_SIZE", i < ARP_TABLE_SIZE);
grzemich 0:d7bd7384a37c 384 LWIP_ASSERT("arp_table[i].state == ETHARP_STATE_EMPTY",
grzemich 0:d7bd7384a37c 385 arp_table[i].state == ETHARP_STATE_EMPTY);
grzemich 0:d7bd7384a37c 386
grzemich 0:d7bd7384a37c 387 /* IP address given? */
grzemich 0:d7bd7384a37c 388 if (ipaddr != NULL) {
grzemich 0:d7bd7384a37c 389 /* set IP address */
grzemich 0:d7bd7384a37c 390 ip_addr_copy(arp_table[i].ipaddr, *ipaddr);
grzemich 0:d7bd7384a37c 391 }
grzemich 0:d7bd7384a37c 392 arp_table[i].ctime = 0;
grzemich 0:d7bd7384a37c 393 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 394 arp_table[i].static_entry = 0;
grzemich 0:d7bd7384a37c 395 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 396 return (err_t)i;
grzemich 0:d7bd7384a37c 397 }
grzemich 0:d7bd7384a37c 398
grzemich 0:d7bd7384a37c 399 /**
grzemich 0:d7bd7384a37c 400 * Send an IP packet on the network using netif->linkoutput
grzemich 0:d7bd7384a37c 401 * The ethernet header is filled in before sending.
grzemich 0:d7bd7384a37c 402 *
grzemich 0:d7bd7384a37c 403 * @params netif the lwIP network interface on which to send the packet
grzemich 0:d7bd7384a37c 404 * @params p the packet to send, p->payload pointing to the (uninitialized) ethernet header
grzemich 0:d7bd7384a37c 405 * @params src the source MAC address to be copied into the ethernet header
grzemich 0:d7bd7384a37c 406 * @params dst the destination MAC address to be copied into the ethernet header
grzemich 0:d7bd7384a37c 407 * @return ERR_OK if the packet was sent, any other err_t on failure
grzemich 0:d7bd7384a37c 408 */
grzemich 0:d7bd7384a37c 409 static err_t
grzemich 0:d7bd7384a37c 410 etharp_send_ip(struct netif *netif, struct pbuf *p, struct eth_addr *src, struct eth_addr *dst)
grzemich 0:d7bd7384a37c 411 {
grzemich 0:d7bd7384a37c 412 struct eth_hdr *ethhdr = (struct eth_hdr *)p->payload;
grzemich 0:d7bd7384a37c 413
grzemich 0:d7bd7384a37c 414 LWIP_ASSERT("netif->hwaddr_len must be the same as ETHARP_HWADDR_LEN for etharp!",
grzemich 0:d7bd7384a37c 415 (netif->hwaddr_len == ETHARP_HWADDR_LEN));
grzemich 0:d7bd7384a37c 416 ETHADDR32_COPY(&ethhdr->dest, dst);
grzemich 0:d7bd7384a37c 417 ETHADDR16_COPY(&ethhdr->src, src);
grzemich 0:d7bd7384a37c 418 ethhdr->type = PP_HTONS(ETHTYPE_IP);
grzemich 0:d7bd7384a37c 419 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_send_ip: sending packet %p\n", (void *)p));
grzemich 0:d7bd7384a37c 420 /* send the packet */
grzemich 0:d7bd7384a37c 421 return netif->linkoutput(netif, p);
grzemich 0:d7bd7384a37c 422 }
grzemich 0:d7bd7384a37c 423
grzemich 0:d7bd7384a37c 424 /**
grzemich 0:d7bd7384a37c 425 * Update (or insert) a IP/MAC address pair in the ARP cache.
grzemich 0:d7bd7384a37c 426 *
grzemich 0:d7bd7384a37c 427 * If a pending entry is resolved, any queued packets will be sent
grzemich 0:d7bd7384a37c 428 * at this point.
grzemich 0:d7bd7384a37c 429 *
grzemich 0:d7bd7384a37c 430 * @param netif netif related to this entry (used for NETIF_ADDRHINT)
grzemich 0:d7bd7384a37c 431 * @param ipaddr IP address of the inserted ARP entry.
grzemich 0:d7bd7384a37c 432 * @param ethaddr Ethernet address of the inserted ARP entry.
grzemich 0:d7bd7384a37c 433 * @param flags @see definition of ETHARP_FLAG_*
grzemich 0:d7bd7384a37c 434 *
grzemich 0:d7bd7384a37c 435 * @return
grzemich 0:d7bd7384a37c 436 * - ERR_OK Succesfully updated ARP cache.
grzemich 0:d7bd7384a37c 437 * - ERR_MEM If we could not add a new ARP entry when ETHARP_FLAG_TRY_HARD was set.
grzemich 0:d7bd7384a37c 438 * - ERR_ARG Non-unicast address given, those will not appear in ARP cache.
grzemich 0:d7bd7384a37c 439 *
grzemich 0:d7bd7384a37c 440 * @see pbuf_free()
grzemich 0:d7bd7384a37c 441 */
grzemich 0:d7bd7384a37c 442 static err_t
grzemich 0:d7bd7384a37c 443 update_arp_entry(struct netif *netif, ip_addr_t *ipaddr, struct eth_addr *ethaddr, u8_t flags)
grzemich 0:d7bd7384a37c 444 {
grzemich 0:d7bd7384a37c 445 s8_t i;
grzemich 0:d7bd7384a37c 446 LWIP_ASSERT("netif->hwaddr_len == ETHARP_HWADDR_LEN", netif->hwaddr_len == ETHARP_HWADDR_LEN);
grzemich 0:d7bd7384a37c 447 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("update_arp_entry: %"U16_F".%"U16_F".%"U16_F".%"U16_F" - %02"X16_F":%02"X16_F":%02"X16_F":%02"X16_F":%02"X16_F":%02"X16_F"\n",
grzemich 0:d7bd7384a37c 448 ip4_addr1_16(ipaddr), ip4_addr2_16(ipaddr), ip4_addr3_16(ipaddr), ip4_addr4_16(ipaddr),
grzemich 0:d7bd7384a37c 449 ethaddr->addr[0], ethaddr->addr[1], ethaddr->addr[2],
grzemich 0:d7bd7384a37c 450 ethaddr->addr[3], ethaddr->addr[4], ethaddr->addr[5]));
grzemich 0:d7bd7384a37c 451 /* non-unicast address? */
grzemich 0:d7bd7384a37c 452 if (ip_addr_isany(ipaddr) ||
grzemich 0:d7bd7384a37c 453 ip_addr_isbroadcast(ipaddr, netif) ||
grzemich 0:d7bd7384a37c 454 ip_addr_ismulticast(ipaddr)) {
grzemich 0:d7bd7384a37c 455 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("update_arp_entry: will not add non-unicast IP address to ARP cache\n"));
grzemich 0:d7bd7384a37c 456 return ERR_ARG;
grzemich 0:d7bd7384a37c 457 }
grzemich 0:d7bd7384a37c 458 /* find or create ARP entry */
grzemich 0:d7bd7384a37c 459 i = find_entry(ipaddr, flags);
grzemich 0:d7bd7384a37c 460 /* bail out if no entry could be found */
grzemich 0:d7bd7384a37c 461 if (i < 0) {
grzemich 0:d7bd7384a37c 462 return (err_t)i;
grzemich 0:d7bd7384a37c 463 }
grzemich 0:d7bd7384a37c 464
grzemich 0:d7bd7384a37c 465 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 466 if (flags & ETHARP_FLAG_STATIC_ENTRY) {
grzemich 0:d7bd7384a37c 467 /* record static type */
grzemich 0:d7bd7384a37c 468 arp_table[i].static_entry = 1;
grzemich 0:d7bd7384a37c 469 }
grzemich 0:d7bd7384a37c 470 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 471
grzemich 0:d7bd7384a37c 472 /* mark it stable */
grzemich 0:d7bd7384a37c 473 arp_table[i].state = ETHARP_STATE_STABLE;
grzemich 0:d7bd7384a37c 474
grzemich 0:d7bd7384a37c 475 #if LWIP_SNMP
grzemich 0:d7bd7384a37c 476 /* record network interface */
grzemich 0:d7bd7384a37c 477 arp_table[i].netif = netif;
grzemich 0:d7bd7384a37c 478 #endif /* LWIP_SNMP */
grzemich 0:d7bd7384a37c 479 /* insert in SNMP ARP index tree */
grzemich 0:d7bd7384a37c 480 snmp_insert_arpidx_tree(netif, &arp_table[i].ipaddr);
grzemich 0:d7bd7384a37c 481
grzemich 0:d7bd7384a37c 482 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("update_arp_entry: updating stable entry %"S16_F"\n", (s16_t)i));
grzemich 0:d7bd7384a37c 483 /* update address */
grzemich 0:d7bd7384a37c 484 ETHADDR32_COPY(&arp_table[i].ethaddr, ethaddr);
grzemich 0:d7bd7384a37c 485 /* reset time stamp */
grzemich 0:d7bd7384a37c 486 arp_table[i].ctime = 0;
grzemich 0:d7bd7384a37c 487 /* this is where we will send out queued packets! */
grzemich 0:d7bd7384a37c 488 #if ARP_QUEUEING
grzemich 0:d7bd7384a37c 489 while (arp_table[i].q != NULL) {
grzemich 0:d7bd7384a37c 490 struct pbuf *p;
grzemich 0:d7bd7384a37c 491 /* remember remainder of queue */
grzemich 0:d7bd7384a37c 492 struct etharp_q_entry *q = arp_table[i].q;
grzemich 0:d7bd7384a37c 493 /* pop first item off the queue */
grzemich 0:d7bd7384a37c 494 arp_table[i].q = q->next;
grzemich 0:d7bd7384a37c 495 /* get the packet pointer */
grzemich 0:d7bd7384a37c 496 p = q->p;
grzemich 0:d7bd7384a37c 497 /* now queue entry can be freed */
grzemich 0:d7bd7384a37c 498 memp_free(MEMP_ARP_QUEUE, q);
grzemich 0:d7bd7384a37c 499 #else /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 500 if (arp_table[i].q != NULL) {
grzemich 0:d7bd7384a37c 501 struct pbuf *p = arp_table[i].q;
grzemich 0:d7bd7384a37c 502 arp_table[i].q = NULL;
grzemich 0:d7bd7384a37c 503 #endif /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 504 /* send the queued IP packet */
grzemich 0:d7bd7384a37c 505 etharp_send_ip(netif, p, (struct eth_addr*)(netif->hwaddr), ethaddr);
grzemich 0:d7bd7384a37c 506 /* free the queued IP packet */
grzemich 0:d7bd7384a37c 507 pbuf_free(p);
grzemich 0:d7bd7384a37c 508 }
grzemich 0:d7bd7384a37c 509 return ERR_OK;
grzemich 0:d7bd7384a37c 510 }
grzemich 0:d7bd7384a37c 511
grzemich 0:d7bd7384a37c 512 #if ETHARP_SUPPORT_STATIC_ENTRIES
grzemich 0:d7bd7384a37c 513 /** Add a new static entry to the ARP table. If an entry exists for the
grzemich 0:d7bd7384a37c 514 * specified IP address, this entry is overwritten.
grzemich 0:d7bd7384a37c 515 * If packets are queued for the specified IP address, they are sent out.
grzemich 0:d7bd7384a37c 516 *
grzemich 0:d7bd7384a37c 517 * @param ipaddr IP address for the new static entry
grzemich 0:d7bd7384a37c 518 * @param ethaddr ethernet address for the new static entry
grzemich 0:d7bd7384a37c 519 * @return @see return values of etharp_add_static_entry
grzemich 0:d7bd7384a37c 520 */
grzemich 0:d7bd7384a37c 521 err_t
grzemich 0:d7bd7384a37c 522 etharp_add_static_entry(ip_addr_t *ipaddr, struct eth_addr *ethaddr)
grzemich 0:d7bd7384a37c 523 {
grzemich 0:d7bd7384a37c 524 struct netif *netif;
grzemich 0:d7bd7384a37c 525 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_add_static_entry: %"U16_F".%"U16_F".%"U16_F".%"U16_F" - %02"X16_F":%02"X16_F":%02"X16_F":%02"X16_F":%02"X16_F":%02"X16_F"\n",
grzemich 0:d7bd7384a37c 526 ip4_addr1_16(ipaddr), ip4_addr2_16(ipaddr), ip4_addr3_16(ipaddr), ip4_addr4_16(ipaddr),
grzemich 0:d7bd7384a37c 527 ethaddr->addr[0], ethaddr->addr[1], ethaddr->addr[2],
grzemich 0:d7bd7384a37c 528 ethaddr->addr[3], ethaddr->addr[4], ethaddr->addr[5]));
grzemich 0:d7bd7384a37c 529
grzemich 0:d7bd7384a37c 530 netif = ip_route(ipaddr);
grzemich 0:d7bd7384a37c 531 if (netif == NULL) {
grzemich 0:d7bd7384a37c 532 return ERR_RTE;
grzemich 0:d7bd7384a37c 533 }
grzemich 0:d7bd7384a37c 534
grzemich 0:d7bd7384a37c 535 return update_arp_entry(netif, ipaddr, ethaddr, ETHARP_FLAG_TRY_HARD | ETHARP_FLAG_STATIC_ENTRY);
grzemich 0:d7bd7384a37c 536 }
grzemich 0:d7bd7384a37c 537
grzemich 0:d7bd7384a37c 538 /** Remove a static entry from the ARP table previously added with a call to
grzemich 0:d7bd7384a37c 539 * etharp_add_static_entry.
grzemich 0:d7bd7384a37c 540 *
grzemich 0:d7bd7384a37c 541 * @param ipaddr IP address of the static entry to remove
grzemich 0:d7bd7384a37c 542 * @return ERR_OK: entry removed
grzemich 0:d7bd7384a37c 543 * ERR_MEM: entry wasn't found
grzemich 0:d7bd7384a37c 544 * ERR_ARG: entry wasn't a static entry but a dynamic one
grzemich 0:d7bd7384a37c 545 */
grzemich 0:d7bd7384a37c 546 err_t
grzemich 0:d7bd7384a37c 547 etharp_remove_static_entry(ip_addr_t *ipaddr)
grzemich 0:d7bd7384a37c 548 {
grzemich 0:d7bd7384a37c 549 s8_t i;
grzemich 0:d7bd7384a37c 550 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_remove_static_entry: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
grzemich 0:d7bd7384a37c 551 ip4_addr1_16(ipaddr), ip4_addr2_16(ipaddr), ip4_addr3_16(ipaddr), ip4_addr4_16(ipaddr)));
grzemich 0:d7bd7384a37c 552
grzemich 0:d7bd7384a37c 553 /* find or create ARP entry */
grzemich 0:d7bd7384a37c 554 i = find_entry(ipaddr, ETHARP_FLAG_FIND_ONLY);
grzemich 0:d7bd7384a37c 555 /* bail out if no entry could be found */
grzemich 0:d7bd7384a37c 556 if (i < 0) {
grzemich 0:d7bd7384a37c 557 return (err_t)i;
grzemich 0:d7bd7384a37c 558 }
grzemich 0:d7bd7384a37c 559
grzemich 0:d7bd7384a37c 560 if ((arp_table[i].state != ETHARP_STATE_STABLE) ||
grzemich 0:d7bd7384a37c 561 (arp_table[i].static_entry == 0)) {
grzemich 0:d7bd7384a37c 562 /* entry wasn't a static entry, cannot remove it */
grzemich 0:d7bd7384a37c 563 return ERR_ARG;
grzemich 0:d7bd7384a37c 564 }
grzemich 0:d7bd7384a37c 565 /* entry found, free it */
grzemich 0:d7bd7384a37c 566 free_entry(i);
grzemich 0:d7bd7384a37c 567 return ERR_OK;
grzemich 0:d7bd7384a37c 568 }
grzemich 0:d7bd7384a37c 569 #endif /* ETHARP_SUPPORT_STATIC_ENTRIES */
grzemich 0:d7bd7384a37c 570
grzemich 0:d7bd7384a37c 571 /**
grzemich 0:d7bd7384a37c 572 * Finds (stable) ethernet/IP address pair from ARP table
grzemich 0:d7bd7384a37c 573 * using interface and IP address index.
grzemich 0:d7bd7384a37c 574 * @note the addresses in the ARP table are in network order!
grzemich 0:d7bd7384a37c 575 *
grzemich 0:d7bd7384a37c 576 * @param netif points to interface index
grzemich 0:d7bd7384a37c 577 * @param ipaddr points to the (network order) IP address index
grzemich 0:d7bd7384a37c 578 * @param eth_ret points to return pointer
grzemich 0:d7bd7384a37c 579 * @param ip_ret points to return pointer
grzemich 0:d7bd7384a37c 580 * @return table index if found, -1 otherwise
grzemich 0:d7bd7384a37c 581 */
grzemich 0:d7bd7384a37c 582 s8_t
grzemich 0:d7bd7384a37c 583 etharp_find_addr(struct netif *netif, ip_addr_t *ipaddr,
grzemich 0:d7bd7384a37c 584 struct eth_addr **eth_ret, ip_addr_t **ip_ret)
grzemich 0:d7bd7384a37c 585 {
grzemich 0:d7bd7384a37c 586 s8_t i;
grzemich 0:d7bd7384a37c 587
grzemich 0:d7bd7384a37c 588 LWIP_ASSERT("eth_ret != NULL && ip_ret != NULL",
grzemich 0:d7bd7384a37c 589 eth_ret != NULL && ip_ret != NULL);
grzemich 0:d7bd7384a37c 590
grzemich 0:d7bd7384a37c 591 LWIP_UNUSED_ARG(netif);
grzemich 0:d7bd7384a37c 592
grzemich 0:d7bd7384a37c 593 i = find_entry(ipaddr, ETHARP_FLAG_FIND_ONLY);
grzemich 0:d7bd7384a37c 594 if((i >= 0) && arp_table[i].state == ETHARP_STATE_STABLE) {
grzemich 0:d7bd7384a37c 595 *eth_ret = &arp_table[i].ethaddr;
grzemich 0:d7bd7384a37c 596 *ip_ret = &arp_table[i].ipaddr;
grzemich 0:d7bd7384a37c 597 return i;
grzemich 0:d7bd7384a37c 598 }
grzemich 0:d7bd7384a37c 599 return -1;
grzemich 0:d7bd7384a37c 600 }
grzemich 0:d7bd7384a37c 601
grzemich 0:d7bd7384a37c 602 #if ETHARP_TRUST_IP_MAC
grzemich 0:d7bd7384a37c 603 /**
grzemich 0:d7bd7384a37c 604 * Updates the ARP table using the given IP packet.
grzemich 0:d7bd7384a37c 605 *
grzemich 0:d7bd7384a37c 606 * Uses the incoming IP packet's source address to update the
grzemich 0:d7bd7384a37c 607 * ARP cache for the local network. The function does not alter
grzemich 0:d7bd7384a37c 608 * or free the packet. This function must be called before the
grzemich 0:d7bd7384a37c 609 * packet p is passed to the IP layer.
grzemich 0:d7bd7384a37c 610 *
grzemich 0:d7bd7384a37c 611 * @param netif The lwIP network interface on which the IP packet pbuf arrived.
grzemich 0:d7bd7384a37c 612 * @param p The IP packet that arrived on netif.
grzemich 0:d7bd7384a37c 613 *
grzemich 0:d7bd7384a37c 614 * @return NULL
grzemich 0:d7bd7384a37c 615 *
grzemich 0:d7bd7384a37c 616 * @see pbuf_free()
grzemich 0:d7bd7384a37c 617 */
grzemich 0:d7bd7384a37c 618 static void
grzemich 0:d7bd7384a37c 619 etharp_ip_input(struct netif *netif, struct pbuf *p)
grzemich 0:d7bd7384a37c 620 {
grzemich 0:d7bd7384a37c 621 struct eth_hdr *ethhdr;
grzemich 0:d7bd7384a37c 622 struct ip_hdr *iphdr;
grzemich 0:d7bd7384a37c 623 ip_addr_t iphdr_src;
grzemich 0:d7bd7384a37c 624 LWIP_ERROR("netif != NULL", (netif != NULL), return;);
grzemich 0:d7bd7384a37c 625
grzemich 0:d7bd7384a37c 626 /* Only insert an entry if the source IP address of the
grzemich 0:d7bd7384a37c 627 incoming IP packet comes from a host on the local network. */
grzemich 0:d7bd7384a37c 628 ethhdr = (struct eth_hdr *)p->payload;
grzemich 0:d7bd7384a37c 629 iphdr = (struct ip_hdr *)((u8_t*)ethhdr + SIZEOF_ETH_HDR);
grzemich 0:d7bd7384a37c 630 #if ETHARP_SUPPORT_VLAN
grzemich 0:d7bd7384a37c 631 if (ethhdr->type == PP_HTONS(ETHTYPE_VLAN)) {
grzemich 0:d7bd7384a37c 632 iphdr = (struct ip_hdr *)((u8_t*)ethhdr + SIZEOF_ETH_HDR + SIZEOF_VLAN_HDR);
grzemich 0:d7bd7384a37c 633 }
grzemich 0:d7bd7384a37c 634 #endif /* ETHARP_SUPPORT_VLAN */
grzemich 0:d7bd7384a37c 635
grzemich 0:d7bd7384a37c 636 ip_addr_copy(iphdr_src, iphdr->src);
grzemich 0:d7bd7384a37c 637
grzemich 0:d7bd7384a37c 638 /* source is not on the local network? */
grzemich 0:d7bd7384a37c 639 if (!ip_addr_netcmp(&iphdr_src, &(netif->ip_addr), &(netif->netmask))) {
grzemich 0:d7bd7384a37c 640 /* do nothing */
grzemich 0:d7bd7384a37c 641 return;
grzemich 0:d7bd7384a37c 642 }
grzemich 0:d7bd7384a37c 643
grzemich 0:d7bd7384a37c 644 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_ip_input: updating ETHARP table.\n"));
grzemich 0:d7bd7384a37c 645 /* update the source IP address in the cache, if present */
grzemich 0:d7bd7384a37c 646 /* @todo We could use ETHARP_FLAG_TRY_HARD if we think we are going to talk
grzemich 0:d7bd7384a37c 647 * back soon (for example, if the destination IP address is ours. */
grzemich 0:d7bd7384a37c 648 update_arp_entry(netif, &iphdr_src, &(ethhdr->src), ETHARP_FLAG_FIND_ONLY);
grzemich 0:d7bd7384a37c 649 }
grzemich 0:d7bd7384a37c 650 #endif /* ETHARP_TRUST_IP_MAC */
grzemich 0:d7bd7384a37c 651
grzemich 0:d7bd7384a37c 652 /**
grzemich 0:d7bd7384a37c 653 * Responds to ARP requests to us. Upon ARP replies to us, add entry to cache
grzemich 0:d7bd7384a37c 654 * send out queued IP packets. Updates cache with snooped address pairs.
grzemich 0:d7bd7384a37c 655 *
grzemich 0:d7bd7384a37c 656 * Should be called for incoming ARP packets. The pbuf in the argument
grzemich 0:d7bd7384a37c 657 * is freed by this function.
grzemich 0:d7bd7384a37c 658 *
grzemich 0:d7bd7384a37c 659 * @param netif The lwIP network interface on which the ARP packet pbuf arrived.
grzemich 0:d7bd7384a37c 660 * @param ethaddr Ethernet address of netif.
grzemich 0:d7bd7384a37c 661 * @param p The ARP packet that arrived on netif. Is freed by this function.
grzemich 0:d7bd7384a37c 662 *
grzemich 0:d7bd7384a37c 663 * @return NULL
grzemich 0:d7bd7384a37c 664 *
grzemich 0:d7bd7384a37c 665 * @see pbuf_free()
grzemich 0:d7bd7384a37c 666 */
grzemich 0:d7bd7384a37c 667 static void
grzemich 0:d7bd7384a37c 668 etharp_arp_input(struct netif *netif, struct eth_addr *ethaddr, struct pbuf *p)
grzemich 0:d7bd7384a37c 669 {
grzemich 0:d7bd7384a37c 670 struct etharp_hdr *hdr;
grzemich 0:d7bd7384a37c 671 struct eth_hdr *ethhdr;
grzemich 0:d7bd7384a37c 672 /* these are aligned properly, whereas the ARP header fields might not be */
grzemich 0:d7bd7384a37c 673 ip_addr_t sipaddr, dipaddr;
grzemich 0:d7bd7384a37c 674 u8_t for_us;
grzemich 0:d7bd7384a37c 675 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 676 const u8_t * ethdst_hwaddr;
grzemich 0:d7bd7384a37c 677 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 678
grzemich 0:d7bd7384a37c 679 LWIP_ERROR("netif != NULL", (netif != NULL), return;);
grzemich 0:d7bd7384a37c 680
grzemich 0:d7bd7384a37c 681 /* drop short ARP packets: we have to check for p->len instead of p->tot_len here
grzemich 0:d7bd7384a37c 682 since a struct etharp_hdr is pointed to p->payload, so it musn't be chained! */
grzemich 0:d7bd7384a37c 683 if (p->len < SIZEOF_ETHARP_PACKET) {
grzemich 0:d7bd7384a37c 684 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING,
grzemich 0:d7bd7384a37c 685 ("etharp_arp_input: packet dropped, too short (%"S16_F"/%"S16_F")\n", p->tot_len,
grzemich 0:d7bd7384a37c 686 (s16_t)SIZEOF_ETHARP_PACKET));
grzemich 0:d7bd7384a37c 687 ETHARP_STATS_INC(etharp.lenerr);
grzemich 0:d7bd7384a37c 688 ETHARP_STATS_INC(etharp.drop);
grzemich 0:d7bd7384a37c 689 pbuf_free(p);
grzemich 0:d7bd7384a37c 690 return;
grzemich 0:d7bd7384a37c 691 }
grzemich 0:d7bd7384a37c 692
grzemich 0:d7bd7384a37c 693 ethhdr = (struct eth_hdr *)p->payload;
grzemich 0:d7bd7384a37c 694 hdr = (struct etharp_hdr *)((u8_t*)ethhdr + SIZEOF_ETH_HDR);
grzemich 0:d7bd7384a37c 695 #if ETHARP_SUPPORT_VLAN
grzemich 0:d7bd7384a37c 696 if (ethhdr->type == PP_HTONS(ETHTYPE_VLAN)) {
grzemich 0:d7bd7384a37c 697 hdr = (struct etharp_hdr *)(((u8_t*)ethhdr) + SIZEOF_ETH_HDR + SIZEOF_VLAN_HDR);
grzemich 0:d7bd7384a37c 698 }
grzemich 0:d7bd7384a37c 699 #endif /* ETHARP_SUPPORT_VLAN */
grzemich 0:d7bd7384a37c 700
grzemich 0:d7bd7384a37c 701 /* RFC 826 "Packet Reception": */
grzemich 0:d7bd7384a37c 702 if ((hdr->hwtype != PP_HTONS(HWTYPE_ETHERNET)) ||
grzemich 0:d7bd7384a37c 703 (hdr->hwlen != ETHARP_HWADDR_LEN) ||
grzemich 0:d7bd7384a37c 704 (hdr->protolen != sizeof(ip_addr_t)) ||
grzemich 0:d7bd7384a37c 705 (hdr->proto != PP_HTONS(ETHTYPE_IP))) {
grzemich 0:d7bd7384a37c 706 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING,
grzemich 0:d7bd7384a37c 707 ("etharp_arp_input: packet dropped, wrong hw type, hwlen, proto, protolen or ethernet type (%"U16_F"/%"U16_F"/%"U16_F"/%"U16_F")\n",
grzemich 0:d7bd7384a37c 708 hdr->hwtype, hdr->hwlen, hdr->proto, hdr->protolen));
grzemich 0:d7bd7384a37c 709 ETHARP_STATS_INC(etharp.proterr);
grzemich 0:d7bd7384a37c 710 ETHARP_STATS_INC(etharp.drop);
grzemich 0:d7bd7384a37c 711 pbuf_free(p);
grzemich 0:d7bd7384a37c 712 return;
grzemich 0:d7bd7384a37c 713 }
grzemich 0:d7bd7384a37c 714 ETHARP_STATS_INC(etharp.recv);
grzemich 0:d7bd7384a37c 715
grzemich 0:d7bd7384a37c 716 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 717 /* We have to check if a host already has configured our random
grzemich 0:d7bd7384a37c 718 * created link local address and continously check if there is
grzemich 0:d7bd7384a37c 719 * a host with this IP-address so we can detect collisions */
grzemich 0:d7bd7384a37c 720 autoip_arp_reply(netif, hdr);
grzemich 0:d7bd7384a37c 721 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 722
grzemich 0:d7bd7384a37c 723 /* Copy struct ip_addr2 to aligned ip_addr, to support compilers without
grzemich 0:d7bd7384a37c 724 * structure packing (not using structure copy which breaks strict-aliasing rules). */
grzemich 0:d7bd7384a37c 725 IPADDR2_COPY(&sipaddr, &hdr->sipaddr);
grzemich 0:d7bd7384a37c 726 IPADDR2_COPY(&dipaddr, &hdr->dipaddr);
grzemich 0:d7bd7384a37c 727
grzemich 0:d7bd7384a37c 728 /* this interface is not configured? */
grzemich 0:d7bd7384a37c 729 if (ip_addr_isany(&netif->ip_addr)) {
grzemich 0:d7bd7384a37c 730 for_us = 0;
grzemich 0:d7bd7384a37c 731 } else {
grzemich 0:d7bd7384a37c 732 /* ARP packet directed to us? */
grzemich 0:d7bd7384a37c 733 for_us = (u8_t)ip_addr_cmp(&dipaddr, &(netif->ip_addr));
grzemich 0:d7bd7384a37c 734 }
grzemich 0:d7bd7384a37c 735
grzemich 0:d7bd7384a37c 736 /* ARP message directed to us?
grzemich 0:d7bd7384a37c 737 -> add IP address in ARP cache; assume requester wants to talk to us,
grzemich 0:d7bd7384a37c 738 can result in directly sending the queued packets for this host.
grzemich 0:d7bd7384a37c 739 ARP message not directed to us?
grzemich 0:d7bd7384a37c 740 -> update the source IP address in the cache, if present */
grzemich 0:d7bd7384a37c 741 update_arp_entry(netif, &sipaddr, &(hdr->shwaddr),
grzemich 0:d7bd7384a37c 742 for_us ? ETHARP_FLAG_TRY_HARD : ETHARP_FLAG_FIND_ONLY);
grzemich 0:d7bd7384a37c 743
grzemich 0:d7bd7384a37c 744 /* now act on the message itself */
grzemich 0:d7bd7384a37c 745 switch (hdr->opcode) {
grzemich 0:d7bd7384a37c 746 /* ARP request? */
grzemich 0:d7bd7384a37c 747 case PP_HTONS(ARP_REQUEST):
grzemich 0:d7bd7384a37c 748 /* ARP request. If it asked for our address, we send out a
grzemich 0:d7bd7384a37c 749 * reply. In any case, we time-stamp any existing ARP entry,
grzemich 0:d7bd7384a37c 750 * and possiby send out an IP packet that was queued on it. */
grzemich 0:d7bd7384a37c 751
grzemich 0:d7bd7384a37c 752 LWIP_DEBUGF (ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_arp_input: incoming ARP request\n"));
grzemich 0:d7bd7384a37c 753 /* ARP request for our address? */
grzemich 0:d7bd7384a37c 754 if (for_us) {
grzemich 0:d7bd7384a37c 755
grzemich 0:d7bd7384a37c 756 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_arp_input: replying to ARP request for our IP address\n"));
grzemich 0:d7bd7384a37c 757 /* Re-use pbuf to send ARP reply.
grzemich 0:d7bd7384a37c 758 Since we are re-using an existing pbuf, we can't call etharp_raw since
grzemich 0:d7bd7384a37c 759 that would allocate a new pbuf. */
grzemich 0:d7bd7384a37c 760 hdr->opcode = htons(ARP_REPLY);
grzemich 0:d7bd7384a37c 761
grzemich 0:d7bd7384a37c 762 IPADDR2_COPY(&hdr->dipaddr, &hdr->sipaddr);
grzemich 0:d7bd7384a37c 763 IPADDR2_COPY(&hdr->sipaddr, &netif->ip_addr);
grzemich 0:d7bd7384a37c 764
grzemich 0:d7bd7384a37c 765 LWIP_ASSERT("netif->hwaddr_len must be the same as ETHARP_HWADDR_LEN for etharp!",
grzemich 0:d7bd7384a37c 766 (netif->hwaddr_len == ETHARP_HWADDR_LEN));
grzemich 0:d7bd7384a37c 767 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 768 /* If we are using Link-Local, all ARP packets that contain a Link-Local
grzemich 0:d7bd7384a37c 769 * 'sender IP address' MUST be sent using link-layer broadcast instead of
grzemich 0:d7bd7384a37c 770 * link-layer unicast. (See RFC3927 Section 2.5, last paragraph) */
grzemich 0:d7bd7384a37c 771 ethdst_hwaddr = ip_addr_islinklocal(&netif->ip_addr) ? (u8_t*)(ethbroadcast.addr) : hdr->shwaddr.addr;
grzemich 0:d7bd7384a37c 772 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 773
grzemich 0:d7bd7384a37c 774 ETHADDR16_COPY(&hdr->dhwaddr, &hdr->shwaddr);
grzemich 0:d7bd7384a37c 775 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 776 ETHADDR16_COPY(&ethhdr->dest, ethdst_hwaddr);
grzemich 0:d7bd7384a37c 777 #else /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 778 ETHADDR16_COPY(&ethhdr->dest, &hdr->shwaddr);
grzemich 0:d7bd7384a37c 779 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 780 ETHADDR16_COPY(&hdr->shwaddr, ethaddr);
grzemich 0:d7bd7384a37c 781 ETHADDR16_COPY(&ethhdr->src, ethaddr);
grzemich 0:d7bd7384a37c 782
grzemich 0:d7bd7384a37c 783 /* hwtype, hwaddr_len, proto, protolen and the type in the ethernet header
grzemich 0:d7bd7384a37c 784 are already correct, we tested that before */
grzemich 0:d7bd7384a37c 785
grzemich 0:d7bd7384a37c 786 /* return ARP reply */
grzemich 0:d7bd7384a37c 787 netif->linkoutput(netif, p);
grzemich 0:d7bd7384a37c 788 /* we are not configured? */
grzemich 0:d7bd7384a37c 789 } else if (ip_addr_isany(&netif->ip_addr)) {
grzemich 0:d7bd7384a37c 790 /* { for_us == 0 and netif->ip_addr.addr == 0 } */
grzemich 0:d7bd7384a37c 791 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_arp_input: we are unconfigured, ARP request ignored.\n"));
grzemich 0:d7bd7384a37c 792 /* request was not directed to us */
grzemich 0:d7bd7384a37c 793 } else {
grzemich 0:d7bd7384a37c 794 /* { for_us == 0 and netif->ip_addr.addr != 0 } */
grzemich 0:d7bd7384a37c 795 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_arp_input: ARP request was not for us.\n"));
grzemich 0:d7bd7384a37c 796 }
grzemich 0:d7bd7384a37c 797 break;
grzemich 0:d7bd7384a37c 798 case PP_HTONS(ARP_REPLY):
grzemich 0:d7bd7384a37c 799 /* ARP reply. We already updated the ARP cache earlier. */
grzemich 0:d7bd7384a37c 800 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_arp_input: incoming ARP reply\n"));
grzemich 0:d7bd7384a37c 801 #if (LWIP_DHCP && DHCP_DOES_ARP_CHECK)
grzemich 0:d7bd7384a37c 802 /* DHCP wants to know about ARP replies from any host with an
grzemich 0:d7bd7384a37c 803 * IP address also offered to us by the DHCP server. We do not
grzemich 0:d7bd7384a37c 804 * want to take a duplicate IP address on a single network.
grzemich 0:d7bd7384a37c 805 * @todo How should we handle redundant (fail-over) interfaces? */
grzemich 0:d7bd7384a37c 806 dhcp_arp_reply(netif, &sipaddr);
grzemich 0:d7bd7384a37c 807 #endif /* (LWIP_DHCP && DHCP_DOES_ARP_CHECK) */
grzemich 0:d7bd7384a37c 808 break;
grzemich 0:d7bd7384a37c 809 default:
grzemich 0:d7bd7384a37c 810 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_arp_input: ARP unknown opcode type %"S16_F"\n", htons(hdr->opcode)));
grzemich 0:d7bd7384a37c 811 ETHARP_STATS_INC(etharp.err);
grzemich 0:d7bd7384a37c 812 break;
grzemich 0:d7bd7384a37c 813 }
grzemich 0:d7bd7384a37c 814 /* free ARP packet */
grzemich 0:d7bd7384a37c 815 pbuf_free(p);
grzemich 0:d7bd7384a37c 816 }
grzemich 0:d7bd7384a37c 817
grzemich 0:d7bd7384a37c 818 /**
grzemich 0:d7bd7384a37c 819 * Resolve and fill-in Ethernet address header for outgoing IP packet.
grzemich 0:d7bd7384a37c 820 *
grzemich 0:d7bd7384a37c 821 * For IP multicast and broadcast, corresponding Ethernet addresses
grzemich 0:d7bd7384a37c 822 * are selected and the packet is transmitted on the link.
grzemich 0:d7bd7384a37c 823 *
grzemich 0:d7bd7384a37c 824 * For unicast addresses, the packet is submitted to etharp_query(). In
grzemich 0:d7bd7384a37c 825 * case the IP address is outside the local network, the IP address of
grzemich 0:d7bd7384a37c 826 * the gateway is used.
grzemich 0:d7bd7384a37c 827 *
grzemich 0:d7bd7384a37c 828 * @param netif The lwIP network interface which the IP packet will be sent on.
grzemich 0:d7bd7384a37c 829 * @param q The pbuf(s) containing the IP packet to be sent.
grzemich 0:d7bd7384a37c 830 * @param ipaddr The IP address of the packet destination.
grzemich 0:d7bd7384a37c 831 *
grzemich 0:d7bd7384a37c 832 * @return
grzemich 0:d7bd7384a37c 833 * - ERR_RTE No route to destination (no gateway to external networks),
grzemich 0:d7bd7384a37c 834 * or the return type of either etharp_query() or etharp_send_ip().
grzemich 0:d7bd7384a37c 835 */
grzemich 0:d7bd7384a37c 836 err_t
grzemich 0:d7bd7384a37c 837 etharp_output(struct netif *netif, struct pbuf *q, ip_addr_t *ipaddr)
grzemich 0:d7bd7384a37c 838 {
grzemich 0:d7bd7384a37c 839 struct eth_addr *dest, mcastaddr;
grzemich 0:d7bd7384a37c 840
grzemich 0:d7bd7384a37c 841 /* make room for Ethernet header - should not fail */
grzemich 0:d7bd7384a37c 842 if (pbuf_header(q, sizeof(struct eth_hdr)) != 0) {
grzemich 0:d7bd7384a37c 843 /* bail out */
grzemich 0:d7bd7384a37c 844 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS,
grzemich 0:d7bd7384a37c 845 ("etharp_output: could not allocate room for header.\n"));
grzemich 0:d7bd7384a37c 846 LINK_STATS_INC(link.lenerr);
grzemich 0:d7bd7384a37c 847 return ERR_BUF;
grzemich 0:d7bd7384a37c 848 }
grzemich 0:d7bd7384a37c 849
grzemich 0:d7bd7384a37c 850 /* assume unresolved Ethernet address */
grzemich 0:d7bd7384a37c 851 dest = NULL;
grzemich 0:d7bd7384a37c 852 /* Determine on destination hardware address. Broadcasts and multicasts
grzemich 0:d7bd7384a37c 853 * are special, other IP addresses are looked up in the ARP table. */
grzemich 0:d7bd7384a37c 854
grzemich 0:d7bd7384a37c 855 /* broadcast destination IP address? */
grzemich 0:d7bd7384a37c 856 if (ip_addr_isbroadcast(ipaddr, netif)) {
grzemich 0:d7bd7384a37c 857 /* broadcast on Ethernet also */
grzemich 0:d7bd7384a37c 858 dest = (struct eth_addr *)&ethbroadcast;
grzemich 0:d7bd7384a37c 859 /* multicast destination IP address? */
grzemich 0:d7bd7384a37c 860 } else if (ip_addr_ismulticast(ipaddr)) {
grzemich 0:d7bd7384a37c 861 /* Hash IP multicast address to MAC address.*/
grzemich 0:d7bd7384a37c 862 mcastaddr.addr[0] = 0x01;
grzemich 0:d7bd7384a37c 863 mcastaddr.addr[1] = 0x00;
grzemich 0:d7bd7384a37c 864 mcastaddr.addr[2] = 0x5e;
grzemich 0:d7bd7384a37c 865 mcastaddr.addr[3] = ip4_addr2(ipaddr) & 0x7f;
grzemich 0:d7bd7384a37c 866 mcastaddr.addr[4] = ip4_addr3(ipaddr);
grzemich 0:d7bd7384a37c 867 mcastaddr.addr[5] = ip4_addr4(ipaddr);
grzemich 0:d7bd7384a37c 868 /* destination Ethernet address is multicast */
grzemich 0:d7bd7384a37c 869 dest = &mcastaddr;
grzemich 0:d7bd7384a37c 870 /* unicast destination IP address? */
grzemich 0:d7bd7384a37c 871 } else {
grzemich 0:d7bd7384a37c 872 /* outside local network? */
grzemich 0:d7bd7384a37c 873 if (!ip_addr_netcmp(ipaddr, &(netif->ip_addr), &(netif->netmask)) &&
grzemich 0:d7bd7384a37c 874 !ip_addr_islinklocal(ipaddr)) {
grzemich 0:d7bd7384a37c 875 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 876 struct ip_hdr *iphdr = (struct ip_hdr*)((u8_t*)q->payload +
grzemich 0:d7bd7384a37c 877 sizeof(struct eth_hdr));
grzemich 0:d7bd7384a37c 878 /* According to RFC 3297, chapter 2.6.2 (Forwarding Rules), a packet with
grzemich 0:d7bd7384a37c 879 a link-local source address must always be "directly to its destination
grzemich 0:d7bd7384a37c 880 on the same physical link. The host MUST NOT send the packet to any
grzemich 0:d7bd7384a37c 881 router for forwarding". */
grzemich 0:d7bd7384a37c 882 if (!ip_addr_islinklocal(&iphdr->src))
grzemich 0:d7bd7384a37c 883 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 884 {
grzemich 0:d7bd7384a37c 885 /* interface has default gateway? */
grzemich 0:d7bd7384a37c 886 if (!ip_addr_isany(&netif->gw)) {
grzemich 0:d7bd7384a37c 887 /* send to hardware address of default gateway IP address */
grzemich 0:d7bd7384a37c 888 ipaddr = &(netif->gw);
grzemich 0:d7bd7384a37c 889 /* no default gateway available */
grzemich 0:d7bd7384a37c 890 } else {
grzemich 0:d7bd7384a37c 891 /* no route to destination error (default gateway missing) */
grzemich 0:d7bd7384a37c 892 return ERR_RTE;
grzemich 0:d7bd7384a37c 893 }
grzemich 0:d7bd7384a37c 894 }
grzemich 0:d7bd7384a37c 895 }
grzemich 0:d7bd7384a37c 896 #if LWIP_NETIF_HWADDRHINT
grzemich 0:d7bd7384a37c 897 if (netif->addr_hint != NULL) {
grzemich 0:d7bd7384a37c 898 /* per-pcb cached entry was given */
grzemich 0:d7bd7384a37c 899 u8_t etharp_cached_entry = *(netif->addr_hint);
grzemich 0:d7bd7384a37c 900 if (etharp_cached_entry < ARP_TABLE_SIZE) {
grzemich 0:d7bd7384a37c 901 #endif /* LWIP_NETIF_HWADDRHINT */
grzemich 0:d7bd7384a37c 902 if ((arp_table[etharp_cached_entry].state == ETHARP_STATE_STABLE) &&
grzemich 0:d7bd7384a37c 903 (ip_addr_cmp(ipaddr, &arp_table[etharp_cached_entry].ipaddr))) {
grzemich 0:d7bd7384a37c 904 /* the per-pcb-cached entry is stable and the right one! */
grzemich 0:d7bd7384a37c 905 ETHARP_STATS_INC(etharp.cachehit);
grzemich 0:d7bd7384a37c 906 return etharp_send_ip(netif, q, (struct eth_addr*)(netif->hwaddr),
grzemich 0:d7bd7384a37c 907 &arp_table[etharp_cached_entry].ethaddr);
grzemich 0:d7bd7384a37c 908 }
grzemich 0:d7bd7384a37c 909 #if LWIP_NETIF_HWADDRHINT
grzemich 0:d7bd7384a37c 910 }
grzemich 0:d7bd7384a37c 911 }
grzemich 0:d7bd7384a37c 912 #endif /* LWIP_NETIF_HWADDRHINT */
grzemich 0:d7bd7384a37c 913 /* queue on destination Ethernet address belonging to ipaddr */
grzemich 0:d7bd7384a37c 914 return etharp_query(netif, ipaddr, q);
grzemich 0:d7bd7384a37c 915 }
grzemich 0:d7bd7384a37c 916
grzemich 0:d7bd7384a37c 917 /* continuation for multicast/broadcast destinations */
grzemich 0:d7bd7384a37c 918 /* obtain source Ethernet address of the given interface */
grzemich 0:d7bd7384a37c 919 /* send packet directly on the link */
grzemich 0:d7bd7384a37c 920 return etharp_send_ip(netif, q, (struct eth_addr*)(netif->hwaddr), dest);
grzemich 0:d7bd7384a37c 921 }
grzemich 0:d7bd7384a37c 922
grzemich 0:d7bd7384a37c 923 /**
grzemich 0:d7bd7384a37c 924 * Send an ARP request for the given IP address and/or queue a packet.
grzemich 0:d7bd7384a37c 925 *
grzemich 0:d7bd7384a37c 926 * If the IP address was not yet in the cache, a pending ARP cache entry
grzemich 0:d7bd7384a37c 927 * is added and an ARP request is sent for the given address. The packet
grzemich 0:d7bd7384a37c 928 * is queued on this entry.
grzemich 0:d7bd7384a37c 929 *
grzemich 0:d7bd7384a37c 930 * If the IP address was already pending in the cache, a new ARP request
grzemich 0:d7bd7384a37c 931 * is sent for the given address. The packet is queued on this entry.
grzemich 0:d7bd7384a37c 932 *
grzemich 0:d7bd7384a37c 933 * If the IP address was already stable in the cache, and a packet is
grzemich 0:d7bd7384a37c 934 * given, it is directly sent and no ARP request is sent out.
grzemich 0:d7bd7384a37c 935 *
grzemich 0:d7bd7384a37c 936 * If the IP address was already stable in the cache, and no packet is
grzemich 0:d7bd7384a37c 937 * given, an ARP request is sent out.
grzemich 0:d7bd7384a37c 938 *
grzemich 0:d7bd7384a37c 939 * @param netif The lwIP network interface on which ipaddr
grzemich 0:d7bd7384a37c 940 * must be queried for.
grzemich 0:d7bd7384a37c 941 * @param ipaddr The IP address to be resolved.
grzemich 0:d7bd7384a37c 942 * @param q If non-NULL, a pbuf that must be delivered to the IP address.
grzemich 0:d7bd7384a37c 943 * q is not freed by this function.
grzemich 0:d7bd7384a37c 944 *
grzemich 0:d7bd7384a37c 945 * @note q must only be ONE packet, not a packet queue!
grzemich 0:d7bd7384a37c 946 *
grzemich 0:d7bd7384a37c 947 * @return
grzemich 0:d7bd7384a37c 948 * - ERR_BUF Could not make room for Ethernet header.
grzemich 0:d7bd7384a37c 949 * - ERR_MEM Hardware address unknown, and no more ARP entries available
grzemich 0:d7bd7384a37c 950 * to query for address or queue the packet.
grzemich 0:d7bd7384a37c 951 * - ERR_MEM Could not queue packet due to memory shortage.
grzemich 0:d7bd7384a37c 952 * - ERR_RTE No route to destination (no gateway to external networks).
grzemich 0:d7bd7384a37c 953 * - ERR_ARG Non-unicast address given, those will not appear in ARP cache.
grzemich 0:d7bd7384a37c 954 *
grzemich 0:d7bd7384a37c 955 */
grzemich 0:d7bd7384a37c 956 err_t
grzemich 0:d7bd7384a37c 957 etharp_query(struct netif *netif, ip_addr_t *ipaddr, struct pbuf *q)
grzemich 0:d7bd7384a37c 958 {
grzemich 0:d7bd7384a37c 959 struct eth_addr * srcaddr = (struct eth_addr *)netif->hwaddr;
grzemich 0:d7bd7384a37c 960 err_t result = ERR_MEM;
grzemich 0:d7bd7384a37c 961 s8_t i; /* ARP entry index */
grzemich 0:d7bd7384a37c 962
grzemich 0:d7bd7384a37c 963 /* non-unicast address? */
grzemich 0:d7bd7384a37c 964 if (ip_addr_isbroadcast(ipaddr, netif) ||
grzemich 0:d7bd7384a37c 965 ip_addr_ismulticast(ipaddr) ||
grzemich 0:d7bd7384a37c 966 ip_addr_isany(ipaddr)) {
grzemich 0:d7bd7384a37c 967 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: will not add non-unicast IP address to ARP cache\n"));
grzemich 0:d7bd7384a37c 968 return ERR_ARG;
grzemich 0:d7bd7384a37c 969 }
grzemich 0:d7bd7384a37c 970
grzemich 0:d7bd7384a37c 971 /* find entry in ARP cache, ask to create entry if queueing packet */
grzemich 0:d7bd7384a37c 972 i = find_entry(ipaddr, ETHARP_FLAG_TRY_HARD);
grzemich 0:d7bd7384a37c 973
grzemich 0:d7bd7384a37c 974 /* could not find or create entry? */
grzemich 0:d7bd7384a37c 975 if (i < 0) {
grzemich 0:d7bd7384a37c 976 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: could not create ARP entry\n"));
grzemich 0:d7bd7384a37c 977 if (q) {
grzemich 0:d7bd7384a37c 978 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: packet dropped\n"));
grzemich 0:d7bd7384a37c 979 ETHARP_STATS_INC(etharp.memerr);
grzemich 0:d7bd7384a37c 980 }
grzemich 0:d7bd7384a37c 981 return (err_t)i;
grzemich 0:d7bd7384a37c 982 }
grzemich 0:d7bd7384a37c 983
grzemich 0:d7bd7384a37c 984 /* mark a fresh entry as pending (we just sent a request) */
grzemich 0:d7bd7384a37c 985 if (arp_table[i].state == ETHARP_STATE_EMPTY) {
grzemich 0:d7bd7384a37c 986 arp_table[i].state = ETHARP_STATE_PENDING;
grzemich 0:d7bd7384a37c 987 }
grzemich 0:d7bd7384a37c 988
grzemich 0:d7bd7384a37c 989 /* { i is either a STABLE or (new or existing) PENDING entry } */
grzemich 0:d7bd7384a37c 990 LWIP_ASSERT("arp_table[i].state == PENDING or STABLE",
grzemich 0:d7bd7384a37c 991 ((arp_table[i].state == ETHARP_STATE_PENDING) ||
grzemich 0:d7bd7384a37c 992 (arp_table[i].state == ETHARP_STATE_STABLE)));
grzemich 0:d7bd7384a37c 993
grzemich 0:d7bd7384a37c 994 /* do we have a pending entry? or an implicit query request? */
grzemich 0:d7bd7384a37c 995 if ((arp_table[i].state == ETHARP_STATE_PENDING) || (q == NULL)) {
grzemich 0:d7bd7384a37c 996 /* try to resolve it; send out ARP request */
grzemich 0:d7bd7384a37c 997 result = etharp_request(netif, ipaddr);
grzemich 0:d7bd7384a37c 998 if (result != ERR_OK) {
grzemich 0:d7bd7384a37c 999 /* ARP request couldn't be sent */
grzemich 0:d7bd7384a37c 1000 /* We don't re-send arp request in etharp_tmr, but we still queue packets,
grzemich 0:d7bd7384a37c 1001 since this failure could be temporary, and the next packet calling
grzemich 0:d7bd7384a37c 1002 etharp_query again could lead to sending the queued packets. */
grzemich 0:d7bd7384a37c 1003 }
grzemich 0:d7bd7384a37c 1004 if (q == NULL) {
grzemich 0:d7bd7384a37c 1005 return result;
grzemich 0:d7bd7384a37c 1006 }
grzemich 0:d7bd7384a37c 1007 }
grzemich 0:d7bd7384a37c 1008
grzemich 0:d7bd7384a37c 1009 /* packet given? */
grzemich 0:d7bd7384a37c 1010 LWIP_ASSERT("q != NULL", q != NULL);
grzemich 0:d7bd7384a37c 1011 /* stable entry? */
grzemich 0:d7bd7384a37c 1012 if (arp_table[i].state == ETHARP_STATE_STABLE) {
grzemich 0:d7bd7384a37c 1013 /* we have a valid IP->Ethernet address mapping */
grzemich 0:d7bd7384a37c 1014 ETHARP_SET_HINT(netif, i);
grzemich 0:d7bd7384a37c 1015 /* send the packet */
grzemich 0:d7bd7384a37c 1016 result = etharp_send_ip(netif, q, srcaddr, &(arp_table[i].ethaddr));
grzemich 0:d7bd7384a37c 1017 /* pending entry? (either just created or already pending */
grzemich 0:d7bd7384a37c 1018 } else if (arp_table[i].state == ETHARP_STATE_PENDING) {
grzemich 0:d7bd7384a37c 1019 /* entry is still pending, queue the given packet 'q' */
grzemich 0:d7bd7384a37c 1020 struct pbuf *p;
grzemich 0:d7bd7384a37c 1021 int copy_needed = 0;
grzemich 0:d7bd7384a37c 1022 /* IF q includes a PBUF_REF, PBUF_POOL or PBUF_RAM, we have no choice but
grzemich 0:d7bd7384a37c 1023 * to copy the whole queue into a new PBUF_RAM (see bug #11400)
grzemich 0:d7bd7384a37c 1024 * PBUF_ROMs can be left as they are, since ROM must not get changed. */
grzemich 0:d7bd7384a37c 1025 p = q;
grzemich 0:d7bd7384a37c 1026 while (p) {
grzemich 0:d7bd7384a37c 1027 LWIP_ASSERT("no packet queues allowed!", (p->len != p->tot_len) || (p->next == 0));
grzemich 0:d7bd7384a37c 1028 if(p->type != PBUF_ROM) {
grzemich 0:d7bd7384a37c 1029 copy_needed = 1;
grzemich 0:d7bd7384a37c 1030 break;
grzemich 0:d7bd7384a37c 1031 }
grzemich 0:d7bd7384a37c 1032 p = p->next;
grzemich 0:d7bd7384a37c 1033 }
grzemich 0:d7bd7384a37c 1034 if(copy_needed) {
grzemich 0:d7bd7384a37c 1035 /* copy the whole packet into new pbufs */
grzemich 0:d7bd7384a37c 1036 p = pbuf_alloc(PBUF_RAW, p->tot_len, PBUF_RAM);
grzemich 0:d7bd7384a37c 1037 if(p != NULL) {
grzemich 0:d7bd7384a37c 1038 if (pbuf_copy(p, q) != ERR_OK) {
grzemich 0:d7bd7384a37c 1039 pbuf_free(p);
grzemich 0:d7bd7384a37c 1040 p = NULL;
grzemich 0:d7bd7384a37c 1041 }
grzemich 0:d7bd7384a37c 1042 }
grzemich 0:d7bd7384a37c 1043 } else {
grzemich 0:d7bd7384a37c 1044 /* referencing the old pbuf is enough */
grzemich 0:d7bd7384a37c 1045 p = q;
grzemich 0:d7bd7384a37c 1046 pbuf_ref(p);
grzemich 0:d7bd7384a37c 1047 }
grzemich 0:d7bd7384a37c 1048 /* packet could be taken over? */
grzemich 0:d7bd7384a37c 1049 if (p != NULL) {
grzemich 0:d7bd7384a37c 1050 /* queue packet ... */
grzemich 0:d7bd7384a37c 1051 #if ARP_QUEUEING
grzemich 0:d7bd7384a37c 1052 struct etharp_q_entry *new_entry;
grzemich 0:d7bd7384a37c 1053 /* allocate a new arp queue entry */
grzemich 0:d7bd7384a37c 1054 new_entry = (struct etharp_q_entry *)memp_malloc(MEMP_ARP_QUEUE);
grzemich 0:d7bd7384a37c 1055 if (new_entry != NULL) {
grzemich 0:d7bd7384a37c 1056 new_entry->next = 0;
grzemich 0:d7bd7384a37c 1057 new_entry->p = p;
grzemich 0:d7bd7384a37c 1058 if(arp_table[i].q != NULL) {
grzemich 0:d7bd7384a37c 1059 /* queue was already existent, append the new entry to the end */
grzemich 0:d7bd7384a37c 1060 struct etharp_q_entry *r;
grzemich 0:d7bd7384a37c 1061 r = arp_table[i].q;
grzemich 0:d7bd7384a37c 1062 while (r->next != NULL) {
grzemich 0:d7bd7384a37c 1063 r = r->next;
grzemich 0:d7bd7384a37c 1064 }
grzemich 0:d7bd7384a37c 1065 r->next = new_entry;
grzemich 0:d7bd7384a37c 1066 } else {
grzemich 0:d7bd7384a37c 1067 /* queue did not exist, first item in queue */
grzemich 0:d7bd7384a37c 1068 arp_table[i].q = new_entry;
grzemich 0:d7bd7384a37c 1069 }
grzemich 0:d7bd7384a37c 1070 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: queued packet %p on ARP entry %"S16_F"\n", (void *)q, (s16_t)i));
grzemich 0:d7bd7384a37c 1071 result = ERR_OK;
grzemich 0:d7bd7384a37c 1072 } else {
grzemich 0:d7bd7384a37c 1073 /* the pool MEMP_ARP_QUEUE is empty */
grzemich 0:d7bd7384a37c 1074 pbuf_free(p);
grzemich 0:d7bd7384a37c 1075 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: could not queue a copy of PBUF_REF packet %p (out of memory)\n", (void *)q));
grzemich 0:d7bd7384a37c 1076 result = ERR_MEM;
grzemich 0:d7bd7384a37c 1077 }
grzemich 0:d7bd7384a37c 1078 #else /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 1079 /* always queue one packet per ARP request only, freeing a previously queued packet */
grzemich 0:d7bd7384a37c 1080 if (arp_table[i].q != NULL) {
grzemich 0:d7bd7384a37c 1081 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: dropped previously queued packet %p for ARP entry %"S16_F"\n", (void *)q, (s16_t)i));
grzemich 0:d7bd7384a37c 1082 pbuf_free(arp_table[i].q);
grzemich 0:d7bd7384a37c 1083 }
grzemich 0:d7bd7384a37c 1084 arp_table[i].q = p;
grzemich 0:d7bd7384a37c 1085 result = ERR_OK;
grzemich 0:d7bd7384a37c 1086 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: queued packet %p on ARP entry %"S16_F"\n", (void *)q, (s16_t)i));
grzemich 0:d7bd7384a37c 1087 #endif /* ARP_QUEUEING */
grzemich 0:d7bd7384a37c 1088 } else {
grzemich 0:d7bd7384a37c 1089 ETHARP_STATS_INC(etharp.memerr);
grzemich 0:d7bd7384a37c 1090 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_query: could not queue a copy of PBUF_REF packet %p (out of memory)\n", (void *)q));
grzemich 0:d7bd7384a37c 1091 result = ERR_MEM;
grzemich 0:d7bd7384a37c 1092 }
grzemich 0:d7bd7384a37c 1093 }
grzemich 0:d7bd7384a37c 1094 return result;
grzemich 0:d7bd7384a37c 1095 }
grzemich 0:d7bd7384a37c 1096
grzemich 0:d7bd7384a37c 1097 /**
grzemich 0:d7bd7384a37c 1098 * Send a raw ARP packet (opcode and all addresses can be modified)
grzemich 0:d7bd7384a37c 1099 *
grzemich 0:d7bd7384a37c 1100 * @param netif the lwip network interface on which to send the ARP packet
grzemich 0:d7bd7384a37c 1101 * @param ethsrc_addr the source MAC address for the ethernet header
grzemich 0:d7bd7384a37c 1102 * @param ethdst_addr the destination MAC address for the ethernet header
grzemich 0:d7bd7384a37c 1103 * @param hwsrc_addr the source MAC address for the ARP protocol header
grzemich 0:d7bd7384a37c 1104 * @param ipsrc_addr the source IP address for the ARP protocol header
grzemich 0:d7bd7384a37c 1105 * @param hwdst_addr the destination MAC address for the ARP protocol header
grzemich 0:d7bd7384a37c 1106 * @param ipdst_addr the destination IP address for the ARP protocol header
grzemich 0:d7bd7384a37c 1107 * @param opcode the type of the ARP packet
grzemich 0:d7bd7384a37c 1108 * @return ERR_OK if the ARP packet has been sent
grzemich 0:d7bd7384a37c 1109 * ERR_MEM if the ARP packet couldn't be allocated
grzemich 0:d7bd7384a37c 1110 * any other err_t on failure
grzemich 0:d7bd7384a37c 1111 */
grzemich 0:d7bd7384a37c 1112 #if !LWIP_AUTOIP
grzemich 0:d7bd7384a37c 1113 static
grzemich 0:d7bd7384a37c 1114 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 1115 err_t
grzemich 0:d7bd7384a37c 1116 etharp_raw(struct netif *netif, const struct eth_addr *ethsrc_addr,
grzemich 0:d7bd7384a37c 1117 const struct eth_addr *ethdst_addr,
grzemich 0:d7bd7384a37c 1118 const struct eth_addr *hwsrc_addr, const ip_addr_t *ipsrc_addr,
grzemich 0:d7bd7384a37c 1119 const struct eth_addr *hwdst_addr, const ip_addr_t *ipdst_addr,
grzemich 0:d7bd7384a37c 1120 const u16_t opcode)
grzemich 0:d7bd7384a37c 1121 {
grzemich 0:d7bd7384a37c 1122 struct pbuf *p;
grzemich 0:d7bd7384a37c 1123 err_t result = ERR_OK;
grzemich 0:d7bd7384a37c 1124 struct eth_hdr *ethhdr;
grzemich 0:d7bd7384a37c 1125 struct etharp_hdr *hdr;
grzemich 0:d7bd7384a37c 1126 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 1127 const u8_t * ethdst_hwaddr;
grzemich 0:d7bd7384a37c 1128 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 1129
grzemich 0:d7bd7384a37c 1130 /* allocate a pbuf for the outgoing ARP request packet */
grzemich 0:d7bd7384a37c 1131 p = pbuf_alloc(PBUF_RAW, SIZEOF_ETHARP_PACKET, PBUF_RAM);
grzemich 0:d7bd7384a37c 1132 /* could allocate a pbuf for an ARP request? */
grzemich 0:d7bd7384a37c 1133 if (p == NULL) {
grzemich 0:d7bd7384a37c 1134 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS,
grzemich 0:d7bd7384a37c 1135 ("etharp_raw: could not allocate pbuf for ARP request.\n"));
grzemich 0:d7bd7384a37c 1136 ETHARP_STATS_INC(etharp.memerr);
grzemich 0:d7bd7384a37c 1137 return ERR_MEM;
grzemich 0:d7bd7384a37c 1138 }
grzemich 0:d7bd7384a37c 1139 LWIP_ASSERT("check that first pbuf can hold struct etharp_hdr",
grzemich 0:d7bd7384a37c 1140 (p->len >= SIZEOF_ETHARP_PACKET));
grzemich 0:d7bd7384a37c 1141
grzemich 0:d7bd7384a37c 1142 ethhdr = (struct eth_hdr *)p->payload;
grzemich 0:d7bd7384a37c 1143 hdr = (struct etharp_hdr *)((u8_t*)ethhdr + SIZEOF_ETH_HDR);
grzemich 0:d7bd7384a37c 1144 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_raw: sending raw ARP packet.\n"));
grzemich 0:d7bd7384a37c 1145 hdr->opcode = htons(opcode);
grzemich 0:d7bd7384a37c 1146
grzemich 0:d7bd7384a37c 1147 LWIP_ASSERT("netif->hwaddr_len must be the same as ETHARP_HWADDR_LEN for etharp!",
grzemich 0:d7bd7384a37c 1148 (netif->hwaddr_len == ETHARP_HWADDR_LEN));
grzemich 0:d7bd7384a37c 1149 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 1150 /* If we are using Link-Local, all ARP packets that contain a Link-Local
grzemich 0:d7bd7384a37c 1151 * 'sender IP address' MUST be sent using link-layer broadcast instead of
grzemich 0:d7bd7384a37c 1152 * link-layer unicast. (See RFC3927 Section 2.5, last paragraph) */
grzemich 0:d7bd7384a37c 1153 ethdst_hwaddr = ip_addr_islinklocal(ipsrc_addr) ? (u8_t*)(ethbroadcast.addr) : ethdst_addr->addr;
grzemich 0:d7bd7384a37c 1154 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 1155 /* Write the ARP MAC-Addresses */
grzemich 0:d7bd7384a37c 1156 ETHADDR16_COPY(&hdr->shwaddr, hwsrc_addr);
grzemich 0:d7bd7384a37c 1157 ETHADDR16_COPY(&hdr->dhwaddr, hwdst_addr);
grzemich 0:d7bd7384a37c 1158 /* Write the Ethernet MAC-Addresses */
grzemich 0:d7bd7384a37c 1159 #if LWIP_AUTOIP
grzemich 0:d7bd7384a37c 1160 ETHADDR16_COPY(&ethhdr->dest, ethdst_hwaddr);
grzemich 0:d7bd7384a37c 1161 #else /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 1162 ETHADDR16_COPY(&ethhdr->dest, ethdst_addr);
grzemich 0:d7bd7384a37c 1163 #endif /* LWIP_AUTOIP */
grzemich 0:d7bd7384a37c 1164 ETHADDR16_COPY(&ethhdr->src, ethsrc_addr);
grzemich 0:d7bd7384a37c 1165 /* Copy struct ip_addr2 to aligned ip_addr, to support compilers without
grzemich 0:d7bd7384a37c 1166 * structure packing. */
grzemich 0:d7bd7384a37c 1167 IPADDR2_COPY(&hdr->sipaddr, ipsrc_addr);
grzemich 0:d7bd7384a37c 1168 IPADDR2_COPY(&hdr->dipaddr, ipdst_addr);
grzemich 0:d7bd7384a37c 1169
grzemich 0:d7bd7384a37c 1170 hdr->hwtype = PP_HTONS(HWTYPE_ETHERNET);
grzemich 0:d7bd7384a37c 1171 hdr->proto = PP_HTONS(ETHTYPE_IP);
grzemich 0:d7bd7384a37c 1172 /* set hwlen and protolen */
grzemich 0:d7bd7384a37c 1173 hdr->hwlen = ETHARP_HWADDR_LEN;
grzemich 0:d7bd7384a37c 1174 hdr->protolen = sizeof(ip_addr_t);
grzemich 0:d7bd7384a37c 1175
grzemich 0:d7bd7384a37c 1176 ethhdr->type = PP_HTONS(ETHTYPE_ARP);
grzemich 0:d7bd7384a37c 1177 /* send ARP query */
grzemich 0:d7bd7384a37c 1178 result = netif->linkoutput(netif, p);
grzemich 0:d7bd7384a37c 1179 ETHARP_STATS_INC(etharp.xmit);
grzemich 0:d7bd7384a37c 1180 /* free ARP query packet */
grzemich 0:d7bd7384a37c 1181 pbuf_free(p);
grzemich 0:d7bd7384a37c 1182 p = NULL;
grzemich 0:d7bd7384a37c 1183 /* could not allocate pbuf for ARP request */
grzemich 0:d7bd7384a37c 1184
grzemich 0:d7bd7384a37c 1185 return result;
grzemich 0:d7bd7384a37c 1186 }
grzemich 0:d7bd7384a37c 1187
grzemich 0:d7bd7384a37c 1188 /**
grzemich 0:d7bd7384a37c 1189 * Send an ARP request packet asking for ipaddr.
grzemich 0:d7bd7384a37c 1190 *
grzemich 0:d7bd7384a37c 1191 * @param netif the lwip network interface on which to send the request
grzemich 0:d7bd7384a37c 1192 * @param ipaddr the IP address for which to ask
grzemich 0:d7bd7384a37c 1193 * @return ERR_OK if the request has been sent
grzemich 0:d7bd7384a37c 1194 * ERR_MEM if the ARP packet couldn't be allocated
grzemich 0:d7bd7384a37c 1195 * any other err_t on failure
grzemich 0:d7bd7384a37c 1196 */
grzemich 0:d7bd7384a37c 1197 err_t
grzemich 0:d7bd7384a37c 1198 etharp_request(struct netif *netif, ip_addr_t *ipaddr)
grzemich 0:d7bd7384a37c 1199 {
grzemich 0:d7bd7384a37c 1200 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE, ("etharp_request: sending ARP request.\n"));
grzemich 0:d7bd7384a37c 1201 return etharp_raw(netif, (struct eth_addr *)netif->hwaddr, &ethbroadcast,
grzemich 0:d7bd7384a37c 1202 (struct eth_addr *)netif->hwaddr, &netif->ip_addr, &ethzero,
grzemich 0:d7bd7384a37c 1203 ipaddr, ARP_REQUEST);
grzemich 0:d7bd7384a37c 1204 }
grzemich 0:d7bd7384a37c 1205 #endif /* LWIP_ARP */
grzemich 0:d7bd7384a37c 1206
grzemich 0:d7bd7384a37c 1207 /**
grzemich 0:d7bd7384a37c 1208 * Process received ethernet frames. Using this function instead of directly
grzemich 0:d7bd7384a37c 1209 * calling ip_input and passing ARP frames through etharp in ethernetif_input,
grzemich 0:d7bd7384a37c 1210 * the ARP cache is protected from concurrent access.
grzemich 0:d7bd7384a37c 1211 *
grzemich 0:d7bd7384a37c 1212 * @param p the recevied packet, p->payload pointing to the ethernet header
grzemich 0:d7bd7384a37c 1213 * @param netif the network interface on which the packet was received
grzemich 0:d7bd7384a37c 1214 */
grzemich 0:d7bd7384a37c 1215 err_t
grzemich 0:d7bd7384a37c 1216 ethernet_input(struct pbuf *p, struct netif *netif)
grzemich 0:d7bd7384a37c 1217 {
grzemich 0:d7bd7384a37c 1218 struct eth_hdr* ethhdr;
grzemich 0:d7bd7384a37c 1219 u16_t type;
grzemich 0:d7bd7384a37c 1220 s16_t ip_hdr_offset = SIZEOF_ETH_HDR;
grzemich 0:d7bd7384a37c 1221
grzemich 0:d7bd7384a37c 1222 if (p->len <= SIZEOF_ETH_HDR) {
grzemich 0:d7bd7384a37c 1223 /* a packet with only an ethernet header (or less) is not valid for us */
grzemich 0:d7bd7384a37c 1224 ETHARP_STATS_INC(etharp.proterr);
grzemich 0:d7bd7384a37c 1225 ETHARP_STATS_INC(etharp.drop);
grzemich 0:d7bd7384a37c 1226 goto free_and_return;
grzemich 0:d7bd7384a37c 1227 }
grzemich 0:d7bd7384a37c 1228
grzemich 0:d7bd7384a37c 1229 /* points to packet payload, which starts with an Ethernet header */
grzemich 0:d7bd7384a37c 1230 ethhdr = (struct eth_hdr *)p->payload;
grzemich 0:d7bd7384a37c 1231 LWIP_DEBUGF(ETHARP_DEBUG | LWIP_DBG_TRACE,
grzemich 0:d7bd7384a37c 1232 ("ethernet_input: dest:%"X8_F":%"X8_F":%"X8_F":%"X8_F":%"X8_F":%"X8_F", src:%"X8_F":%"X8_F":%"X8_F":%"X8_F":%"X8_F":%"X8_F", type:%"X16_F"\n",
grzemich 0:d7bd7384a37c 1233 (unsigned)ethhdr->dest.addr[0], (unsigned)ethhdr->dest.addr[1], (unsigned)ethhdr->dest.addr[2],
grzemich 0:d7bd7384a37c 1234 (unsigned)ethhdr->dest.addr[3], (unsigned)ethhdr->dest.addr[4], (unsigned)ethhdr->dest.addr[5],
grzemich 0:d7bd7384a37c 1235 (unsigned)ethhdr->src.addr[0], (unsigned)ethhdr->src.addr[1], (unsigned)ethhdr->src.addr[2],
grzemich 0:d7bd7384a37c 1236 (unsigned)ethhdr->src.addr[3], (unsigned)ethhdr->src.addr[4], (unsigned)ethhdr->src.addr[5],
grzemich 0:d7bd7384a37c 1237 (unsigned)htons(ethhdr->type)));
grzemich 0:d7bd7384a37c 1238
grzemich 0:d7bd7384a37c 1239 type = ethhdr->type;
grzemich 0:d7bd7384a37c 1240 #if ETHARP_SUPPORT_VLAN
grzemich 0:d7bd7384a37c 1241 if (type == PP_HTONS(ETHTYPE_VLAN)) {
grzemich 0:d7bd7384a37c 1242 struct eth_vlan_hdr *vlan = (struct eth_vlan_hdr*)(((char*)ethhdr) + SIZEOF_ETH_HDR);
grzemich 0:d7bd7384a37c 1243 if (p->len <= SIZEOF_ETH_HDR + SIZEOF_VLAN_HDR) {
grzemich 0:d7bd7384a37c 1244 /* a packet with only an ethernet/vlan header (or less) is not valid for us */
grzemich 0:d7bd7384a37c 1245 ETHARP_STATS_INC(etharp.proterr);
grzemich 0:d7bd7384a37c 1246 ETHARP_STATS_INC(etharp.drop);
grzemich 0:d7bd7384a37c 1247 goto free_and_return;
grzemich 0:d7bd7384a37c 1248 }
grzemich 0:d7bd7384a37c 1249 #ifdef ETHARP_VLAN_CHECK /* if not, allow all VLANs */
grzemich 0:d7bd7384a37c 1250 if (VLAN_ID(vlan) != ETHARP_VLAN_CHECK) {
grzemich 0:d7bd7384a37c 1251 /* silently ignore this packet: not for our VLAN */
grzemich 0:d7bd7384a37c 1252 pbuf_free(p);
grzemich 0:d7bd7384a37c 1253 return ERR_OK;
grzemich 0:d7bd7384a37c 1254 }
grzemich 0:d7bd7384a37c 1255 #endif /* ETHARP_VLAN_CHECK */
grzemich 0:d7bd7384a37c 1256 type = vlan->tpid;
grzemich 0:d7bd7384a37c 1257 ip_hdr_offset = SIZEOF_ETH_HDR + SIZEOF_VLAN_HDR;
grzemich 0:d7bd7384a37c 1258 }
grzemich 0:d7bd7384a37c 1259 #endif /* ETHARP_SUPPORT_VLAN */
grzemich 0:d7bd7384a37c 1260
grzemich 0:d7bd7384a37c 1261 #if LWIP_ARP_FILTER_NETIF
grzemich 0:d7bd7384a37c 1262 netif = LWIP_ARP_FILTER_NETIF_FN(p, netif, htons(type));
grzemich 0:d7bd7384a37c 1263 #endif /* LWIP_ARP_FILTER_NETIF*/
grzemich 0:d7bd7384a37c 1264
grzemich 0:d7bd7384a37c 1265 switch (type) {
grzemich 0:d7bd7384a37c 1266 #if LWIP_ARP
grzemich 0:d7bd7384a37c 1267 /* IP packet? */
grzemich 0:d7bd7384a37c 1268 case PP_HTONS(ETHTYPE_IP):
grzemich 0:d7bd7384a37c 1269 if (!(netif->flags & NETIF_FLAG_ETHARP)) {
grzemich 0:d7bd7384a37c 1270 goto free_and_return;
grzemich 0:d7bd7384a37c 1271 }
grzemich 0:d7bd7384a37c 1272 #if ETHARP_TRUST_IP_MAC
grzemich 0:d7bd7384a37c 1273 /* update ARP table */
grzemich 0:d7bd7384a37c 1274 etharp_ip_input(netif, p);
grzemich 0:d7bd7384a37c 1275 #endif /* ETHARP_TRUST_IP_MAC */
grzemich 0:d7bd7384a37c 1276 /* skip Ethernet header */
grzemich 0:d7bd7384a37c 1277 if(pbuf_header(p, -ip_hdr_offset)) {
grzemich 0:d7bd7384a37c 1278 LWIP_ASSERT("Can't move over header in packet", 0);
grzemich 0:d7bd7384a37c 1279 goto free_and_return;
grzemich 0:d7bd7384a37c 1280 } else {
grzemich 0:d7bd7384a37c 1281 /* pass to IP layer */
grzemich 0:d7bd7384a37c 1282 ip_input(p, netif);
grzemich 0:d7bd7384a37c 1283 }
grzemich 0:d7bd7384a37c 1284 break;
grzemich 0:d7bd7384a37c 1285
grzemich 0:d7bd7384a37c 1286 case PP_HTONS(ETHTYPE_ARP):
grzemich 0:d7bd7384a37c 1287 if (!(netif->flags & NETIF_FLAG_ETHARP)) {
grzemich 0:d7bd7384a37c 1288 goto free_and_return;
grzemich 0:d7bd7384a37c 1289 }
grzemich 0:d7bd7384a37c 1290 /* pass p to ARP module */
grzemich 0:d7bd7384a37c 1291 etharp_arp_input(netif, (struct eth_addr*)(netif->hwaddr), p);
grzemich 0:d7bd7384a37c 1292 break;
grzemich 0:d7bd7384a37c 1293 #endif /* LWIP_ARP */
grzemich 0:d7bd7384a37c 1294 #if PPPOE_SUPPORT
grzemich 0:d7bd7384a37c 1295 case PP_HTONS(ETHTYPE_PPPOEDISC): /* PPP Over Ethernet Discovery Stage */
grzemich 0:d7bd7384a37c 1296 pppoe_disc_input(netif, p);
grzemich 0:d7bd7384a37c 1297 break;
grzemich 0:d7bd7384a37c 1298
grzemich 0:d7bd7384a37c 1299 case PP_HTONS(ETHTYPE_PPPOE): /* PPP Over Ethernet Session Stage */
grzemich 0:d7bd7384a37c 1300 pppoe_data_input(netif, p);
grzemich 0:d7bd7384a37c 1301 break;
grzemich 0:d7bd7384a37c 1302 #endif /* PPPOE_SUPPORT */
grzemich 0:d7bd7384a37c 1303
grzemich 0:d7bd7384a37c 1304 default:
grzemich 0:d7bd7384a37c 1305 ETHARP_STATS_INC(etharp.proterr);
grzemich 0:d7bd7384a37c 1306 ETHARP_STATS_INC(etharp.drop);
grzemich 0:d7bd7384a37c 1307 goto free_and_return;
grzemich 0:d7bd7384a37c 1308 }
grzemich 0:d7bd7384a37c 1309
grzemich 0:d7bd7384a37c 1310 /* This means the pbuf is freed or consumed,
grzemich 0:d7bd7384a37c 1311 so the caller doesn't have to free it again */
grzemich 0:d7bd7384a37c 1312 return ERR_OK;
grzemich 0:d7bd7384a37c 1313
grzemich 0:d7bd7384a37c 1314 free_and_return:
grzemich 0:d7bd7384a37c 1315 pbuf_free(p);
grzemich 0:d7bd7384a37c 1316 return ERR_OK;
grzemich 0:d7bd7384a37c 1317 }
grzemich 0:d7bd7384a37c 1318 #endif /* LWIP_ARP || LWIP_ETHERNET */