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