blob: 0c24becae3939421ace5ff064e76442c9703e9b6 [file] [log] [blame]
Patrice Chotard2373cba2019-11-25 09:07:37 +01001// SPDX-License-Identifier: GPL-2.0+
2/*
3 * Copyright 2010-2011 Calxeda, Inc.
4 * Copyright (c) 2014, NVIDIA CORPORATION. All rights reserved.
5 */
6
7#include <common.h>
Simon Glass09140112020-05-10 11:40:03 -06008#include <command.h>
Patrice Chotard2373cba2019-11-25 09:07:37 +01009#include <env.h>
Simon Glass8e8ccfe2019-12-28 10:45:03 -070010#include <image.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060011#include <log.h>
Patrice Chotard2373cba2019-11-25 09:07:37 +010012#include <malloc.h>
13#include <mapmem.h>
14#include <lcd.h>
Simon Glass90526e92020-05-10 11:39:56 -060015#include <net.h>
Neil Armstrong69076df2021-01-20 09:54:53 +010016#include <fdt_support.h>
17#include <linux/libfdt.h>
Patrice Chotard2373cba2019-11-25 09:07:37 +010018#include <linux/string.h>
19#include <linux/ctype.h>
20#include <errno.h>
21#include <linux/list.h>
22
Zhang Ning02901462022-02-01 08:33:37 +080023#ifdef CONFIG_DM_RNG
24#include <dm.h>
25#include <rng.h>
26#endif
27
Patrice Chotard2373cba2019-11-25 09:07:37 +010028#include <splash.h>
29#include <asm/io.h>
30
31#include "menu.h"
32#include "cli.h"
33
34#include "pxe_utils.h"
35
Ben Wolsieffer2c4e0672019-11-28 00:07:08 -050036#define MAX_TFTP_PATH_LEN 512
Patrice Chotard2373cba2019-11-25 09:07:37 +010037
Simon Glass4d79e882021-10-14 12:48:08 -060038int pxe_get_file_size(ulong *sizep)
39{
40 const char *val;
41
42 val = from_env("filesize");
43 if (!val)
44 return -ENOENT;
45
46 if (strict_strtoul(val, 16, sizep) < 0)
47 return -EINVAL;
48
49 return 0;
50}
51
Simon Glass18109cc2021-10-14 12:48:01 -060052/**
53 * format_mac_pxe() - obtain a MAC address in the PXE format
54 *
55 * This produces a MAC-address string in the format for the current ethernet
56 * device:
57 *
58 * 01-aa-bb-cc-dd-ee-ff
59 *
60 * where aa-ff is the MAC address in hex
61 *
62 * @outbuf: Buffer to write string to
63 * @outbuf_len: length of buffer
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010064 * Return: 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no
Simon Glass18109cc2021-10-14 12:48:01 -060065 * current ethernet device
66 */
Patrice Chotard2373cba2019-11-25 09:07:37 +010067int format_mac_pxe(char *outbuf, size_t outbuf_len)
68{
69 uchar ethaddr[6];
70
71 if (outbuf_len < 21) {
72 printf("outbuf is too small (%zd < 21)\n", outbuf_len);
Simon Glass18109cc2021-10-14 12:48:01 -060073 return -ENOSPC;
Patrice Chotard2373cba2019-11-25 09:07:37 +010074 }
75
76 if (!eth_env_get_enetaddr_by_index("eth", eth_get_dev_index(), ethaddr))
77 return -ENOENT;
78
79 sprintf(outbuf, "01-%02x-%02x-%02x-%02x-%02x-%02x",
80 ethaddr[0], ethaddr[1], ethaddr[2],
81 ethaddr[3], ethaddr[4], ethaddr[5]);
82
83 return 1;
84}
85
Simon Glass18109cc2021-10-14 12:48:01 -060086/**
Simon Glass18109cc2021-10-14 12:48:01 -060087 * get_relfile() - read a file relative to the PXE file
88 *
Patrice Chotard2373cba2019-11-25 09:07:37 +010089 * As in pxelinux, paths to files referenced from files we retrieve are
90 * relative to the location of bootfile. get_relfile takes such a path and
91 * joins it with the bootfile path to get the full path to the target file. If
92 * the bootfile path is NULL, we use file_path as is.
93 *
Simon Glass18109cc2021-10-14 12:48:01 -060094 * @ctx: PXE context
95 * @file_path: File path to read (relative to the PXE file)
96 * @file_addr: Address to load file to
Simon Glass4d79e882021-10-14 12:48:08 -060097 * @filesizep: If not NULL, returns the file size in bytes
Simon Glass18109cc2021-10-14 12:48:01 -060098 * Returns 1 for success, or < 0 on error
Patrice Chotard2373cba2019-11-25 09:07:37 +010099 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600100static int get_relfile(struct pxe_context *ctx, const char *file_path,
Simon Glass4d79e882021-10-14 12:48:08 -0600101 unsigned long file_addr, ulong *filesizep)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100102{
103 size_t path_len;
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100104 char relfile[MAX_TFTP_PATH_LEN + 1];
Patrice Chotard2373cba2019-11-25 09:07:37 +0100105 char addr_buf[18];
Simon Glass4d79e882021-10-14 12:48:08 -0600106 ulong size;
107 int ret;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100108
Simon Glass74b7a2b2021-10-14 12:48:05 -0600109 if (file_path[0] == '/' && ctx->allow_abs_path)
110 *relfile = '\0';
111 else
112 strncpy(relfile, ctx->bootdir, MAX_TFTP_PATH_LEN);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100113
Simon Glass74b7a2b2021-10-14 12:48:05 -0600114 path_len = strlen(file_path) + strlen(relfile);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100115
116 if (path_len > MAX_TFTP_PATH_LEN) {
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100117 printf("Base path too long (%s%s)\n", relfile, file_path);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100118
119 return -ENAMETOOLONG;
120 }
121
122 strcat(relfile, file_path);
123
124 printf("Retrieving file: %s\n", relfile);
125
126 sprintf(addr_buf, "%lx", file_addr);
127
Simon Glass4d79e882021-10-14 12:48:08 -0600128 ret = ctx->getfile(ctx, relfile, addr_buf, &size);
129 if (ret < 0)
130 return log_msg_ret("get", ret);
131 if (filesizep)
132 *filesizep = size;
133
134 return 1;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100135}
136
Simon Glass18109cc2021-10-14 12:48:01 -0600137/**
138 * get_pxe_file() - read a file
139 *
140 * The file is read and nul-terminated
141 *
142 * @ctx: PXE context
143 * @file_path: File path to read (relative to the PXE file)
144 * @file_addr: Address to load file to
145 * Returns 1 for success, or < 0 on error
146 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600147int get_pxe_file(struct pxe_context *ctx, const char *file_path,
Simon Glass4d79e882021-10-14 12:48:08 -0600148 ulong file_addr)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100149{
Simon Glass4d79e882021-10-14 12:48:08 -0600150 ulong size;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100151 int err;
152 char *buf;
153
Simon Glass4d79e882021-10-14 12:48:08 -0600154 err = get_relfile(ctx, file_path, file_addr, &size);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100155 if (err < 0)
156 return err;
157
Simon Glass4d79e882021-10-14 12:48:08 -0600158 buf = map_sysmem(file_addr + size, 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100159 *buf = '\0';
160 unmap_sysmem(buf);
161
162 return 1;
163}
164
165#define PXELINUX_DIR "pxelinux.cfg/"
166
Simon Glass18109cc2021-10-14 12:48:01 -0600167/**
168 * get_pxelinux_path() - Get a file in the pxelinux.cfg/ directory
169 *
170 * @ctx: PXE context
171 * @file: Filename to process (relative to pxelinux.cfg/)
172 * Returns 1 for success, -ENAMETOOLONG if the resulting path is too long.
173 * or other value < 0 on other error
174 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600175int get_pxelinux_path(struct pxe_context *ctx, const char *file,
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100176 unsigned long pxefile_addr_r)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100177{
178 size_t base_len = strlen(PXELINUX_DIR);
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100179 char path[MAX_TFTP_PATH_LEN + 1];
Patrice Chotard2373cba2019-11-25 09:07:37 +0100180
181 if (base_len + strlen(file) > MAX_TFTP_PATH_LEN) {
182 printf("path (%s%s) too long, skipping\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100183 PXELINUX_DIR, file);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100184 return -ENAMETOOLONG;
185 }
186
187 sprintf(path, PXELINUX_DIR "%s", file);
188
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600189 return get_pxe_file(ctx, path, pxefile_addr_r);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100190}
191
Simon Glass18109cc2021-10-14 12:48:01 -0600192/**
193 * get_relfile_envaddr() - read a file to an address in an env var
194 *
Patrice Chotard2373cba2019-11-25 09:07:37 +0100195 * Wrapper to make it easier to store the file at file_path in the location
196 * specified by envaddr_name. file_path will be joined to the bootfile path,
197 * if any is specified.
198 *
Simon Glass18109cc2021-10-14 12:48:01 -0600199 * @ctx: PXE context
200 * @file_path: File path to read (relative to the PXE file)
201 * @envaddr_name: Name of environment variable which contains the address to
202 * load to
Simon Glass4d79e882021-10-14 12:48:08 -0600203 * @filesizep: Returns the file size in bytes
Simon Glass18109cc2021-10-14 12:48:01 -0600204 * Returns 1 on success, -ENOENT if @envaddr_name does not exist as an
205 * environment variable, -EINVAL if its format is not valid hex, or other
206 * value < 0 on other error
Patrice Chotard2373cba2019-11-25 09:07:37 +0100207 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600208static int get_relfile_envaddr(struct pxe_context *ctx, const char *file_path,
Simon Glass4d79e882021-10-14 12:48:08 -0600209 const char *envaddr_name, ulong *filesizep)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100210{
211 unsigned long file_addr;
212 char *envaddr;
213
214 envaddr = from_env(envaddr_name);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100215 if (!envaddr)
216 return -ENOENT;
217
218 if (strict_strtoul(envaddr, 16, &file_addr) < 0)
219 return -EINVAL;
220
Simon Glass4d79e882021-10-14 12:48:08 -0600221 return get_relfile(ctx, file_path, file_addr, filesizep);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100222}
223
Simon Glass18109cc2021-10-14 12:48:01 -0600224/**
225 * label_create() - crate a new PXE label
226 *
Patrice Chotard2373cba2019-11-25 09:07:37 +0100227 * Allocates memory for and initializes a pxe_label. This uses malloc, so the
228 * result must be free()'d to reclaim the memory.
229 *
Simon Glass18109cc2021-10-14 12:48:01 -0600230 * Returns a pointer to the label, or NULL if out of memory
Patrice Chotard2373cba2019-11-25 09:07:37 +0100231 */
232static struct pxe_label *label_create(void)
233{
234 struct pxe_label *label;
235
236 label = malloc(sizeof(struct pxe_label));
Patrice Chotard2373cba2019-11-25 09:07:37 +0100237 if (!label)
238 return NULL;
239
240 memset(label, 0, sizeof(struct pxe_label));
241
242 return label;
243}
244
Simon Glass18109cc2021-10-14 12:48:01 -0600245/**
246 * label_destroy() - free the memory used by a pxe_label
247 *
248 * This frees @label itself as well as memory used by its name,
249 * kernel, config, append, initrd, fdt, fdtdir and fdtoverlay members, if
250 * they're non-NULL.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100251 *
252 * So - be sure to only use dynamically allocated memory for the members of
253 * the pxe_label struct, unless you want to clean it up first. These are
254 * currently only created by the pxe file parsing code.
Simon Glass18109cc2021-10-14 12:48:01 -0600255 *
256 * @label: Label to free
Patrice Chotard2373cba2019-11-25 09:07:37 +0100257 */
258static void label_destroy(struct pxe_label *label)
259{
Simon Glass929860b2021-10-14 12:48:02 -0600260 free(label->name);
261 free(label->kernel);
262 free(label->config);
263 free(label->append);
264 free(label->initrd);
265 free(label->fdt);
266 free(label->fdtdir);
267 free(label->fdtoverlays);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100268 free(label);
269}
270
Simon Glass18109cc2021-10-14 12:48:01 -0600271/**
272 * label_print() - Print a label and its string members if they're defined
Patrice Chotard2373cba2019-11-25 09:07:37 +0100273 *
274 * This is passed as a callback to the menu code for displaying each
275 * menu entry.
Simon Glass18109cc2021-10-14 12:48:01 -0600276 *
277 * @data: Label to print (is cast to struct pxe_label *)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100278 */
279static void label_print(void *data)
280{
281 struct pxe_label *label = data;
282 const char *c = label->menu ? label->menu : label->name;
283
284 printf("%s:\t%s\n", label->num, c);
285}
286
Simon Glass18109cc2021-10-14 12:48:01 -0600287/**
288 * label_localboot() - Boot a label that specified 'localboot'
Patrice Chotard2373cba2019-11-25 09:07:37 +0100289 *
Simon Glass18109cc2021-10-14 12:48:01 -0600290 * This requires that the 'localcmd' environment variable is defined. Its
291 * contents will be executed as U-Boot commands. If the label specified an
292 * 'append' line, its contents will be used to overwrite the contents of the
293 * 'bootargs' environment variable prior to running 'localcmd'.
294 *
295 * @label: Label to process
296 * Returns 1 on success or < 0 on error
Patrice Chotard2373cba2019-11-25 09:07:37 +0100297 */
298static int label_localboot(struct pxe_label *label)
299{
300 char *localcmd;
301
302 localcmd = from_env("localcmd");
Patrice Chotard2373cba2019-11-25 09:07:37 +0100303 if (!localcmd)
304 return -ENOENT;
305
306 if (label->append) {
307 char bootargs[CONFIG_SYS_CBSIZE];
308
Simon Glass1a62d642020-11-05 10:33:47 -0700309 cli_simple_process_macros(label->append, bootargs,
310 sizeof(bootargs));
Patrice Chotard2373cba2019-11-25 09:07:37 +0100311 env_set("bootargs", bootargs);
312 }
313
314 debug("running: %s\n", localcmd);
315
316 return run_command_list(localcmd, strlen(localcmd), 0);
317}
318
Zhang Ning02901462022-02-01 08:33:37 +0800319/*
320 * label_boot_kaslrseed generate kaslrseed from hw rng
321 */
322
323static void label_boot_kaslrseed(void)
324{
325#ifdef CONFIG_DM_RNG
326 ulong fdt_addr;
327 struct fdt_header *working_fdt;
328 size_t n = 0x8;
329 struct udevice *dev;
330 u64 *buf;
331 int nodeoffset;
332 int err;
333
334 /* Get the main fdt and map it */
335 fdt_addr = hextoul(env_get("fdt_addr_r"), NULL);
336 working_fdt = map_sysmem(fdt_addr, 0);
337 err = fdt_check_header(working_fdt);
338 if (err)
339 return;
340
341 /* add extra size for holding kaslr-seed */
342 /* err is new fdt size, 0 or negtive */
343 err = fdt_shrink_to_minimum(working_fdt, 512);
344 if (err <= 0)
345 return;
346
347 if (uclass_get_device(UCLASS_RNG, 0, &dev) || !dev) {
348 printf("No RNG device\n");
349 return;
350 }
351
352 nodeoffset = fdt_find_or_add_subnode(working_fdt, 0, "chosen");
353 if (nodeoffset < 0) {
354 printf("Reading chosen node failed\n");
355 return;
356 }
357
358 buf = malloc(n);
359 if (!buf) {
360 printf("Out of memory\n");
361 return;
362 }
363
364 if (dm_rng_read(dev, buf, n)) {
365 printf("Reading RNG failed\n");
366 goto err;
367 }
368
369 err = fdt_setprop(working_fdt, nodeoffset, "kaslr-seed", buf, sizeof(buf));
370 if (err < 0) {
371 printf("Unable to set kaslr-seed on chosen node: %s\n", fdt_strerror(err));
372 goto err;
373 }
374err:
375 free(buf);
376#endif
377 return;
378}
379
Simon Glass18109cc2021-10-14 12:48:01 -0600380/**
381 * label_boot_fdtoverlay() - Loads fdt overlays specified in 'fdtoverlays'
382 *
383 * @ctx: PXE context
384 * @label: Label to process
Neil Armstrong69076df2021-01-20 09:54:53 +0100385 */
386#ifdef CONFIG_OF_LIBFDT_OVERLAY
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600387static void label_boot_fdtoverlay(struct pxe_context *ctx,
388 struct pxe_label *label)
Neil Armstrong69076df2021-01-20 09:54:53 +0100389{
390 char *fdtoverlay = label->fdtoverlays;
391 struct fdt_header *working_fdt;
392 char *fdtoverlay_addr_env;
393 ulong fdtoverlay_addr;
394 ulong fdt_addr;
395 int err;
396
397 /* Get the main fdt and map it */
Simon Glass7e5f4602021-07-24 09:03:29 -0600398 fdt_addr = hextoul(env_get("fdt_addr_r"), NULL);
Neil Armstrong69076df2021-01-20 09:54:53 +0100399 working_fdt = map_sysmem(fdt_addr, 0);
400 err = fdt_check_header(working_fdt);
401 if (err)
402 return;
403
404 /* Get the specific overlay loading address */
405 fdtoverlay_addr_env = env_get("fdtoverlay_addr_r");
406 if (!fdtoverlay_addr_env) {
407 printf("Invalid fdtoverlay_addr_r for loading overlays\n");
408 return;
409 }
410
Simon Glass7e5f4602021-07-24 09:03:29 -0600411 fdtoverlay_addr = hextoul(fdtoverlay_addr_env, NULL);
Neil Armstrong69076df2021-01-20 09:54:53 +0100412
413 /* Cycle over the overlay files and apply them in order */
414 do {
415 struct fdt_header *blob;
416 char *overlayfile;
417 char *end;
418 int len;
419
420 /* Drop leading spaces */
421 while (*fdtoverlay == ' ')
422 ++fdtoverlay;
423
424 /* Copy a single filename if multiple provided */
425 end = strstr(fdtoverlay, " ");
426 if (end) {
427 len = (int)(end - fdtoverlay);
428 overlayfile = malloc(len + 1);
429 strncpy(overlayfile, fdtoverlay, len);
430 overlayfile[len] = '\0';
431 } else
432 overlayfile = fdtoverlay;
433
434 if (!strlen(overlayfile))
435 goto skip_overlay;
436
437 /* Load overlay file */
Simon Glass4d79e882021-10-14 12:48:08 -0600438 err = get_relfile_envaddr(ctx, overlayfile, "fdtoverlay_addr_r",
439 NULL);
Neil Armstrong69076df2021-01-20 09:54:53 +0100440 if (err < 0) {
441 printf("Failed loading overlay %s\n", overlayfile);
442 goto skip_overlay;
443 }
444
445 /* Resize main fdt */
446 fdt_shrink_to_minimum(working_fdt, 8192);
447
448 blob = map_sysmem(fdtoverlay_addr, 0);
449 err = fdt_check_header(blob);
450 if (err) {
451 printf("Invalid overlay %s, skipping\n",
452 overlayfile);
453 goto skip_overlay;
454 }
455
456 err = fdt_overlay_apply_verbose(working_fdt, blob);
457 if (err) {
458 printf("Failed to apply overlay %s, skipping\n",
459 overlayfile);
460 goto skip_overlay;
461 }
462
463skip_overlay:
464 if (end)
465 free(overlayfile);
466 } while ((fdtoverlay = strstr(fdtoverlay, " ")));
467}
468#endif
469
Simon Glass18109cc2021-10-14 12:48:01 -0600470/**
471 * label_boot() - Boot according to the contents of a pxe_label
Patrice Chotard2373cba2019-11-25 09:07:37 +0100472 *
473 * If we can't boot for any reason, we return. A successful boot never
474 * returns.
475 *
476 * The kernel will be stored in the location given by the 'kernel_addr_r'
477 * environment variable.
478 *
479 * If the label specifies an initrd file, it will be stored in the location
480 * given by the 'ramdisk_addr_r' environment variable.
481 *
482 * If the label specifies an 'append' line, its contents will overwrite that
483 * of the 'bootargs' environment variable.
Simon Glass18109cc2021-10-14 12:48:01 -0600484 *
485 * @ctx: PXE context
486 * @label: Label to process
487 * Returns does not return on success, otherwise returns 0 if a localboot
488 * label was processed, or 1 on error
Patrice Chotard2373cba2019-11-25 09:07:37 +0100489 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600490static int label_boot(struct pxe_context *ctx, struct pxe_label *label)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100491{
492 char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL };
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700493 char *zboot_argv[] = { "zboot", NULL, "0", NULL, NULL };
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700494 char *kernel_addr = NULL;
495 char *initrd_addr_str = NULL;
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700496 char initrd_filesize[10];
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700497 char initrd_str[28];
Patrice Chotard2373cba2019-11-25 09:07:37 +0100498 char mac_str[29] = "";
499 char ip_str[68] = "";
500 char *fit_addr = NULL;
501 int bootm_argc = 2;
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700502 int zboot_argc = 3;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100503 int len = 0;
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700504 ulong kernel_addr_r;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100505 void *buf;
506
507 label_print(label);
508
509 label->attempted = 1;
510
511 if (label->localboot) {
512 if (label->localboot_val >= 0)
513 label_localboot(label);
514 return 0;
515 }
516
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100517 if (!label->kernel) {
Patrice Chotard2373cba2019-11-25 09:07:37 +0100518 printf("No kernel given, skipping %s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100519 label->name);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100520 return 1;
521 }
522
523 if (label->initrd) {
Simon Glass4d79e882021-10-14 12:48:08 -0600524 ulong size;
525
526 if (get_relfile_envaddr(ctx, label->initrd, "ramdisk_addr_r",
527 &size) < 0) {
Patrice Chotard2373cba2019-11-25 09:07:37 +0100528 printf("Skipping %s for failure retrieving initrd\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100529 label->name);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100530 return 1;
531 }
532
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700533 initrd_addr_str = env_get("ramdisk_addr_r");
Simon Glass4d79e882021-10-14 12:48:08 -0600534 strcpy(initrd_filesize, simple_xtoa(size));
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700535
536 strncpy(initrd_str, initrd_addr_str, 18);
537 strcat(initrd_str, ":");
538 strncat(initrd_str, initrd_filesize, 9);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100539 }
540
Simon Glass4d79e882021-10-14 12:48:08 -0600541 if (get_relfile_envaddr(ctx, label->kernel, "kernel_addr_r",
542 NULL) < 0) {
Patrice Chotard2373cba2019-11-25 09:07:37 +0100543 printf("Skipping %s for failure retrieving kernel\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100544 label->name);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100545 return 1;
546 }
547
548 if (label->ipappend & 0x1) {
549 sprintf(ip_str, " ip=%s:%s:%s:%s",
550 env_get("ipaddr"), env_get("serverip"),
551 env_get("gatewayip"), env_get("netmask"));
552 }
553
Kory Maincentff0287e2021-02-02 16:42:28 +0100554 if (IS_ENABLED(CONFIG_CMD_NET)) {
555 if (label->ipappend & 0x2) {
556 int err;
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100557
Kory Maincentff0287e2021-02-02 16:42:28 +0100558 strcpy(mac_str, " BOOTIF=");
559 err = format_mac_pxe(mac_str + 8, sizeof(mac_str) - 8);
560 if (err < 0)
561 mac_str[0] = '\0';
562 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100563 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100564
565 if ((label->ipappend & 0x3) || label->append) {
566 char bootargs[CONFIG_SYS_CBSIZE] = "";
567 char finalbootargs[CONFIG_SYS_CBSIZE];
568
569 if (strlen(label->append ?: "") +
570 strlen(ip_str) + strlen(mac_str) + 1 > sizeof(bootargs)) {
571 printf("bootarg overflow %zd+%zd+%zd+1 > %zd\n",
572 strlen(label->append ?: ""),
573 strlen(ip_str), strlen(mac_str),
574 sizeof(bootargs));
575 return 1;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100576 }
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100577
578 if (label->append)
579 strncpy(bootargs, label->append, sizeof(bootargs));
580
581 strcat(bootargs, ip_str);
582 strcat(bootargs, mac_str);
583
Simon Glass1a62d642020-11-05 10:33:47 -0700584 cli_simple_process_macros(bootargs, finalbootargs,
585 sizeof(finalbootargs));
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100586 env_set("bootargs", finalbootargs);
587 printf("append: %s\n", finalbootargs);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100588 }
589
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700590 kernel_addr = env_get("kernel_addr_r");
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700591
Patrice Chotard2373cba2019-11-25 09:07:37 +0100592 /* for FIT, append the configuration identifier */
593 if (label->config) {
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700594 int len = strlen(kernel_addr) + strlen(label->config) + 1;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100595
596 fit_addr = malloc(len);
597 if (!fit_addr) {
598 printf("malloc fail (FIT address)\n");
599 return 1;
600 }
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700601 snprintf(fit_addr, len, "%s%s", kernel_addr, label->config);
602 kernel_addr = fit_addr;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100603 }
604
605 /*
606 * fdt usage is optional:
Anton Leontievdb366742019-09-03 10:52:24 +0300607 * It handles the following scenarios.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100608 *
Anton Leontievdb366742019-09-03 10:52:24 +0300609 * Scenario 1: If fdt_addr_r specified and "fdt" or "fdtdir" label is
610 * defined in pxe file, retrieve fdt blob from server. Pass fdt_addr_r to
611 * bootm, and adjust argc appropriately.
612 *
613 * If retrieve fails and no exact fdt blob is specified in pxe file with
614 * "fdt" label, try Scenario 2.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100615 *
616 * Scenario 2: If there is an fdt_addr specified, pass it along to
617 * bootm, and adjust argc appropriately.
618 *
Peter Hoyesd5ba6182021-10-14 09:40:04 +0100619 * Scenario 3: If there is an fdtcontroladdr specified, pass it along to
620 * bootm, and adjust argc appropriately.
621 *
622 * Scenario 4: fdt blob is not available.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100623 */
624 bootm_argv[3] = env_get("fdt_addr_r");
625
626 /* if fdt label is defined then get fdt from server */
627 if (bootm_argv[3]) {
628 char *fdtfile = NULL;
629 char *fdtfilefree = NULL;
630
631 if (label->fdt) {
632 fdtfile = label->fdt;
633 } else if (label->fdtdir) {
634 char *f1, *f2, *f3, *f4, *slash;
635
636 f1 = env_get("fdtfile");
637 if (f1) {
638 f2 = "";
639 f3 = "";
640 f4 = "";
641 } else {
642 /*
643 * For complex cases where this code doesn't
644 * generate the correct filename, the board
645 * code should set $fdtfile during early boot,
646 * or the boot scripts should set $fdtfile
647 * before invoking "pxe" or "sysboot".
648 */
649 f1 = env_get("soc");
650 f2 = "-";
651 f3 = env_get("board");
652 f4 = ".dtb";
Dimitri John Ledkov75efe7d2021-04-21 12:42:01 +0100653 if (!f1) {
654 f1 = "";
655 f2 = "";
656 }
657 if (!f3) {
658 f2 = "";
659 f3 = "";
660 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100661 }
662
663 len = strlen(label->fdtdir);
664 if (!len)
665 slash = "./";
666 else if (label->fdtdir[len - 1] != '/')
667 slash = "/";
668 else
669 slash = "";
670
671 len = strlen(label->fdtdir) + strlen(slash) +
672 strlen(f1) + strlen(f2) + strlen(f3) +
673 strlen(f4) + 1;
674 fdtfilefree = malloc(len);
675 if (!fdtfilefree) {
676 printf("malloc fail (FDT filename)\n");
677 goto cleanup;
678 }
679
680 snprintf(fdtfilefree, len, "%s%s%s%s%s%s",
681 label->fdtdir, slash, f1, f2, f3, f4);
682 fdtfile = fdtfilefree;
683 }
684
685 if (fdtfile) {
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600686 int err = get_relfile_envaddr(ctx, fdtfile,
Simon Glass4d79e882021-10-14 12:48:08 -0600687 "fdt_addr_r", NULL);
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100688
Patrice Chotard2373cba2019-11-25 09:07:37 +0100689 free(fdtfilefree);
690 if (err < 0) {
Anton Leontievdb366742019-09-03 10:52:24 +0300691 bootm_argv[3] = NULL;
692
693 if (label->fdt) {
694 printf("Skipping %s for failure retrieving FDT\n",
695 label->name);
696 goto cleanup;
697 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100698 }
Neil Armstrong69076df2021-01-20 09:54:53 +0100699
Zhang Ning02901462022-02-01 08:33:37 +0800700 if (label->kaslrseed)
701 label_boot_kaslrseed();
702
Neil Armstrong69076df2021-01-20 09:54:53 +0100703#ifdef CONFIG_OF_LIBFDT_OVERLAY
704 if (label->fdtoverlays)
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600705 label_boot_fdtoverlay(ctx, label);
Neil Armstrong69076df2021-01-20 09:54:53 +0100706#endif
Patrice Chotard2373cba2019-11-25 09:07:37 +0100707 } else {
708 bootm_argv[3] = NULL;
709 }
710 }
711
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700712 bootm_argv[1] = kernel_addr;
713 zboot_argv[1] = kernel_addr;
714
715 if (initrd_addr_str) {
716 bootm_argv[2] = initrd_str;
717 bootm_argc = 3;
718
719 zboot_argv[3] = initrd_addr_str;
720 zboot_argv[4] = initrd_filesize;
721 zboot_argc = 5;
722 }
723
Patrice Chotard2373cba2019-11-25 09:07:37 +0100724 if (!bootm_argv[3])
725 bootm_argv[3] = env_get("fdt_addr");
726
Peter Hoyesd5ba6182021-10-14 09:40:04 +0100727 if (!bootm_argv[3])
728 bootm_argv[3] = env_get("fdtcontroladdr");
729
Patrice Chotard2373cba2019-11-25 09:07:37 +0100730 if (bootm_argv[3]) {
731 if (!bootm_argv[2])
732 bootm_argv[2] = "-";
733 bootm_argc = 4;
734 }
735
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700736 kernel_addr_r = genimg_get_kernel_addr(kernel_addr);
737 buf = map_sysmem(kernel_addr_r, 0);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100738 /* Try bootm for legacy and FIT format image */
739 if (genimg_get_format(buf) != IMAGE_FORMAT_INVALID)
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600740 do_bootm(ctx->cmdtp, 0, bootm_argc, bootm_argv);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100741 /* Try booting an AArch64 Linux kernel image */
Kory Maincentff0287e2021-02-02 16:42:28 +0100742 else if (IS_ENABLED(CONFIG_CMD_BOOTI))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600743 do_booti(ctx->cmdtp, 0, bootm_argc, bootm_argv);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100744 /* Try booting a Image */
Kory Maincentff0287e2021-02-02 16:42:28 +0100745 else if (IS_ENABLED(CONFIG_CMD_BOOTZ))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600746 do_bootz(ctx->cmdtp, 0, bootm_argc, bootm_argv);
Kory Maincent18c25822021-02-02 16:42:29 +0100747 /* Try booting an x86_64 Linux kernel image */
748 else if (IS_ENABLED(CONFIG_CMD_ZBOOT))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600749 do_zboot_parent(ctx->cmdtp, 0, zboot_argc, zboot_argv, NULL);
Kory Maincentff0287e2021-02-02 16:42:28 +0100750
Patrice Chotard2373cba2019-11-25 09:07:37 +0100751 unmap_sysmem(buf);
752
753cleanup:
Simon Glass929860b2021-10-14 12:48:02 -0600754 free(fit_addr);
755
Patrice Chotard2373cba2019-11-25 09:07:37 +0100756 return 1;
757}
758
Simon Glass18109cc2021-10-14 12:48:01 -0600759/** enum token_type - Tokens for the pxe file parser */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100760enum token_type {
761 T_EOL,
762 T_STRING,
763 T_EOF,
764 T_MENU,
765 T_TITLE,
766 T_TIMEOUT,
767 T_LABEL,
768 T_KERNEL,
769 T_LINUX,
770 T_APPEND,
771 T_INITRD,
772 T_LOCALBOOT,
773 T_DEFAULT,
774 T_PROMPT,
775 T_INCLUDE,
776 T_FDT,
777 T_FDTDIR,
Neil Armstrong69076df2021-01-20 09:54:53 +0100778 T_FDTOVERLAYS,
Patrice Chotard2373cba2019-11-25 09:07:37 +0100779 T_ONTIMEOUT,
780 T_IPAPPEND,
781 T_BACKGROUND,
Zhang Ning02901462022-02-01 08:33:37 +0800782 T_KASLRSEED,
Patrice Chotard2373cba2019-11-25 09:07:37 +0100783 T_INVALID
784};
785
Simon Glass18109cc2021-10-14 12:48:01 -0600786/** struct token - token - given by a value and a type */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100787struct token {
788 char *val;
789 enum token_type type;
790};
791
Simon Glass18109cc2021-10-14 12:48:01 -0600792/* Keywords recognized */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100793static const struct token keywords[] = {
794 {"menu", T_MENU},
795 {"title", T_TITLE},
796 {"timeout", T_TIMEOUT},
797 {"default", T_DEFAULT},
798 {"prompt", T_PROMPT},
799 {"label", T_LABEL},
800 {"kernel", T_KERNEL},
801 {"linux", T_LINUX},
802 {"localboot", T_LOCALBOOT},
803 {"append", T_APPEND},
804 {"initrd", T_INITRD},
805 {"include", T_INCLUDE},
806 {"devicetree", T_FDT},
807 {"fdt", T_FDT},
808 {"devicetreedir", T_FDTDIR},
809 {"fdtdir", T_FDTDIR},
Neil Armstrong69076df2021-01-20 09:54:53 +0100810 {"fdtoverlays", T_FDTOVERLAYS},
Patrice Chotard2373cba2019-11-25 09:07:37 +0100811 {"ontimeout", T_ONTIMEOUT,},
812 {"ipappend", T_IPAPPEND,},
813 {"background", T_BACKGROUND,},
Zhang Ning02901462022-02-01 08:33:37 +0800814 {"kaslrseed", T_KASLRSEED,},
Patrice Chotard2373cba2019-11-25 09:07:37 +0100815 {NULL, T_INVALID}
816};
817
Simon Glass18109cc2021-10-14 12:48:01 -0600818/**
819 * enum lex_state - lexer state
820 *
Patrice Chotard2373cba2019-11-25 09:07:37 +0100821 * Since pxe(linux) files don't have a token to identify the start of a
822 * literal, we have to keep track of when we're in a state where a literal is
823 * expected vs when we're in a state a keyword is expected.
824 */
825enum lex_state {
826 L_NORMAL = 0,
827 L_KEYWORD,
828 L_SLITERAL
829};
830
Simon Glass18109cc2021-10-14 12:48:01 -0600831/**
832 * get_string() - retrieves a string from *p and stores it as a token in *t.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100833 *
Simon Glass18109cc2021-10-14 12:48:01 -0600834 * This is used for scanning both string literals and keywords.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100835 *
836 * Characters from *p are copied into t-val until a character equal to
837 * delim is found, or a NUL byte is reached. If delim has the special value of
838 * ' ', any whitespace character will be used as a delimiter.
839 *
840 * If lower is unequal to 0, uppercase characters will be converted to
841 * lowercase in the result. This is useful to make keywords case
842 * insensitive.
843 *
844 * The location of *p is updated to point to the first character after the end
845 * of the token - the ending delimiter.
846 *
Simon Glass18109cc2021-10-14 12:48:01 -0600847 * Memory for t->val is allocated using malloc and must be free()'d to reclaim
848 * it.
849 *
850 * @p: Points to a pointer to the current position in the input being processed.
851 * Updated to point at the first character after the current token
852 * @t: Pointers to a token to fill in
853 * @delim: Delimiter character to look for, either newline or space
854 * @lower: true to convert the string to lower case when storing
855 * Returns the new value of t->val, on success, NULL if out of memory
Patrice Chotard2373cba2019-11-25 09:07:37 +0100856 */
857static char *get_string(char **p, struct token *t, char delim, int lower)
858{
859 char *b, *e;
860 size_t len, i;
861
862 /*
863 * b and e both start at the beginning of the input stream.
864 *
865 * e is incremented until we find the ending delimiter, or a NUL byte
866 * is reached. Then, we take e - b to find the length of the token.
867 */
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100868 b = *p;
869 e = *p;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100870 while (*e) {
871 if ((delim == ' ' && isspace(*e)) || delim == *e)
872 break;
873 e++;
874 }
875
876 len = e - b;
877
878 /*
879 * Allocate memory to hold the string, and copy it in, converting
880 * characters to lowercase if lower is != 0.
881 */
882 t->val = malloc(len + 1);
883 if (!t->val)
884 return NULL;
885
886 for (i = 0; i < len; i++, b++) {
887 if (lower)
888 t->val[i] = tolower(*b);
889 else
890 t->val[i] = *b;
891 }
892
893 t->val[len] = '\0';
894
Simon Glass929860b2021-10-14 12:48:02 -0600895 /* Update *p so the caller knows where to continue scanning */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100896 *p = e;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100897 t->type = T_STRING;
898
899 return t->val;
900}
901
Simon Glass18109cc2021-10-14 12:48:01 -0600902/**
903 * get_keyword() - Populate a keyword token with a type and value
904 *
905 * Updates the ->type field based on the keyword string in @val
906 * @t: Token to populate
Patrice Chotard2373cba2019-11-25 09:07:37 +0100907 */
908static void get_keyword(struct token *t)
909{
910 int i;
911
912 for (i = 0; keywords[i].val; i++) {
913 if (!strcmp(t->val, keywords[i].val)) {
914 t->type = keywords[i].type;
915 break;
916 }
917 }
918}
919
Simon Glass18109cc2021-10-14 12:48:01 -0600920/**
921 * get_token() - Get the next token
Patrice Chotard2373cba2019-11-25 09:07:37 +0100922 *
Simon Glass18109cc2021-10-14 12:48:01 -0600923 * We have to keep track of which state we're in to know if we're looking to get
924 * a string literal or a keyword.
925 *
926 * @p: Points to a pointer to the current position in the input being processed.
927 * Updated to point at the first character after the current token
Patrice Chotard2373cba2019-11-25 09:07:37 +0100928 */
929static void get_token(char **p, struct token *t, enum lex_state state)
930{
931 char *c = *p;
932
933 t->type = T_INVALID;
934
935 /* eat non EOL whitespace */
936 while (isblank(*c))
937 c++;
938
939 /*
940 * eat comments. note that string literals can't begin with #, but
941 * can contain a # after their first character.
942 */
943 if (*c == '#') {
944 while (*c && *c != '\n')
945 c++;
946 }
947
948 if (*c == '\n') {
949 t->type = T_EOL;
950 c++;
951 } else if (*c == '\0') {
952 t->type = T_EOF;
953 c++;
954 } else if (state == L_SLITERAL) {
955 get_string(&c, t, '\n', 0);
956 } else if (state == L_KEYWORD) {
957 /*
958 * when we expect a keyword, we first get the next string
959 * token delimited by whitespace, and then check if it
960 * matches a keyword in our keyword list. if it does, it's
961 * converted to a keyword token of the appropriate type, and
962 * if not, it remains a string token.
963 */
964 get_string(&c, t, ' ', 1);
965 get_keyword(t);
966 }
967
968 *p = c;
969}
970
Simon Glass18109cc2021-10-14 12:48:01 -0600971/**
972 * eol_or_eof() - Find end of line
973 *
974 * Increment *c until we get to the end of the current line, or EOF
975 *
976 * @c: Points to a pointer to the current position in the input being processed.
977 * Updated to point at the first character after the current token
Patrice Chotard2373cba2019-11-25 09:07:37 +0100978 */
979static void eol_or_eof(char **c)
980{
981 while (**c && **c != '\n')
982 (*c)++;
983}
984
985/*
986 * All of these parse_* functions share some common behavior.
987 *
988 * They finish with *c pointing after the token they parse, and return 1 on
989 * success, or < 0 on error.
990 */
991
992/*
993 * Parse a string literal and store a pointer it at *dst. String literals
994 * terminate at the end of the line.
995 */
996static int parse_sliteral(char **c, char **dst)
997{
998 struct token t;
999 char *s = *c;
1000
1001 get_token(c, &t, L_SLITERAL);
1002
1003 if (t.type != T_STRING) {
1004 printf("Expected string literal: %.*s\n", (int)(*c - s), s);
1005 return -EINVAL;
1006 }
1007
1008 *dst = t.val;
1009
1010 return 1;
1011}
1012
1013/*
1014 * Parse a base 10 (unsigned) integer and store it at *dst.
1015 */
1016static int parse_integer(char **c, int *dst)
1017{
1018 struct token t;
1019 char *s = *c;
1020
1021 get_token(c, &t, L_SLITERAL);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001022 if (t.type != T_STRING) {
1023 printf("Expected string: %.*s\n", (int)(*c - s), s);
1024 return -EINVAL;
1025 }
1026
1027 *dst = simple_strtol(t.val, NULL, 10);
1028
1029 free(t.val);
1030
1031 return 1;
1032}
1033
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001034static int parse_pxefile_top(struct pxe_context *ctx, char *p, ulong base,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001035 struct pxe_menu *cfg, int nest_level);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001036
1037/*
1038 * Parse an include statement, and retrieve and parse the file it mentions.
1039 *
1040 * base should point to a location where it's safe to store the file, and
1041 * nest_level should indicate how many nested includes have occurred. For this
1042 * include, nest_level has already been incremented and doesn't need to be
1043 * incremented here.
1044 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001045static int handle_include(struct pxe_context *ctx, char **c, unsigned long base,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001046 struct pxe_menu *cfg, int nest_level)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001047{
1048 char *include_path;
1049 char *s = *c;
1050 int err;
1051 char *buf;
1052 int ret;
1053
1054 err = parse_sliteral(c, &include_path);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001055 if (err < 0) {
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001056 printf("Expected include path: %.*s\n", (int)(*c - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001057 return err;
1058 }
1059
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001060 err = get_pxe_file(ctx, include_path, base);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001061 if (err < 0) {
1062 printf("Couldn't retrieve %s\n", include_path);
1063 return err;
1064 }
1065
1066 buf = map_sysmem(base, 0);
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001067 ret = parse_pxefile_top(ctx, buf, base, cfg, nest_level);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001068 unmap_sysmem(buf);
1069
1070 return ret;
1071}
1072
1073/*
1074 * Parse lines that begin with 'menu'.
1075 *
1076 * base and nest are provided to handle the 'menu include' case.
1077 *
1078 * base should point to a location where it's safe to store the included file.
1079 *
1080 * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
1081 * a file it includes, 3 when parsing a file included by that file, and so on.
1082 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001083static int parse_menu(struct pxe_context *ctx, char **c, struct pxe_menu *cfg,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001084 unsigned long base, int nest_level)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001085{
1086 struct token t;
1087 char *s = *c;
1088 int err = 0;
1089
1090 get_token(c, &t, L_KEYWORD);
1091
1092 switch (t.type) {
1093 case T_TITLE:
1094 err = parse_sliteral(c, &cfg->title);
1095
1096 break;
1097
1098 case T_INCLUDE:
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001099 err = handle_include(ctx, c, base, cfg, nest_level + 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001100 break;
1101
1102 case T_BACKGROUND:
1103 err = parse_sliteral(c, &cfg->bmp);
1104 break;
1105
1106 default:
1107 printf("Ignoring malformed menu command: %.*s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001108 (int)(*c - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001109 }
Patrice Chotard2373cba2019-11-25 09:07:37 +01001110 if (err < 0)
1111 return err;
1112
1113 eol_or_eof(c);
1114
1115 return 1;
1116}
1117
1118/*
1119 * Handles parsing a 'menu line' when we're parsing a label.
1120 */
1121static int parse_label_menu(char **c, struct pxe_menu *cfg,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001122 struct pxe_label *label)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001123{
1124 struct token t;
1125 char *s;
1126
1127 s = *c;
1128
1129 get_token(c, &t, L_KEYWORD);
1130
1131 switch (t.type) {
1132 case T_DEFAULT:
1133 if (!cfg->default_label)
1134 cfg->default_label = strdup(label->name);
1135
1136 if (!cfg->default_label)
1137 return -ENOMEM;
1138
1139 break;
1140 case T_LABEL:
1141 parse_sliteral(c, &label->menu);
1142 break;
1143 default:
1144 printf("Ignoring malformed menu command: %.*s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001145 (int)(*c - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001146 }
1147
1148 eol_or_eof(c);
1149
1150 return 0;
1151}
1152
1153/*
1154 * Handles parsing a 'kernel' label.
1155 * expecting "filename" or "<fit_filename>#cfg"
1156 */
1157static int parse_label_kernel(char **c, struct pxe_label *label)
1158{
1159 char *s;
1160 int err;
1161
1162 err = parse_sliteral(c, &label->kernel);
1163 if (err < 0)
1164 return err;
1165
1166 s = strstr(label->kernel, "#");
1167 if (!s)
1168 return 1;
1169
1170 label->config = malloc(strlen(s) + 1);
1171 if (!label->config)
1172 return -ENOMEM;
1173
1174 strcpy(label->config, s);
1175 *s = 0;
1176
1177 return 1;
1178}
1179
1180/*
1181 * Parses a label and adds it to the list of labels for a menu.
1182 *
1183 * A label ends when we either get to the end of a file, or
1184 * get some input we otherwise don't have a handler defined
1185 * for.
1186 *
1187 */
1188static int parse_label(char **c, struct pxe_menu *cfg)
1189{
1190 struct token t;
1191 int len;
1192 char *s = *c;
1193 struct pxe_label *label;
1194 int err;
1195
1196 label = label_create();
1197 if (!label)
1198 return -ENOMEM;
1199
1200 err = parse_sliteral(c, &label->name);
1201 if (err < 0) {
1202 printf("Expected label name: %.*s\n", (int)(*c - s), s);
1203 label_destroy(label);
1204 return -EINVAL;
1205 }
1206
1207 list_add_tail(&label->list, &cfg->labels);
1208
1209 while (1) {
1210 s = *c;
1211 get_token(c, &t, L_KEYWORD);
1212
1213 err = 0;
1214 switch (t.type) {
1215 case T_MENU:
1216 err = parse_label_menu(c, cfg, label);
1217 break;
1218
1219 case T_KERNEL:
1220 case T_LINUX:
1221 err = parse_label_kernel(c, label);
1222 break;
1223
1224 case T_APPEND:
1225 err = parse_sliteral(c, &label->append);
1226 if (label->initrd)
1227 break;
1228 s = strstr(label->append, "initrd=");
1229 if (!s)
1230 break;
1231 s += 7;
1232 len = (int)(strchr(s, ' ') - s);
1233 label->initrd = malloc(len + 1);
1234 strncpy(label->initrd, s, len);
1235 label->initrd[len] = '\0';
1236
1237 break;
1238
1239 case T_INITRD:
1240 if (!label->initrd)
1241 err = parse_sliteral(c, &label->initrd);
1242 break;
1243
1244 case T_FDT:
1245 if (!label->fdt)
1246 err = parse_sliteral(c, &label->fdt);
1247 break;
1248
1249 case T_FDTDIR:
1250 if (!label->fdtdir)
1251 err = parse_sliteral(c, &label->fdtdir);
1252 break;
1253
Neil Armstrong69076df2021-01-20 09:54:53 +01001254 case T_FDTOVERLAYS:
1255 if (!label->fdtoverlays)
1256 err = parse_sliteral(c, &label->fdtoverlays);
1257 break;
1258
Patrice Chotard2373cba2019-11-25 09:07:37 +01001259 case T_LOCALBOOT:
1260 label->localboot = 1;
1261 err = parse_integer(c, &label->localboot_val);
1262 break;
1263
1264 case T_IPAPPEND:
1265 err = parse_integer(c, &label->ipappend);
1266 break;
1267
Zhang Ning02901462022-02-01 08:33:37 +08001268 case T_KASLRSEED:
1269 label->kaslrseed = 1;
1270 break;
1271
Patrice Chotard2373cba2019-11-25 09:07:37 +01001272 case T_EOL:
1273 break;
1274
1275 default:
1276 /*
1277 * put the token back! we don't want it - it's the end
1278 * of a label and whatever token this is, it's
1279 * something for the menu level context to handle.
1280 */
1281 *c = s;
1282 return 1;
1283 }
1284
1285 if (err < 0)
1286 return err;
1287 }
1288}
1289
1290/*
1291 * This 16 comes from the limit pxelinux imposes on nested includes.
1292 *
1293 * There is no reason at all we couldn't do more, but some limit helps prevent
1294 * infinite (until crash occurs) recursion if a file tries to include itself.
1295 */
1296#define MAX_NEST_LEVEL 16
1297
1298/*
1299 * Entry point for parsing a menu file. nest_level indicates how many times
1300 * we've nested in includes. It will be 1 for the top level menu file.
1301 *
1302 * Returns 1 on success, < 0 on error.
1303 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001304static int parse_pxefile_top(struct pxe_context *ctx, char *p, unsigned long base,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001305 struct pxe_menu *cfg, int nest_level)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001306{
1307 struct token t;
1308 char *s, *b, *label_name;
1309 int err;
1310
1311 b = p;
1312
1313 if (nest_level > MAX_NEST_LEVEL) {
1314 printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL);
1315 return -EMLINK;
1316 }
1317
1318 while (1) {
1319 s = p;
1320
1321 get_token(&p, &t, L_KEYWORD);
1322
1323 err = 0;
1324 switch (t.type) {
1325 case T_MENU:
1326 cfg->prompt = 1;
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001327 err = parse_menu(ctx, &p, cfg,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001328 base + ALIGN(strlen(b) + 1, 4),
1329 nest_level);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001330 break;
1331
1332 case T_TIMEOUT:
1333 err = parse_integer(&p, &cfg->timeout);
1334 break;
1335
1336 case T_LABEL:
1337 err = parse_label(&p, cfg);
1338 break;
1339
1340 case T_DEFAULT:
1341 case T_ONTIMEOUT:
1342 err = parse_sliteral(&p, &label_name);
1343
1344 if (label_name) {
1345 if (cfg->default_label)
1346 free(cfg->default_label);
1347
1348 cfg->default_label = label_name;
1349 }
1350
1351 break;
1352
1353 case T_INCLUDE:
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001354 err = handle_include(ctx, &p,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001355 base + ALIGN(strlen(b), 4), cfg,
1356 nest_level + 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001357 break;
1358
1359 case T_PROMPT:
1360 eol_or_eof(&p);
1361 break;
1362
1363 case T_EOL:
1364 break;
1365
1366 case T_EOF:
1367 return 1;
1368
1369 default:
1370 printf("Ignoring unknown command: %.*s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001371 (int)(p - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001372 eol_or_eof(&p);
1373 }
1374
1375 if (err < 0)
1376 return err;
1377 }
1378}
1379
1380/*
Patrice Chotard2373cba2019-11-25 09:07:37 +01001381 */
1382void destroy_pxe_menu(struct pxe_menu *cfg)
1383{
1384 struct list_head *pos, *n;
1385 struct pxe_label *label;
1386
Simon Glass929860b2021-10-14 12:48:02 -06001387 free(cfg->title);
1388 free(cfg->default_label);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001389
1390 list_for_each_safe(pos, n, &cfg->labels) {
1391 label = list_entry(pos, struct pxe_label, list);
1392
1393 label_destroy(label);
1394 }
1395
1396 free(cfg);
1397}
1398
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001399struct pxe_menu *parse_pxefile(struct pxe_context *ctx, unsigned long menucfg)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001400{
1401 struct pxe_menu *cfg;
1402 char *buf;
1403 int r;
1404
1405 cfg = malloc(sizeof(struct pxe_menu));
Patrice Chotard2373cba2019-11-25 09:07:37 +01001406 if (!cfg)
1407 return NULL;
1408
1409 memset(cfg, 0, sizeof(struct pxe_menu));
1410
1411 INIT_LIST_HEAD(&cfg->labels);
1412
1413 buf = map_sysmem(menucfg, 0);
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001414 r = parse_pxefile_top(ctx, buf, menucfg, cfg, 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001415 unmap_sysmem(buf);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001416 if (r < 0) {
1417 destroy_pxe_menu(cfg);
1418 return NULL;
1419 }
1420
1421 return cfg;
1422}
1423
1424/*
1425 * Converts a pxe_menu struct into a menu struct for use with U-Boot's generic
1426 * menu code.
1427 */
1428static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
1429{
1430 struct pxe_label *label;
1431 struct list_head *pos;
1432 struct menu *m;
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001433 char *label_override;
Patrice Chotard2373cba2019-11-25 09:07:37 +01001434 int err;
1435 int i = 1;
1436 char *default_num = NULL;
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001437 char *override_num = NULL;
Patrice Chotard2373cba2019-11-25 09:07:37 +01001438
1439 /*
1440 * Create a menu and add items for all the labels.
1441 */
1442 m = menu_create(cfg->title, DIV_ROUND_UP(cfg->timeout, 10),
Thirupathaiah Annapureddy5168d7a2020-03-18 11:38:42 -07001443 cfg->prompt, NULL, label_print, NULL, NULL);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001444 if (!m)
1445 return NULL;
1446
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001447 label_override = env_get("pxe_label_override");
1448
Patrice Chotard2373cba2019-11-25 09:07:37 +01001449 list_for_each(pos, &cfg->labels) {
1450 label = list_entry(pos, struct pxe_label, list);
1451
1452 sprintf(label->num, "%d", i++);
1453 if (menu_item_add(m, label->num, label) != 1) {
1454 menu_destroy(m);
1455 return NULL;
1456 }
1457 if (cfg->default_label &&
1458 (strcmp(label->name, cfg->default_label) == 0))
1459 default_num = label->num;
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001460 if (label_override && !strcmp(label->name, label_override))
1461 override_num = label->num;
1462 }
1463
1464
1465 if (label_override) {
1466 if (override_num)
1467 default_num = override_num;
1468 else
1469 printf("Missing override pxe label: %s\n",
1470 label_override);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001471 }
1472
1473 /*
1474 * After we've created items for each label in the menu, set the
1475 * menu's default label if one was specified.
1476 */
1477 if (default_num) {
1478 err = menu_default_set(m, default_num);
1479 if (err != 1) {
1480 if (err != -ENOENT) {
1481 menu_destroy(m);
1482 return NULL;
1483 }
1484
1485 printf("Missing default: %s\n", cfg->default_label);
1486 }
1487 }
1488
1489 return m;
1490}
1491
1492/*
1493 * Try to boot any labels we have yet to attempt to boot.
1494 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001495static void boot_unattempted_labels(struct pxe_context *ctx,
1496 struct pxe_menu *cfg)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001497{
1498 struct list_head *pos;
1499 struct pxe_label *label;
1500
1501 list_for_each(pos, &cfg->labels) {
1502 label = list_entry(pos, struct pxe_label, list);
1503
1504 if (!label->attempted)
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001505 label_boot(ctx, label);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001506 }
1507}
1508
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001509void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001510{
1511 void *choice;
1512 struct menu *m;
1513 int err;
1514
Kory Maincentff0287e2021-02-02 16:42:28 +01001515 if (IS_ENABLED(CONFIG_CMD_BMP)) {
1516 /* display BMP if available */
1517 if (cfg->bmp) {
Simon Glass4d79e882021-10-14 12:48:08 -06001518 if (get_relfile(ctx, cfg->bmp, image_load_addr, NULL)) {
Kory Maincentff0287e2021-02-02 16:42:28 +01001519 if (CONFIG_IS_ENABLED(CMD_CLS))
1520 run_command("cls", 0);
1521 bmp_display(image_load_addr,
1522 BMP_ALIGN_CENTER, BMP_ALIGN_CENTER);
1523 } else {
1524 printf("Skipping background bmp %s for failure\n",
1525 cfg->bmp);
1526 }
Patrice Chotard2373cba2019-11-25 09:07:37 +01001527 }
1528 }
Patrice Chotard2373cba2019-11-25 09:07:37 +01001529
1530 m = pxe_menu_to_menu(cfg);
1531 if (!m)
1532 return;
1533
1534 err = menu_get_choice(m, &choice);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001535 menu_destroy(m);
1536
1537 /*
1538 * err == 1 means we got a choice back from menu_get_choice.
1539 *
1540 * err == -ENOENT if the menu was setup to select the default but no
1541 * default was set. in that case, we should continue trying to boot
1542 * labels that haven't been attempted yet.
1543 *
1544 * otherwise, the user interrupted or there was some other error and
1545 * we give up.
1546 */
1547
1548 if (err == 1) {
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001549 err = label_boot(ctx, choice);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001550 if (!err)
1551 return;
1552 } else if (err != -ENOENT) {
1553 return;
1554 }
1555
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001556 boot_unattempted_labels(ctx, cfg);
1557}
1558
Simon Glass12df8422021-10-14 12:48:04 -06001559int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp,
1560 pxe_getfile_func getfile, void *userdata,
1561 bool allow_abs_path, const char *bootfile)
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001562{
Simon Glass12df8422021-10-14 12:48:04 -06001563 const char *last_slash;
1564 size_t path_len = 0;
1565
1566 memset(ctx, '\0', sizeof(*ctx));
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001567 ctx->cmdtp = cmdtp;
Simon Glassb1ead6b2021-10-14 12:47:57 -06001568 ctx->getfile = getfile;
Simon Glass4ad5d512021-10-14 12:47:58 -06001569 ctx->userdata = userdata;
Simon Glass8018b9a2021-10-14 12:47:59 -06001570 ctx->allow_abs_path = allow_abs_path;
Simon Glass12df8422021-10-14 12:48:04 -06001571
1572 /* figure out the boot directory, if there is one */
1573 if (bootfile && strlen(bootfile) >= MAX_TFTP_PATH_LEN)
1574 return -ENOSPC;
1575 ctx->bootdir = strdup(bootfile ? bootfile : "");
1576 if (!ctx->bootdir)
1577 return -ENOMEM;
1578
1579 if (bootfile) {
1580 last_slash = strrchr(bootfile, '/');
1581 if (last_slash)
1582 path_len = (last_slash - bootfile) + 1;
1583 }
1584 ctx->bootdir[path_len] = '\0';
1585
1586 return 0;
1587}
1588
1589void pxe_destroy_ctx(struct pxe_context *ctx)
1590{
1591 free(ctx->bootdir);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001592}
Simon Glass9e62e7c2021-10-14 12:48:03 -06001593
1594int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt)
1595{
1596 struct pxe_menu *cfg;
1597
1598 cfg = parse_pxefile(ctx, pxefile_addr_r);
1599 if (!cfg) {
1600 printf("Error parsing config file\n");
1601 return 1;
1602 }
1603
1604 if (prompt)
1605 cfg->prompt = 1;
1606
1607 handle_pxe_menu(ctx, cfg);
1608
1609 destroy_pxe_menu(cfg);
1610
1611 return 0;
1612}