pxe.c 37.3 KB
Newer Older
Jason Hobbs's avatar
Jason Hobbs committed
1 2
/*
 * Copyright 2010-2011 Calxeda, Inc.
3
 * Copyright (c) 2014, NVIDIA CORPORATION.  All rights reserved.
Jason Hobbs's avatar
Jason Hobbs committed
4
 *
5
 * SPDX-License-Identifier:	GPL-2.0+
Jason Hobbs's avatar
Jason Hobbs committed
6
 */
7

Jason Hobbs's avatar
Jason Hobbs committed
8 9 10
#include <common.h>
#include <command.h>
#include <malloc.h>
11
#include <mapmem.h>
Jason Hobbs's avatar
Jason Hobbs committed
12 13 14 15
#include <linux/string.h>
#include <linux/ctype.h>
#include <errno.h>
#include <linux/list.h>
16
#include <fs.h>
17
#include <asm/io.h>
Jason Hobbs's avatar
Jason Hobbs committed
18 19

#include "menu.h"
20
#include "cli.h"
Jason Hobbs's avatar
Jason Hobbs committed
21 22 23

#define MAX_TFTP_PATH_LEN 127

24
const char *pxe_default_paths[] = {
25
#ifdef CONFIG_SYS_SOC
26
	"default-" CONFIG_SYS_ARCH "-" CONFIG_SYS_SOC,
27
#endif
28 29 30 31 32
	"default-" CONFIG_SYS_ARCH,
	"default",
	NULL
};

33 34
static bool is_pxe;

Jason Hobbs's avatar
Jason Hobbs committed
35 36 37 38 39
/*
 * Like getenv, but prints an error if envvar isn't defined in the
 * environment.  It always returns what getenv does, so it can be used in
 * place of getenv without changing error handling otherwise.
 */
40
static char *from_env(const char *envvar)
Jason Hobbs's avatar
Jason Hobbs committed
41 42 43 44 45 46 47 48 49 50 51
{
	char *ret;

	ret = getenv(envvar);

	if (!ret)
		printf("missing environment variable: %s\n", envvar);

	return ret;
}

52
#ifdef CONFIG_CMD_NET
Jason Hobbs's avatar
Jason Hobbs committed
53 54 55 56 57 58 59 60 61 62 63 64
/*
 * Convert an ethaddr from the environment to the format used by pxelinux
 * filenames based on mac addresses. Convert's ':' to '-', and adds "01-" to
 * the beginning of the ethernet address to indicate a hardware type of
 * Ethernet. Also converts uppercase hex characters into lowercase, to match
 * pxelinux's behavior.
 *
 * Returns 1 for success, -ENOENT if 'ethaddr' is undefined in the
 * environment, or some other value < 0 on error.
 */
static int format_mac_pxe(char *outbuf, size_t outbuf_len)
{
65
	uchar ethaddr[6];
Jason Hobbs's avatar
Jason Hobbs committed
66

67
	if (outbuf_len < 21) {
68
		printf("outbuf is too small (%zd < 21)\n", outbuf_len);
Jason Hobbs's avatar
Jason Hobbs committed
69 70 71 72

		return -EINVAL;
	}

73 74 75
	if (!eth_getenv_enetaddr_by_index("eth", eth_get_dev_index(),
					  ethaddr))
		return -ENOENT;
Jason Hobbs's avatar
Jason Hobbs committed
76

77 78 79
	sprintf(outbuf, "01-%02x-%02x-%02x-%02x-%02x-%02x",
		ethaddr[0], ethaddr[1], ethaddr[2],
		ethaddr[3], ethaddr[4], ethaddr[5]);
Jason Hobbs's avatar
Jason Hobbs committed
80 81 82

	return 1;
}
83
#endif
Jason Hobbs's avatar
Jason Hobbs committed
84 85 86 87 88 89

/*
 * Returns the directory the file specified in the bootfile env variable is
 * in. If bootfile isn't defined in the environment, return NULL, which should
 * be interpreted as "don't prepend anything to paths".
 */
90 91
static int get_bootfile_path(const char *file_path, char *bootfile_path,
			     size_t bootfile_path_size)
Jason Hobbs's avatar
Jason Hobbs committed
92 93
{
	char *bootfile, *last_slash;
94 95
	size_t path_len = 0;

96 97
	/* Only syslinux allows absolute paths */
	if (file_path[0] == '/' && !is_pxe)
98
		goto ret;
Jason Hobbs's avatar
Jason Hobbs committed
99 100 101

	bootfile = from_env("bootfile");

102 103
	if (!bootfile)
		goto ret;
Jason Hobbs's avatar
Jason Hobbs committed
104 105 106

	last_slash = strrchr(bootfile, '/');

107 108
	if (last_slash == NULL)
		goto ret;
Jason Hobbs's avatar
Jason Hobbs committed
109 110 111 112

	path_len = (last_slash - bootfile) + 1;

	if (bootfile_path_size < path_len) {
113
		printf("bootfile_path too small. (%zd < %zd)\n",
Jason Hobbs's avatar
Jason Hobbs committed
114 115 116 117 118 119 120
				bootfile_path_size, path_len);

		return -1;
	}

	strncpy(bootfile_path, bootfile, path_len);

121
 ret:
Jason Hobbs's avatar
Jason Hobbs committed
122 123 124 125 126
	bootfile_path[path_len] = '\0';

	return 1;
}

127
static int (*do_getfile)(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr);
128

