blob: a92bb896c63e01ef00b805a6f7efcd671605c203 [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>
Patrick Delaunaye6fe02a2022-03-22 17:08:43 +01009#include <dm.h>
Patrice Chotard2373cba2019-11-25 09:07:37 +010010#include <env.h>
Simon Glass8e8ccfe2019-12-28 10:45:03 -070011#include <image.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060012#include <log.h>
Patrice Chotard2373cba2019-11-25 09:07:37 +010013#include <malloc.h>
14#include <mapmem.h>
Simon Glass90526e92020-05-10 11:39:56 -060015#include <net.h>
Neil Armstrong69076df2021-01-20 09:54:53 +010016#include <fdt_support.h>
Patrick Delaunaye6fe02a2022-03-22 17:08:43 +010017#include <video.h>
Neil Armstrong69076df2021-01-20 09:54:53 +010018#include <linux/libfdt.h>
Patrice Chotard2373cba2019-11-25 09:07:37 +010019#include <linux/string.h>
20#include <linux/ctype.h>
21#include <errno.h>
22#include <linux/list.h>
23
Zhang Ning02901462022-02-01 08:33:37 +080024#ifdef CONFIG_DM_RNG
Zhang Ning02901462022-02-01 08:33:37 +080025#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);
Patrick Delaunaya5dacef2022-10-28 11:01:19 +0200261 free(label->kernel_label);
Simon Glass929860b2021-10-14 12:48:02 -0600262 free(label->kernel);
263 free(label->config);
264 free(label->append);
265 free(label->initrd);
266 free(label->fdt);
267 free(label->fdtdir);
268 free(label->fdtoverlays);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100269 free(label);
270}
271
Simon Glass18109cc2021-10-14 12:48:01 -0600272/**
273 * label_print() - Print a label and its string members if they're defined
Patrice Chotard2373cba2019-11-25 09:07:37 +0100274 *
275 * This is passed as a callback to the menu code for displaying each
276 * menu entry.
Simon Glass18109cc2021-10-14 12:48:01 -0600277 *
278 * @data: Label to print (is cast to struct pxe_label *)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100279 */
280static void label_print(void *data)
281{
282 struct pxe_label *label = data;
283 const char *c = label->menu ? label->menu : label->name;
284
285 printf("%s:\t%s\n", label->num, c);
286}
287
Simon Glass18109cc2021-10-14 12:48:01 -0600288/**
289 * label_localboot() - Boot a label that specified 'localboot'
Patrice Chotard2373cba2019-11-25 09:07:37 +0100290 *
Simon Glass18109cc2021-10-14 12:48:01 -0600291 * This requires that the 'localcmd' environment variable is defined. Its
292 * contents will be executed as U-Boot commands. If the label specified an
293 * 'append' line, its contents will be used to overwrite the contents of the
294 * 'bootargs' environment variable prior to running 'localcmd'.
295 *
296 * @label: Label to process
297 * Returns 1 on success or < 0 on error
Patrice Chotard2373cba2019-11-25 09:07:37 +0100298 */
299static int label_localboot(struct pxe_label *label)
300{
301 char *localcmd;
302
303 localcmd = from_env("localcmd");
Patrice Chotard2373cba2019-11-25 09:07:37 +0100304 if (!localcmd)
305 return -ENOENT;
306
307 if (label->append) {
308 char bootargs[CONFIG_SYS_CBSIZE];
309
Simon Glass1a62d642020-11-05 10:33:47 -0700310 cli_simple_process_macros(label->append, bootargs,
311 sizeof(bootargs));
Patrice Chotard2373cba2019-11-25 09:07:37 +0100312 env_set("bootargs", bootargs);
313 }
314
315 debug("running: %s\n", localcmd);
316
317 return run_command_list(localcmd, strlen(localcmd), 0);
318}
319
Zhang Ning02901462022-02-01 08:33:37 +0800320/*
321 * label_boot_kaslrseed generate kaslrseed from hw rng
322 */
323
324static void label_boot_kaslrseed(void)
325{
326#ifdef CONFIG_DM_RNG
327 ulong fdt_addr;
328 struct fdt_header *working_fdt;
329 size_t n = 0x8;
330 struct udevice *dev;
331 u64 *buf;
332 int nodeoffset;
333 int err;
334
335 /* Get the main fdt and map it */
336 fdt_addr = hextoul(env_get("fdt_addr_r"), NULL);
337 working_fdt = map_sysmem(fdt_addr, 0);
338 err = fdt_check_header(working_fdt);
339 if (err)
340 return;
341
342 /* add extra size for holding kaslr-seed */
343 /* err is new fdt size, 0 or negtive */
344 err = fdt_shrink_to_minimum(working_fdt, 512);
345 if (err <= 0)
346 return;
347
348 if (uclass_get_device(UCLASS_RNG, 0, &dev) || !dev) {
349 printf("No RNG device\n");
350 return;
351 }
352
353 nodeoffset = fdt_find_or_add_subnode(working_fdt, 0, "chosen");
354 if (nodeoffset < 0) {
355 printf("Reading chosen node failed\n");
356 return;
357 }
358
359 buf = malloc(n);
360 if (!buf) {
361 printf("Out of memory\n");
362 return;
363 }
364
365 if (dm_rng_read(dev, buf, n)) {
366 printf("Reading RNG failed\n");
367 goto err;
368 }
369
370 err = fdt_setprop(working_fdt, nodeoffset, "kaslr-seed", buf, sizeof(buf));
371 if (err < 0) {
372 printf("Unable to set kaslr-seed on chosen node: %s\n", fdt_strerror(err));
373 goto err;
374 }
375err:
376 free(buf);
377#endif
378 return;
379}
380
Simon Glass18109cc2021-10-14 12:48:01 -0600381/**
382 * label_boot_fdtoverlay() - Loads fdt overlays specified in 'fdtoverlays'
Edoardo Tomelleri35821a22022-09-21 15:26:33 +0200383 * or 'devicetree-overlay'
Simon Glass18109cc2021-10-14 12:48:01 -0600384 *
385 * @ctx: PXE context
386 * @label: Label to process
Neil Armstrong69076df2021-01-20 09:54:53 +0100387 */
388#ifdef CONFIG_OF_LIBFDT_OVERLAY
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600389static void label_boot_fdtoverlay(struct pxe_context *ctx,
390 struct pxe_label *label)
Neil Armstrong69076df2021-01-20 09:54:53 +0100391{
392 char *fdtoverlay = label->fdtoverlays;
393 struct fdt_header *working_fdt;
394 char *fdtoverlay_addr_env;
395 ulong fdtoverlay_addr;
396 ulong fdt_addr;
397 int err;
398
399 /* Get the main fdt and map it */
Simon Glass7e5f4602021-07-24 09:03:29 -0600400 fdt_addr = hextoul(env_get("fdt_addr_r"), NULL);
Neil Armstrong69076df2021-01-20 09:54:53 +0100401 working_fdt = map_sysmem(fdt_addr, 0);
402 err = fdt_check_header(working_fdt);
403 if (err)
404 return;
405
406 /* Get the specific overlay loading address */
407 fdtoverlay_addr_env = env_get("fdtoverlay_addr_r");
408 if (!fdtoverlay_addr_env) {
409 printf("Invalid fdtoverlay_addr_r for loading overlays\n");
410 return;
411 }
412
Simon Glass7e5f4602021-07-24 09:03:29 -0600413 fdtoverlay_addr = hextoul(fdtoverlay_addr_env, NULL);
Neil Armstrong69076df2021-01-20 09:54:53 +0100414
415 /* Cycle over the overlay files and apply them in order */
416 do {
417 struct fdt_header *blob;
418 char *overlayfile;
419 char *end;
420 int len;
421
422 /* Drop leading spaces */
423 while (*fdtoverlay == ' ')
424 ++fdtoverlay;
425
426 /* Copy a single filename if multiple provided */
427 end = strstr(fdtoverlay, " ");
428 if (end) {
429 len = (int)(end - fdtoverlay);
430 overlayfile = malloc(len + 1);
431 strncpy(overlayfile, fdtoverlay, len);
432 overlayfile[len] = '\0';
433 } else
434 overlayfile = fdtoverlay;
435
436 if (!strlen(overlayfile))
437 goto skip_overlay;
438
439 /* Load overlay file */
Simon Glass4d79e882021-10-14 12:48:08 -0600440 err = get_relfile_envaddr(ctx, overlayfile, "fdtoverlay_addr_r",
441 NULL);
Neil Armstrong69076df2021-01-20 09:54:53 +0100442 if (err < 0) {
443 printf("Failed loading overlay %s\n", overlayfile);
444 goto skip_overlay;
445 }
446
447 /* Resize main fdt */
448 fdt_shrink_to_minimum(working_fdt, 8192);
449
450 blob = map_sysmem(fdtoverlay_addr, 0);
451 err = fdt_check_header(blob);
452 if (err) {
453 printf("Invalid overlay %s, skipping\n",
454 overlayfile);
455 goto skip_overlay;
456 }
457
458 err = fdt_overlay_apply_verbose(working_fdt, blob);
459 if (err) {
460 printf("Failed to apply overlay %s, skipping\n",
461 overlayfile);
462 goto skip_overlay;
463 }
464
465skip_overlay:
466 if (end)
467 free(overlayfile);
468 } while ((fdtoverlay = strstr(fdtoverlay, " ")));
469}
470#endif
471
Simon Glass18109cc2021-10-14 12:48:01 -0600472/**
473 * label_boot() - Boot according to the contents of a pxe_label
Patrice Chotard2373cba2019-11-25 09:07:37 +0100474 *
475 * If we can't boot for any reason, we return. A successful boot never
476 * returns.
477 *
478 * The kernel will be stored in the location given by the 'kernel_addr_r'
479 * environment variable.
480 *
481 * If the label specifies an initrd file, it will be stored in the location
482 * given by the 'ramdisk_addr_r' environment variable.
483 *
484 * If the label specifies an 'append' line, its contents will overwrite that
485 * of the 'bootargs' environment variable.
Simon Glass18109cc2021-10-14 12:48:01 -0600486 *
487 * @ctx: PXE context
488 * @label: Label to process
489 * Returns does not return on success, otherwise returns 0 if a localboot
490 * label was processed, or 1 on error
Patrice Chotard2373cba2019-11-25 09:07:37 +0100491 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600492static int label_boot(struct pxe_context *ctx, struct pxe_label *label)
Patrice Chotard2373cba2019-11-25 09:07:37 +0100493{
494 char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL };
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700495 char *zboot_argv[] = { "zboot", NULL, "0", NULL, NULL };
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700496 char *kernel_addr = NULL;
497 char *initrd_addr_str = NULL;
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700498 char initrd_filesize[10];
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700499 char initrd_str[28];
Patrice Chotard2373cba2019-11-25 09:07:37 +0100500 char mac_str[29] = "";
501 char ip_str[68] = "";
502 char *fit_addr = NULL;
503 int bootm_argc = 2;
Zhaofeng Li23f3e392021-10-20 00:18:14 -0700504 int zboot_argc = 3;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100505 int len = 0;
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700506 ulong kernel_addr_r;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100507 void *buf;
508
509 label_print(label);
510
511 label->attempted = 1;
512
513 if (label->localboot) {
514 if (label->localboot_val >= 0)
515 label_localboot(label);
516 return 0;
517 }
518
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100519 if (!label->kernel) {
Patrice Chotard2373cba2019-11-25 09:07:37 +0100520 printf("No kernel given, skipping %s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100521 label->name);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100522 return 1;
523 }
524
Patrick Delaunayf723c272022-10-28 11:01:18 +0200525 if (get_relfile_envaddr(ctx, label->kernel, "kernel_addr_r",
526 NULL) < 0) {
527 printf("Skipping %s for failure retrieving kernel\n",
528 label->name);
529 return 1;
530 }
Simon Glass4d79e882021-10-14 12:48:08 -0600531
Patrick Delaunayf723c272022-10-28 11:01:18 +0200532 kernel_addr = env_get("kernel_addr_r");
533 /* for FIT, append the configuration identifier */
534 if (label->config) {
535 int len = strlen(kernel_addr) + strlen(label->config) + 1;
536
537 fit_addr = malloc(len);
538 if (!fit_addr) {
539 printf("malloc fail (FIT address)\n");
540 return 1;
541 }
542 snprintf(fit_addr, len, "%s%s", kernel_addr, label->config);
543 kernel_addr = fit_addr;
544 }
545
Patrick Delaunaya5dacef2022-10-28 11:01:19 +0200546 /* For FIT, the label can be identical to kernel one */
547 if (label->initrd && !strcmp(label->kernel_label, label->initrd)) {
548 initrd_addr_str = kernel_addr;
549 } else if (label->initrd) {
Simon Glass4d79e882021-10-14 12:48:08 -0600550 ulong size;
Simon Glass4d79e882021-10-14 12:48:08 -0600551 if (get_relfile_envaddr(ctx, label->initrd, "ramdisk_addr_r",
552 &size) < 0) {
Patrice Chotard2373cba2019-11-25 09:07:37 +0100553 printf("Skipping %s for failure retrieving initrd\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100554 label->name);
Patrick Delaunayf723c272022-10-28 11:01:18 +0200555 goto cleanup;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100556 }
Thomas Mittelstaedt1a075d42023-05-04 13:42:55 +0000557 strcpy(initrd_filesize, simple_xtoa(size));
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700558 initrd_addr_str = env_get("ramdisk_addr_r");
Heinrich Schuchardt085cbda2021-11-15 19:26:51 +0100559 size = snprintf(initrd_str, sizeof(initrd_str), "%s:%lx",
560 initrd_addr_str, size);
561 if (size >= sizeof(initrd_str))
Patrick Delaunayf723c272022-10-28 11:01:18 +0200562 goto cleanup;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100563 }
564
565 if (label->ipappend & 0x1) {
566 sprintf(ip_str, " ip=%s:%s:%s:%s",
567 env_get("ipaddr"), env_get("serverip"),
568 env_get("gatewayip"), env_get("netmask"));
569 }
570
Kory Maincentff0287e2021-02-02 16:42:28 +0100571 if (IS_ENABLED(CONFIG_CMD_NET)) {
572 if (label->ipappend & 0x2) {
573 int err;
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100574
Kory Maincentff0287e2021-02-02 16:42:28 +0100575 strcpy(mac_str, " BOOTIF=");
576 err = format_mac_pxe(mac_str + 8, sizeof(mac_str) - 8);
577 if (err < 0)
578 mac_str[0] = '\0';
579 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100580 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100581
582 if ((label->ipappend & 0x3) || label->append) {
583 char bootargs[CONFIG_SYS_CBSIZE] = "";
584 char finalbootargs[CONFIG_SYS_CBSIZE];
585
586 if (strlen(label->append ?: "") +
587 strlen(ip_str) + strlen(mac_str) + 1 > sizeof(bootargs)) {
588 printf("bootarg overflow %zd+%zd+%zd+1 > %zd\n",
589 strlen(label->append ?: ""),
590 strlen(ip_str), strlen(mac_str),
591 sizeof(bootargs));
Patrick Delaunayf723c272022-10-28 11:01:18 +0200592 goto cleanup;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100593 }
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100594
595 if (label->append)
596 strncpy(bootargs, label->append, sizeof(bootargs));
597
598 strcat(bootargs, ip_str);
599 strcat(bootargs, mac_str);
600
Simon Glass1a62d642020-11-05 10:33:47 -0700601 cli_simple_process_macros(bootargs, finalbootargs,
602 sizeof(finalbootargs));
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100603 env_set("bootargs", finalbootargs);
604 printf("append: %s\n", finalbootargs);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100605 }
606
Patrice Chotard2373cba2019-11-25 09:07:37 +0100607 /*
608 * fdt usage is optional:
Anton Leontievdb366742019-09-03 10:52:24 +0300609 * It handles the following scenarios.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100610 *
Anton Leontievdb366742019-09-03 10:52:24 +0300611 * Scenario 1: If fdt_addr_r specified and "fdt" or "fdtdir" label is
612 * defined in pxe file, retrieve fdt blob from server. Pass fdt_addr_r to
613 * bootm, and adjust argc appropriately.
614 *
615 * If retrieve fails and no exact fdt blob is specified in pxe file with
616 * "fdt" label, try Scenario 2.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100617 *
618 * Scenario 2: If there is an fdt_addr specified, pass it along to
619 * bootm, and adjust argc appropriately.
620 *
Marek Vasutbee35512022-12-17 18:41:13 +0100621 * Scenario 3: If there is an fdtcontroladdr specified, pass it along to
Marek Vasut519e6642022-12-14 07:45:18 +0100622 * bootm, and adjust argc appropriately, unless the image type is fitImage.
Marek Vasutbee35512022-12-17 18:41:13 +0100623 *
624 * Scenario 4: fdt blob is not available.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100625 */
626 bootm_argv[3] = env_get("fdt_addr_r");
627
Patrick Delaunaya5dacef2022-10-28 11:01:19 +0200628 /* For FIT, the label can be identical to kernel one */
629 if (label->fdt && !strcmp(label->kernel_label, label->fdt)) {
630 bootm_argv[3] = kernel_addr;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100631 /* if fdt label is defined then get fdt from server */
Patrick Delaunaya5dacef2022-10-28 11:01:19 +0200632 } else if (bootm_argv[3]) {
Patrice Chotard2373cba2019-11-25 09:07:37 +0100633 char *fdtfile = NULL;
634 char *fdtfilefree = NULL;
635
636 if (label->fdt) {
637 fdtfile = label->fdt;
638 } else if (label->fdtdir) {
639 char *f1, *f2, *f3, *f4, *slash;
640
641 f1 = env_get("fdtfile");
642 if (f1) {
643 f2 = "";
644 f3 = "";
645 f4 = "";
646 } else {
647 /*
648 * For complex cases where this code doesn't
649 * generate the correct filename, the board
650 * code should set $fdtfile during early boot,
651 * or the boot scripts should set $fdtfile
652 * before invoking "pxe" or "sysboot".
653 */
654 f1 = env_get("soc");
655 f2 = "-";
656 f3 = env_get("board");
657 f4 = ".dtb";
Dimitri John Ledkov75efe7d2021-04-21 12:42:01 +0100658 if (!f1) {
659 f1 = "";
660 f2 = "";
661 }
662 if (!f3) {
663 f2 = "";
664 f3 = "";
665 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100666 }
667
668 len = strlen(label->fdtdir);
669 if (!len)
670 slash = "./";
671 else if (label->fdtdir[len - 1] != '/')
672 slash = "/";
673 else
674 slash = "";
675
676 len = strlen(label->fdtdir) + strlen(slash) +
677 strlen(f1) + strlen(f2) + strlen(f3) +
678 strlen(f4) + 1;
679 fdtfilefree = malloc(len);
680 if (!fdtfilefree) {
681 printf("malloc fail (FDT filename)\n");
682 goto cleanup;
683 }
684
685 snprintf(fdtfilefree, len, "%s%s%s%s%s%s",
686 label->fdtdir, slash, f1, f2, f3, f4);
687 fdtfile = fdtfilefree;
688 }
689
690 if (fdtfile) {
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600691 int err = get_relfile_envaddr(ctx, fdtfile,
Simon Glass4d79e882021-10-14 12:48:08 -0600692 "fdt_addr_r", NULL);
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100693
Patrice Chotard2373cba2019-11-25 09:07:37 +0100694 free(fdtfilefree);
695 if (err < 0) {
Anton Leontievdb366742019-09-03 10:52:24 +0300696 bootm_argv[3] = NULL;
697
698 if (label->fdt) {
699 printf("Skipping %s for failure retrieving FDT\n",
700 label->name);
701 goto cleanup;
702 }
Patrice Chotard2373cba2019-11-25 09:07:37 +0100703 }
Neil Armstrong69076df2021-01-20 09:54:53 +0100704
Dan Carpenterbb34bc02023-07-27 10:12:39 +0300705 if (label->kaslrseed)
706 label_boot_kaslrseed();
Zhang Ning02901462022-02-01 08:33:37 +0800707
Neil Armstrong69076df2021-01-20 09:54:53 +0100708#ifdef CONFIG_OF_LIBFDT_OVERLAY
709 if (label->fdtoverlays)
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600710 label_boot_fdtoverlay(ctx, label);
Neil Armstrong69076df2021-01-20 09:54:53 +0100711#endif
Patrice Chotard2373cba2019-11-25 09:07:37 +0100712 } else {
713 bootm_argv[3] = NULL;
714 }
715 }
716
Zhaofeng Lic97bd172021-10-20 00:18:15 -0700717 bootm_argv[1] = kernel_addr;
718 zboot_argv[1] = kernel_addr;
719
720 if (initrd_addr_str) {
721 bootm_argv[2] = initrd_str;
722 bootm_argc = 3;
723
724 zboot_argv[3] = initrd_addr_str;
725 zboot_argv[4] = initrd_filesize;
726 zboot_argc = 5;
727 }
728
Patrice Chotard2373cba2019-11-25 09:07:37 +0100729 if (!bootm_argv[3])
730 bootm_argv[3] = env_get("fdt_addr");
731
Marek Vasut519e6642022-12-14 07:45:18 +0100732 kernel_addr_r = genimg_get_kernel_addr(kernel_addr);
733 buf = map_sysmem(kernel_addr_r, 0);
734
735 if (!bootm_argv[3] && genimg_get_format(buf) != IMAGE_FORMAT_FIT)
Marek Vasutbee35512022-12-17 18:41:13 +0100736 bootm_argv[3] = env_get("fdtcontroladdr");
737
Patrice Chotard2373cba2019-11-25 09:07:37 +0100738 if (bootm_argv[3]) {
739 if (!bootm_argv[2])
740 bootm_argv[2] = "-";
741 bootm_argc = 4;
742 }
743
Patrice Chotard2373cba2019-11-25 09:07:37 +0100744 /* Try bootm for legacy and FIT format image */
John Keepingbe43a352022-07-28 11:19:15 +0100745 if (genimg_get_format(buf) != IMAGE_FORMAT_INVALID &&
746 IS_ENABLED(CONFIG_CMD_BOOTM))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600747 do_bootm(ctx->cmdtp, 0, bootm_argc, bootm_argv);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100748 /* Try booting an AArch64 Linux kernel image */
Kory Maincentff0287e2021-02-02 16:42:28 +0100749 else if (IS_ENABLED(CONFIG_CMD_BOOTI))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600750 do_booti(ctx->cmdtp, 0, bootm_argc, bootm_argv);
Patrice Chotard2373cba2019-11-25 09:07:37 +0100751 /* Try booting a Image */
Kory Maincentff0287e2021-02-02 16:42:28 +0100752 else if (IS_ENABLED(CONFIG_CMD_BOOTZ))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600753 do_bootz(ctx->cmdtp, 0, bootm_argc, bootm_argv);
Kory Maincent18c25822021-02-02 16:42:29 +0100754 /* Try booting an x86_64 Linux kernel image */
755 else if (IS_ENABLED(CONFIG_CMD_ZBOOT))
Simon Glassfd3fa5c2021-10-14 12:47:56 -0600756 do_zboot_parent(ctx->cmdtp, 0, zboot_argc, zboot_argv, NULL);
Kory Maincentff0287e2021-02-02 16:42:28 +0100757
Patrice Chotard2373cba2019-11-25 09:07:37 +0100758 unmap_sysmem(buf);
759
760cleanup:
Simon Glass929860b2021-10-14 12:48:02 -0600761 free(fit_addr);
762
Patrice Chotard2373cba2019-11-25 09:07:37 +0100763 return 1;
764}
765
Simon Glass18109cc2021-10-14 12:48:01 -0600766/** enum token_type - Tokens for the pxe file parser */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100767enum token_type {
768 T_EOL,
769 T_STRING,
770 T_EOF,
771 T_MENU,
772 T_TITLE,
773 T_TIMEOUT,
774 T_LABEL,
775 T_KERNEL,
776 T_LINUX,
777 T_APPEND,
778 T_INITRD,
779 T_LOCALBOOT,
780 T_DEFAULT,
781 T_PROMPT,
782 T_INCLUDE,
783 T_FDT,
784 T_FDTDIR,
Neil Armstrong69076df2021-01-20 09:54:53 +0100785 T_FDTOVERLAYS,
Patrice Chotard2373cba2019-11-25 09:07:37 +0100786 T_ONTIMEOUT,
787 T_IPAPPEND,
788 T_BACKGROUND,
Zhang Ning02901462022-02-01 08:33:37 +0800789 T_KASLRSEED,
Patrice Chotard2373cba2019-11-25 09:07:37 +0100790 T_INVALID
791};
792
Simon Glass18109cc2021-10-14 12:48:01 -0600793/** struct token - token - given by a value and a type */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100794struct token {
795 char *val;
796 enum token_type type;
797};
798
Simon Glass18109cc2021-10-14 12:48:01 -0600799/* Keywords recognized */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100800static const struct token keywords[] = {
801 {"menu", T_MENU},
802 {"title", T_TITLE},
803 {"timeout", T_TIMEOUT},
804 {"default", T_DEFAULT},
805 {"prompt", T_PROMPT},
806 {"label", T_LABEL},
807 {"kernel", T_KERNEL},
808 {"linux", T_LINUX},
809 {"localboot", T_LOCALBOOT},
810 {"append", T_APPEND},
811 {"initrd", T_INITRD},
812 {"include", T_INCLUDE},
813 {"devicetree", T_FDT},
814 {"fdt", T_FDT},
815 {"devicetreedir", T_FDTDIR},
816 {"fdtdir", T_FDTDIR},
Neil Armstrong69076df2021-01-20 09:54:53 +0100817 {"fdtoverlays", T_FDTOVERLAYS},
Edoardo Tomelleri35821a22022-09-21 15:26:33 +0200818 {"devicetree-overlay", T_FDTOVERLAYS},
Patrice Chotard2373cba2019-11-25 09:07:37 +0100819 {"ontimeout", T_ONTIMEOUT,},
820 {"ipappend", T_IPAPPEND,},
821 {"background", T_BACKGROUND,},
Zhang Ning02901462022-02-01 08:33:37 +0800822 {"kaslrseed", T_KASLRSEED,},
Patrice Chotard2373cba2019-11-25 09:07:37 +0100823 {NULL, T_INVALID}
824};
825
Simon Glass18109cc2021-10-14 12:48:01 -0600826/**
827 * enum lex_state - lexer state
828 *
Patrice Chotard2373cba2019-11-25 09:07:37 +0100829 * Since pxe(linux) files don't have a token to identify the start of a
830 * literal, we have to keep track of when we're in a state where a literal is
831 * expected vs when we're in a state a keyword is expected.
832 */
833enum lex_state {
834 L_NORMAL = 0,
835 L_KEYWORD,
836 L_SLITERAL
837};
838
Simon Glass18109cc2021-10-14 12:48:01 -0600839/**
840 * get_string() - retrieves a string from *p and stores it as a token in *t.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100841 *
Simon Glass18109cc2021-10-14 12:48:01 -0600842 * This is used for scanning both string literals and keywords.
Patrice Chotard2373cba2019-11-25 09:07:37 +0100843 *
844 * Characters from *p are copied into t-val until a character equal to
845 * delim is found, or a NUL byte is reached. If delim has the special value of
846 * ' ', any whitespace character will be used as a delimiter.
847 *
848 * If lower is unequal to 0, uppercase characters will be converted to
849 * lowercase in the result. This is useful to make keywords case
850 * insensitive.
851 *
852 * The location of *p is updated to point to the first character after the end
853 * of the token - the ending delimiter.
854 *
Simon Glass18109cc2021-10-14 12:48:01 -0600855 * Memory for t->val is allocated using malloc and must be free()'d to reclaim
856 * it.
857 *
858 * @p: Points to a pointer to the current position in the input being processed.
859 * Updated to point at the first character after the current token
860 * @t: Pointers to a token to fill in
861 * @delim: Delimiter character to look for, either newline or space
862 * @lower: true to convert the string to lower case when storing
863 * Returns the new value of t->val, on success, NULL if out of memory
Patrice Chotard2373cba2019-11-25 09:07:37 +0100864 */
865static char *get_string(char **p, struct token *t, char delim, int lower)
866{
867 char *b, *e;
868 size_t len, i;
869
870 /*
871 * b and e both start at the beginning of the input stream.
872 *
873 * e is incremented until we find the ending delimiter, or a NUL byte
874 * is reached. Then, we take e - b to find the length of the token.
875 */
Patrice Chotard8cb22a62019-11-25 09:07:39 +0100876 b = *p;
877 e = *p;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100878 while (*e) {
879 if ((delim == ' ' && isspace(*e)) || delim == *e)
880 break;
881 e++;
882 }
883
884 len = e - b;
885
886 /*
887 * Allocate memory to hold the string, and copy it in, converting
888 * characters to lowercase if lower is != 0.
889 */
890 t->val = malloc(len + 1);
891 if (!t->val)
892 return NULL;
893
894 for (i = 0; i < len; i++, b++) {
895 if (lower)
896 t->val[i] = tolower(*b);
897 else
898 t->val[i] = *b;
899 }
900
901 t->val[len] = '\0';
902
Simon Glass929860b2021-10-14 12:48:02 -0600903 /* Update *p so the caller knows where to continue scanning */
Patrice Chotard2373cba2019-11-25 09:07:37 +0100904 *p = e;
Patrice Chotard2373cba2019-11-25 09:07:37 +0100905 t->type = T_STRING;
906
907 return t->val;
908}
909
Simon Glass18109cc2021-10-14 12:48:01 -0600910/**
911 * get_keyword() - Populate a keyword token with a type and value
912 *
913 * Updates the ->type field based on the keyword string in @val
914 * @t: Token to populate
Patrice Chotard2373cba2019-11-25 09:07:37 +0100915 */
916static void get_keyword(struct token *t)
917{
918 int i;
919
920 for (i = 0; keywords[i].val; i++) {
921 if (!strcmp(t->val, keywords[i].val)) {
922 t->type = keywords[i].type;
923 break;
924 }
925 }
926}
927
Simon Glass18109cc2021-10-14 12:48:01 -0600928/**
929 * get_token() - Get the next token
Patrice Chotard2373cba2019-11-25 09:07:37 +0100930 *
Simon Glass18109cc2021-10-14 12:48:01 -0600931 * We have to keep track of which state we're in to know if we're looking to get
932 * a string literal or a keyword.
933 *
934 * @p: Points to a pointer to the current position in the input being processed.
935 * Updated to point at the first character after the current token
Patrice Chotard2373cba2019-11-25 09:07:37 +0100936 */
937static void get_token(char **p, struct token *t, enum lex_state state)
938{
939 char *c = *p;
940
941 t->type = T_INVALID;
942
943 /* eat non EOL whitespace */
944 while (isblank(*c))
945 c++;
946
947 /*
948 * eat comments. note that string literals can't begin with #, but
949 * can contain a # after their first character.
950 */
951 if (*c == '#') {
952 while (*c && *c != '\n')
953 c++;
954 }
955
956 if (*c == '\n') {
957 t->type = T_EOL;
958 c++;
959 } else if (*c == '\0') {
960 t->type = T_EOF;
961 c++;
962 } else if (state == L_SLITERAL) {
963 get_string(&c, t, '\n', 0);
964 } else if (state == L_KEYWORD) {
965 /*
966 * when we expect a keyword, we first get the next string
967 * token delimited by whitespace, and then check if it
968 * matches a keyword in our keyword list. if it does, it's
969 * converted to a keyword token of the appropriate type, and
970 * if not, it remains a string token.
971 */
972 get_string(&c, t, ' ', 1);
973 get_keyword(t);
974 }
975
976 *p = c;
977}
978
Simon Glass18109cc2021-10-14 12:48:01 -0600979/**
980 * eol_or_eof() - Find end of line
981 *
982 * Increment *c until we get to the end of the current line, or EOF
983 *
984 * @c: Points to a pointer to the current position in the input being processed.
985 * Updated to point at the first character after the current token
Patrice Chotard2373cba2019-11-25 09:07:37 +0100986 */
987static void eol_or_eof(char **c)
988{
989 while (**c && **c != '\n')
990 (*c)++;
991}
992
993/*
994 * All of these parse_* functions share some common behavior.
995 *
996 * They finish with *c pointing after the token they parse, and return 1 on
997 * success, or < 0 on error.
998 */
999
1000/*
1001 * Parse a string literal and store a pointer it at *dst. String literals
1002 * terminate at the end of the line.
1003 */
1004static int parse_sliteral(char **c, char **dst)
1005{
1006 struct token t;
1007 char *s = *c;
1008
1009 get_token(c, &t, L_SLITERAL);
1010
1011 if (t.type != T_STRING) {
1012 printf("Expected string literal: %.*s\n", (int)(*c - s), s);
1013 return -EINVAL;
1014 }
1015
1016 *dst = t.val;
1017
1018 return 1;
1019}
1020
1021/*
1022 * Parse a base 10 (unsigned) integer and store it at *dst.
1023 */
1024static int parse_integer(char **c, int *dst)
1025{
1026 struct token t;
1027 char *s = *c;
1028
1029 get_token(c, &t, L_SLITERAL);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001030 if (t.type != T_STRING) {
1031 printf("Expected string: %.*s\n", (int)(*c - s), s);
1032 return -EINVAL;
1033 }
1034
1035 *dst = simple_strtol(t.val, NULL, 10);
1036
1037 free(t.val);
1038
1039 return 1;
1040}
1041
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001042static int parse_pxefile_top(struct pxe_context *ctx, char *p, ulong base,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001043 struct pxe_menu *cfg, int nest_level);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001044
1045/*
1046 * Parse an include statement, and retrieve and parse the file it mentions.
1047 *
1048 * base should point to a location where it's safe to store the file, and
1049 * nest_level should indicate how many nested includes have occurred. For this
1050 * include, nest_level has already been incremented and doesn't need to be
1051 * incremented here.
1052 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001053static int handle_include(struct pxe_context *ctx, char **c, unsigned long base,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001054 struct pxe_menu *cfg, int nest_level)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001055{
1056 char *include_path;
1057 char *s = *c;
1058 int err;
1059 char *buf;
1060 int ret;
1061
1062 err = parse_sliteral(c, &include_path);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001063 if (err < 0) {
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001064 printf("Expected include path: %.*s\n", (int)(*c - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001065 return err;
1066 }
1067
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001068 err = get_pxe_file(ctx, include_path, base);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001069 if (err < 0) {
1070 printf("Couldn't retrieve %s\n", include_path);
1071 return err;
1072 }
1073
1074 buf = map_sysmem(base, 0);
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001075 ret = parse_pxefile_top(ctx, buf, base, cfg, nest_level);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001076 unmap_sysmem(buf);
1077
1078 return ret;
1079}
1080
1081/*
1082 * Parse lines that begin with 'menu'.
1083 *
1084 * base and nest are provided to handle the 'menu include' case.
1085 *
1086 * base should point to a location where it's safe to store the included file.
1087 *
1088 * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
1089 * a file it includes, 3 when parsing a file included by that file, and so on.
1090 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001091static int parse_menu(struct pxe_context *ctx, char **c, struct pxe_menu *cfg,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001092 unsigned long base, int nest_level)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001093{
1094 struct token t;
1095 char *s = *c;
1096 int err = 0;
1097
1098 get_token(c, &t, L_KEYWORD);
1099
1100 switch (t.type) {
1101 case T_TITLE:
1102 err = parse_sliteral(c, &cfg->title);
1103
1104 break;
1105
1106 case T_INCLUDE:
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001107 err = handle_include(ctx, c, base, cfg, nest_level + 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001108 break;
1109
1110 case T_BACKGROUND:
1111 err = parse_sliteral(c, &cfg->bmp);
1112 break;
1113
1114 default:
1115 printf("Ignoring malformed menu command: %.*s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001116 (int)(*c - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001117 }
Patrice Chotard2373cba2019-11-25 09:07:37 +01001118 if (err < 0)
1119 return err;
1120
1121 eol_or_eof(c);
1122
1123 return 1;
1124}
1125
1126/*
1127 * Handles parsing a 'menu line' when we're parsing a label.
1128 */
1129static int parse_label_menu(char **c, struct pxe_menu *cfg,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001130 struct pxe_label *label)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001131{
1132 struct token t;
1133 char *s;
1134
1135 s = *c;
1136
1137 get_token(c, &t, L_KEYWORD);
1138
1139 switch (t.type) {
1140 case T_DEFAULT:
1141 if (!cfg->default_label)
1142 cfg->default_label = strdup(label->name);
1143
1144 if (!cfg->default_label)
1145 return -ENOMEM;
1146
1147 break;
1148 case T_LABEL:
1149 parse_sliteral(c, &label->menu);
1150 break;
1151 default:
1152 printf("Ignoring malformed menu command: %.*s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001153 (int)(*c - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001154 }
1155
1156 eol_or_eof(c);
1157
1158 return 0;
1159}
1160
1161/*
1162 * Handles parsing a 'kernel' label.
1163 * expecting "filename" or "<fit_filename>#cfg"
1164 */
1165static int parse_label_kernel(char **c, struct pxe_label *label)
1166{
1167 char *s;
1168 int err;
1169
1170 err = parse_sliteral(c, &label->kernel);
1171 if (err < 0)
1172 return err;
1173
Patrick Delaunaya5dacef2022-10-28 11:01:19 +02001174 /* copy the kernel label to compare with FDT / INITRD when FIT is used */
1175 label->kernel_label = strdup(label->kernel);
1176 if (!label->kernel_label)
1177 return -ENOMEM;
1178
Patrice Chotard2373cba2019-11-25 09:07:37 +01001179 s = strstr(label->kernel, "#");
1180 if (!s)
1181 return 1;
1182
Patrick Delaunay51c5c282022-10-28 11:01:20 +02001183 label->config = strdup(s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001184 if (!label->config)
1185 return -ENOMEM;
1186
Patrice Chotard2373cba2019-11-25 09:07:37 +01001187 *s = 0;
1188
1189 return 1;
1190}
1191
1192/*
1193 * Parses a label and adds it to the list of labels for a menu.
1194 *
1195 * A label ends when we either get to the end of a file, or
1196 * get some input we otherwise don't have a handler defined
1197 * for.
1198 *
1199 */
1200static int parse_label(char **c, struct pxe_menu *cfg)
1201{
1202 struct token t;
1203 int len;
1204 char *s = *c;
1205 struct pxe_label *label;
1206 int err;
1207
1208 label = label_create();
1209 if (!label)
1210 return -ENOMEM;
1211
1212 err = parse_sliteral(c, &label->name);
1213 if (err < 0) {
1214 printf("Expected label name: %.*s\n", (int)(*c - s), s);
1215 label_destroy(label);
1216 return -EINVAL;
1217 }
1218
1219 list_add_tail(&label->list, &cfg->labels);
1220
1221 while (1) {
1222 s = *c;
1223 get_token(c, &t, L_KEYWORD);
1224
1225 err = 0;
1226 switch (t.type) {
1227 case T_MENU:
1228 err = parse_label_menu(c, cfg, label);
1229 break;
1230
1231 case T_KERNEL:
1232 case T_LINUX:
1233 err = parse_label_kernel(c, label);
1234 break;
1235
1236 case T_APPEND:
1237 err = parse_sliteral(c, &label->append);
1238 if (label->initrd)
1239 break;
1240 s = strstr(label->append, "initrd=");
1241 if (!s)
1242 break;
1243 s += 7;
1244 len = (int)(strchr(s, ' ') - s);
1245 label->initrd = malloc(len + 1);
1246 strncpy(label->initrd, s, len);
1247 label->initrd[len] = '\0';
1248
1249 break;
1250
1251 case T_INITRD:
1252 if (!label->initrd)
1253 err = parse_sliteral(c, &label->initrd);
1254 break;
1255
1256 case T_FDT:
1257 if (!label->fdt)
1258 err = parse_sliteral(c, &label->fdt);
1259 break;
1260
1261 case T_FDTDIR:
1262 if (!label->fdtdir)
1263 err = parse_sliteral(c, &label->fdtdir);
1264 break;
1265
Neil Armstrong69076df2021-01-20 09:54:53 +01001266 case T_FDTOVERLAYS:
1267 if (!label->fdtoverlays)
1268 err = parse_sliteral(c, &label->fdtoverlays);
1269 break;
1270
Patrice Chotard2373cba2019-11-25 09:07:37 +01001271 case T_LOCALBOOT:
1272 label->localboot = 1;
1273 err = parse_integer(c, &label->localboot_val);
1274 break;
1275
1276 case T_IPAPPEND:
1277 err = parse_integer(c, &label->ipappend);
1278 break;
1279
Zhang Ning02901462022-02-01 08:33:37 +08001280 case T_KASLRSEED:
1281 label->kaslrseed = 1;
1282 break;
1283
Patrice Chotard2373cba2019-11-25 09:07:37 +01001284 case T_EOL:
1285 break;
1286
1287 default:
1288 /*
1289 * put the token back! we don't want it - it's the end
1290 * of a label and whatever token this is, it's
1291 * something for the menu level context to handle.
1292 */
1293 *c = s;
1294 return 1;
1295 }
1296
1297 if (err < 0)
1298 return err;
1299 }
1300}
1301
1302/*
1303 * This 16 comes from the limit pxelinux imposes on nested includes.
1304 *
1305 * There is no reason at all we couldn't do more, but some limit helps prevent
1306 * infinite (until crash occurs) recursion if a file tries to include itself.
1307 */
1308#define MAX_NEST_LEVEL 16
1309
1310/*
1311 * Entry point for parsing a menu file. nest_level indicates how many times
1312 * we've nested in includes. It will be 1 for the top level menu file.
1313 *
1314 * Returns 1 on success, < 0 on error.
1315 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001316static int parse_pxefile_top(struct pxe_context *ctx, char *p, unsigned long base,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001317 struct pxe_menu *cfg, int nest_level)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001318{
1319 struct token t;
1320 char *s, *b, *label_name;
1321 int err;
1322
1323 b = p;
1324
1325 if (nest_level > MAX_NEST_LEVEL) {
1326 printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL);
1327 return -EMLINK;
1328 }
1329
1330 while (1) {
1331 s = p;
1332
1333 get_token(&p, &t, L_KEYWORD);
1334
1335 err = 0;
1336 switch (t.type) {
1337 case T_MENU:
1338 cfg->prompt = 1;
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001339 err = parse_menu(ctx, &p, cfg,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001340 base + ALIGN(strlen(b) + 1, 4),
1341 nest_level);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001342 break;
1343
1344 case T_TIMEOUT:
1345 err = parse_integer(&p, &cfg->timeout);
1346 break;
1347
1348 case T_LABEL:
1349 err = parse_label(&p, cfg);
1350 break;
1351
1352 case T_DEFAULT:
1353 case T_ONTIMEOUT:
1354 err = parse_sliteral(&p, &label_name);
1355
1356 if (label_name) {
1357 if (cfg->default_label)
1358 free(cfg->default_label);
1359
1360 cfg->default_label = label_name;
1361 }
1362
1363 break;
1364
1365 case T_INCLUDE:
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001366 err = handle_include(ctx, &p,
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001367 base + ALIGN(strlen(b), 4), cfg,
1368 nest_level + 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001369 break;
1370
1371 case T_PROMPT:
Manuel Traut739e8362022-11-18 09:00:27 +01001372 err = parse_integer(&p, &cfg->prompt);
1373 // Do not fail if prompt configuration is undefined
1374 if (err < 0)
1375 eol_or_eof(&p);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001376 break;
1377
1378 case T_EOL:
1379 break;
1380
1381 case T_EOF:
1382 return 1;
1383
1384 default:
1385 printf("Ignoring unknown command: %.*s\n",
Patrice Chotard8cb22a62019-11-25 09:07:39 +01001386 (int)(p - s), s);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001387 eol_or_eof(&p);
1388 }
1389
1390 if (err < 0)
1391 return err;
1392 }
1393}
1394
1395/*
Patrice Chotard2373cba2019-11-25 09:07:37 +01001396 */
1397void destroy_pxe_menu(struct pxe_menu *cfg)
1398{
1399 struct list_head *pos, *n;
1400 struct pxe_label *label;
1401
Simon Glass929860b2021-10-14 12:48:02 -06001402 free(cfg->title);
1403 free(cfg->default_label);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001404
1405 list_for_each_safe(pos, n, &cfg->labels) {
1406 label = list_entry(pos, struct pxe_label, list);
1407
1408 label_destroy(label);
1409 }
1410
1411 free(cfg);
1412}
1413
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001414struct pxe_menu *parse_pxefile(struct pxe_context *ctx, unsigned long menucfg)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001415{
1416 struct pxe_menu *cfg;
1417 char *buf;
1418 int r;
1419
1420 cfg = malloc(sizeof(struct pxe_menu));
Patrice Chotard2373cba2019-11-25 09:07:37 +01001421 if (!cfg)
1422 return NULL;
1423
1424 memset(cfg, 0, sizeof(struct pxe_menu));
1425
1426 INIT_LIST_HEAD(&cfg->labels);
1427
1428 buf = map_sysmem(menucfg, 0);
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001429 r = parse_pxefile_top(ctx, buf, menucfg, cfg, 1);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001430 unmap_sysmem(buf);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001431 if (r < 0) {
1432 destroy_pxe_menu(cfg);
1433 return NULL;
1434 }
1435
1436 return cfg;
1437}
1438
1439/*
1440 * Converts a pxe_menu struct into a menu struct for use with U-Boot's generic
1441 * menu code.
1442 */
1443static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
1444{
1445 struct pxe_label *label;
1446 struct list_head *pos;
1447 struct menu *m;
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001448 char *label_override;
Patrice Chotard2373cba2019-11-25 09:07:37 +01001449 int err;
1450 int i = 1;
1451 char *default_num = NULL;
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001452 char *override_num = NULL;
Patrice Chotard2373cba2019-11-25 09:07:37 +01001453
1454 /*
1455 * Create a menu and add items for all the labels.
1456 */
1457 m = menu_create(cfg->title, DIV_ROUND_UP(cfg->timeout, 10),
Thirupathaiah Annapureddy5168d7a2020-03-18 11:38:42 -07001458 cfg->prompt, NULL, label_print, NULL, NULL);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001459 if (!m)
1460 return NULL;
1461
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001462 label_override = env_get("pxe_label_override");
1463
Patrice Chotard2373cba2019-11-25 09:07:37 +01001464 list_for_each(pos, &cfg->labels) {
1465 label = list_entry(pos, struct pxe_label, list);
1466
1467 sprintf(label->num, "%d", i++);
1468 if (menu_item_add(m, label->num, label) != 1) {
1469 menu_destroy(m);
1470 return NULL;
1471 }
1472 if (cfg->default_label &&
1473 (strcmp(label->name, cfg->default_label) == 0))
1474 default_num = label->num;
Amjad Ouled-Ameurc2969792021-11-13 14:09:20 +01001475 if (label_override && !strcmp(label->name, label_override))
1476 override_num = label->num;
1477 }
1478
1479
1480 if (label_override) {
1481 if (override_num)
1482 default_num = override_num;
1483 else
1484 printf("Missing override pxe label: %s\n",
1485 label_override);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001486 }
1487
1488 /*
1489 * After we've created items for each label in the menu, set the
1490 * menu's default label if one was specified.
1491 */
1492 if (default_num) {
1493 err = menu_default_set(m, default_num);
1494 if (err != 1) {
1495 if (err != -ENOENT) {
1496 menu_destroy(m);
1497 return NULL;
1498 }
1499
1500 printf("Missing default: %s\n", cfg->default_label);
1501 }
1502 }
1503
1504 return m;
1505}
1506
1507/*
1508 * Try to boot any labels we have yet to attempt to boot.
1509 */
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001510static void boot_unattempted_labels(struct pxe_context *ctx,
1511 struct pxe_menu *cfg)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001512{
1513 struct list_head *pos;
1514 struct pxe_label *label;
1515
1516 list_for_each(pos, &cfg->labels) {
1517 label = list_entry(pos, struct pxe_label, list);
1518
1519 if (!label->attempted)
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001520 label_boot(ctx, label);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001521 }
1522}
1523
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001524void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg)
Patrice Chotard2373cba2019-11-25 09:07:37 +01001525{
1526 void *choice;
1527 struct menu *m;
1528 int err;
1529
Kory Maincentff0287e2021-02-02 16:42:28 +01001530 if (IS_ENABLED(CONFIG_CMD_BMP)) {
1531 /* display BMP if available */
1532 if (cfg->bmp) {
Simon Glass4d79e882021-10-14 12:48:08 -06001533 if (get_relfile(ctx, cfg->bmp, image_load_addr, NULL)) {
Simon Glassb86986c2022-10-18 07:46:31 -06001534#if defined(CONFIG_VIDEO)
Patrick Delaunaye6fe02a2022-03-22 17:08:43 +01001535 struct udevice *dev;
1536
1537 err = uclass_first_device_err(UCLASS_VIDEO, &dev);
1538 if (!err)
1539 video_clear(dev);
1540#endif
Kory Maincentff0287e2021-02-02 16:42:28 +01001541 bmp_display(image_load_addr,
1542 BMP_ALIGN_CENTER, BMP_ALIGN_CENTER);
1543 } else {
1544 printf("Skipping background bmp %s for failure\n",
1545 cfg->bmp);
1546 }
Patrice Chotard2373cba2019-11-25 09:07:37 +01001547 }
1548 }
Patrice Chotard2373cba2019-11-25 09:07:37 +01001549
1550 m = pxe_menu_to_menu(cfg);
1551 if (!m)
1552 return;
1553
1554 err = menu_get_choice(m, &choice);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001555 menu_destroy(m);
1556
1557 /*
1558 * err == 1 means we got a choice back from menu_get_choice.
1559 *
1560 * err == -ENOENT if the menu was setup to select the default but no
1561 * default was set. in that case, we should continue trying to boot
1562 * labels that haven't been attempted yet.
1563 *
1564 * otherwise, the user interrupted or there was some other error and
1565 * we give up.
1566 */
1567
1568 if (err == 1) {
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001569 err = label_boot(ctx, choice);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001570 if (!err)
1571 return;
1572 } else if (err != -ENOENT) {
1573 return;
1574 }
1575
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001576 boot_unattempted_labels(ctx, cfg);
1577}
1578
Simon Glass12df8422021-10-14 12:48:04 -06001579int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp,
1580 pxe_getfile_func getfile, void *userdata,
Sean Edmond7d018892023-04-11 10:48:47 -07001581 bool allow_abs_path, const char *bootfile, bool use_ipv6)
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001582{
Simon Glass12df8422021-10-14 12:48:04 -06001583 const char *last_slash;
1584 size_t path_len = 0;
1585
1586 memset(ctx, '\0', sizeof(*ctx));
Simon Glassfd3fa5c2021-10-14 12:47:56 -06001587 ctx->cmdtp = cmdtp;
Simon Glassb1ead6b2021-10-14 12:47:57 -06001588 ctx->getfile = getfile;
Simon Glass4ad5d512021-10-14 12:47:58 -06001589 ctx->userdata = userdata;
Simon Glass8018b9a2021-10-14 12:47:59 -06001590 ctx->allow_abs_path = allow_abs_path;
Sean Edmond7d018892023-04-11 10:48:47 -07001591 ctx->use_ipv6 = use_ipv6;
Simon Glass12df8422021-10-14 12:48:04 -06001592
1593 /* figure out the boot directory, if there is one */
1594 if (bootfile && strlen(bootfile) >= MAX_TFTP_PATH_LEN)
1595 return -ENOSPC;
1596 ctx->bootdir = strdup(bootfile ? bootfile : "");
1597 if (!ctx->bootdir)
1598 return -ENOMEM;
1599
1600 if (bootfile) {
1601 last_slash = strrchr(bootfile, '/');
1602 if (last_slash)
1603 path_len = (last_slash - bootfile) + 1;
1604 }
1605 ctx->bootdir[path_len] = '\0';
1606
1607 return 0;
1608}
1609
1610void pxe_destroy_ctx(struct pxe_context *ctx)
1611{
1612 free(ctx->bootdir);
Patrice Chotard2373cba2019-11-25 09:07:37 +01001613}
Simon Glass9e62e7c2021-10-14 12:48:03 -06001614
1615int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt)
1616{
1617 struct pxe_menu *cfg;
1618
1619 cfg = parse_pxefile(ctx, pxefile_addr_r);
1620 if (!cfg) {
1621 printf("Error parsing config file\n");
1622 return 1;
1623 }
1624
1625 if (prompt)
1626 cfg->prompt = 1;
1627
1628 handle_pxe_menu(ctx, cfg);
1629
1630 destroy_pxe_menu(cfg);
1631
1632 return 0;
1633}