ZG2100 Network interface source

Committer:
donatien
Date:
Fri Jul 09 15:37:23 2010 +0000
Revision:
0:b802fc31f1db
Child:
1:3a7c15057192

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:b802fc31f1db 1 /**
donatien 0:b802fc31f1db 2 * @file
donatien 0:b802fc31f1db 3 * AutoIP Automatic LinkLocal IP Configuration
donatien 0:b802fc31f1db 4 *
donatien 0:b802fc31f1db 5 */
donatien 0:b802fc31f1db 6
donatien 0:b802fc31f1db 7 /*
donatien 0:b802fc31f1db 8 *
donatien 0:b802fc31f1db 9 * Copyright (c) 2007 Dominik Spies <kontakt@dspies.de>
donatien 0:b802fc31f1db 10 * All rights reserved.
donatien 0:b802fc31f1db 11 *
donatien 0:b802fc31f1db 12 * Redistribution and use in source and binary forms, with or without modification,
donatien 0:b802fc31f1db 13 * are permitted provided that the following conditions are met:
donatien 0:b802fc31f1db 14 *
donatien 0:b802fc31f1db 15 * 1. Redistributions of source code must retain the above copyright notice,
donatien 0:b802fc31f1db 16 * this list of conditions and the following disclaimer.
donatien 0:b802fc31f1db 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
donatien 0:b802fc31f1db 18 * this list of conditions and the following disclaimer in the documentation
donatien 0:b802fc31f1db 19 * and/or other materials provided with the distribution.
donatien 0:b802fc31f1db 20 * 3. The name of the author may not be used to endorse or promote products
donatien 0:b802fc31f1db 21 * derived from this software without specific prior written permission.
donatien 0:b802fc31f1db 22 *
donatien 0:b802fc31f1db 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
donatien 0:b802fc31f1db 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
donatien 0:b802fc31f1db 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
donatien 0:b802fc31f1db 26 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
donatien 0:b802fc31f1db 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
donatien 0:b802fc31f1db 28 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
donatien 0:b802fc31f1db 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
donatien 0:b802fc31f1db 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
donatien 0:b802fc31f1db 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
donatien 0:b802fc31f1db 32 * OF SUCH DAMAGE.
donatien 0:b802fc31f1db 33 *
donatien 0:b802fc31f1db 34 * Author: Dominik Spies <kontakt@dspies.de>
donatien 0:b802fc31f1db 35 *
donatien 0:b802fc31f1db 36 * This is a AutoIP implementation for the lwIP TCP/IP stack. It aims to conform
donatien 0:b802fc31f1db 37 * with RFC 3927.
donatien 0:b802fc31f1db 38 *
donatien 0:b802fc31f1db 39 *
donatien 0:b802fc31f1db 40 * Please coordinate changes and requests with Dominik Spies
donatien 0:b802fc31f1db 41 * <kontakt@dspies.de>
donatien 0:b802fc31f1db 42 */
donatien 0:b802fc31f1db 43
donatien 0:b802fc31f1db 44 /*******************************************************************************
donatien 0:b802fc31f1db 45 * USAGE:
donatien 0:b802fc31f1db 46 *
donatien 0:b802fc31f1db 47 * define LWIP_AUTOIP 1 in your lwipopts.h
donatien 0:b802fc31f1db 48 *
donatien 0:b802fc31f1db 49 * If you don't use tcpip.c (so, don't call, you don't call tcpip_init):
donatien 0:b802fc31f1db 50 * - First, call autoip_init().
donatien 0:b802fc31f1db 51 * - call autoip_tmr() all AUTOIP_TMR_INTERVAL msces,
donatien 0:b802fc31f1db 52 * that should be defined in autoip.h.
donatien 0:b802fc31f1db 53 * I recommend a value of 100. The value must divide 1000 with a remainder almost 0.
donatien 0:b802fc31f1db 54 * Possible values are 1000, 500, 333, 250, 200, 166, 142, 125, 111, 100 ....
donatien 0:b802fc31f1db 55 *
donatien 0:b802fc31f1db 56 * Without DHCP:
donatien 0:b802fc31f1db 57 * - Call autoip_start() after netif_add().
donatien 0:b802fc31f1db 58 *
donatien 0:b802fc31f1db 59 * With DHCP:
donatien 0:b802fc31f1db 60 * - define LWIP_DHCP_AUTOIP_COOP 1 in your lwipopts.h.
donatien 0:b802fc31f1db 61 * - Configure your DHCP Client.
donatien 0:b802fc31f1db 62 *
donatien 0:b802fc31f1db 63 */
donatien 0:b802fc31f1db 64
donatien 0:b802fc31f1db 65 #include "lwip/opt.h"
donatien 0:b802fc31f1db 66
donatien 0:b802fc31f1db 67 #if LWIP_AUTOIP /* don't build if not configured for use in lwipopts.h */
donatien 0:b802fc31f1db 68
donatien 0:b802fc31f1db 69 #include "lwip/mem.h"
donatien 0:b802fc31f1db 70 #include "lwip/udp.h"
donatien 0:b802fc31f1db 71 #include "lwip/ip_addr.h"
donatien 0:b802fc31f1db 72 #include "lwip/netif.h"
donatien 0:b802fc31f1db 73 #include "lwip/autoip.h"
donatien 0:b802fc31f1db 74 #include "netif/etharp.h"
donatien 0:b802fc31f1db 75
donatien 0:b802fc31f1db 76 #include <stdlib.h>
donatien 0:b802fc31f1db 77 #include <string.h>
donatien 0:b802fc31f1db 78
donatien 0:b802fc31f1db 79 /* 169.254.0.0 */
donatien 0:b802fc31f1db 80 #define AUTOIP_NET 0xA9FE0000
donatien 0:b802fc31f1db 81 /* 169.254.1.0 */
donatien 0:b802fc31f1db 82 #define AUTOIP_RANGE_START (AUTOIP_NET | 0x0100)
donatien 0:b802fc31f1db 83 /* 169.254.254.255 */
donatien 0:b802fc31f1db 84 #define AUTOIP_RANGE_END (AUTOIP_NET | 0xFEFF)
donatien 0:b802fc31f1db 85
donatien 0:b802fc31f1db 86
donatien 0:b802fc31f1db 87 /** Pseudo random macro based on netif informations.
donatien 0:b802fc31f1db 88 * You could use "rand()" from the C Library if you define LWIP_AUTOIP_RAND in lwipopts.h */
donatien 0:b802fc31f1db 89 #ifndef LWIP_AUTOIP_RAND
donatien 0:b802fc31f1db 90 #define LWIP_AUTOIP_RAND(netif) ( (((u32_t)((netif->hwaddr[5]) & 0xff) << 24) | \
donatien 0:b802fc31f1db 91 ((u32_t)((netif->hwaddr[3]) & 0xff) << 16) | \
donatien 0:b802fc31f1db 92 ((u32_t)((netif->hwaddr[2]) & 0xff) << 8) | \
donatien 0:b802fc31f1db 93 ((u32_t)((netif->hwaddr[4]) & 0xff))) + \
donatien 0:b802fc31f1db 94 (netif->autoip?netif->autoip->tried_llipaddr:0))
donatien 0:b802fc31f1db 95 #endif /* LWIP_AUTOIP_RAND */
donatien 0:b802fc31f1db 96
donatien 0:b802fc31f1db 97 /**
donatien 0:b802fc31f1db 98 * Macro that generates the initial IP address to be tried by AUTOIP.
donatien 0:b802fc31f1db 99 * If you want to override this, define it to something else in lwipopts.h.
donatien 0:b802fc31f1db 100 */
donatien 0:b802fc31f1db 101 #ifndef LWIP_AUTOIP_CREATE_SEED_ADDR
donatien 0:b802fc31f1db 102 #define LWIP_AUTOIP_CREATE_SEED_ADDR(netif) \
donatien 0:b802fc31f1db 103 htonl(AUTOIP_RANGE_START + ((u32_t)(((u8_t)(netif->hwaddr[4])) | \
donatien 0:b802fc31f1db 104 ((u32_t)((u8_t)(netif->hwaddr[5]))) << 8)))
donatien 0:b802fc31f1db 105 #endif /* LWIP_AUTOIP_CREATE_SEED_ADDR */
donatien 0:b802fc31f1db 106
donatien 0:b802fc31f1db 107 /* static functions */
donatien 0:b802fc31f1db 108 static void autoip_handle_arp_conflict(struct netif *netif);
donatien 0:b802fc31f1db 109
donatien 0:b802fc31f1db 110 /* creates a pseudo random LL IP-Address for a network interface */
donatien 0:b802fc31f1db 111 static void autoip_create_addr(struct netif *netif, ip_addr_t *ipaddr);
donatien 0:b802fc31f1db 112
donatien 0:b802fc31f1db 113 /* sends an ARP probe */
donatien 0:b802fc31f1db 114 static err_t autoip_arp_probe(struct netif *netif);
donatien 0:b802fc31f1db 115
donatien 0:b802fc31f1db 116 /* sends an ARP announce */
donatien 0:b802fc31f1db 117 static err_t autoip_arp_announce(struct netif *netif);
donatien 0:b802fc31f1db 118
donatien 0:b802fc31f1db 119 /* configure interface for use with current LL IP-Address */
donatien 0:b802fc31f1db 120 static err_t autoip_bind(struct netif *netif);
donatien 0:b802fc31f1db 121
donatien 0:b802fc31f1db 122 /* start sending probes for llipaddr */
donatien 0:b802fc31f1db 123 static void autoip_start_probing(struct netif *netif);
donatien 0:b802fc31f1db 124
donatien 0:b802fc31f1db 125 /**
donatien 0:b802fc31f1db 126 * Initialize this module
donatien 0:b802fc31f1db 127 */
donatien 0:b802fc31f1db 128 void
donatien 0:b802fc31f1db 129 autoip_init(void)
donatien 0:b802fc31f1db 130 {
donatien 0:b802fc31f1db 131 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE, ("autoip_init()\n"));
donatien 0:b802fc31f1db 132 }
donatien 0:b802fc31f1db 133
donatien 0:b802fc31f1db 134 /** Set a statically allocated struct autoip to work with.
donatien 0:b802fc31f1db 135 * Using this prevents autoip_start to allocate it using mem_malloc.
donatien 0:b802fc31f1db 136 *
donatien 0:b802fc31f1db 137 * @param netif the netif for which to set the struct autoip
donatien 0:b802fc31f1db 138 * @param dhcp (uninitialised) dhcp struct allocated by the application
donatien 0:b802fc31f1db 139 */
donatien 0:b802fc31f1db 140 void
donatien 0:b802fc31f1db 141 autoip_set_struct(struct netif *netif, struct autoip *autoip)
donatien 0:b802fc31f1db 142 {
donatien 0:b802fc31f1db 143 LWIP_ASSERT("netif != NULL", netif != NULL);
donatien 0:b802fc31f1db 144 LWIP_ASSERT("autoip != NULL", autoip != NULL);
donatien 0:b802fc31f1db 145 LWIP_ASSERT("netif already has a struct autoip set", netif->autoip == NULL);
donatien 0:b802fc31f1db 146
donatien 0:b802fc31f1db 147 /* clear data structure */
donatien 0:b802fc31f1db 148 memset(autoip, 0, sizeof(struct autoip));
donatien 0:b802fc31f1db 149 /* autoip->state = AUTOIP_STATE_OFF; */
donatien 0:b802fc31f1db 150 netif->autoip = autoip;
donatien 0:b802fc31f1db 151 }
donatien 0:b802fc31f1db 152
donatien 0:b802fc31f1db 153 /**
donatien 0:b802fc31f1db 154 * Handle a IP address conflict after an ARP conflict detection
donatien 0:b802fc31f1db 155 */
donatien 0:b802fc31f1db 156 static void
donatien 0:b802fc31f1db 157 autoip_handle_arp_conflict(struct netif *netif)
donatien 0:b802fc31f1db 158 {
donatien 0:b802fc31f1db 159 /* Somehow detect if we are defending or retreating */
donatien 0:b802fc31f1db 160 unsigned char defend = 1; /* tbd */
donatien 0:b802fc31f1db 161
donatien 0:b802fc31f1db 162 if(defend) {
donatien 0:b802fc31f1db 163 if(netif->autoip->lastconflict > 0) {
donatien 0:b802fc31f1db 164 /* retreat, there was a conflicting ARP in the last
donatien 0:b802fc31f1db 165 * DEFEND_INTERVAL seconds
donatien 0:b802fc31f1db 166 */
donatien 0:b802fc31f1db 167 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 168 ("autoip_handle_arp_conflict(): we are defending, but in DEFEND_INTERVAL, retreating\n"));
donatien 0:b802fc31f1db 169
donatien 0:b802fc31f1db 170 /* TODO: close all TCP sessions */
donatien 0:b802fc31f1db 171 autoip_start(netif);
donatien 0:b802fc31f1db 172 } else {
donatien 0:b802fc31f1db 173 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 174 ("autoip_handle_arp_conflict(): we are defend, send ARP Announce\n"));
donatien 0:b802fc31f1db 175 autoip_arp_announce(netif);
donatien 0:b802fc31f1db 176 netif->autoip->lastconflict = DEFEND_INTERVAL * AUTOIP_TICKS_PER_SECOND;
donatien 0:b802fc31f1db 177 }
donatien 0:b802fc31f1db 178 } else {
donatien 0:b802fc31f1db 179 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 180 ("autoip_handle_arp_conflict(): we do not defend, retreating\n"));
donatien 0:b802fc31f1db 181 /* TODO: close all TCP sessions */
donatien 0:b802fc31f1db 182 autoip_start(netif);
donatien 0:b802fc31f1db 183 }
donatien 0:b802fc31f1db 184 }
donatien 0:b802fc31f1db 185
donatien 0:b802fc31f1db 186 /**
donatien 0:b802fc31f1db 187 * Create an IP-Address out of range 169.254.1.0 to 169.254.254.255
donatien 0:b802fc31f1db 188 *
donatien 0:b802fc31f1db 189 * @param netif network interface on which create the IP-Address
donatien 0:b802fc31f1db 190 * @param ipaddr ip address to initialize
donatien 0:b802fc31f1db 191 */
donatien 0:b802fc31f1db 192 static void
donatien 0:b802fc31f1db 193 autoip_create_addr(struct netif *netif, ip_addr_t *ipaddr)
donatien 0:b802fc31f1db 194 {
donatien 0:b802fc31f1db 195 /* Here we create an IP-Address out of range 169.254.1.0 to 169.254.254.255
donatien 0:b802fc31f1db 196 * compliant to RFC 3927 Section 2.1
donatien 0:b802fc31f1db 197 * We have 254 * 256 possibilities */
donatien 0:b802fc31f1db 198
donatien 0:b802fc31f1db 199 u32_t addr = ntohl(LWIP_AUTOIP_CREATE_SEED_ADDR(netif));
donatien 0:b802fc31f1db 200 addr += netif->autoip->tried_llipaddr;
donatien 0:b802fc31f1db 201 addr = AUTOIP_NET | (addr & 0xffff);
donatien 0:b802fc31f1db 202 /* Now, 169.254.0.0 <= addr <= 169.254.255.255 */
donatien 0:b802fc31f1db 203
donatien 0:b802fc31f1db 204 if (addr < AUTOIP_RANGE_START) {
donatien 0:b802fc31f1db 205 addr += AUTOIP_RANGE_END - AUTOIP_RANGE_START + 1;
donatien 0:b802fc31f1db 206 }
donatien 0:b802fc31f1db 207 if (addr > AUTOIP_RANGE_END) {
donatien 0:b802fc31f1db 208 addr -= AUTOIP_RANGE_END - AUTOIP_RANGE_START + 1;
donatien 0:b802fc31f1db 209 }
donatien 0:b802fc31f1db 210 LWIP_ASSERT("AUTOIP address not in range", (addr >= AUTOIP_RANGE_START) &&
donatien 0:b802fc31f1db 211 (addr <= AUTOIP_RANGE_END));
donatien 0:b802fc31f1db 212 ip4_addr_set_u32(ipaddr, htonl(addr));
donatien 0:b802fc31f1db 213
donatien 0:b802fc31f1db 214 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 215 ("autoip_create_addr(): tried_llipaddr=%"U16_F", %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:b802fc31f1db 216 (u16_t)(netif->autoip->tried_llipaddr), ip4_addr1_16(ipaddr), ip4_addr2_16(ipaddr),
donatien 0:b802fc31f1db 217 ip4_addr3_16(ipaddr), ip4_addr4_16(ipaddr)));
donatien 0:b802fc31f1db 218 }
donatien 0:b802fc31f1db 219
donatien 0:b802fc31f1db 220 /**
donatien 0:b802fc31f1db 221 * Sends an ARP probe from a network interface
donatien 0:b802fc31f1db 222 *
donatien 0:b802fc31f1db 223 * @param netif network interface used to send the probe
donatien 0:b802fc31f1db 224 */
donatien 0:b802fc31f1db 225 static err_t
donatien 0:b802fc31f1db 226 autoip_arp_probe(struct netif *netif)
donatien 0:b802fc31f1db 227 {
donatien 0:b802fc31f1db 228 return etharp_raw(netif, (struct eth_addr *)netif->hwaddr, &ethbroadcast,
donatien 0:b802fc31f1db 229 (struct eth_addr *)netif->hwaddr, IP_ADDR_ANY, &ethzero,
donatien 0:b802fc31f1db 230 &netif->autoip->llipaddr, ARP_REQUEST);
donatien 0:b802fc31f1db 231 }
donatien 0:b802fc31f1db 232
donatien 0:b802fc31f1db 233 /**
donatien 0:b802fc31f1db 234 * Sends an ARP announce from a network interface
donatien 0:b802fc31f1db 235 *
donatien 0:b802fc31f1db 236 * @param netif network interface used to send the announce
donatien 0:b802fc31f1db 237 */
donatien 0:b802fc31f1db 238 static err_t
donatien 0:b802fc31f1db 239 autoip_arp_announce(struct netif *netif)
donatien 0:b802fc31f1db 240 {
donatien 0:b802fc31f1db 241 return etharp_raw(netif, (struct eth_addr *)netif->hwaddr, &ethbroadcast,
donatien 0:b802fc31f1db 242 (struct eth_addr *)netif->hwaddr, &netif->autoip->llipaddr, &ethzero,
donatien 0:b802fc31f1db 243 &netif->autoip->llipaddr, ARP_REQUEST);
donatien 0:b802fc31f1db 244 }
donatien 0:b802fc31f1db 245
donatien 0:b802fc31f1db 246 /**
donatien 0:b802fc31f1db 247 * Configure interface for use with current LL IP-Address
donatien 0:b802fc31f1db 248 *
donatien 0:b802fc31f1db 249 * @param netif network interface to configure with current LL IP-Address
donatien 0:b802fc31f1db 250 */
donatien 0:b802fc31f1db 251 static err_t
donatien 0:b802fc31f1db 252 autoip_bind(struct netif *netif)
donatien 0:b802fc31f1db 253 {
donatien 0:b802fc31f1db 254 struct autoip *autoip = netif->autoip;
donatien 0:b802fc31f1db 255 ip_addr_t sn_mask, gw_addr;
donatien 0:b802fc31f1db 256
donatien 0:b802fc31f1db 257 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:b802fc31f1db 258 ("autoip_bind(netif=%p) %c%c%"U16_F" %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:b802fc31f1db 259 (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num,
donatien 0:b802fc31f1db 260 ip4_addr1_16(&autoip->llipaddr), ip4_addr2_16(&autoip->llipaddr),
donatien 0:b802fc31f1db 261 ip4_addr3_16(&autoip->llipaddr), ip4_addr4_16(&autoip->llipaddr)));
donatien 0:b802fc31f1db 262
donatien 0:b802fc31f1db 263 IP4_ADDR(&sn_mask, 255, 255, 0, 0);
donatien 0:b802fc31f1db 264 IP4_ADDR(&gw_addr, 0, 0, 0, 0);
donatien 0:b802fc31f1db 265
donatien 0:b802fc31f1db 266 netif_set_ipaddr(netif, &autoip->llipaddr);
donatien 0:b802fc31f1db 267 netif_set_netmask(netif, &sn_mask);
donatien 0:b802fc31f1db 268 netif_set_gw(netif, &gw_addr);
donatien 0:b802fc31f1db 269
donatien 0:b802fc31f1db 270 /* bring the interface up */
donatien 0:b802fc31f1db 271 netif_set_up(netif);
donatien 0:b802fc31f1db 272
donatien 0:b802fc31f1db 273 return ERR_OK;
donatien 0:b802fc31f1db 274 }
donatien 0:b802fc31f1db 275
donatien 0:b802fc31f1db 276 /**
donatien 0:b802fc31f1db 277 * Start AutoIP client
donatien 0:b802fc31f1db 278 *
donatien 0:b802fc31f1db 279 * @param netif network interface on which start the AutoIP client
donatien 0:b802fc31f1db 280 */
donatien 0:b802fc31f1db 281 err_t
donatien 0:b802fc31f1db 282 autoip_start(struct netif *netif)
donatien 0:b802fc31f1db 283 {
donatien 0:b802fc31f1db 284 struct autoip *autoip = netif->autoip;
donatien 0:b802fc31f1db 285 err_t result = ERR_OK;
donatien 0:b802fc31f1db 286
donatien 0:b802fc31f1db 287 if(netif_is_up(netif)) {
donatien 0:b802fc31f1db 288 netif_set_down(netif);
donatien 0:b802fc31f1db 289 }
donatien 0:b802fc31f1db 290
donatien 0:b802fc31f1db 291 /* Set IP-Address, Netmask and Gateway to 0 to make sure that
donatien 0:b802fc31f1db 292 * ARP Packets are formed correctly
donatien 0:b802fc31f1db 293 */
donatien 0:b802fc31f1db 294 ip_addr_set_zero(&netif->ip_addr);
donatien 0:b802fc31f1db 295 ip_addr_set_zero(&netif->netmask);
donatien 0:b802fc31f1db 296 ip_addr_set_zero(&netif->gw);
donatien 0:b802fc31f1db 297
donatien 0:b802fc31f1db 298 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 299 ("autoip_start(netif=%p) %c%c%"U16_F"\n", (void*)netif, netif->name[0],
donatien 0:b802fc31f1db 300 netif->name[1], (u16_t)netif->num));
donatien 0:b802fc31f1db 301 if(autoip == NULL) {
donatien 0:b802fc31f1db 302 /* no AutoIP client attached yet? */
donatien 0:b802fc31f1db 303 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:b802fc31f1db 304 ("autoip_start(): starting new AUTOIP client\n"));
donatien 0:b802fc31f1db 305 autoip = (struct autoip *)mem_malloc(sizeof(struct autoip));
donatien 0:b802fc31f1db 306 if(autoip == NULL) {
donatien 0:b802fc31f1db 307 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:b802fc31f1db 308 ("autoip_start(): could not allocate autoip\n"));
donatien 0:b802fc31f1db 309 return ERR_MEM;
donatien 0:b802fc31f1db 310 }
donatien 0:b802fc31f1db 311 memset( autoip, 0, sizeof(struct autoip));
donatien 0:b802fc31f1db 312 /* store this AutoIP client in the netif */
donatien 0:b802fc31f1db 313 netif->autoip = autoip;
donatien 0:b802fc31f1db 314 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE, ("autoip_start(): allocated autoip"));
donatien 0:b802fc31f1db 315 } else {
donatien 0:b802fc31f1db 316 autoip->state = AUTOIP_STATE_OFF;
donatien 0:b802fc31f1db 317 autoip->ttw = 0;
donatien 0:b802fc31f1db 318 autoip->sent_num = 0;
donatien 0:b802fc31f1db 319 memset(&autoip->llipaddr, 0, sizeof(ip_addr_t));
donatien 0:b802fc31f1db 320 autoip->lastconflict = 0;
donatien 0:b802fc31f1db 321 }
donatien 0:b802fc31f1db 322
donatien 0:b802fc31f1db 323 autoip_create_addr(netif, &(autoip->llipaddr));
donatien 0:b802fc31f1db 324 autoip->tried_llipaddr++;
donatien 0:b802fc31f1db 325 autoip_start_probing(netif);
donatien 0:b802fc31f1db 326
donatien 0:b802fc31f1db 327 return result;
donatien 0:b802fc31f1db 328 }
donatien 0:b802fc31f1db 329
donatien 0:b802fc31f1db 330 static void
donatien 0:b802fc31f1db 331 autoip_start_probing(struct netif *netif)
donatien 0:b802fc31f1db 332 {
donatien 0:b802fc31f1db 333 struct autoip *autoip = netif->autoip;
donatien 0:b802fc31f1db 334
donatien 0:b802fc31f1db 335 autoip->state = AUTOIP_STATE_PROBING;
donatien 0:b802fc31f1db 336 autoip->sent_num = 0;
donatien 0:b802fc31f1db 337 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 338 ("autoip_start_probing(): changing state to PROBING: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:b802fc31f1db 339 ip4_addr1_16(&netif->autoip->llipaddr), ip4_addr2_16(&netif->autoip->llipaddr),
donatien 0:b802fc31f1db 340 ip4_addr3_16(&netif->autoip->llipaddr), ip4_addr4_16(&netif->autoip->llipaddr)));
donatien 0:b802fc31f1db 341
donatien 0:b802fc31f1db 342 /* time to wait to first probe, this is randomly
donatien 0:b802fc31f1db 343 * choosen out of 0 to PROBE_WAIT seconds.
donatien 0:b802fc31f1db 344 * compliant to RFC 3927 Section 2.2.1
donatien 0:b802fc31f1db 345 */
donatien 0:b802fc31f1db 346 autoip->ttw = (u16_t)(LWIP_AUTOIP_RAND(netif) % (PROBE_WAIT * AUTOIP_TICKS_PER_SECOND));
donatien 0:b802fc31f1db 347
donatien 0:b802fc31f1db 348 /*
donatien 0:b802fc31f1db 349 * if we tried more then MAX_CONFLICTS we must limit our rate for
donatien 0:b802fc31f1db 350 * accquiring and probing address
donatien 0:b802fc31f1db 351 * compliant to RFC 3927 Section 2.2.1
donatien 0:b802fc31f1db 352 */
donatien 0:b802fc31f1db 353 if(autoip->tried_llipaddr > MAX_CONFLICTS) {
donatien 0:b802fc31f1db 354 autoip->ttw = RATE_LIMIT_INTERVAL * AUTOIP_TICKS_PER_SECOND;
donatien 0:b802fc31f1db 355 }
donatien 0:b802fc31f1db 356 }
donatien 0:b802fc31f1db 357
donatien 0:b802fc31f1db 358 /**
donatien 0:b802fc31f1db 359 * Handle a possible change in the network configuration.
donatien 0:b802fc31f1db 360 *
donatien 0:b802fc31f1db 361 * If there is an AutoIP address configured, take the interface down
donatien 0:b802fc31f1db 362 * and begin probing with the same address.
donatien 0:b802fc31f1db 363 */
donatien 0:b802fc31f1db 364 void
donatien 0:b802fc31f1db 365 autoip_network_changed(struct netif *netif)
donatien 0:b802fc31f1db 366 {
donatien 0:b802fc31f1db 367 if (netif->autoip && netif->autoip->state != AUTOIP_STATE_OFF) {
donatien 0:b802fc31f1db 368 netif_set_down(netif);
donatien 0:b802fc31f1db 369 autoip_start_probing(netif);
donatien 0:b802fc31f1db 370 }
donatien 0:b802fc31f1db 371 }
donatien 0:b802fc31f1db 372
donatien 0:b802fc31f1db 373 /**
donatien 0:b802fc31f1db 374 * Stop AutoIP client
donatien 0:b802fc31f1db 375 *
donatien 0:b802fc31f1db 376 * @param netif network interface on which stop the AutoIP client
donatien 0:b802fc31f1db 377 */
donatien 0:b802fc31f1db 378 err_t
donatien 0:b802fc31f1db 379 autoip_stop(struct netif *netif)
donatien 0:b802fc31f1db 380 {
donatien 0:b802fc31f1db 381 netif->autoip->state = AUTOIP_STATE_OFF;
donatien 0:b802fc31f1db 382 netif_set_down(netif);
donatien 0:b802fc31f1db 383 return ERR_OK;
donatien 0:b802fc31f1db 384 }
donatien 0:b802fc31f1db 385
donatien 0:b802fc31f1db 386 /**
donatien 0:b802fc31f1db 387 * Has to be called in loop every AUTOIP_TMR_INTERVAL milliseconds
donatien 0:b802fc31f1db 388 */
donatien 0:b802fc31f1db 389 void
donatien 0:b802fc31f1db 390 autoip_tmr()
donatien 0:b802fc31f1db 391 {
donatien 0:b802fc31f1db 392 struct netif *netif = netif_list;
donatien 0:b802fc31f1db 393 /* loop through netif's */
donatien 0:b802fc31f1db 394 while (netif != NULL) {
donatien 0:b802fc31f1db 395 /* only act on AutoIP configured interfaces */
donatien 0:b802fc31f1db 396 if (netif->autoip != NULL) {
donatien 0:b802fc31f1db 397 if(netif->autoip->lastconflict > 0) {
donatien 0:b802fc31f1db 398 netif->autoip->lastconflict--;
donatien 0:b802fc31f1db 399 }
donatien 0:b802fc31f1db 400
donatien 0:b802fc31f1db 401 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:b802fc31f1db 402 ("autoip_tmr() AutoIP-State: %"U16_F", ttw=%"U16_F"\n",
donatien 0:b802fc31f1db 403 (u16_t)(netif->autoip->state), netif->autoip->ttw));
donatien 0:b802fc31f1db 404
donatien 0:b802fc31f1db 405 switch(netif->autoip->state) {
donatien 0:b802fc31f1db 406 case AUTOIP_STATE_PROBING:
donatien 0:b802fc31f1db 407 if(netif->autoip->ttw > 0) {
donatien 0:b802fc31f1db 408 netif->autoip->ttw--;
donatien 0:b802fc31f1db 409 } else {
donatien 0:b802fc31f1db 410 if(netif->autoip->sent_num >= PROBE_NUM) {
donatien 0:b802fc31f1db 411 netif->autoip->state = AUTOIP_STATE_ANNOUNCING;
donatien 0:b802fc31f1db 412 netif->autoip->sent_num = 0;
donatien 0:b802fc31f1db 413 netif->autoip->ttw = ANNOUNCE_WAIT * AUTOIP_TICKS_PER_SECOND;
donatien 0:b802fc31f1db 414 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 415 ("autoip_tmr(): changing state to ANNOUNCING: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:b802fc31f1db 416 ip4_addr1_16(&netif->autoip->llipaddr), ip4_addr2_16(&netif->autoip->llipaddr),
donatien 0:b802fc31f1db 417 ip4_addr3_16(&netif->autoip->llipaddr), ip4_addr4_16(&netif->autoip->llipaddr)));
donatien 0:b802fc31f1db 418 } else {
donatien 0:b802fc31f1db 419 autoip_arp_probe(netif);
donatien 0:b802fc31f1db 420 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:b802fc31f1db 421 ("autoip_tmr() PROBING Sent Probe\n"));
donatien 0:b802fc31f1db 422 netif->autoip->sent_num++;
donatien 0:b802fc31f1db 423 /* calculate time to wait to next probe */
donatien 0:b802fc31f1db 424 netif->autoip->ttw = (u16_t)((LWIP_AUTOIP_RAND(netif) %
donatien 0:b802fc31f1db 425 ((PROBE_MAX - PROBE_MIN) * AUTOIP_TICKS_PER_SECOND) ) +
donatien 0:b802fc31f1db 426 PROBE_MIN * AUTOIP_TICKS_PER_SECOND);
donatien 0:b802fc31f1db 427 }
donatien 0:b802fc31f1db 428 }
donatien 0:b802fc31f1db 429 break;
donatien 0:b802fc31f1db 430
donatien 0:b802fc31f1db 431 case AUTOIP_STATE_ANNOUNCING:
donatien 0:b802fc31f1db 432 if(netif->autoip->ttw > 0) {
donatien 0:b802fc31f1db 433 netif->autoip->ttw--;
donatien 0:b802fc31f1db 434 } else {
donatien 0:b802fc31f1db 435 if(netif->autoip->sent_num == 0) {
donatien 0:b802fc31f1db 436 /* We are here the first time, so we waited ANNOUNCE_WAIT seconds
donatien 0:b802fc31f1db 437 * Now we can bind to an IP address and use it.
donatien 0:b802fc31f1db 438 *
donatien 0:b802fc31f1db 439 * autoip_bind calls netif_set_up. This triggers a gratuitous ARP
donatien 0:b802fc31f1db 440 * which counts as an announcement.
donatien 0:b802fc31f1db 441 */
donatien 0:b802fc31f1db 442 autoip_bind(netif);
donatien 0:b802fc31f1db 443 } else {
donatien 0:b802fc31f1db 444 autoip_arp_announce(netif);
donatien 0:b802fc31f1db 445 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE,
donatien 0:b802fc31f1db 446 ("autoip_tmr() ANNOUNCING Sent Announce\n"));
donatien 0:b802fc31f1db 447 }
donatien 0:b802fc31f1db 448 netif->autoip->ttw = ANNOUNCE_INTERVAL * AUTOIP_TICKS_PER_SECOND;
donatien 0:b802fc31f1db 449 netif->autoip->sent_num++;
donatien 0:b802fc31f1db 450
donatien 0:b802fc31f1db 451 if(netif->autoip->sent_num >= ANNOUNCE_NUM) {
donatien 0:b802fc31f1db 452 netif->autoip->state = AUTOIP_STATE_BOUND;
donatien 0:b802fc31f1db 453 netif->autoip->sent_num = 0;
donatien 0:b802fc31f1db 454 netif->autoip->ttw = 0;
donatien 0:b802fc31f1db 455 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
donatien 0:b802fc31f1db 456 ("autoip_tmr(): changing state to BOUND: %"U16_F".%"U16_F".%"U16_F".%"U16_F"\n",
donatien 0:b802fc31f1db 457 ip4_addr1_16(&netif->autoip->llipaddr), ip4_addr2_16(&netif->autoip->llipaddr),
donatien 0:b802fc31f1db 458 ip4_addr3_16(&netif->autoip->llipaddr), ip4_addr4_16(&netif->autoip->llipaddr)));
donatien 0:b802fc31f1db 459 }
donatien 0:b802fc31f1db 460 }
donatien 0:b802fc31f1db 461 break;
donatien 0:b802fc31f1db 462 }
donatien 0:b802fc31f1db 463 }
donatien 0:b802fc31f1db 464 /* proceed to next network interface */
donatien 0:b802fc31f1db 465 netif = netif->next;
donatien 0:b802fc31f1db 466 }
donatien 0:b802fc31f1db 467 }
donatien 0:b802fc31f1db 468
donatien 0:b802fc31f1db 469 /**
donatien 0:b802fc31f1db 470 * Handles every incoming ARP Packet, called by etharp_arp_input.
donatien 0:b802fc31f1db 471 *
donatien 0:b802fc31f1db 472 * @param netif network interface to use for autoip processing
donatien 0:b802fc31f1db 473 * @param hdr Incoming ARP packet
donatien 0:b802fc31f1db 474 */
donatien 0:b802fc31f1db 475 void
donatien 0:b802fc31f1db 476 autoip_arp_reply(struct netif *netif, struct etharp_hdr *hdr)
donatien 0:b802fc31f1db 477 {
donatien 0:b802fc31f1db 478 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE, ("autoip_arp_reply()\n"));
donatien 0:b802fc31f1db 479 if ((netif->autoip != NULL) && (netif->autoip->state != AUTOIP_STATE_OFF)) {
donatien 0:b802fc31f1db 480 /* when ip.src == llipaddr && hw.src != netif->hwaddr
donatien 0:b802fc31f1db 481 *
donatien 0:b802fc31f1db 482 * when probing ip.dst == llipaddr && hw.src != netif->hwaddr
donatien 0:b802fc31f1db 483 * we have a conflict and must solve it
donatien 0:b802fc31f1db 484 */
donatien 0:b802fc31f1db 485 ip_addr_t sipaddr, dipaddr;
donatien 0:b802fc31f1db 486 struct eth_addr netifaddr;
donatien 0:b802fc31f1db 487 netifaddr.addr[0] = netif->hwaddr[0];
donatien 0:b802fc31f1db 488 netifaddr.addr[1] = netif->hwaddr[1];
donatien 0:b802fc31f1db 489 netifaddr.addr[2] = netif->hwaddr[2];
donatien 0:b802fc31f1db 490 netifaddr.addr[3] = netif->hwaddr[3];
donatien 0:b802fc31f1db 491 netifaddr.addr[4] = netif->hwaddr[4];
donatien 0:b802fc31f1db 492 netifaddr.addr[5] = netif->hwaddr[5];
donatien 0:b802fc31f1db 493
donatien 0:b802fc31f1db 494 /* Copy struct ip_addr2 to aligned ip_addr, to support compilers without
donatien 0:b802fc31f1db 495 * structure packing (not using structure copy which breaks strict-aliasing rules).
donatien 0:b802fc31f1db 496 */
donatien 0:b802fc31f1db 497 SMEMCPY(&sipaddr, &hdr->sipaddr, sizeof(sipaddr));
donatien 0:b802fc31f1db 498 SMEMCPY(&dipaddr, &hdr->dipaddr, sizeof(dipaddr));
donatien 0:b802fc31f1db 499
donatien 0:b802fc31f1db 500 if ((netif->autoip->state == AUTOIP_STATE_PROBING) ||
donatien 0:b802fc31f1db 501 ((netif->autoip->state == AUTOIP_STATE_ANNOUNCING) &&
donatien 0:b802fc31f1db 502 (netif->autoip->sent_num == 0))) {
donatien 0:b802fc31f1db 503 /* RFC 3927 Section 2.2.1:
donatien 0:b802fc31f1db 504 * from beginning to after ANNOUNCE_WAIT
donatien 0:b802fc31f1db 505 * seconds we have a conflict if
donatien 0:b802fc31f1db 506 * ip.src == llipaddr OR
donatien 0:b802fc31f1db 507 * ip.dst == llipaddr && hw.src != own hwaddr
donatien 0:b802fc31f1db 508 */
donatien 0:b802fc31f1db 509 if ((ip_addr_cmp(&sipaddr, &netif->autoip->llipaddr)) ||
donatien 0:b802fc31f1db 510 (ip_addr_cmp(&dipaddr, &netif->autoip->llipaddr) &&
donatien 0:b802fc31f1db 511 !eth_addr_cmp(&netifaddr, &hdr->shwaddr))) {
donatien 0:b802fc31f1db 512 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE | LWIP_DBG_LEVEL_WARNING,
donatien 0:b802fc31f1db 513 ("autoip_arp_reply(): Probe Conflict detected\n"));
donatien 0:b802fc31f1db 514 autoip_start(netif);
donatien 0:b802fc31f1db 515 }
donatien 0:b802fc31f1db 516 } else {
donatien 0:b802fc31f1db 517 /* RFC 3927 Section 2.5:
donatien 0:b802fc31f1db 518 * in any state we have a conflict if
donatien 0:b802fc31f1db 519 * ip.src == llipaddr && hw.src != own hwaddr
donatien 0:b802fc31f1db 520 */
donatien 0:b802fc31f1db 521 if (ip_addr_cmp(&sipaddr, &netif->autoip->llipaddr) &&
donatien 0:b802fc31f1db 522 !eth_addr_cmp(&netifaddr, &hdr->shwaddr)) {
donatien 0:b802fc31f1db 523 LWIP_DEBUGF(AUTOIP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE | LWIP_DBG_LEVEL_WARNING,
donatien 0:b802fc31f1db 524 ("autoip_arp_reply(): Conflicting ARP-Packet detected\n"));
donatien 0:b802fc31f1db 525 autoip_handle_arp_conflict(netif);
donatien 0:b802fc31f1db 526 }
donatien 0:b802fc31f1db 527 }
donatien 0:b802fc31f1db 528 }
donatien 0:b802fc31f1db 529 }
donatien 0:b802fc31f1db 530
donatien 0:b802fc31f1db 531 #endif /* LWIP_AUTOIP */