1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
12 #include <efi_loader.h>
13 #include <efi_selftest.h>
15 #include <linux/libfdt.h>
16 #include <linux/libfdt_env.h>
19 #include <asm-generic/sections.h>
20 #include <linux/linkage.h>
22 DECLARE_GLOBAL_DATA_PTR;
24 static struct efi_device_path *bootefi_image_path;
25 static struct efi_device_path *bootefi_device_path;
28 * Set the load options of an image from an environment variable.
30 * @handle: the image handle
31 * @env_var: name of the environment variable
34 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
36 struct efi_loaded_image *loaded_image_info;
38 const char *env = env_get(env_var);
42 ret = EFI_CALL(systab.boottime->open_protocol(
44 &efi_guid_loaded_image,
45 (void **)&loaded_image_info,
47 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
48 if (ret != EFI_SUCCESS)
49 return EFI_INVALID_PARAMETER;
51 loaded_image_info->load_options = NULL;
52 loaded_image_info->load_options_size = 0;
56 size = utf8_utf16_strlen(env) + 1;
57 loaded_image_info->load_options = calloc(size, sizeof(u16));
58 if (!loaded_image_info->load_options) {
59 printf("ERROR: Out of memory\n");
60 EFI_CALL(systab.boottime->close_protocol(handle,
61 &efi_guid_loaded_image,
63 return EFI_OUT_OF_RESOURCES;
65 pos = loaded_image_info->load_options;
66 utf8_utf16_strcpy(&pos, env);
67 loaded_image_info->load_options_size = size * 2;
70 return EFI_CALL(systab.boottime->close_protocol(handle,
71 &efi_guid_loaded_image,
75 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
78 * copy_fdt() - Copy the device tree to a new location available to EFI
80 * The FDT is copied to a suitable location within the EFI memory map.
81 * Additional 12 KiB are added to the space in case the device tree needs to be
82 * expanded later with fdt_open_into().
84 * @fdtp: On entry a pointer to the flattened device tree.
85 * On exit a pointer to the copy of the flattened device tree.
89 static efi_status_t copy_fdt(void **fdtp)
91 unsigned long fdt_ram_start = -1L, fdt_pages;
98 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
99 u64 ram_start = gd->bd->bi_dram[i].start;
100 u64 ram_size = gd->bd->bi_dram[i].size;
105 if (ram_start < fdt_ram_start)
106 fdt_ram_start = ram_start;
110 * Give us at least 12 KiB of breathing room in case the device tree
111 * needs to be expanded later.
114 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
115 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
118 * Safe fdt location is at 127 MiB.
119 * On the sandbox convert from the sandbox address space.
121 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
123 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
124 EFI_BOOT_SERVICES_DATA, fdt_pages,
126 if (ret != EFI_SUCCESS) {
127 /* If we can't put it there, put it somewhere */
128 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
129 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
130 EFI_BOOT_SERVICES_DATA, fdt_pages,
132 if (ret != EFI_SUCCESS) {
133 printf("ERROR: Failed to reserve space for FDT\n");
137 new_fdt = (void *)(uintptr_t)new_fdt_addr;
138 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
139 fdt_set_totalsize(new_fdt, fdt_size);
141 *fdtp = (void *)(uintptr_t)new_fdt_addr;
147 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
149 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
150 * ignored because this is not critical and we would rather continue to try to
153 * @fdt: Pointer to device tree
155 static void efi_carve_out_dt_rsv(void *fdt)
158 uint64_t addr, size, pages;
160 nr_rsv = fdt_num_mem_rsv(fdt);
162 /* Look for an existing entry and add it to the efi mem map. */
163 for (i = 0; i < nr_rsv; i++) {
164 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
167 /* Convert from sandbox address space. */
168 addr = (uintptr_t)map_sysmem(addr, 0);
170 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
171 addr &= ~EFI_PAGE_MASK;
172 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
174 printf("FDT memrsv map %d: Failed to add to map\n", i);
179 * get_config_table() - get configuration table
181 * @guid: GUID of the configuration table
182 * Return: pointer to configuration table or NULL
184 static void *get_config_table(const efi_guid_t *guid)
188 for (i = 0; i < systab.nr_tables; i++) {
189 if (!guidcmp(guid, &systab.tables[i].guid))
190 return systab.tables[i].table;
195 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
198 * efi_install_fdt() - install fdt passed by a command argument
199 * @fdt_opt: pointer to argument
200 * Return: status code
202 * If specified, fdt will be installed as configuration table,
203 * otherwise no fdt will be passed.
205 static efi_status_t efi_install_fdt(const char *fdt_opt)
208 * The EBBR spec requires that we have either an FDT or an ACPI table
211 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
213 printf("ERROR: can't have ACPI table and device tree.\n");
214 return EFI_LOAD_ERROR;
217 unsigned long fdt_addr;
219 bootm_headers_t img = { 0 };
223 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
225 return EFI_INVALID_PARAMETER;
227 /* Look for device tree that is already installed */
228 if (get_config_table(&efi_guid_fdt))
230 /* Use our own device tree as default */
231 fdt_opt = env_get("fdtcontroladdr");
233 printf("ERROR: need device tree\n");
234 return EFI_NOT_FOUND;
236 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
238 printf("ERROR: invalid $fdtcontroladdr\n");
239 return EFI_LOAD_ERROR;
243 /* Install device tree */
244 fdt = map_sysmem(fdt_addr, 0);
245 if (fdt_check_header(fdt)) {
246 printf("ERROR: invalid device tree\n");
247 return EFI_LOAD_ERROR;
250 /* Create memory reservations as indicated by the device tree */
251 efi_carve_out_dt_rsv(fdt);
253 /* Prepare device tree for payload */
254 ret = copy_fdt(&fdt);
256 printf("ERROR: out of memory\n");
257 return EFI_OUT_OF_RESOURCES;
260 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
261 printf("ERROR: failed to process device tree\n");
262 return EFI_LOAD_ERROR;
265 /* Install device tree as UEFI table */
266 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
267 if (ret != EFI_SUCCESS) {
268 printf("ERROR: failed to install device tree\n");
271 #endif /* GENERATE_ACPI_TABLE */
277 * do_bootefi_exec() - execute EFI binary
279 * @handle: handle of loaded image
280 * Return: status code
282 * Load the EFI binary into a newly assigned memory unwinding the relocation
283 * information, install the loaded image protocol, and call the binary.
285 static efi_status_t do_bootefi_exec(efi_handle_t handle)
288 efi_uintn_t exit_data_size = 0;
289 u16 *exit_data = NULL;
291 /* Transfer environment variable as load options */
292 ret = set_load_options(handle, "bootargs");
293 if (ret != EFI_SUCCESS)
296 /* Call our payload! */
297 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
298 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
299 if (ret && exit_data) {
300 printf("## %ls\n", exit_data);
301 efi_free_pool(exit_data);
307 * FIXME: Who is responsible for
308 * free(loaded_image_info->load_options);
309 * Once efi_exit() is implemented correctly,
310 * handle itself doesn't exist here.
317 * do_efibootmgr() - execute EFI boot manager
319 * Return: status code
321 static int do_efibootmgr(void)
326 ret = efi_bootmgr_load(&handle);
327 if (ret != EFI_SUCCESS) {
328 printf("EFI boot manager: Cannot load any image\n");
329 return CMD_RET_FAILURE;
332 ret = do_bootefi_exec(handle);
334 if (ret != EFI_SUCCESS)
335 return CMD_RET_FAILURE;
337 return CMD_RET_SUCCESS;
341 * do_bootefi_image() - execute EFI binary
343 * Set up memory image for the binary to be loaded, prepare device path, and
344 * then call do_bootefi_exec() to execute it.
346 * @image_opt: string of image start address
347 * Return: status code
349 static int do_bootefi_image(const char *image_opt)
352 struct efi_device_path *device_path, *image_path;
353 struct efi_device_path *file_path = NULL;
354 unsigned long addr, size;
355 const char *size_str;
356 efi_handle_t mem_handle = NULL, handle;
359 #ifdef CONFIG_CMD_BOOTEFI_HELLO
360 if (!strcmp(image_opt, "hello")) {
363 saddr = env_get("loadaddr");
364 size = __efi_helloworld_end - __efi_helloworld_begin;
367 addr = simple_strtoul(saddr, NULL, 16);
369 addr = CONFIG_SYS_LOAD_ADDR;
371 image_buf = map_sysmem(addr, size);
372 memcpy(image_buf, __efi_helloworld_begin, size);
379 size_str = env_get("filesize");
381 size = simple_strtoul(size_str, NULL, 16);
385 addr = simple_strtoul(image_opt, NULL, 16);
386 /* Check that a numeric value was passed */
387 if (!addr && *image_opt != '0')
388 return CMD_RET_USAGE;
390 image_buf = map_sysmem(addr, size);
392 device_path = bootefi_device_path;
393 image_path = bootefi_image_path;
396 if (!device_path && !image_path) {
398 * Special case for efi payload not loaded from disk,
399 * such as 'bootefi hello' or for example payload
400 * loaded directly into memory via JTAG, etc:
402 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
403 (uintptr_t)image_buf, size);
405 * Make sure that device for device_path exist
406 * in load_image(). Otherwise, shell and grub will fail.
408 ret = efi_create_handle(&mem_handle);
409 if (ret != EFI_SUCCESS)
412 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
414 if (ret != EFI_SUCCESS)
417 assert(device_path && image_path);
418 file_path = efi_dp_append(device_path, image_path);
421 ret = EFI_CALL(efi_load_image(false, efi_root,
422 file_path, image_buf, size, &handle));
423 if (ret != EFI_SUCCESS)
426 ret = do_bootefi_exec(handle);
430 efi_delete_handle(mem_handle);
432 efi_free_pool(file_path);
434 if (ret != EFI_SUCCESS)
435 return CMD_RET_FAILURE;
437 return CMD_RET_SUCCESS;
440 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
441 static efi_status_t bootefi_run_prepare(const char *load_options_path,
442 struct efi_device_path *device_path,
443 struct efi_device_path *image_path,
444 struct efi_loaded_image_obj **image_objp,
445 struct efi_loaded_image **loaded_image_infop)
449 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
451 if (ret != EFI_SUCCESS)
454 /* Transfer environment variable as load options */
455 return set_load_options((efi_handle_t)*image_objp, load_options_path);
459 * bootefi_test_prepare() - prepare to run an EFI test
461 * Prepare to run a test as if it were provided by a loaded image.
463 * @image_objp: pointer to be set to the loaded image handle
464 * @loaded_image_infop: pointer to be set to the loaded image protocol
465 * @path: dummy file path used to construct the device path
466 * set in the loaded image protocol
467 * @load_options_path: name of a U-Boot environment variable. Its value is
468 * set as load options in the loaded image protocol.
469 * Return: status code
471 static efi_status_t bootefi_test_prepare
472 (struct efi_loaded_image_obj **image_objp,
473 struct efi_loaded_image **loaded_image_infop, const char *path,
474 const char *load_options_path)
478 /* Construct a dummy device path */
479 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
480 if (!bootefi_device_path)
481 return EFI_OUT_OF_RESOURCES;
483 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
484 if (!bootefi_image_path) {
485 ret = EFI_OUT_OF_RESOURCES;
489 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
490 bootefi_image_path, image_objp,
492 if (ret == EFI_SUCCESS)
495 efi_free_pool(bootefi_image_path);
496 bootefi_image_path = NULL;
498 efi_free_pool(bootefi_device_path);
499 bootefi_device_path = NULL;
504 * bootefi_run_finish() - finish up after running an EFI test
506 * @loaded_image_info: Pointer to a struct which holds the loaded image info
507 * @image_obj: Pointer to a struct which holds the loaded image object
509 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
510 struct efi_loaded_image *loaded_image_info)
513 free(loaded_image_info->load_options);
514 efi_delete_handle(&image_obj->header);
518 * do_efi_selftest() - execute EFI selftest
520 * Return: status code
522 static int do_efi_selftest(void)
524 struct efi_loaded_image_obj *image_obj;
525 struct efi_loaded_image *loaded_image_info;
528 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
529 "\\selftest", "efi_selftest");
530 if (ret != EFI_SUCCESS)
531 return CMD_RET_FAILURE;
533 /* Execute the test */
534 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
535 bootefi_run_finish(image_obj, loaded_image_info);
537 return ret != EFI_SUCCESS;
539 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
542 * do_bootefi() - execute `bootefi` command
544 * @cmdtp: table entry describing command
545 * @flag: bitmap indicating how the command was invoked
546 * @argc: number of arguments
547 * @argv: command line arguments
548 * Return: status code
550 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
555 return CMD_RET_USAGE;
557 /* Initialize EFI drivers */
558 ret = efi_init_obj_list();
559 if (ret != EFI_SUCCESS) {
560 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
561 ret & ~EFI_ERROR_MASK);
562 return CMD_RET_FAILURE;
565 ret = efi_install_fdt(argc > 2 ? argv[2] : NULL);
566 if (ret == EFI_INVALID_PARAMETER)
567 return CMD_RET_USAGE;
568 else if (ret != EFI_SUCCESS)
569 return CMD_RET_FAILURE;
571 if (!strcmp(argv[1], "bootmgr"))
572 return do_efibootmgr();
573 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
574 else if (!strcmp(argv[1], "selftest"))
575 return do_efi_selftest();
578 return do_bootefi_image(argv[1]);
581 #ifdef CONFIG_SYS_LONGHELP
582 static char bootefi_help_text[] =
583 "<image address> [fdt address]\n"
584 " - boot EFI payload stored at address <image address>.\n"
585 " If specified, the device tree located at <fdt address> gets\n"
586 " exposed as EFI configuration table.\n"
587 #ifdef CONFIG_CMD_BOOTEFI_HELLO
589 " - boot a sample Hello World application stored within U-Boot\n"
591 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
592 "bootefi selftest [fdt address]\n"
593 " - boot an EFI selftest application stored within U-Boot\n"
594 " Use environment variable efi_selftest to select a single test.\n"
595 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
597 "bootefi bootmgr [fdt address]\n"
598 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
600 " If specified, the device tree located at <fdt address> gets\n"
601 " exposed as EFI configuration table.\n";
605 bootefi, 3, 0, do_bootefi,
606 "Boots an EFI payload from memory",
610 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
612 struct efi_device_path *device, *image;
615 /* efi_set_bootdev is typically called repeatedly, recover memory */
616 efi_free_pool(bootefi_device_path);
617 efi_free_pool(bootefi_image_path);
619 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
620 if (ret == EFI_SUCCESS) {
621 bootefi_device_path = device;
623 /* FIXME: image should not contain device */
624 struct efi_device_path *image_tmp = image;
626 efi_dp_split_file_path(image, &device, &image);
627 efi_free_pool(image_tmp);
629 bootefi_image_path = image;
631 bootefi_device_path = NULL;
632 bootefi_image_path = NULL;