2 * Copyright 2010-2011 Calxeda, Inc.
4 * SPDX-License-Identifier: GPL-2.0+
10 #include <linux/string.h>
11 #include <linux/ctype.h>
13 #include <linux/list.h>
17 #define MAX_TFTP_PATH_LEN 127
19 const char *pxe_default_paths[] = {
21 "default-" CONFIG_SYS_ARCH "-" CONFIG_SYS_SOC,
23 "default-" CONFIG_SYS_ARCH,
31 * Like getenv, but prints an error if envvar isn't defined in the
32 * environment. It always returns what getenv does, so it can be used in
33 * place of getenv without changing error handling otherwise.
35 static char *from_env(const char *envvar)
42 printf("missing environment variable: %s\n", envvar);
48 * Convert an ethaddr from the environment to the format used by pxelinux
49 * filenames based on mac addresses. Convert's ':' to '-', and adds "01-" to
50 * the beginning of the ethernet address to indicate a hardware type of
51 * Ethernet. Also converts uppercase hex characters into lowercase, to match
52 * pxelinux's behavior.
54 * Returns 1 for success, -ENOENT if 'ethaddr' is undefined in the
55 * environment, or some other value < 0 on error.
57 static int format_mac_pxe(char *outbuf, size_t outbuf_len)
61 if (outbuf_len < 21) {
62 printf("outbuf is too small (%zd < 21)\n", outbuf_len);
67 if (!eth_getenv_enetaddr_by_index("eth", eth_get_dev_index(),
71 sprintf(outbuf, "01-%02x-%02x-%02x-%02x-%02x-%02x",
72 ethaddr[0], ethaddr[1], ethaddr[2],
73 ethaddr[3], ethaddr[4], ethaddr[5]);
79 * Returns the directory the file specified in the bootfile env variable is
80 * in. If bootfile isn't defined in the environment, return NULL, which should
81 * be interpreted as "don't prepend anything to paths".
83 static int get_bootfile_path(const char *file_path, char *bootfile_path,
84 size_t bootfile_path_size)
86 char *bootfile, *last_slash;
89 /* Only syslinux allows absolute paths */
90 if (file_path[0] == '/' && !is_pxe)
93 bootfile = from_env("bootfile");
98 last_slash = strrchr(bootfile, '/');
100 if (last_slash == NULL)
103 path_len = (last_slash - bootfile) + 1;
105 if (bootfile_path_size < path_len) {
106 printf("bootfile_path too small. (%zd < %zd)\n",
107 bootfile_path_size, path_len);
112 strncpy(bootfile_path, bootfile, path_len);
115 bootfile_path[path_len] = '\0';
120 static int (*do_getfile)(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr);
122 static int do_get_tftp(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
124 char *tftp_argv[] = {"tftp", NULL, NULL, NULL};
126 tftp_argv[1] = file_addr;
127 tftp_argv[2] = (void *)file_path;
129 if (do_tftpb(cmdtp, 0, 3, tftp_argv))
135 static char *fs_argv[5];
137 static int do_get_ext2(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
139 #ifdef CONFIG_CMD_EXT2
140 fs_argv[0] = "ext2load";
141 fs_argv[3] = file_addr;
142 fs_argv[4] = (void *)file_path;
144 if (!do_ext2load(cmdtp, 0, 5, fs_argv))
150 static int do_get_fat(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
152 #ifdef CONFIG_CMD_FAT
153 fs_argv[0] = "fatload";
154 fs_argv[3] = file_addr;
155 fs_argv[4] = (void *)file_path;
157 if (!do_fat_fsload(cmdtp, 0, 5, fs_argv))
164 * As in pxelinux, paths to files referenced from files we retrieve are
165 * relative to the location of bootfile. get_relfile takes such a path and
166 * joins it with the bootfile path to get the full path to the target file. If
167 * the bootfile path is NULL, we use file_path as is.
169 * Returns 1 for success, or < 0 on error.
171 static int get_relfile(cmd_tbl_t *cmdtp, const char *file_path, void *file_addr)
174 char relfile[MAX_TFTP_PATH_LEN+1];
178 err = get_bootfile_path(file_path, relfile, sizeof(relfile));
183 path_len = strlen(file_path);
184 path_len += strlen(relfile);
186 if (path_len > MAX_TFTP_PATH_LEN) {
187 printf("Base path too long (%s%s)\n",
191 return -ENAMETOOLONG;
194 strcat(relfile, file_path);
196 printf("Retrieving file: %s\n", relfile);
198 sprintf(addr_buf, "%p", file_addr);
200 return do_getfile(cmdtp, relfile, addr_buf);
204 * Retrieve the file at 'file_path' to the locate given by 'file_addr'. If
205 * 'bootfile' was specified in the environment, the path to bootfile will be
206 * prepended to 'file_path' and the resulting path will be used.
208 * Returns 1 on success, or < 0 for error.
210 static int get_pxe_file(cmd_tbl_t *cmdtp, const char *file_path, void *file_addr)
212 unsigned long config_file_size;
216 err = get_relfile(cmdtp, file_path, file_addr);
222 * the file comes without a NUL byte at the end, so find out its size
223 * and add the NUL byte.
225 tftp_filesize = from_env("filesize");
230 if (strict_strtoul(tftp_filesize, 16, &config_file_size) < 0)
233 *(char *)(file_addr + config_file_size) = '\0';
238 #define PXELINUX_DIR "pxelinux.cfg/"
241 * Retrieves a file in the 'pxelinux.cfg' folder. Since this uses get_pxe_file
242 * to do the hard work, the location of the 'pxelinux.cfg' folder is generated
243 * from the bootfile path, as described above.
245 * Returns 1 on success or < 0 on error.
247 static int get_pxelinux_path(cmd_tbl_t *cmdtp, const char *file, void *pxefile_addr_r)
249 size_t base_len = strlen(PXELINUX_DIR);
250 char path[MAX_TFTP_PATH_LEN+1];
252 if (base_len + strlen(file) > MAX_TFTP_PATH_LEN) {
253 printf("path (%s%s) too long, skipping\n",
255 return -ENAMETOOLONG;
258 sprintf(path, PXELINUX_DIR "%s", file);
260 return get_pxe_file(cmdtp, path, pxefile_addr_r);
264 * Looks for a pxe file with a name based on the pxeuuid environment variable.
266 * Returns 1 on success or < 0 on error.
268 static int pxe_uuid_path(cmd_tbl_t *cmdtp, void *pxefile_addr_r)
272 uuid_str = from_env("pxeuuid");
277 return get_pxelinux_path(cmdtp, uuid_str, pxefile_addr_r);
281 * Looks for a pxe file with a name based on the 'ethaddr' environment
284 * Returns 1 on success or < 0 on error.
286 static int pxe_mac_path(cmd_tbl_t *cmdtp, void *pxefile_addr_r)
291 err = format_mac_pxe(mac_str, sizeof(mac_str));
296 return get_pxelinux_path(cmdtp, mac_str, pxefile_addr_r);
300 * Looks for pxe files with names based on our IP address. See pxelinux
301 * documentation for details on what these file names look like. We match
304 * Returns 1 on success or < 0 on error.
306 static int pxe_ipaddr_paths(cmd_tbl_t *cmdtp, void *pxefile_addr_r)
311 sprintf(ip_addr, "%08X", ntohl(NetOurIP));
313 for (mask_pos = 7; mask_pos >= 0; mask_pos--) {
314 err = get_pxelinux_path(cmdtp, ip_addr, pxefile_addr_r);
319 ip_addr[mask_pos] = '\0';
326 * Entry point for the 'pxe get' command.
327 * This Follows pxelinux's rules to download a config file from a tftp server.
328 * The file is stored at the location given by the pxefile_addr_r environment
329 * variable, which must be set.
331 * UUID comes from pxeuuid env variable, if defined
332 * MAC addr comes from ethaddr env variable, if defined
335 * see http://syslinux.zytor.com/wiki/index.php/PXELINUX
337 * Returns 0 on success or 1 on error.
340 do_pxe_get(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
342 char *pxefile_addr_str;
343 unsigned long pxefile_addr_r;
346 do_getfile = do_get_tftp;
349 return CMD_RET_USAGE;
351 pxefile_addr_str = from_env("pxefile_addr_r");
353 if (!pxefile_addr_str)
356 err = strict_strtoul(pxefile_addr_str, 16,
357 (unsigned long *)&pxefile_addr_r);
362 * Keep trying paths until we successfully get a file we're looking
365 if (pxe_uuid_path(cmdtp, (void *)pxefile_addr_r) > 0 ||
366 pxe_mac_path(cmdtp, (void *)pxefile_addr_r) > 0 ||
367 pxe_ipaddr_paths(cmdtp, (void *)pxefile_addr_r) > 0) {
368 printf("Config file found\n");
373 while (pxe_default_paths[i]) {
374 if (get_pxelinux_path(cmdtp, pxe_default_paths[i],
375 (void *)pxefile_addr_r) > 0) {
376 printf("Config file found\n");
382 printf("Config file not found\n");
388 * Wrapper to make it easier to store the file at file_path in the location
389 * specified by envaddr_name. file_path will be joined to the bootfile path,
390 * if any is specified.
392 * Returns 1 on success or < 0 on error.
394 static int get_relfile_envaddr(cmd_tbl_t *cmdtp, const char *file_path, const char *envaddr_name)
396 unsigned long file_addr;
399 envaddr = from_env(envaddr_name);
404 if (strict_strtoul(envaddr, 16, &file_addr) < 0)
407 return get_relfile(cmdtp, file_path, (void *)file_addr);
411 * A note on the pxe file parser.
413 * We're parsing files that use syslinux grammar, which has a few quirks.
414 * String literals must be recognized based on context - there is no
415 * quoting or escaping support. There's also nothing to explicitly indicate
416 * when a label section completes. We deal with that by ending a label
417 * section whenever we see a line that doesn't include.
419 * As with the syslinux family, this same file format could be reused in the
420 * future for non pxe purposes. The only action it takes during parsing that
421 * would throw this off is handling of include files. It assumes we're using
422 * pxe, and does a tftp download of a file listed as an include file in the
423 * middle of the parsing operation. That could be handled by refactoring it to
424 * take a 'include file getter' function.
428 * Describes a single label given in a pxe file.
430 * Create these with the 'label_create' function given below.
432 * name - the name of the menu as given on the 'menu label' line.
433 * kernel - the path to the kernel file to use for this label.
434 * append - kernel command line to use when booting this label
435 * initrd - path to the initrd to use for this label.
436 * attempted - 0 if we haven't tried to boot this label, 1 if we have.
437 * localboot - 1 if this label specified 'localboot', 0 otherwise.
438 * list - lets these form a list, which a pxe_menu struct will hold.
452 struct list_head list;
456 * Describes a pxe menu as given via pxe files.
458 * title - the name of the menu as given by a 'menu title' line.
459 * default_label - the name of the default label, if any.
460 * timeout - time in tenths of a second to wait for a user key-press before
461 * booting the default label.
462 * prompt - if 0, don't prompt for a choice unless the timeout period is
463 * interrupted. If 1, always prompt for a choice regardless of
465 * labels - a list of labels defined for the menu.
472 struct list_head labels;
476 * Allocates memory for and initializes a pxe_label. This uses malloc, so the
477 * result must be free()'d to reclaim the memory.
479 * Returns NULL if malloc fails.
481 static struct pxe_label *label_create(void)
483 struct pxe_label *label;
485 label = malloc(sizeof(struct pxe_label));
490 memset(label, 0, sizeof(struct pxe_label));
496 * Free the memory used by a pxe_label, including that used by its name,
497 * kernel, append and initrd members, if they're non NULL.
499 * So - be sure to only use dynamically allocated memory for the members of
500 * the pxe_label struct, unless you want to clean it up first. These are
501 * currently only created by the pxe file parsing code.
503 static void label_destroy(struct pxe_label *label)
524 * Print a label and its string members if they're defined.
526 * This is passed as a callback to the menu code for displaying each
529 static void label_print(void *data)
531 struct pxe_label *label = data;
532 const char *c = label->menu ? label->menu : label->name;
534 printf("%s:\t%s\n", label->num, c);
538 * Boot a label that specified 'localboot'. This requires that the 'localcmd'
539 * environment variable is defined. Its contents will be executed as U-boot
540 * command. If the label specified an 'append' line, its contents will be
541 * used to overwrite the contents of the 'bootargs' environment variable prior
542 * to running 'localcmd'.
544 * Returns 1 on success or < 0 on error.
546 static int label_localboot(struct pxe_label *label)
550 localcmd = from_env("localcmd");
556 setenv("bootargs", label->append);
558 debug("running: %s\n", localcmd);
560 return run_command_list(localcmd, strlen(localcmd), 0);
564 * Boot according to the contents of a pxe_label.
566 * If we can't boot for any reason, we return. A successful boot never
569 * The kernel will be stored in the location given by the 'kernel_addr_r'
570 * environment variable.
572 * If the label specifies an initrd file, it will be stored in the location
573 * given by the 'ramdisk_addr_r' environment variable.
575 * If the label specifies an 'append' line, its contents will overwrite that
576 * of the 'bootargs' environment variable.
578 static int label_boot(cmd_tbl_t *cmdtp, struct pxe_label *label)
580 char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL };
582 char mac_str[29] = "";
583 char ip_str[68] = "";
590 label->attempted = 1;
592 if (label->localboot) {
593 if (label->localboot_val >= 0)
594 label_localboot(label);
598 if (label->kernel == NULL) {
599 printf("No kernel given, skipping %s\n",
605 if (get_relfile_envaddr(cmdtp, label->initrd, "ramdisk_addr_r") < 0) {
606 printf("Skipping %s for failure retrieving initrd\n",
611 bootm_argv[2] = initrd_str;
612 strcpy(bootm_argv[2], getenv("ramdisk_addr_r"));
613 strcat(bootm_argv[2], ":");
614 strcat(bootm_argv[2], getenv("filesize"));
619 if (get_relfile_envaddr(cmdtp, label->kernel, "kernel_addr_r") < 0) {
620 printf("Skipping %s for failure retrieving kernel\n",
625 if (label->ipappend & 0x1) {
626 sprintf(ip_str, " ip=%s:%s:%s:%s",
627 getenv("ipaddr"), getenv("serverip"),
628 getenv("gatewayip"), getenv("netmask"));
629 len += strlen(ip_str);
632 if (label->ipappend & 0x2) {
634 strcpy(mac_str, " BOOTIF=");
635 err = format_mac_pxe(mac_str + 8, sizeof(mac_str) - 8);
638 len += strlen(mac_str);
642 len += strlen(label->append);
645 bootargs = malloc(len + 1);
650 strcpy(bootargs, label->append);
651 strcat(bootargs, ip_str);
652 strcat(bootargs, mac_str);
654 setenv("bootargs", bootargs);
655 printf("append: %s\n", bootargs);
660 bootm_argv[1] = getenv("kernel_addr_r");
663 * fdt usage is optional:
664 * It handles the following scenarios. All scenarios are exclusive
666 * Scenario 1: If fdt_addr_r specified and "fdt" label is defined in
667 * pxe file, retrieve fdt blob from server. Pass fdt_addr_r to bootm,
668 * and adjust argc appropriately.
670 * Scenario 2: If there is an fdt_addr specified, pass it along to
671 * bootm, and adjust argc appropriately.
673 * Scenario 3: fdt blob is not available.
675 bootm_argv[3] = getenv("fdt_addr_r");
677 /* if fdt label is defined then get fdt from server */
678 if (bootm_argv[3] && label->fdt) {
679 if (get_relfile_envaddr(cmdtp, label->fdt, "fdt_addr_r") < 0) {
680 printf("Skipping %s for failure retrieving fdt\n",
685 bootm_argv[3] = getenv("fdt_addr");
690 do_bootm(cmdtp, 0, bootm_argc, bootm_argv);
692 #ifdef CONFIG_CMD_BOOTZ
693 /* Try booting a zImage if do_bootm returns */
694 do_bootz(cmdtp, 0, bootm_argc, bootm_argv);
700 * Tokens for the pxe file parser.
725 * A token - given by a value and a type.
729 enum token_type type;
733 * Keywords recognized.
735 static const struct token keywords[] = {
738 {"timeout", T_TIMEOUT},
739 {"default", T_DEFAULT},
740 {"prompt", T_PROMPT},
742 {"kernel", T_KERNEL},
744 {"localboot", T_LOCALBOOT},
745 {"append", T_APPEND},
746 {"initrd", T_INITRD},
747 {"include", T_INCLUDE},
748 {"devicetree", T_FDT},
750 {"ontimeout", T_ONTIMEOUT,},
751 {"ipappend", T_IPAPPEND,},
756 * Since pxe(linux) files don't have a token to identify the start of a
757 * literal, we have to keep track of when we're in a state where a literal is
758 * expected vs when we're in a state a keyword is expected.
767 * get_string retrieves a string from *p and stores it as a token in
770 * get_string used for scanning both string literals and keywords.
772 * Characters from *p are copied into t-val until a character equal to
773 * delim is found, or a NUL byte is reached. If delim has the special value of
774 * ' ', any whitespace character will be used as a delimiter.
776 * If lower is unequal to 0, uppercase characters will be converted to
777 * lowercase in the result. This is useful to make keywords case
780 * The location of *p is updated to point to the first character after the end
781 * of the token - the ending delimiter.
783 * On success, the new value of t->val is returned. Memory for t->val is
784 * allocated using malloc and must be free()'d to reclaim it. If insufficient
785 * memory is available, NULL is returned.
787 static char *get_string(char **p, struct token *t, char delim, int lower)
793 * b and e both start at the beginning of the input stream.
795 * e is incremented until we find the ending delimiter, or a NUL byte
796 * is reached. Then, we take e - b to find the length of the token.
801 if ((delim == ' ' && isspace(*e)) || delim == *e)
809 * Allocate memory to hold the string, and copy it in, converting
810 * characters to lowercase if lower is != 0.
812 t->val = malloc(len + 1);
816 for (i = 0; i < len; i++, b++) {
818 t->val[i] = tolower(*b);
826 * Update *p so the caller knows where to continue scanning.
836 * Populate a keyword token with a type and value.
838 static void get_keyword(struct token *t)
842 for (i = 0; keywords[i].val; i++) {
843 if (!strcmp(t->val, keywords[i].val)) {
844 t->type = keywords[i].type;
851 * Get the next token. We have to keep track of which state we're in to know
852 * if we're looking to get a string literal or a keyword.
854 * *p is updated to point at the first character after the current token.
856 static void get_token(char **p, struct token *t, enum lex_state state)
862 /* eat non EOL whitespace */
867 * eat comments. note that string literals can't begin with #, but
868 * can contain a # after their first character.
871 while (*c && *c != '\n')
878 } else if (*c == '\0') {
881 } else if (state == L_SLITERAL) {
882 get_string(&c, t, '\n', 0);
883 } else if (state == L_KEYWORD) {
885 * when we expect a keyword, we first get the next string
886 * token delimited by whitespace, and then check if it
887 * matches a keyword in our keyword list. if it does, it's
888 * converted to a keyword token of the appropriate type, and
889 * if not, it remains a string token.
891 get_string(&c, t, ' ', 1);
899 * Increment *c until we get to the end of the current line, or EOF.
901 static void eol_or_eof(char **c)
903 while (**c && **c != '\n')
908 * All of these parse_* functions share some common behavior.
910 * They finish with *c pointing after the token they parse, and return 1 on
911 * success, or < 0 on error.
915 * Parse a string literal and store a pointer it at *dst. String literals
916 * terminate at the end of the line.
918 static int parse_sliteral(char **c, char **dst)
923 get_token(c, &t, L_SLITERAL);
925 if (t.type != T_STRING) {
926 printf("Expected string literal: %.*s\n", (int)(*c - s), s);
936 * Parse a base 10 (unsigned) integer and store it at *dst.
938 static int parse_integer(char **c, int *dst)
943 get_token(c, &t, L_SLITERAL);
945 if (t.type != T_STRING) {
946 printf("Expected string: %.*s\n", (int)(*c - s), s);
950 *dst = simple_strtol(t.val, NULL, 10);
957 static int parse_pxefile_top(cmd_tbl_t *cmdtp, char *p, struct pxe_menu *cfg, int nest_level);
960 * Parse an include statement, and retrieve and parse the file it mentions.
962 * base should point to a location where it's safe to store the file, and
963 * nest_level should indicate how many nested includes have occurred. For this
964 * include, nest_level has already been incremented and doesn't need to be
967 static int handle_include(cmd_tbl_t *cmdtp, char **c, char *base,
968 struct pxe_menu *cfg, int nest_level)
974 err = parse_sliteral(c, &include_path);
977 printf("Expected include path: %.*s\n",
982 err = get_pxe_file(cmdtp, include_path, base);
985 printf("Couldn't retrieve %s\n", include_path);
989 return parse_pxefile_top(cmdtp, base, cfg, nest_level);
993 * Parse lines that begin with 'menu'.
995 * b and nest are provided to handle the 'menu include' case.
997 * b should be the address where the file currently being parsed is stored.
999 * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
1000 * a file it includes, 3 when parsing a file included by that file, and so on.
1002 static int parse_menu(cmd_tbl_t *cmdtp, char **c, struct pxe_menu *cfg, char *b, int nest_level)
1008 get_token(c, &t, L_KEYWORD);
1012 err = parse_sliteral(c, &cfg->title);
1017 err = handle_include(cmdtp, c, b + strlen(b) + 1, cfg,
1022 printf("Ignoring malformed menu command: %.*s\n",
1035 * Handles parsing a 'menu line' when we're parsing a label.
1037 static int parse_label_menu(char **c, struct pxe_menu *cfg,
1038 struct pxe_label *label)
1045 get_token(c, &t, L_KEYWORD);
1049 if (!cfg->default_label)
1050 cfg->default_label = strdup(label->name);
1052 if (!cfg->default_label)
1057 parse_sliteral(c, &label->menu);
1060 printf("Ignoring malformed menu command: %.*s\n",
1070 * Parses a label and adds it to the list of labels for a menu.
1072 * A label ends when we either get to the end of a file, or
1073 * get some input we otherwise don't have a handler defined
1077 static int parse_label(char **c, struct pxe_menu *cfg)
1082 struct pxe_label *label;
1085 label = label_create();
1089 err = parse_sliteral(c, &label->name);
1091 printf("Expected label name: %.*s\n", (int)(*c - s), s);
1092 label_destroy(label);
1096 list_add_tail(&label->list, &cfg->labels);
1100 get_token(c, &t, L_KEYWORD);
1105 err = parse_label_menu(c, cfg, label);
1110 err = parse_sliteral(c, &label->kernel);
1114 err = parse_sliteral(c, &label->append);
1117 s = strstr(label->append, "initrd=");
1121 len = (int)(strchr(s, ' ') - s);
1122 label->initrd = malloc(len + 1);
1123 strncpy(label->initrd, s, len);
1124 label->initrd[len] = '\0';
1130 err = parse_sliteral(c, &label->initrd);
1135 err = parse_sliteral(c, &label->fdt);
1139 label->localboot = 1;
1140 err = parse_integer(c, &label->localboot_val);
1144 err = parse_integer(c, &label->ipappend);
1152 * put the token back! we don't want it - it's the end
1153 * of a label and whatever token this is, it's
1154 * something for the menu level context to handle.
1166 * This 16 comes from the limit pxelinux imposes on nested includes.
1168 * There is no reason at all we couldn't do more, but some limit helps prevent
1169 * infinite (until crash occurs) recursion if a file tries to include itself.
1171 #define MAX_NEST_LEVEL 16
1174 * Entry point for parsing a menu file. nest_level indicates how many times
1175 * we've nested in includes. It will be 1 for the top level menu file.
1177 * Returns 1 on success, < 0 on error.
1179 static int parse_pxefile_top(cmd_tbl_t *cmdtp, char *p, struct pxe_menu *cfg, int nest_level)
1182 char *s, *b, *label_name;
1187 if (nest_level > MAX_NEST_LEVEL) {
1188 printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL);
1195 get_token(&p, &t, L_KEYWORD);
1201 err = parse_menu(cmdtp, &p, cfg, b, nest_level);
1205 err = parse_integer(&p, &cfg->timeout);
1209 err = parse_label(&p, cfg);
1214 err = parse_sliteral(&p, &label_name);
1217 if (cfg->default_label)
1218 free(cfg->default_label);
1220 cfg->default_label = label_name;
1226 err = handle_include(cmdtp, &p, b + ALIGN(strlen(b), 4), cfg,
1241 printf("Ignoring unknown command: %.*s\n",
1252 * Free the memory used by a pxe_menu and its labels.
1254 static void destroy_pxe_menu(struct pxe_menu *cfg)
1256 struct list_head *pos, *n;
1257 struct pxe_label *label;
1262 if (cfg->default_label)
1263 free(cfg->default_label);
1265 list_for_each_safe(pos, n, &cfg->labels) {
1266 label = list_entry(pos, struct pxe_label, list);
1268 label_destroy(label);
1275 * Entry point for parsing a pxe file. This is only used for the top level
1278 * Returns NULL if there is an error, otherwise, returns a pointer to a
1279 * pxe_menu struct populated with the results of parsing the pxe file (and any
1280 * files it includes). The resulting pxe_menu struct can be free()'d by using
1281 * the destroy_pxe_menu() function.
1283 static struct pxe_menu *parse_pxefile(cmd_tbl_t *cmdtp, char *menucfg)
1285 struct pxe_menu *cfg;
1287 cfg = malloc(sizeof(struct pxe_menu));
1292 memset(cfg, 0, sizeof(struct pxe_menu));
1294 INIT_LIST_HEAD(&cfg->labels);
1296 if (parse_pxefile_top(cmdtp, menucfg, cfg, 1) < 0) {
1297 destroy_pxe_menu(cfg);
1305 * Converts a pxe_menu struct into a menu struct for use with U-boot's generic
1308 static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
1310 struct pxe_label *label;
1311 struct list_head *pos;
1315 char *default_num = NULL;
1318 * Create a menu and add items for all the labels.
1320 m = menu_create(cfg->title, cfg->timeout, cfg->prompt, label_print,
1326 list_for_each(pos, &cfg->labels) {
1327 label = list_entry(pos, struct pxe_label, list);
1329 sprintf(label->num, "%d", i++);
1330 if (menu_item_add(m, label->num, label) != 1) {
1334 if (cfg->default_label &&
1335 (strcmp(label->name, cfg->default_label) == 0))
1336 default_num = label->num;
1341 * After we've created items for each label in the menu, set the
1342 * menu's default label if one was specified.
1345 err = menu_default_set(m, default_num);
1347 if (err != -ENOENT) {
1352 printf("Missing default: %s\n", cfg->default_label);
1360 * Try to boot any labels we have yet to attempt to boot.
1362 static void boot_unattempted_labels(cmd_tbl_t *cmdtp, struct pxe_menu *cfg)
1364 struct list_head *pos;
1365 struct pxe_label *label;
1367 list_for_each(pos, &cfg->labels) {
1368 label = list_entry(pos, struct pxe_label, list);
1370 if (!label->attempted)
1371 label_boot(cmdtp, label);
1376 * Boot the system as prescribed by a pxe_menu.
1378 * Use the menu system to either get the user's choice or the default, based
1379 * on config or user input. If there is no default or user's choice,
1380 * attempted to boot labels in the order they were given in pxe files.
1381 * If the default or user's choice fails to boot, attempt to boot other
1382 * labels in the order they were given in pxe files.
1384 * If this function returns, there weren't any labels that successfully
1385 * booted, or the user interrupted the menu selection via ctrl+c.
1387 static void handle_pxe_menu(cmd_tbl_t *cmdtp, struct pxe_menu *cfg)
1393 m = pxe_menu_to_menu(cfg);
1397 err = menu_get_choice(m, &choice);
1402 * err == 1 means we got a choice back from menu_get_choice.
1404 * err == -ENOENT if the menu was setup to select the default but no
1405 * default was set. in that case, we should continue trying to boot
1406 * labels that haven't been attempted yet.
1408 * otherwise, the user interrupted or there was some other error and
1413 err = label_boot(cmdtp, choice);
1416 } else if (err != -ENOENT) {
1420 boot_unattempted_labels(cmdtp, cfg);
1424 * Boots a system using a pxe file
1426 * Returns 0 on success, 1 on error.
1429 do_pxe_boot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1431 unsigned long pxefile_addr_r;
1432 struct pxe_menu *cfg;
1433 char *pxefile_addr_str;
1435 do_getfile = do_get_tftp;
1438 pxefile_addr_str = from_env("pxefile_addr_r");
1439 if (!pxefile_addr_str)
1442 } else if (argc == 2) {
1443 pxefile_addr_str = argv[1];
1445 return CMD_RET_USAGE;
1448 if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
1449 printf("Invalid pxefile address: %s\n", pxefile_addr_str);
1453 cfg = parse_pxefile(cmdtp, (char *)(pxefile_addr_r));
1456 printf("Error parsing config file\n");
1460 handle_pxe_menu(cmdtp, cfg);
1462 destroy_pxe_menu(cfg);
1467 static cmd_tbl_t cmd_pxe_sub[] = {
1468 U_BOOT_CMD_MKENT(get, 1, 1, do_pxe_get, "", ""),
1469 U_BOOT_CMD_MKENT(boot, 2, 1, do_pxe_boot, "", "")
1472 int do_pxe(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1477 return CMD_RET_USAGE;
1481 /* drop initial "pxe" arg */
1485 cp = find_cmd_tbl(argv[0], cmd_pxe_sub, ARRAY_SIZE(cmd_pxe_sub));
1488 return cp->cmd(cmdtp, flag, argc, argv);
1490 return CMD_RET_USAGE;
1495 "commands to get and boot from pxe files",
1496 "get - try to retrieve a pxe file using tftp\npxe "
1497 "boot [pxefile_addr_r] - boot from the pxe file at pxefile_addr_r\n"
1501 * Boots a system using a local disk syslinux/extlinux file
1503 * Returns 0 on success, 1 on error.
1505 int do_sysboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1507 unsigned long pxefile_addr_r;
1508 struct pxe_menu *cfg;
1509 char *pxefile_addr_str;
1515 if (strstr(argv[1], "-p")) {
1522 return cmd_usage(cmdtp);
1525 pxefile_addr_str = from_env("pxefile_addr_r");
1526 if (!pxefile_addr_str)
1529 pxefile_addr_str = argv[4];
1533 filename = getenv("bootfile");
1536 setenv("bootfile", filename);
1539 if (strstr(argv[3], "ext2"))
1540 do_getfile = do_get_ext2;
1541 else if (strstr(argv[3], "fat"))
1542 do_getfile = do_get_fat;
1544 printf("Invalid filesystem: %s\n", argv[3]);
1547 fs_argv[1] = argv[1];
1548 fs_argv[2] = argv[2];
1550 if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
1551 printf("Invalid pxefile address: %s\n", pxefile_addr_str);
1555 if (get_pxe_file(cmdtp, filename, (void *)pxefile_addr_r) < 0) {
1556 printf("Error reading config file\n");
1560 cfg = parse_pxefile(cmdtp, (char *)(pxefile_addr_r));
1563 printf("Error parsing config file\n");
1570 handle_pxe_menu(cmdtp, cfg);
1572 destroy_pxe_menu(cfg);
1578 sysboot, 7, 1, do_sysboot,
1579 "command to get and boot from syslinux files",
1580 "[-p] <interface> <dev[:part]> <ext2|fat> [addr] [filename]\n"
1581 " - load and parse syslinux menu file 'filename' from ext2 or fat\n"
1582 " filesystem on 'dev' on 'interface' to address 'addr'"