1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
12 #include <efi_loader.h>
13 #include <efi_selftest.h>
17 #include <linux/libfdt.h>
18 #include <linux/libfdt_env.h>
21 #include <asm-generic/sections.h>
22 #include <linux/linkage.h>
24 DECLARE_GLOBAL_DATA_PTR;
26 static struct efi_device_path *bootefi_image_path;
27 static struct efi_device_path *bootefi_device_path;
30 * Set the load options of an image from an environment variable.
32 * @handle: the image handle
33 * @env_var: name of the environment variable
34 * @load_options: pointer to load options (output)
37 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var,
40 struct efi_loaded_image *loaded_image_info;
42 const char *env = env_get(env_var);
47 ret = EFI_CALL(systab.boottime->open_protocol(
49 &efi_guid_loaded_image,
50 (void **)&loaded_image_info,
52 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
53 if (ret != EFI_SUCCESS)
54 return EFI_INVALID_PARAMETER;
56 loaded_image_info->load_options = NULL;
57 loaded_image_info->load_options_size = 0;
61 size = utf8_utf16_strlen(env) + 1;
62 loaded_image_info->load_options = calloc(size, sizeof(u16));
63 if (!loaded_image_info->load_options) {
64 printf("ERROR: Out of memory\n");
65 EFI_CALL(systab.boottime->close_protocol(handle,
66 &efi_guid_loaded_image,
68 return EFI_OUT_OF_RESOURCES;
70 pos = loaded_image_info->load_options;
72 utf8_utf16_strcpy(&pos, env);
73 loaded_image_info->load_options_size = size * 2;
76 return EFI_CALL(systab.boottime->close_protocol(handle,
77 &efi_guid_loaded_image,
81 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
84 * copy_fdt() - Copy the device tree to a new location available to EFI
86 * The FDT is copied to a suitable location within the EFI memory map.
87 * Additional 12 KiB are added to the space in case the device tree needs to be
88 * expanded later with fdt_open_into().
90 * @fdtp: On entry a pointer to the flattened device tree.
91 * On exit a pointer to the copy of the flattened device tree.
95 static efi_status_t copy_fdt(void **fdtp)
97 unsigned long fdt_ram_start = -1L, fdt_pages;
104 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
105 u64 ram_start = gd->bd->bi_dram[i].start;
106 u64 ram_size = gd->bd->bi_dram[i].size;
111 if (ram_start < fdt_ram_start)
112 fdt_ram_start = ram_start;
116 * Give us at least 12 KiB of breathing room in case the device tree
117 * needs to be expanded later.
120 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
121 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
124 * Safe fdt location is at 127 MiB.
125 * On the sandbox convert from the sandbox address space.
127 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
129 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
130 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
132 if (ret != EFI_SUCCESS) {
133 /* If we can't put it there, put it somewhere */
134 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
135 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
136 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
138 if (ret != EFI_SUCCESS) {
139 printf("ERROR: Failed to reserve space for FDT\n");
143 new_fdt = (void *)(uintptr_t)new_fdt_addr;
144 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
145 fdt_set_totalsize(new_fdt, fdt_size);
147 *fdtp = (void *)(uintptr_t)new_fdt_addr;
152 static void efi_reserve_memory(u64 addr, u64 size)
154 /* Convert from sandbox address space. */
155 addr = (uintptr_t)map_sysmem(addr, 0);
156 if (efi_add_memory_map(addr, size,
157 EFI_RESERVED_MEMORY_TYPE) != EFI_SUCCESS)
158 printf("Reserved memory mapping failed addr %llx size %llx\n",
163 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
165 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
166 * ignored because this is not critical and we would rather continue to try to
169 * @fdt: Pointer to device tree
171 static void efi_carve_out_dt_rsv(void *fdt)
175 int nodeoffset, subnode;
177 nr_rsv = fdt_num_mem_rsv(fdt);
179 /* Look for an existing entry and add it to the efi mem map. */
180 for (i = 0; i < nr_rsv; i++) {
181 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
183 efi_reserve_memory(addr, size);
186 /* process reserved-memory */
187 nodeoffset = fdt_subnode_offset(fdt, 0, "reserved-memory");
188 if (nodeoffset >= 0) {
189 subnode = fdt_first_subnode(fdt, nodeoffset);
190 while (subnode >= 0) {
191 /* check if this subnode has a reg property */
192 addr = fdtdec_get_addr_size(fdt, subnode, "reg",
193 (fdt_size_t *)&size);
195 * The /reserved-memory node may have children with
196 * a size instead of a reg property.
198 if (addr != FDT_ADDR_T_NONE &&
199 fdtdec_get_is_enabled(fdt, subnode))
200 efi_reserve_memory(addr, size);
201 subnode = fdt_next_subnode(fdt, subnode);
207 * get_config_table() - get configuration table
209 * @guid: GUID of the configuration table
210 * Return: pointer to configuration table or NULL
212 static void *get_config_table(const efi_guid_t *guid)
216 for (i = 0; i < systab.nr_tables; i++) {
217 if (!guidcmp(guid, &systab.tables[i].guid))
218 return systab.tables[i].table;
223 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
226 * efi_install_fdt() - install device tree
228 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
229 * address will will be installed as configuration table, otherwise the device
230 * tree located at the address indicated by environment variable fdt_addr or as
231 * fallback fdtcontroladdr will be used.
233 * On architectures using ACPI tables device trees shall not be installed as
234 * configuration table.
236 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
237 * the hardware device tree as indicated by environment variable
238 * fdt_addr or as fallback the internal device tree as indicated by
239 * the environment variable fdtcontroladdr
240 * Return: status code
242 efi_status_t efi_install_fdt(void *fdt)
245 * The EBBR spec requires that we have either an FDT or an ACPI table
248 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
250 printf("ERROR: can't have ACPI table and device tree.\n");
251 return EFI_LOAD_ERROR;
254 bootm_headers_t img = { 0 };
257 if (fdt == EFI_FDT_USE_INTERNAL) {
261 /* Look for device tree that is already installed */
262 if (get_config_table(&efi_guid_fdt))
264 /* Check if there is a hardware device tree */
265 fdt_opt = env_get("fdt_addr");
266 /* Use our own device tree as fallback */
268 fdt_opt = env_get("fdtcontroladdr");
270 printf("ERROR: need device tree\n");
271 return EFI_NOT_FOUND;
274 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
276 printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
277 return EFI_LOAD_ERROR;
279 fdt = map_sysmem(fdt_addr, 0);
282 /* Install device tree */
283 if (fdt_check_header(fdt)) {
284 printf("ERROR: invalid device tree\n");
285 return EFI_LOAD_ERROR;
288 /* Prepare device tree for payload */
289 ret = copy_fdt(&fdt);
291 printf("ERROR: out of memory\n");
292 return EFI_OUT_OF_RESOURCES;
295 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
296 printf("ERROR: failed to process device tree\n");
297 return EFI_LOAD_ERROR;
300 /* Create memory reservations as indicated by the device tree */
301 efi_carve_out_dt_rsv(fdt);
303 /* Install device tree as UEFI table */
304 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
305 if (ret != EFI_SUCCESS) {
306 printf("ERROR: failed to install device tree\n");
309 #endif /* GENERATE_ACPI_TABLE */
315 * do_bootefi_exec() - execute EFI binary
317 * @handle: handle of loaded image
318 * Return: status code
320 * Load the EFI binary into a newly assigned memory unwinding the relocation
321 * information, install the loaded image protocol, and call the binary.
323 static efi_status_t do_bootefi_exec(efi_handle_t handle)
326 efi_uintn_t exit_data_size = 0;
327 u16 *exit_data = NULL;
330 /* Transfer environment variable as load options */
331 ret = set_load_options(handle, "bootargs", &load_options);
332 if (ret != EFI_SUCCESS)
335 /* Call our payload! */
336 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
337 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
338 if (ret && exit_data) {
339 printf("## %ls\n", exit_data);
340 efi_free_pool(exit_data);
351 * do_efibootmgr() - execute EFI boot manager
353 * Return: status code
355 static int do_efibootmgr(void)
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
377 * Set up memory image for the binary to be loaded, prepare device path, and
378 * then call do_bootefi_exec() to execute it.
380 * @image_opt: string of image start address
381 * Return: status code
383 static int do_bootefi_image(const char *image_opt)
386 unsigned long addr, size;
387 const char *size_str;
390 #ifdef CONFIG_CMD_BOOTEFI_HELLO
391 if (!strcmp(image_opt, "hello")) {
394 saddr = env_get("loadaddr");
395 size = __efi_helloworld_end - __efi_helloworld_begin;
398 addr = simple_strtoul(saddr, NULL, 16);
400 addr = CONFIG_SYS_LOAD_ADDR;
402 image_buf = map_sysmem(addr, size);
403 memcpy(image_buf, __efi_helloworld_begin, size);
405 efi_free_pool(bootefi_device_path);
406 efi_free_pool(bootefi_image_path);
407 bootefi_device_path = NULL;
408 bootefi_image_path = NULL;
412 size_str = env_get("filesize");
414 size = simple_strtoul(size_str, NULL, 16);
418 addr = simple_strtoul(image_opt, NULL, 16);
419 /* Check that a numeric value was passed */
420 if (!addr && *image_opt != '0')
421 return CMD_RET_USAGE;
423 image_buf = map_sysmem(addr, size);
425 ret = efi_run_image(image_buf, size);
427 if (ret != EFI_SUCCESS)
428 return CMD_RET_FAILURE;
430 return CMD_RET_SUCCESS;
434 * efi_run_image() - run loaded UEFI image
436 * @source_buffer: memory address of the UEFI image
437 * @source_size: size of the UEFI image
438 * Return: status code
440 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
442 efi_handle_t mem_handle = NULL, handle;
443 struct efi_device_path *file_path = NULL;
446 if (!bootefi_device_path || !bootefi_image_path) {
448 * Special case for efi payload not loaded from disk,
449 * such as 'bootefi hello' or for example payload
450 * loaded directly into memory via JTAG, etc:
452 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
453 (uintptr_t)source_buffer,
456 * Make sure that device for device_path exist
457 * in load_image(). Otherwise, shell and grub will fail.
459 ret = efi_create_handle(&mem_handle);
460 if (ret != EFI_SUCCESS)
463 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
465 if (ret != EFI_SUCCESS)
468 file_path = efi_dp_append(bootefi_device_path,
472 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
473 source_size, &handle));
474 if (ret != EFI_SUCCESS)
477 ret = do_bootefi_exec(handle);
480 efi_delete_handle(mem_handle);
481 efi_free_pool(file_path);
485 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
486 static efi_status_t bootefi_run_prepare(const char *load_options_path,
487 struct efi_device_path *device_path,
488 struct efi_device_path *image_path,
489 struct efi_loaded_image_obj **image_objp,
490 struct efi_loaded_image **loaded_image_infop)
495 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
497 if (ret != EFI_SUCCESS)
500 /* Transfer environment variable as load options */
501 return set_load_options((efi_handle_t)*image_objp, load_options_path,
506 * bootefi_test_prepare() - prepare to run an EFI test
508 * Prepare to run a test as if it were provided by a loaded image.
510 * @image_objp: pointer to be set to the loaded image handle
511 * @loaded_image_infop: pointer to be set to the loaded image protocol
512 * @path: dummy file path used to construct the device path
513 * set in the loaded image protocol
514 * @load_options_path: name of a U-Boot environment variable. Its value is
515 * set as load options in the loaded image protocol.
516 * Return: status code
518 static efi_status_t bootefi_test_prepare
519 (struct efi_loaded_image_obj **image_objp,
520 struct efi_loaded_image **loaded_image_infop, const char *path,
521 const char *load_options_path)
525 /* Construct a dummy device path */
526 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
527 if (!bootefi_device_path)
528 return EFI_OUT_OF_RESOURCES;
530 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
531 if (!bootefi_image_path) {
532 ret = EFI_OUT_OF_RESOURCES;
536 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
537 bootefi_image_path, image_objp,
539 if (ret == EFI_SUCCESS)
542 efi_free_pool(bootefi_image_path);
543 bootefi_image_path = NULL;
545 efi_free_pool(bootefi_device_path);
546 bootefi_device_path = NULL;
551 * bootefi_run_finish() - finish up after running an EFI test
553 * @loaded_image_info: Pointer to a struct which holds the loaded image info
554 * @image_obj: Pointer to a struct which holds the loaded image object
556 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
557 struct efi_loaded_image *loaded_image_info)
560 free(loaded_image_info->load_options);
561 efi_delete_handle(&image_obj->header);
565 * do_efi_selftest() - execute EFI selftest
567 * Return: status code
569 static int do_efi_selftest(void)
571 struct efi_loaded_image_obj *image_obj;
572 struct efi_loaded_image *loaded_image_info;
575 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
576 "\\selftest", "efi_selftest");
577 if (ret != EFI_SUCCESS)
578 return CMD_RET_FAILURE;
580 /* Execute the test */
581 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
582 bootefi_run_finish(image_obj, loaded_image_info);
584 return ret != EFI_SUCCESS;
586 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
589 * do_bootefi() - execute `bootefi` command
591 * @cmdtp: table entry describing command
592 * @flag: bitmap indicating how the command was invoked
593 * @argc: number of arguments
594 * @argv: command line arguments
595 * Return: status code
597 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
603 return CMD_RET_USAGE;
605 /* Initialize EFI drivers */
606 ret = efi_init_obj_list();
607 if (ret != EFI_SUCCESS) {
608 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
609 ret & ~EFI_ERROR_MASK);
610 return CMD_RET_FAILURE;
616 fdt_addr = simple_strtoul(argv[2], NULL, 16);
617 fdt = map_sysmem(fdt_addr, 0);
619 fdt = EFI_FDT_USE_INTERNAL;
621 ret = efi_install_fdt(fdt);
622 if (ret == EFI_INVALID_PARAMETER)
623 return CMD_RET_USAGE;
624 else if (ret != EFI_SUCCESS)
625 return CMD_RET_FAILURE;
627 if (!strcmp(argv[1], "bootmgr"))
628 return do_efibootmgr();
629 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
630 else if (!strcmp(argv[1], "selftest"))
631 return do_efi_selftest();
634 return do_bootefi_image(argv[1]);
637 #ifdef CONFIG_SYS_LONGHELP
638 static char bootefi_help_text[] =
639 "<image address> [fdt address]\n"
640 " - boot EFI payload stored at address <image address>.\n"
641 " If specified, the device tree located at <fdt address> gets\n"
642 " exposed as EFI configuration table.\n"
643 #ifdef CONFIG_CMD_BOOTEFI_HELLO
645 " - boot a sample Hello World application stored within U-Boot\n"
647 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
648 "bootefi selftest [fdt address]\n"
649 " - boot an EFI selftest application stored within U-Boot\n"
650 " Use environment variable efi_selftest to select a single test.\n"
651 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
653 "bootefi bootmgr [fdt address]\n"
654 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
656 " If specified, the device tree located at <fdt address> gets\n"
657 " exposed as EFI configuration table.\n";
661 bootefi, 3, 0, do_bootefi,
662 "Boots an EFI payload from memory",
667 * efi_set_bootdev() - set boot device
669 * This function is called when a file is loaded, e.g. via the 'load' command.
670 * We use the path to this file to inform the UEFI binary about the boot device.
672 * @dev: device, e.g. "MMC"
673 * @devnr: number of the device, e.g. "1:2"
674 * @path: path to file loaded
676 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
678 struct efi_device_path *device, *image;
681 /* efi_set_bootdev is typically called repeatedly, recover memory */
682 efi_free_pool(bootefi_device_path);
683 efi_free_pool(bootefi_image_path);
685 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
686 if (ret == EFI_SUCCESS) {
687 bootefi_device_path = device;
689 /* FIXME: image should not contain device */
690 struct efi_device_path *image_tmp = image;
692 efi_dp_split_file_path(image, &device, &image);
693 efi_free_pool(image_tmp);
695 bootefi_image_path = image;
697 bootefi_device_path = NULL;
698 bootefi_image_path = NULL;