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>
18 #include <linux/libfdt.h>
19 #include <linux/libfdt_env.h>
22 #include <asm-generic/sections.h>
23 #include <linux/linkage.h>
25 DECLARE_GLOBAL_DATA_PTR;
27 static struct efi_device_path *bootefi_image_path;
28 static struct efi_device_path *bootefi_device_path;
31 * Set the load options of an image from an environment variable.
33 * @handle: the image handle
34 * @env_var: name of the environment variable
35 * @load_options: pointer to load options (output)
38 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var,
41 struct efi_loaded_image *loaded_image_info;
43 const char *env = env_get(env_var);
48 ret = EFI_CALL(systab.boottime->open_protocol(
50 &efi_guid_loaded_image,
51 (void **)&loaded_image_info,
53 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
54 if (ret != EFI_SUCCESS)
55 return EFI_INVALID_PARAMETER;
57 loaded_image_info->load_options = NULL;
58 loaded_image_info->load_options_size = 0;
62 size = utf8_utf16_strlen(env) + 1;
63 loaded_image_info->load_options = calloc(size, sizeof(u16));
64 if (!loaded_image_info->load_options) {
65 printf("ERROR: Out of memory\n");
66 EFI_CALL(systab.boottime->close_protocol(handle,
67 &efi_guid_loaded_image,
69 return EFI_OUT_OF_RESOURCES;
71 pos = loaded_image_info->load_options;
73 utf8_utf16_strcpy(&pos, env);
74 loaded_image_info->load_options_size = size * 2;
77 return EFI_CALL(systab.boottime->close_protocol(handle,
78 &efi_guid_loaded_image,
82 #if !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
85 * copy_fdt() - Copy the device tree to a new location available to EFI
87 * The FDT is copied to a suitable location within the EFI memory map.
88 * Additional 12 KiB are added to the space in case the device tree needs to be
89 * expanded later with fdt_open_into().
91 * @fdtp: On entry a pointer to the flattened device tree.
92 * On exit a pointer to the copy of the flattened device tree.
96 static efi_status_t copy_fdt(void **fdtp)
98 unsigned long fdt_ram_start = -1L, fdt_pages;
105 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
106 u64 ram_start = gd->bd->bi_dram[i].start;
107 u64 ram_size = gd->bd->bi_dram[i].size;
112 if (ram_start < fdt_ram_start)
113 fdt_ram_start = ram_start;
117 * Give us at least 12 KiB of breathing room in case the device tree
118 * needs to be expanded later.
121 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
122 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
125 * Safe fdt location is at 127 MiB.
126 * On the sandbox convert from the sandbox address space.
128 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
130 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
131 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
133 if (ret != EFI_SUCCESS) {
134 /* If we can't put it there, put it somewhere */
135 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
136 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
137 EFI_ACPI_RECLAIM_MEMORY, fdt_pages,
139 if (ret != EFI_SUCCESS) {
140 printf("ERROR: Failed to reserve space for FDT\n");
144 new_fdt = (void *)(uintptr_t)new_fdt_addr;
145 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
146 fdt_set_totalsize(new_fdt, fdt_size);
148 *fdtp = (void *)(uintptr_t)new_fdt_addr;
153 static void efi_reserve_memory(u64 addr, u64 size)
155 /* Convert from sandbox address space. */
156 addr = (uintptr_t)map_sysmem(addr, 0);
157 if (efi_add_memory_map(addr, size,
158 EFI_RESERVED_MEMORY_TYPE) != EFI_SUCCESS)
159 printf("Reserved memory mapping failed addr %llx size %llx\n",
164 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
166 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
167 * ignored because this is not critical and we would rather continue to try to
170 * @fdt: Pointer to device tree
172 static void efi_carve_out_dt_rsv(void *fdt)
176 int nodeoffset, subnode;
178 nr_rsv = fdt_num_mem_rsv(fdt);
180 /* Look for an existing entry and add it to the efi mem map. */
181 for (i = 0; i < nr_rsv; i++) {
182 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
184 efi_reserve_memory(addr, size);
187 /* process reserved-memory */
188 nodeoffset = fdt_subnode_offset(fdt, 0, "reserved-memory");
189 if (nodeoffset >= 0) {
190 subnode = fdt_first_subnode(fdt, nodeoffset);
191 while (subnode >= 0) {
195 /* check if this subnode has a reg property */
196 fdt_addr = fdtdec_get_addr_size_auto_parent(
197 fdt, nodeoffset, subnode,
198 "reg", 0, &fdt_size, false);
200 * The /reserved-memory node may have children with
201 * a size instead of a reg property.
203 if (addr != FDT_ADDR_T_NONE &&
204 fdtdec_get_is_enabled(fdt, subnode))
205 efi_reserve_memory(fdt_addr, fdt_size);
206 subnode = fdt_next_subnode(fdt, subnode);
212 * get_config_table() - get configuration table
214 * @guid: GUID of the configuration table
215 * Return: pointer to configuration table or NULL
217 static void *get_config_table(const efi_guid_t *guid)
221 for (i = 0; i < systab.nr_tables; i++) {
222 if (!guidcmp(guid, &systab.tables[i].guid))
223 return systab.tables[i].table;
228 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
231 * efi_install_fdt() - install device tree
233 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
234 * address will will be installed as configuration table, otherwise the device
235 * tree located at the address indicated by environment variable fdt_addr or as
236 * fallback fdtcontroladdr will be used.
238 * On architectures using ACPI tables device trees shall not be installed as
239 * configuration table.
241 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
242 * the hardware device tree as indicated by environment variable
243 * fdt_addr or as fallback the internal device tree as indicated by
244 * the environment variable fdtcontroladdr
245 * Return: status code
247 efi_status_t efi_install_fdt(void *fdt)
250 * The EBBR spec requires that we have either an FDT or an ACPI table
253 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
255 printf("ERROR: can't have ACPI table and device tree.\n");
256 return EFI_LOAD_ERROR;
259 bootm_headers_t img = { 0 };
262 if (fdt == EFI_FDT_USE_INTERNAL) {
266 /* Look for device tree that is already installed */
267 if (get_config_table(&efi_guid_fdt))
269 /* Check if there is a hardware device tree */
270 fdt_opt = env_get("fdt_addr");
271 /* Use our own device tree as fallback */
273 fdt_opt = env_get("fdtcontroladdr");
275 printf("ERROR: need device tree\n");
276 return EFI_NOT_FOUND;
279 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
281 printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
282 return EFI_LOAD_ERROR;
284 fdt = map_sysmem(fdt_addr, 0);
287 /* Install device tree */
288 if (fdt_check_header(fdt)) {
289 printf("ERROR: invalid device tree\n");
290 return EFI_LOAD_ERROR;
293 /* Prepare device tree for payload */
294 ret = copy_fdt(&fdt);
296 printf("ERROR: out of memory\n");
297 return EFI_OUT_OF_RESOURCES;
300 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
301 printf("ERROR: failed to process device tree\n");
302 return EFI_LOAD_ERROR;
305 /* Create memory reservations as indicated by the device tree */
306 efi_carve_out_dt_rsv(fdt);
308 /* Install device tree as UEFI table */
309 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
310 if (ret != EFI_SUCCESS) {
311 printf("ERROR: failed to install device tree\n");
314 #endif /* GENERATE_ACPI_TABLE */
320 * do_bootefi_exec() - execute EFI binary
322 * @handle: handle of loaded image
323 * Return: status code
325 * Load the EFI binary into a newly assigned memory unwinding the relocation
326 * information, install the loaded image protocol, and call the binary.
328 static efi_status_t do_bootefi_exec(efi_handle_t handle)
331 efi_uintn_t exit_data_size = 0;
332 u16 *exit_data = NULL;
335 /* Transfer environment variable as load options */
336 ret = set_load_options(handle, "bootargs", &load_options);
337 if (ret != EFI_SUCCESS)
340 /* Call our payload! */
341 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
342 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
343 if (ret && exit_data) {
344 printf("## %ls\n", exit_data);
345 efi_free_pool(exit_data);
356 * do_efibootmgr() - execute EFI boot manager
358 * Return: status code
360 static int do_efibootmgr(void)
365 ret = efi_bootmgr_load(&handle);
366 if (ret != EFI_SUCCESS) {
367 printf("EFI boot manager: Cannot load any image\n");
368 return CMD_RET_FAILURE;
371 ret = do_bootefi_exec(handle);
373 if (ret != EFI_SUCCESS)
374 return CMD_RET_FAILURE;
376 return CMD_RET_SUCCESS;
380 * do_bootefi_image() - execute EFI binary
382 * Set up memory image for the binary to be loaded, prepare device path, and
383 * then call do_bootefi_exec() to execute it.
385 * @image_opt: string of image start address
386 * Return: status code
388 static int do_bootefi_image(const char *image_opt)
391 unsigned long addr, size;
392 const char *size_str;
395 #ifdef CONFIG_CMD_BOOTEFI_HELLO
396 if (!strcmp(image_opt, "hello")) {
399 saddr = env_get("loadaddr");
400 size = __efi_helloworld_end - __efi_helloworld_begin;
403 addr = simple_strtoul(saddr, NULL, 16);
405 addr = CONFIG_SYS_LOAD_ADDR;
407 image_buf = map_sysmem(addr, size);
408 memcpy(image_buf, __efi_helloworld_begin, size);
410 efi_free_pool(bootefi_device_path);
411 efi_free_pool(bootefi_image_path);
412 bootefi_device_path = NULL;
413 bootefi_image_path = NULL;
417 size_str = env_get("filesize");
419 size = simple_strtoul(size_str, NULL, 16);
423 addr = simple_strtoul(image_opt, NULL, 16);
424 /* Check that a numeric value was passed */
425 if (!addr && *image_opt != '0')
426 return CMD_RET_USAGE;
428 image_buf = map_sysmem(addr, size);
430 ret = efi_run_image(image_buf, size);
432 if (ret != EFI_SUCCESS)
433 return CMD_RET_FAILURE;
435 return CMD_RET_SUCCESS;
439 * efi_run_image() - run loaded UEFI image
441 * @source_buffer: memory address of the UEFI image
442 * @source_size: size of the UEFI image
443 * Return: status code
445 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
447 efi_handle_t mem_handle = NULL, handle;
448 struct efi_device_path *file_path = NULL;
451 if (!bootefi_device_path || !bootefi_image_path) {
453 * Special case for efi payload not loaded from disk,
454 * such as 'bootefi hello' or for example payload
455 * loaded directly into memory via JTAG, etc:
457 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
458 (uintptr_t)source_buffer,
461 * Make sure that device for device_path exist
462 * in load_image(). Otherwise, shell and grub will fail.
464 ret = efi_create_handle(&mem_handle);
465 if (ret != EFI_SUCCESS)
468 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
470 if (ret != EFI_SUCCESS)
473 file_path = efi_dp_append(bootefi_device_path,
477 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
478 source_size, &handle));
479 if (ret != EFI_SUCCESS)
482 ret = do_bootefi_exec(handle);
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 set_load_options((efi_handle_t)*image_objp, load_options_path,
511 * bootefi_test_prepare() - prepare to run an EFI test
513 * Prepare to run a test as if it were provided by a loaded image.
515 * @image_objp: pointer to be set to the loaded image handle
516 * @loaded_image_infop: pointer to be set to the loaded image protocol
517 * @path: dummy file path used to construct the device path
518 * set in the loaded image protocol
519 * @load_options_path: name of a U-Boot environment variable. Its value is
520 * set as load options in the loaded image protocol.
521 * Return: status code
523 static efi_status_t bootefi_test_prepare
524 (struct efi_loaded_image_obj **image_objp,
525 struct efi_loaded_image **loaded_image_infop, const char *path,
526 const char *load_options_path)
530 /* Construct a dummy device path */
531 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
532 if (!bootefi_device_path)
533 return EFI_OUT_OF_RESOURCES;
535 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
536 if (!bootefi_image_path) {
537 ret = EFI_OUT_OF_RESOURCES;
541 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
542 bootefi_image_path, image_objp,
544 if (ret == EFI_SUCCESS)
547 efi_free_pool(bootefi_image_path);
548 bootefi_image_path = NULL;
550 efi_free_pool(bootefi_device_path);
551 bootefi_device_path = NULL;
556 * bootefi_run_finish() - finish up after running an EFI test
558 * @loaded_image_info: Pointer to a struct which holds the loaded image info
559 * @image_obj: Pointer to a struct which holds the loaded image object
561 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
562 struct efi_loaded_image *loaded_image_info)
565 free(loaded_image_info->load_options);
566 efi_delete_handle(&image_obj->header);
570 * do_efi_selftest() - execute EFI selftest
572 * Return: status code
574 static int do_efi_selftest(void)
576 struct efi_loaded_image_obj *image_obj;
577 struct efi_loaded_image *loaded_image_info;
580 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
581 "\\selftest", "efi_selftest");
582 if (ret != EFI_SUCCESS)
583 return CMD_RET_FAILURE;
585 /* Execute the test */
586 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
587 bootefi_run_finish(image_obj, loaded_image_info);
589 return ret != EFI_SUCCESS;
591 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
594 * do_bootefi() - execute `bootefi` command
596 * @cmdtp: table entry describing command
597 * @flag: bitmap indicating how the command was invoked
598 * @argc: number of arguments
599 * @argv: command line arguments
600 * Return: status code
602 static int do_bootefi(struct cmd_tbl *cmdtp, int flag, int argc,
609 return CMD_RET_USAGE;
611 /* Initialize EFI drivers */
612 ret = efi_init_obj_list();
613 if (ret != EFI_SUCCESS) {
614 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
615 ret & ~EFI_ERROR_MASK);
616 return CMD_RET_FAILURE;
622 fdt_addr = simple_strtoul(argv[2], NULL, 16);
623 fdt = map_sysmem(fdt_addr, 0);
625 fdt = EFI_FDT_USE_INTERNAL;
627 ret = efi_install_fdt(fdt);
628 if (ret == EFI_INVALID_PARAMETER)
629 return CMD_RET_USAGE;
630 else if (ret != EFI_SUCCESS)
631 return CMD_RET_FAILURE;
633 if (!strcmp(argv[1], "bootmgr"))
634 return do_efibootmgr();
635 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
636 else if (!strcmp(argv[1], "selftest"))
637 return do_efi_selftest();
640 return do_bootefi_image(argv[1]);
643 #ifdef CONFIG_SYS_LONGHELP
644 static char bootefi_help_text[] =
645 "<image address> [fdt address]\n"
646 " - boot EFI payload stored at address <image address>.\n"
647 " If specified, the device tree located at <fdt address> gets\n"
648 " exposed as EFI configuration table.\n"
649 #ifdef CONFIG_CMD_BOOTEFI_HELLO
651 " - boot a sample Hello World application stored within U-Boot\n"
653 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
654 "bootefi selftest [fdt address]\n"
655 " - boot an EFI selftest application stored within U-Boot\n"
656 " Use environment variable efi_selftest to select a single test.\n"
657 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
659 "bootefi bootmgr [fdt address]\n"
660 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
662 " If specified, the device tree located at <fdt address> gets\n"
663 " exposed as EFI configuration table.\n";
667 bootefi, 3, 0, do_bootefi,
668 "Boots an EFI payload from memory",
673 * efi_set_bootdev() - set boot device
675 * This function is called when a file is loaded, e.g. via the 'load' command.
676 * We use the path to this file to inform the UEFI binary about the boot device.
678 * @dev: device, e.g. "MMC"
679 * @devnr: number of the device, e.g. "1:2"
680 * @path: path to file loaded
682 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
684 struct efi_device_path *device, *image;
687 /* efi_set_bootdev is typically called repeatedly, recover memory */
688 efi_free_pool(bootefi_device_path);
689 efi_free_pool(bootefi_image_path);
691 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
692 if (ret == EFI_SUCCESS) {
693 bootefi_device_path = device;
695 /* FIXME: image should not contain device */
696 struct efi_device_path *image_tmp = image;
698 efi_dp_split_file_path(image, &device, &image);
699 efi_free_pool(image_tmp);
701 bootefi_image_path = image;
703 bootefi_device_path = NULL;
704 bootefi_image_path = NULL;