4 #ifndef __LWIP_DHCP_H__
\r
5 #define __LWIP_DHCP_H__
\r
7 #include "lwip/opt.h"
\r
8 #include "lwip/netif.h"
\r
9 #include "lwip/udp.h"
\r
11 /** period (in seconds) of the application calling dhcp_coarse_tmr() */
\r
12 #define DHCP_COARSE_TIMER_SECS 60
\r
13 /** period (in milliseconds) of the application calling dhcp_fine_tmr() */
\r
14 #define DHCP_FINE_TIMER_MSECS 500
\r
18 /** current DHCP state machine state */
\r
20 /** retries of current request */
\r
22 /** transaction identifier of last sent request */
\r
24 /** our connection to the DHCP server */
\r
25 struct udp_pcb *pcb;
\r
26 /** (first) pbuf of incoming msg */
\r
29 struct dhcp_msg *msg_in;
\r
30 /** incoming msg options */
\r
31 struct dhcp_msg *options_in;
\r
32 /** ingoing msg options length */
\r
33 u16_t options_in_len;
\r
35 struct pbuf *p_out; /* pbuf of outcoming msg */
\r
36 struct dhcp_msg *msg_out; /* outgoing msg */
\r
37 u16_t options_out_len; /* outgoing msg options length */
\r
38 u16_t request_timeout; /* #ticks with period DHCP_FINE_TIMER_SECS for request timeout */
\r
39 u16_t t1_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for renewal time */
\r
40 u16_t t2_timeout; /* #ticks with period DHCP_COARSE_TIMER_SECS for rebind time */
\r
41 struct ip_addr server_ip_addr; /* dhcp server address that offered this lease */
\r
42 struct ip_addr offered_ip_addr;
\r
43 struct ip_addr offered_sn_mask;
\r
44 struct ip_addr offered_gw_addr;
\r
45 struct ip_addr offered_bc_addr;
\r
46 #define DHCP_MAX_DNS 2
\r
47 u32_t dns_count; /* actual number of DNS servers obtained */
\r
48 struct ip_addr offered_dns_addr[DHCP_MAX_DNS]; /* DNS server addresses */
\r
50 u32_t offered_t0_lease; /* lease period (in seconds) */
\r
51 u32_t offered_t1_renew; /* recommended renew time (usually 50% of lease period) */
\r
52 u32_t offered_t2_rebind; /* recommended rebind time (usually 66% of lease period) */
\r
54 * TODO: See dhcp.c "TODO"s
\r
57 struct ip_addr offered_si_addr;
\r
58 u8_t *boot_file_name;
\r
62 /* MUST be compiled with "pack structs" or equivalent! */
\r
63 #ifdef PACK_STRUCT_USE_INCLUDES
\r
64 # include "arch/bpstruct.h"
\r
67 /** minimum set of fields of any DHCP message */
\r
70 PACK_STRUCT_FIELD(u8_t op);
\r
71 PACK_STRUCT_FIELD(u8_t htype);
\r
72 PACK_STRUCT_FIELD(u8_t hlen);
\r
73 PACK_STRUCT_FIELD(u8_t hops);
\r
74 PACK_STRUCT_FIELD(u32_t xid);
\r
75 PACK_STRUCT_FIELD(u16_t secs);
\r
76 PACK_STRUCT_FIELD(u16_t flags);
\r
77 PACK_STRUCT_FIELD(struct ip_addr ciaddr);
\r
78 PACK_STRUCT_FIELD(struct ip_addr yiaddr);
\r
79 PACK_STRUCT_FIELD(struct ip_addr siaddr);
\r
80 PACK_STRUCT_FIELD(struct ip_addr giaddr);
\r
81 #define DHCP_CHADDR_LEN 16U
\r
82 PACK_STRUCT_FIELD(u8_t chaddr[DHCP_CHADDR_LEN]);
\r
83 #define DHCP_SNAME_LEN 64U
\r
84 PACK_STRUCT_FIELD(u8_t sname[DHCP_SNAME_LEN]);
\r
85 #define DHCP_FILE_LEN 128U
\r
86 PACK_STRUCT_FIELD(u8_t file[DHCP_FILE_LEN]);
\r
87 PACK_STRUCT_FIELD(u32_t cookie);
\r
88 #define DHCP_MIN_OPTIONS_LEN 68U
\r
89 /** make sure user does not configure this too small */
\r
90 #if ((defined(DHCP_OPTIONS_LEN)) && (DHCP_OPTIONS_LEN < DHCP_MIN_OPTIONS_LEN))
\r
91 # undef DHCP_OPTIONS_LEN
\r
93 /** allow this to be configured in lwipopts.h, but not too small */
\r
94 #if (!defined(DHCP_OPTIONS_LEN))
\r
95 /** set this to be sufficient for your options in outgoing DHCP msgs */
\r
96 # define DHCP_OPTIONS_LEN DHCP_MIN_OPTIONS_LEN
\r
98 PACK_STRUCT_FIELD(u8_t options[DHCP_OPTIONS_LEN]);
\r
99 } PACK_STRUCT_STRUCT;
\r
101 #ifdef PACK_STRUCT_USE_INCLUDES
\r
102 # include "arch/epstruct.h"
\r
105 /** start DHCP configuration */
\r
106 err_t dhcp_start(struct netif *netif);
\r
107 /** enforce early lease renewal (not needed normally)*/
\r
108 err_t dhcp_renew(struct netif *netif);
\r
109 /** release the DHCP lease, usually called before dhcp_stop()*/
\r
110 err_t dhcp_release(struct netif *netif);
\r
111 /** stop DHCP configuration */
\r
112 void dhcp_stop(struct netif *netif);
\r
113 /** inform server of our manual IP address */
\r
114 void dhcp_inform(struct netif *netif);
\r
116 /** if enabled, check whether the offered IP address is not in use, using ARP */
\r
117 #if DHCP_DOES_ARP_CHECK
\r
118 void dhcp_arp_reply(struct netif *netif, struct ip_addr *addr);
\r
121 /** to be called every minute */
\r
122 void dhcp_coarse_tmr(void);
\r
123 /** to be called every half second */
\r
124 void dhcp_fine_tmr(void);
\r
126 /** DHCP message item offsets and length */
\r
127 #define DHCP_MSG_OFS (UDP_DATA_OFS)
\r
128 #define DHCP_OP_OFS (DHCP_MSG_OFS + 0)
\r
129 #define DHCP_HTYPE_OFS (DHCP_MSG_OFS + 1)
\r
130 #define DHCP_HLEN_OFS (DHCP_MSG_OFS + 2)
\r
131 #define DHCP_HOPS_OFS (DHCP_MSG_OFS + 3)
\r
132 #define DHCP_XID_OFS (DHCP_MSG_OFS + 4)
\r
133 #define DHCP_SECS_OFS (DHCP_MSG_OFS + 8)
\r
134 #define DHCP_FLAGS_OFS (DHCP_MSG_OFS + 10)
\r
135 #define DHCP_CIADDR_OFS (DHCP_MSG_OFS + 12)
\r
136 #define DHCP_YIADDR_OFS (DHCP_MSG_OFS + 16)
\r
137 #define DHCP_SIADDR_OFS (DHCP_MSG_OFS + 20)
\r
138 #define DHCP_GIADDR_OFS (DHCP_MSG_OFS + 24)
\r
139 #define DHCP_CHADDR_OFS (DHCP_MSG_OFS + 28)
\r
140 #define DHCP_SNAME_OFS (DHCP_MSG_OFS + 44)
\r
141 #define DHCP_FILE_OFS (DHCP_MSG_OFS + 108)
\r
142 #define DHCP_MSG_LEN 236
\r
144 #define DHCP_COOKIE_OFS (DHCP_MSG_OFS + DHCP_MSG_LEN)
\r
145 #define DHCP_OPTIONS_OFS (DHCP_MSG_OFS + DHCP_MSG_LEN + 4)
\r
147 #define DHCP_CLIENT_PORT 68
\r
148 #define DHCP_SERVER_PORT 67
\r
150 /** DHCP client states */
\r
151 #define DHCP_REQUESTING 1
\r
152 #define DHCP_INIT 2
\r
153 #define DHCP_REBOOTING 3
\r
154 #define DHCP_REBINDING 4
\r
155 #define DHCP_RENEWING 5
\r
156 #define DHCP_SELECTING 6
\r
157 #define DHCP_INFORMING 7
\r
158 #define DHCP_CHECKING 8
\r
159 #define DHCP_PERMANENT 9
\r
160 #define DHCP_BOUND 10
\r
161 /** not yet implemented #define DHCP_RELEASING 11 */
\r
162 #define DHCP_BACKING_OFF 12
\r
163 #define DHCP_OFF 13
\r
165 #define DHCP_BOOTREQUEST 1
\r
166 #define DHCP_BOOTREPLY 2
\r
168 #define DHCP_DISCOVER 1
\r
169 #define DHCP_OFFER 2
\r
170 #define DHCP_REQUEST 3
\r
171 #define DHCP_DECLINE 4
\r
174 #define DHCP_RELEASE 7
\r
175 #define DHCP_INFORM 8
\r
177 #define DHCP_HTYPE_ETH 1
\r
179 #define DHCP_HLEN_ETH 6
\r
181 #define DHCP_BROADCAST_FLAG 15
\r
182 #define DHCP_BROADCAST_MASK (1 << DHCP_FLAG_BROADCAST)
\r
184 /** BootP options */
\r
185 #define DHCP_OPTION_PAD 0
\r
186 #define DHCP_OPTION_SUBNET_MASK 1 /* RFC 2132 3.3 */
\r
187 #define DHCP_OPTION_ROUTER 3
\r
188 #define DHCP_OPTION_DNS_SERVER 6
\r
189 #define DHCP_OPTION_HOSTNAME 12
\r
190 #define DHCP_OPTION_IP_TTL 23
\r
191 #define DHCP_OPTION_MTU 26
\r
192 #define DHCP_OPTION_BROADCAST 28
\r
193 #define DHCP_OPTION_TCP_TTL 37
\r
194 #define DHCP_OPTION_END 255
\r
196 /** DHCP options */
\r
197 #define DHCP_OPTION_REQUESTED_IP 50 /* RFC 2132 9.1, requested IP address */
\r
198 #define DHCP_OPTION_LEASE_TIME 51 /* RFC 2132 9.2, time in seconds, in 4 bytes */
\r
199 #define DHCP_OPTION_OVERLOAD 52 /* RFC2132 9.3, use file and/or sname field for options */
\r
201 #define DHCP_OPTION_MESSAGE_TYPE 53 /* RFC 2132 9.6, important for DHCP */
\r
202 #define DHCP_OPTION_MESSAGE_TYPE_LEN 1
\r
205 #define DHCP_OPTION_SERVER_ID 54 /* RFC 2132 9.7, server IP address */
\r
206 #define DHCP_OPTION_PARAMETER_REQUEST_LIST 55 /* RFC 2132 9.8, requested option types */
\r
208 #define DHCP_OPTION_MAX_MSG_SIZE 57 /* RFC 2132 9.10, message size accepted >= 576 */
\r
209 #define DHCP_OPTION_MAX_MSG_SIZE_LEN 2
\r
211 #define DHCP_OPTION_T1 58 /* T1 renewal time */
\r
212 #define DHCP_OPTION_T2 59 /* T2 rebinding time */
\r
213 #define DHCP_OPTION_CLIENT_ID 61
\r
214 #define DHCP_OPTION_TFTP_SERVERNAME 66
\r
215 #define DHCP_OPTION_BOOTFILE 67
\r
217 /** possible combinations of overloading the file and sname fields with options */
\r
218 #define DHCP_OVERLOAD_NONE 0
\r
219 #define DHCP_OVERLOAD_FILE 1
\r
220 #define DHCP_OVERLOAD_SNAME 2
\r
221 #define DHCP_OVERLOAD_SNAME_FILE 3
\r
223 #endif /*__LWIP_DHCP_H__*/
\r