xref: /openbmc/u-boot/net/bootp.c (revision 42f8ebfd)
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 <net.h>
14 #include <net/tftp.h>
15 #include "bootp.h"
16 #include "nfs.h"
17 #ifdef CONFIG_STATUS_LED
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 		setenv("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_STATUS_LED) && defined(STATUS_LED_BOOT)
362 	status_led_set(STATUS_LED_BOOT, STATUS_LED_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 		puts("\nRetry time exceeded\n");
390 		net_set_state(NETLOOP_FAIL);
391 #else
392 		puts("\nRetry time exceeded; starting again\n");
393 		net_start_again();
394 #endif
395 	} else {
396 		bootp_timeout *= 2;
397 		if (bootp_timeout > 2000)
398 			bootp_timeout = 2000;
399 		net_set_timeout_handler(bootp_timeout, bootp_timeout_handler);
400 		bootp_request();
401 	}
402 }
403 
404 #define put_vci(e, str)						\
405 	do {							\
406 		size_t vci_strlen = strlen(str);		\
407 		*e++ = 60;	/* Vendor Class Identifier */	\
408 		*e++ = vci_strlen;				\
409 		memcpy(e, str, vci_strlen);			\
410 		e += vci_strlen;				\
411 	} while (0)
412 
413 /*
414  *	Initialize BOOTP extension fields in the request.
415  */
416 #if defined(CONFIG_CMD_DHCP)
417 static int dhcp_extended(u8 *e, int message_type, struct in_addr server_ip,
418 			struct in_addr requested_ip)
419 {
420 	u8 *start = e;
421 	u8 *cnt;
422 #if defined(CONFIG_BOOTP_PXE)
423 	char *uuid;
424 	u16 clientarch;
425 #endif
426 
427 #if defined(CONFIG_BOOTP_VENDOREX)
428 	u8 *x;
429 #endif
430 #if defined(CONFIG_BOOTP_SEND_HOSTNAME)
431 	char *hostname;
432 #endif
433 
434 	*e++ = 99;		/* RFC1048 Magic Cookie */
435 	*e++ = 130;
436 	*e++ = 83;
437 	*e++ = 99;
438 
439 	*e++ = 53;		/* DHCP Message Type */
440 	*e++ = 1;
441 	*e++ = message_type;
442 
443 	*e++ = 57;		/* Maximum DHCP Message Size */
444 	*e++ = 2;
445 	*e++ = (576 - 312 + OPT_FIELD_SIZE) >> 8;
446 	*e++ = (576 - 312 + OPT_FIELD_SIZE) & 0xff;
447 
448 	if (server_ip.s_addr) {
449 		int tmp = ntohl(server_ip.s_addr);
450 
451 		*e++ = 54;	/* ServerID */
452 		*e++ = 4;
453 		*e++ = tmp >> 24;
454 		*e++ = tmp >> 16;
455 		*e++ = tmp >> 8;
456 		*e++ = tmp & 0xff;
457 	}
458 
459 	if (requested_ip.s_addr) {
460 		int tmp = ntohl(requested_ip.s_addr);
461 
462 		*e++ = 50;	/* Requested IP */
463 		*e++ = 4;
464 		*e++ = tmp >> 24;
465 		*e++ = tmp >> 16;
466 		*e++ = tmp >> 8;
467 		*e++ = tmp & 0xff;
468 	}
469 #if defined(CONFIG_BOOTP_SEND_HOSTNAME)
470 	hostname = getenv("hostname");
471 	if (hostname) {
472 		int hostnamelen = strlen(hostname);
473 
474 		*e++ = 12;	/* Hostname */
475 		*e++ = hostnamelen;
476 		memcpy(e, hostname, hostnamelen);
477 		e += hostnamelen;
478 	}
479 #endif
480 
481 #if defined(CONFIG_BOOTP_PXE)
482 	clientarch = CONFIG_BOOTP_PXE_CLIENTARCH;
483 	*e++ = 93;	/* Client System Architecture */
484 	*e++ = 2;
485 	*e++ = (clientarch >> 8) & 0xff;
486 	*e++ = clientarch & 0xff;
487 
488 	*e++ = 94;	/* Client Network Interface Identifier */
489 	*e++ = 3;
490 	*e++ = 1;	/* type field for UNDI */
491 	*e++ = 0;	/* major revision */
492 	*e++ = 0;	/* minor revision */
493 
494 	uuid = getenv("pxeuuid");
495 
496 	if (uuid) {
497 		if (uuid_str_valid(uuid)) {
498 			*e++ = 97;	/* Client Machine Identifier */
499 			*e++ = 17;
500 			*e++ = 0;	/* type 0 - UUID */
501 
502 			uuid_str_to_bin(uuid, e, UUID_STR_FORMAT_STD);
503 			e += 16;
504 		} else {
505 			printf("Invalid pxeuuid: %s\n", uuid);
506 		}
507 	}
508 #endif
509 
510 #if defined(CONFIG_SPL_BUILD) && defined(CONFIG_SPL_NET_VCI_STRING)
511 	put_vci(e, CONFIG_SPL_NET_VCI_STRING);
512 #elif defined(CONFIG_BOOTP_VCI_STRING)
513 	put_vci(e, CONFIG_BOOTP_VCI_STRING);
514 #endif
515 
516 #if defined(CONFIG_BOOTP_VENDOREX)
517 	x = dhcp_vendorex_prep(e);
518 	if (x)
519 		return x - start;
520 #endif
521 
522 	*e++ = 55;		/* Parameter Request List */
523 	 cnt = e++;		/* Pointer to count of requested items */
524 	*cnt = 0;
525 #if defined(CONFIG_BOOTP_SUBNETMASK)
526 	*e++  = 1;		/* Subnet Mask */
527 	*cnt += 1;
528 #endif
529 #if defined(CONFIG_BOOTP_TIMEOFFSET)
530 	*e++  = 2;
531 	*cnt += 1;
532 #endif
533 #if defined(CONFIG_BOOTP_GATEWAY)
534 	*e++  = 3;		/* Router Option */
535 	*cnt += 1;
536 #endif
537 #if defined(CONFIG_BOOTP_DNS)
538 	*e++  = 6;		/* DNS Server(s) */
539 	*cnt += 1;
540 #endif
541 #if defined(CONFIG_BOOTP_HOSTNAME)
542 	*e++  = 12;		/* Hostname */
543 	*cnt += 1;
544 #endif
545 #if defined(CONFIG_BOOTP_BOOTFILESIZE)
546 	*e++  = 13;		/* Boot File Size */
547 	*cnt += 1;
548 #endif
549 #if defined(CONFIG_BOOTP_BOOTPATH)
550 	*e++  = 17;		/* Boot path */
551 	*cnt += 1;
552 #endif
553 #if defined(CONFIG_BOOTP_NISDOMAIN)
554 	*e++  = 40;		/* NIS Domain name request */
555 	*cnt += 1;
556 #endif
557 #if defined(CONFIG_BOOTP_NTPSERVER)
558 	*e++  = 42;
559 	*cnt += 1;
560 #endif
561 	/* no options, so back up to avoid sending an empty request list */
562 	if (*cnt == 0)
563 		e -= 2;
564 
565 	*e++  = 255;		/* End of the list */
566 
567 	/* Pad to minimal length */
568 #ifdef	CONFIG_DHCP_MIN_EXT_LEN
569 	while ((e - start) < CONFIG_DHCP_MIN_EXT_LEN)
570 		*e++ = 0;
571 #endif
572 
573 	return e - start;
574 }
575 
576 #else
577 /*
578  * Warning: no field size check - change CONFIG_BOOTP_* at your own risk!
579  */
580 static int bootp_extended(u8 *e)
581 {
582 	u8 *start = e;
583 
584 	*e++ = 99;		/* RFC1048 Magic Cookie */
585 	*e++ = 130;
586 	*e++ = 83;
587 	*e++ = 99;
588 
589 #if defined(CONFIG_CMD_DHCP)
590 	*e++ = 53;		/* DHCP Message Type */
591 	*e++ = 1;
592 	*e++ = DHCP_DISCOVER;
593 
594 	*e++ = 57;		/* Maximum DHCP Message Size */
595 	*e++ = 2;
596 	*e++ = (576 - 312 + OPT_FIELD_SIZE) >> 16;
597 	*e++ = (576 - 312 + OPT_FIELD_SIZE) & 0xff;
598 #endif
599 
600 #if defined(CONFIG_BOOTP_VCI_STRING) || \
601 	(defined(CONFIG_SPL_BUILD) && defined(CONFIG_SPL_NET_VCI_STRING))
602 #ifdef CONFIG_SPL_BUILD
603 	put_vci(e, CONFIG_SPL_NET_VCI_STRING);
604 #else
605 	put_vci(e, CONFIG_BOOTP_VCI_STRING);
606 #endif
607 #endif
608 
609 #if defined(CONFIG_BOOTP_SUBNETMASK)
610 	*e++ = 1;		/* Subnet mask request */
611 	*e++ = 4;
612 	e   += 4;
613 #endif
614 
615 #if defined(CONFIG_BOOTP_GATEWAY)
616 	*e++ = 3;		/* Default gateway request */
617 	*e++ = 4;
618 	e   += 4;
619 #endif
620 
621 #if defined(CONFIG_BOOTP_DNS)
622 	*e++ = 6;		/* Domain Name Server */
623 	*e++ = 4;
624 	e   += 4;
625 #endif
626 
627 #if defined(CONFIG_BOOTP_HOSTNAME)
628 	*e++ = 12;		/* Host name request */
629 	*e++ = 32;
630 	e   += 32;
631 #endif
632 
633 #if defined(CONFIG_BOOTP_BOOTFILESIZE)
634 	*e++ = 13;		/* Boot file size */
635 	*e++ = 2;
636 	e   += 2;
637 #endif
638 
639 #if defined(CONFIG_BOOTP_BOOTPATH)
640 	*e++ = 17;		/* Boot path */
641 	*e++ = 32;
642 	e   += 32;
643 #endif
644 
645 #if defined(CONFIG_BOOTP_NISDOMAIN)
646 	*e++ = 40;		/* NIS Domain name request */
647 	*e++ = 32;
648 	e   += 32;
649 #endif
650 #if defined(CONFIG_BOOTP_NTPSERVER)
651 	*e++ = 42;
652 	*e++ = 4;
653 	e   += 4;
654 #endif
655 
656 	*e++ = 255;		/* End of the list */
657 
658 	return e - start;
659 }
660 #endif
661 
662 void bootp_reset(void)
663 {
664 	bootp_num_ids = 0;
665 	bootp_try = 0;
666 	bootp_start = get_timer(0);
667 	bootp_timeout = 250;
668 }
669 
670 void bootp_request(void)
671 {
672 	uchar *pkt, *iphdr;
673 	struct bootp_hdr *bp;
674 	int extlen, pktlen, iplen;
675 	int eth_hdr_size;
676 #ifdef CONFIG_BOOTP_RANDOM_DELAY
677 	ulong rand_ms;
678 #endif
679 	u32 bootp_id;
680 	struct in_addr zero_ip;
681 	struct in_addr bcast_ip;
682 	char *ep;  /* Environment pointer */
683 
684 	bootstage_mark_name(BOOTSTAGE_ID_BOOTP_START, "bootp_start");
685 #if defined(CONFIG_CMD_DHCP)
686 	dhcp_state = INIT;
687 #endif
688 
689 	ep = getenv("bootpretryperiod");
690 	if (ep != NULL)
691 		time_taken_max = simple_strtoul(ep, NULL, 10);
692 	else
693 		time_taken_max = TIMEOUT_MS;
694 
695 #ifdef CONFIG_BOOTP_RANDOM_DELAY		/* Random BOOTP delay */
696 	if (bootp_try == 0)
697 		srand_mac();
698 
699 	if (bootp_try <= 2)	/* Start with max 1024 * 1ms */
700 		rand_ms = rand() >> (22 - bootp_try);
701 	else		/* After 3rd BOOTP request max 8192 * 1ms */
702 		rand_ms = rand() >> 19;
703 
704 	printf("Random delay: %ld ms...\n", rand_ms);
705 	mdelay(rand_ms);
706 
707 #endif	/* CONFIG_BOOTP_RANDOM_DELAY */
708 
709 	printf("BOOTP broadcast %d\n", ++bootp_try);
710 	pkt = net_tx_packet;
711 	memset((void *)pkt, 0, PKTSIZE);
712 
713 	eth_hdr_size = net_set_ether(pkt, net_bcast_ethaddr, PROT_IP);
714 	pkt += eth_hdr_size;
715 
716 	/*
717 	 * Next line results in incorrect packet size being transmitted,
718 	 * resulting in errors in some DHCP servers, reporting missing bytes.
719 	 * Size must be set in packet header after extension length has been
720 	 * determined.
721 	 * C. Hallinan, DS4.COM, Inc.
722 	 */
723 	/* net_set_udp_header(pkt, 0xFFFFFFFFL, PORT_BOOTPS, PORT_BOOTPC,
724 		sizeof (struct bootp_hdr)); */
725 	iphdr = pkt;	/* We need this later for net_set_udp_header() */
726 	pkt += IP_UDP_HDR_SIZE;
727 
728 	bp = (struct bootp_hdr *)pkt;
729 	bp->bp_op = OP_BOOTREQUEST;
730 	bp->bp_htype = HWT_ETHER;
731 	bp->bp_hlen = HWL_ETHER;
732 	bp->bp_hops = 0;
733 	/*
734 	 * according to RFC1542, should be 0 on first request, secs since
735 	 * first request otherwise
736 	 */
737 	bp->bp_secs = htons(get_timer(bootp_start) / 1000);
738 	zero_ip.s_addr = 0;
739 	net_write_ip(&bp->bp_ciaddr, zero_ip);
740 	net_write_ip(&bp->bp_yiaddr, zero_ip);
741 	net_write_ip(&bp->bp_siaddr, zero_ip);
742 	net_write_ip(&bp->bp_giaddr, zero_ip);
743 	memcpy(bp->bp_chaddr, net_ethaddr, 6);
744 	copy_filename(bp->bp_file, net_boot_file_name, sizeof(bp->bp_file));
745 
746 	/* Request additional information from the BOOTP/DHCP server */
747 #if defined(CONFIG_CMD_DHCP)
748 	extlen = dhcp_extended((u8 *)bp->bp_vend, DHCP_DISCOVER, zero_ip,
749 			       zero_ip);
750 #else
751 	extlen = bootp_extended((u8 *)bp->bp_vend);
752 #endif
753 
754 	/*
755 	 *	Bootp ID is the lower 4 bytes of our ethernet address
756 	 *	plus the current time in ms.
757 	 */
758 	bootp_id = ((u32)net_ethaddr[2] << 24)
759 		| ((u32)net_ethaddr[3] << 16)
760 		| ((u32)net_ethaddr[4] << 8)
761 		| (u32)net_ethaddr[5];
762 	bootp_id += get_timer(0);
763 	bootp_id = htonl(bootp_id);
764 	bootp_add_id(bootp_id);
765 	net_copy_u32(&bp->bp_id, &bootp_id);
766 
767 	/*
768 	 * Calculate proper packet lengths taking into account the
769 	 * variable size of the options field
770 	 */
771 	iplen = BOOTP_HDR_SIZE - OPT_FIELD_SIZE + extlen;
772 	pktlen = eth_hdr_size + IP_UDP_HDR_SIZE + iplen;
773 	bcast_ip.s_addr = 0xFFFFFFFFL;
774 	net_set_udp_header(iphdr, bcast_ip, PORT_BOOTPS, PORT_BOOTPC, iplen);
775 	net_set_timeout_handler(bootp_timeout, bootp_timeout_handler);
776 
777 #if defined(CONFIG_CMD_DHCP)
778 	dhcp_state = SELECTING;
779 	net_set_udp_handler(dhcp_handler);
780 #else
781 	net_set_udp_handler(bootp_handler);
782 #endif
783 	net_send_packet(net_tx_packet, pktlen);
784 }
785 
786 #if defined(CONFIG_CMD_DHCP)
787 static void dhcp_process_options(uchar *popt, uchar *end)
788 {
789 	int oplen, size;
790 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_TIMEOFFSET)
791 	int *to_ptr;
792 #endif
793 
794 	while (popt < end && *popt != 0xff) {
795 		oplen = *(popt + 1);
796 		switch (*popt) {
797 		case 0:
798 			oplen = -1; /* Pad omits len byte */
799 			break;
800 		case 1:
801 			net_copy_ip(&net_netmask, (popt + 2));
802 			break;
803 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_TIMEOFFSET)
804 		case 2:		/* Time offset	*/
805 			to_ptr = &net_ntp_time_offset;
806 			net_copy_u32((u32 *)to_ptr, (u32 *)(popt + 2));
807 			net_ntp_time_offset = ntohl(net_ntp_time_offset);
808 			break;
809 #endif
810 		case 3:
811 			net_copy_ip(&net_gateway, (popt + 2));
812 			break;
813 		case 6:
814 			net_copy_ip(&net_dns_server, (popt + 2));
815 #if defined(CONFIG_BOOTP_DNS2)
816 			if (*(popt + 1) > 4)
817 				net_copy_ip(&net_dns_server2, (popt + 2 + 4));
818 #endif
819 			break;
820 		case 12:
821 			size = truncate_sz("Host Name",
822 				sizeof(net_hostname), oplen);
823 			memcpy(&net_hostname, popt + 2, size);
824 			net_hostname[size] = 0;
825 			break;
826 		case 15:	/* Ignore Domain Name Option */
827 			break;
828 		case 17:
829 			size = truncate_sz("Root Path",
830 				sizeof(net_root_path), oplen);
831 			memcpy(&net_root_path, popt + 2, size);
832 			net_root_path[size] = 0;
833 			break;
834 		case 28:	/* Ignore Broadcast Address Option */
835 			break;
836 #if defined(CONFIG_CMD_SNTP) && defined(CONFIG_BOOTP_NTPSERVER)
837 		case 42:	/* NTP server IP */
838 			net_copy_ip(&net_ntp_server, (popt + 2));
839 			break;
840 #endif
841 		case 51:
842 			net_copy_u32(&dhcp_leasetime, (u32 *)(popt + 2));
843 			break;
844 		case 52:
845 			dhcp_option_overload = popt[2];
846 			break;
847 		case 53:	/* Ignore Message Type Option */
848 			break;
849 		case 54:
850 			net_copy_ip(&dhcp_server_ip, (popt + 2));
851 			break;
852 		case 58:	/* Ignore Renewal Time Option */
853 			break;
854 		case 59:	/* Ignore Rebinding Time Option */
855 			break;
856 		case 66:	/* Ignore TFTP server name */
857 			break;
858 		case 67:	/* Bootfile option */
859 			size = truncate_sz("Bootfile",
860 					   sizeof(net_boot_file_name), oplen);
861 			memcpy(&net_boot_file_name, popt + 2, size);
862 			net_boot_file_name[size] = 0;
863 			break;
864 		default:
865 #if defined(CONFIG_BOOTP_VENDOREX)
866 			if (dhcp_vendorex_proc(popt))
867 				break;
868 #endif
869 			printf("*** Unhandled DHCP Option in OFFER/ACK:"
870 			       " %d\n", *popt);
871 			break;
872 		}
873 		popt += oplen + 2;	/* Process next option */
874 	}
875 }
876 
877 static void dhcp_packet_process_options(struct bootp_hdr *bp)
878 {
879 	uchar *popt = (uchar *)&bp->bp_vend[4];
880 	uchar *end = popt + BOOTP_HDR_SIZE;
881 
882 	if (net_read_u32((u32 *)&bp->bp_vend[0]) != htonl(BOOTP_VENDOR_MAGIC))
883 		return;
884 
885 	dhcp_option_overload = 0;
886 
887 	/*
888 	 * The 'options' field MUST be interpreted first, 'file' next,
889 	 * 'sname' last.
890 	 */
891 	dhcp_process_options(popt, end);
892 
893 	if (dhcp_option_overload & OVERLOAD_FILE) {
894 		popt = (uchar *)bp->bp_file;
895 		end = popt + sizeof(bp->bp_file);
896 		dhcp_process_options(popt, end);
897 	}
898 
899 	if (dhcp_option_overload & OVERLOAD_SNAME) {
900 		popt = (uchar *)bp->bp_sname;
901 		end = popt + sizeof(bp->bp_sname);
902 		dhcp_process_options(popt, end);
903 	}
904 }
905 
906 static int dhcp_message_type(unsigned char *popt)
907 {
908 	if (net_read_u32((u32 *)popt) != htonl(BOOTP_VENDOR_MAGIC))
909 		return -1;
910 
911 	popt += 4;
912 	while (*popt != 0xff) {
913 		if (*popt == 53)	/* DHCP Message Type */
914 			return *(popt + 2);
915 		if (*popt == 0)	{
916 			/* Pad */
917 			popt += 1;
918 		} else {
919 			/* Scan through all options */
920 			popt += *(popt + 1) + 2;
921 		}
922 	}
923 	return -1;
924 }
925 
926 static void dhcp_send_request_packet(struct bootp_hdr *bp_offer)
927 {
928 	uchar *pkt, *iphdr;
929 	struct bootp_hdr *bp;
930 	int pktlen, iplen, extlen;
931 	int eth_hdr_size;
932 	struct in_addr offered_ip;
933 	struct in_addr zero_ip;
934 	struct in_addr bcast_ip;
935 
936 	debug("dhcp_send_request_packet: Sending DHCPREQUEST\n");
937 	pkt = net_tx_packet;
938 	memset((void *)pkt, 0, PKTSIZE);
939 
940 	eth_hdr_size = net_set_ether(pkt, net_bcast_ethaddr, PROT_IP);
941 	pkt += eth_hdr_size;
942 
943 	iphdr = pkt;	/* We'll need this later to set proper pkt size */
944 	pkt += IP_UDP_HDR_SIZE;
945 
946 	bp = (struct bootp_hdr *)pkt;
947 	bp->bp_op = OP_BOOTREQUEST;
948 	bp->bp_htype = HWT_ETHER;
949 	bp->bp_hlen = HWL_ETHER;
950 	bp->bp_hops = 0;
951 	bp->bp_secs = htons(get_timer(bootp_start) / 1000);
952 	/* Do not set the client IP, your IP, or server IP yet, since it
953 	 * hasn't been ACK'ed by the server yet */
954 
955 	/*
956 	 * RFC3046 requires Relay Agents to discard packets with
957 	 * nonzero and offered giaddr
958 	 */
959 	zero_ip.s_addr = 0;
960 	net_write_ip(&bp->bp_giaddr, zero_ip);
961 
962 	memcpy(bp->bp_chaddr, net_ethaddr, 6);
963 	copy_filename(bp->bp_file, net_boot_file_name, sizeof(bp->bp_file));
964 
965 	/*
966 	 * ID is the id of the OFFER packet
967 	 */
968 
969 	net_copy_u32(&bp->bp_id, &bp_offer->bp_id);
970 
971 	/*
972 	 * Copy options from OFFER packet if present
973 	 */
974 
975 	/* Copy offered IP into the parameters request list */
976 	net_copy_ip(&offered_ip, &bp_offer->bp_yiaddr);
977 	extlen = dhcp_extended((u8 *)bp->bp_vend, DHCP_REQUEST,
978 		dhcp_server_ip, offered_ip);
979 
980 	iplen = BOOTP_HDR_SIZE - OPT_FIELD_SIZE + extlen;
981 	pktlen = eth_hdr_size + IP_UDP_HDR_SIZE + iplen;
982 	bcast_ip.s_addr = 0xFFFFFFFFL;
983 	net_set_udp_header(iphdr, bcast_ip, PORT_BOOTPS, PORT_BOOTPC, iplen);
984 
985 #ifdef CONFIG_BOOTP_DHCP_REQUEST_DELAY
986 	udelay(CONFIG_BOOTP_DHCP_REQUEST_DELAY);
987 #endif	/* CONFIG_BOOTP_DHCP_REQUEST_DELAY */
988 	debug("Transmitting DHCPREQUEST packet: len = %d\n", pktlen);
989 	net_send_packet(net_tx_packet, pktlen);
990 }
991 
992 /*
993  *	Handle DHCP received packets.
994  */
995 static void dhcp_handler(uchar *pkt, unsigned dest, struct in_addr sip,
996 			 unsigned src, unsigned len)
997 {
998 	struct bootp_hdr *bp = (struct bootp_hdr *)pkt;
999 
1000 	debug("DHCPHandler: got packet: (src=%d, dst=%d, len=%d) state: %d\n",
1001 	      src, dest, len, dhcp_state);
1002 
1003 	/* Filter out pkts we don't want */
1004 	if (check_reply_packet(pkt, dest, src, len))
1005 		return;
1006 
1007 	debug("DHCPHandler: got DHCP packet: (src=%d, dst=%d, len=%d) state: "
1008 	      "%d\n", src, dest, len, dhcp_state);
1009 
1010 	if (net_read_ip(&bp->bp_yiaddr).s_addr == 0)
1011 		return;
1012 
1013 	switch (dhcp_state) {
1014 	case SELECTING:
1015 		/*
1016 		 * Wait an appropriate time for any potential DHCPOFFER packets
1017 		 * to arrive.  Then select one, and generate DHCPREQUEST
1018 		 * response.  If filename is in format we recognize, assume it
1019 		 * is a valid OFFER from a server we want.
1020 		 */
1021 		debug("DHCP: state=SELECTING bp_file: \"%s\"\n", bp->bp_file);
1022 #ifdef CONFIG_SYS_BOOTFILE_PREFIX
1023 		if (strncmp(bp->bp_file,
1024 			    CONFIG_SYS_BOOTFILE_PREFIX,
1025 			    strlen(CONFIG_SYS_BOOTFILE_PREFIX)) == 0) {
1026 #endif	/* CONFIG_SYS_BOOTFILE_PREFIX */
1027 			dhcp_packet_process_options(bp);
1028 
1029 			debug("TRANSITIONING TO REQUESTING STATE\n");
1030 			dhcp_state = REQUESTING;
1031 
1032 			net_set_timeout_handler(5000, bootp_timeout_handler);
1033 			dhcp_send_request_packet(bp);
1034 #ifdef CONFIG_SYS_BOOTFILE_PREFIX
1035 		}
1036 #endif	/* CONFIG_SYS_BOOTFILE_PREFIX */
1037 
1038 		return;
1039 		break;
1040 	case REQUESTING:
1041 		debug("DHCP State: REQUESTING\n");
1042 
1043 		if (dhcp_message_type((u8 *)bp->bp_vend) == DHCP_ACK) {
1044 			dhcp_packet_process_options(bp);
1045 			/* Store net params from reply */
1046 			store_net_params(bp);
1047 			dhcp_state = BOUND;
1048 			printf("DHCP client bound to address %pI4 (%lu ms)\n",
1049 			       &net_ip, get_timer(bootp_start));
1050 			net_set_timeout_handler(0, (thand_f *)0);
1051 			bootstage_mark_name(BOOTSTAGE_ID_BOOTP_STOP,
1052 					    "bootp_stop");
1053 
1054 			net_auto_load();
1055 			return;
1056 		}
1057 		break;
1058 	case BOUND:
1059 		/* DHCP client bound to address */
1060 		break;
1061 	default:
1062 		puts("DHCP: INVALID STATE\n");
1063 		break;
1064 	}
1065 }
1066 
1067 void dhcp_request(void)
1068 {
1069 	bootp_request();
1070 }
1071 #endif	/* CONFIG_CMD_DHCP */
1072