cmd/bootefi.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI application loader
   4  *
   5  *  Copyright (c) 2016 Alexander Graf
   6  */
   7
   8 #define LOG_CATEGORY LOGC_EFI
   9
  10 #include <common.h>
  11 #include <bootm.h>
  12 #include <charset.h>
  13 #include <command.h>
  14 #include <dm.h>
  15 #include <efi_loader.h>
  16 #include <efi_selftest.h>
  17 #include <env.h>
  18 #include <errno.h>
  19 #include <image.h>
  20 #include <log.h>
  21 #include <malloc.h>
  22 #include <asm/global_data.h>
  23 #include <linux/libfdt.h>
  24 #include <linux/libfdt_env.h>
  25 #include <mapmem.h>
  26 #include <memalign.h>
  27 #include <asm-generic/sections.h>
  28 #include <linux/linkage.h>
  29
  30 DECLARE_GLOBAL_DATA_PTR;
  31
  32 static struct efi_device_path *bootefi_image_path;
  33 static struct efi_device_path *bootefi_device_path;
  34 static void *image_addr;
  35 static size_t image_size;
  36
  37 /**
  38  * efi_get_image_parameters() - return image parameters
  39  *
  40  * @img_addr:           address of loaded image in memory
  41  * @img_size:           size of loaded image
  42  */
  43 void efi_get_image_parameters(void **img_addr, size_t *img_size)
  44 {
  45         *img_addr = image_addr;
  46         *img_size = image_size;
  47 }
  48
  49 /**
  50  * efi_clear_bootdev() - clear boot device
  51  */
  52 static void efi_clear_bootdev(void)
  53 {
  54         efi_free_pool(bootefi_device_path);
  55         efi_free_pool(bootefi_image_path);
  56         bootefi_device_path = NULL;
  57         bootefi_image_path = NULL;
  58         image_addr = NULL;
  59         image_size = 0;
  60 }
  61
  62 /**
  63  * efi_set_bootdev() - set boot device
  64  *
  65  * This function is called when a file is loaded, e.g. via the 'load' command.
  66  * We use the path to this file to inform the UEFI binary about the boot device.
  67  *
  68  * @dev:                device, e.g. "MMC"
  69  * @devnr:              number of the device, e.g. "1:2"
  70  * @path:               path to file loaded
  71  * @buffer:             buffer with file loaded
  72  * @buffer_size:        size of file loaded
  73  */
  74 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
  75                      void *buffer, size_t buffer_size)
  76 {
  77         struct efi_device_path *device, *image;
  78         efi_status_t ret;
  79
  80         log_debug("dev=%s, devnr=%s, path=%s, buffer=%p, size=%zx\n", dev,
  81                   devnr, path, buffer, buffer_size);
  82
  83         /* Forget overwritten image */
  84         if (buffer + buffer_size >= image_addr &&
  85             image_addr + image_size >= buffer)
  86                 efi_clear_bootdev();
  87
  88         /* Remember only PE-COFF and FIT images */
  89         if (efi_check_pe(buffer, buffer_size, NULL) != EFI_SUCCESS) {
  90                 if (IS_ENABLED(CONFIG_FIT) &&
  91                     !fit_check_format(buffer, IMAGE_SIZE_INVAL)) {
  92                         /*
  93                          * FIT images of type EFI_OS are started via command
  94                          * bootm. We should not use their boot device with the
  95                          * bootefi command.
  96                          */
  97                         buffer = 0;
  98                         buffer_size = 0;
  99                 } else {
 100                         log_debug("- not remembering image\n");
 101                         return;
 102                 }
 103         }
 104
 105         /* efi_set_bootdev() is typically called repeatedly, recover memory */
 106         efi_clear_bootdev();
 107
 108         image_addr = buffer;
 109         image_size = buffer_size;
 110
 111         ret = efi_dp_from_name(dev, devnr, path, &device, &image);
 112         if (ret == EFI_SUCCESS) {
 113                 bootefi_device_path = device;
 114                 if (image) {
 115                         /* FIXME: image should not contain device */
 116                         struct efi_device_path *image_tmp = image;
 117
 118                         efi_dp_split_file_path(image, &device, &image);
 119                         efi_free_pool(image_tmp);
 120                 }
 121                 bootefi_image_path = image;
 122                 log_debug("- boot device %pD\n", device);
 123                 if (image)
 124                         log_debug("- image %pD\n", image);
 125         } else {
 126                 log_debug("- efi_dp_from_name() failed, err=%lx\n", ret);
 127                 efi_clear_bootdev();
 128         }
 129 }
 130
 131 /**
 132  * efi_env_set_load_options() - set load options from environment variable
 133  *
 134  * @handle:             the image handle
 135  * @env_var:            name of the environment variable
 136  * @load_options:       pointer to load options (output)
 137  * Return:              status code
 138  */
 139 static efi_status_t efi_env_set_load_options(efi_handle_t handle,
 140                                              const char *env_var,
 141                                              u16 **load_options)
 142 {
 143         const char *env = env_get(env_var);
 144         size_t size;
 145         u16 *pos;
 146         efi_status_t ret;
 147
 148         *load_options = NULL;
 149         if (!env)
 150                 return EFI_SUCCESS;
 151         size = sizeof(u16) * (utf8_utf16_strlen(env) + 1);
 152         pos = calloc(size, 1);
 153         if (!pos)
 154                 return EFI_OUT_OF_RESOURCES;
 155         *load_options = pos;
 156         utf8_utf16_strcpy(&pos, env);
 157         ret = efi_set_load_options(handle, size, *load_options);
 158         if (ret != EFI_SUCCESS) {
 159                 free(*load_options);
 160                 *load_options = NULL;
 161         }
 162         return ret;
 163 }
 164
 165 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
 166
 167 /**
 168  * copy_fdt() - Copy the device tree to a new location available to EFI
 169  *
 170  * The FDT is copied to a suitable location within the EFI memory map.
 171  * Additional 12 KiB are added to the space in case the device tree needs to be
 172  * expanded later with fdt_open_into().
 173  *
 174  * @fdtp:       On entry a pointer to the flattened device tree.
 175  *              On exit a pointer to the copy of the flattened device tree.
 176  *              FDT start
 177  * Return:      status code
 178  */
 179 static efi_status_t copy_fdt(void **fdtp)
 180 {
 181         unsigned long fdt_ram_start = -1L, fdt_pages;
 182         efi_status_t ret = 0;
 183         void *fdt, *new_fdt;
 184         u64 new_fdt_addr;
 185         uint fdt_size;
 186         int i;
 187
 188         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 189                 u64 ram_start = gd->bd->bi_dram[i].start;
 190                 u64 ram_size = gd->bd->bi_dram[i].size;
 191
 192                 if (!ram_size)
 193                         continue;
 194
 195                 if (ram_start < fdt_ram_start)
 196                         fdt_ram_start = ram_start;
 197         }
 198
 199         /*
 200          * Give us at least 12 KiB of breathing room in case the device tree
 201          * needs to be expanded later.
 202          */
 203         fdt = *fdtp;
 204         fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
 205         fdt_size = fdt_pages << EFI_PAGE_SHIFT;
 206
 207         /*
 208          * Safe fdt location is at 127 MiB.
 209          * On the sandbox convert from the sandbox address space.
 210          */
 211         new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
 212                                              fdt_size, 0);
 213         ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 214                                  EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
 215                                  &new_fdt_addr);
 216         if (ret != EFI_SUCCESS) {
 217                 /* If we can't put it there, put it somewhere */
 218                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
 219                 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 220                                          EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
 221                                          &new_fdt_addr);
 222                 if (ret != EFI_SUCCESS) {
 223                         log_err("ERROR: Failed to reserve space for FDT\n");
 224                         goto done;
 225                 }
 226         }
 227         new_fdt = (void *)(uintptr_t)new_fdt_addr;
 228         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
 229         fdt_set_totalsize(new_fdt, fdt_size);
 230
 231         *fdtp = (void *)(uintptr_t)new_fdt_addr;
 232 done:
 233         return ret;
 234 }
 235
 236 /**
 237  * get_config_table() - get configuration table
 238  *
 239  * @guid:       GUID of the configuration table
 240  * Return:      pointer to configuration table or NULL
 241  */
 242 static void *get_config_table(const efi_guid_t *guid)
 243 {
 244         size_t i;
 245
 246         for (i = 0; i < systab.nr_tables; i++) {
 247                 if (!guidcmp(guid, &systab.tables[i].guid))
 248                         return systab.tables[i].table;
 249         }
 250         return NULL;
 251 }
 252
 253 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
 254
 255 /**
 256  * efi_install_fdt() - install device tree
 257  *
 258  * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
 259  * address will will be installed as configuration table, otherwise the device
 260  * tree located at the address indicated by environment variable fdt_addr or as
 261  * fallback fdtcontroladdr will be used.
 262  *
 263  * On architectures using ACPI tables device trees shall not be installed as
 264  * configuration table.
 265  *
 266  * @fdt:        address of device tree or EFI_FDT_USE_INTERNAL to use the
 267  *              the hardware device tree as indicated by environment variable
 268  *              fdt_addr or as fallback the internal device tree as indicated by
 269  *              the environment variable fdtcontroladdr
 270  * Return:      status code
 271  */
 272 efi_status_t efi_install_fdt(void *fdt)
 273 {
 274         /*
 275          * The EBBR spec requires that we have either an FDT or an ACPI table
 276          * but not both.
 277          */
 278 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
 279         if (fdt) {
 280                 log_warning("WARNING: Can't have ACPI table and device tree - ignoring DT.\n");
 281                 return EFI_SUCCESS;
 282         }
 283 #else
 284         struct bootm_headers img = { 0 };
 285         efi_status_t ret;
 286
 287         if (fdt == EFI_FDT_USE_INTERNAL) {
 288                 const char *fdt_opt;
 289                 uintptr_t fdt_addr;
 290
 291                 /* Look for device tree that is already installed */
 292                 if (get_config_table(&efi_guid_fdt))
 293                         return EFI_SUCCESS;
 294                 /* Check if there is a hardware device tree */
 295                 fdt_opt = env_get("fdt_addr");
 296                 /* Use our own device tree as fallback */
 297                 if (!fdt_opt) {
 298                         fdt_opt = env_get("fdtcontroladdr");
 299                         if (!fdt_opt) {
 300                                 log_err("ERROR: need device tree\n");
 301                                 return EFI_NOT_FOUND;
 302                         }
 303                 }
 304                 fdt_addr = hextoul(fdt_opt, NULL);
 305                 if (!fdt_addr) {
 306                         log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
 307                         return EFI_LOAD_ERROR;
 308                 }
 309                 fdt = map_sysmem(fdt_addr, 0);
 310         }
 311
 312         /* Install device tree */
 313         if (fdt_check_header(fdt)) {
 314                 log_err("ERROR: invalid device tree\n");
 315                 return EFI_LOAD_ERROR;
 316         }
 317
 318         /* Prepare device tree for payload */
 319         ret = copy_fdt(&fdt);
 320         if (ret) {
 321                 log_err("ERROR: out of memory\n");
 322                 return EFI_OUT_OF_RESOURCES;
 323         }
 324
 325         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 326                 log_err("ERROR: failed to process device tree\n");
 327                 return EFI_LOAD_ERROR;
 328         }
 329
 330         /* Create memory reservations as indicated by the device tree */
 331         efi_carve_out_dt_rsv(fdt);
 332
 333         efi_try_purge_kaslr_seed(fdt);
 334
 335         if (CONFIG_IS_ENABLED(EFI_TCG2_PROTOCOL_MEASURE_DTB)) {
 336                 ret = efi_tcg2_measure_dtb(fdt);
 337                 if (ret == EFI_SECURITY_VIOLATION) {
 338                         log_err("ERROR: failed to measure DTB\n");
 339                         return ret;
 340                 }
 341         }
 342
 343         /* Install device tree as UEFI table */
 344         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
 345         if (ret != EFI_SUCCESS) {
 346                 log_err("ERROR: failed to install device tree\n");
 347                 return ret;
 348         }
 349 #endif /* GENERATE_ACPI_TABLE */
 350
 351         return EFI_SUCCESS;
 352 }
 353
 354 /**
 355  * do_bootefi_exec() - execute EFI binary
 356  *
 357  * The image indicated by @handle is started. When it returns the allocated
 358  * memory for the @load_options is freed.
 359  *
 360  * @handle:             handle of loaded image
 361  * @load_options:       load options
 362  * Return:              status code
 363  *
 364  * Load the EFI binary into a newly assigned memory unwinding the relocation
 365  * information, install the loaded image protocol, and call the binary.
 366  */
 367 static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
 368 {
 369         efi_status_t ret;
 370         efi_uintn_t exit_data_size = 0;
 371         u16 *exit_data = NULL;
 372
 373         /* On ARM switch from EL3 or secure mode to EL2 or non-secure mode */
 374         switch_to_non_secure_mode();
 375
 376         /*
 377          * The UEFI standard requires that the watchdog timer is set to five
 378          * minutes when invoking an EFI boot option.
 379          *
 380          * Unified Extensible Firmware Interface (UEFI), version 2.7 Errata A
 381          * 7.5. Miscellaneous Boot Services - EFI_BOOT_SERVICES.SetWatchdogTimer
 382          */
 383         ret = efi_set_watchdog(300);
 384         if (ret != EFI_SUCCESS) {
 385                 log_err("ERROR: Failed to set watchdog timer\n");
 386                 goto out;
 387         }
 388
 389         /* Call our payload! */
 390         ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
 391         if (ret != EFI_SUCCESS) {
 392                 log_err("## Application failed, r = %lu\n",
 393                         ret & ~EFI_ERROR_MASK);
 394                 if (exit_data) {
 395                         log_err("## %ls\n", exit_data);
 396                         efi_free_pool(exit_data);
 397                 }
 398         }
 399
 400         efi_restore_gd();
 401
 402 out:
 403         free(load_options);
 404
 405         if (IS_ENABLED(CONFIG_EFI_LOAD_FILE2_INITRD)) {
 406                 if (efi_initrd_deregister() != EFI_SUCCESS)
 407                         log_err("Failed to remove loadfile2 for initrd\n");
 408         }
 409
 410         /* Control is returned to U-Boot, disable EFI watchdog */
 411         efi_set_watchdog(0);
 412
 413         return ret;
 414 }
 415
 416 /**
 417  * do_efibootmgr() - execute EFI boot manager
 418  *
 419  * Return:      status code
 420  */
 421 static int do_efibootmgr(void)
 422 {
 423         efi_handle_t handle;
 424         efi_status_t ret;
 425         void *load_options;
 426
 427         ret = efi_bootmgr_load(&handle, &load_options);
 428         if (ret != EFI_SUCCESS) {
 429                 log_notice("EFI boot manager: Cannot load any image\n");
 430                 return CMD_RET_FAILURE;
 431         }
 432
 433         ret = do_bootefi_exec(handle, load_options);
 434
 435         if (ret != EFI_SUCCESS)
 436                 return CMD_RET_FAILURE;
 437
 438         return CMD_RET_SUCCESS;
 439 }
 440
 441 /**
 442  * do_bootefi_image() - execute EFI binary
 443  *
 444  * Set up memory image for the binary to be loaded, prepare device path, and
 445  * then call do_bootefi_exec() to execute it.
 446  *
 447  * @image_opt:  string with image start address
 448  * @size_opt:   string with image size or NULL
 449  * Return:      status code
 450  */
 451 static int do_bootefi_image(const char *image_opt, const char *size_opt)
 452 {
 453         void *image_buf;
 454         unsigned long addr, size;
 455         efi_status_t ret;
 456
 457 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 458         if (!strcmp(image_opt, "hello")) {
 459                 image_buf = __efi_helloworld_begin;
 460                 size = __efi_helloworld_end - __efi_helloworld_begin;
 461                 efi_clear_bootdev();
 462         } else
 463 #endif
 464         {
 465                 addr = strtoul(image_opt, NULL, 16);
 466                 /* Check that a numeric value was passed */
 467                 if (!addr)
 468                         return CMD_RET_USAGE;
 469                 image_buf = map_sysmem(addr, 0);
 470
 471                 if (size_opt) {
 472                         size = strtoul(size_opt, NULL, 16);
 473                         if (!size)
 474                                 return CMD_RET_USAGE;
 475                         efi_clear_bootdev();
 476                 } else {
 477                         if (image_buf != image_addr) {
 478                                 log_err("No UEFI binary known at %s\n",
 479                                         image_opt);
 480                                 return CMD_RET_FAILURE;
 481                         }
 482                         size = image_size;
 483                 }
 484         }
 485         ret = efi_run_image(image_buf, size);
 486
 487         if (ret != EFI_SUCCESS)
 488                 return CMD_RET_FAILURE;
 489
 490         return CMD_RET_SUCCESS;
 491 }
 492
 493 /**
 494  * efi_run_image() - run loaded UEFI image
 495  *
 496  * @source_buffer:      memory address of the UEFI image
 497  * @source_size:        size of the UEFI image
 498  * Return:              status code
 499  */
 500 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
 501 {
 502         efi_handle_t mem_handle = NULL, handle;
 503         struct efi_device_path *file_path = NULL;
 504         struct efi_device_path *msg_path;
 505         efi_status_t ret, ret2;
 506         u16 *load_options;
 507
 508         if (!bootefi_device_path || !bootefi_image_path) {
 509                 log_debug("Not loaded from disk\n");
 510                 /*
 511                  * Special case for efi payload not loaded from disk,
 512                  * such as 'bootefi hello' or for example payload
 513                  * loaded directly into memory via JTAG, etc:
 514                  */
 515                 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
 516                                             (uintptr_t)source_buffer,
 517                                             source_size);
 518                 /*
 519                  * Make sure that device for device_path exist
 520                  * in load_image(). Otherwise, shell and grub will fail.
 521                  */
 522                 ret = efi_install_multiple_protocol_interfaces(&mem_handle,
 523                                                                &efi_guid_device_path,
 524                                                                file_path, NULL);
 525                 if (ret != EFI_SUCCESS)
 526                         goto out;
 527                 msg_path = file_path;
 528         } else {
 529                 file_path = efi_dp_append(bootefi_device_path,
 530                                           bootefi_image_path);
 531                 msg_path = bootefi_image_path;
 532                 log_debug("Loaded from disk\n");
 533         }
 534
 535         log_info("Booting %pD\n", msg_path);
 536
 537         ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
 538                                       source_size, &handle));
 539         if (ret != EFI_SUCCESS) {
 540                 log_err("Loading image failed\n");
 541                 goto out;
 542         }
 543
 544         /* Transfer environment variable as load options */
 545         ret = efi_env_set_load_options(handle, "bootargs", &load_options);
 546         if (ret != EFI_SUCCESS)
 547                 goto out;
 548
 549         ret = do_bootefi_exec(handle, load_options);
 550
 551 out:
 552         ret2 = efi_uninstall_multiple_protocol_interfaces(mem_handle,
 553                                                           &efi_guid_device_path,
 554                                                           file_path, NULL);
 555         efi_free_pool(file_path);
 556         return (ret != EFI_SUCCESS) ? ret : ret2;
 557 }
 558
 559 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 560 static efi_status_t bootefi_run_prepare(const char *load_options_path,
 561                 struct efi_device_path *device_path,
 562                 struct efi_device_path *image_path,
 563                 struct efi_loaded_image_obj **image_objp,
 564                 struct efi_loaded_image **loaded_image_infop)
 565 {
 566         efi_status_t ret;
 567         u16 *load_options;
 568
 569         ret = efi_setup_loaded_image(device_path, image_path, image_objp,
 570                                      loaded_image_infop);
 571         if (ret != EFI_SUCCESS)
 572                 return ret;
 573
 574         /* Transfer environment variable as load options */
 575         return efi_env_set_load_options((efi_handle_t)*image_objp,
 576                                         load_options_path,
 577                                         &load_options);
 578 }
 579
 580 /**
 581  * bootefi_test_prepare() - prepare to run an EFI test
 582  *
 583  * Prepare to run a test as if it were provided by a loaded image.
 584  *
 585  * @image_objp:         pointer to be set to the loaded image handle
 586  * @loaded_image_infop: pointer to be set to the loaded image protocol
 587  * @path:               dummy file path used to construct the device path
 588  *                      set in the loaded image protocol
 589  * @load_options_path:  name of a U-Boot environment variable. Its value is
 590  *                      set as load options in the loaded image protocol.
 591  * Return:              status code
 592  */
 593 static efi_status_t bootefi_test_prepare
 594                 (struct efi_loaded_image_obj **image_objp,
 595                  struct efi_loaded_image **loaded_image_infop, const char *path,
 596                  const char *load_options_path)
 597 {
 598         efi_status_t ret;
 599
 600         /* Construct a dummy device path */
 601         bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
 602         if (!bootefi_device_path)
 603                 return EFI_OUT_OF_RESOURCES;
 604
 605         bootefi_image_path = efi_dp_from_file(NULL, 0, path);
 606         if (!bootefi_image_path) {
 607                 ret = EFI_OUT_OF_RESOURCES;
 608                 goto failure;
 609         }
 610
 611         ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
 612                                   bootefi_image_path, image_objp,
 613                                   loaded_image_infop);
 614         if (ret == EFI_SUCCESS)
 615                 return ret;
 616
 617 failure:
 618         efi_clear_bootdev();
 619         return ret;
 620 }
 621
 622 /**
 623  * bootefi_run_finish() - finish up after running an EFI test
 624  *
 625  * @loaded_image_info: Pointer to a struct which holds the loaded image info
 626  * @image_obj: Pointer to a struct which holds the loaded image object
 627  */
 628 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
 629                                struct efi_loaded_image *loaded_image_info)
 630 {
 631         efi_restore_gd();
 632         free(loaded_image_info->load_options);
 633         efi_delete_handle(&image_obj->header);
 634 }
 635
 636 /**
 637  * do_efi_selftest() - execute EFI selftest
 638  *
 639  * Return:      status code
 640  */
 641 static int do_efi_selftest(void)
 642 {
 643         struct efi_loaded_image_obj *image_obj;
 644         struct efi_loaded_image *loaded_image_info;
 645         efi_status_t ret;
 646
 647         ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
 648                                    "\\selftest", "efi_selftest");
 649         if (ret != EFI_SUCCESS)
 650                 return CMD_RET_FAILURE;
 651
 652         /* Execute the test */
 653         ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
 654         bootefi_run_finish(image_obj, loaded_image_info);
 655
 656         return ret != EFI_SUCCESS;
 657 }
 658 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
 659
 660 /**
 661  * do_bootefi() - execute `bootefi` command
 662  *
 663  * @cmdtp:      table entry describing command
 664  * @flag:       bitmap indicating how the command was invoked
 665  * @argc:       number of arguments
 666  * @argv:       command line arguments
 667  * Return:      status code
 668  */
 669 static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
 670                       char *const argv[])
 671 {
 672         efi_status_t ret;
 673         char *img_addr, *img_size, *str_copy, *pos;
 674         void *fdt;
 675
 676         if (argc < 2)
 677                 return CMD_RET_USAGE;
 678
 679         /* Initialize EFI drivers */
 680         ret = efi_init_obj_list();
 681         if (ret != EFI_SUCCESS) {
 682                 log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
 683                         ret & ~EFI_ERROR_MASK);
 684                 return CMD_RET_FAILURE;
 685         }
 686
 687         if (argc > 2) {
 688                 uintptr_t fdt_addr;
 689
 690                 fdt_addr = hextoul(argv[2], NULL);
 691                 fdt = map_sysmem(fdt_addr, 0);
 692         } else {
 693                 fdt = EFI_FDT_USE_INTERNAL;
 694         }
 695         ret = efi_install_fdt(fdt);
 696         if (ret == EFI_INVALID_PARAMETER)
 697                 return CMD_RET_USAGE;
 698         else if (ret != EFI_SUCCESS)
 699                 return CMD_RET_FAILURE;
 700
 701         if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) {
 702                 if (!strcmp(argv[1], "bootmgr"))
 703                         return do_efibootmgr();
 704         }
 705 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 706         if (!strcmp(argv[1], "selftest"))
 707                 return do_efi_selftest();
 708 #endif
 709         str_copy = strdup(argv[1]);
 710         if (!str_copy) {
 711                 log_err("Out of memory\n");
 712                 return CMD_RET_FAILURE;
 713         }
 714         pos = str_copy;
 715         img_addr = strsep(&pos, ":");
 716         img_size = strsep(&pos, ":");
 717         ret = do_bootefi_image(img_addr, img_size);
 718         free(str_copy);
 719
 720         return ret;
 721 }
 722
 723 #ifdef CONFIG_SYS_LONGHELP
 724 static char bootefi_help_text[] =
 725         "<image address>[:<image size>] [<fdt address>]\n"
 726         "  - boot EFI payload\n"
 727 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 728         "bootefi hello\n"
 729         "  - boot a sample Hello World application stored within U-Boot\n"
 730 #endif
 731 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 732         "bootefi selftest [fdt address]\n"
 733         "  - boot an EFI selftest application stored within U-Boot\n"
 734         "    Use environment variable efi_selftest to select a single test.\n"
 735         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 736 #endif
 737 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
 738         "bootefi bootmgr [fdt address]\n"
 739         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
 740         "\n"
 741         "    If specified, the device tree located at <fdt address> gets\n"
 742         "    exposed as EFI configuration table.\n"
 743 #endif
 744         ;
 745 #endif
 746
 747 U_BOOT_CMD(
 748         bootefi, 4, 0, do_bootefi,
 749         "Boots an EFI payload from memory",
 750         bootefi_help_text
 751 );