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