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