1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2010-2011 Calxeda, Inc.
4 * Copyright (c) 2014, NVIDIA CORPORATION. All rights reserved.
11 #include <linux/string.h>
12 #include <linux/ctype.h>
14 #include <linux/list.h>
21 #define MAX_TFTP_PATH_LEN 127
23 const char *pxe_default_paths[] = {
25 "default-" CONFIG_SYS_ARCH "-" CONFIG_SYS_SOC,
27 "default-" CONFIG_SYS_ARCH,
35 * Like env_get, but prints an error if envvar isn't defined in the
36 * environment. It always returns what env_get does, so it can be used in
37 * place of env_get without changing error handling otherwise.
39 static char *from_env(const char *envvar)
43 ret = env_get(envvar);
46 printf("missing environment variable: %s\n", envvar);
53 * Convert an ethaddr from the environment to the format used by pxelinux
54 * filenames based on mac addresses. Convert's ':' to '-', and adds "01-" to
55 * the beginning of the ethernet address to indicate a hardware type of
56 * Ethernet. Also converts uppercase hex characters into lowercase, to match
57 * pxelinux's behavior.
59 * Returns 1 for success, -ENOENT if 'ethaddr' is undefined in the
60 * environment, or some other value < 0 on error.
62 static int format_mac_pxe(char *outbuf, size_t outbuf_len)
66 if (outbuf_len < 21) {
67 printf("outbuf is too small (%zd < 21)\n", outbuf_len);
72 if (!eth_env_get_enetaddr_by_index("eth", eth_get_dev_index(), ethaddr))
75 sprintf(outbuf, "01-%02x-%02x-%02x-%02x-%02x-%02x",
76 ethaddr[0], ethaddr[1], ethaddr[2],
77 ethaddr[3], ethaddr[4], ethaddr[5]);
84 * Returns the directory the file specified in the bootfile env variable is
85 * in. If bootfile isn't defined in the environment, return NULL, which should
86 * be interpreted as "don't prepend anything to paths".
88 static int get_bootfile_path(const char *file_path, char *bootfile_path,
89 size_t bootfile_path_size)
91 char *bootfile, *last_slash;
94 /* Only syslinux allows absolute paths */
95 if (file_path[0] == '/' && !is_pxe)
98 bootfile = from_env("bootfile");
103 last_slash = strrchr(bootfile, '/');
105 if (last_slash == NULL)
108 path_len = (last_slash - bootfile) + 1;
110 if (bootfile_path_size < path_len) {
111 printf("bootfile_path too small. (%zd < %zd)\n",
112 bootfile_path_size, path_len);
117 strncpy(bootfile_path, bootfile, path_len);
120 bootfile_path[path_len] = '\0';
125 static int (*do_getfile)(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr);
127 #ifdef CONFIG_CMD_NET
128 static int do_get_tftp(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
130 char *tftp_argv[] = {"tftp", NULL, NULL, NULL};
132 tftp_argv[1] = file_addr;
133 tftp_argv[2] = (void *)file_path;
135 if (do_tftpb(cmdtp, 0, 3, tftp_argv))
142 static char *fs_argv[5];
144 static int do_get_ext2(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
146 #ifdef CONFIG_CMD_EXT2
147 fs_argv[0] = "ext2load";
148 fs_argv[3] = file_addr;
149 fs_argv[4] = (void *)file_path;
151 if (!do_ext2load(cmdtp, 0, 5, fs_argv))
157 static int do_get_fat(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
159 #ifdef CONFIG_CMD_FAT
160 fs_argv[0] = "fatload";
161 fs_argv[3] = file_addr;
162 fs_argv[4] = (void *)file_path;
164 if (!do_fat_fsload(cmdtp, 0, 5, fs_argv))
170 static int do_get_any(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
172 #ifdef CONFIG_CMD_FS_GENERIC
174 fs_argv[3] = file_addr;
175 fs_argv[4] = (void *)file_path;
177 if (!do_load(cmdtp, 0, 5, fs_argv, FS_TYPE_ANY))
184 * As in pxelinux, paths to files referenced from files we retrieve are
185 * relative to the location of bootfile. get_relfile takes such a path and
186 * joins it with the bootfile path to get the full path to the target file. If
187 * the bootfile path is NULL, we use file_path as is.
189 * Returns 1 for success, or < 0 on error.
191 static int get_relfile(cmd_tbl_t *cmdtp, const char *file_path,
192 unsigned long file_addr)
195 char relfile[MAX_TFTP_PATH_LEN+1];
199 err = get_bootfile_path(file_path, relfile, sizeof(relfile));
204 path_len = strlen(file_path);
205 path_len += strlen(relfile);
207 if (path_len > MAX_TFTP_PATH_LEN) {
208 printf("Base path too long (%s%s)\n",
212 return -ENAMETOOLONG;
215 strcat(relfile, file_path);
217 printf("Retrieving file: %s\n", relfile);
219 sprintf(addr_buf, "%lx", file_addr);
221 return do_getfile(cmdtp, relfile, addr_buf);
225 * Retrieve the file at 'file_path' to the locate given by 'file_addr'. If
226 * 'bootfile' was specified in the environment, the path to bootfile will be
227 * prepended to 'file_path' and the resulting path will be used.
229 * Returns 1 on success, or < 0 for error.
231 static int get_pxe_file(cmd_tbl_t *cmdtp, const char *file_path,
232 unsigned long file_addr)
234 unsigned long config_file_size;
239 err = get_relfile(cmdtp, file_path, file_addr);
245 * the file comes without a NUL byte at the end, so find out its size
246 * and add the NUL byte.
248 tftp_filesize = from_env("filesize");
253 if (strict_strtoul(tftp_filesize, 16, &config_file_size) < 0)
256 buf = map_sysmem(file_addr + config_file_size, 1);
263 #ifdef CONFIG_CMD_NET
265 #define PXELINUX_DIR "pxelinux.cfg/"
268 * Retrieves a file in the 'pxelinux.cfg' folder. Since this uses get_pxe_file
269 * to do the hard work, the location of the 'pxelinux.cfg' folder is generated
270 * from the bootfile path, as described above.
272 * Returns 1 on success or < 0 on error.
274 static int get_pxelinux_path(cmd_tbl_t *cmdtp, const char *file,
275 unsigned long pxefile_addr_r)
277 size_t base_len = strlen(PXELINUX_DIR);
278 char path[MAX_TFTP_PATH_LEN+1];
280 if (base_len + strlen(file) > MAX_TFTP_PATH_LEN) {
281 printf("path (%s%s) too long, skipping\n",
283 return -ENAMETOOLONG;
286 sprintf(path, PXELINUX_DIR "%s", file);
288 return get_pxe_file(cmdtp, path, pxefile_addr_r);
292 * Looks for a pxe file with a name based on the pxeuuid environment variable.
294 * Returns 1 on success or < 0 on error.
296 static int pxe_uuid_path(cmd_tbl_t *cmdtp, unsigned long pxefile_addr_r)
300 uuid_str = from_env("pxeuuid");
305 return get_pxelinux_path(cmdtp, uuid_str, pxefile_addr_r);
309 * Looks for a pxe file with a name based on the 'ethaddr' environment
312 * Returns 1 on success or < 0 on error.
314 static int pxe_mac_path(cmd_tbl_t *cmdtp, unsigned long pxefile_addr_r)
319 err = format_mac_pxe(mac_str, sizeof(mac_str));
324 return get_pxelinux_path(cmdtp, mac_str, pxefile_addr_r);
328 * Looks for pxe files with names based on our IP address. See pxelinux
329 * documentation for details on what these file names look like. We match
332 * Returns 1 on success or < 0 on error.
334 static int pxe_ipaddr_paths(cmd_tbl_t *cmdtp, unsigned long pxefile_addr_r)
339 sprintf(ip_addr, "%08X", ntohl(net_ip.s_addr));
341 for (mask_pos = 7; mask_pos >= 0; mask_pos--) {
342 err = get_pxelinux_path(cmdtp, ip_addr, pxefile_addr_r);
347 ip_addr[mask_pos] = '\0';
354 * Entry point for the 'pxe get' command.
355 * This Follows pxelinux's rules to download a config file from a tftp server.
356 * The file is stored at the location given by the pxefile_addr_r environment
357 * variable, which must be set.
359 * UUID comes from pxeuuid env variable, if defined
360 * MAC addr comes from ethaddr env variable, if defined
363 * see http://syslinux.zytor.com/wiki/index.php/PXELINUX
365 * Returns 0 on success or 1 on error.
368 do_pxe_get(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
370 char *pxefile_addr_str;
371 unsigned long pxefile_addr_r;
374 do_getfile = do_get_tftp;
377 return CMD_RET_USAGE;
379 pxefile_addr_str = from_env("pxefile_addr_r");
381 if (!pxefile_addr_str)
384 err = strict_strtoul(pxefile_addr_str, 16,
385 (unsigned long *)&pxefile_addr_r);
390 * Keep trying paths until we successfully get a file we're looking
393 if (pxe_uuid_path(cmdtp, pxefile_addr_r) > 0 ||
394 pxe_mac_path(cmdtp, pxefile_addr_r) > 0 ||
395 pxe_ipaddr_paths(cmdtp, pxefile_addr_r) > 0) {
396 printf("Config file found\n");
401 while (pxe_default_paths[i]) {
402 if (get_pxelinux_path(cmdtp, pxe_default_paths[i],
403 pxefile_addr_r) > 0) {
404 printf("Config file found\n");
410 printf("Config file not found\n");
417 * Wrapper to make it easier to store the file at file_path in the location
418 * specified by envaddr_name. file_path will be joined to the bootfile path,
419 * if any is specified.
421 * Returns 1 on success or < 0 on error.
423 static int get_relfile_envaddr(cmd_tbl_t *cmdtp, const char *file_path, const char *envaddr_name)
425 unsigned long file_addr;
428 envaddr = from_env(envaddr_name);
433 if (strict_strtoul(envaddr, 16, &file_addr) < 0)
436 return get_relfile(cmdtp, file_path, file_addr);
440 * A note on the pxe file parser.
442 * We're parsing files that use syslinux grammar, which has a few quirks.
443 * String literals must be recognized based on context - there is no
444 * quoting or escaping support. There's also nothing to explicitly indicate
445 * when a label section completes. We deal with that by ending a label
446 * section whenever we see a line that doesn't include.
448 * As with the syslinux family, this same file format could be reused in the
449 * future for non pxe purposes. The only action it takes during parsing that
450 * would throw this off is handling of include files. It assumes we're using
451 * pxe, and does a tftp download of a file listed as an include file in the
452 * middle of the parsing operation. That could be handled by refactoring it to
453 * take a 'include file getter' function.
457 * Describes a single label given in a pxe file.
459 * Create these with the 'label_create' function given below.
461 * name - the name of the menu as given on the 'menu label' line.
462 * kernel - the path to the kernel file to use for this label.
463 * append - kernel command line to use when booting this label
464 * initrd - path to the initrd to use for this label.
465 * attempted - 0 if we haven't tried to boot this label, 1 if we have.
466 * localboot - 1 if this label specified 'localboot', 0 otherwise.
467 * list - lets these form a list, which a pxe_menu struct will hold.
483 struct list_head list;
487 * Describes a pxe menu as given via pxe files.
489 * title - the name of the menu as given by a 'menu title' line.
490 * default_label - the name of the default label, if any.
491 * timeout - time in tenths of a second to wait for a user key-press before
492 * booting the default label.
493 * prompt - if 0, don't prompt for a choice unless the timeout period is
494 * interrupted. If 1, always prompt for a choice regardless of
496 * labels - a list of labels defined for the menu.
503 struct list_head labels;
507 * Allocates memory for and initializes a pxe_label. This uses malloc, so the
508 * result must be free()'d to reclaim the memory.
510 * Returns NULL if malloc fails.
512 static struct pxe_label *label_create(void)
514 struct pxe_label *label;
516 label = malloc(sizeof(struct pxe_label));
521 memset(label, 0, sizeof(struct pxe_label));
527 * Free the memory used by a pxe_label, including that used by its name,
528 * kernel, append and initrd members, if they're non NULL.
530 * So - be sure to only use dynamically allocated memory for the members of
531 * the pxe_label struct, unless you want to clean it up first. These are
532 * currently only created by the pxe file parsing code.
534 static void label_destroy(struct pxe_label *label)
561 * Print a label and its string members if they're defined.
563 * This is passed as a callback to the menu code for displaying each
566 static void label_print(void *data)
568 struct pxe_label *label = data;
569 const char *c = label->menu ? label->menu : label->name;
571 printf("%s:\t%s\n", label->num, c);
575 * Boot a label that specified 'localboot'. This requires that the 'localcmd'
576 * environment variable is defined. Its contents will be executed as U-Boot
577 * command. If the label specified an 'append' line, its contents will be
578 * used to overwrite the contents of the 'bootargs' environment variable prior
579 * to running 'localcmd'.
581 * Returns 1 on success or < 0 on error.
583 static int label_localboot(struct pxe_label *label)
587 localcmd = from_env("localcmd");
593 char bootargs[CONFIG_SYS_CBSIZE];
595 cli_simple_process_macros(label->append, bootargs);
596 env_set("bootargs", bootargs);
599 debug("running: %s\n", localcmd);
601 return run_command_list(localcmd, strlen(localcmd), 0);
605 * Boot according to the contents of a pxe_label.
607 * If we can't boot for any reason, we return. A successful boot never
610 * The kernel will be stored in the location given by the 'kernel_addr_r'
611 * environment variable.
613 * If the label specifies an initrd file, it will be stored in the location
614 * given by the 'ramdisk_addr_r' environment variable.
616 * If the label specifies an 'append' line, its contents will overwrite that
617 * of the 'bootargs' environment variable.
619 static int label_boot(cmd_tbl_t *cmdtp, struct pxe_label *label)
621 char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL };
623 char mac_str[29] = "";
624 char ip_str[68] = "";
625 char *fit_addr = NULL;
633 label->attempted = 1;
635 if (label->localboot) {
636 if (label->localboot_val >= 0)
637 label_localboot(label);
641 if (label->kernel == NULL) {
642 printf("No kernel given, skipping %s\n",
648 if (get_relfile_envaddr(cmdtp, label->initrd, "ramdisk_addr_r") < 0) {
649 printf("Skipping %s for failure retrieving initrd\n",
654 bootm_argv[2] = initrd_str;
655 strncpy(bootm_argv[2], env_get("ramdisk_addr_r"), 18);
656 strcat(bootm_argv[2], ":");
657 strncat(bootm_argv[2], env_get("filesize"), 9);
660 if (get_relfile_envaddr(cmdtp, label->kernel, "kernel_addr_r") < 0) {
661 printf("Skipping %s for failure retrieving kernel\n",
666 if (label->ipappend & 0x1) {
667 sprintf(ip_str, " ip=%s:%s:%s:%s",
668 env_get("ipaddr"), env_get("serverip"),
669 env_get("gatewayip"), env_get("netmask"));
672 #ifdef CONFIG_CMD_NET
673 if (label->ipappend & 0x2) {
675 strcpy(mac_str, " BOOTIF=");
676 err = format_mac_pxe(mac_str + 8, sizeof(mac_str) - 8);
682 if ((label->ipappend & 0x3) || label->append) {
683 char bootargs[CONFIG_SYS_CBSIZE] = "";
684 char finalbootargs[CONFIG_SYS_CBSIZE];
686 if (strlen(label->append ?: "") +
687 strlen(ip_str) + strlen(mac_str) + 1 > sizeof(bootargs)) {
688 printf("bootarg overflow %zd+%zd+%zd+1 > %zd\n",
689 strlen(label->append ?: ""),
690 strlen(ip_str), strlen(mac_str),
695 strncpy(bootargs, label->append,
697 strcat(bootargs, ip_str);
698 strcat(bootargs, mac_str);
700 cli_simple_process_macros(bootargs, finalbootargs);
701 env_set("bootargs", finalbootargs);
702 printf("append: %s\n", finalbootargs);
706 bootm_argv[1] = env_get("kernel_addr_r");
707 /* for FIT, append the configuration identifier */
709 int len = strlen(bootm_argv[1]) + strlen(label->config) + 1;
711 fit_addr = malloc(len);
713 printf("malloc fail (FIT address)\n");
716 snprintf(fit_addr, len, "%s%s", bootm_argv[1], label->config);
717 bootm_argv[1] = fit_addr;
721 * fdt usage is optional:
722 * It handles the following scenarios. All scenarios are exclusive
724 * Scenario 1: If fdt_addr_r specified and "fdt" label is defined in
725 * pxe file, retrieve fdt blob from server. Pass fdt_addr_r to bootm,
726 * and adjust argc appropriately.
728 * Scenario 2: If there is an fdt_addr specified, pass it along to
729 * bootm, and adjust argc appropriately.
731 * Scenario 3: fdt blob is not available.
733 bootm_argv[3] = env_get("fdt_addr_r");
735 /* if fdt label is defined then get fdt from server */
737 char *fdtfile = NULL;
738 char *fdtfilefree = NULL;
741 fdtfile = label->fdt;
742 } else if (label->fdtdir) {
743 char *f1, *f2, *f3, *f4, *slash;
745 f1 = env_get("fdtfile");
752 * For complex cases where this code doesn't
753 * generate the correct filename, the board
754 * code should set $fdtfile during early boot,
755 * or the boot scripts should set $fdtfile
756 * before invoking "pxe" or "sysboot".
760 f3 = env_get("board");
764 len = strlen(label->fdtdir);
767 else if (label->fdtdir[len - 1] != '/')
772 len = strlen(label->fdtdir) + strlen(slash) +
773 strlen(f1) + strlen(f2) + strlen(f3) +
775 fdtfilefree = malloc(len);
777 printf("malloc fail (FDT filename)\n");
781 snprintf(fdtfilefree, len, "%s%s%s%s%s%s",
782 label->fdtdir, slash, f1, f2, f3, f4);
783 fdtfile = fdtfilefree;
787 int err = get_relfile_envaddr(cmdtp, fdtfile, "fdt_addr_r");
790 printf("Skipping %s for failure retrieving fdt\n",
795 bootm_argv[3] = NULL;
800 bootm_argv[3] = env_get("fdt_addr");
808 kernel_addr = genimg_get_kernel_addr(bootm_argv[1]);
809 buf = map_sysmem(kernel_addr, 0);
810 /* Try bootm for legacy and FIT format image */
811 if (genimg_get_format(buf) != IMAGE_FORMAT_INVALID)
812 do_bootm(cmdtp, 0, bootm_argc, bootm_argv);
813 #ifdef CONFIG_CMD_BOOTI
814 /* Try booting an AArch64 Linux kernel image */
816 do_booti(cmdtp, 0, bootm_argc, bootm_argv);
817 #elif defined(CONFIG_CMD_BOOTZ)
818 /* Try booting a Image */
820 do_bootz(cmdtp, 0, bootm_argc, bootm_argv);
831 * Tokens for the pxe file parser.
857 * A token - given by a value and a type.
861 enum token_type type;
865 * Keywords recognized.
867 static const struct token keywords[] = {
870 {"timeout", T_TIMEOUT},
871 {"default", T_DEFAULT},
872 {"prompt", T_PROMPT},
874 {"kernel", T_KERNEL},
876 {"localboot", T_LOCALBOOT},
877 {"append", T_APPEND},
878 {"initrd", T_INITRD},
879 {"include", T_INCLUDE},
880 {"devicetree", T_FDT},
882 {"devicetreedir", T_FDTDIR},
883 {"fdtdir", T_FDTDIR},
884 {"ontimeout", T_ONTIMEOUT,},
885 {"ipappend", T_IPAPPEND,},
890 * Since pxe(linux) files don't have a token to identify the start of a
891 * literal, we have to keep track of when we're in a state where a literal is
892 * expected vs when we're in a state a keyword is expected.
901 * get_string retrieves a string from *p and stores it as a token in
904 * get_string used for scanning both string literals and keywords.
906 * Characters from *p are copied into t-val until a character equal to
907 * delim is found, or a NUL byte is reached. If delim has the special value of
908 * ' ', any whitespace character will be used as a delimiter.
910 * If lower is unequal to 0, uppercase characters will be converted to
911 * lowercase in the result. This is useful to make keywords case
914 * The location of *p is updated to point to the first character after the end
915 * of the token - the ending delimiter.
917 * On success, the new value of t->val is returned. Memory for t->val is
918 * allocated using malloc and must be free()'d to reclaim it. If insufficient
919 * memory is available, NULL is returned.
921 static char *get_string(char **p, struct token *t, char delim, int lower)
927 * b and e both start at the beginning of the input stream.
929 * e is incremented until we find the ending delimiter, or a NUL byte
930 * is reached. Then, we take e - b to find the length of the token.
935 if ((delim == ' ' && isspace(*e)) || delim == *e)
943 * Allocate memory to hold the string, and copy it in, converting
944 * characters to lowercase if lower is != 0.
946 t->val = malloc(len + 1);
950 for (i = 0; i < len; i++, b++) {
952 t->val[i] = tolower(*b);
960 * Update *p so the caller knows where to continue scanning.
970 * Populate a keyword token with a type and value.
972 static void get_keyword(struct token *t)
976 for (i = 0; keywords[i].val; i++) {
977 if (!strcmp(t->val, keywords[i].val)) {
978 t->type = keywords[i].type;
985 * Get the next token. We have to keep track of which state we're in to know
986 * if we're looking to get a string literal or a keyword.
988 * *p is updated to point at the first character after the current token.
990 static void get_token(char **p, struct token *t, enum lex_state state)
996 /* eat non EOL whitespace */
1001 * eat comments. note that string literals can't begin with #, but
1002 * can contain a # after their first character.
1005 while (*c && *c != '\n')
1012 } else if (*c == '\0') {
1015 } else if (state == L_SLITERAL) {
1016 get_string(&c, t, '\n', 0);
1017 } else if (state == L_KEYWORD) {
1019 * when we expect a keyword, we first get the next string
1020 * token delimited by whitespace, and then check if it
1021 * matches a keyword in our keyword list. if it does, it's
1022 * converted to a keyword token of the appropriate type, and
1023 * if not, it remains a string token.
1025 get_string(&c, t, ' ', 1);
1033 * Increment *c until we get to the end of the current line, or EOF.
1035 static void eol_or_eof(char **c)
1037 while (**c && **c != '\n')
1042 * All of these parse_* functions share some common behavior.
1044 * They finish with *c pointing after the token they parse, and return 1 on
1045 * success, or < 0 on error.
1049 * Parse a string literal and store a pointer it at *dst. String literals
1050 * terminate at the end of the line.
1052 static int parse_sliteral(char **c, char **dst)
1057 get_token(c, &t, L_SLITERAL);
1059 if (t.type != T_STRING) {
1060 printf("Expected string literal: %.*s\n", (int)(*c - s), s);
1070 * Parse a base 10 (unsigned) integer and store it at *dst.
1072 static int parse_integer(char **c, int *dst)
1077 get_token(c, &t, L_SLITERAL);
1079 if (t.type != T_STRING) {
1080 printf("Expected string: %.*s\n", (int)(*c - s), s);
1084 *dst = simple_strtol(t.val, NULL, 10);
1091 static int parse_pxefile_top(cmd_tbl_t *cmdtp, char *p, unsigned long base,
1092 struct pxe_menu *cfg, int nest_level);
1095 * Parse an include statement, and retrieve and parse the file it mentions.
1097 * base should point to a location where it's safe to store the file, and
1098 * nest_level should indicate how many nested includes have occurred. For this
1099 * include, nest_level has already been incremented and doesn't need to be
1102 static int handle_include(cmd_tbl_t *cmdtp, char **c, unsigned long base,
1103 struct pxe_menu *cfg, int nest_level)
1111 err = parse_sliteral(c, &include_path);
1114 printf("Expected include path: %.*s\n",
1119 err = get_pxe_file(cmdtp, include_path, base);
1122 printf("Couldn't retrieve %s\n", include_path);
1126 buf = map_sysmem(base, 0);
1127 ret = parse_pxefile_top(cmdtp, buf, base, cfg, nest_level);
1134 * Parse lines that begin with 'menu'.
1136 * base and nest are provided to handle the 'menu include' case.
1138 * base should point to a location where it's safe to store the included file.
1140 * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
1141 * a file it includes, 3 when parsing a file included by that file, and so on.
1143 static int parse_menu(cmd_tbl_t *cmdtp, char **c, struct pxe_menu *cfg,
1144 unsigned long base, int nest_level)
1150 get_token(c, &t, L_KEYWORD);
1154 err = parse_sliteral(c, &cfg->title);
1159 err = handle_include(cmdtp, c, base, cfg,
1164 printf("Ignoring malformed menu command: %.*s\n",
1177 * Handles parsing a 'menu line' when we're parsing a label.
1179 static int parse_label_menu(char **c, struct pxe_menu *cfg,
1180 struct pxe_label *label)
1187 get_token(c, &t, L_KEYWORD);
1191 if (!cfg->default_label)
1192 cfg->default_label = strdup(label->name);
1194 if (!cfg->default_label)
1199 parse_sliteral(c, &label->menu);
1202 printf("Ignoring malformed menu command: %.*s\n",
1212 * Handles parsing a 'kernel' label.
1213 * expecting "filename" or "<fit_filename>#cfg"
1215 static int parse_label_kernel(char **c, struct pxe_label *label)
1220 err = parse_sliteral(c, &label->kernel);
1224 s = strstr(label->kernel, "#");
1228 label->config = malloc(strlen(s) + 1);
1232 strcpy(label->config, s);
1239 * Parses a label and adds it to the list of labels for a menu.
1241 * A label ends when we either get to the end of a file, or
1242 * get some input we otherwise don't have a handler defined
1246 static int parse_label(char **c, struct pxe_menu *cfg)
1251 struct pxe_label *label;
1254 label = label_create();
1258 err = parse_sliteral(c, &label->name);
1260 printf("Expected label name: %.*s\n", (int)(*c - s), s);
1261 label_destroy(label);
1265 list_add_tail(&label->list, &cfg->labels);
1269 get_token(c, &t, L_KEYWORD);
1274 err = parse_label_menu(c, cfg, label);
1279 err = parse_label_kernel(c, label);
1283 err = parse_sliteral(c, &label->append);
1286 s = strstr(label->append, "initrd=");
1290 len = (int)(strchr(s, ' ') - s);
1291 label->initrd = malloc(len + 1);
1292 strncpy(label->initrd, s, len);
1293 label->initrd[len] = '\0';
1299 err = parse_sliteral(c, &label->initrd);
1304 err = parse_sliteral(c, &label->fdt);
1309 err = parse_sliteral(c, &label->fdtdir);
1313 label->localboot = 1;
1314 err = parse_integer(c, &label->localboot_val);
1318 err = parse_integer(c, &label->ipappend);
1326 * put the token back! we don't want it - it's the end
1327 * of a label and whatever token this is, it's
1328 * something for the menu level context to handle.
1340 * This 16 comes from the limit pxelinux imposes on nested includes.
1342 * There is no reason at all we couldn't do more, but some limit helps prevent
1343 * infinite (until crash occurs) recursion if a file tries to include itself.
1345 #define MAX_NEST_LEVEL 16
1348 * Entry point for parsing a menu file. nest_level indicates how many times
1349 * we've nested in includes. It will be 1 for the top level menu file.
1351 * Returns 1 on success, < 0 on error.
1353 static int parse_pxefile_top(cmd_tbl_t *cmdtp, char *p, unsigned long base,
1354 struct pxe_menu *cfg, int nest_level)
1357 char *s, *b, *label_name;
1362 if (nest_level > MAX_NEST_LEVEL) {
1363 printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL);
1370 get_token(&p, &t, L_KEYWORD);
1376 err = parse_menu(cmdtp, &p, cfg,
1377 base + ALIGN(strlen(b) + 1, 4),
1382 err = parse_integer(&p, &cfg->timeout);
1386 err = parse_label(&p, cfg);
1391 err = parse_sliteral(&p, &label_name);
1394 if (cfg->default_label)
1395 free(cfg->default_label);
1397 cfg->default_label = label_name;
1403 err = handle_include(cmdtp, &p,
1404 base + ALIGN(strlen(b), 4), cfg,
1419 printf("Ignoring unknown command: %.*s\n",
1430 * Free the memory used by a pxe_menu and its labels.
1432 static void destroy_pxe_menu(struct pxe_menu *cfg)
1434 struct list_head *pos, *n;
1435 struct pxe_label *label;
1440 if (cfg->default_label)
1441 free(cfg->default_label);
1443 list_for_each_safe(pos, n, &cfg->labels) {
1444 label = list_entry(pos, struct pxe_label, list);
1446 label_destroy(label);
1453 * Entry point for parsing a pxe file. This is only used for the top level
1456 * Returns NULL if there is an error, otherwise, returns a pointer to a
1457 * pxe_menu struct populated with the results of parsing the pxe file (and any
1458 * files it includes). The resulting pxe_menu struct can be free()'d by using
1459 * the destroy_pxe_menu() function.
1461 static struct pxe_menu *parse_pxefile(cmd_tbl_t *cmdtp, unsigned long menucfg)
1463 struct pxe_menu *cfg;
1467 cfg = malloc(sizeof(struct pxe_menu));
1472 memset(cfg, 0, sizeof(struct pxe_menu));
1474 INIT_LIST_HEAD(&cfg->labels);
1476 buf = map_sysmem(menucfg, 0);
1477 r = parse_pxefile_top(cmdtp, buf, menucfg, cfg, 1);
1481 destroy_pxe_menu(cfg);
1489 * Converts a pxe_menu struct into a menu struct for use with U-Boot's generic
1492 static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
1494 struct pxe_label *label;
1495 struct list_head *pos;
1499 char *default_num = NULL;
1502 * Create a menu and add items for all the labels.
1504 m = menu_create(cfg->title, DIV_ROUND_UP(cfg->timeout, 10),
1505 cfg->prompt, label_print, NULL, NULL);
1510 list_for_each(pos, &cfg->labels) {
1511 label = list_entry(pos, struct pxe_label, list);
1513 sprintf(label->num, "%d", i++);
1514 if (menu_item_add(m, label->num, label) != 1) {
1518 if (cfg->default_label &&
1519 (strcmp(label->name, cfg->default_label) == 0))
1520 default_num = label->num;
1525 * After we've created items for each label in the menu, set the
1526 * menu's default label if one was specified.
1529 err = menu_default_set(m, default_num);
1531 if (err != -ENOENT) {
1536 printf("Missing default: %s\n", cfg->default_label);
1544 * Try to boot any labels we have yet to attempt to boot.
1546 static void boot_unattempted_labels(cmd_tbl_t *cmdtp, struct pxe_menu *cfg)
1548 struct list_head *pos;
1549 struct pxe_label *label;
1551 list_for_each(pos, &cfg->labels) {
1552 label = list_entry(pos, struct pxe_label, list);
1554 if (!label->attempted)
1555 label_boot(cmdtp, label);
1560 * Boot the system as prescribed by a pxe_menu.
1562 * Use the menu system to either get the user's choice or the default, based
1563 * on config or user input. If there is no default or user's choice,
1564 * attempted to boot labels in the order they were given in pxe files.
1565 * If the default or user's choice fails to boot, attempt to boot other
1566 * labels in the order they were given in pxe files.
1568 * If this function returns, there weren't any labels that successfully
1569 * booted, or the user interrupted the menu selection via ctrl+c.
1571 static void handle_pxe_menu(cmd_tbl_t *cmdtp, struct pxe_menu *cfg)
1577 m = pxe_menu_to_menu(cfg);
1581 err = menu_get_choice(m, &choice);
1586 * err == 1 means we got a choice back from menu_get_choice.
1588 * err == -ENOENT if the menu was setup to select the default but no
1589 * default was set. in that case, we should continue trying to boot
1590 * labels that haven't been attempted yet.
1592 * otherwise, the user interrupted or there was some other error and
1597 err = label_boot(cmdtp, choice);
1600 } else if (err != -ENOENT) {
1604 boot_unattempted_labels(cmdtp, cfg);
1607 #ifdef CONFIG_CMD_NET
1609 * Boots a system using a pxe file
1611 * Returns 0 on success, 1 on error.
1614 do_pxe_boot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1616 unsigned long pxefile_addr_r;
1617 struct pxe_menu *cfg;
1618 char *pxefile_addr_str;
1620 do_getfile = do_get_tftp;
1623 pxefile_addr_str = from_env("pxefile_addr_r");
1624 if (!pxefile_addr_str)
1627 } else if (argc == 2) {
1628 pxefile_addr_str = argv[1];
1630 return CMD_RET_USAGE;
1633 if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
1634 printf("Invalid pxefile address: %s\n", pxefile_addr_str);
1638 cfg = parse_pxefile(cmdtp, pxefile_addr_r);
1641 printf("Error parsing config file\n");
1645 handle_pxe_menu(cmdtp, cfg);
1647 destroy_pxe_menu(cfg);
1649 copy_filename(net_boot_file_name, "", sizeof(net_boot_file_name));
1654 static cmd_tbl_t cmd_pxe_sub[] = {
1655 U_BOOT_CMD_MKENT(get, 1, 1, do_pxe_get, "", ""),
1656 U_BOOT_CMD_MKENT(boot, 2, 1, do_pxe_boot, "", "")
1659 static int do_pxe(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1664 return CMD_RET_USAGE;
1668 /* drop initial "pxe" arg */
1672 cp = find_cmd_tbl(argv[0], cmd_pxe_sub, ARRAY_SIZE(cmd_pxe_sub));
1675 return cp->cmd(cmdtp, flag, argc, argv);
1677 return CMD_RET_USAGE;
1682 "commands to get and boot from pxe files",
1683 "get - try to retrieve a pxe file using tftp\npxe "
1684 "boot [pxefile_addr_r] - boot from the pxe file at pxefile_addr_r\n"
1689 * Boots a system using a local disk syslinux/extlinux file
1691 * Returns 0 on success, 1 on error.
1693 static int do_sysboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1695 unsigned long pxefile_addr_r;
1696 struct pxe_menu *cfg;
1697 char *pxefile_addr_str;
1703 if (argc > 1 && strstr(argv[1], "-p")) {
1710 return cmd_usage(cmdtp);
1713 pxefile_addr_str = from_env("pxefile_addr_r");
1714 if (!pxefile_addr_str)
1717 pxefile_addr_str = argv[4];
1721 filename = env_get("bootfile");
1724 env_set("bootfile", filename);
1727 if (strstr(argv[3], "ext2"))
1728 do_getfile = do_get_ext2;
1729 else if (strstr(argv[3], "fat"))
1730 do_getfile = do_get_fat;
1731 else if (strstr(argv[3], "any"))
1732 do_getfile = do_get_any;
1734 printf("Invalid filesystem: %s\n", argv[3]);
1737 fs_argv[1] = argv[1];
1738 fs_argv[2] = argv[2];
1740 if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
1741 printf("Invalid pxefile address: %s\n", pxefile_addr_str);
1745 if (get_pxe_file(cmdtp, filename, pxefile_addr_r) < 0) {
1746 printf("Error reading config file\n");
1750 cfg = parse_pxefile(cmdtp, pxefile_addr_r);
1753 printf("Error parsing config file\n");
1760 handle_pxe_menu(cmdtp, cfg);
1762 destroy_pxe_menu(cfg);
1768 sysboot, 7, 1, do_sysboot,
1769 "command to get and boot from syslinux files",
1770 "[-p] <interface> <dev[:part]> <ext2|fat|any> [addr] [filename]\n"
1771 " - load and parse syslinux menu file 'filename' from ext2, fat\n"
1772 " or any filesystem on 'dev' on 'interface' to address 'addr'"