3 * Dynamic Host Configuration Protocol client
9 * Copyright (c) 2001-2004 Leon Woestenberg <leon.woestenberg@gmx.net>
10 * Copyright (c) 2001-2004 Axon Digital Design B.V., The Netherlands.
11 * All rights reserved.
13 * Redistribution and use in source and binary forms, with or without modification,
14 * are permitted provided that the following conditions are met:
16 * 1. Redistributions of source code must retain the above copyright notice,
17 * this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright notice,
19 * this list of conditions and the following disclaimer in the documentation
20 * and/or other materials provided with the distribution.
21 * 3. The name of the author may not be used to endorse or promote products
22 * derived from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
25 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
27 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
29 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
35 * This file is a contribution to the lwIP TCP/IP stack.
36 * The Swedish Institute of Computer Science and Adam Dunkels
37 * are specifically granted permission to redistribute this
40 * Author: Leon Woestenberg <leon.woestenberg@gmx.net>
42 * This is a DHCP client for the lwIP TCP/IP stack. It aims to conform
43 * with RFC 2131 and RFC 2132.
46 * - Support for interfaces other than Ethernet (SLIP, PPP, ...)
48 * Please coordinate changes and requests with Leon Woestenberg
49 * <leon.woestenberg@gmx.net>
51 * Integration with your code:
54 * #define DHCP_COARSE_TIMER_SECS (recommended 60 which is a minute)
55 * #define DHCP_FINE_TIMER_MSECS (recommended 500 which equals TCP coarse timer)
57 * Then have your application call dhcp_coarse_tmr() and
58 * dhcp_fine_tmr() on the defined intervals.
60 * dhcp_start(struct netif *netif);
61 * starts a DHCP client instance which configures the interface by
62 * obtaining an IP address lease and maintaining it.
64 * Use dhcp_release(netif) to end the lease and use dhcp_stop(netif)
65 * to remove the DHCP client.
71 #if LWIP_DHCP /* don't build if not configured for use in lwipopts.h */
73 #include "lwip/stats.h"
76 #include "lwip/ip_addr.h"
77 #include "lwip/netif.h"
79 #include "lwip/dhcp.h"
80 #include "lwip/autoip.h"
82 #include "netif/etharp.h"
86 /** DHCP_CREATE_RAND_XID: if this is set to 1, the xid is created using
87 * LWIP_RAND() (this overrides DHCP_GLOBAL_XID)
89 #ifndef DHCP_CREATE_RAND_XID
90 #define DHCP_CREATE_RAND_XID 1
93 /** Default for DHCP_GLOBAL_XID is 0xABCD0000
94 * This can be changed by defining DHCP_GLOBAL_XID and DHCP_GLOBAL_XID_HEADER, e.g.
95 * #define DHCP_GLOBAL_XID_HEADER "stdlib.h"
96 * #define DHCP_GLOBAL_XID rand()
98 #ifdef DHCP_GLOBAL_XID_HEADER
99 #include DHCP_GLOBAL_XID_HEADER /* include optional starting XID generation prototypes */
102 /** DHCP_OPTION_MAX_MSG_SIZE is set to the MTU
103 * MTU is checked to be big enough in dhcp_start */
104 #define DHCP_MAX_MSG_LEN(netif) (netif->mtu)
105 #define DHCP_MAX_MSG_LEN_MIN_REQUIRED 576
106 /** Minimum length for reply before packet is parsed */
107 #define DHCP_MIN_REPLY_LEN 44
109 #define REBOOT_TRIES 2
111 /** Option handling: options are parsed in dhcp_parse_reply
112 * and saved in an array where other functions can load them from.
113 * This might be moved into the struct dhcp (not necessarily since
114 * lwIP is single-threaded and the array is only used while in recv
116 #define DHCP_OPTION_IDX_OVERLOAD 0
117 #define DHCP_OPTION_IDX_MSG_TYPE 1
118 #define DHCP_OPTION_IDX_SERVER_ID 2
119 #define DHCP_OPTION_IDX_LEASE_TIME 3
120 #define DHCP_OPTION_IDX_T1 4
121 #define DHCP_OPTION_IDX_T2 5
122 #define DHCP_OPTION_IDX_SUBNET_MASK 6
123 #define DHCP_OPTION_IDX_ROUTER 7
124 #define DHCP_OPTION_IDX_DNS_SERVER 8
125 #define DHCP_OPTION_IDX_MAX (DHCP_OPTION_IDX_DNS_SERVER + DNS_MAX_SERVERS)
127 /** Holds the decoded option values, only valid while in dhcp_recv.
128 @todo: move this into struct dhcp? */
129 u32_t dhcp_rx_options_val[DHCP_OPTION_IDX_MAX];
130 /** Holds a flag which option was received and is contained in dhcp_rx_options_val,
131 only valid while in dhcp_recv.
132 @todo: move this into struct dhcp? */
133 u8_t dhcp_rx_options_given[DHCP_OPTION_IDX_MAX];
135 #ifdef DHCP_GLOBAL_XID
137 static u8_t xid_initialised;
138 #endif /* DHCP_GLOBAL_XID */
140 #define dhcp_option_given(dhcp, idx) (dhcp_rx_options_given[idx] != 0)
141 #define dhcp_got_option(dhcp, idx) (dhcp_rx_options_given[idx] = 1)
142 #define dhcp_clear_option(dhcp, idx) (dhcp_rx_options_given[idx] = 0)
143 #define dhcp_clear_all_options(dhcp) (memset(dhcp_rx_options_given, 0, sizeof(dhcp_rx_options_given)))
144 #define dhcp_get_option_value(dhcp, idx) (dhcp_rx_options_val[idx])
145 #define dhcp_set_option_value(dhcp, idx, val) (dhcp_rx_options_val[idx] = (val))
148 /* DHCP client state machine functions */
149 static err_t dhcp_discover(struct netif *netif);
150 static err_t dhcp_select(struct netif *netif);
151 static void dhcp_bind(struct netif *netif);
152 #if DHCP_DOES_ARP_CHECK
153 static err_t dhcp_decline(struct netif *netif);
154 #endif /* DHCP_DOES_ARP_CHECK */
155 static err_t dhcp_rebind(struct netif *netif);
156 static err_t dhcp_reboot(struct netif *netif);
157 static void dhcp_set_state(struct dhcp *dhcp, u8_t new_state);
159 /* receive, unfold, parse and free incoming messages */
160 static void dhcp_recv(void *arg, struct udp_pcb *pcb, struct pbuf *p, ip_addr_t *addr, u16_t port);
162 /* set the DHCP timers */
163 static void dhcp_timeout(struct netif *netif);
164 static void dhcp_t1_timeout(struct netif *netif);
165 static void dhcp_t2_timeout(struct netif *netif);
167 /* build outgoing messages */
168 /* create a DHCP message, fill in common headers */
169 static err_t dhcp_create_msg(struct netif *netif, struct dhcp *dhcp, u8_t message_type);
170 /* free a DHCP request */
171 static void dhcp_delete_msg(struct dhcp *dhcp);
172 /* add a DHCP option (type, then length in bytes) */
173 static void dhcp_option(struct dhcp *dhcp, u8_t option_type, u8_t option_len);
174 /* add option values */
175 static void dhcp_option_byte(struct dhcp *dhcp, u8_t value);
176 static void dhcp_option_short(struct dhcp *dhcp, u16_t value);
177 static void dhcp_option_long(struct dhcp *dhcp, u32_t value);
178 #if LWIP_NETIF_HOSTNAME
179 static void dhcp_option_hostname(struct dhcp *dhcp, struct netif *netif);
180 #endif /* LWIP_NETIF_HOSTNAME */
181 /* always add the DHCP options trailer to end and pad */
182 static void dhcp_option_trailer(struct dhcp *dhcp);
185 * Back-off the DHCP client (because of a received NAK response).
187 * Back-off the DHCP client because of a received NAK. Receiving a
188 * NAK means the client asked for something non-sensible, for
189 * example when it tries to renew a lease obtained on another network.
191 * We clear any existing set IP address and restart DHCP negotiation
192 * afresh (as per RFC2131 3.2.3).
194 * @param netif the netif under DHCP control
197 dhcp_handle_nak(struct netif *netif)
199 struct dhcp *dhcp = netif->dhcp;
200 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_handle_nak(netif=%p) %c%c%"U16_F"\n",
201 (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num));
202 /* Set the interface down since the address must no longer be used, as per RFC2131 */
203 netif_set_down(netif);
204 /* remove IP address from interface */
205 netif_set_ipaddr(netif, IP_ADDR_ANY);
206 netif_set_gw(netif, IP_ADDR_ANY);
207 netif_set_netmask(netif, IP_ADDR_ANY);
208 /* Change to a defined state */
209 dhcp_set_state(dhcp, DHCP_BACKING_OFF);
210 /* We can immediately restart discovery */
211 dhcp_discover(netif);
214 #if DHCP_DOES_ARP_CHECK
216 * Checks if the offered IP address is already in use.
218 * It does so by sending an ARP request for the offered address and
219 * entering CHECKING state. If no ARP reply is received within a small
220 * interval, the address is assumed to be free for use by us.
222 * @param netif the netif under DHCP control
225 dhcp_check(struct netif *netif)
227 struct dhcp *dhcp = netif->dhcp;
230 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_check(netif=%p) %c%c\n", (void *)netif, (s16_t)netif->name[0],
231 (s16_t)netif->name[1]));
232 dhcp_set_state(dhcp, DHCP_CHECKING);
233 /* create an ARP query for the offered IP address, expecting that no host
234 responds, as the IP address should not be in use. */
235 result = etharp_query(netif, &dhcp->offered_ip_addr, NULL);
236 if (result != ERR_OK) {
237 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING, ("dhcp_check: could not perform ARP query\n"));
241 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
242 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_check(): set request timeout %"U16_F" msecs\n", msecs));
244 #endif /* DHCP_DOES_ARP_CHECK */
247 * Remember the configuration offered by a DHCP server.
249 * @param netif the netif under DHCP control
252 dhcp_handle_offer(struct netif *netif)
254 struct dhcp *dhcp = netif->dhcp;
255 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_handle_offer(netif=%p) %c%c%"U16_F"\n",
256 (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num));
257 /* obtain the server address */
258 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_SERVER_ID)) {
259 ip4_addr_set_u32(&dhcp->server_ip_addr, htonl(dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_SERVER_ID)));
260 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_handle_offer(): server 0x%08"X32_F"\n",
261 ip4_addr_get_u32(&dhcp->server_ip_addr)));
262 /* remember offered address */
263 ip_addr_copy(dhcp->offered_ip_addr, dhcp->msg_in->yiaddr);
264 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_handle_offer(): offer for 0x%08"X32_F"\n",
265 ip4_addr_get_u32(&dhcp->offered_ip_addr)));
269 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS,
270 ("dhcp_handle_offer(netif=%p) did not get server ID!\n", (void*)netif));
275 * Select a DHCP server offer out of all offers.
277 * Simply select the first offer received.
279 * @param netif the netif under DHCP control
280 * @return lwIP specific error (see error.h)
283 dhcp_select(struct netif *netif)
285 struct dhcp *dhcp = netif->dhcp;
289 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_select(netif=%p) %c%c%"U16_F"\n", (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num));
290 dhcp_set_state(dhcp, DHCP_REQUESTING);
292 /* create and initialize the DHCP message header */
293 result = dhcp_create_msg(netif, dhcp, DHCP_REQUEST);
294 if (result == ERR_OK) {
295 dhcp_option(dhcp, DHCP_OPTION_MAX_MSG_SIZE, DHCP_OPTION_MAX_MSG_SIZE_LEN);
296 dhcp_option_short(dhcp, DHCP_MAX_MSG_LEN(netif));
298 /* MUST request the offered IP address */
299 dhcp_option(dhcp, DHCP_OPTION_REQUESTED_IP, 4);
300 dhcp_option_long(dhcp, ntohl(ip4_addr_get_u32(&dhcp->offered_ip_addr)));
302 dhcp_option(dhcp, DHCP_OPTION_SERVER_ID, 4);
303 dhcp_option_long(dhcp, ntohl(ip4_addr_get_u32(&dhcp->server_ip_addr)));
305 dhcp_option(dhcp, DHCP_OPTION_PARAMETER_REQUEST_LIST, 4/*num options*/);
306 dhcp_option_byte(dhcp, DHCP_OPTION_SUBNET_MASK);
307 dhcp_option_byte(dhcp, DHCP_OPTION_ROUTER);
308 dhcp_option_byte(dhcp, DHCP_OPTION_BROADCAST);
309 dhcp_option_byte(dhcp, DHCP_OPTION_DNS_SERVER);
311 #if LWIP_NETIF_HOSTNAME
312 dhcp_option_hostname(dhcp, netif);
313 #endif /* LWIP_NETIF_HOSTNAME */
315 dhcp_option_trailer(dhcp);
316 /* shrink the pbuf to the actual content length */
317 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
319 /* send broadcast to any DHCP server */
320 udp_sendto_if(dhcp->pcb, dhcp->p_out, IP_ADDR_BROADCAST, DHCP_SERVER_PORT, netif);
321 dhcp_delete_msg(dhcp);
322 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_select: REQUESTING\n"));
324 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING, ("dhcp_select: could not allocate DHCP request\n"));
327 msecs = (dhcp->tries < 6 ? 1 << dhcp->tries : 60) * 1000;
328 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
329 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_select(): set request timeout %"U16_F" msecs\n", msecs));
334 * The DHCP timer that checks for lease renewal/rebind timeouts.
339 struct netif *netif = netif_list;
340 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_coarse_tmr()\n"));
341 /* iterate through all network interfaces */
342 while (netif != NULL) {
343 /* only act on DHCP configured interfaces */
344 if (netif->dhcp != NULL) {
345 /* timer is active (non zero), and triggers (zeroes) now? */
346 if (netif->dhcp->t2_timeout-- == 1) {
347 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_coarse_tmr(): t2 timeout\n"));
348 /* this clients' rebind timeout triggered */
349 dhcp_t2_timeout(netif);
350 /* timer is active (non zero), and triggers (zeroes) now */
351 } else if (netif->dhcp->t1_timeout-- == 1) {
352 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_coarse_tmr(): t1 timeout\n"));
353 /* this clients' renewal timeout triggered */
354 dhcp_t1_timeout(netif);
357 /* proceed to next netif */
363 * DHCP transaction timeout handling
365 * A DHCP server is expected to respond within a short period of time.
366 * This timer checks whether an outstanding DHCP request is timed out.
371 struct netif *netif = netif_list;
372 /* loop through netif's */
373 while (netif != NULL) {
374 /* only act on DHCP configured interfaces */
375 if (netif->dhcp != NULL) {
376 /* timer is active (non zero), and is about to trigger now */
377 if (netif->dhcp->request_timeout > 1) {
378 netif->dhcp->request_timeout--;
380 else if (netif->dhcp->request_timeout == 1) {
381 netif->dhcp->request_timeout--;
382 /* { netif->dhcp->request_timeout == 0 } */
383 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_fine_tmr(): request timeout\n"));
384 /* this client's request timeout triggered */
388 /* proceed to next network interface */
394 * A DHCP negotiation transaction, or ARP request, has timed out.
396 * The timer that was started with the DHCP or ARP request has
397 * timed out, indicating no response was received in time.
399 * @param netif the netif under DHCP control
402 dhcp_timeout(struct netif *netif)
404 struct dhcp *dhcp = netif->dhcp;
405 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_timeout()\n"));
406 /* back-off period has passed, or server selection timed out */
407 if ((dhcp->state == DHCP_BACKING_OFF) || (dhcp->state == DHCP_SELECTING)) {
408 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_timeout(): restarting discovery\n"));
409 dhcp_discover(netif);
410 /* receiving the requested lease timed out */
411 } else if (dhcp->state == DHCP_REQUESTING) {
412 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_timeout(): REQUESTING, DHCP request timed out\n"));
413 if (dhcp->tries <= 5) {
416 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_timeout(): REQUESTING, releasing, restarting\n"));
418 dhcp_discover(netif);
420 #if DHCP_DOES_ARP_CHECK
421 /* received no ARP reply for the offered address (which is good) */
422 } else if (dhcp->state == DHCP_CHECKING) {
423 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_timeout(): CHECKING, ARP request timed out\n"));
424 if (dhcp->tries <= 1) {
426 /* no ARP replies on the offered address,
427 looks like the IP address is indeed free */
429 /* bind the interface to the offered address */
432 #endif /* DHCP_DOES_ARP_CHECK */
434 /* did not get response to renew request? */
435 else if (dhcp->state == DHCP_RENEWING) {
436 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_timeout(): RENEWING, DHCP request timed out\n"));
437 /* just retry renewal */
438 /* note that the rebind timer will eventually time-out if renew does not work */
440 /* did not get response to rebind request? */
441 } else if (dhcp->state == DHCP_REBINDING) {
442 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_timeout(): REBINDING, DHCP request timed out\n"));
443 if (dhcp->tries <= 8) {
446 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_timeout(): RELEASING, DISCOVERING\n"));
448 dhcp_discover(netif);
450 } else if (dhcp->state == DHCP_REBOOTING) {
451 if (dhcp->tries < REBOOT_TRIES) {
454 dhcp_discover(netif);
460 * The renewal period has timed out.
462 * @param netif the netif under DHCP control
465 dhcp_t1_timeout(struct netif *netif)
467 struct dhcp *dhcp = netif->dhcp;
468 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_t1_timeout()\n"));
469 if ((dhcp->state == DHCP_REQUESTING) || (dhcp->state == DHCP_BOUND) ||
470 (dhcp->state == DHCP_RENEWING)) {
471 /* just retry to renew - note that the rebind timer (t2) will
472 * eventually time-out if renew tries fail. */
473 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
474 ("dhcp_t1_timeout(): must renew\n"));
475 /* This slightly different to RFC2131: DHCPREQUEST will be sent from state
476 DHCP_RENEWING, not DHCP_BOUND */
482 * The rebind period has timed out.
484 * @param netif the netif under DHCP control
487 dhcp_t2_timeout(struct netif *netif)
489 struct dhcp *dhcp = netif->dhcp;
490 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_t2_timeout()\n"));
491 if ((dhcp->state == DHCP_REQUESTING) || (dhcp->state == DHCP_BOUND) ||
492 (dhcp->state == DHCP_RENEWING)) {
493 /* just retry to rebind */
494 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE,
495 ("dhcp_t2_timeout(): must rebind\n"));
496 /* This slightly different to RFC2131: DHCPREQUEST will be sent from state
497 DHCP_REBINDING, not DHCP_BOUND */
503 * Handle a DHCP ACK packet
505 * @param netif the netif under DHCP control
508 dhcp_handle_ack(struct netif *netif)
510 struct dhcp *dhcp = netif->dhcp;
513 #endif /* LWIP_DNS */
515 /* clear options we might not get from the ACK */
516 ip_addr_set_zero(&dhcp->offered_sn_mask);
517 ip_addr_set_zero(&dhcp->offered_gw_addr);
518 #if LWIP_DHCP_BOOTP_FILE
519 ip_addr_set_zero(&dhcp->offered_si_addr);
520 #endif /* LWIP_DHCP_BOOTP_FILE */
522 /* lease time given? */
523 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_LEASE_TIME)) {
524 /* remember offered lease time */
525 dhcp->offered_t0_lease = dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_LEASE_TIME);
527 /* renewal period given? */
528 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_T1)) {
529 /* remember given renewal period */
530 dhcp->offered_t1_renew = dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_T1);
532 /* calculate safe periods for renewal */
533 dhcp->offered_t1_renew = dhcp->offered_t0_lease / 2;
536 /* renewal period given? */
537 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_T2)) {
538 /* remember given rebind period */
539 dhcp->offered_t2_rebind = dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_T2);
541 /* calculate safe periods for rebinding */
542 dhcp->offered_t2_rebind = dhcp->offered_t0_lease;
545 /* (y)our internet address */
546 ip_addr_copy(dhcp->offered_ip_addr, dhcp->msg_in->yiaddr);
548 #if LWIP_DHCP_BOOTP_FILE
549 /* copy boot server address,
550 boot file name copied in dhcp_parse_reply if not overloaded */
551 ip_addr_copy(dhcp->offered_si_addr, dhcp->msg_in->siaddr);
552 #endif /* LWIP_DHCP_BOOTP_FILE */
554 /* subnet mask given? */
555 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_SUBNET_MASK)) {
556 /* remember given subnet mask */
557 ip4_addr_set_u32(&dhcp->offered_sn_mask, htonl(dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_SUBNET_MASK)));
558 dhcp->subnet_mask_given = 1;
560 dhcp->subnet_mask_given = 0;
564 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_ROUTER)) {
565 ip4_addr_set_u32(&dhcp->offered_gw_addr, htonl(dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_ROUTER)));
571 while(dhcp_option_given(dhcp, DHCP_OPTION_IDX_DNS_SERVER + n) && (n < DNS_MAX_SERVERS)) {
573 ip4_addr_set_u32(&dns_addr, htonl(dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_DNS_SERVER + n)));
574 dns_setserver(n, &dns_addr);
577 #endif /* LWIP_DNS */
580 /** Set a statically allocated struct dhcp to work with.
581 * Using this prevents dhcp_start to allocate it using mem_malloc.
583 * @param netif the netif for which to set the struct dhcp
584 * @param dhcp (uninitialised) dhcp struct allocated by the application
587 dhcp_set_struct(struct netif *netif, struct dhcp *dhcp)
589 LWIP_ASSERT("netif != NULL", netif != NULL);
590 LWIP_ASSERT("dhcp != NULL", dhcp != NULL);
591 LWIP_ASSERT("netif already has a struct dhcp set", netif->dhcp == NULL);
593 /* clear data structure */
594 memset(dhcp, 0, sizeof(struct dhcp));
595 /* dhcp_set_state(&dhcp, DHCP_OFF); */
599 /** Removes a struct dhcp from a netif.
601 * ATTENTION: Only use this when not using dhcp_set_struct() to allocate the
602 * struct dhcp since the memory is passed back to the heap.
604 * @param netif the netif from which to remove the struct dhcp
606 void dhcp_cleanup(struct netif *netif)
608 LWIP_ASSERT("netif != NULL", netif != NULL);
610 if (netif->dhcp != NULL) {
611 mem_free(netif->dhcp);
617 * Start DHCP negotiation for a network interface.
619 * If no DHCP client instance was attached to this interface,
620 * a new client is created first. If a DHCP client instance
621 * was already present, it restarts negotiation.
623 * @param netif The lwIP network interface
624 * @return lwIP error code
625 * - ERR_OK - No error
626 * - ERR_MEM - Out of memory
629 dhcp_start(struct netif *netif)
632 err_t result = ERR_OK;
634 LWIP_ERROR("netif != NULL", (netif != NULL), return ERR_ARG;);
636 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_start(netif=%p) %c%c%"U16_F"\n", (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num));
637 /* Remove the flag that says this netif is handled by DHCP,
638 it is set when we succeeded starting. */
639 netif->flags &= ~NETIF_FLAG_DHCP;
641 /* check hwtype of the netif */
642 if ((netif->flags & NETIF_FLAG_ETHARP) == 0) {
643 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): No ETHARP netif\n"));
647 /* check MTU of the netif */
648 if (netif->mtu < DHCP_MAX_MSG_LEN_MIN_REQUIRED) {
649 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): Cannot use this netif with DHCP: MTU is too small\n"));
653 /* no DHCP client attached yet? */
655 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): starting new DHCP client\n"));
656 dhcp = (struct dhcp *)mem_malloc(sizeof(struct dhcp));
658 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): could not allocate dhcp\n"));
661 /* store this dhcp client in the netif */
663 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): allocated dhcp"));
664 /* already has DHCP client attached */
666 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_start(): restarting DHCP configuration\n"));
667 if (dhcp->pcb != NULL) {
668 udp_remove(dhcp->pcb);
670 LWIP_ASSERT("pbuf p_out wasn't freed", dhcp->p_out == NULL);
671 LWIP_ASSERT("reply wasn't freed", dhcp->msg_in == NULL );
674 /* clear data structure */
675 memset(dhcp, 0, sizeof(struct dhcp));
676 /* dhcp_set_state(&dhcp, DHCP_OFF); */
677 /* allocate UDP PCB */
678 dhcp->pcb = udp_new();
679 if (dhcp->pcb == NULL) {
680 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): could not obtain pcb\n"));
683 dhcp->pcb->so_options |= SOF_BROADCAST;
684 /* set up local and remote port for the pcb */
685 udp_bind(dhcp->pcb, IP_ADDR_ANY, DHCP_CLIENT_PORT);
686 udp_connect(dhcp->pcb, IP_ADDR_ANY, DHCP_SERVER_PORT);
687 /* set up the recv callback and argument */
688 udp_recv(dhcp->pcb, dhcp_recv, netif);
689 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_start(): starting DHCP configuration\n"));
690 /* (re)start the DHCP negotiation */
691 result = dhcp_discover(netif);
692 if (result != ERR_OK) {
693 /* free resources allocated above */
697 /* Set the flag that says this netif is handled by DHCP. */
698 netif->flags |= NETIF_FLAG_DHCP;
703 * Inform a DHCP server of our manual configuration.
705 * This informs DHCP servers of our fixed IP address configuration
706 * by sending an INFORM message. It does not involve DHCP address
707 * configuration, it is just here to be nice to the network.
709 * @param netif The lwIP network interface
712 dhcp_inform(struct netif *netif)
715 err_t result = ERR_OK;
718 LWIP_ERROR("netif != NULL", (netif != NULL), return;);
720 memset(&dhcp, 0, sizeof(struct dhcp));
721 dhcp_set_state(&dhcp, DHCP_INFORM);
723 if ((netif->dhcp != NULL) && (netif->dhcp->pcb != NULL)) {
724 /* re-use existing pcb */
725 pcb = netif->dhcp->pcb;
729 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_inform(): could not obtain pcb"));
733 dhcp.pcb->so_options |= SOF_BROADCAST;
734 udp_bind(dhcp.pcb, IP_ADDR_ANY, DHCP_CLIENT_PORT);
735 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_inform(): created new udp pcb\n"));
737 /* create and initialize the DHCP message header */
738 result = dhcp_create_msg(netif, &dhcp, DHCP_INFORM);
739 if (result == ERR_OK) {
740 dhcp_option(&dhcp, DHCP_OPTION_MAX_MSG_SIZE, DHCP_OPTION_MAX_MSG_SIZE_LEN);
741 dhcp_option_short(&dhcp, DHCP_MAX_MSG_LEN(netif));
743 dhcp_option_trailer(&dhcp);
745 pbuf_realloc(dhcp.p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp.options_out_len);
747 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_inform: INFORMING\n"));
748 udp_sendto_if(pcb, dhcp.p_out, IP_ADDR_BROADCAST, DHCP_SERVER_PORT, netif);
749 dhcp_delete_msg(&dhcp);
751 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_inform: could not allocate DHCP request\n"));
754 if (dhcp.pcb != NULL) {
755 /* otherwise, the existing pcb was used */
756 udp_remove(dhcp.pcb);
760 /** Handle a possible change in the network configuration.
762 * This enters the REBOOTING state to verify that the currently bound
763 * address is still valid.
766 dhcp_network_changed(struct netif *netif)
768 struct dhcp *dhcp = netif->dhcp;
771 switch (dhcp->state) {
776 netif_set_down(netif);
785 #if LWIP_DHCP_AUTOIP_COOP
786 if(dhcp->autoip_coop_state == DHCP_AUTOIP_COOP_STATE_ON) {
788 dhcp->autoip_coop_state = DHCP_AUTOIP_COOP_STATE_OFF;
790 #endif /* LWIP_DHCP_AUTOIP_COOP */
791 dhcp_discover(netif);
796 #if DHCP_DOES_ARP_CHECK
798 * Match an ARP reply with the offered IP address.
800 * @param netif the network interface on which the reply was received
801 * @param addr The IP address we received a reply from
803 void dhcp_arp_reply(struct netif *netif, ip_addr_t *addr)
805 LWIP_ERROR("netif != NULL", (netif != NULL), return;);
806 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_arp_reply()\n"));
807 /* is a DHCP client doing an ARP check? */
808 if ((netif->dhcp != NULL) && (netif->dhcp->state == DHCP_CHECKING)) {
809 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_arp_reply(): CHECKING, arp reply for 0x%08"X32_F"\n",
810 ip4_addr_get_u32(addr)));
811 /* did a host respond with the address we
812 were offered by the DHCP server? */
813 if (ip_addr_cmp(addr, &netif->dhcp->offered_ip_addr)) {
814 /* we will not accept the offered address */
815 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE | LWIP_DBG_LEVEL_WARNING,
816 ("dhcp_arp_reply(): arp reply matched with offered address, declining\n"));
823 * Decline an offered lease.
825 * Tell the DHCP server we do not accept the offered address.
826 * One reason to decline the lease is when we find out the address
827 * is already in use by another host (through ARP).
829 * @param netif the netif under DHCP control
832 dhcp_decline(struct netif *netif)
834 struct dhcp *dhcp = netif->dhcp;
835 err_t result = ERR_OK;
837 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_decline()\n"));
838 dhcp_set_state(dhcp, DHCP_BACKING_OFF);
839 /* create and initialize the DHCP message header */
840 result = dhcp_create_msg(netif, dhcp, DHCP_DECLINE);
841 if (result == ERR_OK) {
842 dhcp_option(dhcp, DHCP_OPTION_REQUESTED_IP, 4);
843 dhcp_option_long(dhcp, ntohl(ip4_addr_get_u32(&dhcp->offered_ip_addr)));
845 dhcp_option_trailer(dhcp);
846 /* resize pbuf to reflect true size of options */
847 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
849 /* per section 4.4.4, broadcast DECLINE messages */
850 udp_sendto_if(dhcp->pcb, dhcp->p_out, IP_ADDR_BROADCAST, DHCP_SERVER_PORT, netif);
851 dhcp_delete_msg(dhcp);
852 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_decline: BACKING OFF\n"));
854 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS,
855 ("dhcp_decline: could not allocate DHCP request\n"));
859 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
860 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_decline(): set request timeout %"U16_F" msecs\n", msecs));
863 #endif /* DHCP_DOES_ARP_CHECK */
867 * Start the DHCP process, discover a DHCP server.
869 * @param netif the netif under DHCP control
872 dhcp_discover(struct netif *netif)
874 struct dhcp *dhcp = netif->dhcp;
875 err_t result = ERR_OK;
877 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_discover()\n"));
878 ip_addr_set_any(&dhcp->offered_ip_addr);
879 dhcp_set_state(dhcp, DHCP_SELECTING);
880 /* create and initialize the DHCP message header */
881 result = dhcp_create_msg(netif, dhcp, DHCP_DISCOVER);
882 if (result == ERR_OK) {
883 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_discover: making request\n"));
885 dhcp_option(dhcp, DHCP_OPTION_MAX_MSG_SIZE, DHCP_OPTION_MAX_MSG_SIZE_LEN);
886 dhcp_option_short(dhcp, DHCP_MAX_MSG_LEN(netif));
888 dhcp_option(dhcp, DHCP_OPTION_PARAMETER_REQUEST_LIST, 4/*num options*/);
889 dhcp_option_byte(dhcp, DHCP_OPTION_SUBNET_MASK);
890 dhcp_option_byte(dhcp, DHCP_OPTION_ROUTER);
891 dhcp_option_byte(dhcp, DHCP_OPTION_BROADCAST);
892 dhcp_option_byte(dhcp, DHCP_OPTION_DNS_SERVER);
894 dhcp_option_trailer(dhcp);
896 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_discover: realloc()ing\n"));
897 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
899 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_discover: sendto(DISCOVER, IP_ADDR_BROADCAST, DHCP_SERVER_PORT)\n"));
900 udp_sendto_if(dhcp->pcb, dhcp->p_out, IP_ADDR_BROADCAST, DHCP_SERVER_PORT, netif);
901 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_discover: deleting()ing\n"));
902 dhcp_delete_msg(dhcp);
903 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_discover: SELECTING\n"));
905 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_discover: could not allocate DHCP request\n"));
908 #if LWIP_DHCP_AUTOIP_COOP
909 if(dhcp->tries >= LWIP_DHCP_AUTOIP_COOP_TRIES && dhcp->autoip_coop_state == DHCP_AUTOIP_COOP_STATE_OFF) {
910 dhcp->autoip_coop_state = DHCP_AUTOIP_COOP_STATE_ON;
913 #endif /* LWIP_DHCP_AUTOIP_COOP */
914 msecs = (dhcp->tries < 6 ? 1 << dhcp->tries : 60) * 1000;
915 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
916 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_discover(): set request timeout %"U16_F" msecs\n", msecs));
922 * Bind the interface to the offered IP address.
924 * @param netif network interface to bind to the offered address
927 dhcp_bind(struct netif *netif)
931 ip_addr_t sn_mask, gw_addr;
932 LWIP_ERROR("dhcp_bind: netif != NULL", (netif != NULL), return;);
934 LWIP_ERROR("dhcp_bind: dhcp != NULL", (dhcp != NULL), return;);
935 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_bind(netif=%p) %c%c%"U16_F"\n", (void*)netif, netif->name[0], netif->name[1], (u16_t)netif->num));
937 /* temporary DHCP lease? */
938 if (dhcp->offered_t1_renew != 0xffffffffUL) {
939 /* set renewal period timer */
940 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_bind(): t1 renewal timer %"U32_F" secs\n", dhcp->offered_t1_renew));
941 timeout = (dhcp->offered_t1_renew + DHCP_COARSE_TIMER_SECS / 2) / DHCP_COARSE_TIMER_SECS;
942 if(timeout > 0xffff) {
945 dhcp->t1_timeout = (u16_t)timeout;
946 if (dhcp->t1_timeout == 0) {
947 dhcp->t1_timeout = 1;
949 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_bind(): set request timeout %"U32_F" msecs\n", dhcp->offered_t1_renew*1000));
951 /* set renewal period timer */
952 if (dhcp->offered_t2_rebind != 0xffffffffUL) {
953 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_bind(): t2 rebind timer %"U32_F" secs\n", dhcp->offered_t2_rebind));
954 timeout = (dhcp->offered_t2_rebind + DHCP_COARSE_TIMER_SECS / 2) / DHCP_COARSE_TIMER_SECS;
955 if(timeout > 0xffff) {
958 dhcp->t2_timeout = (u16_t)timeout;
959 if (dhcp->t2_timeout == 0) {
960 dhcp->t2_timeout = 1;
962 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_bind(): set request timeout %"U32_F" msecs\n", dhcp->offered_t2_rebind*1000));
965 if (dhcp->subnet_mask_given) {
966 /* copy offered network mask */
967 ip_addr_copy(sn_mask, dhcp->offered_sn_mask);
969 /* subnet mask not given, choose a safe subnet mask given the network class */
970 u8_t first_octet = ip4_addr1(&dhcp->offered_ip_addr);
971 if (first_octet <= 127) {
972 ip4_addr_set_u32(&sn_mask, PP_HTONL(0xff000000UL));
973 } else if (first_octet >= 192) {
974 ip4_addr_set_u32(&sn_mask, PP_HTONL(0xffffff00UL));
976 ip4_addr_set_u32(&sn_mask, PP_HTONL(0xffff0000UL));
980 ip_addr_copy(gw_addr, dhcp->offered_gw_addr);
981 /* gateway address not given? */
982 if (ip_addr_isany(&gw_addr)) {
983 /* copy network address */
984 ip_addr_get_network(&gw_addr, &dhcp->offered_ip_addr, &sn_mask);
985 /* use first host address on network as gateway */
986 ip4_addr_set_u32(&gw_addr, ip4_addr_get_u32(&gw_addr) | PP_HTONL(0x00000001UL));
989 #if LWIP_DHCP_AUTOIP_COOP
990 if(dhcp->autoip_coop_state == DHCP_AUTOIP_COOP_STATE_ON) {
992 dhcp->autoip_coop_state = DHCP_AUTOIP_COOP_STATE_OFF;
994 #endif /* LWIP_DHCP_AUTOIP_COOP */
996 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_bind(): IP: 0x%08"X32_F"\n",
997 ip4_addr_get_u32(&dhcp->offered_ip_addr)));
998 netif_set_ipaddr(netif, &dhcp->offered_ip_addr);
999 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_bind(): SN: 0x%08"X32_F"\n",
1000 ip4_addr_get_u32(&sn_mask)));
1001 netif_set_netmask(netif, &sn_mask);
1002 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_STATE, ("dhcp_bind(): GW: 0x%08"X32_F"\n",
1003 ip4_addr_get_u32(&gw_addr)));
1004 netif_set_gw(netif, &gw_addr);
1005 /* bring the interface up */
1006 netif_set_up(netif);
1007 /* netif is now bound to DHCP leased address */
1008 dhcp_set_state(dhcp, DHCP_BOUND);
1012 * Renew an existing DHCP lease at the involved DHCP server.
1014 * @param netif network interface which must renew its lease
1017 dhcp_renew(struct netif *netif)
1019 struct dhcp *dhcp = netif->dhcp;
1022 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_renew()\n"));
1023 dhcp_set_state(dhcp, DHCP_RENEWING);
1025 /* create and initialize the DHCP message header */
1026 result = dhcp_create_msg(netif, dhcp, DHCP_REQUEST);
1027 if (result == ERR_OK) {
1028 dhcp_option(dhcp, DHCP_OPTION_MAX_MSG_SIZE, DHCP_OPTION_MAX_MSG_SIZE_LEN);
1029 dhcp_option_short(dhcp, DHCP_MAX_MSG_LEN(netif));
1031 #if LWIP_NETIF_HOSTNAME
1032 dhcp_option_hostname(dhcp, netif);
1033 #endif /* LWIP_NETIF_HOSTNAME */
1036 dhcp_option(dhcp, DHCP_OPTION_REQUESTED_IP, 4);
1037 dhcp_option_long(dhcp, ntohl(dhcp->offered_ip_addr.addr));
1041 dhcp_option(dhcp, DHCP_OPTION_SERVER_ID, 4);
1042 dhcp_option_long(dhcp, ntohl(dhcp->server_ip_addr.addr));
1044 /* append DHCP message trailer */
1045 dhcp_option_trailer(dhcp);
1047 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
1049 udp_sendto_if(dhcp->pcb, dhcp->p_out, &dhcp->server_ip_addr, DHCP_SERVER_PORT, netif);
1050 dhcp_delete_msg(dhcp);
1052 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_renew: RENEWING\n"));
1054 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_renew: could not allocate DHCP request\n"));
1057 /* back-off on retries, but to a maximum of 20 seconds */
1058 msecs = dhcp->tries < 10 ? dhcp->tries * 2000 : 20 * 1000;
1059 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
1060 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_renew(): set request timeout %"U16_F" msecs\n", msecs));
1065 * Rebind with a DHCP server for an existing DHCP lease.
1067 * @param netif network interface which must rebind with a DHCP server
1070 dhcp_rebind(struct netif *netif)
1072 struct dhcp *dhcp = netif->dhcp;
1075 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_rebind()\n"));
1076 dhcp_set_state(dhcp, DHCP_REBINDING);
1078 /* create and initialize the DHCP message header */
1079 result = dhcp_create_msg(netif, dhcp, DHCP_REQUEST);
1080 if (result == ERR_OK) {
1081 dhcp_option(dhcp, DHCP_OPTION_MAX_MSG_SIZE, DHCP_OPTION_MAX_MSG_SIZE_LEN);
1082 dhcp_option_short(dhcp, DHCP_MAX_MSG_LEN(netif));
1084 #if LWIP_NETIF_HOSTNAME
1085 dhcp_option_hostname(dhcp, netif);
1086 #endif /* LWIP_NETIF_HOSTNAME */
1089 dhcp_option(dhcp, DHCP_OPTION_REQUESTED_IP, 4);
1090 dhcp_option_long(dhcp, ntohl(dhcp->offered_ip_addr.addr));
1092 dhcp_option(dhcp, DHCP_OPTION_SERVER_ID, 4);
1093 dhcp_option_long(dhcp, ntohl(dhcp->server_ip_addr.addr));
1096 dhcp_option_trailer(dhcp);
1098 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
1100 /* broadcast to server */
1101 udp_sendto_if(dhcp->pcb, dhcp->p_out, IP_ADDR_BROADCAST, DHCP_SERVER_PORT, netif);
1102 dhcp_delete_msg(dhcp);
1103 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_rebind: REBINDING\n"));
1105 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_rebind: could not allocate DHCP request\n"));
1108 msecs = dhcp->tries < 10 ? dhcp->tries * 1000 : 10 * 1000;
1109 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
1110 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_rebind(): set request timeout %"U16_F" msecs\n", msecs));
1115 * Enter REBOOTING state to verify an existing lease
1117 * @param netif network interface which must reboot
1120 dhcp_reboot(struct netif *netif)
1122 struct dhcp *dhcp = netif->dhcp;
1125 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_reboot()\n"));
1126 dhcp_set_state(dhcp, DHCP_REBOOTING);
1128 /* create and initialize the DHCP message header */
1129 result = dhcp_create_msg(netif, dhcp, DHCP_REQUEST);
1130 if (result == ERR_OK) {
1131 dhcp_option(dhcp, DHCP_OPTION_MAX_MSG_SIZE, DHCP_OPTION_MAX_MSG_SIZE_LEN);
1132 dhcp_option_short(dhcp, 576);
1134 dhcp_option(dhcp, DHCP_OPTION_REQUESTED_IP, 4);
1135 dhcp_option_long(dhcp, ntohl(ip4_addr_get_u32(&dhcp->offered_ip_addr)));
1137 dhcp_option_trailer(dhcp);
1139 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
1141 /* broadcast to server */
1142 udp_sendto_if(dhcp->pcb, dhcp->p_out, IP_ADDR_BROADCAST, DHCP_SERVER_PORT, netif);
1143 dhcp_delete_msg(dhcp);
1144 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_reboot: REBOOTING\n"));
1146 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_reboot: could not allocate DHCP request\n"));
1149 msecs = dhcp->tries < 10 ? dhcp->tries * 1000 : 10 * 1000;
1150 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
1151 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_reboot(): set request timeout %"U16_F" msecs\n", msecs));
1157 * Release a DHCP lease.
1159 * @param netif network interface which must release its lease
1162 dhcp_release(struct netif *netif)
1164 struct dhcp *dhcp = netif->dhcp;
1167 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_release()\n"));
1169 /* idle DHCP client */
1170 dhcp_set_state(dhcp, DHCP_OFF);
1171 /* clean old DHCP offer */
1172 ip_addr_set_zero(&dhcp->server_ip_addr);
1173 ip_addr_set_zero(&dhcp->offered_ip_addr);
1174 ip_addr_set_zero(&dhcp->offered_sn_mask);
1175 ip_addr_set_zero(&dhcp->offered_gw_addr);
1176 #if LWIP_DHCP_BOOTP_FILE
1177 ip_addr_set_zero(&dhcp->offered_si_addr);
1178 #endif /* LWIP_DHCP_BOOTP_FILE */
1179 dhcp->offered_t0_lease = dhcp->offered_t1_renew = dhcp->offered_t2_rebind = 0;
1181 /* create and initialize the DHCP message header */
1182 result = dhcp_create_msg(netif, dhcp, DHCP_RELEASE);
1183 if (result == ERR_OK) {
1184 dhcp_option_trailer(dhcp);
1186 pbuf_realloc(dhcp->p_out, sizeof(struct dhcp_msg) - DHCP_OPTIONS_LEN + dhcp->options_out_len);
1188 udp_sendto_if(dhcp->pcb, dhcp->p_out, &dhcp->server_ip_addr, DHCP_SERVER_PORT, netif);
1189 dhcp_delete_msg(dhcp);
1190 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_release: RELEASED, DHCP_OFF\n"));
1192 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS, ("dhcp_release: could not allocate DHCP request\n"));
1195 msecs = dhcp->tries < 10 ? dhcp->tries * 1000 : 10 * 1000;
1196 dhcp->request_timeout = (msecs + DHCP_FINE_TIMER_MSECS - 1) / DHCP_FINE_TIMER_MSECS;
1197 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_STATE, ("dhcp_release(): set request timeout %"U16_F" msecs\n", msecs));
1198 /* bring the interface down */
1199 netif_set_down(netif);
1200 /* remove IP address from interface */
1201 netif_set_ipaddr(netif, IP_ADDR_ANY);
1202 netif_set_gw(netif, IP_ADDR_ANY);
1203 netif_set_netmask(netif, IP_ADDR_ANY);
1209 * Remove the DHCP client from the interface.
1211 * @param netif The network interface to stop DHCP on
1214 dhcp_stop(struct netif *netif)
1217 LWIP_ERROR("dhcp_stop: netif != NULL", (netif != NULL), return;);
1219 /* Remove the flag that says this netif is handled by DHCP. */
1220 netif->flags &= ~NETIF_FLAG_DHCP;
1222 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_stop()\n"));
1223 /* netif is DHCP configured? */
1225 #if LWIP_DHCP_AUTOIP_COOP
1226 if(dhcp->autoip_coop_state == DHCP_AUTOIP_COOP_STATE_ON) {
1228 dhcp->autoip_coop_state = DHCP_AUTOIP_COOP_STATE_OFF;
1230 #endif /* LWIP_DHCP_AUTOIP_COOP */
1232 if (dhcp->pcb != NULL) {
1233 udp_remove(dhcp->pcb);
1236 LWIP_ASSERT("reply wasn't freed", dhcp->msg_in == NULL);
1237 dhcp_set_state(dhcp, DHCP_OFF);
1242 * Set the DHCP state of a DHCP client.
1244 * If the state changed, reset the number of tries.
1247 dhcp_set_state(struct dhcp *dhcp, u8_t new_state)
1249 if (new_state != dhcp->state) {
1250 dhcp->state = new_state;
1252 dhcp->request_timeout = 0;
1257 * Concatenate an option type and length field to the outgoing
1262 dhcp_option(struct dhcp *dhcp, u8_t option_type, u8_t option_len)
1264 LWIP_ASSERT("dhcp_option: dhcp->options_out_len + 2 + option_len <= DHCP_OPTIONS_LEN", dhcp->options_out_len + 2U + option_len <= DHCP_OPTIONS_LEN);
1265 dhcp->msg_out->options[dhcp->options_out_len++] = option_type;
1266 dhcp->msg_out->options[dhcp->options_out_len++] = option_len;
1269 * Concatenate a single byte to the outgoing DHCP message.
1273 dhcp_option_byte(struct dhcp *dhcp, u8_t value)
1275 LWIP_ASSERT("dhcp_option_byte: dhcp->options_out_len < DHCP_OPTIONS_LEN", dhcp->options_out_len < DHCP_OPTIONS_LEN);
1276 dhcp->msg_out->options[dhcp->options_out_len++] = value;
1280 dhcp_option_short(struct dhcp *dhcp, u16_t value)
1282 LWIP_ASSERT("dhcp_option_short: dhcp->options_out_len + 2 <= DHCP_OPTIONS_LEN", dhcp->options_out_len + 2U <= DHCP_OPTIONS_LEN);
1283 dhcp->msg_out->options[dhcp->options_out_len++] = (u8_t)((value & 0xff00U) >> 8);
1284 dhcp->msg_out->options[dhcp->options_out_len++] = (u8_t) (value & 0x00ffU);
1288 dhcp_option_long(struct dhcp *dhcp, u32_t value)
1290 LWIP_ASSERT("dhcp_option_long: dhcp->options_out_len + 4 <= DHCP_OPTIONS_LEN", dhcp->options_out_len + 4U <= DHCP_OPTIONS_LEN);
1291 dhcp->msg_out->options[dhcp->options_out_len++] = (u8_t)((value & 0xff000000UL) >> 24);
1292 dhcp->msg_out->options[dhcp->options_out_len++] = (u8_t)((value & 0x00ff0000UL) >> 16);
1293 dhcp->msg_out->options[dhcp->options_out_len++] = (u8_t)((value & 0x0000ff00UL) >> 8);
1294 dhcp->msg_out->options[dhcp->options_out_len++] = (u8_t)((value & 0x000000ffUL));
1297 #if LWIP_NETIF_HOSTNAME
1299 dhcp_option_hostname(struct dhcp *dhcp, struct netif *netif)
1301 if (netif->hostname != NULL) {
1302 size_t namelen = strlen(netif->hostname);
1305 const char *p = netif->hostname;
1306 LWIP_ASSERT("DHCP: hostname is too long!", namelen <= 255);
1307 len = LWIP_MAX(namelen, 255);
1308 dhcp_option(dhcp, DHCP_OPTION_HOSTNAME, len);
1310 dhcp_option_byte(dhcp, *p++);
1315 #endif /* LWIP_NETIF_HOSTNAME */
1318 * Extract the DHCP message and the DHCP options.
1320 * Extract the DHCP message and the DHCP options, each into a contiguous
1321 * piece of memory. As a DHCP message is variable sized by its options,
1322 * and also allows overriding some fields for options, the easy approach
1323 * is to first unfold the options into a conitguous piece of memory, and
1324 * use that further on.
1328 dhcp_parse_reply(struct dhcp *dhcp, struct pbuf *p)
1334 u16_t options_idx_max;
1336 int parse_file_as_options = 0;
1337 int parse_sname_as_options = 0;
1339 /* clear received options */
1340 dhcp_clear_all_options(dhcp);
1341 /* check that beginning of dhcp_msg (up to and including chaddr) is in first pbuf */
1342 if (p->len < DHCP_SNAME_OFS) {
1345 dhcp->msg_in = (struct dhcp_msg *)p->payload;
1346 #if LWIP_DHCP_BOOTP_FILE
1347 /* clear boot file name */
1348 dhcp->boot_file_name[0] = 0;
1349 #endif /* LWIP_DHCP_BOOTP_FILE */
1353 /* start with options field */
1354 options_idx = DHCP_OPTIONS_OFS;
1355 /* parse options to the end of the received packet */
1356 options_idx_max = p->tot_len;
1359 while((q != NULL) && (options_idx >= q->len)) {
1360 options_idx -= q->len;
1361 options_idx_max -= q->len;
1367 offset = options_idx;
1368 offset_max = options_idx_max;
1369 options = (u8_t*)q->payload;
1370 /* at least 1 byte to read and no end marker, then at least 3 bytes to read? */
1371 while((q != NULL) && (options[offset] != DHCP_OPTION_END) && (offset < offset_max)) {
1372 u8_t op = options[offset];
1374 u8_t decode_len = 0;
1375 int decode_idx = -1;
1376 u16_t val_offset = offset + 2;
1377 /* len byte might be in the next pbuf */
1378 if (offset + 1 < q->len) {
1379 len = options[offset + 1];
1381 len = (q->next != NULL ? ((u8_t*)q->next->payload)[0] : 0);
1383 /* LWIP_DEBUGF(DHCP_DEBUG, ("msg_offset=%"U16_F", q->len=%"U16_F, msg_offset, q->len)); */
1386 /* case(DHCP_OPTION_END): handled above */
1387 case(DHCP_OPTION_PAD):
1388 /* special option: no len encoded */
1389 decode_len = len = 0;
1390 /* will be increased below */
1393 case(DHCP_OPTION_SUBNET_MASK):
1394 LWIP_ASSERT("len == 4", len == 4);
1395 decode_idx = DHCP_OPTION_IDX_SUBNET_MASK;
1397 case(DHCP_OPTION_ROUTER):
1398 decode_len = 4; /* only copy the first given router */
1399 LWIP_ASSERT("len >= decode_len", len >= decode_len);
1400 decode_idx = DHCP_OPTION_IDX_ROUTER;
1402 case(DHCP_OPTION_DNS_SERVER):
1403 /* special case: there might be more than one server */
1404 LWIP_ASSERT("len % 4 == 0", len % 4 == 0);
1405 /* limit number of DNS servers */
1406 decode_len = LWIP_MIN(len, 4 * DNS_MAX_SERVERS);
1407 LWIP_ASSERT("len >= decode_len", len >= decode_len);
1408 decode_idx = DHCP_OPTION_IDX_DNS_SERVER;
1410 case(DHCP_OPTION_LEASE_TIME):
1411 LWIP_ASSERT("len == 4", len == 4);
1412 decode_idx = DHCP_OPTION_IDX_LEASE_TIME;
1414 case(DHCP_OPTION_OVERLOAD):
1415 LWIP_ASSERT("len == 1", len == 1);
1416 decode_idx = DHCP_OPTION_IDX_OVERLOAD;
1418 case(DHCP_OPTION_MESSAGE_TYPE):
1419 LWIP_ASSERT("len == 1", len == 1);
1420 decode_idx = DHCP_OPTION_IDX_MSG_TYPE;
1422 case(DHCP_OPTION_SERVER_ID):
1423 LWIP_ASSERT("len == 4", len == 4);
1424 decode_idx = DHCP_OPTION_IDX_SERVER_ID;
1426 case(DHCP_OPTION_T1):
1427 LWIP_ASSERT("len == 4", len == 4);
1428 decode_idx = DHCP_OPTION_IDX_T1;
1430 case(DHCP_OPTION_T2):
1431 LWIP_ASSERT("len == 4", len == 4);
1432 decode_idx = DHCP_OPTION_IDX_T2;
1436 LWIP_DEBUGF(DHCP_DEBUG, ("skipping option %"U16_F" in options\n", op));
1440 if (decode_len > 0) {
1444 LWIP_ASSERT("check decode_idx", decode_idx >= 0 && decode_idx < DHCP_OPTION_IDX_MAX);
1445 LWIP_ASSERT("option already decoded", !dhcp_option_given(dhcp, decode_idx));
1446 copy_len = LWIP_MIN(decode_len, 4);
1447 pbuf_copy_partial(q, &value, copy_len, val_offset);
1448 if (decode_len > 4) {
1449 /* decode more than one u32_t */
1450 LWIP_ASSERT("decode_len % 4 == 0", decode_len % 4 == 0);
1451 dhcp_got_option(dhcp, decode_idx);
1452 dhcp_set_option_value(dhcp, decode_idx, htonl(value));
1457 } else if (decode_len == 4) {
1458 value = ntohl(value);
1460 LWIP_ASSERT("invalid decode_len", decode_len == 1);
1461 value = ((u8_t*)&value)[0];
1463 dhcp_got_option(dhcp, decode_idx);
1464 dhcp_set_option_value(dhcp, decode_idx, value);
1466 if (offset >= q->len) {
1468 offset_max -= q->len;
1470 options = (u8_t*)q->payload;
1473 /* is this an overloaded message? */
1474 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_OVERLOAD)) {
1475 u32_t overload = dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_OVERLOAD);
1476 dhcp_clear_option(dhcp, DHCP_OPTION_IDX_OVERLOAD);
1477 if (overload == DHCP_OVERLOAD_FILE) {
1478 parse_file_as_options = 1;
1479 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("overloaded file field\n"));
1480 } else if (overload == DHCP_OVERLOAD_SNAME) {
1481 parse_sname_as_options = 1;
1482 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("overloaded sname field\n"));
1483 } else if (overload == DHCP_OVERLOAD_SNAME_FILE) {
1484 parse_sname_as_options = 1;
1485 parse_file_as_options = 1;
1486 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("overloaded sname and file field\n"));
1488 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("invalid overload option: %d\n", (int)overload));
1490 #if LWIP_DHCP_BOOTP_FILE
1491 if (!parse_file_as_options) {
1492 /* only do this for ACK messages */
1493 if (dhcp_option_given(dhcp, DHCP_OPTION_IDX_MSG_TYPE) &&
1494 (dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_MSG_TYPE) == DHCP_ACK))
1495 /* copy bootp file name, don't care for sname (server hostname) */
1496 pbuf_copy_partial(p, dhcp->boot_file_name, DHCP_FILE_LEN-1, DHCP_FILE_OFS);
1497 /* make sure the string is really NULL-terminated */
1498 dhcp->boot_file_name[DHCP_FILE_LEN-1] = 0;
1500 #endif /* LWIP_DHCP_BOOTP_FILE */
1502 if (parse_file_as_options) {
1503 /* if both are overloaded, parse file first and then sname (RFC 2131 ch. 4.1) */
1504 parse_file_as_options = 0;
1505 options_idx = DHCP_FILE_OFS;
1506 options_idx_max = DHCP_FILE_OFS + DHCP_FILE_LEN;
1508 } else if (parse_sname_as_options) {
1509 parse_sname_as_options = 0;
1510 options_idx = DHCP_SNAME_OFS;
1511 options_idx_max = DHCP_SNAME_OFS + DHCP_SNAME_LEN;
1518 * If an incoming DHCP message is in response to us, then trigger the state machine
1521 dhcp_recv(void *arg, struct udp_pcb *pcb, struct pbuf *p, ip_addr_t *addr, u16_t port)
1523 struct netif *netif = (struct netif *)arg;
1524 struct dhcp *dhcp = netif->dhcp;
1525 struct dhcp_msg *reply_msg = (struct dhcp_msg *)p->payload;
1528 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("dhcp_recv(pbuf = %p) from DHCP server %"U16_F".%"U16_F".%"U16_F".%"U16_F" port %"U16_F"\n", (void*)p,
1529 ip4_addr1_16(addr), ip4_addr2_16(addr), ip4_addr3_16(addr), ip4_addr4_16(addr), port));
1530 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("pbuf->len = %"U16_F"\n", p->len));
1531 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("pbuf->tot_len = %"U16_F"\n", p->tot_len));
1532 /* prevent warnings about unused arguments */
1533 LWIP_UNUSED_ARG(pcb);
1534 LWIP_UNUSED_ARG(addr);
1535 LWIP_UNUSED_ARG(port);
1537 LWIP_ASSERT("reply wasn't freed", dhcp->msg_in == NULL);
1539 if (p->len < DHCP_MIN_REPLY_LEN) {
1540 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING, ("DHCP reply message or pbuf too short\n"));
1541 goto free_pbuf_and_return;
1544 if (reply_msg->op != DHCP_BOOTREPLY) {
1545 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING, ("not a DHCP reply message, but type %"U16_F"\n", (u16_t)reply_msg->op));
1546 goto free_pbuf_and_return;
1548 /* iterate through hardware address and match against DHCP message */
1549 for (i = 0; i < netif->hwaddr_len; i++) {
1550 if (netif->hwaddr[i] != reply_msg->chaddr[i]) {
1551 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING,
1552 ("netif->hwaddr[%"U16_F"]==%02"X16_F" != reply_msg->chaddr[%"U16_F"]==%02"X16_F"\n",
1553 (u16_t)i, (u16_t)netif->hwaddr[i], (u16_t)i, (u16_t)reply_msg->chaddr[i]));
1554 goto free_pbuf_and_return;
1557 /* match transaction ID against what we expected */
1558 if (ntohl(reply_msg->xid) != dhcp->xid) {
1559 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING,
1560 ("transaction id mismatch reply_msg->xid(%"X32_F")!=dhcp->xid(%"X32_F")\n",ntohl(reply_msg->xid),dhcp->xid));
1561 goto free_pbuf_and_return;
1563 /* option fields could be unfold? */
1564 if (dhcp_parse_reply(dhcp, p) != ERR_OK) {
1565 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS,
1566 ("problem unfolding DHCP message - too short on memory?\n"));
1567 goto free_pbuf_and_return;
1570 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("searching DHCP_OPTION_MESSAGE_TYPE\n"));
1571 /* obtain pointer to DHCP message type */
1572 if (!dhcp_option_given(dhcp, DHCP_OPTION_IDX_MSG_TYPE)) {
1573 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_WARNING, ("DHCP_OPTION_MESSAGE_TYPE option not found\n"));
1574 goto free_pbuf_and_return;
1577 /* read DHCP message type */
1578 msg_type = (u8_t)dhcp_get_option_value(dhcp, DHCP_OPTION_IDX_MSG_TYPE);
1579 /* message type is DHCP ACK? */
1580 if (msg_type == DHCP_ACK) {
1581 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("DHCP_ACK received\n"));
1582 /* in requesting state? */
1583 if (dhcp->state == DHCP_REQUESTING) {
1584 dhcp_handle_ack(netif);
1585 #if DHCP_DOES_ARP_CHECK
1586 /* check if the acknowledged lease address is already in use */
1589 /* bind interface to the acknowledged lease address */
1593 /* already bound to the given lease address? */
1594 else if ((dhcp->state == DHCP_REBOOTING) || (dhcp->state == DHCP_REBINDING) || (dhcp->state == DHCP_RENEWING)) {
1598 /* received a DHCP_NAK in appropriate state? */
1599 else if ((msg_type == DHCP_NAK) &&
1600 ((dhcp->state == DHCP_REBOOTING) || (dhcp->state == DHCP_REQUESTING) ||
1601 (dhcp->state == DHCP_REBINDING) || (dhcp->state == DHCP_RENEWING ))) {
1602 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("DHCP_NAK received\n"));
1603 dhcp_handle_nak(netif);
1605 /* received a DHCP_OFFER in DHCP_SELECTING state? */
1606 else if ((msg_type == DHCP_OFFER) && (dhcp->state == DHCP_SELECTING)) {
1607 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE, ("DHCP_OFFER received in DHCP_SELECTING state\n"));
1608 dhcp->request_timeout = 0;
1609 /* remember offered lease */
1610 dhcp_handle_offer(netif);
1612 free_pbuf_and_return:
1613 dhcp->msg_in = NULL;
1618 * Create a DHCP request, fill in common headers
1620 * @param netif the netif under DHCP control
1621 * @param dhcp dhcp control struct
1622 * @param message_type message type of the request
1625 dhcp_create_msg(struct netif *netif, struct dhcp *dhcp, u8_t message_type)
1628 #ifndef DHCP_GLOBAL_XID
1629 /** default global transaction identifier starting value (easy to match
1630 * with a packet analyser). We simply increment for each new request.
1631 * Predefine DHCP_GLOBAL_XID to a better value or a function call to generate one
1632 * at runtime, any supporting function prototypes can be defined in DHCP_GLOBAL_XID_HEADER */
1633 #if DHCP_CREATE_RAND_XID && defined(LWIP_RAND)
1635 #else /* DHCP_CREATE_RAND_XID && defined(LWIP_RAND) */
1636 static u32_t xid = 0xABCD0000;
1637 #endif /* DHCP_CREATE_RAND_XID && defined(LWIP_RAND) */
1639 if (!xid_initialised) {
1640 xid = DHCP_GLOBAL_XID;
1641 xid_initialised = !xid_initialised;
1644 LWIP_ERROR("dhcp_create_msg: netif != NULL", (netif != NULL), return ERR_ARG;);
1645 LWIP_ERROR("dhcp_create_msg: dhcp != NULL", (dhcp != NULL), return ERR_VAL;);
1646 LWIP_ASSERT("dhcp_create_msg: dhcp->p_out == NULL", dhcp->p_out == NULL);
1647 LWIP_ASSERT("dhcp_create_msg: dhcp->msg_out == NULL", dhcp->msg_out == NULL);
1648 dhcp->p_out = pbuf_alloc(PBUF_TRANSPORT, sizeof(struct dhcp_msg), PBUF_RAM);
1649 if (dhcp->p_out == NULL) {
1650 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE | LWIP_DBG_LEVEL_SERIOUS,
1651 ("dhcp_create_msg(): could not allocate pbuf\n"));
1654 LWIP_ASSERT("dhcp_create_msg: check that first pbuf can hold struct dhcp_msg",
1655 (dhcp->p_out->len >= sizeof(struct dhcp_msg)));
1657 /* reuse transaction identifier in retransmissions */
1658 if (dhcp->tries == 0) {
1659 #if DHCP_CREATE_RAND_XID && defined(LWIP_RAND)
1661 #else /* DHCP_CREATE_RAND_XID && defined(LWIP_RAND) */
1663 #endif /* DHCP_CREATE_RAND_XID && defined(LWIP_RAND) */
1666 LWIP_DEBUGF(DHCP_DEBUG | LWIP_DBG_TRACE,
1667 ("transaction id xid(%"X32_F")\n", xid));
1669 dhcp->msg_out = (struct dhcp_msg *)dhcp->p_out->payload;
1671 dhcp->msg_out->op = DHCP_BOOTREQUEST;
1672 /* TODO: make link layer independent */
1673 dhcp->msg_out->htype = DHCP_HTYPE_ETH;
1674 dhcp->msg_out->hlen = netif->hwaddr_len;
1675 dhcp->msg_out->hops = 0;
1676 dhcp->msg_out->xid = htonl(dhcp->xid);
1677 dhcp->msg_out->secs = 0;
1678 /* we don't need the broadcast flag since we can receive unicast traffic
1679 before being fully configured! */
1680 dhcp->msg_out->flags = 0;
1681 ip_addr_set_zero(&dhcp->msg_out->ciaddr);
1682 /* set ciaddr to netif->ip_addr based on message_type and state */
1683 if ((message_type == DHCP_INFORM) || (message_type == DHCP_DECLINE) ||
1684 ((message_type == DHCP_REQUEST) && /* DHCP_BOUND not used for sending! */
1685 ((dhcp->state==DHCP_RENEWING) || dhcp->state==DHCP_REBINDING))) {
1686 ip_addr_copy(dhcp->msg_out->ciaddr, netif->ip_addr);
1688 ip_addr_set_zero(&dhcp->msg_out->yiaddr);
1689 ip_addr_set_zero(&dhcp->msg_out->siaddr);
1690 ip_addr_set_zero(&dhcp->msg_out->giaddr);
1691 for (i = 0; i < DHCP_CHADDR_LEN; i++) {
1692 /* copy netif hardware address, pad with zeroes */
1693 dhcp->msg_out->chaddr[i] = (i < netif->hwaddr_len) ? netif->hwaddr[i] : 0/* pad byte*/;
1695 for (i = 0; i < DHCP_SNAME_LEN; i++) {
1696 dhcp->msg_out->sname[i] = 0;
1698 for (i = 0; i < DHCP_FILE_LEN; i++) {
1699 dhcp->msg_out->file[i] = 0;
1701 dhcp->msg_out->cookie = PP_HTONL(DHCP_MAGIC_COOKIE);
1702 dhcp->options_out_len = 0;
1703 /* fill options field with an incrementing array (for debugging purposes) */
1704 for (i = 0; i < DHCP_OPTIONS_LEN; i++) {
1705 dhcp->msg_out->options[i] = (u8_t)i; /* for debugging only, no matter if truncated */
1707 /* Add option MESSAGE_TYPE */
1708 dhcp_option(dhcp, DHCP_OPTION_MESSAGE_TYPE, DHCP_OPTION_MESSAGE_TYPE_LEN);
1709 dhcp_option_byte(dhcp, message_type);
1714 * Free previously allocated memory used to send a DHCP request.
1716 * @param dhcp the dhcp struct to free the request from
1719 dhcp_delete_msg(struct dhcp *dhcp)
1721 LWIP_ERROR("dhcp_delete_msg: dhcp != NULL", (dhcp != NULL), return;);
1722 LWIP_ASSERT("dhcp_delete_msg: dhcp->p_out != NULL", dhcp->p_out != NULL);
1723 LWIP_ASSERT("dhcp_delete_msg: dhcp->msg_out != NULL", dhcp->msg_out != NULL);
1724 if (dhcp->p_out != NULL) {
1725 pbuf_free(dhcp->p_out);
1728 dhcp->msg_out = NULL;
1732 * Add a DHCP message trailer
1734 * Adds the END option to the DHCP message, and if
1735 * necessary, up to three padding bytes.
1737 * @param dhcp DHCP state structure
1740 dhcp_option_trailer(struct dhcp *dhcp)
1742 LWIP_ERROR("dhcp_option_trailer: dhcp != NULL", (dhcp != NULL), return;);
1743 LWIP_ASSERT("dhcp_option_trailer: dhcp->msg_out != NULL\n", dhcp->msg_out != NULL);
1744 LWIP_ASSERT("dhcp_option_trailer: dhcp->options_out_len < DHCP_OPTIONS_LEN\n", dhcp->options_out_len < DHCP_OPTIONS_LEN);
1745 dhcp->msg_out->options[dhcp->options_out_len++] = DHCP_OPTION_END;
1746 /* packet is too small, or not 4 byte aligned? */
1747 while ((dhcp->options_out_len < DHCP_MIN_OPTIONS_LEN) || (dhcp->options_out_len & 3)) {
1748 /* LWIP_DEBUGF(DHCP_DEBUG,("dhcp_option_trailer:dhcp->options_out_len=%"U16_F", DHCP_OPTIONS_LEN=%"U16_F, dhcp->options_out_len, DHCP_OPTIONS_LEN)); */
1749 LWIP_ASSERT("dhcp_option_trailer: dhcp->options_out_len < DHCP_OPTIONS_LEN\n", dhcp->options_out_len < DHCP_OPTIONS_LEN);
1750 /* add a fill/padding byte */
1751 dhcp->msg_out->options[dhcp->options_out_len++] = 0;
1755 #endif /* LWIP_DHCP */