1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
13 #include <efi_loader.h>
14 #include <efi_selftest.h>
16 #include <linux/libfdt.h>
17 #include <linux/libfdt_env.h>
20 #include <asm/global_data.h>
21 #include <asm-generic/sections.h>
22 #include <asm-generic/unaligned.h>
23 #include <linux/linkage.h>
25 DECLARE_GLOBAL_DATA_PTR;
27 static struct efi_device_path *bootefi_image_path;
28 static struct efi_device_path *bootefi_device_path;
31 * Allow unaligned memory access.
33 * This routine is overridden by architectures providing this feature.
35 void __weak allow_unaligned(void)
40 * Set the load options of an image from an environment variable.
42 * @handle: the image handle
43 * @env_var: name of the environment variable
46 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
48 struct efi_loaded_image *loaded_image_info;
50 const char *env = env_get(env_var);
54 ret = EFI_CALL(systab.boottime->open_protocol(
56 &efi_guid_loaded_image,
57 (void **)&loaded_image_info,
59 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
60 if (ret != EFI_SUCCESS)
61 return EFI_INVALID_PARAMETER;
63 loaded_image_info->load_options = NULL;
64 loaded_image_info->load_options_size = 0;
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,
75 return EFI_OUT_OF_RESOURCES;
77 pos = loaded_image_info->load_options;
78 utf8_utf16_strcpy(&pos, env);
79 loaded_image_info->load_options_size = size * 2;
82 return EFI_CALL(systab.boottime->close_protocol(handle,
83 &efi_guid_loaded_image,
87 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
90 * copy_fdt() - Copy the device tree to a new location available to EFI
92 * The FDT is copied to a suitable location within the EFI memory map.
93 * Additional 12 KiB are added to the space in case the device tree needs to be
94 * expanded later with fdt_open_into().
96 * @fdtp: On entry a pointer to the flattened device tree.
97 * On exit a pointer to the copy of the flattened device tree.
101 static efi_status_t copy_fdt(void **fdtp)
103 unsigned long fdt_ram_start = -1L, fdt_pages;
104 efi_status_t ret = 0;
110 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
111 u64 ram_start = gd->bd->bi_dram[i].start;
112 u64 ram_size = gd->bd->bi_dram[i].size;
117 if (ram_start < fdt_ram_start)
118 fdt_ram_start = ram_start;
122 * Give us at least 12 KiB of breathing room in case the device tree
123 * needs to be expanded later.
126 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
127 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
130 * Safe fdt location is at 127 MiB.
131 * On the sandbox convert from the sandbox address space.
133 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
135 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
136 EFI_BOOT_SERVICES_DATA, fdt_pages,
138 if (ret != EFI_SUCCESS) {
139 /* If we can't put it there, put it somewhere */
140 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
141 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
142 EFI_BOOT_SERVICES_DATA, fdt_pages,
144 if (ret != EFI_SUCCESS) {
145 printf("ERROR: Failed to reserve space for FDT\n");
149 new_fdt = (void *)(uintptr_t)new_fdt_addr;
150 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
151 fdt_set_totalsize(new_fdt, fdt_size);
153 *fdtp = (void *)(uintptr_t)new_fdt_addr;
159 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
161 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
162 * ignored because this is not critical and we would rather continue to try to
165 * @fdt: Pointer to device tree
167 static void efi_carve_out_dt_rsv(void *fdt)
170 uint64_t addr, size, pages;
172 nr_rsv = fdt_num_mem_rsv(fdt);
174 /* Look for an existing entry and add it to the efi mem map. */
175 for (i = 0; i < nr_rsv; i++) {
176 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
179 /* Convert from sandbox address space. */
180 addr = (uintptr_t)map_sysmem(addr, 0);
182 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
183 addr &= ~EFI_PAGE_MASK;
184 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
186 printf("FDT memrsv map %d: Failed to add to map\n", i);
191 * get_config_table() - get configuration table
193 * @guid: GUID of the configuration table
194 * Return: pointer to configuration table or NULL
196 static void *get_config_table(const efi_guid_t *guid)
200 for (i = 0; i < systab.nr_tables; i++) {
201 if (!guidcmp(guid, &systab.tables[i].guid))
202 return systab.tables[i].table;
207 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
210 * efi_install_fdt() - install fdt passed by a command argument
211 * @fdt_opt: pointer to argument
212 * Return: status code
214 * If specified, fdt will be installed as configuration table,
215 * otherwise no fdt will be passed.
217 static efi_status_t efi_install_fdt(const char *fdt_opt)
220 * The EBBR spec requires that we have either an FDT or an ACPI table
223 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
225 printf("ERROR: can't have ACPI table and device tree.\n");
226 return EFI_LOAD_ERROR;
229 unsigned long fdt_addr;
231 bootm_headers_t img = { 0 };
235 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
237 return EFI_INVALID_PARAMETER;
239 /* Look for device tree that is already installed */
240 if (get_config_table(&efi_guid_fdt))
242 /* Use our own device tree as default */
243 fdt_opt = env_get("fdtcontroladdr");
245 printf("ERROR: need device tree\n");
246 return EFI_NOT_FOUND;
248 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
250 printf("ERROR: invalid $fdtcontroladdr\n");
251 return EFI_LOAD_ERROR;
255 /* Install device tree */
256 fdt = map_sysmem(fdt_addr, 0);
257 if (fdt_check_header(fdt)) {
258 printf("ERROR: invalid device tree\n");
259 return EFI_LOAD_ERROR;
262 /* Create memory reservations as indicated by the device tree */
263 efi_carve_out_dt_rsv(fdt);
265 /* Prepare device tree for payload */
266 ret = copy_fdt(&fdt);
268 printf("ERROR: out of memory\n");
269 return EFI_OUT_OF_RESOURCES;
272 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
273 printf("ERROR: failed to process device tree\n");
274 return EFI_LOAD_ERROR;
277 /* Install device tree as UEFI table */
278 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
279 if (ret != EFI_SUCCESS) {
280 printf("ERROR: failed to install device tree\n");
283 #endif /* GENERATE_ACPI_TABLE */
289 * do_bootefi_exec() - execute EFI binary
291 * @handle: handle of loaded image
292 * Return: status code
294 * Load the EFI binary into a newly assigned memory unwinding the relocation
295 * information, install the loaded image protocol, and call the binary.
297 static efi_status_t do_bootefi_exec(efi_handle_t handle)
300 efi_uintn_t exit_data_size = 0;
301 u16 *exit_data = NULL;
303 /* Transfer environment variable as load options */
304 ret = set_load_options(handle, "bootargs");
305 if (ret != EFI_SUCCESS)
308 /* Call our payload! */
309 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
310 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
311 if (ret && exit_data) {
312 printf("## %ls\n", exit_data);
313 efi_free_pool(exit_data);
319 * FIXME: Who is responsible for
320 * free(loaded_image_info->load_options);
321 * Once efi_exit() is implemented correctly,
322 * handle itself doesn't exist here.
329 * do_efibootmgr() - execute EFI Boot Manager
331 * @fdt_opt: string of fdt start address
332 * Return: status code
334 * Execute EFI Boot Manager
336 static int do_efibootmgr(const char *fdt_opt)
341 /* Allow unaligned memory access */
344 switch_to_non_secure_mode();
346 /* Initialize EFI drivers */
347 ret = efi_init_obj_list();
348 if (ret != EFI_SUCCESS) {
349 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
350 ret & ~EFI_ERROR_MASK);
351 return CMD_RET_FAILURE;
354 ret = efi_install_fdt(fdt_opt);
355 if (ret == EFI_INVALID_PARAMETER)
356 return CMD_RET_USAGE;
357 else if (ret != EFI_SUCCESS)
358 return CMD_RET_FAILURE;
360 ret = efi_bootmgr_load(&handle);
361 if (ret != EFI_SUCCESS) {
362 printf("EFI boot manager: Cannot load any image\n");
363 return CMD_RET_FAILURE;
366 ret = do_bootefi_exec(handle);
368 if (ret != EFI_SUCCESS)
369 return CMD_RET_FAILURE;
371 return CMD_RET_SUCCESS;
375 * do_bootefi_image() - execute EFI binary from command line
377 * @image_opt: string of image start address
378 * @fdt_opt: string of fdt start address
379 * Return: status code
381 * Set up memory image for the binary to be loaded, prepare
382 * device path and then call do_bootefi_exec() to execute it.
384 static int do_bootefi_image(const char *image_opt, const char *fdt_opt)
387 struct efi_device_path *device_path, *image_path;
388 struct efi_device_path *file_path = NULL;
389 unsigned long addr, size;
390 const char *size_str;
391 efi_handle_t mem_handle = NULL, handle;
394 /* Allow unaligned memory access */
397 switch_to_non_secure_mode();
399 /* Initialize EFI drivers */
400 ret = efi_init_obj_list();
401 if (ret != EFI_SUCCESS) {
402 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
403 ret & ~EFI_ERROR_MASK);
404 return CMD_RET_FAILURE;
407 ret = efi_install_fdt(fdt_opt);
408 if (ret == EFI_INVALID_PARAMETER)
409 return CMD_RET_USAGE;
410 else if (ret != EFI_SUCCESS)
411 return CMD_RET_FAILURE;
413 #ifdef CONFIG_CMD_BOOTEFI_HELLO
414 if (!strcmp(image_opt, "hello")) {
417 saddr = env_get("loadaddr");
418 size = __efi_helloworld_end - __efi_helloworld_begin;
421 addr = simple_strtoul(saddr, NULL, 16);
423 addr = CONFIG_SYS_LOAD_ADDR;
425 image_buf = map_sysmem(addr, size);
426 memcpy(image_buf, __efi_helloworld_begin, size);
433 size_str = env_get("filesize");
435 size = simple_strtoul(size_str, NULL, 16);
439 addr = simple_strtoul(image_opt, NULL, 16);
440 /* Check that a numeric value was passed */
441 if (!addr && *image_opt != '0')
442 return CMD_RET_USAGE;
444 image_buf = map_sysmem(addr, size);
446 device_path = bootefi_device_path;
447 image_path = bootefi_image_path;
450 if (!device_path && !image_path) {
452 * Special case for efi payload not loaded from disk,
453 * such as 'bootefi hello' or for example payload
454 * loaded directly into memory via JTAG, etc:
456 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
457 (uintptr_t)image_buf, size);
459 * Make sure that device for device_path exist
460 * in load_image(). Otherwise, shell and grub will fail.
462 ret = efi_create_handle(&mem_handle);
463 if (ret != EFI_SUCCESS)
466 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
468 if (ret != EFI_SUCCESS)
471 assert(device_path && image_path);
472 file_path = efi_dp_append(device_path, image_path);
475 ret = EFI_CALL(efi_load_image(false, efi_root,
476 file_path, image_buf, size, &handle));
477 if (ret != EFI_SUCCESS)
480 ret = do_bootefi_exec(handle);
484 efi_delete_handle(mem_handle);
486 efi_free_pool(file_path);
488 if (ret != EFI_SUCCESS)
489 return CMD_RET_FAILURE;
491 return CMD_RET_SUCCESS;
494 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
495 static efi_status_t bootefi_run_prepare(const char *load_options_path,
496 struct efi_device_path *device_path,
497 struct efi_device_path *image_path,
498 struct efi_loaded_image_obj **image_objp,
499 struct efi_loaded_image **loaded_image_infop)
503 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
505 if (ret != EFI_SUCCESS)
508 /* Transfer environment variable as load options */
509 return set_load_options((efi_handle_t)*image_objp, load_options_path);
513 * bootefi_test_prepare() - prepare to run an EFI test
515 * Prepare to run a test as if it were provided by a loaded image.
517 * @image_objp: pointer to be set to the loaded image handle
518 * @loaded_image_infop: pointer to be set to the loaded image protocol
519 * @path: dummy file path used to construct the device path
520 * set in the loaded image protocol
521 * @load_options_path: name of a U-Boot environment variable. Its value is
522 * set as load options in the loaded image protocol.
523 * Return: status code
525 static efi_status_t bootefi_test_prepare
526 (struct efi_loaded_image_obj **image_objp,
527 struct efi_loaded_image **loaded_image_infop, const char *path,
528 const char *load_options_path)
532 /* Construct a dummy device path */
533 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
534 if (!bootefi_device_path)
535 return EFI_OUT_OF_RESOURCES;
537 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
538 if (!bootefi_image_path) {
539 ret = EFI_OUT_OF_RESOURCES;
543 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
544 bootefi_image_path, image_objp,
546 if (ret == EFI_SUCCESS)
549 efi_free_pool(bootefi_image_path);
550 bootefi_image_path = NULL;
552 efi_free_pool(bootefi_device_path);
553 bootefi_device_path = NULL;
558 * bootefi_run_finish() - finish up after running an EFI test
560 * @loaded_image_info: Pointer to a struct which holds the loaded image info
561 * @image_obj: Pointer to a struct which holds the loaded image object
563 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
564 struct efi_loaded_image *loaded_image_info)
567 free(loaded_image_info->load_options);
568 efi_delete_handle(&image_obj->header);
572 * do_efi_selftest() - execute EFI Selftest
574 * @fdt_opt: string of fdt start address
575 * Return: status code
577 * Execute EFI Selftest
579 static int do_efi_selftest(const char *fdt_opt)
581 struct efi_loaded_image_obj *image_obj;
582 struct efi_loaded_image *loaded_image_info;
585 /* Allow unaligned memory access */
588 switch_to_non_secure_mode();
590 /* Initialize EFI drivers */
591 ret = efi_init_obj_list();
592 if (ret != EFI_SUCCESS) {
593 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
594 ret & ~EFI_ERROR_MASK);
595 return CMD_RET_FAILURE;
598 ret = efi_install_fdt(fdt_opt);
599 if (ret == EFI_INVALID_PARAMETER)
600 return CMD_RET_USAGE;
601 else if (ret != EFI_SUCCESS)
602 return CMD_RET_FAILURE;
604 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
605 "\\selftest", "efi_selftest");
606 if (ret != EFI_SUCCESS)
607 return CMD_RET_FAILURE;
609 /* Execute the test */
610 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
611 bootefi_run_finish(image_obj, loaded_image_info);
613 return ret != EFI_SUCCESS;
615 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
617 /* Interpreter command to boot an arbitrary EFI image from memory */
618 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
621 return CMD_RET_USAGE;
623 if (!strcmp(argv[1], "bootmgr"))
624 return do_efibootmgr(argc > 2 ? argv[2] : NULL);
625 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
626 else if (!strcmp(argv[1], "selftest"))
627 return do_efi_selftest(argc > 2 ? argv[2] : NULL);
630 return do_bootefi_image(argv[1], argc > 2 ? argv[2] : NULL);
633 #ifdef CONFIG_SYS_LONGHELP
634 static char bootefi_help_text[] =
635 "<image address> [fdt address]\n"
636 " - boot EFI payload stored at address <image address>.\n"
637 " If specified, the device tree located at <fdt address> gets\n"
638 " exposed as EFI configuration table.\n"
639 #ifdef CONFIG_CMD_BOOTEFI_HELLO
641 " - boot a sample Hello World application stored within U-Boot\n"
643 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
644 "bootefi selftest [fdt address]\n"
645 " - boot an EFI selftest application stored within U-Boot\n"
646 " Use environment variable efi_selftest to select a single test.\n"
647 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
649 "bootefi bootmgr [fdt address]\n"
650 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
652 " If specified, the device tree located at <fdt address> gets\n"
653 " exposed as EFI configuration table.\n";
657 bootefi, 3, 0, do_bootefi,
658 "Boots an EFI payload from memory",
662 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
664 struct efi_device_path *device, *image;
667 /* efi_set_bootdev is typically called repeatedly, recover memory */
668 efi_free_pool(bootefi_device_path);
669 efi_free_pool(bootefi_image_path);
671 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
672 if (ret == EFI_SUCCESS) {
673 bootefi_device_path = device;
675 /* FIXME: image should not contain device */
676 struct efi_device_path *image_tmp = image;
678 efi_dp_split_file_path(image, &device, &image);
679 efi_free_pool(image_tmp);
681 bootefi_image_path = image;
683 bootefi_device_path = NULL;
684 bootefi_image_path = NULL;