1*10465441SEvalZero /** 2*10465441SEvalZero * @file 3*10465441SEvalZero * 4*10465441SEvalZero * DHCPv6 client: IPv6 address autoconfiguration as per 5*10465441SEvalZero * RFC 3315 (stateful DHCPv6) and 6*10465441SEvalZero * RFC 3736 (stateless DHCPv6). 7*10465441SEvalZero */ 8*10465441SEvalZero 9*10465441SEvalZero /* 10*10465441SEvalZero * Copyright (c) 2018 Simon Goldschmidt 11*10465441SEvalZero * All rights reserved. 12*10465441SEvalZero * 13*10465441SEvalZero * Redistribution and use in source and binary forms, with or without modification, 14*10465441SEvalZero * are permitted provided that the following conditions are met: 15*10465441SEvalZero * 16*10465441SEvalZero * 1. Redistributions of source code must retain the above copyright notice, 17*10465441SEvalZero * this list of conditions and the following disclaimer. 18*10465441SEvalZero * 2. Redistributions in binary form must reproduce the above copyright notice, 19*10465441SEvalZero * this list of conditions and the following disclaimer in the documentation 20*10465441SEvalZero * and/or other materials provided with the distribution. 21*10465441SEvalZero * 3. The name of the author may not be used to endorse or promote products 22*10465441SEvalZero * derived from this software without specific prior written permission. 23*10465441SEvalZero * 24*10465441SEvalZero * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 25*10465441SEvalZero * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 26*10465441SEvalZero * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 27*10465441SEvalZero * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 28*10465441SEvalZero * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 29*10465441SEvalZero * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 30*10465441SEvalZero * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 31*10465441SEvalZero * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 32*10465441SEvalZero * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 33*10465441SEvalZero * OF SUCH DAMAGE. 34*10465441SEvalZero * 35*10465441SEvalZero * This file is part of the lwIP TCP/IP stack. 36*10465441SEvalZero * 37*10465441SEvalZero * Author: Simon Goldschmidt <[email protected]> 38*10465441SEvalZero */ 39*10465441SEvalZero 40*10465441SEvalZero #ifndef LWIP_HDR_IP6_DHCP6_H 41*10465441SEvalZero #define LWIP_HDR_IP6_DHCP6_H 42*10465441SEvalZero 43*10465441SEvalZero #include "lwip/opt.h" 44*10465441SEvalZero 45*10465441SEvalZero #if LWIP_IPV6_DHCP6 /* don't build if not configured for use in lwipopts.h */ 46*10465441SEvalZero 47*10465441SEvalZero #include "lwip/err.h" 48*10465441SEvalZero #include "lwip/netif.h" 49*10465441SEvalZero 50*10465441SEvalZero #ifdef __cplusplus 51*10465441SEvalZero extern "C" { 52*10465441SEvalZero #endif 53*10465441SEvalZero 54*10465441SEvalZero /** period (in milliseconds) of the application calling dhcp6_tmr() */ 55*10465441SEvalZero #define DHCP6_TIMER_MSECS 500 56*10465441SEvalZero 57*10465441SEvalZero struct dhcp6 58*10465441SEvalZero { 59*10465441SEvalZero /** transaction identifier of last sent request */ 60*10465441SEvalZero u32_t xid; 61*10465441SEvalZero /** track PCB allocation state */ 62*10465441SEvalZero u8_t pcb_allocated; 63*10465441SEvalZero /** current DHCPv6 state machine state */ 64*10465441SEvalZero u8_t state; 65*10465441SEvalZero /** retries of current request */ 66*10465441SEvalZero u8_t tries; 67*10465441SEvalZero /** if request config is triggered while another action is active, this keeps track of it */ 68*10465441SEvalZero u8_t request_config_pending; 69*10465441SEvalZero /** #ticks with period DHCP6_TIMER_MSECS for request timeout */ 70*10465441SEvalZero u16_t request_timeout; 71*10465441SEvalZero #if LWIP_IPV6_DHCP6_STATEFUL 72*10465441SEvalZero /* @todo: add more members here to keep track of stateful DHCPv6 data, like lease times */ 73*10465441SEvalZero #endif /* LWIP_IPV6_DHCP6_STATEFUL */ 74*10465441SEvalZero }; 75*10465441SEvalZero 76*10465441SEvalZero void dhcp6_set_struct(struct netif *netif, struct dhcp6 *dhcp6); 77*10465441SEvalZero /** Remove a struct dhcp6 previously set to the netif using dhcp6_set_struct() */ 78*10465441SEvalZero #define dhcp6_remove_struct(netif) netif_set_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_DHCP6, NULL) 79*10465441SEvalZero void dhcp6_cleanup(struct netif *netif); 80*10465441SEvalZero 81*10465441SEvalZero err_t dhcp6_enable_stateful(struct netif *netif); 82*10465441SEvalZero err_t dhcp6_enable_stateless(struct netif *netif); 83*10465441SEvalZero void dhcp6_disable(struct netif *netif); 84*10465441SEvalZero 85*10465441SEvalZero void dhcp6_tmr(void); 86*10465441SEvalZero 87*10465441SEvalZero void dhcp6_nd6_ra_trigger(struct netif *netif, u8_t managed_addr_config, u8_t other_config); 88*10465441SEvalZero 89*10465441SEvalZero #if LWIP_DHCP6_GET_NTP_SRV 90*10465441SEvalZero /** This function must exist, in other to add offered NTP servers to 91*10465441SEvalZero * the NTP (or SNTP) engine. 92*10465441SEvalZero * See LWIP_DHCP6_MAX_NTP_SERVERS */ 93*10465441SEvalZero extern void dhcp6_set_ntp_servers(u8_t num_ntp_servers, const ip_addr_t* ntp_server_addrs); 94*10465441SEvalZero #endif /* LWIP_DHCP6_GET_NTP_SRV */ 95*10465441SEvalZero 96*10465441SEvalZero #define netif_dhcp6_data(netif) ((struct dhcp6*)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_DHCP6)) 97*10465441SEvalZero 98*10465441SEvalZero #ifdef __cplusplus 99*10465441SEvalZero } 100*10465441SEvalZero #endif 101*10465441SEvalZero 102*10465441SEvalZero #endif /* LWIP_IPV6_DHCP6 */ 103*10465441SEvalZero 104*10465441SEvalZero #endif /* LWIP_HDR_IP6_DHCP6_H */ 105