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