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 #include <charset.h>
   9 #include <common.h>
  10 #include <command.h>
  11 #include <dm.h>
  12 #include <efi_loader.h>
  13 #include <efi_selftest.h>
  14 #include <errno.h>
  15 #include <linux/libfdt.h>
  16 #include <linux/libfdt_env.h>
  17 #include <mapmem.h>
  18 #include <memalign.h>
  19 #include <asm/global_data.h>
  20 #include <asm-generic/sections.h>
  21 #include <asm-generic/unaligned.h>
  22 #include <linux/linkage.h>
  23
  24 #ifdef CONFIG_ARMV7_NONSEC
  25 #include <asm/armv7.h>
  26 #include <asm/secure.h>
  27 #endif
  28
  29 DECLARE_GLOBAL_DATA_PTR;
  30
  31 #define OBJ_LIST_NOT_INITIALIZED 1
  32
  33 static efi_status_t efi_obj_list_initialized = OBJ_LIST_NOT_INITIALIZED;
  34
  35 static struct efi_device_path *bootefi_image_path;
  36 static struct efi_device_path *bootefi_device_path;
  37
  38 /* Initialize and populate EFI object list */
  39 efi_status_t efi_init_obj_list(void)
  40 {
  41         efi_status_t ret = EFI_SUCCESS;
  42
  43         /* Initialize once only */
  44         if (efi_obj_list_initialized != OBJ_LIST_NOT_INITIALIZED)
  45                 return efi_obj_list_initialized;
  46
  47         /* Initialize system table */
  48         ret = efi_initialize_system_table();
  49         if (ret != EFI_SUCCESS)
  50                 goto out;
  51
  52         /* Initialize EFI driver uclass */
  53         ret = efi_driver_init();
  54         if (ret != EFI_SUCCESS)
  55                 goto out;
  56
  57         ret = efi_console_register();
  58         if (ret != EFI_SUCCESS)
  59                 goto out;
  60 #ifdef CONFIG_PARTITIONS
  61         ret = efi_disk_register();
  62         if (ret != EFI_SUCCESS)
  63                 goto out;
  64 #endif
  65 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
  66         ret = efi_gop_register();
  67         if (ret != EFI_SUCCESS)
  68                 goto out;
  69 #endif
  70 #ifdef CONFIG_NET
  71         ret = efi_net_register();
  72         if (ret != EFI_SUCCESS)
  73                 goto out;
  74 #endif
  75 #ifdef CONFIG_GENERATE_ACPI_TABLE
  76         ret = efi_acpi_register();
  77         if (ret != EFI_SUCCESS)
  78                 goto out;
  79 #endif
  80 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
  81         ret = efi_smbios_register();
  82         if (ret != EFI_SUCCESS)
  83                 goto out;
  84 #endif
  85         ret = efi_watchdog_register();
  86         if (ret != EFI_SUCCESS)
  87                 goto out;
  88
  89         /* Initialize EFI runtime services */
  90         ret = efi_reset_system_init();
  91         if (ret != EFI_SUCCESS)
  92                 goto out;
  93
  94 out:
  95         efi_obj_list_initialized = ret;
  96         return ret;
  97 }
  98
  99 /*
 100  * Allow unaligned memory access.
 101  *
 102  * This routine is overridden by architectures providing this feature.
 103  */
 104 void __weak allow_unaligned(void)
 105 {
 106 }
 107
 108 /*
 109  * Set the load options of an image from an environment variable.
 110  *
 111  * @loaded_image_info:  the image
 112  * @env_var:            name of the environment variable
 113  */
 114 static void set_load_options(struct efi_loaded_image *loaded_image_info,
 115                              const char *env_var)
 116 {
 117         size_t size;
 118         const char *env = env_get(env_var);
 119         u16 *pos;
 120
 121         loaded_image_info->load_options = NULL;
 122         loaded_image_info->load_options_size = 0;
 123         if (!env)
 124                 return;
 125         size = utf8_utf16_strlen(env) + 1;
 126         loaded_image_info->load_options = calloc(size, sizeof(u16));
 127         if (!loaded_image_info->load_options) {
 128                 printf("ERROR: Out of memory\n");
 129                 return;
 130         }
 131         pos = loaded_image_info->load_options;
 132         utf8_utf16_strcpy(&pos, env);
 133         loaded_image_info->load_options_size = size * 2;
 134 }
 135
 136 /**
 137  * copy_fdt() - Copy the device tree to a new location available to EFI
 138  *
 139  * The FDT is relocated into a suitable location within the EFI memory map.
 140  * An additional 12KB is added to the space in case the device tree needs to be
 141  * expanded later with fdt_open_into().
 142  *
 143  * @fdt_addr: On entry, address of start of FDT. On exit, address of relocated
 144  *      FDT start
 145  * @fdt_sizep: Returns new size of FDT, including
 146  * @return new relocated address of FDT
 147  */
 148 static efi_status_t copy_fdt(ulong *fdt_addrp, ulong *fdt_sizep)
 149 {
 150         unsigned long fdt_ram_start = -1L, fdt_pages;
 151         efi_status_t ret = 0;
 152         void *fdt, *new_fdt;
 153         u64 new_fdt_addr;
 154         uint fdt_size;
 155         int i;
 156
 157         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 158                 u64 ram_start = gd->bd->bi_dram[i].start;
 159                 u64 ram_size = gd->bd->bi_dram[i].size;
 160
 161                 if (!ram_size)
 162                         continue;
 163
 164                 if (ram_start < fdt_ram_start)
 165                         fdt_ram_start = ram_start;
 166         }
 167
 168         /*
 169          * Give us at least 4KB of breathing room in case the device tree needs
 170          * to be expanded later. Round up to the nearest EFI page boundary.
 171          */
 172         fdt = map_sysmem(*fdt_addrp, 0);
 173         fdt_size = fdt_totalsize(fdt);
 174         fdt_size += 4096 * 3;
 175         fdt_size = ALIGN(fdt_size + EFI_PAGE_SIZE - 1, EFI_PAGE_SIZE);
 176         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 177
 178         /* Safe fdt location is at 127MB */
 179         new_fdt_addr = fdt_ram_start + (127 * 1024 * 1024) + fdt_size;
 180         ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 181                                  EFI_RUNTIME_SERVICES_DATA, fdt_pages,
 182                                  &new_fdt_addr);
 183         if (ret != EFI_SUCCESS) {
 184                 /* If we can't put it there, put it somewhere */
 185                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
 186                 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 187                                          EFI_RUNTIME_SERVICES_DATA, fdt_pages,
 188                                          &new_fdt_addr);
 189                 if (ret != EFI_SUCCESS) {
 190                         printf("ERROR: Failed to reserve space for FDT\n");
 191                         goto done;
 192                 }
 193         }
 194
 195         new_fdt = map_sysmem(new_fdt_addr, fdt_size);
 196         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
 197         fdt_set_totalsize(new_fdt, fdt_size);
 198
 199         *fdt_addrp = new_fdt_addr;
 200         *fdt_sizep = fdt_size;
 201 done:
 202         return ret;
 203 }
 204
 205 static efi_status_t efi_do_enter(
 206                         efi_handle_t image_handle, struct efi_system_table *st,
 207                         EFIAPI efi_status_t (*entry)(
 208                                 efi_handle_t image_handle,
 209                                 struct efi_system_table *st))
 210 {
 211         efi_status_t ret = EFI_LOAD_ERROR;
 212
 213         if (entry)
 214                 ret = entry(image_handle, st);
 215         st->boottime->exit(image_handle, ret, 0, NULL);
 216         return ret;
 217 }
 218
 219 #ifdef CONFIG_ARM64
 220 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
 221                         efi_handle_t image_handle, struct efi_system_table *st),
 222                         efi_handle_t image_handle, struct efi_system_table *st)
 223 {
 224         /* Enable caches again */
 225         dcache_enable();
 226
 227         return efi_do_enter(image_handle, st, entry);
 228 }
 229 #endif
 230
 231 #ifdef CONFIG_ARMV7_NONSEC
 232 static bool is_nonsec;
 233
 234 static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)(
 235                         efi_handle_t image_handle, struct efi_system_table *st),
 236                         efi_handle_t image_handle, struct efi_system_table *st)
 237 {
 238         /* Enable caches again */
 239         dcache_enable();
 240
 241         is_nonsec = true;
 242
 243         return efi_do_enter(image_handle, st, entry);
 244 }
 245 #endif
 246
 247 /*
 248  * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
 249  *
 250  * The mem_rsv entries of the FDT are added to the memory map. Any failures are
 251  * ignored because this is not critical and we would rather continue to try to
 252  * boot.
 253  *
 254  * @fdt: Pointer to device tree
 255  */
 256 static void efi_carve_out_dt_rsv(void *fdt)
 257 {
 258         int nr_rsv, i;
 259         uint64_t addr, size, pages;
 260
 261         nr_rsv = fdt_num_mem_rsv(fdt);
 262
 263         /* Look for an existing entry and add it to the efi mem map. */
 264         for (i = 0; i < nr_rsv; i++) {
 265                 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
 266                         continue;
 267
 268                 pages = ALIGN(size, EFI_PAGE_SIZE) >> EFI_PAGE_SHIFT;
 269                 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
 270                                         false))
 271                         printf("FDT memrsv map %d: Failed to add to map\n", i);
 272         }
 273 }
 274
 275 static efi_status_t efi_install_fdt(ulong fdt_addr)
 276 {
 277         bootm_headers_t img = { 0 };
 278         ulong fdt_pages, fdt_size, fdt_start;
 279         efi_status_t ret;
 280         void *fdt;
 281
 282         fdt = map_sysmem(fdt_addr, 0);
 283         if (fdt_check_header(fdt)) {
 284                 printf("ERROR: invalid device tree\n");
 285                 return EFI_INVALID_PARAMETER;
 286         }
 287
 288         /* Prepare fdt for payload */
 289         ret = copy_fdt(&fdt_addr, &fdt_size);
 290         if (ret)
 291                 return ret;
 292
 293         unmap_sysmem(fdt);
 294         fdt = map_sysmem(fdt_addr, 0);
 295         fdt_size = fdt_totalsize(fdt);
 296         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 297                 printf("ERROR: failed to process device tree\n");
 298                 return EFI_LOAD_ERROR;
 299         }
 300
 301         efi_carve_out_dt_rsv(fdt);
 302
 303         /* Link to it in the efi tables */
 304         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
 305         if (ret != EFI_SUCCESS)
 306                 return EFI_OUT_OF_RESOURCES;
 307
 308         /* And reserve the space in the memory map */
 309         fdt_start = fdt_addr;
 310         fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
 311
 312         ret = efi_add_memory_map(fdt_start, fdt_pages,
 313                                  EFI_BOOT_SERVICES_DATA, true);
 314
 315         return ret;
 316 }
 317
 318 /*
 319  * Load an EFI payload into a newly allocated piece of memory, register all
 320  * EFI objects it would want to access and jump to it.
 321  */
 322 static efi_status_t do_bootefi_exec(void *efi,
 323                                     struct efi_device_path *device_path,
 324                                     struct efi_device_path *image_path)
 325 {
 326         struct efi_loaded_image loaded_image_info = {};
 327         struct efi_object loaded_image_info_obj = {};
 328         struct efi_object mem_obj = {};
 329         struct efi_device_path *memdp = NULL;
 330         efi_status_t ret;
 331
 332         EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
 333                                      struct efi_system_table *st);
 334
 335         /*
 336          * Special case for efi payload not loaded from disk, such as
 337          * 'bootefi hello' or for example payload loaded directly into
 338          * memory via jtag/etc:
 339          */
 340         if (!device_path && !image_path) {
 341                 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
 342                 /* actual addresses filled in after efi_load_pe() */
 343                 memdp = efi_dp_from_mem(0, 0, 0);
 344                 device_path = image_path = memdp;
 345                 efi_add_handle(&mem_obj);
 346
 347                 ret = efi_add_protocol(mem_obj.handle, &efi_guid_device_path,
 348                                        device_path);
 349                 if (ret != EFI_SUCCESS)
 350                         goto exit;
 351         } else {
 352                 assert(device_path && image_path);
 353         }
 354
 355         efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
 356                                device_path, image_path);
 357
 358         /*
 359          * gd lives in a fixed register which may get clobbered while we execute
 360          * the payload. So save it here and restore it on every callback entry
 361          */
 362         efi_save_gd();
 363
 364         /* Transfer environment variable bootargs as load options */
 365         set_load_options(&loaded_image_info, "bootargs");
 366         /* Load the EFI payload */
 367         entry = efi_load_pe(efi, &loaded_image_info);
 368         if (!entry) {
 369                 ret = EFI_LOAD_ERROR;
 370                 goto exit;
 371         }
 372
 373         if (memdp) {
 374                 struct efi_device_path_memory *mdp = (void *)memdp;
 375                 mdp->memory_type = loaded_image_info.image_code_type;
 376                 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
 377                 mdp->end_address = mdp->start_address +
 378                                 loaded_image_info.image_size;
 379         }
 380
 381         /* we don't support much: */
 382         env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
 383                 "{ro,boot}(blob)0000000000000000");
 384
 385         /* Call our payload! */
 386         debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
 387
 388         if (setjmp(&loaded_image_info.exit_jmp)) {
 389                 ret = loaded_image_info.exit_status;
 390                 goto exit;
 391         }
 392
 393 #ifdef CONFIG_ARM64
 394         /* On AArch64 we need to make sure we call our payload in < EL3 */
 395         if (current_el() == 3) {
 396                 smp_kick_all_cpus();
 397                 dcache_disable();       /* flush cache before switch to EL2 */
 398
 399                 /* Move into EL2 and keep running there */
 400                 armv8_switch_to_el2((ulong)entry,
 401                                     (ulong)&loaded_image_info_obj.handle,
 402                                     (ulong)&systab, 0, (ulong)efi_run_in_el2,
 403                                     ES_TO_AARCH64);
 404
 405                 /* Should never reach here, efi exits with longjmp */
 406                 while (1) { }
 407         }
 408 #endif
 409
 410 #ifdef CONFIG_ARMV7_NONSEC
 411         if (armv7_boot_nonsec() && !is_nonsec) {
 412                 dcache_disable();       /* flush cache before switch to HYP */
 413
 414                 armv7_init_nonsec();
 415                 secure_ram_addr(_do_nonsec_entry)(
 416                                         efi_run_in_hyp,
 417                                         (uintptr_t)entry,
 418                                         (uintptr_t)loaded_image_info_obj.handle,
 419                                         (uintptr_t)&systab);
 420
 421                 /* Should never reach here, efi exits with longjmp */
 422                 while (1) { }
 423         }
 424 #endif
 425
 426         ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
 427
 428 exit:
 429         /* image has returned, loaded-image obj goes *poof*: */
 430         list_del(&loaded_image_info_obj.link);
 431         if (mem_obj.handle)
 432                 list_del(&mem_obj.link);
 433
 434         return ret;
 435 }
 436
 437 static int do_bootefi_bootmgr_exec(void)
 438 {
 439         struct efi_device_path *device_path, *file_path;
 440         void *addr;
 441         efi_status_t r;
 442
 443         /*
 444          * gd lives in a fixed register which may get clobbered while we execute
 445          * the payload. So save it here and restore it on every callback entry
 446          */
 447         efi_save_gd();
 448
 449         addr = efi_bootmgr_load(&device_path, &file_path);
 450         if (!addr)
 451                 return 1;
 452
 453         printf("## Starting EFI application at %p ...\n", addr);
 454         r = do_bootefi_exec(addr, device_path, file_path);
 455         printf("## Application terminated, r = %lu\n",
 456                r & ~EFI_ERROR_MASK);
 457
 458         if (r != EFI_SUCCESS)
 459                 return 1;
 460
 461         return 0;
 462 }
 463
 464 /* Interpreter command to boot an arbitrary EFI image from memory */
 465 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 466 {
 467         unsigned long addr;
 468         char *saddr;
 469         efi_status_t r;
 470         unsigned long fdt_addr;
 471
 472         /* Allow unaligned memory access */
 473         allow_unaligned();
 474
 475         /* Initialize EFI drivers */
 476         r = efi_init_obj_list();
 477         if (r != EFI_SUCCESS) {
 478                 printf("Error: Cannot set up EFI drivers, r = %lu\n",
 479                        r & ~EFI_ERROR_MASK);
 480                 return CMD_RET_FAILURE;
 481         }
 482
 483         if (argc < 2)
 484                 return CMD_RET_USAGE;
 485
 486         if (argc > 2) {
 487                 fdt_addr = simple_strtoul(argv[2], NULL, 16);
 488                 if (!fdt_addr && *argv[2] != '0')
 489                         return CMD_RET_USAGE;
 490                 /* Install device tree */
 491                 r = efi_install_fdt(fdt_addr);
 492                 if (r != EFI_SUCCESS) {
 493                         printf("ERROR: failed to install device tree\n");
 494                         return CMD_RET_FAILURE;
 495                 }
 496         } else {
 497                 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
 498                 efi_install_configuration_table(&efi_guid_fdt, NULL);
 499                 printf("WARNING: booting without device tree\n");
 500         }
 501 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 502         if (!strcmp(argv[1], "hello")) {
 503                 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
 504
 505                 saddr = env_get("loadaddr");
 506                 if (saddr)
 507                         addr = simple_strtoul(saddr, NULL, 16);
 508                 else
 509                         addr = CONFIG_SYS_LOAD_ADDR;
 510                 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
 511         } else
 512 #endif
 513 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 514         if (!strcmp(argv[1], "selftest")) {
 515                 struct efi_loaded_image loaded_image_info = {};
 516                 struct efi_object loaded_image_info_obj = {};
 517
 518                 /* Construct a dummy device path. */
 519                 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
 520                                                       (uintptr_t)&efi_selftest,
 521                                                       (uintptr_t)&efi_selftest);
 522                 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
 523
 524                 efi_setup_loaded_image(&loaded_image_info,
 525                                        &loaded_image_info_obj,
 526                                        bootefi_device_path, bootefi_image_path);
 527                 /*
 528                  * gd lives in a fixed register which may get clobbered while we
 529                  * execute the payload. So save it here and restore it on every
 530                  * callback entry
 531                  */
 532                 efi_save_gd();
 533                 /* Transfer environment variable efi_selftest as load options */
 534                 set_load_options(&loaded_image_info, "efi_selftest");
 535                 /* Execute the test */
 536                 r = efi_selftest(loaded_image_info_obj.handle, &systab);
 537                 efi_restore_gd();
 538                 free(loaded_image_info.load_options);
 539                 list_del(&loaded_image_info_obj.link);
 540                 return r != EFI_SUCCESS;
 541         } else
 542 #endif
 543         if (!strcmp(argv[1], "bootmgr")) {
 544                 return do_bootefi_bootmgr_exec();
 545         } else {
 546                 saddr = argv[1];
 547
 548                 addr = simple_strtoul(saddr, NULL, 16);
 549                 /* Check that a numeric value was passed */
 550                 if (!addr && *saddr != '0')
 551                         return CMD_RET_USAGE;
 552
 553         }
 554
 555         printf("## Starting EFI application at %08lx ...\n", addr);
 556         r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
 557                             bootefi_image_path);
 558         printf("## Application terminated, r = %lu\n",
 559                r & ~EFI_ERROR_MASK);
 560
 561         if (r != EFI_SUCCESS)
 562                 return 1;
 563         else
 564                 return 0;
 565 }
 566
 567 #ifdef CONFIG_SYS_LONGHELP
 568 static char bootefi_help_text[] =
 569         "<image address> [fdt address]\n"
 570         "  - boot EFI payload stored at address <image address>.\n"
 571         "    If specified, the device tree located at <fdt address> gets\n"
 572         "    exposed as EFI configuration table.\n"
 573 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 574         "bootefi hello\n"
 575         "  - boot a sample Hello World application stored within U-Boot\n"
 576 #endif
 577 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 578         "bootefi selftest [fdt address]\n"
 579         "  - boot an EFI selftest application stored within U-Boot\n"
 580         "    Use environment variable efi_selftest to select a single test.\n"
 581         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 582 #endif
 583         "bootefi bootmgr [fdt addr]\n"
 584         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
 585         "\n"
 586         "    If specified, the device tree located at <fdt address> gets\n"
 587         "    exposed as EFI configuration table.\n";
 588 #endif
 589
 590 U_BOOT_CMD(
 591         bootefi, 3, 0, do_bootefi,
 592         "Boots an EFI payload from memory",
 593         bootefi_help_text
 594 );
 595
 596 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 597 {
 598         char filename[32] = { 0 }; /* dp->str is u16[32] long */
 599         char *s;
 600
 601         if (strcmp(dev, "Net")) {
 602                 struct blk_desc *desc;
 603                 disk_partition_t fs_partition;
 604                 int part;
 605
 606                 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
 607                                                1);
 608                 if (part < 0)
 609                         return;
 610
 611                 bootefi_device_path = efi_dp_from_part(desc, part);
 612         } else {
 613 #ifdef CONFIG_NET
 614                 bootefi_device_path = efi_dp_from_eth();
 615 #endif
 616         }
 617
 618         if (!path)
 619                 return;
 620
 621         if (strcmp(dev, "Net")) {
 622                 /* Add leading / to fs paths, because they're absolute */
 623                 snprintf(filename, sizeof(filename), "/%s", path);
 624         } else {
 625                 snprintf(filename, sizeof(filename), "%s", path);
 626         }
 627         /* DOS style file path: */
 628         s = filename;
 629         while ((s = strchr(s, '/')))
 630                 *s++ = '\\';
 631         bootefi_image_path = efi_dp_from_file(NULL, 0, filename);
 632 }