xref: /openbmc/u-boot/net/bootp.c (revision 173f023f)
1 /*
2  *	Based on LiMon - BOOTP.
3  *
4  *	Copyright 1994, 1995, 2000 Neil Russell.
5  *	(See License)
6  *	Copyright 2000 Roland Borde
7  *	Copyright 2000 Paolo Scaffardi
8  *	Copyright 2000-2004 Wolfgang Denk, wd@denx.de
9  */
10 
11 #include <common.h>
12 #include <command.h>
13 #include <efi_loader.h>
14 #include <net.h>
15 #include <net/tftp.h>
16 #include "bootp.h"
17 #ifdef CONFIG_LED_STATUS
18 #include <status_led.h>
19 #endif
20 #ifdef CONFIG_BOOTP_RANDOM_DELAY
21 #include "net_rand.h"
22 #endif
23 
24 #define BOOTP_VENDOR_MAGIC	0x63825363	/* RFC1048 Magic Cookie */
25 
26 /*
27  * The timeout for the initial BOOTP/DHCP request used to be described by a
28  * counter of fixed-length timeout periods. TIMEOUT_COUNT represents
29  * that counter
30  *
31  * Now that the timeout periods are variable (exponential backoff and retry)
32  * we convert the timeout count to the absolute time it would have take to
33  * execute that many retries, and keep sending retry packets until that time
34  * is reached.
35  */
36 #ifndef CONFIG_NET_RETRY_COUNT
37 # define TIMEOUT_COUNT	5		/* # of timeouts before giving up */
38 #else
39 # define TIMEOUT_COUNT	(CONFIG_NET_RETRY_COUNT)
40 #endif
41 #define TIMEOUT_MS	((3 + (TIMEOUT_COUNT * 5)) * 1000)
42 
43 #define PORT_BOOTPS	67		/* BOOTP server UDP port */
44 #define PORT_BOOTPC	68		/* BOOTP client UDP port */
45 
46 #ifndef CONFIG_DHCP_MIN_EXT_LEN		/* minimal length of extension list */
47 #define CONFIG_DHCP_MIN_EXT_LEN 64
48 #endif
49 
50 #ifndef CONFIG_BOOTP_ID_CACHE_SIZE
51 #define CONFIG_BOOTP_ID_CACHE_SIZE 4
52 #endif
53 
54 u32		bootp_ids[CONFIG_BOOTP_ID_CACHE_SIZE];
55 unsigned int	bootp_num_ids;
56 int		bootp_try;
57 ulong		bootp_start;
58 ulong		bootp_timeout;
59 char net_nis_domain[32] = {0,}; /* Our NIS domain */
60 char net_hostname[32] = {0,}; /* Our hostname */
61 char net_root_path[64] = {0,}; /* Our bootpath */
62 
63 static ulong time_taken_max;
64 
65 #if defined(CONFIG_CMD_DHCP)
66 static dhcp_state_t dhcp_state = INIT;
67 static u32 dhcp_leasetime;
68 static struct in_addr dhcp_server_ip;
69 static u8 dhcp_option_overload;
70 #define OVERLOAD_FILE 1
71 #define OVERLOAD_SNAME 2
72 static void dhcp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
73 			unsigned src, unsigned len);
74 
75 /* For Debug */
76 #if 0
77 static char *dhcpmsg2str(int type)
78 {
79 	switch (type) {
80 	case 1:	 return "DHCPDISCOVER"; break;
81 	case 2:	 return "DHCPOFFER";	break;
82 	case 3:	 return "DHCPREQUEST";	break;
83 	case 4:	 return "DHCPDECLINE";	break;
84 	case 5:	 return "DHCPACK";	break;
85 	case 6:	 return "DHCPNACK";	break;
86 	case 7:	 return "DHCPRELEASE";	break;
87 	default: return "UNKNOWN/INVALID MSG TYPE"; break;
88 	}
89 }
90 #endif
91 #endif
92 
93 static void bootp_add_id(ulong id)
94 {
95 	if (bootp_num_ids >= ARRAY_SIZE(bootp_ids)) {
96 		size_t size = sizeof(bootp_ids) - sizeof(id);
97 
98 		memmove(bootp_ids, &bootp_ids[1], size);
99 		bootp_ids[bootp_num_ids - 1] = id;
100 	} else {
101 		bootp_ids[bootp_num_ids] = id;
102 		bootp_num_ids++;
103 	}
104 }
105 
106 static bool bootp_match_id(ulong id)
107 {
108 	unsigned int i;
109 
110 	for (i = 0; i < bootp_num_ids; i++)
111 		if (bootp_ids[i] == id)
112 			return true;
113 
114 	return false;
115 }
116 
117 static int check_reply_packet(uchar *pkt, unsigned dest, unsigned src,
118 			      unsigned len)
119 {
120 	struct bootp_hdr *bp = (struct bootp_hdr *)pkt;
121 	int retval = 0;
122 
123 	if (dest != PORT_BOOTPC || src != PORT_BOOTPS)
124 		retval = -1;
125 	else if (len < sizeof(struct bootp_hdr) - OPT_FIELD_SIZE)
126 		retval = -2;
127 	else if (bp->bp_op != OP_BOOTREPLY)
128 		retval = -3;
129 	else if (bp->bp_htype != HWT_ETHER)
130 		retval = -4;
131 	else if (bp->bp_hlen != HWL_ETHER)
132 		retval = -5;
133 	else if (!bootp_match_id(net_read_u32(&bp->bp_id)))
134 		retval = -6;
135 	else if (memcmp(bp->bp_chaddr, net_ethaddr, HWL_ETHER) != 0)
136 		retval = -7;
137 
138 	debug("Filtering pkt = %d\n", retval);
139 
140 	return retval;
141 }
142 
143 /*
144  * Copy parameters of interest from BOOTP_REPLY/DHCP_OFFER packet
145  */
146 static void store_net_params(struct bootp_hdr *bp)
147 {
148 #if !defined(CONFIG_BOOTP_SERVERIP)
149 	struct in_addr tmp_ip;
150 
151 	net_copy_ip(&tmp_ip, &bp->bp_siaddr);
152 	if (tmp_ip.s_addr != 0)
153 		net_copy_ip(&net_server_ip, &bp->bp_siaddr);
154 	memcpy(net_server_ethaddr,
155 	       ((struct ethernet_hdr *)net_rx_packet)->et_src, 6);
156 	if (
157 #if defined(CONFIG_CMD_DHCP)
158 	    !(dhcp_option_overload & OVERLOAD_FILE) &&
159 #endif
160 	    (strlen(bp->bp_file) > 0)) {
161 		copy_filename(net_boot_file_name, bp->bp_file,
162 			      sizeof(net_boot_file_name));
163 	}
164 
165 	debug("net_boot_file_name: %s\n", net_boot_file_name);
166 
167 	/* Propagate to environment:
168 	 * don't delete exising entry when BOOTP / DHCP reply does
169 	 * not contain a new value
170 	 */
171 	if (*net_boot_file_name)
172 		env_set("bootfile", net_boot_file_name);
173 #endif
174 	net_copy_ip(&net_ip, &bp->bp_yiaddr);
175 }
176 
177 static int truncate_sz(const char *name, int maxlen, int curlen)
178 {
179 	if (curlen >= maxlen) {
180 		printf("*** WARNING: %s is too long (%d - max: %d)"
181 			" - truncated\n", name, curlen, maxlen);
182 		curlen = maxlen - 1;
183 	}
184 	return curlen;
185 }
186 
187 #if !defined(CONFIG_CMD_DHCP)
188 
189 static void bootp_process_vendor_field(u8 *ext)
190 {
191 	int size = *(ext + 1);
192 
193 	debug("[BOOTP] Processing extension %d... (%d bytes)\n", *ext,
194 	      *(ext + 1));
195 
196 	net_boot_file_expected_size_in_blocks = 0;
197 
198 	switch (*ext) {
199 		/* Fixed length fields */
200 	case 1:			/* Subnet mask */
201 		if (net_netmask.s_addr == 0)
202 			net_copy_ip(&net_netmask, (struct in_addr *)(ext + 2));
203 		break;
204 	case 2:			/* Time offset - Not yet supported */
205 		break;
206 		/* Variable length fields */
207 	case 3:			/* Gateways list */
208 		if (net_gateway.s_addr == 0)
209 			net_copy_ip(&net_gateway, (struct in_addr *)(ext + 2));
210 		break;
211 	case 4:			/* Time server - Not yet supported */
212 		break;
213 	case 5:			/* IEN-116 name server - Not yet supported */
214 		break;
215 	case 6:
216 		if (net_dns_server.s_addr == 0)
217 			net_copy_ip(&net_dns_server,
218 				    (struct in_addr *)(ext + 2));
219 #if defined(CONFIG_BOOTP_DNS2)
220 		if ((net_dns_server2.s_addr == 0) && (size > 4))
221 			net_copy_ip(&net_dns_server2,
222 				    (struct in_addr *)(ext + 2 + 4));
223 #endif
224 		break;
225 	case 7:			/* Log server - Not yet supported */
226 		break;
227 	case 8:			/* Cookie/Quote server - Not yet supported */
228 		break;
229 	case 9:			/* LPR server - Not yet supported */
230 		break;
231 	case 10:		/* Impress server - Not yet supported */
232 		break;
233 	case 11:		/* RPL server - Not yet supported */
234 		break;
235 	case 12:		/* Host name */
236 		if (net_hostname[0] == 0) {
237 			size = truncate_sz("Host Name",
238 				sizeof(net_hostname), size);
239 			memcpy(&net_hostname, ext + 2, size);
240 			net_hostname[size] = 0;
241 		}
242 		break;
243 	case 13:		/* Boot file size */
244 		if (size == 2)
245 			net_boot_file_expected_size_in_blocks =
246 				ntohs(*(ushort *)(ext + 2));
247 		else if (size == 4)
248 			net_boot_file_expected_size_in_blocks =
249 				ntohl(*(ulong *)(ext + 2));
250 		break;
251 	case 14:		/* Merit dump file - Not yet supported */
252 		break;
253 	case 15:		/* Domain name - Not yet supported */
254 		break;
255 	case 16:		/* Swap server - Not yet supported */
256 		break;
257 	case 17:		/* Root path */
258 		if (net_root_path[0] == 0) {
259 			size = truncate_sz("Root Path",
260 				sizeof(net_root_path), size);
261 			memcpy(&net_root_path, ext + 2, size);
262 			net_root_path[size] = 0;
263 		}
264 		break;
265 	case 18:		/* Extension path - Not yet supported */
266 		/*
267 		 * This can be used to send the information of the
268 		 * vendor area in another file that the client can
269 		 * access via TFTP.
270 		 */
271 		break;
272 		/* IP host layer fields */
273 	case 40:		/* NIS Domain name */
274 		if (net_nis_domain[0] == 0) {
275 			size = truncate_sz("NIS Domain Name",
276 				sizeof(net_nis_domain), size);
277 			memcpy(&net_nis_domain, ext + 2, size);
278 			net_nis_domain[size] = 0;
279 		}
280 		break;
281 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_NTPSERVER)
282 	case 42:	/* NTP server IP */
283 		net_copy_ip(&net_ntp_server, (struct in_addr *)(ext + 2));
284 		break;
285 #endif
286 		/* Application layer fields */
287 	case 43:		/* Vendor specific info - Not yet supported */
288 		/*
289 		 * Binary information to exchange specific
290 		 * product information.
291 		 */
292 		break;
293 		/* Reserved (custom) fields (128..254) */
294 	}
295 }
296 
297 static void bootp_process_vendor(u8 *ext, int size)
298 {
299 	u8 *end = ext + size;
300 
301 	debug("[BOOTP] Checking extension (%d bytes)...\n", size);
302 
303 	while ((ext < end) && (*ext != 0xff)) {
304 		if (*ext == 0) {
305 			ext++;
306 		} else {
307 			u8 *opt = ext;
308 
309 			ext += ext[1] + 2;
310 			if (ext <= end)
311 				bootp_process_vendor_field(opt);
312 		}
313 	}
314 
315 	debug("[BOOTP] Received fields:\n");
316 	if (net_netmask.s_addr)
317 		debug("net_netmask : %pI4\n", &net_netmask);
318 
319 	if (net_gateway.s_addr)
320 		debug("net_gateway	: %pI4", &net_gateway);
321 
322 	if (net_boot_file_expected_size_in_blocks)
323 		debug("net_boot_file_expected_size_in_blocks : %d\n",
324 		      net_boot_file_expected_size_in_blocks);
325 
326 	if (net_hostname[0])
327 		debug("net_hostname  : %s\n", net_hostname);
328 
329 	if (net_root_path[0])
330 		debug("net_root_path  : %s\n", net_root_path);
331 
332 	if (net_nis_domain[0])
333 		debug("net_nis_domain : %s\n", net_nis_domain);
334 
335 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_NTPSERVER)
336 	if (net_ntp_server)
337 		debug("net_ntp_server : %pI4\n", &net_ntp_server);
338 #endif
339 }
340 
341 /*
342  *	Handle a BOOTP received packet.
343  */
344 static void bootp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
345 			  unsigned src, unsigned len)
346 {
347 	struct bootp_hdr *bp;
348 
349 	debug("got BOOTP packet (src=%d, dst=%d, len=%d want_len=%zu)\n",
350 	      src, dest, len, sizeof(struct bootp_hdr));
351 
352 	bp = (struct bootp_hdr *)pkt;
353 
354 	/* Filter out pkts we don't want */
355 	if (check_reply_packet(pkt, dest, src, len))
356 		return;
357 
358 	/*
359 	 *	Got a good BOOTP reply.	 Copy the data into our variables.
360 	 */
361 #if defined(CONFIG_LED_STATUS) && defined(CONFIG_LED_STATUS_BOOT_ENABLE)
362 	status_led_set(CONFIG_LED_STATUS_BOOT, CONFIG_LED_STATUS_OFF);
363 #endif
364 
365 	store_net_params(bp);		/* Store net parameters from reply */
366 
367 	/* Retrieve extended information (we must parse the vendor area) */
368 	if (net_read_u32((u32 *)&bp->bp_vend[0]) == htonl(BOOTP_VENDOR_MAGIC))
369 		bootp_process_vendor((uchar *)&bp->bp_vend[4], len);
370 
371 	net_set_timeout_handler(0, (thand_f *)0);
372 	bootstage_mark_name(BOOTSTAGE_ID_BOOTP_STOP, "bootp_stop");
373 
374 	debug("Got good BOOTP\n");
375 
376 	net_auto_load();
377 }
378 #endif
379 
380 /*
381  *	Timeout on BOOTP/DHCP request.
382  */
383 static void bootp_timeout_handler(void)
384 {
385 	ulong time_taken = get_timer(bootp_start);
386 
387 	if (time_taken >= time_taken_max) {
388 #ifdef CONFIG_BOOTP_MAY_FAIL
389 		char *ethrotate;
390 
391 		ethrotate = env_get("ethrotate");
392 		if ((ethrotate && strcmp(ethrotate, "no") == 0) ||
393 		    net_restart_wrap) {
394 			puts("\nRetry time exceeded\n");
395 			net_set_state(NETLOOP_FAIL);
396 		} else
397 #endif
398 		{
399 			puts("\nRetry time exceeded; starting again\n");
400 			net_start_again();
401 		}
402 	} else {
403 		bootp_timeout *= 2;
404 		if (bootp_timeout > 2000)
405 			bootp_timeout = 2000;
406 		net_set_timeout_handler(bootp_timeout, bootp_timeout_handler);
407 		bootp_request();
408 	}
409 }
410 
411 #define put_vci(e, str)						\
412 	do {							\
413 		size_t vci_strlen = strlen(str);		\
414 		*e++ = 60;	/* Vendor Class Identifier */	\
415 		*e++ = vci_strlen;				\
416 		memcpy(e, str, vci_strlen);			\
417 		e += vci_strlen;				\
418 	} while (0)
419 
420 static u8 *add_vci(u8 *e)
421 {
422 	char *vci = NULL;
423 	char *env_vci = env_get("bootp_vci");
424 
425 #if defined(CONFIG_SPL_BUILD) && defined(CONFIG_SPL_NET_VCI_STRING)
426 	vci = CONFIG_SPL_NET_VCI_STRING;
427 #elif defined(CONFIG_BOOTP_VCI_STRING)
428 	vci = CONFIG_BOOTP_VCI_STRING;
429 #endif
430 
431 	if (env_vci)
432 		vci = env_vci;
433 
434 	if (vci)
435 		put_vci(e, vci);
436 
437 	return e;
438 }
439 
440 /*
441  *	Initialize BOOTP extension fields in the request.
442  */
443 #if defined(CONFIG_CMD_DHCP)
444 static int dhcp_extended(u8 *e, int message_type, struct in_addr server_ip,
445 			struct in_addr requested_ip)
446 {
447 	u8 *start = e;
448 	u8 *cnt;
449 #ifdef CONFIG_LIB_UUID
450 	char *uuid;
451 #endif
452 	int clientarch = -1;
453 
454 #if defined(CONFIG_BOOTP_VENDOREX)
455 	u8 *x;
456 #endif
457 #if defined(CONFIG_BOOTP_SEND_HOSTNAME)
458 	char *hostname;
459 #endif
460 
461 	*e++ = 99;		/* RFC1048 Magic Cookie */
462 	*e++ = 130;
463 	*e++ = 83;
464 	*e++ = 99;
465 
466 	*e++ = 53;		/* DHCP Message Type */
467 	*e++ = 1;
468 	*e++ = message_type;
469 
470 	*e++ = 57;		/* Maximum DHCP Message Size */
471 	*e++ = 2;
472 	*e++ = (576 - 312 + OPT_FIELD_SIZE) >> 8;
473 	*e++ = (576 - 312 + OPT_FIELD_SIZE) & 0xff;
474 
475 	if (server_ip.s_addr) {
476 		int tmp = ntohl(server_ip.s_addr);
477 
478 		*e++ = 54;	/* ServerID */
479 		*e++ = 4;
480 		*e++ = tmp >> 24;
481 		*e++ = tmp >> 16;
482 		*e++ = tmp >> 8;
483 		*e++ = tmp & 0xff;
484 	}
485 
486 	if (requested_ip.s_addr) {
487 		int tmp = ntohl(requested_ip.s_addr);
488 
489 		*e++ = 50;	/* Requested IP */
490 		*e++ = 4;
491 		*e++ = tmp >> 24;
492 		*e++ = tmp >> 16;
493 		*e++ = tmp >> 8;
494 		*e++ = tmp & 0xff;
495 	}
496 #if defined(CONFIG_BOOTP_SEND_HOSTNAME)
497 	hostname = env_get("hostname");
498 	if (hostname) {
499 		int hostnamelen = strlen(hostname);
500 
501 		*e++ = 12;	/* Hostname */
502 		*e++ = hostnamelen;
503 		memcpy(e, hostname, hostnamelen);
504 		e += hostnamelen;
505 	}
506 #endif
507 
508 #ifdef CONFIG_BOOTP_PXE_CLIENTARCH
509 	clientarch = CONFIG_BOOTP_PXE_CLIENTARCH;
510 #endif
511 
512 	if (env_get("bootp_arch"))
513 		clientarch = env_get_ulong("bootp_arch", 16, clientarch);
514 
515 	if (clientarch > 0) {
516 		*e++ = 93;	/* Client System Architecture */
517 		*e++ = 2;
518 		*e++ = (clientarch >> 8) & 0xff;
519 		*e++ = clientarch & 0xff;
520 	}
521 
522 	*e++ = 94;	/* Client Network Interface Identifier */
523 	*e++ = 3;
524 	*e++ = 1;	/* type field for UNDI */
525 	*e++ = 0;	/* major revision */
526 	*e++ = 0;	/* minor revision */
527 
528 #ifdef CONFIG_LIB_UUID
529 	uuid = env_get("pxeuuid");
530 
531 	if (uuid) {
532 		if (uuid_str_valid(uuid)) {
533 			*e++ = 97;	/* Client Machine Identifier */
534 			*e++ = 17;
535 			*e++ = 0;	/* type 0 - UUID */
536 
537 			uuid_str_to_bin(uuid, e, UUID_STR_FORMAT_STD);
538 			e += 16;
539 		} else {
540 			printf("Invalid pxeuuid: %s\n", uuid);
541 		}
542 	}
543 #endif
544 
545 	e = add_vci(e);
546 
547 #if defined(CONFIG_BOOTP_VENDOREX)
548 	x = dhcp_vendorex_prep(e);
549 	if (x)
550 		return x - start;
551 #endif
552 
553 	*e++ = 55;		/* Parameter Request List */
554 	 cnt = e++;		/* Pointer to count of requested items */
555 	*cnt = 0;
556 #if defined(CONFIG_BOOTP_SUBNETMASK)
557 	*e++  = 1;		/* Subnet Mask */
558 	*cnt += 1;
559 #endif
560 #if defined(CONFIG_BOOTP_TIMEOFFSET)
561 	*e++  = 2;
562 	*cnt += 1;
563 #endif
564 #if defined(CONFIG_BOOTP_GATEWAY)
565 	*e++  = 3;		/* Router Option */
566 	*cnt += 1;
567 #endif
568 #if defined(CONFIG_BOOTP_DNS)
569 	*e++  = 6;		/* DNS Server(s) */
570 	*cnt += 1;
571 #endif
572 #if defined(CONFIG_BOOTP_HOSTNAME)
573 	*e++  = 12;		/* Hostname */
574 	*cnt += 1;
575 #endif
576 #if defined(CONFIG_BOOTP_BOOTFILESIZE)
577 	*e++  = 13;		/* Boot File Size */
578 	*cnt += 1;
579 #endif
580 #if defined(CONFIG_BOOTP_BOOTPATH)
581 	*e++  = 17;		/* Boot path */
582 	*cnt += 1;
583 #endif
584 #if defined(CONFIG_BOOTP_NISDOMAIN)
585 	*e++  = 40;		/* NIS Domain name request */
586 	*cnt += 1;
587 #endif
588 #if defined(CONFIG_BOOTP_NTPSERVER)
589 	*e++  = 42;
590 	*cnt += 1;
591 #endif
592 	/* no options, so back up to avoid sending an empty request list */
593 	if (*cnt == 0)
594 		e -= 2;
595 
596 	*e++  = 255;		/* End of the list */
597 
598 	/* Pad to minimal length */
599 #ifdef	CONFIG_DHCP_MIN_EXT_LEN
600 	while ((e - start) < CONFIG_DHCP_MIN_EXT_LEN)
601 		*e++ = 0;
602 #endif
603 
604 	return e - start;
605 }
606 
607 #else
608 /*
609  * Warning: no field size check - change CONFIG_BOOTP_* at your own risk!
610  */
611 static int bootp_extended(u8 *e)
612 {
613 	u8 *start = e;
614 
615 	*e++ = 99;		/* RFC1048 Magic Cookie */
616 	*e++ = 130;
617 	*e++ = 83;
618 	*e++ = 99;
619 
620 #if defined(CONFIG_CMD_DHCP)
621 	*e++ = 53;		/* DHCP Message Type */
622 	*e++ = 1;
623 	*e++ = DHCP_DISCOVER;
624 
625 	*e++ = 57;		/* Maximum DHCP Message Size */
626 	*e++ = 2;
627 	*e++ = (576 - 312 + OPT_FIELD_SIZE) >> 16;
628 	*e++ = (576 - 312 + OPT_FIELD_SIZE) & 0xff;
629 #endif
630 
631 	add_vci(e);
632 
633 #if defined(CONFIG_BOOTP_SUBNETMASK)
634 	*e++ = 1;		/* Subnet mask request */
635 	*e++ = 4;
636 	e   += 4;
637 #endif
638 
639 #if defined(CONFIG_BOOTP_GATEWAY)
640 	*e++ = 3;		/* Default gateway request */
641 	*e++ = 4;
642 	e   += 4;
643 #endif
644 
645 #if defined(CONFIG_BOOTP_DNS)
646 	*e++ = 6;		/* Domain Name Server */
647 	*e++ = 4;
648 	e   += 4;
649 #endif
650 
651 #if defined(CONFIG_BOOTP_HOSTNAME)
652 	*e++ = 12;		/* Host name request */
653 	*e++ = 32;
654 	e   += 32;
655 #endif
656 
657 #if defined(CONFIG_BOOTP_BOOTFILESIZE)
658 	*e++ = 13;		/* Boot file size */
659 	*e++ = 2;
660 	e   += 2;
661 #endif
662 
663 #if defined(CONFIG_BOOTP_BOOTPATH)
664 	*e++ = 17;		/* Boot path */
665 	*e++ = 32;
666 	e   += 32;
667 #endif
668 
669 #if defined(CONFIG_BOOTP_NISDOMAIN)
670 	*e++ = 40;		/* NIS Domain name request */
671 	*e++ = 32;
672 	e   += 32;
673 #endif
674 #if defined(CONFIG_BOOTP_NTPSERVER)
675 	*e++ = 42;
676 	*e++ = 4;
677 	e   += 4;
678 #endif
679 
680 	*e++ = 255;		/* End of the list */
681 
682 	/*
683 	 * If nothing in list, remove it altogether. Some DHCP servers get
684 	 * upset by this minor faux pas and do not respond at all.
685 	 */
686 	if (e == start + 3) {
687 		printf("*** Warning: no DHCP options requested\n");
688 		e -= 3;
689 	}
690 
691 	return e - start;
692 }
693 #endif
694 
695 void bootp_reset(void)
696 {
697 	bootp_num_ids = 0;
698 	bootp_try = 0;
699 	bootp_start = get_timer(0);
700 	bootp_timeout = 250;
701 }
702 
703 void bootp_request(void)
704 {
705 	uchar *pkt, *iphdr;
706 	struct bootp_hdr *bp;
707 	int extlen, pktlen, iplen;
708 	int eth_hdr_size;
709 #ifdef CONFIG_BOOTP_RANDOM_DELAY
710 	ulong rand_ms;
711 #endif
712 	u32 bootp_id;
713 	struct in_addr zero_ip;
714 	struct in_addr bcast_ip;
715 	char *ep;  /* Environment pointer */
716 
717 	bootstage_mark_name(BOOTSTAGE_ID_BOOTP_START, "bootp_start");
718 #if defined(CONFIG_CMD_DHCP)
719 	dhcp_state = INIT;
720 #endif
721 
722 	ep = env_get("bootpretryperiod");
723 	if (ep != NULL)
724 		time_taken_max = simple_strtoul(ep, NULL, 10);
725 	else
726 		time_taken_max = TIMEOUT_MS;
727 
728 #ifdef CONFIG_BOOTP_RANDOM_DELAY		/* Random BOOTP delay */
729 	if (bootp_try == 0)
730 		srand_mac();
731 
732 	if (bootp_try <= 2)	/* Start with max 1024 * 1ms */
733 		rand_ms = rand() >> (22 - bootp_try);
734 	else		/* After 3rd BOOTP request max 8192 * 1ms */
735 		rand_ms = rand() >> 19;
736 
737 	printf("Random delay: %ld ms...\n", rand_ms);
738 	mdelay(rand_ms);
739 
740 #endif	/* CONFIG_BOOTP_RANDOM_DELAY */
741 
742 	printf("BOOTP broadcast %d\n", ++bootp_try);
743 	pkt = net_tx_packet;
744 	memset((void *)pkt, 0, PKTSIZE);
745 
746 	eth_hdr_size = net_set_ether(pkt, net_bcast_ethaddr, PROT_IP);
747 	pkt += eth_hdr_size;
748 
749 	/*
750 	 * Next line results in incorrect packet size being transmitted,
751 	 * resulting in errors in some DHCP servers, reporting missing bytes.
752 	 * Size must be set in packet header after extension length has been
753 	 * determined.
754 	 * C. Hallinan, DS4.COM, Inc.
755 	 */
756 	/* net_set_udp_header(pkt, 0xFFFFFFFFL, PORT_BOOTPS, PORT_BOOTPC,
757 		sizeof (struct bootp_hdr)); */
758 	iphdr = pkt;	/* We need this later for net_set_udp_header() */
759 	pkt += IP_UDP_HDR_SIZE;
760 
761 	bp = (struct bootp_hdr *)pkt;
762 	bp->bp_op = OP_BOOTREQUEST;
763 	bp->bp_htype = HWT_ETHER;
764 	bp->bp_hlen = HWL_ETHER;
765 	bp->bp_hops = 0;
766 	/*
767 	 * according to RFC1542, should be 0 on first request, secs since
768 	 * first request otherwise
769 	 */
770 	bp->bp_secs = htons(get_timer(bootp_start) / 1000);
771 	zero_ip.s_addr = 0;
772 	net_write_ip(&bp->bp_ciaddr, zero_ip);
773 	net_write_ip(&bp->bp_yiaddr, zero_ip);
774 	net_write_ip(&bp->bp_siaddr, zero_ip);
775 	net_write_ip(&bp->bp_giaddr, zero_ip);
776 	memcpy(bp->bp_chaddr, net_ethaddr, 6);
777 	copy_filename(bp->bp_file, net_boot_file_name, sizeof(bp->bp_file));
778 
779 	/* Request additional information from the BOOTP/DHCP server */
780 #if defined(CONFIG_CMD_DHCP)
781 	extlen = dhcp_extended((u8 *)bp->bp_vend, DHCP_DISCOVER, zero_ip,
782 			       zero_ip);
783 #else
784 	extlen = bootp_extended((u8 *)bp->bp_vend);
785 #endif
786 
787 	/*
788 	 *	Bootp ID is the lower 4 bytes of our ethernet address
789 	 *	plus the current time in ms.
790 	 */
791 	bootp_id = ((u32)net_ethaddr[2] << 24)
792 		| ((u32)net_ethaddr[3] << 16)
793 		| ((u32)net_ethaddr[4] << 8)
794 		| (u32)net_ethaddr[5];
795 	bootp_id += get_timer(0);
796 	bootp_id = htonl(bootp_id);
797 	bootp_add_id(bootp_id);
798 	net_copy_u32(&bp->bp_id, &bootp_id);
799 
800 	/*
801 	 * Calculate proper packet lengths taking into account the
802 	 * variable size of the options field
803 	 */
804 	iplen = BOOTP_HDR_SIZE - OPT_FIELD_SIZE + extlen;
805 	pktlen = eth_hdr_size + IP_UDP_HDR_SIZE + iplen;
806 	bcast_ip.s_addr = 0xFFFFFFFFL;
807 	net_set_udp_header(iphdr, bcast_ip, PORT_BOOTPS, PORT_BOOTPC, iplen);
808 	net_set_timeout_handler(bootp_timeout, bootp_timeout_handler);
809 
810 #if defined(CONFIG_CMD_DHCP)
811 	dhcp_state = SELECTING;
812 	net_set_udp_handler(dhcp_handler);
813 #else
814 	net_set_udp_handler(bootp_handler);
815 #endif
816 	net_send_packet(net_tx_packet, pktlen);
817 }
818 
819 #if defined(CONFIG_CMD_DHCP)
820 static void dhcp_process_options(uchar *popt, uchar *end)
821 {
822 	int oplen, size;
823 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_TIMEOFFSET)
824 	int *to_ptr;
825 #endif
826 
827 	while (popt < end && *popt != 0xff) {
828 		oplen = *(popt + 1);
829 		switch (*popt) {
830 		case 0:
831 			oplen = -1; /* Pad omits len byte */
832 			break;
833 		case 1:
834 			net_copy_ip(&net_netmask, (popt + 2));
835 			break;
836 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_TIMEOFFSET)
837 		case 2:		/* Time offset	*/
838 			to_ptr = &net_ntp_time_offset;
839 			net_copy_u32((u32 *)to_ptr, (u32 *)(popt + 2));
840 			net_ntp_time_offset = ntohl(net_ntp_time_offset);
841 			break;
842 #endif
843 		case 3:
844 			net_copy_ip(&net_gateway, (popt + 2));
845 			break;
846 		case 6:
847 			net_copy_ip(&net_dns_server, (popt + 2));
848 #if defined(CONFIG_BOOTP_DNS2)
849 			if (*(popt + 1) > 4)
850 				net_copy_ip(&net_dns_server2, (popt + 2 + 4));
851 #endif
852 			break;
853 		case 12:
854 			size = truncate_sz("Host Name",
855 				sizeof(net_hostname), oplen);
856 			memcpy(&net_hostname, popt + 2, size);
857 			net_hostname[size] = 0;
858 			break;
859 		case 15:	/* Ignore Domain Name Option */
860 			break;
861 		case 17:
862 			size = truncate_sz("Root Path",
863 				sizeof(net_root_path), oplen);
864 			memcpy(&net_root_path, popt + 2, size);
865 			net_root_path[size] = 0;
866 			break;
867 		case 28:	/* Ignore Broadcast Address Option */
868 			break;
869 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_NTPSERVER)
870 		case 42:	/* NTP server IP */
871 			net_copy_ip(&net_ntp_server, (popt + 2));
872 			break;
873 #endif
874 		case 51:
875 			net_copy_u32(&dhcp_leasetime, (u32 *)(popt + 2));
876 			break;
877 		case 52:
878 			dhcp_option_overload = popt[2];
879 			break;
880 		case 53:	/* Ignore Message Type Option */
881 			break;
882 		case 54:
883 			net_copy_ip(&dhcp_server_ip, (popt + 2));
884 			break;
885 		case 58:	/* Ignore Renewal Time Option */
886 			break;
887 		case 59:	/* Ignore Rebinding Time Option */
888 			break;
889 		case 66:	/* Ignore TFTP server name */
890 			break;
891 		case 67:	/* Bootfile option */
892 			size = truncate_sz("Bootfile",
893 					   sizeof(net_boot_file_name), oplen);
894 			memcpy(&net_boot_file_name, popt + 2, size);
895 			net_boot_file_name[size] = 0;
896 			break;
897 		default:
898 #if defined(CONFIG_BOOTP_VENDOREX)
899 			if (dhcp_vendorex_proc(popt))
900 				break;
901 #endif
902 			printf("*** Unhandled DHCP Option in OFFER/ACK:"
903 			       " %d\n", *popt);
904 			break;
905 		}
906 		popt += oplen + 2;	/* Process next option */
907 	}
908 }
909 
910 static void dhcp_packet_process_options(struct bootp_hdr *bp)
911 {
912 	uchar *popt = (uchar *)&bp->bp_vend[4];
913 	uchar *end = popt + BOOTP_HDR_SIZE;
914 
915 	if (net_read_u32((u32 *)&bp->bp_vend[0]) != htonl(BOOTP_VENDOR_MAGIC))
916 		return;
917 
918 	dhcp_option_overload = 0;
919 
920 	/*
921 	 * The 'options' field MUST be interpreted first, 'file' next,
922 	 * 'sname' last.
923 	 */
924 	dhcp_process_options(popt, end);
925 
926 	if (dhcp_option_overload & OVERLOAD_FILE) {
927 		popt = (uchar *)bp->bp_file;
928 		end = popt + sizeof(bp->bp_file);
929 		dhcp_process_options(popt, end);
930 	}
931 
932 	if (dhcp_option_overload & OVERLOAD_SNAME) {
933 		popt = (uchar *)bp->bp_sname;
934 		end = popt + sizeof(bp->bp_sname);
935 		dhcp_process_options(popt, end);
936 	}
937 }
938 
939 static int dhcp_message_type(unsigned char *popt)
940 {
941 	if (net_read_u32((u32 *)popt) != htonl(BOOTP_VENDOR_MAGIC))
942 		return -1;
943 
944 	popt += 4;
945 	while (*popt != 0xff) {
946 		if (*popt == 53)	/* DHCP Message Type */
947 			return *(popt + 2);
948 		if (*popt == 0)	{
949 			/* Pad */
950 			popt += 1;
951 		} else {
952 			/* Scan through all options */
953 			popt += *(popt + 1) + 2;
954 		}
955 	}
956 	return -1;
957 }
958 
959 static void dhcp_send_request_packet(struct bootp_hdr *bp_offer)
960 {
961 	uchar *pkt, *iphdr;
962 	struct bootp_hdr *bp;
963 	int pktlen, iplen, extlen;
964 	int eth_hdr_size;
965 	struct in_addr offered_ip;
966 	struct in_addr zero_ip;
967 	struct in_addr bcast_ip;
968 
969 	debug("dhcp_send_request_packet: Sending DHCPREQUEST\n");
970 	pkt = net_tx_packet;
971 	memset((void *)pkt, 0, PKTSIZE);
972 
973 	eth_hdr_size = net_set_ether(pkt, net_bcast_ethaddr, PROT_IP);
974 	pkt += eth_hdr_size;
975 
976 	iphdr = pkt;	/* We'll need this later to set proper pkt size */
977 	pkt += IP_UDP_HDR_SIZE;
978 
979 	bp = (struct bootp_hdr *)pkt;
980 	bp->bp_op = OP_BOOTREQUEST;
981 	bp->bp_htype = HWT_ETHER;
982 	bp->bp_hlen = HWL_ETHER;
983 	bp->bp_hops = 0;
984 	bp->bp_secs = htons(get_timer(bootp_start) / 1000);
985 	/* Do not set the client IP, your IP, or server IP yet, since it
986 	 * hasn't been ACK'ed by the server yet */
987 
988 	/*
989 	 * RFC3046 requires Relay Agents to discard packets with
990 	 * nonzero and offered giaddr
991 	 */
992 	zero_ip.s_addr = 0;
993 	net_write_ip(&bp->bp_giaddr, zero_ip);
994 
995 	memcpy(bp->bp_chaddr, net_ethaddr, 6);
996 	copy_filename(bp->bp_file, net_boot_file_name, sizeof(bp->bp_file));
997 
998 	/*
999 	 * ID is the id of the OFFER packet
1000 	 */
1001 
1002 	net_copy_u32(&bp->bp_id, &bp_offer->bp_id);
1003 
1004 	/*
1005 	 * Copy options from OFFER packet if present
1006 	 */
1007 
1008 	/* Copy offered IP into the parameters request list */
1009 	net_copy_ip(&offered_ip, &bp_offer->bp_yiaddr);
1010 	extlen = dhcp_extended((u8 *)bp->bp_vend, DHCP_REQUEST,
1011 		dhcp_server_ip, offered_ip);
1012 
1013 	iplen = BOOTP_HDR_SIZE - OPT_FIELD_SIZE + extlen;
1014 	pktlen = eth_hdr_size + IP_UDP_HDR_SIZE + iplen;
1015 	bcast_ip.s_addr = 0xFFFFFFFFL;
1016 	net_set_udp_header(iphdr, bcast_ip, PORT_BOOTPS, PORT_BOOTPC, iplen);
1017 
1018 #ifdef CONFIG_BOOTP_DHCP_REQUEST_DELAY
1019 	udelay(CONFIG_BOOTP_DHCP_REQUEST_DELAY);
1020 #endif	/* CONFIG_BOOTP_DHCP_REQUEST_DELAY */
1021 	debug("Transmitting DHCPREQUEST packet: len = %d\n", pktlen);
1022 	net_send_packet(net_tx_packet, pktlen);
1023 }
1024 
1025 /*
1026  *	Handle DHCP received packets.
1027  */
1028 static void dhcp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
1029 			 unsigned src, unsigned len)
1030 {
1031 	struct bootp_hdr *bp = (struct bootp_hdr *)pkt;
1032 
1033 	debug("DHCPHandler: got packet: (src=%d, dst=%d, len=%d) state: %d\n",
1034 	      src, dest, len, dhcp_state);
1035 
1036 	/* Filter out pkts we don't want */
1037 	if (check_reply_packet(pkt, dest, src, len))
1038 		return;
1039 
1040 	debug("DHCPHandler: got DHCP packet: (src=%d, dst=%d, len=%d) state: "
1041 	      "%d\n", src, dest, len, dhcp_state);
1042 
1043 	if (net_read_ip(&bp->bp_yiaddr).s_addr == 0)
1044 		return;
1045 
1046 	switch (dhcp_state) {
1047 	case SELECTING:
1048 		/*
1049 		 * Wait an appropriate time for any potential DHCPOFFER packets
1050 		 * to arrive.  Then select one, and generate DHCPREQUEST
1051 		 * response.  If filename is in format we recognize, assume it
1052 		 * is a valid OFFER from a server we want.
1053 		 */
1054 		debug("DHCP: state=SELECTING bp_file: \"%s\"\n", bp->bp_file);
1055 #ifdef CONFIG_SYS_BOOTFILE_PREFIX
1056 		if (strncmp(bp->bp_file,
1057 			    CONFIG_SYS_BOOTFILE_PREFIX,
1058 			    strlen(CONFIG_SYS_BOOTFILE_PREFIX)) == 0) {
1059 #endif	/* CONFIG_SYS_BOOTFILE_PREFIX */
1060 			dhcp_packet_process_options(bp);
1061 			efi_net_set_dhcp_ack(pkt, len);
1062 
1063 			debug("TRANSITIONING TO REQUESTING STATE\n");
1064 			dhcp_state = REQUESTING;
1065 
1066 			net_set_timeout_handler(5000, bootp_timeout_handler);
1067 			dhcp_send_request_packet(bp);
1068 #ifdef CONFIG_SYS_BOOTFILE_PREFIX
1069 		}
1070 #endif	/* CONFIG_SYS_BOOTFILE_PREFIX */
1071 
1072 		return;
1073 		break;
1074 	case REQUESTING:
1075 		debug("DHCP State: REQUESTING\n");
1076 
1077 		if (dhcp_message_type((u8 *)bp->bp_vend) == DHCP_ACK) {
1078 			dhcp_packet_process_options(bp);
1079 			/* Store net params from reply */
1080 			store_net_params(bp);
1081 			dhcp_state = BOUND;
1082 			printf("DHCP client bound to address %pI4 (%lu ms)\n",
1083 			       &net_ip, get_timer(bootp_start));
1084 			net_set_timeout_handler(0, (thand_f *)0);
1085 			bootstage_mark_name(BOOTSTAGE_ID_BOOTP_STOP,
1086 					    "bootp_stop");
1087 
1088 			net_auto_load();
1089 			return;
1090 		}
1091 		break;
1092 	case BOUND:
1093 		/* DHCP client bound to address */
1094 		break;
1095 	default:
1096 		puts("DHCP: INVALID STATE\n");
1097 		break;
1098 	}
1099 }
1100 
1101 void dhcp_request(void)
1102 {
1103 	bootp_request();
1104 }
1105 #endif	/* CONFIG_CMD_DHCP */
1106