]>
git.ipfire.org Git - people/ms/u-boot.git/blob - common/cmd_pxe.c
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.
453 struct list_head list
;
457 * Describes a pxe menu as given via pxe files.
459 * title - the name of the menu as given by a 'menu title' line.
460 * default_label - the name of the default label, if any.
461 * timeout - time in tenths of a second to wait for a user key-press before
462 * booting the default label.
463 * prompt - if 0, don't prompt for a choice unless the timeout period is
464 * interrupted. If 1, always prompt for a choice regardless of
466 * labels - a list of labels defined for the menu.
473 struct list_head labels
;
477 * Allocates memory for and initializes a pxe_label. This uses malloc, so the
478 * result must be free()'d to reclaim the memory.
480 * Returns NULL if malloc fails.
482 static struct pxe_label
*label_create(void)
484 struct pxe_label
*label
;
486 label
= malloc(sizeof(struct pxe_label
));
491 memset(label
, 0, sizeof(struct pxe_label
));
497 * Free the memory used by a pxe_label, including that used by its name,
498 * kernel, append and initrd members, if they're non NULL.
500 * So - be sure to only use dynamically allocated memory for the members of
501 * the pxe_label struct, unless you want to clean it up first. These are
502 * currently only created by the pxe file parsing code.
504 static void label_destroy(struct pxe_label
*label
)
528 * Print a label and its string members if they're defined.
530 * This is passed as a callback to the menu code for displaying each
533 static void label_print(void *data
)
535 struct pxe_label
*label
= data
;
536 const char *c
= label
->menu
? label
->menu
: label
->name
;
538 printf("%s:\t%s\n", label
->num
, c
);
542 * Boot a label that specified 'localboot'. This requires that the 'localcmd'
543 * environment variable is defined. Its contents will be executed as U-boot
544 * command. If the label specified an 'append' line, its contents will be
545 * used to overwrite the contents of the 'bootargs' environment variable prior
546 * to running 'localcmd'.
548 * Returns 1 on success or < 0 on error.
550 static int label_localboot(struct pxe_label
*label
)
554 localcmd
= from_env("localcmd");
560 setenv("bootargs", label
->append
);
562 debug("running: %s\n", localcmd
);
564 return run_command_list(localcmd
, strlen(localcmd
), 0);
568 * Boot according to the contents of a pxe_label.
570 * If we can't boot for any reason, we return. A successful boot never
573 * The kernel will be stored in the location given by the 'kernel_addr_r'
574 * environment variable.
576 * If the label specifies an initrd file, it will be stored in the location
577 * given by the 'ramdisk_addr_r' environment variable.
579 * If the label specifies an 'append' line, its contents will overwrite that
580 * of the 'bootargs' environment variable.
582 static int label_boot(cmd_tbl_t
*cmdtp
, struct pxe_label
*label
)
584 char *bootm_argv
[] = { "bootm", NULL
, NULL
, NULL
, NULL
};
586 char mac_str
[29] = "";
587 char ip_str
[68] = "";
594 label
->attempted
= 1;
596 if (label
->localboot
) {
597 if (label
->localboot_val
>= 0)
598 label_localboot(label
);
602 if (label
->kernel
== NULL
) {
603 printf("No kernel given, skipping %s\n",
609 if (get_relfile_envaddr(cmdtp
, label
->initrd
, "ramdisk_addr_r") < 0) {
610 printf("Skipping %s for failure retrieving initrd\n",
615 bootm_argv
[2] = initrd_str
;
616 strcpy(bootm_argv
[2], getenv("ramdisk_addr_r"));
617 strcat(bootm_argv
[2], ":");
618 strcat(bootm_argv
[2], getenv("filesize"));
623 if (get_relfile_envaddr(cmdtp
, label
->kernel
, "kernel_addr_r") < 0) {
624 printf("Skipping %s for failure retrieving kernel\n",
629 if (label
->ipappend
& 0x1) {
630 sprintf(ip_str
, " ip=%s:%s:%s:%s",
631 getenv("ipaddr"), getenv("serverip"),
632 getenv("gatewayip"), getenv("netmask"));
633 len
+= strlen(ip_str
);
636 if (label
->ipappend
& 0x2) {
638 strcpy(mac_str
, " BOOTIF=");
639 err
= format_mac_pxe(mac_str
+ 8, sizeof(mac_str
) - 8);
642 len
+= strlen(mac_str
);
646 len
+= strlen(label
->append
);
649 bootargs
= malloc(len
+ 1);
654 strcpy(bootargs
, label
->append
);
655 strcat(bootargs
, ip_str
);
656 strcat(bootargs
, mac_str
);
658 setenv("bootargs", bootargs
);
659 printf("append: %s\n", bootargs
);
664 bootm_argv
[1] = getenv("kernel_addr_r");
667 * fdt usage is optional:
668 * It handles the following scenarios. All scenarios are exclusive
670 * Scenario 1: If fdt_addr_r specified and "fdt" label is defined in
671 * pxe file, retrieve fdt blob from server. Pass fdt_addr_r to bootm,
672 * and adjust argc appropriately.
674 * Scenario 2: If there is an fdt_addr specified, pass it along to
675 * bootm, and adjust argc appropriately.
677 * Scenario 3: fdt blob is not available.
679 bootm_argv
[3] = getenv("fdt_addr_r");
681 /* if fdt label is defined then get fdt from server */
683 char *fdtfile
= NULL
;
684 char *fdtfilefree
= NULL
;
687 fdtfile
= label
->fdt
;
688 } else if (label
->fdtdir
) {
689 fdtfile
= getenv("fdtfile");
691 * For complex cases, it might be worth calling a
692 * board- or SoC-provided function here to provide a
696 * fdtfile = gen_fdtfile();
698 * If this is added, be sure to keep the default below,
699 * or move it to the default weak implementation of
703 char *soc
= getenv("soc");
704 char *board
= getenv("board");
707 len
= strlen(label
->fdtdir
);
710 else if (label
->fdtdir
[len
- 1] != '/')
715 len
= strlen(label
->fdtdir
) + strlen(slash
) +
716 strlen(soc
) + 1 + strlen(board
) + 5;
717 fdtfilefree
= malloc(len
);
719 printf("malloc fail (FDT filename)\n");
723 snprintf(fdtfilefree
, len
, "%s%s%s-%s.dtb",
724 label
->fdtdir
, slash
, soc
, board
);
725 fdtfile
= fdtfilefree
;
730 int err
= get_relfile_envaddr(cmdtp
, fdtfile
, "fdt_addr_r");
733 printf("Skipping %s for failure retrieving fdt\n",
738 bootm_argv
[3] = NULL
;
743 bootm_argv
[3] = getenv("fdt_addr");
748 do_bootm(cmdtp
, 0, bootm_argc
, bootm_argv
);
750 #ifdef CONFIG_CMD_BOOTZ
751 /* Try booting a zImage if do_bootm returns */
752 do_bootz(cmdtp
, 0, bootm_argc
, bootm_argv
);
758 * Tokens for the pxe file parser.
784 * A token - given by a value and a type.
788 enum token_type type
;
792 * Keywords recognized.
794 static const struct token keywords
[] = {
797 {"timeout", T_TIMEOUT
},
798 {"default", T_DEFAULT
},
799 {"prompt", T_PROMPT
},
801 {"kernel", T_KERNEL
},
803 {"localboot", T_LOCALBOOT
},
804 {"append", T_APPEND
},
805 {"initrd", T_INITRD
},
806 {"include", T_INCLUDE
},
807 {"devicetree", T_FDT
},
809 {"devicetreedir", T_FDTDIR
},
810 {"fdtdir", T_FDTDIR
},
811 {"ontimeout", T_ONTIMEOUT
,},
812 {"ipappend", T_IPAPPEND
,},
817 * Since pxe(linux) files don't have a token to identify the start of a
818 * literal, we have to keep track of when we're in a state where a literal is
819 * expected vs when we're in a state a keyword is expected.
828 * get_string retrieves a string from *p and stores it as a token in
831 * get_string used for scanning both string literals and keywords.
833 * Characters from *p are copied into t-val until a character equal to
834 * delim is found, or a NUL byte is reached. If delim has the special value of
835 * ' ', any whitespace character will be used as a delimiter.
837 * If lower is unequal to 0, uppercase characters will be converted to
838 * lowercase in the result. This is useful to make keywords case
841 * The location of *p is updated to point to the first character after the end
842 * of the token - the ending delimiter.
844 * On success, the new value of t->val is returned. Memory for t->val is
845 * allocated using malloc and must be free()'d to reclaim it. If insufficient
846 * memory is available, NULL is returned.
848 static char *get_string(char **p
, struct token
*t
, char delim
, int lower
)
854 * b and e both start at the beginning of the input stream.
856 * e is incremented until we find the ending delimiter, or a NUL byte
857 * is reached. Then, we take e - b to find the length of the token.
862 if ((delim
== ' ' && isspace(*e
)) || delim
== *e
)
870 * Allocate memory to hold the string, and copy it in, converting
871 * characters to lowercase if lower is != 0.
873 t
->val
= malloc(len
+ 1);
877 for (i
= 0; i
< len
; i
++, b
++) {
879 t
->val
[i
] = tolower(*b
);
887 * Update *p so the caller knows where to continue scanning.
897 * Populate a keyword token with a type and value.
899 static void get_keyword(struct token
*t
)
903 for (i
= 0; keywords
[i
].val
; i
++) {
904 if (!strcmp(t
->val
, keywords
[i
].val
)) {
905 t
->type
= keywords
[i
].type
;
912 * Get the next token. We have to keep track of which state we're in to know
913 * if we're looking to get a string literal or a keyword.
915 * *p is updated to point at the first character after the current token.
917 static void get_token(char **p
, struct token
*t
, enum lex_state state
)
923 /* eat non EOL whitespace */
928 * eat comments. note that string literals can't begin with #, but
929 * can contain a # after their first character.
932 while (*c
&& *c
!= '\n')
939 } else if (*c
== '\0') {
942 } else if (state
== L_SLITERAL
) {
943 get_string(&c
, t
, '\n', 0);
944 } else if (state
== L_KEYWORD
) {
946 * when we expect a keyword, we first get the next string
947 * token delimited by whitespace, and then check if it
948 * matches a keyword in our keyword list. if it does, it's
949 * converted to a keyword token of the appropriate type, and
950 * if not, it remains a string token.
952 get_string(&c
, t
, ' ', 1);
960 * Increment *c until we get to the end of the current line, or EOF.
962 static void eol_or_eof(char **c
)
964 while (**c
&& **c
!= '\n')
969 * All of these parse_* functions share some common behavior.
971 * They finish with *c pointing after the token they parse, and return 1 on
972 * success, or < 0 on error.
976 * Parse a string literal and store a pointer it at *dst. String literals
977 * terminate at the end of the line.
979 static int parse_sliteral(char **c
, char **dst
)
984 get_token(c
, &t
, L_SLITERAL
);
986 if (t
.type
!= T_STRING
) {
987 printf("Expected string literal: %.*s\n", (int)(*c
- s
), s
);
997 * Parse a base 10 (unsigned) integer and store it at *dst.
999 static int parse_integer(char **c
, int *dst
)
1004 get_token(c
, &t
, L_SLITERAL
);
1006 if (t
.type
!= T_STRING
) {
1007 printf("Expected string: %.*s\n", (int)(*c
- s
), s
);
1011 *dst
= simple_strtol(t
.val
, NULL
, 10);
1018 static int parse_pxefile_top(cmd_tbl_t
*cmdtp
, char *p
, struct pxe_menu
*cfg
, int nest_level
);
1021 * Parse an include statement, and retrieve and parse the file it mentions.
1023 * base should point to a location where it's safe to store the file, and
1024 * nest_level should indicate how many nested includes have occurred. For this
1025 * include, nest_level has already been incremented and doesn't need to be
1028 static int handle_include(cmd_tbl_t
*cmdtp
, char **c
, char *base
,
1029 struct pxe_menu
*cfg
, int nest_level
)
1035 err
= parse_sliteral(c
, &include_path
);
1038 printf("Expected include path: %.*s\n",
1043 err
= get_pxe_file(cmdtp
, include_path
, base
);
1046 printf("Couldn't retrieve %s\n", include_path
);
1050 return parse_pxefile_top(cmdtp
, base
, cfg
, nest_level
);
1054 * Parse lines that begin with 'menu'.
1056 * b and nest are provided to handle the 'menu include' case.
1058 * b should be the address where the file currently being parsed is stored.
1060 * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
1061 * a file it includes, 3 when parsing a file included by that file, and so on.
1063 static int parse_menu(cmd_tbl_t
*cmdtp
, char **c
, struct pxe_menu
*cfg
, char *b
, int nest_level
)
1069 get_token(c
, &t
, L_KEYWORD
);
1073 err
= parse_sliteral(c
, &cfg
->title
);
1078 err
= handle_include(cmdtp
, c
, b
+ strlen(b
) + 1, cfg
,
1083 printf("Ignoring malformed menu command: %.*s\n",
1096 * Handles parsing a 'menu line' when we're parsing a label.
1098 static int parse_label_menu(char **c
, struct pxe_menu
*cfg
,
1099 struct pxe_label
*label
)
1106 get_token(c
, &t
, L_KEYWORD
);
1110 if (!cfg
->default_label
)
1111 cfg
->default_label
= strdup(label
->name
);
1113 if (!cfg
->default_label
)
1118 parse_sliteral(c
, &label
->menu
);
1121 printf("Ignoring malformed menu command: %.*s\n",
1131 * Parses a label and adds it to the list of labels for a menu.
1133 * A label ends when we either get to the end of a file, or
1134 * get some input we otherwise don't have a handler defined
1138 static int parse_label(char **c
, struct pxe_menu
*cfg
)
1143 struct pxe_label
*label
;
1146 label
= label_create();
1150 err
= parse_sliteral(c
, &label
->name
);
1152 printf("Expected label name: %.*s\n", (int)(*c
- s
), s
);
1153 label_destroy(label
);
1157 list_add_tail(&label
->list
, &cfg
->labels
);
1161 get_token(c
, &t
, L_KEYWORD
);
1166 err
= parse_label_menu(c
, cfg
, label
);
1171 err
= parse_sliteral(c
, &label
->kernel
);
1175 err
= parse_sliteral(c
, &label
->append
);
1178 s
= strstr(label
->append
, "initrd=");
1182 len
= (int)(strchr(s
, ' ') - s
);
1183 label
->initrd
= malloc(len
+ 1);
1184 strncpy(label
->initrd
, s
, len
);
1185 label
->initrd
[len
] = '\0';
1191 err
= parse_sliteral(c
, &label
->initrd
);
1196 err
= parse_sliteral(c
, &label
->fdt
);
1201 err
= parse_sliteral(c
, &label
->fdtdir
);
1205 label
->localboot
= 1;
1206 err
= parse_integer(c
, &label
->localboot_val
);
1210 err
= parse_integer(c
, &label
->ipappend
);
1218 * put the token back! we don't want it - it's the end
1219 * of a label and whatever token this is, it's
1220 * something for the menu level context to handle.
1232 * This 16 comes from the limit pxelinux imposes on nested includes.
1234 * There is no reason at all we couldn't do more, but some limit helps prevent
1235 * infinite (until crash occurs) recursion if a file tries to include itself.
1237 #define MAX_NEST_LEVEL 16
1240 * Entry point for parsing a menu file. nest_level indicates how many times
1241 * we've nested in includes. It will be 1 for the top level menu file.
1243 * Returns 1 on success, < 0 on error.
1245 static int parse_pxefile_top(cmd_tbl_t
*cmdtp
, char *p
, struct pxe_menu
*cfg
, int nest_level
)
1248 char *s
, *b
, *label_name
;
1253 if (nest_level
> MAX_NEST_LEVEL
) {
1254 printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL
);
1261 get_token(&p
, &t
, L_KEYWORD
);
1267 err
= parse_menu(cmdtp
, &p
, cfg
, b
, nest_level
);
1271 err
= parse_integer(&p
, &cfg
->timeout
);
1275 err
= parse_label(&p
, cfg
);
1280 err
= parse_sliteral(&p
, &label_name
);
1283 if (cfg
->default_label
)
1284 free(cfg
->default_label
);
1286 cfg
->default_label
= label_name
;
1292 err
= handle_include(cmdtp
, &p
, b
+ ALIGN(strlen(b
), 4), cfg
,
1307 printf("Ignoring unknown command: %.*s\n",
1318 * Free the memory used by a pxe_menu and its labels.
1320 static void destroy_pxe_menu(struct pxe_menu
*cfg
)
1322 struct list_head
*pos
, *n
;
1323 struct pxe_label
*label
;
1328 if (cfg
->default_label
)
1329 free(cfg
->default_label
);
1331 list_for_each_safe(pos
, n
, &cfg
->labels
) {
1332 label
= list_entry(pos
, struct pxe_label
, list
);
1334 label_destroy(label
);
1341 * Entry point for parsing a pxe file. This is only used for the top level
1344 * Returns NULL if there is an error, otherwise, returns a pointer to a
1345 * pxe_menu struct populated with the results of parsing the pxe file (and any
1346 * files it includes). The resulting pxe_menu struct can be free()'d by using
1347 * the destroy_pxe_menu() function.
1349 static struct pxe_menu
*parse_pxefile(cmd_tbl_t
*cmdtp
, char *menucfg
)
1351 struct pxe_menu
*cfg
;
1353 cfg
= malloc(sizeof(struct pxe_menu
));
1358 memset(cfg
, 0, sizeof(struct pxe_menu
));
1360 INIT_LIST_HEAD(&cfg
->labels
);
1362 if (parse_pxefile_top(cmdtp
, menucfg
, cfg
, 1) < 0) {
1363 destroy_pxe_menu(cfg
);
1371 * Converts a pxe_menu struct into a menu struct for use with U-boot's generic
1374 static struct menu
*pxe_menu_to_menu(struct pxe_menu
*cfg
)
1376 struct pxe_label
*label
;
1377 struct list_head
*pos
;
1381 char *default_num
= NULL
;
1384 * Create a menu and add items for all the labels.
1386 m
= menu_create(cfg
->title
, cfg
->timeout
, cfg
->prompt
, label_print
,
1392 list_for_each(pos
, &cfg
->labels
) {
1393 label
= list_entry(pos
, struct pxe_label
, list
);
1395 sprintf(label
->num
, "%d", i
++);
1396 if (menu_item_add(m
, label
->num
, label
) != 1) {
1400 if (cfg
->default_label
&&
1401 (strcmp(label
->name
, cfg
->default_label
) == 0))
1402 default_num
= label
->num
;
1407 * After we've created items for each label in the menu, set the
1408 * menu's default label if one was specified.
1411 err
= menu_default_set(m
, default_num
);
1413 if (err
!= -ENOENT
) {
1418 printf("Missing default: %s\n", cfg
->default_label
);
1426 * Try to boot any labels we have yet to attempt to boot.
1428 static void boot_unattempted_labels(cmd_tbl_t
*cmdtp
, struct pxe_menu
*cfg
)
1430 struct list_head
*pos
;
1431 struct pxe_label
*label
;
1433 list_for_each(pos
, &cfg
->labels
) {
1434 label
= list_entry(pos
, struct pxe_label
, list
);
1436 if (!label
->attempted
)
1437 label_boot(cmdtp
, label
);
1442 * Boot the system as prescribed by a pxe_menu.
1444 * Use the menu system to either get the user's choice or the default, based
1445 * on config or user input. If there is no default or user's choice,
1446 * attempted to boot labels in the order they were given in pxe files.
1447 * If the default or user's choice fails to boot, attempt to boot other
1448 * labels in the order they were given in pxe files.
1450 * If this function returns, there weren't any labels that successfully
1451 * booted, or the user interrupted the menu selection via ctrl+c.
1453 static void handle_pxe_menu(cmd_tbl_t
*cmdtp
, struct pxe_menu
*cfg
)
1459 m
= pxe_menu_to_menu(cfg
);
1463 err
= menu_get_choice(m
, &choice
);
1468 * err == 1 means we got a choice back from menu_get_choice.
1470 * err == -ENOENT if the menu was setup to select the default but no
1471 * default was set. in that case, we should continue trying to boot
1472 * labels that haven't been attempted yet.
1474 * otherwise, the user interrupted or there was some other error and
1479 err
= label_boot(cmdtp
, choice
);
1482 } else if (err
!= -ENOENT
) {
1486 boot_unattempted_labels(cmdtp
, cfg
);
1490 * Boots a system using a pxe file
1492 * Returns 0 on success, 1 on error.
1495 do_pxe_boot(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
1497 unsigned long pxefile_addr_r
;
1498 struct pxe_menu
*cfg
;
1499 char *pxefile_addr_str
;
1501 do_getfile
= do_get_tftp
;
1504 pxefile_addr_str
= from_env("pxefile_addr_r");
1505 if (!pxefile_addr_str
)
1508 } else if (argc
== 2) {
1509 pxefile_addr_str
= argv
[1];
1511 return CMD_RET_USAGE
;
1514 if (strict_strtoul(pxefile_addr_str
, 16, &pxefile_addr_r
) < 0) {
1515 printf("Invalid pxefile address: %s\n", pxefile_addr_str
);
1519 cfg
= parse_pxefile(cmdtp
, (char *)(pxefile_addr_r
));
1522 printf("Error parsing config file\n");
1526 handle_pxe_menu(cmdtp
, cfg
);
1528 destroy_pxe_menu(cfg
);
1533 static cmd_tbl_t cmd_pxe_sub
[] = {
1534 U_BOOT_CMD_MKENT(get
, 1, 1, do_pxe_get
, "", ""),
1535 U_BOOT_CMD_MKENT(boot
, 2, 1, do_pxe_boot
, "", "")
1538 int do_pxe(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
1543 return CMD_RET_USAGE
;
1547 /* drop initial "pxe" arg */
1551 cp
= find_cmd_tbl(argv
[0], cmd_pxe_sub
, ARRAY_SIZE(cmd_pxe_sub
));
1554 return cp
->cmd(cmdtp
, flag
, argc
, argv
);
1556 return CMD_RET_USAGE
;
1561 "commands to get and boot from pxe files",
1562 "get - try to retrieve a pxe file using tftp\npxe "
1563 "boot [pxefile_addr_r] - boot from the pxe file at pxefile_addr_r\n"
1567 * Boots a system using a local disk syslinux/extlinux file
1569 * Returns 0 on success, 1 on error.
1571 int do_sysboot(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
1573 unsigned long pxefile_addr_r
;
1574 struct pxe_menu
*cfg
;
1575 char *pxefile_addr_str
;
1581 if (strstr(argv
[1], "-p")) {
1588 return cmd_usage(cmdtp
);
1591 pxefile_addr_str
= from_env("pxefile_addr_r");
1592 if (!pxefile_addr_str
)
1595 pxefile_addr_str
= argv
[4];
1599 filename
= getenv("bootfile");
1602 setenv("bootfile", filename
);
1605 if (strstr(argv
[3], "ext2"))
1606 do_getfile
= do_get_ext2
;
1607 else if (strstr(argv
[3], "fat"))
1608 do_getfile
= do_get_fat
;
1610 printf("Invalid filesystem: %s\n", argv
[3]);
1613 fs_argv
[1] = argv
[1];
1614 fs_argv
[2] = argv
[2];
1616 if (strict_strtoul(pxefile_addr_str
, 16, &pxefile_addr_r
) < 0) {
1617 printf("Invalid pxefile address: %s\n", pxefile_addr_str
);
1621 if (get_pxe_file(cmdtp
, filename
, (void *)pxefile_addr_r
) < 0) {
1622 printf("Error reading config file\n");
1626 cfg
= parse_pxefile(cmdtp
, (char *)(pxefile_addr_r
));
1629 printf("Error parsing config file\n");
1636 handle_pxe_menu(cmdtp
, cfg
);
1638 destroy_pxe_menu(cfg
);
1644 sysboot
, 7, 1, do_sysboot
,
1645 "command to get and boot from syslinux files",
1646 "[-p] <interface> <dev[:part]> <ext2|fat> [addr] [filename]\n"
1647 " - load and parse syslinux menu file 'filename' from ext2 or fat\n"
1648 " filesystem on 'dev' on 'interface' to address 'addr'"