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