Dependencies:   mbed

Dependents:   TCP

Committer:
slowness
Date:
Tue Sep 06 18:05:46 2011 +0000
Revision:
0:58c3d014a4e7

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:58c3d014a4e7 1 /**
slowness 0:58c3d014a4e7 2 * @file
slowness 0:58c3d014a4e7 3 *
slowness 0:58c3d014a4e7 4 * AutoIP Automatic LinkLocal IP Configuration
slowness 0:58c3d014a4e7 5 */
slowness 0:58c3d014a4e7 6
slowness 0:58c3d014a4e7 7 /*
slowness 0:58c3d014a4e7 8 *
slowness 0:58c3d014a4e7 9 * Copyright (c) 2007 Dominik Spies <kontakt@dspies.de>
slowness 0:58c3d014a4e7 10 * All rights reserved.
slowness 0:58c3d014a4e7 11 *
slowness 0:58c3d014a4e7 12 * Redistribution and use in source and binary forms, with or without modification,
slowness 0:58c3d014a4e7 13 * are permitted provided that the following conditions are met:
slowness 0:58c3d014a4e7 14 *
slowness 0:58c3d014a4e7 15 * 1. Redistributions of source code must retain the above copyright notice,
slowness 0:58c3d014a4e7 16 * this list of conditions and the following disclaimer.
slowness 0:58c3d014a4e7 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
slowness 0:58c3d014a4e7 18 * this list of conditions and the following disclaimer in the documentation
slowness 0:58c3d014a4e7 19 * and/or other materials provided with the distribution.
slowness 0:58c3d014a4e7 20 * 3. The name of the author may not be used to endorse or promote products
slowness 0:58c3d014a4e7 21 * derived from this software without specific prior written permission.
slowness 0:58c3d014a4e7 22 *
slowness 0:58c3d014a4e7 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
slowness 0:58c3d014a4e7 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
slowness 0:58c3d014a4e7 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
slowness 0:58c3d014a4e7 26 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
slowness 0:58c3d014a4e7 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
slowness 0:58c3d014a4e7 28 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
slowness 0:58c3d014a4e7 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
slowness 0:58c3d014a4e7 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
slowness 0:58c3d014a4e7 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
slowness 0:58c3d014a4e7 32 * OF SUCH DAMAGE.
slowness 0:58c3d014a4e7 33 *
slowness 0:58c3d014a4e7 34 * Author: Dominik Spies <kontakt@dspies.de>
slowness 0:58c3d014a4e7 35 *
slowness 0:58c3d014a4e7 36 * This is a AutoIP implementation for the lwIP TCP/IP stack. It aims to conform
slowness 0:58c3d014a4e7 37 * with RFC 3927.
slowness 0:58c3d014a4e7 38 *
slowness 0:58c3d014a4e7 39 *
slowness 0:58c3d014a4e7 40 * Please coordinate changes and requests with Dominik Spies
slowness 0:58c3d014a4e7 41 * <kontakt@dspies.de>
slowness 0:58c3d014a4e7 42 */
slowness 0:58c3d014a4e7 43
slowness 0:58c3d014a4e7 44 #ifndef __LWIP_AUTOIP_H__
slowness 0:58c3d014a4e7 45 #define __LWIP_AUTOIP_H__
slowness 0:58c3d014a4e7 46
slowness 0:58c3d014a4e7 47 #include "lwip/opt.h"
slowness 0:58c3d014a4e7 48
slowness 0:58c3d014a4e7 49 #if LWIP_AUTOIP /* don't build if not configured for use in lwipopts.h */
slowness 0:58c3d014a4e7 50
slowness 0:58c3d014a4e7 51 #include "lwip/netif.h"
slowness 0:58c3d014a4e7 52 #include "lwip/udp.h"
slowness 0:58c3d014a4e7 53 #include "netif/etharp.h"
slowness 0:58c3d014a4e7 54
slowness 0:58c3d014a4e7 55 #ifdef __cplusplus
slowness 0:58c3d014a4e7 56 extern "C" {
slowness 0:58c3d014a4e7 57 #endif
slowness 0:58c3d014a4e7 58
slowness 0:58c3d014a4e7 59 /* AutoIP Timing */
slowness 0:58c3d014a4e7 60 #define AUTOIP_TMR_INTERVAL 100
slowness 0:58c3d014a4e7 61 #define AUTOIP_TICKS_PER_SECOND (1000 / AUTOIP_TMR_INTERVAL)
slowness 0:58c3d014a4e7 62
slowness 0:58c3d014a4e7 63 /* RFC 3927 Constants */
slowness 0:58c3d014a4e7 64 #define PROBE_WAIT 1 /* second (initial random delay) */
slowness 0:58c3d014a4e7 65 #define PROBE_MIN 1 /* second (minimum delay till repeated probe) */
slowness 0:58c3d014a4e7 66 #define PROBE_MAX 2 /* seconds (maximum delay till repeated probe) */
slowness 0:58c3d014a4e7 67 #define PROBE_NUM 3 /* (number of probe packets) */
slowness 0:58c3d014a4e7 68 #define ANNOUNCE_NUM 2 /* (number of announcement packets) */
slowness 0:58c3d014a4e7 69 #define ANNOUNCE_INTERVAL 2 /* seconds (time between announcement packets) */
slowness 0:58c3d014a4e7 70 #define ANNOUNCE_WAIT 2 /* seconds (delay before announcing) */
slowness 0:58c3d014a4e7 71 #define MAX_CONFLICTS 10 /* (max conflicts before rate limiting) */
slowness 0:58c3d014a4e7 72 #define RATE_LIMIT_INTERVAL 60 /* seconds (delay between successive attempts) */
slowness 0:58c3d014a4e7 73 #define DEFEND_INTERVAL 10 /* seconds (min. wait between defensive ARPs) */
slowness 0:58c3d014a4e7 74
slowness 0:58c3d014a4e7 75 /* AutoIP client states */
slowness 0:58c3d014a4e7 76 #define AUTOIP_STATE_OFF 0
slowness 0:58c3d014a4e7 77 #define AUTOIP_STATE_PROBING 1
slowness 0:58c3d014a4e7 78 #define AUTOIP_STATE_ANNOUNCING 2
slowness 0:58c3d014a4e7 79 #define AUTOIP_STATE_BOUND 3
slowness 0:58c3d014a4e7 80
slowness 0:58c3d014a4e7 81 struct autoip
slowness 0:58c3d014a4e7 82 {
slowness 0:58c3d014a4e7 83 ip_addr_t llipaddr; /* the currently selected, probed, announced or used LL IP-Address */
slowness 0:58c3d014a4e7 84 u8_t state; /* current AutoIP state machine state */
slowness 0:58c3d014a4e7 85 u8_t sent_num; /* sent number of probes or announces, dependent on state */
slowness 0:58c3d014a4e7 86 u16_t ttw; /* ticks to wait, tick is AUTOIP_TMR_INTERVAL long */
slowness 0:58c3d014a4e7 87 u8_t lastconflict; /* ticks until a conflict can be solved by defending */
slowness 0:58c3d014a4e7 88 u8_t tried_llipaddr; /* total number of probed/used Link Local IP-Addresses */
slowness 0:58c3d014a4e7 89 };
slowness 0:58c3d014a4e7 90
slowness 0:58c3d014a4e7 91
slowness 0:58c3d014a4e7 92 /** Init srand, has to be called before entering mainloop */
slowness 0:58c3d014a4e7 93 void autoip_init(void);
slowness 0:58c3d014a4e7 94
slowness 0:58c3d014a4e7 95 /** Set a struct autoip allocated by the application to work with */
slowness 0:58c3d014a4e7 96 void autoip_set_struct(struct netif *netif, struct autoip *autoip);
slowness 0:58c3d014a4e7 97
slowness 0:58c3d014a4e7 98 /** Start AutoIP client */
slowness 0:58c3d014a4e7 99 err_t autoip_start(struct netif *netif);
slowness 0:58c3d014a4e7 100
slowness 0:58c3d014a4e7 101 /** Stop AutoIP client */
slowness 0:58c3d014a4e7 102 err_t autoip_stop(struct netif *netif);
slowness 0:58c3d014a4e7 103
slowness 0:58c3d014a4e7 104 /** Handles every incoming ARP Packet, called by etharp_arp_input */
slowness 0:58c3d014a4e7 105 void autoip_arp_reply(struct netif *netif, struct etharp_hdr *hdr);
slowness 0:58c3d014a4e7 106
slowness 0:58c3d014a4e7 107 /** Has to be called in loop every AUTOIP_TMR_INTERVAL milliseconds */
slowness 0:58c3d014a4e7 108 void autoip_tmr(void);
slowness 0:58c3d014a4e7 109
slowness 0:58c3d014a4e7 110 /** Handle a possible change in the network configuration */
slowness 0:58c3d014a4e7 111 void autoip_network_changed(struct netif *netif);
slowness 0:58c3d014a4e7 112
slowness 0:58c3d014a4e7 113 #ifdef __cplusplus
slowness 0:58c3d014a4e7 114 }
slowness 0:58c3d014a4e7 115 #endif
slowness 0:58c3d014a4e7 116
slowness 0:58c3d014a4e7 117 #endif /* LWIP_AUTOIP */
slowness 0:58c3d014a4e7 118
slowness 0:58c3d014a4e7 119 #endif /* __LWIP_AUTOIP_H__ */