129
#ifdef CONFIG_CMD_NET
130
static int do_get_tftp(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
131 132 133 134
{
	char *tftp_argv[] = {"tftp", NULL, NULL, NULL};

	tftp_argv[1] = file_addr;
135
	tftp_argv[2] = (void *)file_path;
136

137
	if (do_tftpb(cmdtp, 0, 3, tftp_argv))
138 139 140 141
		return -ENOENT;

	return 1;
}
142
#endif
143 144 145

static char *fs_argv[5];

146
static int do_get_ext2(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
147 148 149 150
{
#ifdef CONFIG_CMD_EXT2
	fs_argv[0] = "ext2load";
	fs_argv[3] = file_addr;
151
	fs_argv[4] = (void *)file_path;
152

153
	if (!do_ext2load(cmdtp, 0, 5, fs_argv))
154 155 156 157 158
		return 1;
#endif
	return -ENOENT;
}

159
static int do_get_fat(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
160 161 162 163
{
#ifdef CONFIG_CMD_FAT
	fs_argv[0] = "fatload";
	fs_argv[3] = file_addr;
164
	fs_argv[4] = (void *)file_path;
165

166
	if (!do_fat_fsload(cmdtp, 0, 5, fs_argv))
167 168 169 170 171
		return 1;
#endif
	return -ENOENT;
}

172 173 174 175 176 177 178 179 180 181 182 183 184
static int do_get_any(cmd_tbl_t *cmdtp, const char *file_path, char *file_addr)
{
#ifdef CONFIG_CMD_FS_GENERIC
	fs_argv[0] = "load";
	fs_argv[3] = file_addr;
	fs_argv[4] = (void *)file_path;

	if (!do_load(cmdtp, 0, 5, fs_argv, FS_TYPE_ANY))
		return 1;
#endif
	return -ENOENT;
}

Jason Hobbs's avatar
Jason Hobbs committed
185 186 187 188 189 190 191 192
/*
 * As in pxelinux, paths to files referenced from files we retrieve are
 * relative to the location of bootfile. get_relfile takes such a path and
 * joins it with the bootfile path to get the full path to the target file. If
 * the bootfile path is NULL, we use file_path as is.
 *
 * Returns 1 for success, or < 0 on error.
 */
193 194
static int get_relfile(cmd_tbl_t *cmdtp, const char *file_path,
	unsigned long file_addr)
Jason Hobbs's avatar
Jason Hobbs committed
195 196 197
{
	size_t path_len;
	char relfile[MAX_TFTP_PATH_LEN+1];
198
	char addr_buf[18];
Jason Hobbs's avatar
Jason Hobbs committed
199 200
	int err;

201
	err = get_bootfile_path(file_path, relfile, sizeof(relfile));
Jason Hobbs's avatar
Jason Hobbs committed
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

	if (err < 0)
		return err;

	path_len = strlen(file_path);
	path_len += strlen(relfile);

	if (path_len > MAX_TFTP_PATH_LEN) {
		printf("Base path too long (%s%s)\n",
					relfile,
					file_path);

		return -ENAMETOOLONG;
	}

	strcat(relfile, file_path);

	printf("Retrieving file: %s\n", relfile);

221
	sprintf(addr_buf, "%lx", file_addr);
Jason Hobbs's avatar
Jason Hobbs committed
222

223
	return do_getfile(cmdtp, relfile, addr_buf);
Jason Hobbs's avatar
Jason Hobbs committed
224 225 226 227 228 229 230 231 232
}

/*
 * Retrieve the file at 'file_path' to the locate given by 'file_addr'. If
 * 'bootfile' was specified in the environment, the path to bootfile will be
 * prepended to 'file_path' and the resulting path will be used.
 *
 * Returns 1 on success, or < 0 for error.
 */
233 234
static int get_pxe_file(cmd_tbl_t *cmdtp, const char *file_path,
	unsigned long file_addr)
Jason Hobbs's avatar
Jason Hobbs committed
235 236 237 238
{
	unsigned long config_file_size;
	char *tftp_filesize;
	int err;
239
	char *buf;
Jason Hobbs's avatar
Jason Hobbs committed
240

241
	err = get_relfile(cmdtp, file_path, file_addr);
Jason Hobbs's avatar
Jason Hobbs committed
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

	if (err < 0)
		return err;

	/*
	 * the file comes without a NUL byte at the end, so find out its size
	 * and add the NUL byte.
	 */
	tftp_filesize = from_env("filesize");

	if (!tftp_filesize)
		return -ENOENT;

	if (strict_strtoul(tftp_filesize, 16, &config_file_size) < 0)
		return -EINVAL;

258 259 260
	buf = map_sysmem(file_addr + config_file_size, 1);
	*buf = '\0';
	unmap_sysmem(buf);
Jason Hobbs's avatar
Jason Hobbs committed
261 262 263 264

	return 1;
}

265 266
#ifdef CONFIG_CMD_NET

Jason Hobbs's avatar
Jason Hobbs committed
267 268 269 270 271 272 273 274 275
#define PXELINUX_DIR "pxelinux.cfg/"

/*
 * Retrieves a file in the 'pxelinux.cfg' folder. Since this uses get_pxe_file
 * to do the hard work, the location of the 'pxelinux.cfg' folder is generated
 * from the bootfile path, as described above.
 *
 * Returns 1 on success or < 0 on error.
 */
276 277
static int get_pxelinux_path(cmd_tbl_t *cmdtp, const char *file,
	unsigned long pxefile_addr_r)
Jason Hobbs's avatar
Jason Hobbs committed
278 279 280 281 282 283 284 285 286 287 288 289
{
	size_t base_len = strlen(PXELINUX_DIR);
	char path[MAX_TFTP_PATH_LEN+1];

	if (base_len + strlen(file) > MAX_TFTP_PATH_LEN) {
		printf("path (%s%s) too long, skipping\n",
				PXELINUX_DIR, file);
		return -ENAMETOOLONG;
	}

	sprintf(path, PXELINUX_DIR "%s", file);

290
	return get_pxe_file(cmdtp, path, pxefile_addr_r);
Jason Hobbs's avatar
Jason Hobbs committed
291 292 293 294 295 296 297
}

/*
 * Looks for a pxe file with a name based on the pxeuuid environment variable.
 *
 * Returns 1 on success or < 0 on error.
 */
298
static int pxe_uuid_path(cmd_tbl_t *cmdtp, unsigned long pxefile_addr_r)
Jason Hobbs's avatar
Jason Hobbs committed
299 300 301 302 303 304 305 306
{
	char *uuid_str;

	uuid_str = from_env("pxeuuid");

	if (!uuid_str)
		return -ENOENT;

307
	return get_pxelinux_path(cmdtp, uuid_str, pxefile_addr_r);
Jason Hobbs's avatar
Jason Hobbs committed
308 309 310 311 312 313 314 315
}

/*
 * Looks for a pxe file with a name based on the 'ethaddr' environment
 * variable.
 *
 * Returns 1 on success or < 0 on error.
 */
316
static int pxe_mac_path(cmd_tbl_t *cmdtp, unsigned long pxefile_addr_r)
Jason Hobbs's avatar
Jason Hobbs committed
317 318 319 320 321 322 323 324 325
{
	char mac_str[21];
	int err;

	err = format_mac_pxe(mac_str, sizeof(mac_str));

	if (err < 0)
		return err;

326
	return get_pxelinux_path(cmdtp, mac_str, pxefile_addr_r);
Jason Hobbs's avatar
Jason Hobbs committed
327 328 329 330 331 332 333 334 335
}

/*
 * Looks for pxe files with names based on our IP address. See pxelinux
 * documentation for details on what these file names look like.  We match
 * that exactly.
 *
 * Returns 1 on success or < 0 on error.
 */
336
static int pxe_ipaddr_paths(cmd_tbl_t *cmdtp, unsigned long pxefile_addr_r)
Jason Hobbs's avatar
Jason Hobbs committed
337 338 339 340
{
	char ip_addr[9];
	int mask_pos, err;

341
	sprintf(ip_addr, "%08X", ntohl(net_ip.s_addr));
Jason Hobbs's avatar
Jason Hobbs committed
342 343

	for (mask_pos = 7; mask_pos >= 0;  mask_pos--) {
344
		err = get_pxelinux_path(cmdtp, ip_addr, pxefile_addr_r);
Jason Hobbs's avatar
Jason Hobbs committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

		if (err > 0)
			return err;

		ip_addr[mask_pos] = '\0';
	}

	return -ENOENT;
}

/*
 * Entry point for the 'pxe get' command.
 * This Follows pxelinux's rules to download a config file from a tftp server.
 * The file is stored at the location given by the pxefile_addr_r environment
 * variable, which must be set.
 *
 * UUID comes from pxeuuid env variable, if defined
 * MAC addr comes from ethaddr env variable, if defined
 * IP
 *
 * see http://syslinux.zytor.com/wiki/index.php/PXELINUX
 *
 * Returns 0 on success or 1 on error.
 */
static int
do_pxe_get(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	char *pxefile_addr_str;
373
	unsigned long pxefile_addr_r;
374
	int err, i = 0;
Jason Hobbs's avatar
Jason Hobbs committed
375

376 377
	do_getfile = do_get_tftp;

Jason Hobbs's avatar
Jason Hobbs committed
378
	if (argc != 1)
379
		return CMD_RET_USAGE;
Jason Hobbs's avatar
Jason Hobbs committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

	pxefile_addr_str = from_env("pxefile_addr_r");

	if (!pxefile_addr_str)
		return 1;

	err = strict_strtoul(pxefile_addr_str, 16,
				(unsigned long *)&pxefile_addr_r);
	if (err < 0)
		return 1;

	/*
	 * Keep trying paths until we successfully get a file we're looking
	 * for.
	 */
395 396 397
	if (pxe_uuid_path(cmdtp, pxefile_addr_r) > 0 ||
	    pxe_mac_path(cmdtp, pxefile_addr_r) > 0 ||
	    pxe_ipaddr_paths(cmdtp, pxefile_addr_r) > 0) {
Jason Hobbs's avatar
Jason Hobbs committed
398 399 400 401 402
		printf("Config file found\n");

		return 0;
	}

403
	while (pxe_default_paths[i]) {
404
		if (get_pxelinux_path(cmdtp, pxe_default_paths[i],
405
				      pxefile_addr_r) > 0) {
406 407 408 409 410 411
			printf("Config file found\n");
			return 0;
		}
		i++;
	}

Jason Hobbs's avatar
Jason Hobbs committed
412 413 414 415
	printf("Config file not found\n");

	return 1;
}
416
#endif
Jason Hobbs's avatar
Jason Hobbs committed
417 418 419 420 421 422 423 424

/*
 * Wrapper to make it easier to store the file at file_path in the location
 * specified by envaddr_name. file_path will be joined to the bootfile path,
 * if any is specified.
 *
 * Returns 1 on success or < 0 on error.
 */
425
static int get_relfile_envaddr(cmd_tbl_t *cmdtp, const char *file_path, const char *envaddr_name)
Jason Hobbs's avatar
Jason Hobbs committed
426
{
427
	unsigned long file_addr;
Jason Hobbs's avatar
Jason Hobbs committed
428 429 430 431 432 433 434
	char *envaddr;

	envaddr = from_env(envaddr_name);

	if (!envaddr)
		return -ENOENT;

435
	if (strict_strtoul(envaddr, 16, &file_addr) < 0)
Jason Hobbs's avatar
Jason Hobbs committed
436 437
		return -EINVAL;

438
	return get_relfile(cmdtp, file_path, file_addr);
Jason Hobbs's avatar
Jason Hobbs committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
}

/*
 * A note on the pxe file parser.
 *
 * We're parsing files that use syslinux grammar, which has a few quirks.
 * String literals must be recognized based on context - there is no
 * quoting or escaping support. There's also nothing to explicitly indicate
 * when a label section completes. We deal with that by ending a label
 * section whenever we see a line that doesn't include.
 *
 * As with the syslinux family, this same file format could be reused in the
 * future for non pxe purposes. The only action it takes during parsing that
 * would throw this off is handling of include files. It assumes we're using
 * pxe, and does a tftp download of a file listed as an include file in the
 * middle of the parsing operation. That could be handled by refactoring it to
 * take a 'include file getter' function.
 */

/*
 * Describes a single label given in a pxe file.
 *
 * Create these with the 'label_create' function given below.
 *
 * name - the name of the menu as given on the 'menu label' line.
 * kernel - the path to the kernel file to use for this label.
 * append - kernel command line to use when booting this label
 * initrd - path to the initrd to use for this label.
 * attempted - 0 if we haven't tried to boot this label, 1 if we have.
 * localboot - 1 if this label specified 'localboot', 0 otherwise.
 * list - lets these form a list, which a pxe_menu struct will hold.
 */
struct pxe_label {
472
	char num[4];
Jason Hobbs's avatar
Jason Hobbs committed
473
	char *name;
474
	char *menu;
Jason Hobbs's avatar
Jason Hobbs committed
475 476 477
	char *kernel;
	char *append;
	char *initrd;
478
	char *fdt;
479
	char *fdtdir;
Rob Herring's avatar
Rob Herring committed
480
	int ipappend;
Jason Hobbs's avatar
Jason Hobbs committed
481 482
	int attempted;
	int localboot;
483
	int localboot_val;
Jason Hobbs's avatar
Jason Hobbs committed
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
	struct list_head list;
};

/*
 * Describes a pxe menu as given via pxe files.
 *
 * title - the name of the menu as given by a 'menu title' line.
 * default_label - the name of the default label, if any.
 * timeout - time in tenths of a second to wait for a user key-press before
 *           booting the default label.
 * prompt - if 0, don't prompt for a choice unless the timeout period is
 *          interrupted.  If 1, always prompt for a choice regardless of
 *          timeout.
 * labels - a list of labels defined for the menu.
 */
struct pxe_menu {
	char *title;
	char *default_label;
	int timeout;
	int prompt;
	struct list_head labels;
};

/*
 * Allocates memory for and initializes a pxe_label. This uses malloc, so the
 * result must be free()'d to reclaim the memory.
 *
 * Returns NULL if malloc fails.
 */
static struct pxe_label *label_create(void)
{
	struct pxe_label *label;

	label = malloc(sizeof(struct pxe_label));

	if (!label)
		return NULL;

	memset(label, 0, sizeof(struct pxe_label));

	return label;
}

/*
 * Free the memory used by a pxe_label, including that used by its name,
 * kernel, append and initrd members, if they're non NULL.
 *
 * So - be sure to only use dynamically allocated memory for the members of
 * the pxe_label struct, unless you want to clean it up first. These are
 * currently only created by the pxe file parsing code.
 */
static void label_destroy(struct pxe_label *label)
{
	if (label->name)
		free(label->name);

	if (label->kernel)
		free(label->kernel);

	if (label->append)
		free(label->append);

	if (label->initrd)
		free(label->initrd);

549 550 551
	if (label->fdt)
		free(label->fdt);

552 553 554
	if (label->fdtdir)
		free(label->fdtdir);

Jason Hobbs's avatar
Jason Hobbs committed
555 556 557 558 559 560 561 562 563 564 565 566
	free(label);
}

/*
 * Print a label and its string members if they're defined.
 *
 * This is passed as a callback to the menu code for displaying each
 * menu entry.
 */
static void label_print(void *data)
{
	struct pxe_label *label = data;
567
	const char *c = label->menu ? label->menu : label->name;
Jason Hobbs's avatar
Jason Hobbs committed
568

569
	printf("%s:\t%s\n", label->num, c);
Jason Hobbs's avatar
Jason Hobbs committed
570 571 572 573
}

/*
 * Boot a label that specified 'localboot'. This requires that the 'localcmd'
574
 * environment variable is defined. Its contents will be executed as U-Boot
Jason Hobbs's avatar
Jason Hobbs committed
575 576 577 578 579 580 581 582
 * command.  If the label specified an 'append' line, its contents will be
 * used to overwrite the contents of the 'bootargs' environment variable prior
 * to running 'localcmd'.
 *
 * Returns 1 on success or < 0 on error.
 */
static int label_localboot(struct pxe_label *label)
{
583
	char *localcmd;
Jason Hobbs's avatar
Jason Hobbs committed
584 585 586 587 588 589

	localcmd = from_env("localcmd");

	if (!localcmd)
		return -ENOENT;

590 591 592 593 594 595
	if (label->append) {
		char bootargs[CONFIG_SYS_CBSIZE];

		cli_simple_process_macros(label->append, bootargs);
		setenv("bootargs", bootargs);
	}
Jason Hobbs's avatar
Jason Hobbs committed
596

597
	debug("running: %s\n", localcmd);
Jason Hobbs's avatar
Jason Hobbs committed
598

599
	return run_command_list(localcmd, strlen(localcmd), 0);
Jason Hobbs's avatar
Jason Hobbs committed
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
}

/*
 * Boot according to the contents of a pxe_label.
 *
 * If we can't boot for any reason, we return.  A successful boot never
 * returns.
 *
 * The kernel will be stored in the location given by the 'kernel_addr_r'
 * environment variable.
 *
 * If the label specifies an initrd file, it will be stored in the location
 * given by the 'ramdisk_addr_r' environment variable.
 *
 * If the label specifies an 'append' line, its contents will overwrite that
 * of the 'bootargs' environment variable.
 */
617
static int label_boot(cmd_tbl_t *cmdtp, struct pxe_label *label)
Jason Hobbs's avatar
Jason Hobbs committed
618 619
{
	char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL };
620
	char initrd_str[22];
Rob Herring's avatar
Rob Herring committed
621 622
	char mac_str[29] = "";
	char ip_str[68] = "";
623
	int bootm_argc = 2;
Rob Herring's avatar
Rob Herring committed
624
	int len = 0;
625 626
	ulong kernel_addr;
	void *buf;
Jason Hobbs's avatar
Jason Hobbs committed
627 628 629 630 631 632

	label_print(label);

	label->attempted = 1;

	if (label->localboot) {
633 634 635
		if (label->localboot_val >= 0)
			label_localboot(label);
		return 0;
Jason Hobbs's avatar
Jason Hobbs committed
636 637 638 639 640
	}

	if (label->kernel == NULL) {
		printf("No kernel given, skipping %s\n",
				label->name);
641
		return 1;
Jason Hobbs's avatar
Jason Hobbs committed
642 643 644
	}

	if (label->initrd) {
645
		if (get_relfile_envaddr(cmdtp, label->initrd, "ramdisk_addr_r") < 0) {
Jason Hobbs's avatar
Jason Hobbs committed
646 647
			printf("Skipping %s for failure retrieving initrd\n",
					label->name);
648
			return 1;
Jason Hobbs's avatar
Jason Hobbs committed
649 650
		}

651 652 653 654
		bootm_argv[2] = initrd_str;
		strcpy(bootm_argv[2], getenv("ramdisk_addr_r"));
		strcat(bootm_argv[2], ":");
		strcat(bootm_argv[2], getenv("filesize"));
Jason Hobbs's avatar
Jason Hobbs committed
655 656
	}

657
	if (get_relfile_envaddr(cmdtp, label->kernel, "kernel_addr_r") < 0) {
Jason Hobbs's avatar
Jason Hobbs committed
658 659
		printf("Skipping %s for failure retrieving kernel\n",
				label->name);
660
		return 1;
Jason Hobbs's avatar
Jason Hobbs committed
661 662
	}

Rob Herring's avatar
Rob Herring committed
663 664 665 666 667 668
	if (label->ipappend & 0x1) {
		sprintf(ip_str, " ip=%s:%s:%s:%s",
			getenv("ipaddr"), getenv("serverip"),
			getenv("gatewayip"), getenv("netmask"));
	}

669
#ifdef CONFIG_CMD_NET
Rob Herring's avatar
Rob Herring committed
670 671 672 673 674 675 676
	if (label->ipappend & 0x2) {
		int err;
		strcpy(mac_str, " BOOTIF=");
		err = format_mac_pxe(mac_str + 8, sizeof(mac_str) - 8);
		if (err < 0)
			mac_str[0] = '\0';
	}
677
#endif
Rob Herring's avatar
Rob Herring committed
678

679 680 681
	if ((label->ipappend & 0x3) || label->append) {
		char bootargs[CONFIG_SYS_CBSIZE] = "";
		char finalbootargs[CONFIG_SYS_CBSIZE];
Rob Herring's avatar
Rob Herring committed
682

683 684 685 686 687 688 689 690 691
		if (strlen(label->append ?: "") +
		    strlen(ip_str) + strlen(mac_str) + 1 > sizeof(bootargs)) {
			printf("bootarg overflow %zd+%zd+%zd+1 > %zd\n",
			       strlen(label->append ?: ""),
			       strlen(ip_str), strlen(mac_str),
			       sizeof(bootargs));
			return 1;
		}

Rob Herring's avatar
Rob Herring committed
692 693 694 695 696
		if (label->append)
			strcpy(bootargs, label->append);
		strcat(bootargs, ip_str);
		strcat(bootargs, mac_str);

697 698 699
		cli_simple_process_macros(bootargs, finalbootargs);
		setenv("bootargs", finalbootargs);
		printf("append: %s\n", finalbootargs);
700
	}
Jason Hobbs's avatar
Jason Hobbs committed
701 702 703 704

	bootm_argv[1] = getenv("kernel_addr_r");

	/*
705 706 707 708 709 710 711 712 713 714 715
	 * fdt usage is optional:
	 * It handles the following scenarios. All scenarios are exclusive
	 *
	 * Scenario 1: If fdt_addr_r specified and "fdt" label is defined in
	 * pxe file, retrieve fdt blob from server. Pass fdt_addr_r to bootm,
	 * and adjust argc appropriately.
	 *
	 * Scenario 2: If there is an fdt_addr specified, pass it along to
	 * bootm, and adjust argc appropriately.
	 *
	 * Scenario 3: fdt blob is not available.
Jason Hobbs's avatar
Jason Hobbs committed
716
	 */
717 718 719
	bootm_argv[3] = getenv("fdt_addr_r");

	/* if fdt label is defined then get fdt from server */
720 721 722 723 724 725 726
	if (bootm_argv[3]) {
		char *fdtfile = NULL;
		char *fdtfilefree = NULL;

		if (label->fdt) {
			fdtfile = label->fdt;
		} else if (label->fdtdir) {
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
			char *f1, *f2, *f3, *f4, *slash;

			f1 = getenv("fdtfile");
			if (f1) {
				f2 = "";
				f3 = "";
				f4 = "";
			} else {
				/*
				 * For complex cases where this code doesn't
				 * generate the correct filename, the board
				 * code should set $fdtfile during early boot,
				 * or the boot scripts should set $fdtfile
				 * before invoking "pxe" or "sysboot".
				 */
				f1 = getenv("soc");
				f2 = "-";
				f3 = getenv("board");
				f4 = ".dtb";
746
			}
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767

			len = strlen(label->fdtdir);
			if (!len)
				slash = "./";
			else if (label->fdtdir[len - 1] != '/')
				slash = "/";
			else
				slash = "";

			len = strlen(label->fdtdir) + strlen(slash) +
				strlen(f1) + strlen(f2) + strlen(f3) +
				strlen(f4) + 1;
			fdtfilefree = malloc(len);
			if (!fdtfilefree) {
				printf("malloc fail (FDT filename)\n");
				return 1;
			}

			snprintf(fdtfilefree, len, "%s%s%s%s%s%s",
				 label->fdtdir, slash, f1, f2, f3, f4);
			fdtfile = fdtfilefree;
768
		}
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783

		if (fdtfile) {
			int err = get_relfile_envaddr(cmdtp, fdtfile, "fdt_addr_r");
			free(fdtfilefree);
			if (err < 0) {
				printf("Skipping %s for failure retrieving fdt\n",
						label->name);
				return 1;
			}
		} else {
			bootm_argv[3] = NULL;
		}
	}

	if (!bootm_argv[3])
784
		bootm_argv[3] = getenv("fdt_addr");
Jason Hobbs's avatar
Jason Hobbs committed
785

786 787 788
	if (bootm_argv[3]) {
		if (!bootm_argv[2])
			bootm_argv[2] = "-";
Jason Hobbs's avatar
Jason Hobbs committed
789
		bootm_argc = 4;
790
	}
Jason Hobbs's avatar
Jason Hobbs committed
791

792 793 794 795 796
	kernel_addr = genimg_get_kernel_addr(bootm_argv[1]);
	buf = map_sysmem(kernel_addr, 0);
	/* Try bootm for legacy and FIT format image */
	if (genimg_get_format(buf) != IMAGE_FORMAT_INVALID)
		do_bootm(cmdtp, 0, bootm_argc, bootm_argv);
797 798 799 800 801 802
#ifdef CONFIG_CMD_BOOTI
	/* Try booting an AArch64 Linux kernel image */
	else
		do_booti(cmdtp, 0, bootm_argc, bootm_argv);
#elif defined(CONFIG_CMD_BOOTZ)
	/* Try booting a Image */
803 804
	else
		do_bootz(cmdtp, 0, bootm_argc, bootm_argv);
805
#endif
806
	unmap_sysmem(buf);
807
	return 1;
Jason Hobbs's avatar
Jason Hobbs committed
808 809 810 811 812 813 814 815 816 817 818 819 820 821
}

/*
 * Tokens for the pxe file parser.
 */
enum token_type {
	T_EOL,
	T_STRING,
	T_EOF,
	T_MENU,
	T_TITLE,
	T_TIMEOUT,
	T_LABEL,
	T_KERNEL,
822
	T_LINUX,
Jason Hobbs's avatar
Jason Hobbs committed
823 824 825 826 827 828
	T_APPEND,
	T_INITRD,
	T_LOCALBOOT,
	T_DEFAULT,
	T_PROMPT,
	T_INCLUDE,
829
	T_FDT,
830
	T_FDTDIR,
831
	T_ONTIMEOUT,
Rob Herring's avatar
Rob Herring committed
832
	T_IPAPPEND,
Jason Hobbs's avatar
Jason Hobbs committed
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
	T_INVALID
};

/*
 * A token - given by a value and a type.
 */
struct token {
	char *val;
	enum token_type type;
};

/*
 * Keywords recognized.
 */
static const struct token keywords[] = {
	{"menu", T_MENU},
	{"title", T_TITLE},
	{"timeout", T_TIMEOUT},
	{"default", T_DEFAULT},
	{"prompt", T_PROMPT},
	{"label", T_LABEL},
	{"kernel", T_KERNEL},
855
	{"linux", T_LINUX},
Jason Hobbs's avatar
Jason Hobbs committed
856 857 858 859
	{"localboot", T_LOCALBOOT},
	{"append", T_APPEND},
	{"initrd", T_INITRD},
	{"include", T_INCLUDE},
860
	{"devicetree", T_FDT},
861
	{"fdt", T_FDT},
862 863
	{"devicetreedir", T_FDTDIR},
	{"fdtdir", T_FDTDIR},
864
	{"ontimeout", T_ONTIMEOUT,},
Rob Herring's avatar
Rob Herring committed
865
	{"ipappend", T_IPAPPEND,},
Jason Hobbs's avatar
Jason Hobbs committed
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
	{NULL, T_INVALID}
};

/*
 * Since pxe(linux) files don't have a token to identify the start of a
 * literal, we have to keep track of when we're in a state where a literal is
 * expected vs when we're in a state a keyword is expected.
 */
enum lex_state {
	L_NORMAL = 0,
	L_KEYWORD,
	L_SLITERAL
};

/*
 * get_string retrieves a string from *p and stores it as a token in
 * *t.
 *
 * get_string used for scanning both string literals and keywords.
 *
 * Characters from *p are copied into t-val until a character equal to
 * delim is found, or a NUL byte is reached. If delim has the special value of
 * ' ', any whitespace character will be used as a delimiter.
 *
 * If lower is unequal to 0, uppercase characters will be converted to
 * lowercase in the result. This is useful to make keywords case
 * insensitive.
 *
 * The location of *p is updated to point to the first character after the end
 * of the token - the ending delimiter.
 *
 * On success, the new value of t->val is returned. Memory for t->val is
 * allocated using malloc and must be free()'d to reclaim it.  If insufficient
 * memory is available, NULL is returned.
 */
static char *get_string(char **p, struct token *t, char delim, int lower)
{
	char *b, *e;
	size_t len, i;

	/*
	 * b and e both start at the beginning of the input stream.
	 *
	 * e is incremented until we find the ending delimiter, or a NUL byte
	 * is reached. Then, we take e - b to find the length of the token.
	 */
	b = e = *p;

	while (*e) {
		if ((delim == ' ' && isspace(*e)) || delim == *e)
			break;
		e++;
	}

	len = e - b;

	/*
	 * Allocate memory to hold the string, and copy it in, converting
	 * characters to lowercase if lower is != 0.
	 */
	t->val = malloc(len + 1);
	if (!t->val)
		return NULL;

	for (i = 0; i < len; i++, b++) {
		if (lower)
			t->val[i] = tolower(*b);
		else
			t->val[i] = *b;
	}

	t->val[len] = '\0';

	/*
	 * Update *p so the caller knows where to continue scanning.
	 */
	*p = e;

	t->type = T_STRING;

	return t->val;
}

/*
 * Populate a keyword token with a type and value.
 */
static void get_keyword(struct token *t)
{
	int i;

	for (i = 0; keywords[i].val; i++) {
		if (!strcmp(t->val, keywords[i].val)) {
			t->type = keywords[i].type;
			break;
		}
	}
}

/*
 * Get the next token.  We have to keep track of which state we're in to know
 * if we're looking to get a string literal or a keyword.
 *
 * *p is updated to point at the first character after the current token.
 */
static void get_token(char **p, struct token *t, enum lex_state state)
{
	char *c = *p;

	t->type = T_INVALID;

	/* eat non EOL whitespace */
	while (isblank(*c))
		c++;

	/*
	 * eat comments. note that string literals can't begin with #, but
	 * can contain a # after their first character.
	 */
	if (*c == '#') {
		while (*c && *c != '\n')
			c++;
	}

	if (*c == '\n') {
		t->type = T_EOL;
		c++;
	} else if (*c == '\0') {
		t->type = T_EOF;
		c++;
	} else if (state == L_SLITERAL) {
		get_string(&c, t, '\n', 0);
	} else if (state == L_KEYWORD) {
		/*
		 * when we expect a keyword, we first get the next string
		 * token delimited by whitespace, and then check if it
		 * matches a keyword in our keyword list. if it does, it's
		 * converted to a keyword token of the appropriate type, and
		 * if not, it remains a string token.
		 */
		get_string(&c, t, ' ', 1);
		get_keyword(t);
	}

	*p = c;
}

/*
 * Increment *c until we get to the end of the current line, or EOF.
 */
static void eol_or_eof(char **c)
{
	while (**c && **c != '\n')
		(*c)++;
}

/*
 * All of these parse_* functions share some common behavior.
 *
 * They finish with *c pointing after the token they parse, and return 1 on
 * success, or < 0 on error.
 */

/*
 * Parse a string literal and store a pointer it at *dst. String literals
 * terminate at the end of the line.
 */
static int parse_sliteral(char **c, char **dst)
{
	struct token t;
	char *s = *c;

	get_token(c, &t, L_SLITERAL);

	if (t.type != T_STRING) {
		printf("Expected string literal: %.*s\n", (int)(*c - s), s);
		return -EINVAL;
	}

	*dst = t.val;

	return 1;
}

/*
 * Parse a base 10 (unsigned) integer and store it at *dst.
 */
static int parse_integer(char **c, int *dst)
{
	struct token t;
	char *s = *c;

	get_token(c, &t, L_SLITERAL);

	if (t.type != T_STRING) {
		printf("Expected string: %.*s\n", (int)(*c - s), s);
		return -EINVAL;
	}

1064
	*dst = simple_strtol(t.val, NULL, 10);
Jason Hobbs's avatar
Jason Hobbs committed
1065 1066 1067 1068 1069 1070

	free(t.val);

	return 1;
}

1071 1072
static int parse_pxefile_top(cmd_tbl_t *cmdtp, char *p, unsigned long base,
	struct pxe_menu *cfg, int nest_level);
Jason Hobbs's avatar
Jason Hobbs committed
1073 1074 1075 1076 1077 1078 1079 1080 1081

/*
 * Parse an include statement, and retrieve and parse the file it mentions.
 *
 * base should point to a location where it's safe to store the file, and
 * nest_level should indicate how many nested includes have occurred. For this
 * include, nest_level has already been incremented and doesn't need to be
 * incremented here.
 */
1082
static int handle_include(cmd_tbl_t *cmdtp, char **c, unsigned long base,
Jason Hobbs's avatar
Jason Hobbs committed
1083 1084 1085 1086 1087
				struct pxe_menu *cfg, int nest_level)
{
	char *include_path;
	char *s = *c;
	int err;
1088 1089
	char *buf;
	int ret;
Jason Hobbs's avatar
Jason Hobbs committed
1090 1091 1092 1093 1094 1095 1096 1097 1098

	err = parse_sliteral(c, &include_path);

	if (err < 0) {
		printf("Expected include path: %.*s\n",
				 (int)(*c - s), s);
		return err;
	}

1099
	err = get_pxe_file(cmdtp, include_path, base);
Jason Hobbs's avatar
Jason Hobbs committed
1100 1101 1102 1103 1104 1105

	if (err < 0) {
		printf("Couldn't retrieve %s\n", include_path);
		return err;
	}

1106 1107 1108 1109 1110
	buf = map_sysmem(base, 0);
	ret = parse_pxefile_top(cmdtp, buf, base, cfg, nest_level);
	unmap_sysmem(buf);

	return ret;
Jason Hobbs's avatar
Jason Hobbs committed
1111 1112 1113 1114 1115
}

/*
 * Parse lines that begin with 'menu'.
 *
1116
 * base and nest are provided to handle the 'menu include' case.
Jason Hobbs's avatar
Jason Hobbs committed
1117
 *
1118
 * base should point to a location where it's safe to store the included file.
Jason Hobbs's avatar
Jason Hobbs committed
1119 1120 1121 1122
 *
 * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
 * a file it includes, 3 when parsing a file included by that file, and so on.
 */
1123 1124
static int parse_menu(cmd_tbl_t *cmdtp, char **c, struct pxe_menu *cfg,
				unsigned long base, int nest_level)
Jason Hobbs's avatar
Jason Hobbs committed
1125 1126 1127
{
	struct token t;
	char *s = *c;
1128
	int err = 0;
Jason Hobbs's avatar
Jason Hobbs committed
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138

	get_token(c, &t, L_KEYWORD);

	switch (t.type) {
	case T_TITLE:
		err = parse_sliteral(c, &cfg->title);

		break;

	case T_INCLUDE:
1139
		err = handle_include(cmdtp, c, base, cfg,
Jason Hobbs's avatar
Jason Hobbs committed
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
						nest_level + 1);
		break;

	default:
		printf("Ignoring malformed menu command: %.*s\n",
				(int)(*c - s), s);
	}

	if (err < 0)
		return err;

	eol_or_eof(c);

	return 1;
}

/*
 * Handles parsing a 'menu line' when we're parsing a label.
 */
static int parse_label_menu(char **c, struct pxe_menu *cfg,
				struct pxe_label *label)
{
	struct token t;
	char *s;

	s = *c;

	get_token(c, &t, L_KEYWORD);

	switch (t.type) {
	case T_DEFAULT:
1171 1172
		if (!cfg->default_label)
			cfg->default_label = strdup(label->name);
Jason Hobbs's avatar
Jason Hobbs committed
1173 1174 1175 1176

		if (!cfg->default_label)
			return -ENOMEM;

1177 1178 1179
		break;
	case T_LABEL:
		parse_sliteral(c, &label->menu);
Jason Hobbs's avatar
Jason Hobbs committed
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201
		break;
	default:
		printf("Ignoring malformed menu command: %.*s\n",
				(int)(*c - s), s);
	}

	eol_or_eof(c);

	return 0;
}

/*
 * Parses a label and adds it to the list of labels for a menu.
 *
 * A label ends when we either get to the end of a file, or
 * get some input we otherwise don't have a handler defined
 * for.
 *
 */
static int parse_label(char **c, struct pxe_menu *cfg)
{
	struct token t;
1202
	int len;
Jason Hobbs's avatar
Jason Hobbs committed
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
	char *s = *c;
	struct pxe_label *label;
	int err;

	label = label_create();
	if (!label)
		return -ENOMEM;

	err = parse_sliteral(c, &label->name);
	if (err < 0) {
		printf("Expected label name: %.*s\n", (int)(*c - s), s);
		label_destroy(label);
		return -EINVAL;
	}

	list_add_tail(&label->list, &cfg->labels);

	while (1) {
		s = *c;
		get_token(c, &t, L_KEYWORD);

		err = 0;
		switch (t.type) {
		case T_MENU:
			err = parse_label_menu(c, cfg, label);
			break;

		case T_KERNEL:
1231
		case T_LINUX:
Jason Hobbs's avatar
Jason Hobbs committed
1232 1233 1234 1235 1236
			err = parse_sliteral(c, &label->kernel);
			break;

		case T_APPEND:
			err = parse_sliteral(c, &label->append);
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
			if (label->initrd)
				break;
			s = strstr(label->append, "initrd=");
			if (!s)
				break;
			s += 7;
			len = (int)(strchr(s, ' ') - s);
			label->initrd = malloc(len + 1);
			strncpy(label->initrd, s, len);
			label->initrd[len] = '\0';

Jason Hobbs's avatar
Jason Hobbs committed
1248 1249 1250
			break;

		case T_INITRD:
1251 1252
			if (!label->initrd)
				err = parse_sliteral(c, &label->initrd);
Jason Hobbs's avatar
Jason Hobbs committed
1253 1254
			break;

1255 1256 1257 1258 1259
		case T_FDT:
			if (!label->fdt)
				err = parse_sliteral(c, &label->fdt);
			break;

1260 1261 1262 1263 1264
		case T_FDTDIR:
			if (!label->fdtdir)
				err = parse_sliteral(c, &label->fdtdir);
			break;

Jason Hobbs's avatar
Jason Hobbs committed
1265
		case T_LOCALBOOT:
1266 1267
			label->localboot = 1;
			err = parse_integer(c, &label->localboot_val);
Jason Hobbs's avatar
Jason Hobbs committed
1268 1269
			break;

Rob Herring's avatar
Rob Herring committed
1270 1271 1272 1273
		case T_IPAPPEND:
			err = parse_integer(c, &label->ipappend);
			break;

Jason Hobbs's avatar
Jason Hobbs committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
		case T_EOL:
			break;

		default:
			/*
			 * put the token back! we don't want it - it's the end
			 * of a label and whatever token this is, it's
			 * something for the menu level context to handle.
			 */
			*c = s;
			return 1;
		}

		if (err < 0)
			return err;
	}
}

/*
 * This 16 comes from the limit pxelinux imposes on nested includes.
 *
 * There is no reason at all we couldn't do more, but some limit helps prevent
 * infinite (until crash occurs) recursion if a file tries to include itself.
 */
#define MAX_NEST_LEVEL 16

/*
 * Entry point for parsing a menu file. nest_level indicates how many times
 * we've nested in includes.  It will be 1 for the top level menu file.
 *
 * Returns 1 on success, < 0 on error.
 */
1306 1307
static int parse_pxefile_top(cmd_tbl_t *cmdtp, char *p, unsigned long base,
				struct pxe_menu *cfg, int nest_level)
Jason Hobbs's avatar
Jason Hobbs committed
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
{
	struct token t;
	char *s, *b, *label_name;
	int err;

	b = p;

	if (nest_level > MAX_NEST_LEVEL) {
		printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL);
		return -EMLINK;
	}

	while (1) {
		s = p;

		get_token(&p, &t, L_KEYWORD);

		err = 0;
		switch (t.type) {
		case T_MENU:
1328
			cfg->prompt = 1;
1329 1330 1331
			err = parse_menu(cmdtp, &p, cfg,
				base + ALIGN(strlen(b) + 1, 4),
				nest_level);
Jason Hobbs's avatar
Jason Hobbs committed
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
			break;

		case T_TIMEOUT:
			err = parse_integer(&p, &cfg->timeout);
			break;

		case T_LABEL:
			err = parse_label(&p, cfg);
			break;

		case T_DEFAULT:
1343
		case T_ONTIMEOUT:
Jason Hobbs's avatar
Jason Hobbs committed
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
			err = parse_sliteral(&p, &label_name);

			if (label_name) {
				if (cfg->default_label)
					free(cfg->default_label);

				cfg->default_label = label_name;
			}

			break;

1355
		case T_INCLUDE:
1356 1357 1358
			err = handle_include(cmdtp, &p,
				base + ALIGN(strlen(b), 4), cfg,
				nest_level + 1);
1359 1360
			break;

Jason Hobbs's avatar
Jason Hobbs committed
1361
		case T_PROMPT:
1362
			eol_or_eof(&p);
Jason Hobbs's avatar
Jason Hobbs committed
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
			break;

		case T_EOL:
			break;

		case T_EOF:
			return 1;

		default:
			printf("Ignoring unknown command: %.*s\n",
							(int)(p - s), s);
			eol_or_eof(&p);
		}

		if (err < 0)
			return err;
	}
}

/*
 * Free the memory used by a pxe_menu and its labels.
 */
static void destroy_pxe_menu(struct pxe_menu *cfg)
{
	struct list_head *pos, *n;
	struct pxe_label *label;

	if (cfg->title)
		free(cfg->title);

	if (cfg->default_label)
		free(cfg->default_label);

	list_for_each_safe(pos, n, &cfg->labels) {
		label = list_entry(pos, struct pxe_label, list);

		label_destroy(label);
	}

	free(cfg);
}

/*
 * Entry point for parsing a pxe file. This is only used for the top level
 * file.
 *
 * Returns NULL if there is an error, otherwise, returns a pointer to a
 * pxe_menu struct populated with the results of parsing the pxe file (and any
 * files it includes). The resulting pxe_menu struct can be free()'d by using
 * the destroy_pxe_menu() function.
 */
1414
static struct pxe_menu *parse_pxefile(cmd_tbl_t *cmdtp, unsigned long menucfg)
Jason Hobbs's avatar
Jason Hobbs committed
1415 1416
{
	struct pxe_menu *cfg;
1417 1418
	char *buf;
	int r;
Jason Hobbs's avatar
Jason Hobbs committed
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428

	cfg = malloc(sizeof(struct pxe_menu));

	if (!cfg)
		return NULL;

	memset(cfg, 0, sizeof(struct pxe_menu));

	INIT_LIST_HEAD(&cfg->labels);

1429 1430 1431 1432 1433
	buf = map_sysmem(menucfg, 0);
	r = parse_pxefile_top(cmdtp, buf, menucfg, cfg, 1);
	unmap_sysmem(buf);

	if (r < 0) {
Jason Hobbs's avatar
Jason Hobbs committed
1434 1435 1436 1437 1438 1439 1440 1441
		destroy_pxe_menu(cfg);
		return NULL;
	}

	return cfg;
}

/*
1442
 * Converts a pxe_menu struct into a menu struct for use with U-Boot's generic
Jason Hobbs's avatar
Jason Hobbs committed
1443 1444 1445 1446 1447 1448 1449 1450
 * menu code.
 */
static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
{
	struct pxe_label *label;
	struct list_head *pos;
	struct menu *m;
	int err;
1451 1452
	int i = 1;
	char *default_num = NULL;
Jason Hobbs's avatar
Jason Hobbs committed
1453 1454 1455 1456

	/*
	 * Create a menu and add items for all the labels.
	 */
1457 1458
	m = menu_create(cfg->title, cfg->timeout, cfg->prompt, label_print,
			NULL, NULL);
Jason Hobbs's avatar
Jason Hobbs committed
1459 1460 1461 1462 1463 1464 1465

	if (!m)
		return NULL;

	list_for_each(pos, &cfg->labels) {
		label = list_entry(pos, struct pxe_label, list);

1466 1467
		sprintf(label->num, "%d", i++);
		if (menu_item_add(m, label->num, label) != 1) {
Jason Hobbs's avatar
Jason Hobbs committed
1468 1469 1470
			menu_destroy(m);
			return NULL;
		}
1471
		if (cfg->default_label &&
1472
		    (strcmp(label->name, cfg->default_label) == 0))
1473 1474
			default_num = label->num;

Jason Hobbs's avatar
Jason Hobbs committed
1475 1476 1477 1478 1479 1480
	}

	/*
	 * After we've created items for each label in the menu, set the
	 * menu's default label if one was specified.
	 */
1481 1482
	if (default_num) {
		err = menu_default_set(m, default_num);
Jason Hobbs's avatar
Jason Hobbs committed
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
		if (err != 1) {
			if (err != -ENOENT) {
				menu_destroy(m);
				return NULL;
			}

			printf("Missing default: %s\n", cfg->default_label);
		}
	}

	return m;
}

/*
 * Try to boot any labels we have yet to attempt to boot.
 */
1499
static void boot_unattempted_labels(cmd_tbl_t *cmdtp, struct pxe_menu *cfg)
Jason Hobbs's avatar
Jason Hobbs committed
1500 1501 1502 1503 1504 1505 1506 1507
{
	struct list_head *pos;
	struct pxe_label *label;

	list_for_each(pos, &cfg->labels) {
		label = list_entry(pos, struct pxe_label, list);

		if (!label->attempted)
1508
			label_boot(cmdtp, label);
Jason Hobbs's avatar
Jason Hobbs committed
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
	}
}

/*
 * Boot the system as prescribed by a pxe_menu.
 *
 * Use the menu system to either get the user's choice or the default, based
 * on config or user input.  If there is no default or user's choice,
 * attempted to boot labels in the order they were given in pxe files.
 * If the default or user's choice fails to boot, attempt to boot other
 * labels in the order they were given in pxe files.
 *
 * If this function returns, there weren't any labels that successfully
 * booted, or the user interrupted the menu selection via ctrl+c.
 */
1524
static void handle_pxe_menu(cmd_tbl_t *cmdtp, struct pxe_menu *cfg)
Jason Hobbs's avatar
Jason Hobbs committed
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
{
	void *choice;
	struct menu *m;
	int err;

	m = pxe_menu_to_menu(cfg);
	if (!m)
		return;

	err = menu_get_choice(m, &choice);

	menu_destroy(m);

1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
	/*
	 * err == 1 means we got a choice back from menu_get_choice.
	 *
	 * err == -ENOENT if the menu was setup to select the default but no
	 * default was set. in that case, we should continue trying to boot
	 * labels that haven't been attempted yet.
	 *
	 * otherwise, the user interrupted or there was some other error and
	 * we give up.
	 */
Jason Hobbs's avatar
Jason Hobbs committed
1548

1549
	if (err == 1) {
1550
		err = label_boot(cmdtp, choice);
1551 1552 1553
		if (!err)
			return;
	} else if (err != -ENOENT) {
1554
		return;
1555
	}
Jason Hobbs's avatar
Jason Hobbs committed
1556

1557
	boot_unattempted_labels(cmdtp, cfg);
Jason Hobbs's avatar
Jason Hobbs committed
1558 1559
}

1560
#ifdef CONFIG_CMD_NET
Jason Hobbs's avatar
Jason Hobbs committed
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572
/*
 * Boots a system using a pxe file
 *
 * Returns 0 on success, 1 on error.
 */
static int
do_pxe_boot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	unsigned long pxefile_addr_r;
	struct pxe_menu *cfg;
	char *pxefile_addr_str;

1573 1574
	do_getfile = do_get_tftp;

Jason Hobbs's avatar
Jason Hobbs committed
1575 1576 1577 1578 1579 1580 1581 1582
	if (argc == 1) {
		pxefile_addr_str = from_env("pxefile_addr_r");
		if (!pxefile_addr_str)
			return 1;

	} else if (argc == 2) {
		pxefile_addr_str = argv[1];
	} else {
1583
		return CMD_RET_USAGE;
Jason Hobbs's avatar
Jason Hobbs committed
1584 1585 1586 1587 1588 1589 1590
	}

	if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
		printf("Invalid pxefile address: %s\n", pxefile_addr_str);
		return 1;
	}

