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;
34 * efi_env_set_load_options() - set load options from environment variable
36 * @handle: the image handle
37 * @env_var: name of the environment variable
38 * @load_options: pointer to load options (output)
41 static efi_status_t efi_env_set_load_options(efi_handle_t handle,
45 const char *env = env_get(env_var);
53 size = sizeof(u16) * (utf8_utf16_strlen(env) + 1);
54 pos = calloc(size, 1);
56 return EFI_OUT_OF_RESOURCES;
58 utf8_utf16_strcpy(&pos, env);
59 ret = efi_set_load_options(handle, size, *load_options);
60 if (ret != EFI_SUCCESS) {
67 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
70 * copy_fdt() - Copy the device tree to a new location available to EFI
72 * The FDT is copied to a suitable location within the EFI memory map.
73 * Additional 12 KiB are added to the space in case the device tree needs to be
74 * expanded later with fdt_open_into().
76 * @fdtp: On entry a pointer to the flattened device tree.
77 * On exit a pointer to the copy of the flattened device tree.
81 static efi_status_t copy_fdt(void **fdtp)
83 unsigned long fdt_ram_start = -1L, fdt_pages;
90 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
91 u64 ram_start = gd->bd->bi_dram[i].start;
92 u64 ram_size = gd->bd->bi_dram[i].size;
97 if (ram_start < fdt_ram_start)
98 fdt_ram_start = ram_start;
102 * Give us at least 12 KiB of breathing room in case the device tree
103 * needs to be expanded later.
106 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
107 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
110 * Safe fdt location is at 127 MiB.
111 * On the sandbox convert from the sandbox address space.
113 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
115 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
116 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
118 if (ret != EFI_SUCCESS) {
119 /* If we can't put it there, put it somewhere */
120 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
121 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
122 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
124 if (ret != EFI_SUCCESS) {
125 log_err("ERROR: Failed to reserve space for FDT\n");
129 new_fdt = (void *)(uintptr_t)new_fdt_addr;
130 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
131 fdt_set_totalsize(new_fdt, fdt_size);
133 *fdtp = (void *)(uintptr_t)new_fdt_addr;
138 static void efi_reserve_memory(u64 addr, u64 size)
140 /* Convert from sandbox address space. */
141 addr = (uintptr_t)map_sysmem(addr, 0);
142 if (efi_add_memory_map(addr, size,
143 EFI_RESERVED_MEMORY_TYPE) != EFI_SUCCESS)
144 log_err("Reserved memory mapping failed addr %llx size %llx\n",
149 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
151 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
152 * ignored because this is not critical and we would rather continue to try to
155 * @fdt: Pointer to device tree
157 static void efi_carve_out_dt_rsv(void *fdt)
161 int nodeoffset, subnode;
163 nr_rsv = fdt_num_mem_rsv(fdt);
165 /* Look for an existing entry and add it to the efi mem map. */
166 for (i = 0; i < nr_rsv; i++) {
167 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
169 efi_reserve_memory(addr, size);
172 /* process reserved-memory */
173 nodeoffset = fdt_subnode_offset(fdt, 0, "reserved-memory");
174 if (nodeoffset >= 0) {
175 subnode = fdt_first_subnode(fdt, nodeoffset);
176 while (subnode >= 0) {
180 /* check if this subnode has a reg property */
181 fdt_addr = fdtdec_get_addr_size_auto_parent(
182 fdt, nodeoffset, subnode,
183 "reg", 0, &fdt_size, false);
185 * The /reserved-memory node may have children with
186 * a size instead of a reg property.
188 if (fdt_addr != FDT_ADDR_T_NONE &&
189 fdtdec_get_is_enabled(fdt, subnode))
190 efi_reserve_memory(fdt_addr, fdt_size);
191 subnode = fdt_next_subnode(fdt, subnode);
197 * get_config_table() - get configuration table
199 * @guid: GUID of the configuration table
200 * Return: pointer to configuration table or NULL
202 static void *get_config_table(const efi_guid_t *guid)
206 for (i = 0; i < systab.nr_tables; i++) {
207 if (!guidcmp(guid, &systab.tables[i].guid))
208 return systab.tables[i].table;
213 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
216 * efi_install_fdt() - install device tree
218 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
219 * address will will be installed as configuration table, otherwise the device
220 * tree located at the address indicated by environment variable fdt_addr or as
221 * fallback fdtcontroladdr will be used.
223 * On architectures using ACPI tables device trees shall not be installed as
224 * configuration table.
226 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
227 * the hardware device tree as indicated by environment variable
228 * fdt_addr or as fallback the internal device tree as indicated by
229 * the environment variable fdtcontroladdr
230 * Return: status code
232 efi_status_t efi_install_fdt(void *fdt)
235 * The EBBR spec requires that we have either an FDT or an ACPI table
238 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
240 log_err("ERROR: can't have ACPI table and device tree.\n");
241 return EFI_LOAD_ERROR;
244 bootm_headers_t img = { 0 };
247 if (fdt == EFI_FDT_USE_INTERNAL) {
251 /* Look for device tree that is already installed */
252 if (get_config_table(&efi_guid_fdt))
254 /* Check if there is a hardware device tree */
255 fdt_opt = env_get("fdt_addr");
256 /* Use our own device tree as fallback */
258 fdt_opt = env_get("fdtcontroladdr");
260 log_err("ERROR: need device tree\n");
261 return EFI_NOT_FOUND;
264 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
266 log_err("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
267 return EFI_LOAD_ERROR;
269 fdt = map_sysmem(fdt_addr, 0);
272 /* Install device tree */
273 if (fdt_check_header(fdt)) {
274 log_err("ERROR: invalid device tree\n");
275 return EFI_LOAD_ERROR;
278 /* Prepare device tree for payload */
279 ret = copy_fdt(&fdt);
281 log_err("ERROR: out of memory\n");
282 return EFI_OUT_OF_RESOURCES;
285 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
286 log_err("ERROR: failed to process device tree\n");
287 return EFI_LOAD_ERROR;
290 /* Create memory reservations as indicated by the device tree */
291 efi_carve_out_dt_rsv(fdt);
293 /* Install device tree as UEFI table */
294 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
295 if (ret != EFI_SUCCESS) {
296 log_err("ERROR: failed to install device tree\n");
299 #endif /* GENERATE_ACPI_TABLE */
305 * do_bootefi_exec() - execute EFI binary
307 * The image indicated by @handle is started. When it returns the allocated
308 * memory for the @load_options is freed.
310 * @handle: handle of loaded image
311 * @load_options: load options
312 * Return: status code
314 * Load the EFI binary into a newly assigned memory unwinding the relocation
315 * information, install the loaded image protocol, and call the binary.
317 static efi_status_t do_bootefi_exec(efi_handle_t handle, void *load_options)
320 efi_uintn_t exit_data_size = 0;
321 u16 *exit_data = NULL;
323 /* Call our payload! */
324 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
325 if (ret != EFI_SUCCESS) {
326 log_err("## Application failed, r = %lu\n",
327 ret & ~EFI_ERROR_MASK);
329 log_err("## %ls\n", exit_data);
330 efi_free_pool(exit_data);
342 * do_efibootmgr() - execute EFI boot manager
344 * Return: status code
346 static int do_efibootmgr(void)
352 ret = efi_bootmgr_load(&handle, &load_options);
353 if (ret != EFI_SUCCESS) {
354 log_notice("EFI boot manager: Cannot load any image\n");
355 return CMD_RET_FAILURE;
358 ret = do_bootefi_exec(handle, load_options);
360 if (ret != EFI_SUCCESS)
361 return CMD_RET_FAILURE;
363 return CMD_RET_SUCCESS;
367 * do_bootefi_image() - execute EFI binary
369 * Set up memory image for the binary to be loaded, prepare device path, and
370 * then call do_bootefi_exec() to execute it.
372 * @image_opt: string of image start address
373 * Return: status code
375 static int do_bootefi_image(const char *image_opt)
378 unsigned long addr, size;
379 const char *size_str;
382 #ifdef CONFIG_CMD_BOOTEFI_HELLO
383 if (!strcmp(image_opt, "hello")) {
386 saddr = env_get("loadaddr");
387 size = __efi_helloworld_end - __efi_helloworld_begin;
390 addr = simple_strtoul(saddr, NULL, 16);
392 addr = CONFIG_SYS_LOAD_ADDR;
394 image_buf = map_sysmem(addr, size);
395 memcpy(image_buf, __efi_helloworld_begin, size);
397 efi_free_pool(bootefi_device_path);
398 efi_free_pool(bootefi_image_path);
399 bootefi_device_path = NULL;
400 bootefi_image_path = NULL;
404 size_str = env_get("filesize");
406 size = simple_strtoul(size_str, NULL, 16);
410 addr = simple_strtoul(image_opt, NULL, 16);
411 /* Check that a numeric value was passed */
412 if (!addr && *image_opt != '0')
413 return CMD_RET_USAGE;
415 image_buf = map_sysmem(addr, size);
417 ret = efi_run_image(image_buf, size);
419 if (ret != EFI_SUCCESS)
420 return CMD_RET_FAILURE;
422 return CMD_RET_SUCCESS;
426 * efi_run_image() - run loaded UEFI image
428 * @source_buffer: memory address of the UEFI image
429 * @source_size: size of the UEFI image
430 * Return: status code
432 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
434 efi_handle_t mem_handle = NULL, handle;
435 struct efi_device_path *file_path = NULL;
436 struct efi_device_path *msg_path;
440 if (!bootefi_device_path || !bootefi_image_path) {
442 * Special case for efi payload not loaded from disk,
443 * such as 'bootefi hello' or for example payload
444 * loaded directly into memory via JTAG, etc:
446 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
447 (uintptr_t)source_buffer,
450 * Make sure that device for device_path exist
451 * in load_image(). Otherwise, shell and grub will fail.
453 ret = efi_create_handle(&mem_handle);
454 if (ret != EFI_SUCCESS)
457 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
459 if (ret != EFI_SUCCESS)
461 msg_path = file_path;
463 file_path = efi_dp_append(bootefi_device_path,
465 msg_path = bootefi_image_path;
468 log_info("Booting %pD\n", msg_path);
470 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
471 source_size, &handle));
472 if (ret != EFI_SUCCESS) {
473 log_err("Loading image failed\n");
477 /* Transfer environment variable as load options */
478 ret = efi_env_set_load_options(handle, "bootargs", &load_options);
479 if (ret != EFI_SUCCESS)
482 ret = do_bootefi_exec(handle, load_options);
485 efi_delete_handle(mem_handle);
486 efi_free_pool(file_path);
490 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
491 static efi_status_t bootefi_run_prepare(const char *load_options_path,
492 struct efi_device_path *device_path,
493 struct efi_device_path *image_path,
494 struct efi_loaded_image_obj **image_objp,
495 struct efi_loaded_image **loaded_image_infop)
500 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
502 if (ret != EFI_SUCCESS)
505 /* Transfer environment variable as load options */
506 return efi_env_set_load_options((efi_handle_t)*image_objp,
512 * bootefi_test_prepare() - prepare to run an EFI test
514 * Prepare to run a test as if it were provided by a loaded image.
516 * @image_objp: pointer to be set to the loaded image handle
517 * @loaded_image_infop: pointer to be set to the loaded image protocol
518 * @path: dummy file path used to construct the device path
519 * set in the loaded image protocol
520 * @load_options_path: name of a U-Boot environment variable. Its value is
521 * set as load options in the loaded image protocol.
522 * Return: status code
524 static efi_status_t bootefi_test_prepare
525 (struct efi_loaded_image_obj **image_objp,
526 struct efi_loaded_image **loaded_image_infop, const char *path,
527 const char *load_options_path)
531 /* Construct a dummy device path */
532 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
533 if (!bootefi_device_path)
534 return EFI_OUT_OF_RESOURCES;
536 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
537 if (!bootefi_image_path) {
538 ret = EFI_OUT_OF_RESOURCES;
542 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
543 bootefi_image_path, image_objp,
545 if (ret == EFI_SUCCESS)
548 efi_free_pool(bootefi_image_path);
549 bootefi_image_path = NULL;
551 efi_free_pool(bootefi_device_path);
552 bootefi_device_path = NULL;
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 (!strcmp(argv[1], "bootmgr"))
635 return do_efibootmgr();
636 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
637 else if (!strcmp(argv[1], "selftest"))
638 return do_efi_selftest();
641 return do_bootefi_image(argv[1]);
644 #ifdef CONFIG_SYS_LONGHELP
645 static char bootefi_help_text[] =
646 "<image address> [fdt address]\n"
647 " - boot EFI payload stored at address <image address>.\n"
648 " If specified, the device tree located at <fdt address> gets\n"
649 " exposed as EFI configuration table.\n"
650 #ifdef CONFIG_CMD_BOOTEFI_HELLO
652 " - boot a sample Hello World application stored within U-Boot\n"
654 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
655 "bootefi selftest [fdt address]\n"
656 " - boot an EFI selftest application stored within U-Boot\n"
657 " Use environment variable efi_selftest to select a single test.\n"
658 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
660 "bootefi bootmgr [fdt address]\n"
661 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
663 " If specified, the device tree located at <fdt address> gets\n"
664 " exposed as EFI configuration table.\n";
668 bootefi, 3, 0, do_bootefi,
669 "Boots an EFI payload from memory",
674 * efi_set_bootdev() - set boot device
676 * This function is called when a file is loaded, e.g. via the 'load' command.
677 * We use the path to this file to inform the UEFI binary about the boot device.
679 * @dev: device, e.g. "MMC"
680 * @devnr: number of the device, e.g. "1:2"
681 * @path: path to file loaded
683 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
685 struct efi_device_path *device, *image;
688 /* efi_set_bootdev is typically called repeatedly, recover memory */
689 efi_free_pool(bootefi_device_path);
690 efi_free_pool(bootefi_image_path);
692 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
693 if (ret == EFI_SUCCESS) {
694 bootefi_device_path = device;
696 /* FIXME: image should not contain device */
697 struct efi_device_path *image_tmp = image;
699 efi_dp_split_file_path(image, &device, &image);
700 efi_free_pool(image_tmp);
702 bootefi_image_path = image;
704 bootefi_device_path = NULL;
705 bootefi_image_path = NULL;