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