1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
8 #define LOG_CATEGORY LOGC_EFI
14 #include <efi_loader.h>
15 #include <efi_selftest.h>
21 #include <linux/libfdt.h>
22 #include <linux/libfdt_env.h>
25 #include <asm-generic/sections.h>
26 #include <linux/linkage.h>
28 DECLARE_GLOBAL_DATA_PTR;
30 static struct efi_device_path *bootefi_image_path;
31 static struct efi_device_path *bootefi_device_path;
32 static void *image_addr;
33 static size_t image_size;
36 * efi_clear_bootdev() - clear boot device
38 static void efi_clear_bootdev(void)
40 efi_free_pool(bootefi_device_path);
41 efi_free_pool(bootefi_image_path);
42 bootefi_device_path = NULL;
43 bootefi_image_path = NULL;
49 * efi_set_bootdev() - set boot device
51 * This function is called when a file is loaded, e.g. via the 'load' command.
52 * We use the path to this file to inform the UEFI binary about the boot device.
54 * @dev: device, e.g. "MMC"
55 * @devnr: number of the device, e.g. "1:2"
56 * @path: path to file loaded
57 * @buffer: buffer with file loaded
58 * @buffer_size: size of file loaded
60 void efi_set_bootdev(const char *dev, const char *devnr, const char *path,
61 void *buffer, size_t buffer_size)
63 struct efi_device_path *device, *image;
66 /* Forget overwritten image */
67 if (buffer + buffer_size >= image_addr &&
68 image_addr + image_size >= buffer)
71 /* Remember only PE-COFF and FIT images */
72 if (efi_check_pe(buffer, buffer_size, NULL) != EFI_SUCCESS) {
74 if (!fit_check_format(buffer))
77 * FIT images of type EFI_OS are started via command bootm.
78 * We should not use their boot device with the bootefi command.
87 /* efi_set_bootdev() is typically called repeatedly, recover memory */
91 image_size = buffer_size;
93 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
94 if (ret == EFI_SUCCESS) {
95 bootefi_device_path = device;
97 /* FIXME: image should not contain device */
98 struct efi_device_path *image_tmp = image;
100 efi_dp_split_file_path(image, &device, &image);
101 efi_free_pool(image_tmp);
103 bootefi_image_path = image;
110 * efi_env_set_load_options() - set load options from environment variable
112 * @handle: the image handle
113 * @env_var: name of the environment variable
114 * @load_options: pointer to load options (output)
115 * Return: status code
117 static efi_status_t efi_env_set_load_options(efi_handle_t handle,
121 const char *env = env_get(env_var);
126 *load_options = NULL;
129 size = sizeof(u16) * (utf8_utf16_strlen(env) + 1);
130 pos = calloc(size, 1);
132 return EFI_OUT_OF_RESOURCES;
134 utf8_utf16_strcpy(&pos, env);
135 ret = efi_set_load_options(handle, size, *load_options);
136 if (ret != EFI_SUCCESS) {
138 *load_options = NULL;
143 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
146 * copy_fdt() - Copy the device tree to a new location available to EFI
148 * The FDT is copied to a suitable location within the EFI memory map.
149 * Additional 12 KiB are added to the space in case the device tree needs to be
150 * expanded later with fdt_open_into().
152 * @fdtp: On entry a pointer to the flattened device tree.
153 * On exit a pointer to the copy of the flattened device tree.
155 * Return: status code
157 static efi_status_t copy_fdt(void **fdtp)
159 unsigned long fdt_ram_start = -1L, fdt_pages;
160 efi_status_t ret = 0;
166 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
167 u64 ram_start = gd->bd->bi_dram[i].start;
168 u64 ram_size = gd->bd->bi_dram[i].size;
173 if (ram_start < fdt_ram_start)
174 fdt_ram_start = ram_start;
178 * Give us at least 12 KiB of breathing room in case the device tree
179 * needs to be expanded later.
182 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
183 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
186 * Safe fdt location is at 127 MiB.
187 * On the sandbox convert from the sandbox address space.
189 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
191 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
192 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
194 if (ret != EFI_SUCCESS) {
195 /* If we can't put it there, put it somewhere */
196 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
197 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
198 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
200 if (ret != EFI_SUCCESS) {
201 log_err("ERROR: Failed to reserve space for FDT\n");
205 new_fdt = (void *)(uintptr_t)new_fdt_addr;
206 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
207 fdt_set_totalsize(new_fdt, fdt_size);
209 *fdtp = (void *)(uintptr_t)new_fdt_addr;
215 * get_config_table() - get configuration table
217 * @guid: GUID of the configuration table
218 * Return: pointer to configuration table or NULL
220 static void *get_config_table(const efi_guid_t *guid)
224 for (i = 0; i < systab.nr_tables; i++) {
225 if (!guidcmp(guid, &systab.tables[i].guid))
226 return systab.tables[i].table;
231 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
234 * efi_install_fdt() - install device tree
236 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
237 * address will will be installed as configuration table, otherwise the device
238 * tree located at the address indicated by environment variable fdt_addr or as
239 * fallback fdtcontroladdr will be used.
241 * On architectures using ACPI tables device trees shall not be installed as
242 * configuration table.
244 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
245 * the hardware device tree as indicated by environment variable
246 * fdt_addr or as fallback the internal device tree as indicated by
247 * the environment variable fdtcontroladdr
248 * Return: status code
250 efi_status_t efi_install_fdt(void *fdt)
253 * The EBBR spec requires that we have either an FDT or an ACPI table
256 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
258 log_err("ERROR: can't have ACPI table and device tree.\n");
259 return EFI_LOAD_ERROR;
262 bootm_headers_t img = { 0 };
265 if (fdt == EFI_FDT_USE_INTERNAL) {
269 /* Look for device tree that is already installed */
270 if (get_config_table(&efi_guid_fdt))
272 /* Check if there is a hardware device tree */
273 fdt_opt = env_get("fdt_addr");
274 /* Use our own device tree as fallback */
276 fdt_opt = env_get("fdtcontroladdr");
278 log_err("ERROR: need device tree\n");
279 return EFI_NOT_FOUND;
282 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
284 log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
285 return EFI_LOAD_ERROR;
287 fdt = map_sysmem(fdt_addr, 0);
290 /* Install device tree */
291 if (fdt_check_header(fdt)) {
292 log_err("ERROR: invalid device tree\n");
293 return EFI_LOAD_ERROR;
296 /* Prepare device tree for payload */
297 ret = copy_fdt(&fdt);
299 log_err("ERROR: out of memory\n");
300 return EFI_OUT_OF_RESOURCES;
303 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
304 log_err("ERROR: failed to process device tree\n");
305 return EFI_LOAD_ERROR;
308 /* Create memory reservations as indicated by the device tree */
309 efi_carve_out_dt_rsv(fdt);
311 /* Install device tree as UEFI table */
312 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
313 if (ret != EFI_SUCCESS) {
314 log_err("ERROR: failed to install device tree\n");
317 #endif /* GENERATE_ACPI_TABLE */
323 * do_bootefi_exec() - execute EFI binary
325 * The image indicated by @handle is started. When it returns the allocated
326 * memory for the @load_options is freed.
328 * @handle: handle of loaded image
329 * @load_options: load options
330 * Return: status code
332 * Load the EFI binary into a newly assigned memory unwinding the relocation
333 * information, install the loaded image protocol, and call the binary.
335 static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
338 efi_uintn_t exit_data_size = 0;
339 u16 *exit_data = NULL;
341 /* Call our payload! */
342 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
343 if (ret != EFI_SUCCESS) {
344 log_err("## Application failed, r = %lu\n",
345 ret & ~EFI_ERROR_MASK);
347 log_err("## %ls\n", exit_data);
348 efi_free_pool(exit_data);
360 * do_efibootmgr() - execute EFI boot manager
362 * Return: status code
364 static int do_efibootmgr(void)
370 ret = efi_bootmgr_load(&handle, &load_options);
371 if (ret != EFI_SUCCESS) {
372 log_notice("EFI boot manager: Cannot load any image\n");
373 return CMD_RET_FAILURE;
376 ret = do_bootefi_exec(handle, load_options);
378 if (ret != EFI_SUCCESS)
379 return CMD_RET_FAILURE;
381 return CMD_RET_SUCCESS;
385 * do_bootefi_image() - execute EFI binary
387 * Set up memory image for the binary to be loaded, prepare device path, and
388 * then call do_bootefi_exec() to execute it.
390 * @image_opt: string of image start address
391 * Return: status code
393 static int do_bootefi_image(const char *image_opt)
396 unsigned long addr, size;
399 #ifdef CONFIG_CMD_BOOTEFI_HELLO
400 if (!strcmp(image_opt, "hello")) {
401 image_buf = __efi_helloworld_begin;
402 size = __efi_helloworld_end - __efi_helloworld_begin;
407 addr = strtoul(image_opt, NULL, 16);
408 /* Check that a numeric value was passed */
410 return CMD_RET_USAGE;
412 image_buf = map_sysmem(addr, 0);
414 if (image_buf != image_addr) {
415 log_err("No UEFI binary known at %s\n", image_opt);
416 return CMD_RET_FAILURE;
420 ret = efi_run_image(image_buf, size);
422 if (ret != EFI_SUCCESS)
423 return CMD_RET_FAILURE;
425 return CMD_RET_SUCCESS;
429 * efi_run_image() - run loaded UEFI image
431 * @source_buffer: memory address of the UEFI image
432 * @source_size: size of the UEFI image
433 * Return: status code
435 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
437 efi_handle_t mem_handle = NULL, handle;
438 struct efi_device_path *file_path = NULL;
439 struct efi_device_path *msg_path;
443 if (!bootefi_device_path || !bootefi_image_path) {
445 * Special case for efi payload not loaded from disk,
446 * such as 'bootefi hello' or for example payload
447 * loaded directly into memory via JTAG, etc:
449 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
450 (uintptr_t)source_buffer,
453 * Make sure that device for device_path exist
454 * in load_image(). Otherwise, shell and grub will fail.
456 ret = efi_create_handle(&mem_handle);
457 if (ret != EFI_SUCCESS)
460 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
462 if (ret != EFI_SUCCESS)
464 msg_path = file_path;
466 file_path = efi_dp_append(bootefi_device_path,
468 msg_path = bootefi_image_path;
471 log_info("Booting %pD\n", msg_path);
473 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
474 source_size, &handle));
475 if (ret != EFI_SUCCESS) {
476 log_err("Loading image failed\n");
480 /* Transfer environment variable as load options */
481 ret = efi_env_set_load_options(handle, "bootargs", &load_options);
482 if (ret != EFI_SUCCESS)
485 ret = do_bootefi_exec(handle, load_options);
488 efi_delete_handle(mem_handle);
489 efi_free_pool(file_path);
493 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
494 static efi_status_t bootefi_run_prepare(const char *load_options_path,
495 struct efi_device_path *device_path,
496 struct efi_device_path *image_path,
497 struct efi_loaded_image_obj **image_objp,
498 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 efi_env_set_load_options((efi_handle_t)*image_objp,
515 * bootefi_test_prepare() - prepare to run an EFI test
517 * Prepare to run a test as if it were provided by a loaded image.
519 * @image_objp: pointer to be set to the loaded image handle
520 * @loaded_image_infop: pointer to be set to the loaded image protocol
521 * @path: dummy file path used to construct the device path
522 * set in the loaded image protocol
523 * @load_options_path: name of a U-Boot environment variable. Its value is
524 * set as load options in the loaded image protocol.
525 * Return: status code
527 static efi_status_t bootefi_test_prepare
528 (struct efi_loaded_image_obj **image_objp,
529 struct efi_loaded_image **loaded_image_infop, const char *path,
530 const char *load_options_path)
534 /* Construct a dummy device path */
535 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
536 if (!bootefi_device_path)
537 return EFI_OUT_OF_RESOURCES;
539 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
540 if (!bootefi_image_path) {
541 ret = EFI_OUT_OF_RESOURCES;
545 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
546 bootefi_image_path, image_objp,
548 if (ret == EFI_SUCCESS)
557 * bootefi_run_finish() - finish up after running an EFI test
559 * @loaded_image_info: Pointer to a struct which holds the loaded image info
560 * @image_obj: Pointer to a struct which holds the loaded image object
562 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
563 struct efi_loaded_image *loaded_image_info)
566 free(loaded_image_info->load_options);
567 efi_delete_handle(&image_obj->header);
571 * do_efi_selftest() - execute EFI selftest
573 * Return: status code
575 static int do_efi_selftest(void)
577 struct efi_loaded_image_obj *image_obj;
578 struct efi_loaded_image *loaded_image_info;
581 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
582 "\\selftest", "efi_selftest");
583 if (ret != EFI_SUCCESS)
584 return CMD_RET_FAILURE;
586 /* Execute the test */
587 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
588 bootefi_run_finish(image_obj, loaded_image_info);
590 return ret != EFI_SUCCESS;
592 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
595 * do_bootefi() - execute `bootefi` command
597 * @cmdtp: table entry describing command
598 * @flag: bitmap indicating how the command was invoked
599 * @argc: number of arguments
600 * @argv: command line arguments
601 * Return: status code
603 static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
610 return CMD_RET_USAGE;
612 /* Initialize EFI drivers */
613 ret = efi_init_obj_list();
614 if (ret != EFI_SUCCESS) {
615 log_err("Error: Cannot initialize UEFI sub-system, r = %lu\n",
616 ret & ~EFI_ERROR_MASK);
617 return CMD_RET_FAILURE;
623 fdt_addr = simple_strtoul(argv[2], NULL, 16);
624 fdt = map_sysmem(fdt_addr, 0);
626 fdt = EFI_FDT_USE_INTERNAL;
628 ret = efi_install_fdt(fdt);
629 if (ret == EFI_INVALID_PARAMETER)
630 return CMD_RET_USAGE;
631 else if (ret != EFI_SUCCESS)
632 return CMD_RET_FAILURE;
634 if (IS_ENABLED(CONFIG_CMD_BOOTEFI_BOOTMGR)) {
635 if (!strcmp(argv[1], "bootmgr"))
636 return do_efibootmgr();
638 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
639 if (!strcmp(argv[1], "selftest"))
640 return do_efi_selftest();
643 return do_bootefi_image(argv[1]);
646 #ifdef CONFIG_SYS_LONGHELP
647 static char bootefi_help_text[] =
648 "<image address> [fdt address]\n"
649 " - boot EFI payload stored at address <image address>.\n"
650 " If specified, the device tree located at <fdt address> gets\n"
651 " exposed as EFI configuration table.\n"
652 #ifdef CONFIG_CMD_BOOTEFI_HELLO
654 " - boot a sample Hello World application stored within U-Boot\n"
656 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
657 "bootefi selftest [fdt address]\n"
658 " - boot an EFI selftest application stored within U-Boot\n"
659 " Use environment variable efi_selftest to select a single test.\n"
660 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
662 #ifdef CONFIG_CMD_BOOTEFI_BOOTMGR
663 "bootefi bootmgr [fdt address]\n"
664 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
666 " If specified, the device tree located at <fdt address> gets\n"
667 " exposed as EFI configuration table.\n"
673 bootefi, 3, 0, do_bootefi,
674 "Boots an EFI payload from memory",