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