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_clear_bootdev() - clear boot device
40 static void efi_clear_bootdev(void)
42 efi_free_pool(bootefi_device_path);
43 efi_free_pool(bootefi_image_path);
44 bootefi_device_path = NULL;
45 bootefi_image_path = NULL;
51 * efi_set_bootdev() - set boot device
53 * This function is called when a file is loaded, e.g. via the 'load' command.
54 * We use the path to this file to inform the UEFI binary about the boot device.
56 * @dev: device, e.g. "MMC"
57 * @devnr: number of the device, e.g. "1:2"
58 * @path: path to file loaded
59 * @buffer: buffer with file loaded
60 * @buffer_size: size of file loaded
62 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
63 void *buffer, size_t buffer_size)
65 struct efi_device_path *device, *image;
68 log_debug("dev=%s, devnr=%s, path=%s, buffer=%p, size=%zx\n", dev,
69 devnr, path, buffer, buffer_size);
71 /* Forget overwritten image */
72 if (buffer + buffer_size >= image_addr &&
73 image_addr + image_size >= buffer)
76 /* Remember only PE-COFF and FIT images */
77 if (efi_check_pe(buffer, buffer_size, NULL) != EFI_SUCCESS) {
78 if (IS_ENABLED(CONFIG_FIT) &&
79 !fit_check_format(buffer, IMAGE_SIZE_INVAL)) {
81 * FIT images of type EFI_OS are started via command
82 * bootm. We should not use their boot device with the
88 log_debug("- not remembering image\n");
93 /* efi_set_bootdev() is typically called repeatedly, recover memory */
97 image_size = buffer_size;
99 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
100 if (ret == EFI_SUCCESS) {
101 bootefi_device_path = device;
103 /* FIXME: image should not contain device */
104 struct efi_device_path *image_tmp = image;
106 efi_dp_split_file_path(image, &device, &image);
107 efi_free_pool(image_tmp);
109 bootefi_image_path = image;
110 log_debug("- recorded device %ls\n", efi_dp_str(device));
112 log_debug("- and image %ls\n", efi_dp_str(image));
114 log_debug("- efi_dp_from_name() failed, err=%lx\n", ret);
120 * efi_env_set_load_options() - set load options from environment variable
122 * @handle: the image handle
123 * @env_var: name of the environment variable
124 * @load_options: pointer to load options (output)
125 * Return: status code
127 static efi_status_t efi_env_set_load_options(efi_handle_t handle,
131 const char *env = env_get(env_var);
136 *load_options = NULL;
139 size = sizeof(u16) * (utf8_utf16_strlen(env) + 1);
140 pos = calloc(size, 1);
142 return EFI_OUT_OF_RESOURCES;
144 utf8_utf16_strcpy(&pos, env);
145 ret = efi_set_load_options(handle, size, *load_options);
146 if (ret != EFI_SUCCESS) {
148 *load_options = NULL;
153 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
156 * copy_fdt() - Copy the device tree to a new location available to EFI
158 * The FDT is copied to a suitable location within the EFI memory map.
159 * Additional 12 KiB are added to the space in case the device tree needs to be
160 * expanded later with fdt_open_into().
162 * @fdtp: On entry a pointer to the flattened device tree.
163 * On exit a pointer to the copy of the flattened device tree.
165 * Return: status code
167 static efi_status_t copy_fdt(void **fdtp)
169 unsigned long fdt_ram_start = -1L, fdt_pages;
170 efi_status_t ret = 0;
176 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
177 u64 ram_start = gd->bd->bi_dram[i].start;
178 u64 ram_size = gd->bd->bi_dram[i].size;
183 if (ram_start < fdt_ram_start)
184 fdt_ram_start = ram_start;
188 * Give us at least 12 KiB of breathing room in case the device tree
189 * needs to be expanded later.
192 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
193 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
196 * Safe fdt location is at 127 MiB.
197 * On the sandbox convert from the sandbox address space.
199 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
201 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
202 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
204 if (ret != EFI_SUCCESS) {
205 /* If we can't put it there, put it somewhere */
206 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
207 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
208 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
210 if (ret != EFI_SUCCESS) {
211 log_err("ERROR: Failed to reserve space for FDT\n");
215 new_fdt = (void *)(uintptr_t)new_fdt_addr;
216 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
217 fdt_set_totalsize(new_fdt, fdt_size);
219 *fdtp = (void *)(uintptr_t)new_fdt_addr;
225 * get_config_table() - get configuration table
227 * @guid: GUID of the configuration table
228 * Return: pointer to configuration table or NULL
230 static void *get_config_table(const efi_guid_t *guid)
234 for (i = 0; i < systab.nr_tables; i++) {
235 if (!guidcmp(guid, &systab.tables[i].guid))
236 return systab.tables[i].table;
241 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
244 * efi_install_fdt() - install device tree
246 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
247 * address will will be installed as configuration table, otherwise the device
248 * tree located at the address indicated by environment variable fdt_addr or as
249 * fallback fdtcontroladdr will be used.
251 * On architectures using ACPI tables device trees shall not be installed as
252 * configuration table.
254 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
255 * the hardware device tree as indicated by environment variable
256 * fdt_addr or as fallback the internal device tree as indicated by
257 * the environment variable fdtcontroladdr
258 * Return: status code
260 efi_status_t efi_install_fdt(void *fdt)
263 * The EBBR spec requires that we have either an FDT or an ACPI table
266 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
268 log_warning("WARNING: Can't have ACPI table and device tree - ignoring DT.\n");
272 bootm_headers_t img = { 0 };
275 if (fdt == EFI_FDT_USE_INTERNAL) {
279 /* Look for device tree that is already installed */
280 if (get_config_table(&efi_guid_fdt))
282 /* Check if there is a hardware device tree */
283 fdt_opt = env_get("fdt_addr");
284 /* Use our own device tree as fallback */
286 fdt_opt = env_get("fdtcontroladdr");
288 log_err("ERROR: need device tree\n");
289 return EFI_NOT_FOUND;
292 fdt_addr = hextoul(fdt_opt, NULL);
294 log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
295 return EFI_LOAD_ERROR;
297 fdt = map_sysmem(fdt_addr, 0);
300 /* Install device tree */
301 if (fdt_check_header(fdt)) {
302 log_err("ERROR: invalid device tree\n");
303 return EFI_LOAD_ERROR;
306 /* Prepare device tree for payload */
307 ret = copy_fdt(&fdt);
309 log_err("ERROR: out of memory\n");
310 return EFI_OUT_OF_RESOURCES;
313 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
314 log_err("ERROR: failed to process device tree\n");
315 return EFI_LOAD_ERROR;
318 /* Create memory reservations as indicated by the device tree */
319 efi_carve_out_dt_rsv(fdt);
321 efi_try_purge_kaslr_seed(fdt);
323 /* Install device tree as UEFI table */
324 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
325 if (ret != EFI_SUCCESS) {
326 log_err("ERROR: failed to install device tree\n");
329 #endif /* GENERATE_ACPI_TABLE */
335 * do_bootefi_exec() - execute EFI binary
337 * The image indicated by @handle is started. When it returns the allocated
338 * memory for the @load_options is freed.
340 * @handle: handle of loaded image
341 * @load_options: load options
342 * Return: status code
344 * Load the EFI binary into a newly assigned memory unwinding the relocation
345 * information, install the loaded image protocol, and call the binary.
347 static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
350 efi_uintn_t exit_data_size = 0;
351 u16 *exit_data = NULL;
353 /* On ARM switch from EL3 or secure mode to EL2 or non-secure mode */
354 switch_to_non_secure_mode();
357 * The UEFI standard requires that the watchdog timer is set to five
358 * minutes when invoking an EFI boot option.
360 * Unified Extensible Firmware Interface (UEFI), version 2.7 Errata A
361 * 7.5. Miscellaneous Boot Services - EFI_BOOT_SERVICES.SetWatchdogTimer
363 ret = efi_set_watchdog(300);
364 if (ret != EFI_SUCCESS) {
365 log_err("ERROR: Failed to set watchdog timer\n");
369 /* Call our payload! */
370 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
371 if (ret != EFI_SUCCESS) {
372 log_err("## Application failed, r = %lu\n",
373 ret & ~EFI_ERROR_MASK);
375 log_err("## %ls\n", exit_data);
376 efi_free_pool(exit_data);
385 if (IS_ENABLED(CONFIG_EFI_LOAD_FILE2_INITRD))
386 efi_initrd_deregister();
388 /* Control is returned to U-Boot, disable EFI watchdog */
395 * do_efibootmgr() - execute EFI boot manager
397 * Return: status code
399 static int do_efibootmgr(void)
405 ret = efi_bootmgr_load(&handle, &load_options);
406 if (ret != EFI_SUCCESS) {
407 log_notice("EFI boot manager: Cannot load any image\n");
408 return CMD_RET_FAILURE;
411 ret = do_bootefi_exec(handle, load_options);
413 if (ret != EFI_SUCCESS)
414 return CMD_RET_FAILURE;
416 return CMD_RET_SUCCESS;
420 * do_bootefi_image() - execute EFI binary
422 * Set up memory image for the binary to be loaded, prepare device path, and
423 * then call do_bootefi_exec() to execute it.
425 * @image_opt: string with image start address
426 * @size_opt: string with image size or NULL
427 * Return: status code
429 static int do_bootefi_image(const char *image_opt, const char *size_opt)
432 unsigned long addr, size;
435 #ifdef CONFIG_CMD_BOOTEFI_HELLO
436 if (!strcmp(image_opt, "hello")) {
437 image_buf = __efi_helloworld_begin;
438 size = __efi_helloworld_end - __efi_helloworld_begin;
443 addr = strtoul(image_opt, NULL, 16);
444 /* Check that a numeric value was passed */
446 return CMD_RET_USAGE;
447 image_buf = map_sysmem(addr, 0);
450 size = strtoul(size_opt, NULL, 16);
452 return CMD_RET_USAGE;
455 if (image_buf != image_addr) {
456 log_err("No UEFI binary known at %s\n",
458 return CMD_RET_FAILURE;
463 ret = efi_run_image(image_buf, size);
465 if (ret != EFI_SUCCESS)
466 return CMD_RET_FAILURE;
468 return CMD_RET_SUCCESS;
472 * efi_run_image() - run loaded UEFI image
474 * @source_buffer: memory address of the UEFI image
475 * @source_size: size of the UEFI image
476 * Return: status code
478 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
480 efi_handle_t mem_handle = NULL, handle;
481 struct efi_device_path *file_path = NULL;
482 struct efi_device_path *msg_path;
486 if (!bootefi_device_path || !bootefi_image_path) {
487 log_debug("Not loaded from disk\n");
489 * Special case for efi payload not loaded from disk,
490 * such as 'bootefi hello' or for example payload
491 * loaded directly into memory via JTAG, etc:
493 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
494 (uintptr_t)source_buffer,
497 * Make sure that device for device_path exist
498 * in load_image(). Otherwise, shell and grub will fail.
500 ret = efi_create_handle(&mem_handle);
501 if (ret != EFI_SUCCESS)
504 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
506 if (ret != EFI_SUCCESS)
508 msg_path = file_path;
510 file_path = efi_dp_append(bootefi_device_path,
512 msg_path = bootefi_image_path;
513 log_debug("Loaded from disk\n");
516 log_info("Booting %pD\n", msg_path);
518 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
519 source_size, &handle));
520 if (ret != EFI_SUCCESS) {
521 log_err("Loading image failed\n");
525 /* Transfer environment variable as load options */
526 ret = efi_env_set_load_options(handle, "bootargs", &load_options);
527 if (ret != EFI_SUCCESS)
530 ret = do_bootefi_exec(handle, load_options);
533 efi_delete_handle(mem_handle);
534 efi_free_pool(file_path);
538 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
539 static efi_status_t bootefi_run_prepare(const char *load_options_path,
540 struct efi_device_path *device_path,
541 struct efi_device_path *image_path,
542 struct efi_loaded_image_obj **image_objp,
543 struct efi_loaded_image **loaded_image_infop)
548 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
550 if (ret != EFI_SUCCESS)
553 /* Transfer environment variable as load options */
554 return efi_env_set_load_options((efi_handle_t)*image_objp,
560 * bootefi_test_prepare() - prepare to run an EFI test
562 * Prepare to run a test as if it were provided by a loaded image.
564 * @image_objp: pointer to be set to the loaded image handle
565 * @loaded_image_infop: pointer to be set to the loaded image protocol
566 * @path: dummy file path used to construct the device path
567 * set in the loaded image protocol
568 * @load_options_path: name of a U-Boot environment variable. Its value is
569 * set as load options in the loaded image protocol.
570 * Return: status code
572 static efi_status_t bootefi_test_prepare
573 (struct efi_loaded_image_obj **image_objp,
574 struct efi_loaded_image **loaded_image_infop, const char *path,
575 const char *load_options_path)
579 /* Construct a dummy device path */
580 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
581 if (!bootefi_device_path)
582 return EFI_OUT_OF_RESOURCES;
584 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
585 if (!bootefi_image_path) {
586 ret = EFI_OUT_OF_RESOURCES;
590 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
591 bootefi_image_path, image_objp,
593 if (ret == EFI_SUCCESS)
602 * bootefi_run_finish() - finish up after running an EFI test
604 * @loaded_image_info: Pointer to a struct which holds the loaded image info
605 * @image_obj: Pointer to a struct which holds the loaded image object
607 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
608 struct efi_loaded_image *loaded_image_info)
611 free(loaded_image_info->load_options);
612 efi_delete_handle(&image_obj->header);
616 * do_efi_selftest() - execute EFI selftest
618 * Return: status code
620 static int do_efi_selftest(void)
622 struct efi_loaded_image_obj *image_obj;
623 struct efi_loaded_image *loaded_image_info;
626 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
627 "\\selftest", "efi_selftest");
628 if (ret != EFI_SUCCESS)
629 return CMD_RET_FAILURE;
631 /* Execute the test */
632 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
633 bootefi_run_finish(image_obj, loaded_image_info);
635 return ret != EFI_SUCCESS;
637 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
640 * do_bootefi() - execute `bootefi` command
642 * @cmdtp: table entry describing command
643 * @flag: bitmap indicating how the command was invoked
644 * @argc: number of arguments
645 * @argv: command line arguments
646 * Return: status code
648 static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
652 char *img_addr, *img_size, *str_copy, *pos;
656 return CMD_RET_USAGE;
658 /* Initialize EFI drivers */
659 ret = efi_init_obj_list();
660 if (ret != EFI_SUCCESS) {
661 log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
662 ret & ~EFI_ERROR_MASK);
663 return CMD_RET_FAILURE;
669 fdt_addr = hextoul(argv[2], NULL);
670 fdt = map_sysmem(fdt_addr, 0);
672 fdt = EFI_FDT_USE_INTERNAL;
674 ret = efi_install_fdt(fdt);
675 if (ret == EFI_INVALID_PARAMETER)
676 return CMD_RET_USAGE;
677 else if (ret != EFI_SUCCESS)
678 return CMD_RET_FAILURE;
680 if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) {
681 if (!strcmp(argv[1], "bootmgr"))
682 return do_efibootmgr();
684 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
685 if (!strcmp(argv[1], "selftest"))
686 return do_efi_selftest();
688 str_copy = strdup(argv[1]);
690 log_err("Out of memory\n");
691 return CMD_RET_FAILURE;
694 img_addr = strsep(&pos, ":");
695 img_size = strsep(&pos, ":");
696 ret = do_bootefi_image(img_addr, img_size);
702 #ifdef CONFIG_SYS_LONGHELP
703 static char bootefi_help_text[] =
704 "<image address>[:<image size>] [<fdt address>]\n"
705 " - boot EFI payload\n"
706 #ifdef CONFIG_CMD_BOOTEFI_HELLO
708 " - boot a sample Hello World application stored within U-Boot\n"
710 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
711 "bootefi selftest [fdt address]\n"
712 " - boot an EFI selftest application stored within U-Boot\n"
713 " Use environment variable efi_selftest to select a single test.\n"
714 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
716 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
717 "bootefi bootmgr [fdt address]\n"
718 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
720 " If specified, the device tree located at <fdt address> gets\n"
721 " exposed as EFI configuration table.\n"
727 bootefi, 4, 0, do_bootefi,
728 "Boots an EFI payload from memory",