xref: /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/lwip/autoip.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /**
2*10465441SEvalZero  * @file
3*10465441SEvalZero  *
4*10465441SEvalZero  * AutoIP Automatic LinkLocal IP Configuration
5*10465441SEvalZero  */
6*10465441SEvalZero 
7*10465441SEvalZero /*
8*10465441SEvalZero  *
9*10465441SEvalZero  * Copyright (c) 2007 Dominik Spies <[email protected]>
10*10465441SEvalZero  * All rights reserved.
11*10465441SEvalZero  *
12*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without modification,
13*10465441SEvalZero  * are permitted provided that the following conditions are met:
14*10465441SEvalZero  *
15*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright notice,
16*10465441SEvalZero  *    this list of conditions and the following disclaimer.
17*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright notice,
18*10465441SEvalZero  *    this list of conditions and the following disclaimer in the documentation
19*10465441SEvalZero  *    and/or other materials provided with the distribution.
20*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
21*10465441SEvalZero  *    derived from this software without specific prior written permission.
22*10465441SEvalZero  *
23*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
24*10465441SEvalZero  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25*10465441SEvalZero  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
26*10465441SEvalZero  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27*10465441SEvalZero  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
28*10465441SEvalZero  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29*10465441SEvalZero  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30*10465441SEvalZero  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
31*10465441SEvalZero  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
32*10465441SEvalZero  * OF SUCH DAMAGE.
33*10465441SEvalZero  *
34*10465441SEvalZero  * Author: Dominik Spies <[email protected]>
35*10465441SEvalZero  *
36*10465441SEvalZero  * This is a AutoIP implementation for the lwIP TCP/IP stack. It aims to conform
37*10465441SEvalZero  * with RFC 3927.
38*10465441SEvalZero  *
39*10465441SEvalZero  */
40*10465441SEvalZero 
41*10465441SEvalZero #ifndef LWIP_HDR_AUTOIP_H
42*10465441SEvalZero #define LWIP_HDR_AUTOIP_H
43*10465441SEvalZero 
44*10465441SEvalZero #include "lwip/opt.h"
45*10465441SEvalZero 
46*10465441SEvalZero #if LWIP_IPV4 && LWIP_AUTOIP /* don't build if not configured for use in lwipopts.h */
47*10465441SEvalZero 
48*10465441SEvalZero #include "lwip/netif.h"
49*10465441SEvalZero /* #include "lwip/udp.h" */
50*10465441SEvalZero #include "lwip/etharp.h"
51*10465441SEvalZero 
52*10465441SEvalZero #ifdef __cplusplus
53*10465441SEvalZero extern "C" {
54*10465441SEvalZero #endif
55*10465441SEvalZero 
56*10465441SEvalZero /** AutoIP Timing */
57*10465441SEvalZero #define AUTOIP_TMR_INTERVAL      100
58*10465441SEvalZero #define AUTOIP_TICKS_PER_SECOND (1000 / AUTOIP_TMR_INTERVAL)
59*10465441SEvalZero 
60*10465441SEvalZero /** AutoIP state information per netif */
61*10465441SEvalZero struct autoip
62*10465441SEvalZero {
63*10465441SEvalZero   /** the currently selected, probed, announced or used LL IP-Address */
64*10465441SEvalZero   ip4_addr_t llipaddr;
65*10465441SEvalZero   /** current AutoIP state machine state */
66*10465441SEvalZero   u8_t state;
67*10465441SEvalZero   /** sent number of probes or announces, dependent on state */
68*10465441SEvalZero   u8_t sent_num;
69*10465441SEvalZero   /** ticks to wait, tick is AUTOIP_TMR_INTERVAL long */
70*10465441SEvalZero   u16_t ttw;
71*10465441SEvalZero   /** ticks until a conflict can be solved by defending */
72*10465441SEvalZero   u8_t lastconflict;
73*10465441SEvalZero   /** total number of probed/used Link Local IP-Addresses */
74*10465441SEvalZero   u8_t tried_llipaddr;
75*10465441SEvalZero };
76*10465441SEvalZero 
77*10465441SEvalZero 
78*10465441SEvalZero void autoip_set_struct(struct netif *netif, struct autoip *autoip);
79*10465441SEvalZero /** Remove a struct autoip previously set to the netif using autoip_set_struct() */
80*10465441SEvalZero #define autoip_remove_struct(netif) do { (netif)->autoip = NULL; } while (0)
81*10465441SEvalZero err_t autoip_start(struct netif *netif);
82*10465441SEvalZero err_t autoip_stop(struct netif *netif);
83*10465441SEvalZero void autoip_arp_reply(struct netif *netif, struct etharp_hdr *hdr);
84*10465441SEvalZero void autoip_tmr(void);
85*10465441SEvalZero void autoip_network_changed(struct netif *netif);
86*10465441SEvalZero u8_t autoip_supplied_address(const struct netif *netif);
87*10465441SEvalZero 
88*10465441SEvalZero /* for lwIP internal use by ip4.c */
89*10465441SEvalZero u8_t autoip_accept_packet(struct netif *netif, const ip4_addr_t *addr);
90*10465441SEvalZero 
91*10465441SEvalZero #define netif_autoip_data(netif) ((struct autoip*)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_AUTOIP))
92*10465441SEvalZero 
93*10465441SEvalZero #ifdef __cplusplus
94*10465441SEvalZero }
95*10465441SEvalZero #endif
96*10465441SEvalZero 
97*10465441SEvalZero #endif /* LWIP_IPV4 && LWIP_AUTOIP */
98*10465441SEvalZero 
99*10465441SEvalZero #endif /* LWIP_HDR_AUTOIP_H */
100