1591
	cfg = parse_pxefile(cmdtp, pxefile_addr_r);
Jason Hobbs's avatar
Jason Hobbs committed
1592 1593 1594 1595 1596 1597

	if (cfg == NULL) {
		printf("Error parsing config file\n");
		return 1;
	}

1598
	handle_pxe_menu(cmdtp, cfg);
Jason Hobbs's avatar
Jason Hobbs committed
1599 1600 1601

	destroy_pxe_menu(cfg);

1602
	copy_filename(net_boot_file_name, "", sizeof(net_boot_file_name));
1603

Jason Hobbs's avatar
Jason Hobbs committed
1604 1605 1606 1607 1608 1609 1610 1611
	return 0;
}

static cmd_tbl_t cmd_pxe_sub[] = {
	U_BOOT_CMD_MKENT(get, 1, 1, do_pxe_get, "", ""),
	U_BOOT_CMD_MKENT(boot, 2, 1, do_pxe_boot, "", "")
};

1612
static int do_pxe(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
Jason Hobbs's avatar
Jason Hobbs committed
1613 1614 1615 1616
{
	cmd_tbl_t *cp;

	if (argc < 2)
1617
		return CMD_RET_USAGE;
Jason Hobbs's avatar
Jason Hobbs committed
1618

1619 1620
	is_pxe = true;

Jason Hobbs's avatar
Jason Hobbs committed
1621 1622 1623 1624 1625 1626 1627 1628 1629
	/* drop initial "pxe" arg */
	argc--;
	argv++;

	cp = find_cmd_tbl(argv[0], cmd_pxe_sub, ARRAY_SIZE(cmd_pxe_sub));

	if (cp)
		return cp->cmd(cmdtp, flag, argc, argv);

1630
	return CMD_RET_USAGE;
Jason Hobbs's avatar
Jason Hobbs committed
1631 1632 1633 1634 1635 1636 1637 1638
}

U_BOOT_CMD(
	pxe, 3, 1, do_pxe,
	"commands to get and boot from pxe files",
	"get - try to retrieve a pxe file using tftp\npxe "
	"boot [pxefile_addr_r] - boot from the pxe file at pxefile_addr_r\n"
);
1639
#endif
1640 1641 1642 1643 1644 1645

/*
 * Boots a system using a local disk syslinux/extlinux file
 *
 * Returns 0 on success, 1 on error.
 */
1646
static int do_sysboot(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
1647 1648 1649 1650 1651 1652 1653
{
	unsigned long pxefile_addr_r;
	struct pxe_menu *cfg;
	char *pxefile_addr_str;
	char *filename;
	int prompt = 0;

1654 1655
	is_pxe = false;

1656
	if (argc > 1 && strstr(argv[1], "-p")) {
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
		prompt = 1;
		argc--;
		argv++;
	}

	if (argc < 4)
		return cmd_usage(cmdtp);

	if (argc < 5) {
		pxefile_addr_str = from_env("pxefile_addr_r");
		if (!pxefile_addr_str)
			return 1;
	} else {
		pxefile_addr_str = argv[4];
	}

	if (argc < 6)
		filename = getenv("bootfile");
	else {
		filename = argv[5];
		setenv("bootfile", filename);
	}

	if (strstr(argv[3], "ext2"))
		do_getfile = do_get_ext2;
	else if (strstr(argv[3], "fat"))
		do_getfile = do_get_fat;
1684 1685
	else if (strstr(argv[3], "any"))
		do_getfile = do_get_any;
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
	else {
		printf("Invalid filesystem: %s\n", argv[3]);
		return 1;
	}
	fs_argv[1] = argv[1];
	fs_argv[2] = argv[2];

	if (strict_strtoul(pxefile_addr_str, 16, &pxefile_addr_r) < 0) {
		printf("Invalid pxefile address: %s\n", pxefile_addr_str);
		return 1;
	}

1698
	if (get_pxe_file(cmdtp, filename, pxefile_addr_r) < 0) {
1699 1700 1701 1702
		printf("Error reading config file\n");
		return 1;
	}

1703
	cfg = parse_pxefile(cmdtp, pxefile_addr_r);
1704 1705 1706 1707 1708 1709 1710 1711 1712

	if (cfg == NULL) {
		printf("Error parsing config file\n");
		return 1;
	}

	if (prompt)
		cfg->prompt = 1;

1713
	handle_pxe_menu(cmdtp, cfg);
1714 1715 1716 1717 1718 1719 1720 1721 1722

	destroy_pxe_menu(cfg);

	return 0;
}

U_BOOT_CMD(
	sysboot, 7, 1, do_sysboot,
	"command to get and boot from syslinux files",
1723 1724 1725
	"[-p] <interface> <dev[:part]> <ext2|fat|any> [addr] [filename]\n"
	"    - load and parse syslinux menu file 'filename' from ext2, fat\n"
	"      or any filesystem on 'dev' on 'interface' to address 'addr'"
1726
);