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