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>
16 #include <linux/libfdt.h>
17 #include <linux/libfdt_env.h>
20 #include <asm-generic/sections.h>
21 #include <linux/linkage.h>
23 DECLARE_GLOBAL_DATA_PTR;
25 static struct efi_device_path *bootefi_image_path;
26 static struct efi_device_path *bootefi_device_path;
29 * Set the load options of an image from an environment variable.
31 * @handle: the image handle
32 * @env_var: name of the environment variable
35 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
37 struct efi_loaded_image *loaded_image_info;
39 const char *env = env_get(env_var);
43 ret = EFI_CALL(systab.boottime->open_protocol(
45 &efi_guid_loaded_image,
46 (void **)&loaded_image_info,
48 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
49 if (ret != EFI_SUCCESS)
50 return EFI_INVALID_PARAMETER;
52 loaded_image_info->load_options = NULL;
53 loaded_image_info->load_options_size = 0;
57 size = utf8_utf16_strlen(env) + 1;
58 loaded_image_info->load_options = calloc(size, sizeof(u16));
59 if (!loaded_image_info->load_options) {
60 printf("ERROR: Out of memory\n");
61 EFI_CALL(systab.boottime->close_protocol(handle,
62 &efi_guid_loaded_image,
64 return EFI_OUT_OF_RESOURCES;
66 pos = loaded_image_info->load_options;
67 utf8_utf16_strcpy(&pos, env);
68 loaded_image_info->load_options_size = size * 2;
71 return EFI_CALL(systab.boottime->close_protocol(handle,
72 &efi_guid_loaded_image,
76 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
79 * copy_fdt() - Copy the device tree to a new location available to EFI
81 * The FDT is copied to a suitable location within the EFI memory map.
82 * Additional 12 KiB are added to the space in case the device tree needs to be
83 * expanded later with fdt_open_into().
85 * @fdtp: On entry a pointer to the flattened device tree.
86 * On exit a pointer to the copy of the flattened device tree.
90 static efi_status_t copy_fdt(void **fdtp)
92 unsigned long fdt_ram_start = -1L, fdt_pages;
99 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
100 u64 ram_start = gd->bd->bi_dram[i].start;
101 u64 ram_size = gd->bd->bi_dram[i].size;
106 if (ram_start < fdt_ram_start)
107 fdt_ram_start = ram_start;
111 * Give us at least 12 KiB of breathing room in case the device tree
112 * needs to be expanded later.
115 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
116 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
119 * Safe fdt location is at 127 MiB.
120 * On the sandbox convert from the sandbox address space.
122 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
124 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
125 EFI_BOOT_SERVICES_DATA, fdt_pages,
127 if (ret != EFI_SUCCESS) {
128 /* If we can't put it there, put it somewhere */
129 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
130 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
131 EFI_BOOT_SERVICES_DATA, fdt_pages,
133 if (ret != EFI_SUCCESS) {
134 printf("ERROR: Failed to reserve space for FDT\n");
138 new_fdt = (void *)(uintptr_t)new_fdt_addr;
139 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
140 fdt_set_totalsize(new_fdt, fdt_size);
142 *fdtp = (void *)(uintptr_t)new_fdt_addr;
148 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
150 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
151 * ignored because this is not critical and we would rather continue to try to
154 * @fdt: Pointer to device tree
156 static void efi_carve_out_dt_rsv(void *fdt)
159 uint64_t addr, size, pages;
161 nr_rsv = fdt_num_mem_rsv(fdt);
163 /* Look for an existing entry and add it to the efi mem map. */
164 for (i = 0; i < nr_rsv; i++) {
165 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
168 /* Convert from sandbox address space. */
169 addr = (uintptr_t)map_sysmem(addr, 0);
171 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
172 addr &= ~EFI_PAGE_MASK;
173 if (efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
174 false) != EFI_SUCCESS)
175 printf("FDT memrsv map %d: Failed to add to map\n", i);
180 * get_config_table() - get configuration table
182 * @guid: GUID of the configuration table
183 * Return: pointer to configuration table or NULL
185 static void *get_config_table(const efi_guid_t *guid)
189 for (i = 0; i < systab.nr_tables; i++) {
190 if (!guidcmp(guid, &systab.tables[i].guid))
191 return systab.tables[i].table;
196 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
199 * efi_install_fdt() - install device tree
201 * If fdt_addr is available, the device tree located at that memory address will
202 * will be installed as configuration table, otherwise the device tree located
203 * at the address indicated by environment variable fdt_addr or as fallback
204 * fdtcontroladdr will be used.
206 * On architectures using ACPI tables device trees shall not be installed as
207 * configuration table.
209 * @fdt_addr: address of device tree or EFI_FDT_USE_INTERNAL to use the
210 * the hardware device tree as indicated by environment variable
211 * fdt_addr or as fallback the internal device tree as indicated by
212 * the environment variable fdtcontroladdr
213 * Return: status code
215 static efi_status_t efi_install_fdt(uintptr_t fdt_addr)
218 * The EBBR spec requires that we have either an FDT or an ACPI table
221 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
223 printf("ERROR: can't have ACPI table and device tree.\n");
224 return EFI_LOAD_ERROR;
228 bootm_headers_t img = { 0 };
231 if (fdt_addr == EFI_FDT_USE_INTERNAL) {
234 /* Look for device tree that is already installed */
235 if (get_config_table(&efi_guid_fdt))
237 /* Check if there is a hardware device tree */
238 fdt_opt = env_get("fdt_addr");
239 /* Use our own device tree as fallback */
241 fdt_opt = env_get("fdtcontroladdr");
243 printf("ERROR: need device tree\n");
244 return EFI_NOT_FOUND;
247 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
249 printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
250 return EFI_LOAD_ERROR;
254 /* Install device tree */
255 fdt = map_sysmem(fdt_addr, 0);
256 if (fdt_check_header(fdt)) {
257 printf("ERROR: invalid device tree\n");
258 return EFI_LOAD_ERROR;
261 /* Create memory reservations as indicated by the device tree */
262 efi_carve_out_dt_rsv(fdt);
264 /* Prepare device tree for payload */
265 ret = copy_fdt(&fdt);
267 printf("ERROR: out of memory\n");
268 return EFI_OUT_OF_RESOURCES;
271 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
272 printf("ERROR: failed to process device tree\n");
273 return EFI_LOAD_ERROR;
276 /* Install device tree as UEFI table */
277 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
278 if (ret != EFI_SUCCESS) {
279 printf("ERROR: failed to install device tree\n");
282 #endif /* GENERATE_ACPI_TABLE */
288 * do_bootefi_exec() - execute EFI binary
290 * @handle: handle of loaded image
291 * Return: status code
293 * Load the EFI binary into a newly assigned memory unwinding the relocation
294 * information, install the loaded image protocol, and call the binary.
296 static efi_status_t do_bootefi_exec(efi_handle_t handle)
299 efi_uintn_t exit_data_size = 0;
300 u16 *exit_data = NULL;
302 /* Transfer environment variable as load options */
303 ret = set_load_options(handle, "bootargs");
304 if (ret != EFI_SUCCESS)
307 /* Call our payload! */
308 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
309 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
310 if (ret && exit_data) {
311 printf("## %ls\n", exit_data);
312 efi_free_pool(exit_data);
318 * FIXME: Who is responsible for
319 * free(loaded_image_info->load_options);
320 * Once efi_exit() is implemented correctly,
321 * handle itself doesn't exist here.
328 * do_efibootmgr() - execute EFI boot manager
330 * Return: status code
332 static int do_efibootmgr(void)
337 ret = efi_bootmgr_load(&handle);
338 if (ret != EFI_SUCCESS) {
339 printf("EFI boot manager: Cannot load any image\n");
340 return CMD_RET_FAILURE;
343 ret = do_bootefi_exec(handle);
345 if (ret != EFI_SUCCESS)
346 return CMD_RET_FAILURE;
348 return CMD_RET_SUCCESS;
352 * do_bootefi_image() - execute EFI binary
354 * Set up memory image for the binary to be loaded, prepare device path, and
355 * then call do_bootefi_exec() to execute it.
357 * @image_opt: string of image start address
358 * Return: status code
360 static int do_bootefi_image(const char *image_opt)
363 struct efi_device_path *device_path, *image_path;
364 struct efi_device_path *file_path = NULL;
365 unsigned long addr, size;
366 const char *size_str;
367 efi_handle_t mem_handle = NULL, handle;
370 #ifdef CONFIG_CMD_BOOTEFI_HELLO
371 if (!strcmp(image_opt, "hello")) {
374 saddr = env_get("loadaddr");
375 size = __efi_helloworld_end - __efi_helloworld_begin;
378 addr = simple_strtoul(saddr, NULL, 16);
380 addr = CONFIG_SYS_LOAD_ADDR;
382 image_buf = map_sysmem(addr, size);
383 memcpy(image_buf, __efi_helloworld_begin, size);
390 size_str = env_get("filesize");
392 size = simple_strtoul(size_str, NULL, 16);
396 addr = simple_strtoul(image_opt, NULL, 16);
397 /* Check that a numeric value was passed */
398 if (!addr && *image_opt != '0')
399 return CMD_RET_USAGE;
401 image_buf = map_sysmem(addr, size);
403 device_path = bootefi_device_path;
404 image_path = bootefi_image_path;
407 if (!device_path && !image_path) {
409 * Special case for efi payload not loaded from disk,
410 * such as 'bootefi hello' or for example payload
411 * loaded directly into memory via JTAG, etc:
413 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
414 (uintptr_t)image_buf, size);
416 * Make sure that device for device_path exist
417 * in load_image(). Otherwise, shell and grub will fail.
419 ret = efi_create_handle(&mem_handle);
420 if (ret != EFI_SUCCESS)
423 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
425 if (ret != EFI_SUCCESS)
428 assert(device_path && image_path);
429 file_path = efi_dp_append(device_path, image_path);
432 ret = EFI_CALL(efi_load_image(false, efi_root,
433 file_path, image_buf, size, &handle));
434 if (ret != EFI_SUCCESS)
437 ret = do_bootefi_exec(handle);
441 efi_delete_handle(mem_handle);
443 efi_free_pool(file_path);
445 if (ret != EFI_SUCCESS)
446 return CMD_RET_FAILURE;
448 return CMD_RET_SUCCESS;
451 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
452 static efi_status_t bootefi_run_prepare(const char *load_options_path,
453 struct efi_device_path *device_path,
454 struct efi_device_path *image_path,
455 struct efi_loaded_image_obj **image_objp,
456 struct efi_loaded_image **loaded_image_infop)
460 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
462 if (ret != EFI_SUCCESS)
465 /* Transfer environment variable as load options */
466 return set_load_options((efi_handle_t)*image_objp, load_options_path);
470 * bootefi_test_prepare() - prepare to run an EFI test
472 * Prepare to run a test as if it were provided by a loaded image.
474 * @image_objp: pointer to be set to the loaded image handle
475 * @loaded_image_infop: pointer to be set to the loaded image protocol
476 * @path: dummy file path used to construct the device path
477 * set in the loaded image protocol
478 * @load_options_path: name of a U-Boot environment variable. Its value is
479 * set as load options in the loaded image protocol.
480 * Return: status code
482 static efi_status_t bootefi_test_prepare
483 (struct efi_loaded_image_obj **image_objp,
484 struct efi_loaded_image **loaded_image_infop, const char *path,
485 const char *load_options_path)
489 /* Construct a dummy device path */
490 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
491 if (!bootefi_device_path)
492 return EFI_OUT_OF_RESOURCES;
494 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
495 if (!bootefi_image_path) {
496 ret = EFI_OUT_OF_RESOURCES;
500 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
501 bootefi_image_path, image_objp,
503 if (ret == EFI_SUCCESS)
506 efi_free_pool(bootefi_image_path);
507 bootefi_image_path = NULL;
509 efi_free_pool(bootefi_device_path);
510 bootefi_device_path = NULL;
515 * bootefi_run_finish() - finish up after running an EFI test
517 * @loaded_image_info: Pointer to a struct which holds the loaded image info
518 * @image_obj: Pointer to a struct which holds the loaded image object
520 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
521 struct efi_loaded_image *loaded_image_info)
524 free(loaded_image_info->load_options);
525 efi_delete_handle(&image_obj->header);
529 * do_efi_selftest() - execute EFI selftest
531 * Return: status code
533 static int do_efi_selftest(void)
535 struct efi_loaded_image_obj *image_obj;
536 struct efi_loaded_image *loaded_image_info;
539 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
540 "\\selftest", "efi_selftest");
541 if (ret != EFI_SUCCESS)
542 return CMD_RET_FAILURE;
544 /* Execute the test */
545 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
546 bootefi_run_finish(image_obj, loaded_image_info);
548 return ret != EFI_SUCCESS;
550 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
553 * do_bootefi() - execute `bootefi` command
555 * @cmdtp: table entry describing command
556 * @flag: bitmap indicating how the command was invoked
557 * @argc: number of arguments
558 * @argv: command line arguments
559 * Return: status code
561 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
567 return CMD_RET_USAGE;
569 /* Initialize EFI drivers */
570 ret = efi_init_obj_list();
571 if (ret != EFI_SUCCESS) {
572 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
573 ret & ~EFI_ERROR_MASK);
574 return CMD_RET_FAILURE;
578 fdt_addr = simple_strtoul(argv[2], NULL, 16);
580 fdt_addr = EFI_FDT_USE_INTERNAL;
581 ret = efi_install_fdt(fdt_addr);
582 if (ret == EFI_INVALID_PARAMETER)
583 return CMD_RET_USAGE;
584 else if (ret != EFI_SUCCESS)
585 return CMD_RET_FAILURE;
587 if (!strcmp(argv[1], "bootmgr"))
588 return do_efibootmgr();
589 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
590 else if (!strcmp(argv[1], "selftest"))
591 return do_efi_selftest();
594 return do_bootefi_image(argv[1]);
597 #ifdef CONFIG_SYS_LONGHELP
598 static char bootefi_help_text[] =
599 "<image address> [fdt address]\n"
600 " - boot EFI payload stored at address <image address>.\n"
601 " If specified, the device tree located at <fdt address> gets\n"
602 " exposed as EFI configuration table.\n"
603 #ifdef CONFIG_CMD_BOOTEFI_HELLO
605 " - boot a sample Hello World application stored within U-Boot\n"
607 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
608 "bootefi selftest [fdt address]\n"
609 " - boot an EFI selftest application stored within U-Boot\n"
610 " Use environment variable efi_selftest to select a single test.\n"
611 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
613 "bootefi bootmgr [fdt address]\n"
614 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
616 " If specified, the device tree located at <fdt address> gets\n"
617 " exposed as EFI configuration table.\n";
621 bootefi, 3, 0, do_bootefi,
622 "Boots an EFI payload from memory",
627 * efi_set_bootdev() - set boot device
629 * This function is called when a file is loaded, e.g. via the 'load' command.
630 * We use the path to this file to inform the UEFI binary about the boot device.
632 * @dev: device, e.g. "MMC"
633 * @devnr: number of the device, e.g. "1:2"
634 * @path: path to file loaded
636 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
638 struct efi_device_path *device, *image;
641 /* efi_set_bootdev is typically called repeatedly, recover memory */
642 efi_free_pool(bootefi_device_path);
643 efi_free_pool(bootefi_image_path);
645 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
646 if (ret == EFI_SUCCESS) {
647 bootefi_device_path = device;
649 /* FIXME: image should not contain device */
650 struct efi_device_path *image_tmp = image;
652 efi_dp_split_file_path(image, &device, &image);
653 efi_free_pool(image_tmp);
655 bootefi_image_path = image;
657 bootefi_device_path = NULL;
658 bootefi_image_path = NULL;