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 <bootm.h>
  10 #include <charset.h>
  11 #include <command.h>
  12 #include <dm.h>
  13 #include <efi_loader.h>
  14 #include <efi_selftest.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/global_data.h>
  21 #include <asm-generic/sections.h>
  22 #include <asm-generic/unaligned.h>
  23 #include <linux/linkage.h>
  24
  25 DECLARE_GLOBAL_DATA_PTR;
  26
  27 static struct efi_device_path *bootefi_image_path;
  28 static struct efi_device_path *bootefi_device_path;
  29
  30 /*
  31  * Allow unaligned memory access.
  32  *
  33  * This routine is overridden by architectures providing this feature.
  34  */
  35 void __weak allow_unaligned(void)
  36 {
  37 }
  38
  39 /*
  40  * Set the load options of an image from an environment variable.
  41  *
  42  * @handle:     the image handle
  43  * @env_var:    name of the environment variable
  44  * Return:      status code
  45  */
  46 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
  47 {
  48         struct efi_loaded_image *loaded_image_info;
  49         size_t size;
  50         const char *env = env_get(env_var);
  51         u16 *pos;
  52         efi_status_t ret;
  53
  54         ret = EFI_CALL(systab.boottime->open_protocol(
  55                                         handle,
  56                                         &efi_guid_loaded_image,
  57                                         (void **)&loaded_image_info,
  58                                         efi_root, NULL,
  59                                         EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
  60         if (ret != EFI_SUCCESS)
  61                 return EFI_INVALID_PARAMETER;
  62
  63         loaded_image_info->load_options = NULL;
  64         loaded_image_info->load_options_size = 0;
  65         if (!env)
  66                 goto out;
  67
  68         size = utf8_utf16_strlen(env) + 1;
  69         loaded_image_info->load_options = calloc(size, sizeof(u16));
  70         if (!loaded_image_info->load_options) {
  71                 printf("ERROR: Out of memory\n");
  72                 EFI_CALL(systab.boottime->close_protocol(handle,
  73                                                          &efi_guid_loaded_image,
  74                                                          efi_root, NULL));
  75                 return EFI_OUT_OF_RESOURCES;
  76         }
  77         pos = loaded_image_info->load_options;
  78         utf8_utf16_strcpy(&pos, env);
  79         loaded_image_info->load_options_size = size * 2;
  80
  81 out:
  82         return EFI_CALL(systab.boottime->close_protocol(handle,
  83                                                         &efi_guid_loaded_image,
  84                                                         efi_root, NULL));
  85 }
  86
  87 /**
  88  * copy_fdt() - Copy the device tree to a new location available to EFI
  89  *
  90  * The FDT is copied to a suitable location within the EFI memory map.
  91  * Additional 12 KiB are added to the space in case the device tree needs to be
  92  * expanded later with fdt_open_into().
  93  *
  94  * @fdtp:       On entry a pointer to the flattened device tree.
  95  *              On exit a pointer to the copy of the flattened device tree.
  96  *              FDT start
  97  * Return:      status code
  98  */
  99 static efi_status_t copy_fdt(void **fdtp)
 100 {
 101         unsigned long fdt_ram_start = -1L, fdt_pages;
 102         efi_status_t ret = 0;
 103         void *fdt, *new_fdt;
 104         u64 new_fdt_addr;
 105         uint fdt_size;
 106         int i;
 107
 108         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 109                 u64 ram_start = gd->bd->bi_dram[i].start;
 110                 u64 ram_size = gd->bd->bi_dram[i].size;
 111
 112                 if (!ram_size)
 113                         continue;
 114
 115                 if (ram_start < fdt_ram_start)
 116                         fdt_ram_start = ram_start;
 117         }
 118
 119         /*
 120          * Give us at least 12 KiB of breathing room in case the device tree
 121          * needs to be expanded later.
 122          */
 123         fdt = *fdtp;
 124         fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
 125         fdt_size = fdt_pages << EFI_PAGE_SHIFT;
 126
 127         /*
 128          * Safe fdt location is at 127 MiB.
 129          * On the sandbox convert from the sandbox address space.
 130          */
 131         new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
 132                                              fdt_size, 0);
 133         ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 134                                  EFI_BOOT_SERVICES_DATA, fdt_pages,
 135                                  &new_fdt_addr);
 136         if (ret != EFI_SUCCESS) {
 137                 /* If we can't put it there, put it somewhere */
 138                 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
 139                 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
 140                                          EFI_BOOT_SERVICES_DATA, fdt_pages,
 141                                          &new_fdt_addr);
 142                 if (ret != EFI_SUCCESS) {
 143                         printf("ERROR: Failed to reserve space for FDT\n");
 144                         goto done;
 145                 }
 146         }
 147         new_fdt = (void *)(uintptr_t)new_fdt_addr;
 148         memcpy(new_fdt, fdt, fdt_totalsize(fdt));
 149         fdt_set_totalsize(new_fdt, fdt_size);
 150
 151         *fdtp = (void *)(uintptr_t)new_fdt_addr;
 152 done:
 153         return ret;
 154 }
 155
 156 /*
 157  * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
 158  *
 159  * The mem_rsv entries of the FDT are added to the memory map. Any failures are
 160  * ignored because this is not critical and we would rather continue to try to
 161  * boot.
 162  *
 163  * @fdt: Pointer to device tree
 164  */
 165 static void efi_carve_out_dt_rsv(void *fdt)
 166 {
 167         int nr_rsv, i;
 168         uint64_t addr, size, pages;
 169
 170         nr_rsv = fdt_num_mem_rsv(fdt);
 171
 172         /* Look for an existing entry and add it to the efi mem map. */
 173         for (i = 0; i < nr_rsv; i++) {
 174                 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
 175                         continue;
 176
 177                 /* Convert from sandbox address space. */
 178                 addr = (uintptr_t)map_sysmem(addr, 0);
 179
 180                 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
 181                 addr &= ~EFI_PAGE_MASK;
 182                 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
 183                                         false))
 184                         printf("FDT memrsv map %d: Failed to add to map\n", i);
 185         }
 186 }
 187
 188 static efi_status_t efi_install_fdt(ulong fdt_addr)
 189 {
 190         bootm_headers_t img = { 0 };
 191         efi_status_t ret;
 192         void *fdt;
 193
 194         fdt = map_sysmem(fdt_addr, 0);
 195         if (fdt_check_header(fdt)) {
 196                 printf("ERROR: invalid device tree\n");
 197                 return EFI_INVALID_PARAMETER;
 198         }
 199
 200         /* Create memory reservation as indicated by the device tree */
 201         efi_carve_out_dt_rsv(fdt);
 202
 203         /* Prepare fdt for payload */
 204         ret = copy_fdt(&fdt);
 205         if (ret)
 206                 return ret;
 207
 208         if (image_setup_libfdt(&img, fdt, 0, NULL)) {
 209                 printf("ERROR: failed to process device tree\n");
 210                 return EFI_LOAD_ERROR;
 211         }
 212
 213         /* Link to it in the efi tables */
 214         ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
 215         if (ret != EFI_SUCCESS)
 216                 return EFI_OUT_OF_RESOURCES;
 217
 218         return ret;
 219 }
 220
 221 static efi_status_t bootefi_run_prepare(const char *load_options_path,
 222                 struct efi_device_path *device_path,
 223                 struct efi_device_path *image_path,
 224                 struct efi_loaded_image_obj **image_objp,
 225                 struct efi_loaded_image **loaded_image_infop)
 226 {
 227         efi_status_t ret;
 228
 229         ret = efi_setup_loaded_image(device_path, image_path, image_objp,
 230                                      loaded_image_infop);
 231         if (ret != EFI_SUCCESS)
 232                 return ret;
 233
 234         /* Transfer environment variable as load options */
 235         return set_load_options((efi_handle_t)*image_objp, load_options_path);
 236 }
 237
 238 /**
 239  * bootefi_run_finish() - finish up after running an EFI test
 240  *
 241  * @loaded_image_info: Pointer to a struct which holds the loaded image info
 242  * @image_objj: Pointer to a struct which holds the loaded image object
 243  */
 244 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
 245                                struct efi_loaded_image *loaded_image_info)
 246 {
 247         efi_restore_gd();
 248         free(loaded_image_info->load_options);
 249         efi_delete_handle(&image_obj->header);
 250 }
 251
 252 /**
 253  * do_bootefi_exec() - execute EFI binary
 254  *
 255  * @efi:                address of the binary
 256  * @device_path:        path of the device from which the binary was loaded
 257  * @image_path:         device path of the binary
 258  * Return:              status code
 259  *
 260  * Load the EFI binary into a newly assigned memory unwinding the relocation
 261  * information, install the loaded image protocol, and call the binary.
 262  */
 263 static efi_status_t do_bootefi_exec(void *efi,
 264                                     struct efi_device_path *device_path,
 265                                     struct efi_device_path *image_path)
 266 {
 267         efi_handle_t mem_handle = NULL;
 268         struct efi_device_path *memdp = NULL;
 269         efi_status_t ret;
 270         struct efi_loaded_image_obj *image_obj = NULL;
 271         struct efi_loaded_image *loaded_image_info = NULL;
 272
 273         /*
 274          * Special case for efi payload not loaded from disk, such as
 275          * 'bootefi hello' or for example payload loaded directly into
 276          * memory via JTAG, etc:
 277          */
 278         if (!device_path && !image_path) {
 279                 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
 280                 /* actual addresses filled in after efi_load_pe() */
 281                 memdp = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
 282                 device_path = image_path = memdp;
 283                 /*
 284                  * Grub expects that the device path of the loaded image is
 285                  * installed on a handle.
 286                  */
 287                 ret = efi_create_handle(&mem_handle);
 288                 if (ret != EFI_SUCCESS)
 289                         return ret; /* TODO: leaks device_path */
 290                 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
 291                                        device_path);
 292                 if (ret != EFI_SUCCESS)
 293                         goto err_add_protocol;
 294         } else {
 295                 assert(device_path && image_path);
 296         }
 297
 298         ret = bootefi_run_prepare("bootargs", device_path, image_path,
 299                                   &image_obj, &loaded_image_info);
 300         if (ret)
 301                 goto err_prepare;
 302
 303         /* Load the EFI payload */
 304         ret = efi_load_pe(image_obj, efi, loaded_image_info);
 305         if (ret != EFI_SUCCESS)
 306                 goto err_prepare;
 307
 308         if (memdp) {
 309                 struct efi_device_path_memory *mdp = (void *)memdp;
 310                 mdp->memory_type = loaded_image_info->image_code_type;
 311                 mdp->start_address = (uintptr_t)loaded_image_info->image_base;
 312                 mdp->end_address = mdp->start_address +
 313                                 loaded_image_info->image_size;
 314         }
 315
 316         /* we don't support much: */
 317         env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
 318                 "{ro,boot}(blob)0000000000000000");
 319
 320         /* Call our payload! */
 321         debug("%s: Jumping to 0x%p\n", __func__, image_obj->entry);
 322         ret = EFI_CALL(efi_start_image(&image_obj->header, NULL, NULL));
 323
 324 err_prepare:
 325         /* image has returned, loaded-image obj goes *poof*: */
 326         bootefi_run_finish(image_obj, loaded_image_info);
 327
 328 err_add_protocol:
 329         if (mem_handle)
 330                 efi_delete_handle(mem_handle);
 331
 332         return ret;
 333 }
 334
 335 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 336 /**
 337  * bootefi_test_prepare() - prepare to run an EFI test
 338  *
 339  * Prepare to run a test as if it were provided by a loaded image.
 340  *
 341  * @image_objp:         pointer to be set to the loaded image handle
 342  * @loaded_image_infop: pointer to be set to the loaded image protocol
 343  * @path:               dummy file path used to construct the device path
 344  *                      set in the loaded image protocol
 345  * @load_options_path:  name of a U-Boot environment variable. Its value is
 346  *                      set as load options in the loaded image protocol.
 347  * Return:              status code
 348  */
 349 static efi_status_t bootefi_test_prepare
 350                 (struct efi_loaded_image_obj **image_objp,
 351                  struct efi_loaded_image **loaded_image_infop, const char *path,
 352                  const char *load_options_path)
 353 {
 354         efi_status_t ret;
 355
 356         /* Construct a dummy device path */
 357         bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
 358         if (!bootefi_device_path)
 359                 return EFI_OUT_OF_RESOURCES;
 360
 361         bootefi_image_path = efi_dp_from_file(NULL, 0, path);
 362         if (!bootefi_image_path) {
 363                 ret = EFI_OUT_OF_RESOURCES;
 364                 goto failure;
 365         }
 366
 367         ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
 368                                   bootefi_image_path, image_objp,
 369                                   loaded_image_infop);
 370         if (ret == EFI_SUCCESS)
 371                 return ret;
 372
 373         efi_free_pool(bootefi_image_path);
 374         bootefi_image_path = NULL;
 375 failure:
 376         efi_free_pool(bootefi_device_path);
 377         bootefi_device_path = NULL;
 378         return ret;
 379 }
 380
 381 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
 382
 383 static int do_bootefi_bootmgr_exec(void)
 384 {
 385         struct efi_device_path *device_path, *file_path;
 386         void *addr;
 387         efi_status_t r;
 388
 389         addr = efi_bootmgr_load(&device_path, &file_path);
 390         if (!addr)
 391                 return 1;
 392
 393         printf("## Starting EFI application at %p ...\n", addr);
 394         r = do_bootefi_exec(addr, device_path, file_path);
 395         printf("## Application terminated, r = %lu\n",
 396                r & ~EFI_ERROR_MASK);
 397
 398         if (r != EFI_SUCCESS)
 399                 return 1;
 400
 401         return 0;
 402 }
 403
 404 /* Interpreter command to boot an arbitrary EFI image from memory */
 405 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 406 {
 407         unsigned long addr;
 408         char *saddr;
 409         efi_status_t r;
 410         unsigned long fdt_addr;
 411
 412         /* Allow unaligned memory access */
 413         allow_unaligned();
 414
 415         switch_to_non_secure_mode();
 416
 417         /* Initialize EFI drivers */
 418         r = efi_init_obj_list();
 419         if (r != EFI_SUCCESS) {
 420                 printf("Error: Cannot set up EFI drivers, r = %lu\n",
 421                        r & ~EFI_ERROR_MASK);
 422                 return CMD_RET_FAILURE;
 423         }
 424
 425         if (argc < 2)
 426                 return CMD_RET_USAGE;
 427
 428         if (argc > 2) {
 429                 fdt_addr = simple_strtoul(argv[2], NULL, 16);
 430                 if (!fdt_addr && *argv[2] != '0')
 431                         return CMD_RET_USAGE;
 432                 /* Install device tree */
 433                 r = efi_install_fdt(fdt_addr);
 434                 if (r != EFI_SUCCESS) {
 435                         printf("ERROR: failed to install device tree\n");
 436                         return CMD_RET_FAILURE;
 437                 }
 438         } else {
 439                 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
 440                 efi_install_configuration_table(&efi_guid_fdt, NULL);
 441                 printf("WARNING: booting without device tree\n");
 442         }
 443 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 444         if (!strcmp(argv[1], "hello")) {
 445                 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
 446
 447                 saddr = env_get("loadaddr");
 448                 if (saddr)
 449                         addr = simple_strtoul(saddr, NULL, 16);
 450                 else
 451                         addr = CONFIG_SYS_LOAD_ADDR;
 452                 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
 453         } else
 454 #endif
 455 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 456         if (!strcmp(argv[1], "selftest")) {
 457                 struct efi_loaded_image_obj *image_obj;
 458                 struct efi_loaded_image *loaded_image_info;
 459
 460                 r = bootefi_test_prepare(&image_obj, &loaded_image_info,
 461                                          "\\selftest", "efi_selftest");
 462                 if (r != EFI_SUCCESS)
 463                         return CMD_RET_FAILURE;
 464
 465                 /* Execute the test */
 466                 r = EFI_CALL(efi_selftest(&image_obj->header, &systab));
 467                 bootefi_run_finish(image_obj, loaded_image_info);
 468                 return r != EFI_SUCCESS;
 469         } else
 470 #endif
 471         if (!strcmp(argv[1], "bootmgr")) {
 472                 return do_bootefi_bootmgr_exec();
 473         } else {
 474                 saddr = argv[1];
 475
 476                 addr = simple_strtoul(saddr, NULL, 16);
 477                 /* Check that a numeric value was passed */
 478                 if (!addr && *saddr != '0')
 479                         return CMD_RET_USAGE;
 480
 481         }
 482
 483         printf("## Starting EFI application at %08lx ...\n", addr);
 484         r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
 485                             bootefi_image_path);
 486         printf("## Application terminated, r = %lu\n",
 487                r & ~EFI_ERROR_MASK);
 488
 489         if (r != EFI_SUCCESS)
 490                 return 1;
 491         else
 492                 return 0;
 493 }
 494
 495 #ifdef CONFIG_SYS_LONGHELP
 496 static char bootefi_help_text[] =
 497         "<image address> [fdt address]\n"
 498         "  - boot EFI payload stored at address <image address>.\n"
 499         "    If specified, the device tree located at <fdt address> gets\n"
 500         "    exposed as EFI configuration table.\n"
 501 #ifdef CONFIG_CMD_BOOTEFI_HELLO
 502         "bootefi hello\n"
 503         "  - boot a sample Hello World application stored within U-Boot\n"
 504 #endif
 505 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
 506         "bootefi selftest [fdt address]\n"
 507         "  - boot an EFI selftest application stored within U-Boot\n"
 508         "    Use environment variable efi_selftest to select a single test.\n"
 509         "    Use 'setenv efi_selftest list' to enumerate all tests.\n"
 510 #endif
 511         "bootefi bootmgr [fdt addr]\n"
 512         "  - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
 513         "\n"
 514         "    If specified, the device tree located at <fdt address> gets\n"
 515         "    exposed as EFI configuration table.\n";
 516 #endif
 517
 518 U_BOOT_CMD(
 519         bootefi, 3, 0, do_bootefi,
 520         "Boots an EFI payload from memory",
 521         bootefi_help_text
 522 );
 523
 524 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
 525 {
 526         struct efi_device_path *device, *image;
 527         efi_status_t ret;
 528
 529         /* efi_set_bootdev is typically called repeatedly, recover memory */
 530         efi_free_pool(bootefi_device_path);
 531         efi_free_pool(bootefi_image_path);
 532
 533         ret = efi_dp_from_name(dev, devnr, path, &device, &image);
 534         if (ret == EFI_SUCCESS) {
 535                 bootefi_device_path = device;
 536                 bootefi_image_path = image;
 537         } else {
 538                 bootefi_device_path = NULL;
 539                 bootefi_image_path = NULL;
 540         }
 541 }