TuyaOS
dhcp.h
浏览该文件的文档.
1
6/*
7 * Copyright (c) 2001-2004 Leon Woestenberg <leon.woestenberg@gmx.net>
8 * Copyright (c) 2001-2004 Axon Digital Design B.V., The Netherlands.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 * 3. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
31 * OF SUCH DAMAGE.
32 *
33 * This file is part of the lwIP TCP/IP stack.
34 *
35 * Author: Leon Woestenberg <leon.woestenberg@gmx.net>
36 *
37 */
38#ifndef LWIP_HDR_DHCP_H
39#define LWIP_HDR_DHCP_H
40
41#include "lwip/opt.h"
42
43#if LWIP_DHCP /* don't build if not configured for use in lwipopts.h */
44
45#include "lwip/netif.h"
46#include "lwip/udp.h"
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
53//hz ᵽlwipopts.hΪû
54#ifndef DHCP_COARSE_TIMER_SECS
55#define DHCP_COARSE_TIMER_SECS 60
56#endif
57
59#define DHCP_COARSE_TIMER_MSECS (DHCP_COARSE_TIMER_SECS * 1000UL)
61#define DHCP_FINE_TIMER_MSECS 500
62
63#define DHCP_BOOT_FILE_LEN 128U
64
65/* AutoIP cooperation flags (struct dhcp.autoip_coop_state) */
66typedef enum {
67 DHCP_AUTOIP_COOP_STATE_OFF = 0,
68 DHCP_AUTOIP_COOP_STATE_ON = 1
69} dhcp_autoip_coop_state_enum_t;
70
71struct dhcp
72{
74 u32_t xid;
76 u8_t pcb_allocated;
78 u8_t state;
80 u8_t tries;
81#if LWIP_DHCP_AUTOIP_COOP
82 u8_t autoip_coop_state;
83#endif
84 u8_t subnet_mask_given;
85
86 u16_t request_timeout; /* #ticks with period DHCP_FINE_TIMER_SECS for request timeout */
87 u16_t t1_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for renewal time */
88 u16_t t2_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for rebind time */
89 u16_t t1_renew_time; /* #ticks with period DHCP_COARSE_TIMER_SECS until next renew try */
90 u16_t t2_rebind_time; /* #ticks with period DHCP_COARSE_TIMER_SECS until next rebind try */
91 u16_t lease_used; /* #ticks with period DHCP_COARSE_TIMER_SECS since last received DHCP ack */
92 u16_t t0_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for lease time */
93 ip_addr_t server_ip_addr; /* dhcp server address that offered this lease (ip_addr_t because passed to UDP) */
94 ip4_addr_t offered_ip_addr;
95 ip4_addr_t offered_sn_mask;
96 ip4_addr_t offered_gw_addr;
97
98 u32_t offered_t0_lease; /* lease period (in seconds) */
99 u32_t offered_t1_renew; /* recommended renew time (usually 50% of lease period) */
100 u32_t offered_t2_rebind; /* recommended rebind time (usually 87.5 of lease period) */
101#if LWIP_DHCP_BOOTP_FILE
102 ip4_addr_t offered_si_addr;
103 char boot_file_name[DHCP_BOOT_FILE_LEN];
104#endif /* LWIP_DHCP_BOOTPFILE */
105#if LWIP_DHCP_SECONDS_ELAPSE
106 u32_t seconds_elapsed; //Realtek add end //hz ֵΪ˼dhcpSeconds Elasped
107#endif
108};
109
110
111void dhcp_set_struct(struct netif *netif, struct dhcp *dhcp);
113#define dhcp_remove_struct(netif) netif_set_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_DHCP, NULL)
114void dhcp_cleanup(struct netif *netif);
115err_t dhcp_start(struct netif *netif);
116err_t dhcp_renew(struct netif *netif);
117err_t dhcp_release(struct netif *netif);
118void dhcp_stop(struct netif *netif);
119void dhcp_release_and_stop(struct netif *netif);
120void dhcp_inform(struct netif *netif);
121void dhcp_network_changed(struct netif *netif);
122#if DHCP_DOES_ARP_CHECK
123void dhcp_arp_reply(struct netif *netif, const ip4_addr_t *addr);
124#endif
125u8_t dhcp_supplied_address(const struct netif *netif);
126/* to be called every minute */
127void dhcp_coarse_tmr(void);
128/* to be called every half second */
129void dhcp_fine_tmr(void);
130
131#if LWIP_DHCP_GET_NTP_SRV
135extern void dhcp_set_ntp_servers(u8_t num_ntp_servers, const ip4_addr_t* ntp_server_addrs);
136#endif /* LWIP_DHCP_GET_NTP_SRV */
137
138#define netif_dhcp_data(netif) ((struct dhcp*)netif_get_client_data(netif, LWIP_NETIF_CLIENT_DATA_INDEX_DHCP))
139
140#ifdef __cplusplus
141}
142#endif
143
144#endif /* LWIP_DHCP */
145
146#endif /*LWIP_HDR_DHCP_H*/
s8_t err_t
Definition: err.h:96
Definition: netif.h:260