boot/pxe_utils.c

   1 // 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 #define LOG_CATEGORY    LOGC_BOOT
   8
   9 #include <command.h>
  10 #include <dm.h>
  11 #include <env.h>
  12 #include <image.h>
  13 #include <log.h>
  14 #include <malloc.h>
  15 #include <mapmem.h>
  16 #include <net.h>
  17 #include <fdt_support.h>
  18 #include <video.h>
  19 #include <linux/libfdt.h>
  20 #include <linux/string.h>
  21 #include <linux/ctype.h>
  22 #include <errno.h>
  23 #include <linux/list.h>
  24
  25 #include <rng.h>
  26
  27 #include <splash.h>
  28 #include <asm/io.h>
  29
  30 #include "menu.h"
  31 #include "cli.h"
  32
  33 #include "pxe_utils.h"
  34
  35 #define MAX_TFTP_PATH_LEN 512
  36
  37 int pxe_get_file_size(ulong *sizep)
  38 {
  39         const char *val;
  40
  41         val = from_env("filesize");
  42         if (!val)
  43                 return -ENOENT;
  44
  45         if (strict_strtoul(val, 16, sizep) < 0)
  46                 return -EINVAL;
  47
  48         return 0;
  49 }
  50
  51 /**
  52  * format_mac_pxe() - obtain a MAC address in the PXE format
  53  *
  54  * This produces a MAC-address string in the format for the current ethernet
  55  * device:
  56  *
  57  *   01-aa-bb-cc-dd-ee-ff
  58  *
  59  * where aa-ff is the MAC address in hex
  60  *
  61  * @outbuf: Buffer to write string to
  62  * @outbuf_len: length of buffer
  63  * Return: 1 if OK, -ENOSPC if buffer is too small, -ENOENT is there is no
  64  *      current ethernet device
  65  */
  66 int format_mac_pxe(char *outbuf, size_t outbuf_len)
  67 {
  68         uchar ethaddr[6];
  69
  70         if (outbuf_len < 21) {
  71                 printf("outbuf is too small (%zd < 21)\n", outbuf_len);
  72                 return -ENOSPC;
  73         }
  74
  75         if (!eth_env_get_enetaddr_by_index("eth", eth_get_dev_index(), ethaddr))
  76                 return -ENOENT;
  77
  78         sprintf(outbuf, "01-%02x-%02x-%02x-%02x-%02x-%02x",
  79                 ethaddr[0], ethaddr[1], ethaddr[2],
  80                 ethaddr[3], ethaddr[4], ethaddr[5]);
  81
  82         return 1;
  83 }
  84
  85 /**
  86  * get_relfile() - read a file relative to the PXE file
  87  *
  88  * As in pxelinux, paths to files referenced from files we retrieve are
  89  * relative to the location of bootfile. get_relfile takes such a path and
  90  * joins it with the bootfile path to get the full path to the target file. If
  91  * the bootfile path is NULL, we use file_path as is.
  92  *
  93  * @ctx: PXE context
  94  * @file_path: File path to read (relative to the PXE file)
  95  * @file_addr: Address to load file to
  96  * @filesizep: If not NULL, returns the file size in bytes
  97  * Returns 1 for success, or < 0 on error
  98  */
  99 static int get_relfile(struct pxe_context *ctx, const char *file_path,
 100                        unsigned long file_addr, ulong *filesizep)
 101 {
 102         size_t path_len;
 103         char relfile[MAX_TFTP_PATH_LEN + 1];
 104         char addr_buf[18];
 105         ulong size;
 106         int ret;
 107
 108         if (file_path[0] == '/' && ctx->allow_abs_path)
 109                 *relfile = '\0';
 110         else
 111                 strncpy(relfile, ctx->bootdir, MAX_TFTP_PATH_LEN);
 112
 113         path_len = strlen(file_path) + strlen(relfile);
 114
 115         if (path_len > MAX_TFTP_PATH_LEN) {
 116                 printf("Base path too long (%s%s)\n", relfile, file_path);
 117
 118                 return -ENAMETOOLONG;
 119         }
 120
 121         strcat(relfile, file_path);
 122
 123         printf("Retrieving file: %s\n", relfile);
 124
 125         sprintf(addr_buf, "%lx", file_addr);
 126
 127         ret = ctx->getfile(ctx, relfile, addr_buf, &size);
 128         if (ret < 0)
 129                 return log_msg_ret("get", ret);
 130         if (filesizep)
 131                 *filesizep = size;
 132
 133         return 1;
 134 }
 135
 136 /**
 137  * get_pxe_file() - read a file
 138  *
 139  * The file is read and nul-terminated
 140  *
 141  * @ctx: PXE context
 142  * @file_path: File path to read (relative to the PXE file)
 143  * @file_addr: Address to load file to
 144  * Returns 1 for success, or < 0 on error
 145  */
 146 int get_pxe_file(struct pxe_context *ctx, const char *file_path,
 147                  ulong file_addr)
 148 {
 149         ulong size;
 150         int err;
 151         char *buf;
 152
 153         err = get_relfile(ctx, file_path, file_addr, &size);
 154         if (err < 0)
 155                 return err;
 156
 157         buf = map_sysmem(file_addr + size, 1);
 158         *buf = '\0';
 159         unmap_sysmem(buf);
 160
 161         return 1;
 162 }
 163
 164 #define PXELINUX_DIR "pxelinux.cfg/"
 165
 166 /**
 167  * get_pxelinux_path() - Get a file in the pxelinux.cfg/ directory
 168  *
 169  * @ctx: PXE context
 170  * @file: Filename to process (relative to pxelinux.cfg/)
 171  * Returns 1 for success, -ENAMETOOLONG if the resulting path is too long.
 172  *      or other value < 0 on other error
 173  */
 174 int get_pxelinux_path(struct pxe_context *ctx, const char *file,
 175                       unsigned long pxefile_addr_r)
 176 {
 177         size_t base_len = strlen(PXELINUX_DIR);
 178         char path[MAX_TFTP_PATH_LEN + 1];
 179
 180         if (base_len + strlen(file) > MAX_TFTP_PATH_LEN) {
 181                 printf("path (%s%s) too long, skipping\n",
 182                        PXELINUX_DIR, file);
 183                 return -ENAMETOOLONG;
 184         }
 185
 186         sprintf(path, PXELINUX_DIR "%s", file);
 187
 188         return get_pxe_file(ctx, path, pxefile_addr_r);
 189 }
 190
 191 /**
 192  * get_relfile_envaddr() - read a file to an address in an env var
 193  *
 194  * Wrapper to make it easier to store the file at file_path in the location
 195  * specified by envaddr_name. file_path will be joined to the bootfile path,
 196  * if any is specified.
 197  *
 198  * @ctx: PXE context
 199  * @file_path: File path to read (relative to the PXE file)
 200  * @envaddr_name: Name of environment variable which contains the address to
 201  *      load to
 202  * @filesizep: Returns the file size in bytes
 203  * Returns 1 on success, -ENOENT if @envaddr_name does not exist as an
 204  *      environment variable, -EINVAL if its format is not valid hex, or other
 205  *      value < 0 on other error
 206  */
 207 static int get_relfile_envaddr(struct pxe_context *ctx, const char *file_path,
 208                                const char *envaddr_name, ulong *filesizep)
 209 {
 210         unsigned long file_addr;
 211         char *envaddr;
 212
 213         envaddr = from_env(envaddr_name);
 214         if (!envaddr)
 215                 return -ENOENT;
 216
 217         if (strict_strtoul(envaddr, 16, &file_addr) < 0)
 218                 return -EINVAL;
 219
 220         return get_relfile(ctx, file_path, file_addr, filesizep);
 221 }
 222
 223 /**
 224  * label_create() - crate a new PXE label
 225  *
 226  * Allocates memory for and initializes a pxe_label. This uses malloc, so the
 227  * result must be free()'d to reclaim the memory.
 228  *
 229  * Returns a pointer to the label, or NULL if out of memory
 230  */
 231 static struct pxe_label *label_create(void)
 232 {
 233         struct pxe_label *label;
 234
 235         label = malloc(sizeof(struct pxe_label));
 236         if (!label)
 237                 return NULL;
 238
 239         memset(label, 0, sizeof(struct pxe_label));
 240
 241         return label;
 242 }
 243
 244 /**
 245  * label_destroy() - free the memory used by a pxe_label
 246  *
 247  * This frees @label itself as well as memory used by its name,
 248  * kernel, config, append, initrd, fdt, fdtdir and fdtoverlay members, if
 249  * they're non-NULL.
 250  *
 251  * So - be sure to only use dynamically allocated memory for the members of
 252  * the pxe_label struct, unless you want to clean it up first. These are
 253  * currently only created by the pxe file parsing code.
 254  *
 255  * @label: Label to free
 256  */
 257 static void label_destroy(struct pxe_label *label)
 258 {
 259         free(label->name);
 260         free(label->kernel_label);
 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);
 268         free(label);
 269 }
 270
 271 /**
 272  * label_print() - Print a label and its string members if they're defined
 273  *
 274  * This is passed as a callback to the menu code for displaying each
 275  * menu entry.
 276  *
 277  * @data: Label to print (is cast to struct pxe_label *)
 278  */
 279 static 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
 287 /**
 288  * label_localboot() - Boot a label that specified 'localboot'
 289  *
 290  * 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
 297  */
 298 static int label_localboot(struct pxe_label *label)
 299 {
 300         char *localcmd;
 301
 302         localcmd = from_env("localcmd");
 303         if (!localcmd)
 304                 return -ENOENT;
 305
 306         if (label->append) {
 307                 char bootargs[CONFIG_SYS_CBSIZE];
 308
 309                 cli_simple_process_macros(label->append, bootargs,
 310                                           sizeof(bootargs));
 311                 env_set("bootargs", bootargs);
 312         }
 313
 314         debug("running: %s\n", localcmd);
 315
 316         return run_command_list(localcmd, strlen(localcmd), 0);
 317 }
 318
 319 /*
 320  * label_boot_kaslrseed generate kaslrseed from hw rng
 321  */
 322
 323 static void label_boot_kaslrseed(void)
 324 {
 325 #if CONFIG_IS_ENABLED(DM_RNG)
 326         ulong fdt_addr;
 327         struct fdt_header *working_fdt;
 328         int err;
 329
 330         /* Get the main fdt and map it */
 331         fdt_addr = hextoul(env_get("fdt_addr_r"), NULL);
 332         working_fdt = map_sysmem(fdt_addr, 0);
 333         err = fdt_check_header(working_fdt);
 334         if (err)
 335                 return;
 336
 337         /* add extra size for holding kaslr-seed */
 338         /* err is new fdt size, 0 or negtive */
 339         err = fdt_shrink_to_minimum(working_fdt, 512);
 340         if (err <= 0)
 341                 return;
 342
 343         fdt_kaslrseed(working_fdt, true);
 344 #endif
 345         return;
 346 }
 347
 348 /**
 349  * label_boot_fdtoverlay() - Loads fdt overlays specified in 'fdtoverlays'
 350  * or 'devicetree-overlay'
 351  *
 352  * @ctx: PXE context
 353  * @label: Label to process
 354  */
 355 #ifdef CONFIG_OF_LIBFDT_OVERLAY
 356 static void label_boot_fdtoverlay(struct pxe_context *ctx,
 357                                   struct pxe_label *label)
 358 {
 359         char *fdtoverlay = label->fdtoverlays;
 360         struct fdt_header *working_fdt;
 361         char *fdtoverlay_addr_env;
 362         ulong fdtoverlay_addr;
 363         ulong fdt_addr;
 364         int err;
 365
 366         /* Get the main fdt and map it */
 367         fdt_addr = hextoul(env_get("fdt_addr_r"), NULL);
 368         working_fdt = map_sysmem(fdt_addr, 0);
 369         err = fdt_check_header(working_fdt);
 370         if (err)
 371                 return;
 372
 373         /* Get the specific overlay loading address */
 374         fdtoverlay_addr_env = env_get("fdtoverlay_addr_r");
 375         if (!fdtoverlay_addr_env) {
 376                 printf("Invalid fdtoverlay_addr_r for loading overlays\n");
 377                 return;
 378         }
 379
 380         fdtoverlay_addr = hextoul(fdtoverlay_addr_env, NULL);
 381
 382         /* Cycle over the overlay files and apply them in order */
 383         do {
 384                 struct fdt_header *blob;
 385                 char *overlayfile;
 386                 char *end;
 387                 int len;
 388
 389                 /* Drop leading spaces */
 390                 while (*fdtoverlay == ' ')
 391                         ++fdtoverlay;
 392
 393                 /* Copy a single filename if multiple provided */
 394                 end = strstr(fdtoverlay, " ");
 395                 if (end) {
 396                         len = (int)(end - fdtoverlay);
 397                         overlayfile = malloc(len + 1);
 398                         strncpy(overlayfile, fdtoverlay, len);
 399                         overlayfile[len] = '\0';
 400                 } else
 401                         overlayfile = fdtoverlay;
 402
 403                 if (!strlen(overlayfile))
 404                         goto skip_overlay;
 405
 406                 /* Load overlay file */
 407                 err = get_relfile_envaddr(ctx, overlayfile, "fdtoverlay_addr_r",
 408                                           NULL);
 409                 if (err < 0) {
 410                         printf("Failed loading overlay %s\n", overlayfile);
 411                         goto skip_overlay;
 412                 }
 413
 414                 /* Resize main fdt */
 415                 fdt_shrink_to_minimum(working_fdt, 8192);
 416
 417                 blob = map_sysmem(fdtoverlay_addr, 0);
 418                 err = fdt_check_header(blob);
 419                 if (err) {
 420                         printf("Invalid overlay %s, skipping\n",
 421                                overlayfile);
 422                         goto skip_overlay;
 423                 }
 424
 425                 err = fdt_overlay_apply_verbose(working_fdt, blob);
 426                 if (err) {
 427                         printf("Failed to apply overlay %s, skipping\n",
 428                                overlayfile);
 429                         goto skip_overlay;
 430                 }
 431
 432 skip_overlay:
 433                 if (end)
 434                         free(overlayfile);
 435         } while ((fdtoverlay = strstr(fdtoverlay, " ")));
 436 }
 437 #endif
 438
 439 /**
 440  * label_boot() - Boot according to the contents of a pxe_label
 441  *
 442  * If we can't boot for any reason, we return.  A successful boot never
 443  * returns.
 444  *
 445  * The kernel will be stored in the location given by the 'kernel_addr_r'
 446  * environment variable.
 447  *
 448  * If the label specifies an initrd file, it will be stored in the location
 449  * given by the 'ramdisk_addr_r' environment variable.
 450  *
 451  * If the label specifies an 'append' line, its contents will overwrite that
 452  * of the 'bootargs' environment variable.
 453  *
 454  * @ctx: PXE context
 455  * @label: Label to process
 456  * Returns does not return on success, otherwise returns 0 if a localboot
 457  *      label was processed, or 1 on error
 458  */
 459 static int label_boot(struct pxe_context *ctx, struct pxe_label *label)
 460 {
 461         char *bootm_argv[] = { "bootm", NULL, NULL, NULL, NULL };
 462         char *zboot_argv[] = { "zboot", NULL, "0", NULL, NULL };
 463         char *kernel_addr = NULL;
 464         char *initrd_addr_str = NULL;
 465         char initrd_filesize[10];
 466         char initrd_str[28];
 467         char mac_str[29] = "";
 468         char ip_str[68] = "";
 469         char *fit_addr = NULL;
 470         int bootm_argc = 2;
 471         int zboot_argc = 3;
 472         int len = 0;
 473         ulong kernel_addr_r;
 474         void *buf;
 475
 476         label_print(label);
 477
 478         label->attempted = 1;
 479
 480         if (label->localboot) {
 481                 if (label->localboot_val >= 0)
 482                         label_localboot(label);
 483                 return 0;
 484         }
 485
 486         if (!label->kernel) {
 487                 printf("No kernel given, skipping %s\n",
 488                        label->name);
 489                 return 1;
 490         }
 491
 492         if (get_relfile_envaddr(ctx, label->kernel, "kernel_addr_r",
 493                                 NULL) < 0) {
 494                 printf("Skipping %s for failure retrieving kernel\n",
 495                        label->name);
 496                 return 1;
 497         }
 498
 499         kernel_addr = env_get("kernel_addr_r");
 500         /* for FIT, append the configuration identifier */
 501         if (label->config) {
 502                 int len = strlen(kernel_addr) + strlen(label->config) + 1;
 503
 504                 fit_addr = malloc(len);
 505                 if (!fit_addr) {
 506                         printf("malloc fail (FIT address)\n");
 507                         return 1;
 508                 }
 509                 snprintf(fit_addr, len, "%s%s", kernel_addr, label->config);
 510                 kernel_addr = fit_addr;
 511         }
 512
 513         /* For FIT, the label can be identical to kernel one */
 514         if (label->initrd && !strcmp(label->kernel_label, label->initrd)) {
 515                 initrd_addr_str =  kernel_addr;
 516         } else if (label->initrd) {
 517                 ulong size;
 518                 if (get_relfile_envaddr(ctx, label->initrd, "ramdisk_addr_r",
 519                                         &size) < 0) {
 520                         printf("Skipping %s for failure retrieving initrd\n",
 521                                label->name);
 522                         goto cleanup;
 523                 }
 524                 strcpy(initrd_filesize, simple_xtoa(size));
 525                 initrd_addr_str = env_get("ramdisk_addr_r");
 526                 size = snprintf(initrd_str, sizeof(initrd_str), "%s:%lx",
 527                                 initrd_addr_str, size);
 528                 if (size >= sizeof(initrd_str))
 529                         goto cleanup;
 530         }
 531
 532         if (label->ipappend & 0x1) {
 533                 sprintf(ip_str, " ip=%s:%s:%s:%s",
 534                         env_get("ipaddr"), env_get("serverip"),
 535                         env_get("gatewayip"), env_get("netmask"));
 536         }
 537
 538         if (IS_ENABLED(CONFIG_CMD_NET)) {
 539                 if (label->ipappend & 0x2) {
 540                         int err;
 541
 542                         strcpy(mac_str, " BOOTIF=");
 543                         err = format_mac_pxe(mac_str + 8, sizeof(mac_str) - 8);
 544                         if (err < 0)
 545                                 mac_str[0] = '\0';
 546                 }
 547         }
 548
 549         if ((label->ipappend & 0x3) || label->append) {
 550                 char bootargs[CONFIG_SYS_CBSIZE] = "";
 551                 char finalbootargs[CONFIG_SYS_CBSIZE];
 552
 553                 if (strlen(label->append ?: "") +
 554                     strlen(ip_str) + strlen(mac_str) + 1 > sizeof(bootargs)) {
 555                         printf("bootarg overflow %zd+%zd+%zd+1 > %zd\n",
 556                                strlen(label->append ?: ""),
 557                                strlen(ip_str), strlen(mac_str),
 558                                sizeof(bootargs));
 559                         goto cleanup;
 560                 }
 561
 562                 if (label->append)
 563                         strncpy(bootargs, label->append, sizeof(bootargs));
 564
 565                 strcat(bootargs, ip_str);
 566                 strcat(bootargs, mac_str);
 567
 568                 cli_simple_process_macros(bootargs, finalbootargs,
 569                                           sizeof(finalbootargs));
 570                 env_set("bootargs", finalbootargs);
 571                 printf("append: %s\n", finalbootargs);
 572         }
 573
 574         /*
 575          * fdt usage is optional:
 576          * It handles the following scenarios.
 577          *
 578          * Scenario 1: If fdt_addr_r specified and "fdt" or "fdtdir" label is
 579          * defined in pxe file, retrieve fdt blob from server. Pass fdt_addr_r to
 580          * bootm, and adjust argc appropriately.
 581          *
 582          * If retrieve fails and no exact fdt blob is specified in pxe file with
 583          * "fdt" label, try Scenario 2.
 584          *
 585          * Scenario 2: If there is an fdt_addr specified, pass it along to
 586          * bootm, and adjust argc appropriately.
 587          *
 588          * Scenario 3: If there is an fdtcontroladdr specified, pass it along to
 589          * bootm, and adjust argc appropriately, unless the image type is fitImage.
 590          *
 591          * Scenario 4: fdt blob is not available.
 592          */
 593         bootm_argv[3] = env_get("fdt_addr_r");
 594
 595         /* For FIT, the label can be identical to kernel one */
 596         if (label->fdt && !strcmp(label->kernel_label, label->fdt)) {
 597                 bootm_argv[3] = kernel_addr;
 598         /* if fdt label is defined then get fdt from server */
 599         } else if (bootm_argv[3]) {
 600                 char *fdtfile = NULL;
 601                 char *fdtfilefree = NULL;
 602
 603                 if (label->fdt) {
 604                         if (IS_ENABLED(CONFIG_SUPPORT_PASSING_ATAGS)) {
 605                                 if (strcmp("-", label->fdt))
 606                                         fdtfile = label->fdt;
 607                         } else {
 608                                 fdtfile = label->fdt;
 609                         }
 610                 } else if (label->fdtdir) {
 611                         char *f1, *f2, *f3, *f4, *slash;
 612
 613                         f1 = env_get("fdtfile");
 614                         if (f1) {
 615                                 f2 = "";
 616                                 f3 = "";
 617                                 f4 = "";
 618                         } else {
 619                                 /*
 620                                  * For complex cases where this code doesn't
 621                                  * generate the correct filename, the board
 622                                  * code should set $fdtfile during early boot,
 623                                  * or the boot scripts should set $fdtfile
 624                                  * before invoking "pxe" or "sysboot".
 625                                  */
 626                                 f1 = env_get("soc");
 627                                 f2 = "-";
 628                                 f3 = env_get("board");
 629                                 f4 = ".dtb";
 630                                 if (!f1) {
 631                                         f1 = "";
 632                                         f2 = "";
 633                                 }
 634                                 if (!f3) {
 635                                         f2 = "";
 636                                         f3 = "";
 637                                 }
 638                         }
 639
 640                         len = strlen(label->fdtdir);
 641                         if (!len)
 642                                 slash = "./";
 643                         else if (label->fdtdir[len - 1] != '/')
 644                                 slash = "/";
 645                         else
 646                                 slash = "";
 647
 648                         len = strlen(label->fdtdir) + strlen(slash) +
 649                                 strlen(f1) + strlen(f2) + strlen(f3) +
 650                                 strlen(f4) + 1;
 651                         fdtfilefree = malloc(len);
 652                         if (!fdtfilefree) {
 653                                 printf("malloc fail (FDT filename)\n");
 654                                 goto cleanup;
 655                         }
 656
 657                         snprintf(fdtfilefree, len, "%s%s%s%s%s%s",
 658                                  label->fdtdir, slash, f1, f2, f3, f4);
 659                         fdtfile = fdtfilefree;
 660                 }
 661
 662                 if (fdtfile) {
 663                         int err = get_relfile_envaddr(ctx, fdtfile,
 664                                                       "fdt_addr_r", NULL);
 665
 666                         free(fdtfilefree);
 667                         if (err < 0) {
 668                                 bootm_argv[3] = NULL;
 669
 670                                 if (label->fdt) {
 671                                         printf("Skipping %s for failure retrieving FDT\n",
 672                                                label->name);
 673                                         goto cleanup;
 674                                 }
 675
 676                                 if (label->fdtdir) {
 677                                         printf("Skipping fdtdir %s for failure retrieving dts\n",
 678                                                 label->fdtdir);
 679                                 }
 680                         }
 681
 682                         if (label->kaslrseed)
 683                                 label_boot_kaslrseed();
 684
 685 #ifdef CONFIG_OF_LIBFDT_OVERLAY
 686                         if (label->fdtoverlays)
 687                                 label_boot_fdtoverlay(ctx, label);
 688 #endif
 689                 } else {
 690                         bootm_argv[3] = NULL;
 691                 }
 692         }
 693
 694         bootm_argv[1] = kernel_addr;
 695         zboot_argv[1] = kernel_addr;
 696
 697         if (initrd_addr_str) {
 698                 bootm_argv[2] = initrd_str;
 699                 bootm_argc = 3;
 700
 701                 zboot_argv[3] = initrd_addr_str;
 702                 zboot_argv[4] = initrd_filesize;
 703                 zboot_argc = 5;
 704         }
 705
 706         if (!bootm_argv[3]) {
 707                 if (IS_ENABLED(CONFIG_SUPPORT_PASSING_ATAGS)) {
 708                         if (strcmp("-", label->fdt))
 709                                 bootm_argv[3] = env_get("fdt_addr");
 710                 } else {
 711                         bootm_argv[3] = env_get("fdt_addr");
 712                 }
 713         }
 714
 715         kernel_addr_r = genimg_get_kernel_addr(kernel_addr);
 716         buf = map_sysmem(kernel_addr_r, 0);
 717
 718         if (!bootm_argv[3] && genimg_get_format(buf) != IMAGE_FORMAT_FIT) {
 719                 if (IS_ENABLED(CONFIG_SUPPORT_PASSING_ATAGS)) {
 720                         if (strcmp("-", label->fdt))
 721                                 bootm_argv[3] = env_get("fdtcontroladdr");
 722                 } else {
 723                         bootm_argv[3] = env_get("fdtcontroladdr");
 724                 }
 725         }
 726
 727         if (bootm_argv[3]) {
 728                 if (!bootm_argv[2])
 729                         bootm_argv[2] = "-";
 730                 bootm_argc = 4;
 731         }
 732
 733         /* Try bootm for legacy and FIT format image */
 734         if (genimg_get_format(buf) != IMAGE_FORMAT_INVALID &&
 735             IS_ENABLED(CONFIG_CMD_BOOTM)) {
 736                 log_debug("using bootm\n");
 737                 do_bootm(ctx->cmdtp, 0, bootm_argc, bootm_argv);
 738         /* Try booting an AArch64 Linux kernel image */
 739         } else if (IS_ENABLED(CONFIG_CMD_BOOTI)) {
 740                 log_debug("using booti\n");
 741                 do_booti(ctx->cmdtp, 0, bootm_argc, bootm_argv);
 742         /* Try booting a Image */
 743         } else if (IS_ENABLED(CONFIG_CMD_BOOTZ)) {
 744                 log_debug("using bootz\n");
 745                 do_bootz(ctx->cmdtp, 0, bootm_argc, bootm_argv);
 746         /* Try booting an x86_64 Linux kernel image */
 747         } else if (IS_ENABLED(CONFIG_CMD_ZBOOT)) {
 748                 log_debug("using zboot\n");
 749                 do_zboot_parent(ctx->cmdtp, 0, zboot_argc, zboot_argv, NULL);
 750         }
 751
 752         unmap_sysmem(buf);
 753
 754 cleanup:
 755         free(fit_addr);
 756
 757         return 1;
 758 }
 759
 760 /** enum token_type - Tokens for the pxe file parser */
 761 enum token_type {
 762         T_EOL,
 763         T_STRING,
 764         T_EOF,
 765         T_MENU,
 766         T_TITLE,
 767         T_TIMEOUT,
 768         T_LABEL,
 769         T_KERNEL,
 770         T_LINUX,
 771         T_APPEND,
 772         T_INITRD,
 773         T_LOCALBOOT,
 774         T_DEFAULT,
 775         T_PROMPT,
 776         T_INCLUDE,
 777         T_FDT,
 778         T_FDTDIR,
 779         T_FDTOVERLAYS,
 780         T_ONTIMEOUT,
 781         T_IPAPPEND,
 782         T_BACKGROUND,
 783         T_KASLRSEED,
 784         T_INVALID
 785 };
 786
 787 /** struct token - token - given by a value and a type */
 788 struct token {
 789         char *val;
 790         enum token_type type;
 791 };
 792
 793 /* Keywords recognized */
 794 static const struct token keywords[] = {
 795         {"menu", T_MENU},
 796         {"title", T_TITLE},
 797         {"timeout", T_TIMEOUT},
 798         {"default", T_DEFAULT},
 799         {"prompt", T_PROMPT},
 800         {"label", T_LABEL},
 801         {"kernel", T_KERNEL},
 802         {"linux", T_LINUX},
 803         {"localboot", T_LOCALBOOT},
 804         {"append", T_APPEND},
 805         {"initrd", T_INITRD},
 806         {"include", T_INCLUDE},
 807         {"devicetree", T_FDT},
 808         {"fdt", T_FDT},
 809         {"devicetreedir", T_FDTDIR},
 810         {"fdtdir", T_FDTDIR},
 811         {"fdtoverlays", T_FDTOVERLAYS},
 812         {"devicetree-overlay", T_FDTOVERLAYS},
 813         {"ontimeout", T_ONTIMEOUT,},
 814         {"ipappend", T_IPAPPEND,},
 815         {"background", T_BACKGROUND,},
 816         {"kaslrseed", T_KASLRSEED,},
 817         {NULL, T_INVALID}
 818 };
 819
 820 /**
 821  * enum lex_state - lexer state
 822  *
 823  * Since pxe(linux) files don't have a token to identify the start of a
 824  * literal, we have to keep track of when we're in a state where a literal is
 825  * expected vs when we're in a state a keyword is expected.
 826  */
 827 enum lex_state {
 828         L_NORMAL = 0,
 829         L_KEYWORD,
 830         L_SLITERAL
 831 };
 832
 833 /**
 834  * get_string() - retrieves a string from *p and stores it as a token in *t.
 835  *
 836  * This is used for scanning both string literals and keywords.
 837  *
 838  * Characters from *p are copied into t-val until a character equal to
 839  * delim is found, or a NUL byte is reached. If delim has the special value of
 840  * ' ', any whitespace character will be used as a delimiter.
 841  *
 842  * If lower is unequal to 0, uppercase characters will be converted to
 843  * lowercase in the result. This is useful to make keywords case
 844  * insensitive.
 845  *
 846  * The location of *p is updated to point to the first character after the end
 847  * of the token - the ending delimiter.
 848  *
 849  * Memory for t->val is allocated using malloc and must be free()'d to reclaim
 850  * it.
 851  *
 852  * @p: Points to a pointer to the current position in the input being processed.
 853  *      Updated to point at the first character after the current token
 854  * @t: Pointers to a token to fill in
 855  * @delim: Delimiter character to look for, either newline or space
 856  * @lower: true to convert the string to lower case when storing
 857  * Returns the new value of t->val, on success, NULL if out of memory
 858  */
 859 static char *get_string(char **p, struct token *t, char delim, int lower)
 860 {
 861         char *b, *e;
 862         size_t len, i;
 863
 864         /*
 865          * b and e both start at the beginning of the input stream.
 866          *
 867          * e is incremented until we find the ending delimiter, or a NUL byte
 868          * is reached. Then, we take e - b to find the length of the token.
 869          */
 870         b = *p;
 871         e = *p;
 872         while (*e) {
 873                 if ((delim == ' ' && isspace(*e)) || delim == *e)
 874                         break;
 875                 e++;
 876         }
 877
 878         len = e - b;
 879
 880         /*
 881          * Allocate memory to hold the string, and copy it in, converting
 882          * characters to lowercase if lower is != 0.
 883          */
 884         t->val = malloc(len + 1);
 885         if (!t->val)
 886                 return NULL;
 887
 888         for (i = 0; i < len; i++, b++) {
 889                 if (lower)
 890                         t->val[i] = tolower(*b);
 891                 else
 892                         t->val[i] = *b;
 893         }
 894
 895         t->val[len] = '\0';
 896
 897         /* Update *p so the caller knows where to continue scanning */
 898         *p = e;
 899         t->type = T_STRING;
 900
 901         return t->val;
 902 }
 903
 904 /**
 905  * get_keyword() - Populate a keyword token with a type and value
 906  *
 907  * Updates the ->type field based on the keyword string in @val
 908  * @t: Token to populate
 909  */
 910 static void get_keyword(struct token *t)
 911 {
 912         int i;
 913
 914         for (i = 0; keywords[i].val; i++) {
 915                 if (!strcmp(t->val, keywords[i].val)) {
 916                         t->type = keywords[i].type;
 917                         break;
 918                 }
 919         }
 920 }
 921
 922 /**
 923  * get_token() - Get the next token
 924  *
 925  * We have to keep track of which state we're in to know if we're looking to get
 926  * a string literal or a keyword.
 927  *
 928  * @p: Points to a pointer to the current position in the input being processed.
 929  *      Updated to point at the first character after the current token
 930  */
 931 static void get_token(char **p, struct token *t, enum lex_state state)
 932 {
 933         char *c = *p;
 934
 935         t->type = T_INVALID;
 936
 937         /* eat non EOL whitespace */
 938         while (isblank(*c))
 939                 c++;
 940
 941         /*
 942          * eat comments. note that string literals can't begin with #, but
 943          * can contain a # after their first character.
 944          */
 945         if (*c == '#') {
 946                 while (*c && *c != '\n')
 947                         c++;
 948         }
 949
 950         if (*c == '\n') {
 951                 t->type = T_EOL;
 952                 c++;
 953         } else if (*c == '\0') {
 954                 t->type = T_EOF;
 955                 c++;
 956         } else if (state == L_SLITERAL) {
 957                 get_string(&c, t, '\n', 0);
 958         } else if (state == L_KEYWORD) {
 959                 /*
 960                  * when we expect a keyword, we first get the next string
 961                  * token delimited by whitespace, and then check if it
 962                  * matches a keyword in our keyword list. if it does, it's
 963                  * converted to a keyword token of the appropriate type, and
 964                  * if not, it remains a string token.
 965                  */
 966                 get_string(&c, t, ' ', 1);
 967                 get_keyword(t);
 968         }
 969
 970         *p = c;
 971 }
 972
 973 /**
 974  * eol_or_eof() - Find end of line
 975  *
 976  * Increment *c until we get to the end of the current line, or EOF
 977  *
 978  * @c: Points to a pointer to the current position in the input being processed.
 979  *      Updated to point at the first character after the current token
 980  */
 981 static void eol_or_eof(char **c)
 982 {
 983         while (**c && **c != '\n')
 984                 (*c)++;
 985 }
 986
 987 /*
 988  * All of these parse_* functions share some common behavior.
 989  *
 990  * They finish with *c pointing after the token they parse, and return 1 on
 991  * success, or < 0 on error.
 992  */
 993
 994 /*
 995  * Parse a string literal and store a pointer it at *dst. String literals
 996  * terminate at the end of the line.
 997  */
 998 static int parse_sliteral(char **c, char **dst)
 999 {
1000         struct token t;
1001         char *s = *c;
1002
1003         get_token(c, &t, L_SLITERAL);
1004
1005         if (t.type != T_STRING) {
1006                 printf("Expected string literal: %.*s\n", (int)(*c - s), s);
1007                 return -EINVAL;
1008         }
1009
1010         *dst = t.val;
1011
1012         return 1;
1013 }
1014
1015 /*
1016  * Parse a base 10 (unsigned) integer and store it at *dst.
1017  */
1018 static int parse_integer(char **c, int *dst)
1019 {
1020         struct token t;
1021         char *s = *c;
1022
1023         get_token(c, &t, L_SLITERAL);
1024         if (t.type != T_STRING) {
1025                 printf("Expected string: %.*s\n", (int)(*c - s), s);
1026                 return -EINVAL;
1027         }
1028
1029         *dst = simple_strtol(t.val, NULL, 10);
1030
1031         free(t.val);
1032
1033         return 1;
1034 }
1035
1036 static int parse_pxefile_top(struct pxe_context *ctx, char *p, ulong base,
1037                              struct pxe_menu *cfg, int nest_level);
1038
1039 /*
1040  * Parse an include statement, and retrieve and parse the file it mentions.
1041  *
1042  * base should point to a location where it's safe to store the file, and
1043  * nest_level should indicate how many nested includes have occurred. For this
1044  * include, nest_level has already been incremented and doesn't need to be
1045  * incremented here.
1046  */
1047 static int handle_include(struct pxe_context *ctx, char **c, unsigned long base,
1048                           struct pxe_menu *cfg, int nest_level)
1049 {
1050         char *include_path;
1051         char *s = *c;
1052         int err;
1053         char *buf;
1054         int ret;
1055
1056         err = parse_sliteral(c, &include_path);
1057         if (err < 0) {
1058                 printf("Expected include path: %.*s\n", (int)(*c - s), s);
1059                 return err;
1060         }
1061
1062         err = get_pxe_file(ctx, include_path, base);
1063         if (err < 0) {
1064                 printf("Couldn't retrieve %s\n", include_path);
1065                 return err;
1066         }
1067
1068         buf = map_sysmem(base, 0);
1069         ret = parse_pxefile_top(ctx, buf, base, cfg, nest_level);
1070         unmap_sysmem(buf);
1071
1072         return ret;
1073 }
1074
1075 /*
1076  * Parse lines that begin with 'menu'.
1077  *
1078  * base and nest are provided to handle the 'menu include' case.
1079  *
1080  * base should point to a location where it's safe to store the included file.
1081  *
1082  * nest_level should be 1 when parsing the top level pxe file, 2 when parsing
1083  * a file it includes, 3 when parsing a file included by that file, and so on.
1084  */
1085 static int parse_menu(struct pxe_context *ctx, char **c, struct pxe_menu *cfg,
1086                       unsigned long base, int nest_level)
1087 {
1088         struct token t;
1089         char *s = *c;
1090         int err = 0;
1091
1092         get_token(c, &t, L_KEYWORD);
1093
1094         switch (t.type) {
1095         case T_TITLE:
1096                 err = parse_sliteral(c, &cfg->title);
1097
1098                 break;
1099
1100         case T_INCLUDE:
1101                 err = handle_include(ctx, c, base, cfg, nest_level + 1);
1102                 break;
1103
1104         case T_BACKGROUND:
1105                 err = parse_sliteral(c, &cfg->bmp);
1106                 break;
1107
1108         default:
1109                 printf("Ignoring malformed menu command: %.*s\n",
1110                        (int)(*c - s), s);
1111         }
1112         if (err < 0)
1113                 return err;
1114
1115         eol_or_eof(c);
1116
1117         return 1;
1118 }
1119
1120 /*
1121  * Handles parsing a 'menu line' when we're parsing a label.
1122  */
1123 static int parse_label_menu(char **c, struct pxe_menu *cfg,
1124                             struct pxe_label *label)
1125 {
1126         struct token t;
1127         char *s;
1128
1129         s = *c;
1130
1131         get_token(c, &t, L_KEYWORD);
1132
1133         switch (t.type) {
1134         case T_DEFAULT:
1135                 if (!cfg->default_label)
1136                         cfg->default_label = strdup(label->name);
1137
1138                 if (!cfg->default_label)
1139                         return -ENOMEM;
1140
1141                 break;
1142         case T_LABEL:
1143                 parse_sliteral(c, &label->menu);
1144                 break;
1145         default:
1146                 printf("Ignoring malformed menu command: %.*s\n",
1147                        (int)(*c - s), s);
1148         }
1149
1150         eol_or_eof(c);
1151
1152         return 0;
1153 }
1154
1155 /*
1156  * Handles parsing a 'kernel' label.
1157  * expecting "filename" or "<fit_filename>#cfg"
1158  */
1159 static int parse_label_kernel(char **c, struct pxe_label *label)
1160 {
1161         char *s;
1162         int err;
1163
1164         err = parse_sliteral(c, &label->kernel);
1165         if (err < 0)
1166                 return err;
1167
1168         /* copy the kernel label to compare with FDT / INITRD when FIT is used */
1169         label->kernel_label = strdup(label->kernel);
1170         if (!label->kernel_label)
1171                 return -ENOMEM;
1172
1173         s = strstr(label->kernel, "#");
1174         if (!s)
1175                 return 1;
1176
1177         label->config = strdup(s);
1178         if (!label->config)
1179                 return -ENOMEM;
1180
1181         *s = 0;
1182
1183         return 1;
1184 }
1185
1186 /*
1187  * Parses a label and adds it to the list of labels for a menu.
1188  *
1189  * A label ends when we either get to the end of a file, or
1190  * get some input we otherwise don't have a handler defined
1191  * for.
1192  *
1193  */
1194 static int parse_label(char **c, struct pxe_menu *cfg)
1195 {
1196         struct token t;
1197         int len;
1198         char *s = *c;
1199         struct pxe_label *label;
1200         int err;
1201
1202         label = label_create();
1203         if (!label)
1204                 return -ENOMEM;
1205
1206         err = parse_sliteral(c, &label->name);
1207         if (err < 0) {
1208                 printf("Expected label name: %.*s\n", (int)(*c - s), s);
1209                 label_destroy(label);
1210                 return -EINVAL;
1211         }
1212
1213         list_add_tail(&label->list, &cfg->labels);
1214
1215         while (1) {
1216                 s = *c;
1217                 get_token(c, &t, L_KEYWORD);
1218
1219                 err = 0;
1220                 switch (t.type) {
1221                 case T_MENU:
1222                         err = parse_label_menu(c, cfg, label);
1223                         break;
1224
1225                 case T_KERNEL:
1226                 case T_LINUX:
1227                         err = parse_label_kernel(c, label);
1228                         break;
1229
1230                 case T_APPEND:
1231                         err = parse_sliteral(c, &label->append);
1232                         if (label->initrd)
1233                                 break;
1234                         s = strstr(label->append, "initrd=");
1235                         if (!s)
1236                                 break;
1237                         s += 7;
1238                         len = (int)(strchr(s, ' ') - s);
1239                         label->initrd = malloc(len + 1);
1240                         strncpy(label->initrd, s, len);
1241                         label->initrd[len] = '\0';
1242
1243                         break;
1244
1245                 case T_INITRD:
1246                         if (!label->initrd)
1247                                 err = parse_sliteral(c, &label->initrd);
1248                         break;
1249
1250                 case T_FDT:
1251                         if (!label->fdt)
1252                                 err = parse_sliteral(c, &label->fdt);
1253                         break;
1254
1255                 case T_FDTDIR:
1256                         if (!label->fdtdir)
1257                                 err = parse_sliteral(c, &label->fdtdir);
1258                         break;
1259
1260                 case T_FDTOVERLAYS:
1261                         if (!label->fdtoverlays)
1262                                 err = parse_sliteral(c, &label->fdtoverlays);
1263                         break;
1264
1265                 case T_LOCALBOOT:
1266                         label->localboot = 1;
1267                         err = parse_integer(c, &label->localboot_val);
1268                         break;
1269
1270                 case T_IPAPPEND:
1271                         err = parse_integer(c, &label->ipappend);
1272                         break;
1273
1274                 case T_KASLRSEED:
1275                         label->kaslrseed = 1;
1276                         break;
1277
1278                 case T_EOL:
1279                         break;
1280
1281                 default:
1282                         /*
1283                          * put the token back! we don't want it - it's the end
1284                          * of a label and whatever token this is, it's
1285                          * something for the menu level context to handle.
1286                          */
1287                         *c = s;
1288                         return 1;
1289                 }
1290
1291                 if (err < 0)
1292                         return err;
1293         }
1294 }
1295
1296 /*
1297  * This 16 comes from the limit pxelinux imposes on nested includes.
1298  *
1299  * There is no reason at all we couldn't do more, but some limit helps prevent
1300  * infinite (until crash occurs) recursion if a file tries to include itself.
1301  */
1302 #define MAX_NEST_LEVEL 16
1303
1304 /*
1305  * Entry point for parsing a menu file. nest_level indicates how many times
1306  * we've nested in includes.  It will be 1 for the top level menu file.
1307  *
1308  * Returns 1 on success, < 0 on error.
1309  */
1310 static int parse_pxefile_top(struct pxe_context *ctx, char *p, unsigned long base,
1311                              struct pxe_menu *cfg, int nest_level)
1312 {
1313         struct token t;
1314         char *s, *b, *label_name;
1315         int err;
1316
1317         b = p;
1318
1319         if (nest_level > MAX_NEST_LEVEL) {
1320                 printf("Maximum nesting (%d) exceeded\n", MAX_NEST_LEVEL);
1321                 return -EMLINK;
1322         }
1323
1324         while (1) {
1325                 s = p;
1326
1327                 get_token(&p, &t, L_KEYWORD);
1328
1329                 err = 0;
1330                 switch (t.type) {
1331                 case T_MENU:
1332                         cfg->prompt = 1;
1333                         err = parse_menu(ctx, &p, cfg,
1334                                          base + ALIGN(strlen(b) + 1, 4),
1335                                          nest_level);
1336                         break;
1337
1338                 case T_TIMEOUT:
1339                         err = parse_integer(&p, &cfg->timeout);
1340                         break;
1341
1342                 case T_LABEL:
1343                         err = parse_label(&p, cfg);
1344                         break;
1345
1346                 case T_DEFAULT:
1347                 case T_ONTIMEOUT:
1348                         err = parse_sliteral(&p, &label_name);
1349
1350                         if (label_name) {
1351                                 if (cfg->default_label)
1352                                         free(cfg->default_label);
1353
1354                                 cfg->default_label = label_name;
1355                         }
1356
1357                         break;
1358
1359                 case T_INCLUDE:
1360                         err = handle_include(ctx, &p,
1361                                              base + ALIGN(strlen(b), 4), cfg,
1362                                              nest_level + 1);
1363                         break;
1364
1365                 case T_PROMPT:
1366                         err = parse_integer(&p, &cfg->prompt);
1367                         // Do not fail if prompt configuration is undefined
1368                         if (err <  0)
1369                                 eol_or_eof(&p);
1370                         break;
1371
1372                 case T_EOL:
1373                         break;
1374
1375                 case T_EOF:
1376                         return 1;
1377
1378                 default:
1379                         printf("Ignoring unknown command: %.*s\n",
1380                                (int)(p - s), s);
1381                         eol_or_eof(&p);
1382                 }
1383
1384                 if (err < 0)
1385                         return err;
1386         }
1387 }
1388
1389 /*
1390  */
1391 void destroy_pxe_menu(struct pxe_menu *cfg)
1392 {
1393         struct list_head *pos, *n;
1394         struct pxe_label *label;
1395
1396         free(cfg->title);
1397         free(cfg->default_label);
1398
1399         list_for_each_safe(pos, n, &cfg->labels) {
1400                 label = list_entry(pos, struct pxe_label, list);
1401
1402                 label_destroy(label);
1403         }
1404
1405         free(cfg);
1406 }
1407
1408 struct pxe_menu *parse_pxefile(struct pxe_context *ctx, unsigned long menucfg)
1409 {
1410         struct pxe_menu *cfg;
1411         char *buf;
1412         int r;
1413
1414         cfg = malloc(sizeof(struct pxe_menu));
1415         if (!cfg)
1416                 return NULL;
1417
1418         memset(cfg, 0, sizeof(struct pxe_menu));
1419
1420         INIT_LIST_HEAD(&cfg->labels);
1421
1422         buf = map_sysmem(menucfg, 0);
1423         r = parse_pxefile_top(ctx, buf, menucfg, cfg, 1);
1424         unmap_sysmem(buf);
1425         if (r < 0) {
1426                 destroy_pxe_menu(cfg);
1427                 return NULL;
1428         }
1429
1430         return cfg;
1431 }
1432
1433 /*
1434  * Converts a pxe_menu struct into a menu struct for use with U-Boot's generic
1435  * menu code.
1436  */
1437 static struct menu *pxe_menu_to_menu(struct pxe_menu *cfg)
1438 {
1439         struct pxe_label *label;
1440         struct list_head *pos;
1441         struct menu *m;
1442         char *label_override;
1443         int err;
1444         int i = 1;
1445         char *default_num = NULL;
1446         char *override_num = NULL;
1447
1448         /*
1449          * Create a menu and add items for all the labels.
1450          */
1451         m = menu_create(cfg->title, DIV_ROUND_UP(cfg->timeout, 10),
1452                         cfg->prompt, NULL, label_print, NULL, NULL);
1453         if (!m)
1454                 return NULL;
1455
1456         label_override = env_get("pxe_label_override");
1457
1458         list_for_each(pos, &cfg->labels) {
1459                 label = list_entry(pos, struct pxe_label, list);
1460
1461                 sprintf(label->num, "%d", i++);
1462                 if (menu_item_add(m, label->num, label) != 1) {
1463                         menu_destroy(m);
1464                         return NULL;
1465                 }
1466                 if (cfg->default_label &&
1467                     (strcmp(label->name, cfg->default_label) == 0))
1468                         default_num = label->num;
1469                 if (label_override && !strcmp(label->name, label_override))
1470                         override_num = label->num;
1471         }
1472
1473         if (label_override) {
1474                 if (override_num)
1475                         default_num = override_num;
1476                 else
1477                         printf("Missing override pxe label: %s\n",
1478                               label_override);
1479         }
1480
1481         /*
1482          * After we've created items for each label in the menu, set the
1483          * menu's default label if one was specified.
1484          */
1485         if (default_num) {
1486                 err = menu_default_set(m, default_num);
1487                 if (err != 1) {
1488                         if (err != -ENOENT) {
1489                                 menu_destroy(m);
1490                                 return NULL;
1491                         }
1492
1493                         printf("Missing default: %s\n", cfg->default_label);
1494                 }
1495         }
1496
1497         return m;
1498 }
1499
1500 /*
1501  * Try to boot any labels we have yet to attempt to boot.
1502  */
1503 static void boot_unattempted_labels(struct pxe_context *ctx,
1504                                     struct pxe_menu *cfg)
1505 {
1506         struct list_head *pos;
1507         struct pxe_label *label;
1508
1509         list_for_each(pos, &cfg->labels) {
1510                 label = list_entry(pos, struct pxe_label, list);
1511
1512                 if (!label->attempted)
1513                         label_boot(ctx, label);
1514         }
1515 }
1516
1517 void handle_pxe_menu(struct pxe_context *ctx, struct pxe_menu *cfg)
1518 {
1519         void *choice;
1520         struct menu *m;
1521         int err;
1522
1523         if (IS_ENABLED(CONFIG_CMD_BMP)) {
1524                 /* display BMP if available */
1525                 if (cfg->bmp) {
1526                         if (get_relfile(ctx, cfg->bmp, image_load_addr, NULL)) {
1527 #if defined(CONFIG_VIDEO)
1528                                 struct udevice *dev;
1529
1530                                 err = uclass_first_device_err(UCLASS_VIDEO, &dev);
1531                                 if (!err)
1532                                         video_clear(dev);
1533 #endif
1534                                 bmp_display(image_load_addr,
1535                                             BMP_ALIGN_CENTER, BMP_ALIGN_CENTER);
1536                         } else {
1537                                 printf("Skipping background bmp %s for failure\n",
1538                                        cfg->bmp);
1539                         }
1540                 }
1541         }
1542
1543         m = pxe_menu_to_menu(cfg);
1544         if (!m)
1545                 return;
1546
1547         err = menu_get_choice(m, &choice);
1548         menu_destroy(m);
1549
1550         /*
1551          * err == 1 means we got a choice back from menu_get_choice.
1552          *
1553          * err == -ENOENT if the menu was setup to select the default but no
1554          * default was set. in that case, we should continue trying to boot
1555          * labels that haven't been attempted yet.
1556          *
1557          * otherwise, the user interrupted or there was some other error and
1558          * we give up.
1559          */
1560
1561         if (err == 1) {
1562                 err = label_boot(ctx, choice);
1563                 if (!err)
1564                         return;
1565         } else if (err != -ENOENT) {
1566                 return;
1567         }
1568
1569         boot_unattempted_labels(ctx, cfg);
1570 }
1571
1572 int pxe_setup_ctx(struct pxe_context *ctx, struct cmd_tbl *cmdtp,
1573                   pxe_getfile_func getfile, void *userdata,
1574                   bool allow_abs_path, const char *bootfile, bool use_ipv6)
1575 {
1576         const char *last_slash;
1577         size_t path_len = 0;
1578
1579         memset(ctx, '\0', sizeof(*ctx));
1580         ctx->cmdtp = cmdtp;
1581         ctx->getfile = getfile;
1582         ctx->userdata = userdata;
1583         ctx->allow_abs_path = allow_abs_path;
1584         ctx->use_ipv6 = use_ipv6;
1585
1586         /* figure out the boot directory, if there is one */
1587         if (bootfile && strlen(bootfile) >= MAX_TFTP_PATH_LEN)
1588                 return -ENOSPC;
1589         ctx->bootdir = strdup(bootfile ? bootfile : "");
1590         if (!ctx->bootdir)
1591                 return -ENOMEM;
1592
1593         if (bootfile) {
1594                 last_slash = strrchr(bootfile, '/');
1595                 if (last_slash)
1596                         path_len = (last_slash - bootfile) + 1;
1597         }
1598         ctx->bootdir[path_len] = '\0';
1599
1600         return 0;
1601 }
1602
1603 void pxe_destroy_ctx(struct pxe_context *ctx)
1604 {
1605         free(ctx->bootdir);
1606 }
1607
1608 int pxe_process(struct pxe_context *ctx, ulong pxefile_addr_r, bool prompt)
1609 {
1610         struct pxe_menu *cfg;
1611
1612         cfg = parse_pxefile(ctx, pxefile_addr_r);
1613         if (!cfg) {
1614                 printf("Error parsing config file\n");
1615                 return 1;
1616         }
1617
1618         if (prompt)
1619                 cfg->prompt = 1;
1620
1621         handle_pxe_menu(ctx, cfg);
1622
1623         destroy_pxe_menu(cfg);
1624
1625         return 0;
1626 }