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 <common.h>
   9 #include <charset.h>
  10 #include <command.h>
  11 #include <dm.h>
  12 #include <efi_loader.h>
  13 #include <efi_selftest.h>
  14 #include <env.h>
  15 #include <errno.h>
  16 #include <linux/libfdt.h>
  17 #include <linux/libfdt_env.h>
  18 #include <mapmem.h>
  19 #include <memalign.h>
  20 #include <asm-generic/sections.h>
  21 #include <linux/linkage.h>
  22
  23 DECLARE_GLOBAL_DATA_PTR;
  24
  25 static struct efi_device_path *bootefi_image_path;
  26 static struct efi_device_path *bootefi_device_path;
  27
  28 /**
  29  * Set the load options of an image from an environment variable.
  30  *
  31  * @handle:     the image handle
  32  * @env_var:    name of the environment variable
  33  * Return:      status code
  34  */
  35 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
  36 {
  37         struct efi_loaded_image *loaded_image_info;
  38         size_t size;
  39         const char *env = env_get(env_var);
  40         u16 *pos;
  41         efi_status_t ret;
  42
  43         ret = EFI_CALL(systab.boottime->open_protocol(
  44                                         handle,
  45                                         &efi_guid_loaded_image,
  46                                         (void **)&loaded_image_info,
  47                                         efi_root, NULL,
  48                                         EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
  49         if (ret != EFI_SUCCESS)
  50                 return EFI_INVALID_PARAMETER;
  51
  52         loaded_image_info->load_options = NULL;
  53         loaded_image_info->load_options_size = 0;
  54         if (!env)
  55                 goto out;
  56
  57         size = utf8_utf16_strlen(env) + 1;
  58         loaded_image_info->load_options = calloc(size, sizeof(u16));
  59         if (!loaded_image_info->load_options) {
  60                 printf("ERROR: Out of memory\n");
  61                 EFI_CALL(systab.boottime->close_protocol(handle,
  62                                                          &efi_guid_loaded_image,
  63                                                          efi_root, NULL));
  64                 return EFI_OUT_OF_RESOURCES;
  65         }
  66         pos = loaded_image_info->load_options;
  67         utf8_utf16_strcpy(&pos, env);
  68         loaded_image_info->load_options_size = size * 2;
  69
  70 out:
  71         return EFI_CALL(systab.boottime->close_protocol(handle,
  72                                                         &efi_guid_loaded_image,
  73                                                         efi_root, NULL));
  74 }
  75
  76 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
  77
  78 /**
  79  * copy_fdt() - Copy the device tree to a new location available to EFI
  80  *
  81  * The FDT is copied to a suitable location within the EFI memory map.
  82  * Additional 12 KiB are added to the space in case the device tree needs to be
  83  * expanded later with fdt_open_into().
  84  *
  85  * @fdtp:       On entry a pointer to the flattened device tree.
  86  *              On exit a pointer to the copy of the flattened device tree.
  87  *              FDT start
  88  * Return:      status code
  89  */
  90 static efi_status_t copy_fdt(void **fdtp)
  91 {
  92         unsigned long fdt_ram_start = -1L, fdt_pages;
  93         efi_status_t ret = 0;
  94         void *fdt, *new_fdt;
  95         u64 new_fdt_addr;
  96         uint fdt_size;
  97         int i;
  98
  99         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 100                 u64 ram_start = gd->bd->bi_dram[i].start;
 101                 u64 ram_size = gd->bd->bi_dram[i].size;
 102
 103                 if (!ram_size)
 104                         continue;
 105
 106                 if (ram_start < fdt_ram_start)
 107                         fdt_ram_start = ram_start;
 108         }
 109
 110         /*
 111          * Give us at least 12 KiB of breathing room in case the device tree
 112          * needs to be expanded later.
 113          */
 114         fdt = *fdtp;
 115         fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
 116         fdt_size = fdt_pages << EFI_PAGE_SHIFT;
 117
 118         /*
 119          * Safe fdt location is at 127 MiB.
 120          * On the sandbox convert from the sandbox address space.
 121          */
 122         new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
 123                                              fdt_size, 0);
 124         ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 125                                  EFI_BOOT_SERVICES_DATA, fdt_pages,
 126                                  &new_fdt_addr);
 127         if (ret != EFI_SUCCESS) {
 128                 /* If we can't put it there, put it somewhere */
 129                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
 130                 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 131                                          EFI_BOOT_SERVICES_DATA, fdt_pages,
 132                                          &new_fdt_addr);
 133                 if (ret != EFI_SUCCESS) {
 134                         printf("ERROR: Failed to reserve space for FDT\n");
 135                         goto done;
 136                 }
 137         }
 138         new_fdt = (void *)(uintptr_t)new_fdt_addr;
 139         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
 140         fdt_set_totalsize(new_fdt, fdt_size);
 141
 142         *fdtp = (void *)(uintptr_t)new_fdt_addr;
 143 done:
 144         return ret;
 145 }
 146
 147 /**
 148  * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
 149  *
 150  * The mem_rsv entries of the FDT are added to the memory map. Any failures are
 151  * ignored because this is not critical and we would rather continue to try to
 152  * boot.
 153  *
 154  * @fdt: Pointer to device tree
 155  */
 156 static void efi_carve_out_dt_rsv(void *fdt)
 157 {
 158         int nr_rsv, i;
 159         uint64_t addr, size, pages;
 160
 161         nr_rsv = fdt_num_mem_rsv(fdt);
 162
 163         /* Look for an existing entry and add it to the efi mem map. */
 164         for (i = 0; i < nr_rsv; i++) {
 165                 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
 166                         continue;
 167
 168                 /* Convert from sandbox address space. */
 169                 addr = (uintptr_t)map_sysmem(addr, 0);
 170
 171                 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
 172                 addr &= ~EFI_PAGE_MASK;
 173                 if (efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
 174                                        false) != EFI_SUCCESS)
 175                         printf("FDT memrsv map %d: Failed to add to map\n", i);
 176         }
 177 }
 178
 179 /**
 180  * get_config_table() - get configuration table
 181  *
 182  * @guid:       GUID of the configuration table
 183  * Return:      pointer to configuration table or NULL
 184  */
 185 static void *get_config_table(const efi_guid_t *guid)
 186 {
 187         size_t i;
 188
 189         for (i = 0; i < systab.nr_tables; i++) {
 190                 if (!guidcmp(guid, &systab.tables[i].guid))
 191                         return systab.tables[i].table;
 192         }
 193         return NULL;
 194 }
 195
 196 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
 197
 198 /**
 199  * efi_install_fdt() - install fdt passed by a command argument
 200  *
 201  * If fdt_opt is available, the device tree located at that memory address will
 202  * will be installed as configuration table, otherwise the device tree located
 203  * at the address indicated by environment variable fdtcontroladdr will be used.
 204  *
 205  * On architectures (x86) using ACPI tables device trees shall not be installed
 206  * as configuration table.
 207  *
 208  * @fdt_opt:    pointer to argument
 209  * Return:      status code
 210  */
 211 static efi_status_t efi_install_fdt(const char *fdt_opt)
 212 {
 213         /*
 214          * The EBBR spec requires that we have either an FDT or an ACPI table
 215          * but not both.
 216          */
 217 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
 218         if (fdt_opt) {
 219                 printf("ERROR: can't have ACPI table and device tree.\n");
 220                 return EFI_LOAD_ERROR;
 221         }
 222 #else
 223         unsigned long fdt_addr;
 224         void *fdt;
 225         bootm_headers_t img = { 0 };
 226         efi_status_t ret;
 227
 228         if (fdt_opt) {
 229                 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
 230                 if (!fdt_addr)
 231                         return EFI_INVALID_PARAMETER;
 232         } else {
 233                 /* Look for device tree that is already installed */
 234                 if (get_config_table(&efi_guid_fdt))
 235                         return EFI_SUCCESS;
 236                 /* Use our own device tree as default */
 237                 fdt_opt = env_get("fdtcontroladdr");
 238                 if (!fdt_opt) {
 239                         printf("ERROR: need device tree\n");
 240                         return EFI_NOT_FOUND;
 241                 }
 242                 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
 243                 if (!fdt_addr) {
 244                         printf("ERROR: invalid $fdtcontroladdr\n");
 245                         return EFI_LOAD_ERROR;
 246                 }
 247         }
 248
 249         /* Install device tree */
 250         fdt = map_sysmem(fdt_addr, 0);
 251         if (fdt_check_header(fdt)) {
 252                 printf("ERROR: invalid device tree\n");
 253                 return EFI_LOAD_ERROR;
 254         }
 255
 256         /* Create memory reservations as indicated by the device tree */
 257         efi_carve_out_dt_rsv(fdt);
 258
 259         /* Prepare device tree for payload */
 260         ret = copy_fdt(&fdt);
 261         if (ret) {
 262                 printf("ERROR: out of memory\n");
 263                 return EFI_OUT_OF_RESOURCES;
 264         }
 265
 266         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 267                 printf("ERROR: failed to process device tree\n");
 268                 return EFI_LOAD_ERROR;
 269         }
 270
 271         /* Install device tree as UEFI table */
 272         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
 273         if (ret != EFI_SUCCESS) {
 274                 printf("ERROR: failed to install device tree\n");
 275                 return ret;
 276         }
 277 #endif /* GENERATE_ACPI_TABLE */
 278
 279         return EFI_SUCCESS;
 280 }
 281
 282 /**
 283  * do_bootefi_exec() - execute EFI binary
 284  *
 285  * @handle:             handle of loaded image
 286  * Return:              status code
 287  *
 288  * Load the EFI binary into a newly assigned memory unwinding the relocation
 289  * information, install the loaded image protocol, and call the binary.
 290  */
 291 static efi_status_t do_bootefi_exec(efi_handle_t handle)
 292 {
 293         efi_status_t ret;
 294         efi_uintn_t exit_data_size = 0;
 295         u16 *exit_data = NULL;
 296
 297         /* Transfer environment variable as load options */
 298         ret = set_load_options(handle, "bootargs");
 299         if (ret != EFI_SUCCESS)
 300                 return ret;
 301
 302         /* Call our payload! */
 303         ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
 304         printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
 305         if (ret && exit_data) {
 306                 printf("## %ls\n", exit_data);
 307                 efi_free_pool(exit_data);
 308         }
 309
 310         efi_restore_gd();
 311
 312         /*
 313          * FIXME: Who is responsible for
 314          *      free(loaded_image_info->load_options);
 315          * Once efi_exit() is implemented correctly,
 316          * handle itself doesn't exist here.
 317          */
 318
 319         return ret;
 320 }
 321
 322 /**
 323  * do_efibootmgr() - execute EFI boot manager
 324  *
 325  * Return:      status code
 326  */
 327 static int do_efibootmgr(void)
 328 {
 329         efi_handle_t handle;
 330         efi_status_t ret;
 331
 332         ret = efi_bootmgr_load(&handle);
 333         if (ret != EFI_SUCCESS) {
 334                 printf("EFI boot manager: Cannot load any image\n");
 335                 return CMD_RET_FAILURE;
 336         }
 337
 338         ret = do_bootefi_exec(handle);
 339
 340         if (ret != EFI_SUCCESS)
 341                 return CMD_RET_FAILURE;
 342
 343         return CMD_RET_SUCCESS;
 344 }
 345
 346 /**
 347  * do_bootefi_image() - execute EFI binary
 348  *
 349  * Set up memory image for the binary to be loaded, prepare device path, and
 350  * then call do_bootefi_exec() to execute it.
 351  *
 352  * @image_opt:  string of image start address
 353  * Return:      status code
 354  */
 355 static int do_bootefi_image(const char *image_opt)
 356 {
 357         void *image_buf;
 358         struct efi_device_path *device_path, *image_path;
 359         struct efi_device_path *file_path = NULL;
 360         unsigned long addr, size;
 361         const char *size_str;
 362         efi_handle_t mem_handle = NULL, handle;
 363         efi_status_t ret;
 364
 365 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 366         if (!strcmp(image_opt, "hello")) {
 367                 char *saddr;
 368
 369                 saddr = env_get("loadaddr");
 370                 size = __efi_helloworld_end - __efi_helloworld_begin;
 371
 372                 if (saddr)
 373                         addr = simple_strtoul(saddr, NULL, 16);
 374                 else
 375                         addr = CONFIG_SYS_LOAD_ADDR;
 376
 377                 image_buf = map_sysmem(addr, size);
 378                 memcpy(image_buf, __efi_helloworld_begin, size);
 379
 380                 device_path = NULL;
 381                 image_path = NULL;
 382         } else
 383 #endif
 384         {
 385                 size_str = env_get("filesize");
 386                 if (size_str)
 387                         size = simple_strtoul(size_str, NULL, 16);
 388                 else
 389                         size = 0;
 390
 391                 addr = simple_strtoul(image_opt, NULL, 16);
 392                 /* Check that a numeric value was passed */
 393                 if (!addr && *image_opt != '0')
 394                         return CMD_RET_USAGE;
 395
 396                 image_buf = map_sysmem(addr, size);
 397
 398                 device_path = bootefi_device_path;
 399                 image_path = bootefi_image_path;
 400         }
 401
 402         if (!device_path && !image_path) {
 403                 /*
 404                  * Special case for efi payload not loaded from disk,
 405                  * such as 'bootefi hello' or for example payload
 406                  * loaded directly into memory via JTAG, etc:
 407                  */
 408                 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
 409                                             (uintptr_t)image_buf, size);
 410                 /*
 411                  * Make sure that device for device_path exist
 412                  * in load_image(). Otherwise, shell and grub will fail.
 413                  */
 414                 ret = efi_create_handle(&mem_handle);
 415                 if (ret != EFI_SUCCESS)
 416                         goto out;
 417
 418                 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
 419                                        file_path);
 420                 if (ret != EFI_SUCCESS)
 421                         goto out;
 422         } else {
 423                 assert(device_path && image_path);
 424                 file_path = efi_dp_append(device_path, image_path);
 425         }
 426
 427         ret = EFI_CALL(efi_load_image(false, efi_root,
 428                                       file_path, image_buf, size, &handle));
 429         if (ret != EFI_SUCCESS)
 430                 goto out;
 431
 432         ret = do_bootefi_exec(handle);
 433
 434 out:
 435         if (mem_handle)
 436                 efi_delete_handle(mem_handle);
 437         if (file_path)
 438                 efi_free_pool(file_path);
 439
 440         if (ret != EFI_SUCCESS)
 441                 return CMD_RET_FAILURE;
 442
 443         return CMD_RET_SUCCESS;
 444 }
 445
 446 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 447 static efi_status_t bootefi_run_prepare(const char *load_options_path,
 448                 struct efi_device_path *device_path,
 449                 struct efi_device_path *image_path,
 450                 struct efi_loaded_image_obj **image_objp,
 451                 struct efi_loaded_image **loaded_image_infop)
 452 {
 453         efi_status_t ret;
 454
 455         ret = efi_setup_loaded_image(device_path, image_path, image_objp,
 456                                      loaded_image_infop);
 457         if (ret != EFI_SUCCESS)
 458                 return ret;
 459
 460         /* Transfer environment variable as load options */
 461         return set_load_options((efi_handle_t)*image_objp, load_options_path);
 462 }
 463
 464 /**
 465  * bootefi_test_prepare() - prepare to run an EFI test
 466  *
 467  * Prepare to run a test as if it were provided by a loaded image.
 468  *
 469  * @image_objp:         pointer to be set to the loaded image handle
 470  * @loaded_image_infop: pointer to be set to the loaded image protocol
 471  * @path:               dummy file path used to construct the device path
 472  *                      set in the loaded image protocol
 473  * @load_options_path:  name of a U-Boot environment variable. Its value is
 474  *                      set as load options in the loaded image protocol.
 475  * Return:              status code
 476  */
 477 static efi_status_t bootefi_test_prepare
 478                 (struct efi_loaded_image_obj **image_objp,
 479                  struct efi_loaded_image **loaded_image_infop, const char *path,
 480                  const char *load_options_path)
 481 {
 482         efi_status_t ret;
 483
 484         /* Construct a dummy device path */
 485         bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
 486         if (!bootefi_device_path)
 487                 return EFI_OUT_OF_RESOURCES;
 488
 489         bootefi_image_path = efi_dp_from_file(NULL, 0, path);
 490         if (!bootefi_image_path) {
 491                 ret = EFI_OUT_OF_RESOURCES;
 492                 goto failure;
 493         }
 494
 495         ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
 496                                   bootefi_image_path, image_objp,
 497                                   loaded_image_infop);
 498         if (ret == EFI_SUCCESS)
 499                 return ret;
 500
 501         efi_free_pool(bootefi_image_path);
 502         bootefi_image_path = NULL;
 503 failure:
 504         efi_free_pool(bootefi_device_path);
 505         bootefi_device_path = NULL;
 506         return ret;
 507 }
 508
 509 /**
 510  * bootefi_run_finish() - finish up after running an EFI test
 511  *
 512  * @loaded_image_info: Pointer to a struct which holds the loaded image info
 513  * @image_obj: Pointer to a struct which holds the loaded image object
 514  */
 515 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
 516                                struct efi_loaded_image *loaded_image_info)
 517 {
 518         efi_restore_gd();
 519         free(loaded_image_info->load_options);
 520         efi_delete_handle(&image_obj->header);
 521 }
 522
 523 /**
 524  * do_efi_selftest() - execute EFI selftest
 525  *
 526  * Return:      status code
 527  */
 528 static int do_efi_selftest(void)
 529 {
 530         struct efi_loaded_image_obj *image_obj;
 531         struct efi_loaded_image *loaded_image_info;
 532         efi_status_t ret;
 533
 534         ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
 535                                    "\\selftest", "efi_selftest");
 536         if (ret != EFI_SUCCESS)
 537                 return CMD_RET_FAILURE;
 538
 539         /* Execute the test */
 540         ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
 541         bootefi_run_finish(image_obj, loaded_image_info);
 542
 543         return ret != EFI_SUCCESS;
 544 }
 545 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
 546
 547 /**
 548  * do_bootefi() - execute `bootefi` command
 549  *
 550  * @cmdtp:      table entry describing command
 551  * @flag:       bitmap indicating how the command was invoked
 552  * @argc:       number of arguments
 553  * @argv:       command line arguments
 554  * Return:      status code
 555  */
 556 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 557 {
 558         efi_status_t ret;
 559
 560         if (argc < 2)
 561                 return CMD_RET_USAGE;
 562
 563         /* Initialize EFI drivers */
 564         ret = efi_init_obj_list();
 565         if (ret != EFI_SUCCESS) {
 566                 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
 567                        ret & ~EFI_ERROR_MASK);
 568                 return CMD_RET_FAILURE;
 569         }
 570
 571         ret = efi_install_fdt(argc > 2 ? argv[2] : NULL);
 572         if (ret == EFI_INVALID_PARAMETER)
 573                 return CMD_RET_USAGE;
 574         else if (ret != EFI_SUCCESS)
 575                 return CMD_RET_FAILURE;
 576
 577         if (!strcmp(argv[1], "bootmgr"))
 578                 return do_efibootmgr();
 579 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 580         else if (!strcmp(argv[1], "selftest"))
 581                 return do_efi_selftest();
 582 #endif
 583
 584         return do_bootefi_image(argv[1]);
 585 }
 586
 587 #ifdef CONFIG_SYS_LONGHELP
 588 static char bootefi_help_text[] =
 589         "<image address> [fdt address]\n"
 590         "  - boot EFI payload stored at address <image address>.\n"
 591         "    If specified, the device tree located at <fdt address> gets\n"
 592         "    exposed as EFI configuration table.\n"
 593 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 594         "bootefi hello\n"
 595         "  - boot a sample Hello World application stored within U-Boot\n"
 596 #endif
 597 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 598         "bootefi selftest [fdt address]\n"
 599         "  - boot an EFI selftest application stored within U-Boot\n"
 600         "    Use environment variable efi_selftest to select a single test.\n"
 601         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 602 #endif
 603         "bootefi bootmgr [fdt address]\n"
 604         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
 605         "\n"
 606         "    If specified, the device tree located at <fdt address> gets\n"
 607         "    exposed as EFI configuration table.\n";
 608 #endif
 609
 610 U_BOOT_CMD(
 611         bootefi, 3, 0, do_bootefi,
 612         "Boots an EFI payload from memory",
 613         bootefi_help_text
 614 );
 615
 616 /**
 617  * efi_set_bootdev() - set boot device
 618  *
 619  * This function is called when a file is loaded, e.g. via the 'load' command.
 620  * We use the path to this file to inform the UEFI binary about the boot device.
 621  *
 622  * @dev:        device, e.g. "MMC"
 623  * @devnr:      number of the device, e.g. "1:2"
 624  * @path:       path to file loaded
 625  */
 626 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 627 {
 628         struct efi_device_path *device, *image;
 629         efi_status_t ret;
 630
 631         /* efi_set_bootdev is typically called repeatedly, recover memory */
 632         efi_free_pool(bootefi_device_path);
 633         efi_free_pool(bootefi_image_path);
 634
 635         ret = efi_dp_from_name(dev, devnr, path, &device, &image);
 636         if (ret == EFI_SUCCESS) {
 637                 bootefi_device_path = device;
 638                 if (image) {
 639                         /* FIXME: image should not contain device */
 640                         struct efi_device_path *image_tmp = image;
 641
 642                         efi_dp_split_file_path(image, &device, &image);
 643                         efi_free_pool(image_tmp);
 644                 }
 645                 bootefi_image_path = image;
 646         } else {
 647                 bootefi_device_path = NULL;
 648                 bootefi_image_path = NULL;
 649         }
 650 }