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;
208 * Safe fdt location is at 127 MiB.
209 * On the sandbox convert from the sandbox address space.
211 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
213 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
214 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
216 if (ret != EFI_SUCCESS) {
217 /* If we can't put it there, put it somewhere */
218 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
219 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
220 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
222 if (ret != EFI_SUCCESS) {
223 log_err("ERROR: Failed to reserve space for FDT\n");
227 new_fdt = (void *)(uintptr_t)new_fdt_addr;
228 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
229 fdt_set_totalsize(new_fdt, fdt_size);
231 *fdtp = (void *)(uintptr_t)new_fdt_addr;
237 * get_config_table() - get configuration table
239 * @guid: GUID of the configuration table
240 * Return: pointer to configuration table or NULL
242 static void *get_config_table(const efi_guid_t *guid)
246 for (i = 0; i < systab.nr_tables; i++) {
247 if (!guidcmp(guid, &systab.tables[i].guid))
248 return systab.tables[i].table;
253 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
256 * efi_install_fdt() - install device tree
258 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
259 * address will will be installed as configuration table, otherwise the device
260 * tree located at the address indicated by environment variable fdt_addr or as
261 * fallback fdtcontroladdr will be used.
263 * On architectures using ACPI tables device trees shall not be installed as
264 * configuration table.
266 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
267 * the hardware device tree as indicated by environment variable
268 * fdt_addr or as fallback the internal device tree as indicated by
269 * the environment variable fdtcontroladdr
270 * Return: status code
272 efi_status_t efi_install_fdt(void *fdt)
275 * The EBBR spec requires that we have either an FDT or an ACPI table
278 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
280 log_warning("WARNING: Can't have ACPI table and device tree - ignoring DT.\n");
284 struct bootm_headers img = { 0 };
287 if (fdt == EFI_FDT_USE_INTERNAL) {
291 /* Look for device tree that is already installed */
292 if (get_config_table(&efi_guid_fdt))
294 /* Check if there is a hardware device tree */
295 fdt_opt = env_get("fdt_addr");
296 /* Use our own device tree as fallback */
298 fdt_opt = env_get("fdtcontroladdr");
300 log_err("ERROR: need device tree\n");
301 return EFI_NOT_FOUND;
304 fdt_addr = hextoul(fdt_opt, NULL);
306 log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
307 return EFI_LOAD_ERROR;
309 fdt = map_sysmem(fdt_addr, 0);
312 /* Install device tree */
313 if (fdt_check_header(fdt)) {
314 log_err("ERROR: invalid device tree\n");
315 return EFI_LOAD_ERROR;
318 /* Prepare device tree for payload */
319 ret = copy_fdt(&fdt);
321 log_err("ERROR: out of memory\n");
322 return EFI_OUT_OF_RESOURCES;
325 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
326 log_err("ERROR: failed to process device tree\n");
327 return EFI_LOAD_ERROR;
330 /* Create memory reservations as indicated by the device tree */
331 efi_carve_out_dt_rsv(fdt);
333 efi_try_purge_kaslr_seed(fdt);
335 /* Install device tree as UEFI table */
336 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
337 if (ret != EFI_SUCCESS) {
338 log_err("ERROR: failed to install device tree\n");
341 #endif /* GENERATE_ACPI_TABLE */
347 * do_bootefi_exec() - execute EFI binary
349 * The image indicated by @handle is started. When it returns the allocated
350 * memory for the @load_options is freed.
352 * @handle: handle of loaded image
353 * @load_options: load options
354 * Return: status code
356 * Load the EFI binary into a newly assigned memory unwinding the relocation
357 * information, install the loaded image protocol, and call the binary.
359 static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
362 efi_uintn_t exit_data_size = 0;
363 u16 *exit_data = NULL;
365 /* On ARM switch from EL3 or secure mode to EL2 or non-secure mode */
366 switch_to_non_secure_mode();
369 * The UEFI standard requires that the watchdog timer is set to five
370 * minutes when invoking an EFI boot option.
372 * Unified Extensible Firmware Interface (UEFI), version 2.7 Errata A
373 * 7.5. Miscellaneous Boot Services - EFI_BOOT_SERVICES.SetWatchdogTimer
375 ret = efi_set_watchdog(300);
376 if (ret != EFI_SUCCESS) {
377 log_err("ERROR: Failed to set watchdog timer\n");
381 /* Call our payload! */
382 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
383 if (ret != EFI_SUCCESS) {
384 log_err("## Application failed, r = %lu\n",
385 ret & ~EFI_ERROR_MASK);
387 log_err("## %ls\n", exit_data);
388 efi_free_pool(exit_data);
397 if (IS_ENABLED(CONFIG_EFI_LOAD_FILE2_INITRD))
398 efi_initrd_deregister();
400 /* Control is returned to U-Boot, disable EFI watchdog */
407 * do_efibootmgr() - execute EFI boot manager
409 * Return: status code
411 static int do_efibootmgr(void)
417 ret = efi_bootmgr_load(&handle, &load_options);
418 if (ret != EFI_SUCCESS) {
419 log_notice("EFI boot manager: Cannot load any image\n");
420 return CMD_RET_FAILURE;
423 ret = do_bootefi_exec(handle, load_options);
425 if (ret != EFI_SUCCESS)
426 return CMD_RET_FAILURE;
428 return CMD_RET_SUCCESS;
432 * do_bootefi_image() - execute EFI binary
434 * Set up memory image for the binary to be loaded, prepare device path, and
435 * then call do_bootefi_exec() to execute it.
437 * @image_opt: string with image start address
438 * @size_opt: string with image size or NULL
439 * Return: status code
441 static int do_bootefi_image(const char *image_opt, const char *size_opt)
444 unsigned long addr, size;
447 #ifdef CONFIG_CMD_BOOTEFI_HELLO
448 if (!strcmp(image_opt, "hello")) {
449 image_buf = __efi_helloworld_begin;
450 size = __efi_helloworld_end - __efi_helloworld_begin;
455 addr = strtoul(image_opt, NULL, 16);
456 /* Check that a numeric value was passed */
458 return CMD_RET_USAGE;
459 image_buf = map_sysmem(addr, 0);
462 size = strtoul(size_opt, NULL, 16);
464 return CMD_RET_USAGE;
467 if (image_buf != image_addr) {
468 log_err("No UEFI binary known at %s\n",
470 return CMD_RET_FAILURE;
475 ret = efi_run_image(image_buf, size);
477 if (ret != EFI_SUCCESS)
478 return CMD_RET_FAILURE;
480 return CMD_RET_SUCCESS;
484 * efi_run_image() - run loaded UEFI image
486 * @source_buffer: memory address of the UEFI image
487 * @source_size: size of the UEFI image
488 * Return: status code
490 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
492 efi_handle_t mem_handle = NULL, handle;
493 struct efi_device_path *file_path = NULL;
494 struct efi_device_path *msg_path;
498 if (!bootefi_device_path || !bootefi_image_path) {
499 log_debug("Not loaded from disk\n");
501 * Special case for efi payload not loaded from disk,
502 * such as 'bootefi hello' or for example payload
503 * loaded directly into memory via JTAG, etc:
505 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
506 (uintptr_t)source_buffer,
509 * Make sure that device for device_path exist
510 * in load_image(). Otherwise, shell and grub will fail.
512 ret = efi_create_handle(&mem_handle);
513 if (ret != EFI_SUCCESS)
516 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
518 if (ret != EFI_SUCCESS)
520 msg_path = file_path;
522 file_path = efi_dp_append(bootefi_device_path,
524 msg_path = bootefi_image_path;
525 log_debug("Loaded from disk\n");
528 log_info("Booting %pD\n", msg_path);
530 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
531 source_size, &handle));
532 if (ret != EFI_SUCCESS) {
533 log_err("Loading image failed\n");
537 /* Transfer environment variable as load options */
538 ret = efi_env_set_load_options(handle, "bootargs", &load_options);
539 if (ret != EFI_SUCCESS)
542 ret = do_bootefi_exec(handle, load_options);
545 efi_delete_handle(mem_handle);
546 efi_free_pool(file_path);
550 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
551 static efi_status_t bootefi_run_prepare(const char *load_options_path,
552 struct efi_device_path *device_path,
553 struct efi_device_path *image_path,
554 struct efi_loaded_image_obj **image_objp,
555 struct efi_loaded_image **loaded_image_infop)
560 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
562 if (ret != EFI_SUCCESS)
565 /* Transfer environment variable as load options */
566 return efi_env_set_load_options((efi_handle_t)*image_objp,
572 * bootefi_test_prepare() - prepare to run an EFI test
574 * Prepare to run a test as if it were provided by a loaded image.
576 * @image_objp: pointer to be set to the loaded image handle
577 * @loaded_image_infop: pointer to be set to the loaded image protocol
578 * @path: dummy file path used to construct the device path
579 * set in the loaded image protocol
580 * @load_options_path: name of a U-Boot environment variable. Its value is
581 * set as load options in the loaded image protocol.
582 * Return: status code
584 static efi_status_t bootefi_test_prepare
585 (struct efi_loaded_image_obj **image_objp,
586 struct efi_loaded_image **loaded_image_infop, const char *path,
587 const char *load_options_path)
591 /* Construct a dummy device path */
592 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
593 if (!bootefi_device_path)
594 return EFI_OUT_OF_RESOURCES;
596 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
597 if (!bootefi_image_path) {
598 ret = EFI_OUT_OF_RESOURCES;
602 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
603 bootefi_image_path, image_objp,
605 if (ret == EFI_SUCCESS)
614 * bootefi_run_finish() - finish up after running an EFI test
616 * @loaded_image_info: Pointer to a struct which holds the loaded image info
617 * @image_obj: Pointer to a struct which holds the loaded image object
619 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
620 struct efi_loaded_image *loaded_image_info)
623 free(loaded_image_info->load_options);
624 efi_delete_handle(&image_obj->header);
628 * do_efi_selftest() - execute EFI selftest
630 * Return: status code
632 static int do_efi_selftest(void)
634 struct efi_loaded_image_obj *image_obj;
635 struct efi_loaded_image *loaded_image_info;
638 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
639 "\\selftest", "efi_selftest");
640 if (ret != EFI_SUCCESS)
641 return CMD_RET_FAILURE;
643 /* Execute the test */
644 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
645 bootefi_run_finish(image_obj, loaded_image_info);
647 return ret != EFI_SUCCESS;
649 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
652 * do_bootefi() - execute `bootefi` command
654 * @cmdtp: table entry describing command
655 * @flag: bitmap indicating how the command was invoked
656 * @argc: number of arguments
657 * @argv: command line arguments
658 * Return: status code
660 static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
664 char *img_addr, *img_size, *str_copy, *pos;
668 return CMD_RET_USAGE;
670 /* Initialize EFI drivers */
671 ret = efi_init_obj_list();
672 if (ret != EFI_SUCCESS) {
673 log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
674 ret & ~EFI_ERROR_MASK);
675 return CMD_RET_FAILURE;
681 fdt_addr = hextoul(argv[2], NULL);
682 fdt = map_sysmem(fdt_addr, 0);
684 fdt = EFI_FDT_USE_INTERNAL;
686 ret = efi_install_fdt(fdt);
687 if (ret == EFI_INVALID_PARAMETER)
688 return CMD_RET_USAGE;
689 else if (ret != EFI_SUCCESS)
690 return CMD_RET_FAILURE;
692 if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) {
693 if (!strcmp(argv[1], "bootmgr"))
694 return do_efibootmgr();
696 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
697 if (!strcmp(argv[1], "selftest"))
698 return do_efi_selftest();
700 str_copy = strdup(argv[1]);
702 log_err("Out of memory\n");
703 return CMD_RET_FAILURE;
706 img_addr = strsep(&pos, ":");
707 img_size = strsep(&pos, ":");
708 ret = do_bootefi_image(img_addr, img_size);
714 #ifdef CONFIG_SYS_LONGHELP
715 static char bootefi_help_text[] =
716 "<image address>[:<image size>] [<fdt address>]\n"
717 " - boot EFI payload\n"
718 #ifdef CONFIG_CMD_BOOTEFI_HELLO
720 " - boot a sample Hello World application stored within U-Boot\n"
722 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
723 "bootefi selftest [fdt address]\n"
724 " - boot an EFI selftest application stored within U-Boot\n"
725 " Use environment variable efi_selftest to select a single test.\n"
726 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
728 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
729 "bootefi bootmgr [fdt address]\n"
730 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
732 " If specified, the device tree located at <fdt address> gets\n"
733 " exposed as EFI configuration table.\n"
739 bootefi, 4, 0, do_bootefi,
740 "Boots an EFI payload from memory",