1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
8 #define LOG_CATEGORY LOGC_EFI
15 #include <efi_loader.h>
16 #include <efi_selftest.h>
22 #include <asm/global_data.h>
23 #include <linux/libfdt.h>
24 #include <linux/libfdt_env.h>
27 #include <asm-generic/sections.h>
28 #include <linux/linkage.h>
30 DECLARE_GLOBAL_DATA_PTR;
32 static struct efi_device_path *bootefi_image_path;
33 static struct efi_device_path *bootefi_device_path;
34 static void *image_addr;
35 static size_t image_size;
38 * efi_get_image_parameters() - return image parameters
40 * @img_addr: address of loaded image in memory
41 * @img_size: size of loaded image
43 void efi_get_image_parameters(void **img_addr, size_t *img_size)
45 *img_addr = image_addr;
46 *img_size = image_size;
50 * efi_clear_bootdev() - clear boot device
52 static void efi_clear_bootdev(void)
54 efi_free_pool(bootefi_device_path);
55 efi_free_pool(bootefi_image_path);
56 bootefi_device_path = NULL;
57 bootefi_image_path = NULL;
63 * efi_set_bootdev() - set boot device
65 * This function is called when a file is loaded, e.g. via the 'load' command.
66 * We use the path to this file to inform the UEFI binary about the boot device.
68 * @dev: device, e.g. "MMC"
69 * @devnr: number of the device, e.g. "1:2"
70 * @path: path to file loaded
71 * @buffer: buffer with file loaded
72 * @buffer_size: size of file loaded
74 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
75 void *buffer, size_t buffer_size)
77 struct efi_device_path *device, *image;
80 log_debug("dev=%s, devnr=%s, path=%s, buffer=%p, size=%zx\n", dev,
81 devnr, path, buffer, buffer_size);
83 /* Forget overwritten image */
84 if (buffer + buffer_size >= image_addr &&
85 image_addr + image_size >= buffer)
88 /* Remember only PE-COFF and FIT images */
89 if (efi_check_pe(buffer, buffer_size, NULL) != EFI_SUCCESS) {
90 if (IS_ENABLED(CONFIG_FIT) &&
91 !fit_check_format(buffer, IMAGE_SIZE_INVAL)) {
93 * FIT images of type EFI_OS are started via command
94 * bootm. We should not use their boot device with the
100 log_debug("- not remembering image\n");
105 /* efi_set_bootdev() is typically called repeatedly, recover memory */
109 image_size = buffer_size;
111 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
112 if (ret == EFI_SUCCESS) {
113 bootefi_device_path = device;
115 /* FIXME: image should not contain device */
116 struct efi_device_path *image_tmp = image;
118 efi_dp_split_file_path(image, &device, &image);
119 efi_free_pool(image_tmp);
121 bootefi_image_path = image;
122 log_debug("- boot device %pD\n", device);
124 log_debug("- image %pD\n", image);
126 log_debug("- efi_dp_from_name() failed, err=%lx\n", ret);
132 * efi_env_set_load_options() - set load options from environment variable
134 * @handle: the image handle
135 * @env_var: name of the environment variable
136 * @load_options: pointer to load options (output)
137 * Return: status code
139 static efi_status_t efi_env_set_load_options(efi_handle_t handle,
143 const char *env = env_get(env_var);
148 *load_options = NULL;
151 size = sizeof(u16) * (utf8_utf16_strlen(env) + 1);
152 pos = calloc(size, 1);
154 return EFI_OUT_OF_RESOURCES;
156 utf8_utf16_strcpy(&pos, env);
157 ret = efi_set_load_options(handle, size, *load_options);
158 if (ret != EFI_SUCCESS) {
160 *load_options = NULL;
165 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
168 * copy_fdt() - Copy the device tree to a new location available to EFI
170 * The FDT is copied to a suitable location within the EFI memory map.
171 * Additional 12 KiB are added to the space in case the device tree needs to be
172 * expanded later with fdt_open_into().
174 * @fdtp: On entry a pointer to the flattened device tree.
175 * On exit a pointer to the copy of the flattened device tree.
177 * Return: status code
179 static efi_status_t copy_fdt(void **fdtp)
181 unsigned long fdt_ram_start = -1L, fdt_pages;
182 efi_status_t ret = 0;
188 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
189 u64 ram_start = gd->bd->bi_dram[i].start;
190 u64 ram_size = gd->bd->bi_dram[i].size;
195 if (ram_start < fdt_ram_start)
196 fdt_ram_start = ram_start;
200 * Give us at least 12 KiB of breathing room in case the device tree
201 * needs to be expanded later.
204 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
205 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
207 ret = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES,
208 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
210 if (ret != EFI_SUCCESS) {
211 log_err("ERROR: Failed to reserve space for FDT\n");
214 new_fdt = (void *)(uintptr_t)new_fdt_addr;
215 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
216 fdt_set_totalsize(new_fdt, fdt_size);
218 *fdtp = (void *)(uintptr_t)new_fdt_addr;
224 * get_config_table() - get configuration table
226 * @guid: GUID of the configuration table
227 * Return: pointer to configuration table or NULL
229 static void *get_config_table(const efi_guid_t *guid)
233 for (i = 0; i < systab.nr_tables; i++) {
234 if (!guidcmp(guid, &systab.tables[i].guid))
235 return systab.tables[i].table;
240 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
243 * efi_install_fdt() - install device tree
245 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
246 * address will will be installed as configuration table, otherwise the device
247 * tree located at the address indicated by environment variable fdt_addr or as
248 * fallback fdtcontroladdr will be used.
250 * On architectures using ACPI tables device trees shall not be installed as
251 * configuration table.
253 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
254 * the hardware device tree as indicated by environment variable
255 * fdt_addr or as fallback the internal device tree as indicated by
256 * the environment variable fdtcontroladdr
257 * Return: status code
259 efi_status_t efi_install_fdt(void *fdt)
262 * The EBBR spec requires that we have either an FDT or an ACPI table
265 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
267 log_warning("WARNING: Can't have ACPI table and device tree - ignoring DT.\n");
271 struct bootm_headers img = { 0 };
274 if (fdt == EFI_FDT_USE_INTERNAL) {
278 /* Look for device tree that is already installed */
279 if (get_config_table(&efi_guid_fdt))
281 /* Check if there is a hardware device tree */
282 fdt_opt = env_get("fdt_addr");
283 /* Use our own device tree as fallback */
285 fdt_opt = env_get("fdtcontroladdr");
287 log_err("ERROR: need device tree\n");
288 return EFI_NOT_FOUND;
291 fdt_addr = hextoul(fdt_opt, NULL);
293 log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
294 return EFI_LOAD_ERROR;
296 fdt = map_sysmem(fdt_addr, 0);
299 /* Install device tree */
300 if (fdt_check_header(fdt)) {
301 log_err("ERROR: invalid device tree\n");
302 return EFI_LOAD_ERROR;
305 /* Prepare device tree for payload */
306 ret = copy_fdt(&fdt);
308 log_err("ERROR: out of memory\n");
309 return EFI_OUT_OF_RESOURCES;
312 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
313 log_err("ERROR: failed to process device tree\n");
314 return EFI_LOAD_ERROR;
317 /* Create memory reservations as indicated by the device tree */
318 efi_carve_out_dt_rsv(fdt);
320 efi_try_purge_kaslr_seed(fdt);
322 if (CONFIG_IS_ENABLED(EFI_TCG2_PROTOCOL_MEASURE_DTB)) {
323 ret = efi_tcg2_measure_dtb(fdt);
324 if (ret == EFI_SECURITY_VIOLATION) {
325 log_err("ERROR: failed to measure DTB\n");
330 /* Install device tree as UEFI table */
331 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
332 if (ret != EFI_SUCCESS) {
333 log_err("ERROR: failed to install device tree\n");
336 #endif /* GENERATE_ACPI_TABLE */
342 * do_bootefi_exec() - execute EFI binary
344 * The image indicated by @handle is started. When it returns the allocated
345 * memory for the @load_options is freed.
347 * @handle: handle of loaded image
348 * @load_options: load options
349 * Return: status code
351 * Load the EFI binary into a newly assigned memory unwinding the relocation
352 * information, install the loaded image protocol, and call the binary.
354 static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
357 efi_uintn_t exit_data_size = 0;
358 u16 *exit_data = NULL;
360 /* On ARM switch from EL3 or secure mode to EL2 or non-secure mode */
361 switch_to_non_secure_mode();
364 * The UEFI standard requires that the watchdog timer is set to five
365 * minutes when invoking an EFI boot option.
367 * Unified Extensible Firmware Interface (UEFI), version 2.7 Errata A
368 * 7.5. Miscellaneous Boot Services - EFI_BOOT_SERVICES.SetWatchdogTimer
370 ret = efi_set_watchdog(300);
371 if (ret != EFI_SUCCESS) {
372 log_err("ERROR: Failed to set watchdog timer\n");
376 /* Call our payload! */
377 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
378 if (ret != EFI_SUCCESS) {
379 log_err("## Application failed, r = %lu\n",
380 ret & ~EFI_ERROR_MASK);
382 log_err("## %ls\n", exit_data);
383 efi_free_pool(exit_data);
392 if (IS_ENABLED(CONFIG_EFI_LOAD_FILE2_INITRD)) {
393 if (efi_initrd_deregister() != EFI_SUCCESS)
394 log_err("Failed to remove loadfile2 for initrd\n");
397 /* Control is returned to U-Boot, disable EFI watchdog */
404 * do_efibootmgr() - execute EFI boot manager
406 * Return: status code
408 static int do_efibootmgr(void)
414 ret = efi_bootmgr_load(&handle, &load_options);
415 if (ret != EFI_SUCCESS) {
416 log_notice("EFI boot manager: Cannot load any image\n");
417 return CMD_RET_FAILURE;
420 ret = do_bootefi_exec(handle, load_options);
422 if (ret != EFI_SUCCESS)
423 return CMD_RET_FAILURE;
425 return CMD_RET_SUCCESS;
429 * do_bootefi_image() - execute EFI binary
431 * Set up memory image for the binary to be loaded, prepare device path, and
432 * then call do_bootefi_exec() to execute it.
434 * @image_opt: string with image start address
435 * @size_opt: string with image size or NULL
436 * Return: status code
438 static int do_bootefi_image(const char *image_opt, const char *size_opt)
441 unsigned long addr, size;
444 #ifdef CONFIG_CMD_BOOTEFI_HELLO
445 if (!strcmp(image_opt, "hello")) {
446 image_buf = __efi_helloworld_begin;
447 size = __efi_helloworld_end - __efi_helloworld_begin;
452 addr = strtoul(image_opt, NULL, 16);
453 /* Check that a numeric value was passed */
455 return CMD_RET_USAGE;
456 image_buf = map_sysmem(addr, 0);
459 size = strtoul(size_opt, NULL, 16);
461 return CMD_RET_USAGE;
464 if (image_buf != image_addr) {
465 log_err("No UEFI binary known at %s\n",
467 return CMD_RET_FAILURE;
472 ret = efi_run_image(image_buf, size);
474 if (ret != EFI_SUCCESS)
475 return CMD_RET_FAILURE;
477 return CMD_RET_SUCCESS;
481 * efi_run_image() - run loaded UEFI image
483 * @source_buffer: memory address of the UEFI image
484 * @source_size: size of the UEFI image
485 * Return: status code
487 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
489 efi_handle_t mem_handle = NULL, handle;
490 struct efi_device_path *file_path = NULL;
491 struct efi_device_path *msg_path;
492 efi_status_t ret, ret2;
495 if (!bootefi_device_path || !bootefi_image_path) {
496 log_debug("Not loaded from disk\n");
498 * Special case for efi payload not loaded from disk,
499 * such as 'bootefi hello' or for example payload
500 * loaded directly into memory via JTAG, etc:
502 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
503 (uintptr_t)source_buffer,
506 * Make sure that device for device_path exist
507 * in load_image(). Otherwise, shell and grub will fail.
509 ret = efi_install_multiple_protocol_interfaces(&mem_handle,
510 &efi_guid_device_path,
512 if (ret != EFI_SUCCESS)
514 msg_path = file_path;
516 file_path = efi_dp_append(bootefi_device_path,
518 msg_path = bootefi_image_path;
519 log_debug("Loaded from disk\n");
522 log_info("Booting %pD\n", msg_path);
524 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
525 source_size, &handle));
526 if (ret != EFI_SUCCESS) {
527 log_err("Loading image failed\n");
531 /* Transfer environment variable as load options */
532 ret = efi_env_set_load_options(handle, "bootargs", &load_options);
533 if (ret != EFI_SUCCESS)
536 ret = do_bootefi_exec(handle, load_options);
539 ret2 = efi_uninstall_multiple_protocol_interfaces(mem_handle,
540 &efi_guid_device_path,
542 efi_free_pool(file_path);
543 return (ret != EFI_SUCCESS) ? ret : ret2;
546 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
547 static efi_status_t bootefi_run_prepare(const char *load_options_path,
548 struct efi_device_path *device_path,
549 struct efi_device_path *image_path,
550 struct efi_loaded_image_obj **image_objp,
551 struct efi_loaded_image **loaded_image_infop)
556 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
558 if (ret != EFI_SUCCESS)
561 /* Transfer environment variable as load options */
562 return efi_env_set_load_options((efi_handle_t)*image_objp,
568 * bootefi_test_prepare() - prepare to run an EFI test
570 * Prepare to run a test as if it were provided by a loaded image.
572 * @image_objp: pointer to be set to the loaded image handle
573 * @loaded_image_infop: pointer to be set to the loaded image protocol
574 * @path: dummy file path used to construct the device path
575 * set in the loaded image protocol
576 * @load_options_path: name of a U-Boot environment variable. Its value is
577 * set as load options in the loaded image protocol.
578 * Return: status code
580 static efi_status_t bootefi_test_prepare
581 (struct efi_loaded_image_obj **image_objp,
582 struct efi_loaded_image **loaded_image_infop, const char *path,
583 const char *load_options_path)
587 /* Construct a dummy device path */
588 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
589 if (!bootefi_device_path)
590 return EFI_OUT_OF_RESOURCES;
592 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
593 if (!bootefi_image_path) {
594 ret = EFI_OUT_OF_RESOURCES;
598 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
599 bootefi_image_path, image_objp,
601 if (ret == EFI_SUCCESS)
610 * bootefi_run_finish() - finish up after running an EFI test
612 * @loaded_image_info: Pointer to a struct which holds the loaded image info
613 * @image_obj: Pointer to a struct which holds the loaded image object
615 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
616 struct efi_loaded_image *loaded_image_info)
619 free(loaded_image_info->load_options);
620 efi_delete_handle(&image_obj->header);
624 * do_efi_selftest() - execute EFI selftest
626 * Return: status code
628 static int do_efi_selftest(void)
630 struct efi_loaded_image_obj *image_obj;
631 struct efi_loaded_image *loaded_image_info;
634 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
635 "\\selftest", "efi_selftest");
636 if (ret != EFI_SUCCESS)
637 return CMD_RET_FAILURE;
639 /* Execute the test */
640 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
641 bootefi_run_finish(image_obj, loaded_image_info);
643 return ret != EFI_SUCCESS;
645 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
648 * do_bootefi() - execute `bootefi` command
650 * @cmdtp: table entry describing command
651 * @flag: bitmap indicating how the command was invoked
652 * @argc: number of arguments
653 * @argv: command line arguments
654 * Return: status code
656 static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
660 char *img_addr, *img_size, *str_copy, *pos;
664 return CMD_RET_USAGE;
666 /* Initialize EFI drivers */
667 ret = efi_init_obj_list();
668 if (ret != EFI_SUCCESS) {
669 log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
670 ret & ~EFI_ERROR_MASK);
671 return CMD_RET_FAILURE;
677 fdt_addr = hextoul(argv[2], NULL);
678 fdt = map_sysmem(fdt_addr, 0);
680 fdt = EFI_FDT_USE_INTERNAL;
682 ret = efi_install_fdt(fdt);
683 if (ret == EFI_INVALID_PARAMETER)
684 return CMD_RET_USAGE;
685 else if (ret != EFI_SUCCESS)
686 return CMD_RET_FAILURE;
688 if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) {
689 if (!strcmp(argv[1], "bootmgr"))
690 return do_efibootmgr();
692 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
693 if (!strcmp(argv[1], "selftest"))
694 return do_efi_selftest();
696 str_copy = strdup(argv[1]);
698 log_err("Out of memory\n");
699 return CMD_RET_FAILURE;
702 img_addr = strsep(&pos, ":");
703 img_size = strsep(&pos, ":");
704 ret = do_bootefi_image(img_addr, img_size);
710 #ifdef CONFIG_SYS_LONGHELP
711 static char bootefi_help_text[] =
712 "<image address>[:<image size>] [<fdt address>]\n"
713 " - boot EFI payload\n"
714 #ifdef CONFIG_CMD_BOOTEFI_HELLO
716 " - boot a sample Hello World application stored within U-Boot\n"
718 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
719 "bootefi selftest [fdt address]\n"
720 " - boot an EFI selftest application stored within U-Boot\n"
721 " Use environment variable efi_selftest to select a single test.\n"
722 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
724 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
725 "bootefi bootmgr [fdt address]\n"
726 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
728 " If specified, the device tree located at <fdt address> gets\n"
729 " exposed as EFI configuration table.\n"
735 bootefi, 4, 0, do_bootefi,
736 "Boots an EFI payload from memory",