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)
156 /* Convert from sandbox address space. */
157 addr = (uintptr_t)map_sysmem(addr, 0);
158 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
159 addr &= ~EFI_PAGE_MASK;
160 if (efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
161 false) != EFI_SUCCESS)
162 printf("Reserved memory mapping failed addr %llx size %llx\n",
167 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
169 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
170 * ignored because this is not critical and we would rather continue to try to
173 * @fdt: Pointer to device tree
175 static void efi_carve_out_dt_rsv(void *fdt)
179 int nodeoffset, subnode;
181 nr_rsv = fdt_num_mem_rsv(fdt);
183 /* Look for an existing entry and add it to the efi mem map. */
184 for (i = 0; i < nr_rsv; i++) {
185 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
187 efi_reserve_memory(addr, size);
190 /* process reserved-memory */
191 nodeoffset = fdt_subnode_offset(fdt, 0, "reserved-memory");
192 if (nodeoffset >= 0) {
193 subnode = fdt_first_subnode(fdt, nodeoffset);
194 while (subnode >= 0) {
195 /* check if this subnode has a reg property */
196 addr = fdtdec_get_addr_size(fdt, subnode, "reg",
197 (fdt_size_t *)&size);
199 * The /reserved-memory node may have children with
200 * a size instead of a reg property.
202 if (addr != FDT_ADDR_T_NONE &&
203 fdtdec_get_is_enabled(fdt, subnode))
204 efi_reserve_memory(addr, size);
205 subnode = fdt_next_subnode(fdt, subnode);
211 * get_config_table() - get configuration table
213 * @guid: GUID of the configuration table
214 * Return: pointer to configuration table or NULL
216 static void *get_config_table(const efi_guid_t *guid)
220 for (i = 0; i < systab.nr_tables; i++) {
221 if (!guidcmp(guid, &systab.tables[i].guid))
222 return systab.tables[i].table;
227 #endif /* !CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE) */
230 * efi_install_fdt() - install device tree
232 * If fdt is not EFI_FDT_USE_INTERNAL, the device tree located at that memory
233 * address will will be installed as configuration table, otherwise the device
234 * tree located at the address indicated by environment variable fdt_addr or as
235 * fallback fdtcontroladdr will be used.
237 * On architectures using ACPI tables device trees shall not be installed as
238 * configuration table.
240 * @fdt: address of device tree or EFI_FDT_USE_INTERNAL to use the
241 * the hardware device tree as indicated by environment variable
242 * fdt_addr or as fallback the internal device tree as indicated by
243 * the environment variable fdtcontroladdr
244 * Return: status code
246 efi_status_t efi_install_fdt(void *fdt)
249 * The EBBR spec requires that we have either an FDT or an ACPI table
252 #if CONFIG_IS_ENABLED(GENERATE_ACPI_TABLE)
254 printf("ERROR: can't have ACPI table and device tree.\n");
255 return EFI_LOAD_ERROR;
258 bootm_headers_t img = { 0 };
261 if (fdt == EFI_FDT_USE_INTERNAL) {
265 /* Look for device tree that is already installed */
266 if (get_config_table(&efi_guid_fdt))
268 /* Check if there is a hardware device tree */
269 fdt_opt = env_get("fdt_addr");
270 /* Use our own device tree as fallback */
272 fdt_opt = env_get("fdtcontroladdr");
274 printf("ERROR: need device tree\n");
275 return EFI_NOT_FOUND;
278 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
280 printf("ERROR: invalid $fdt_addr or $fdtcontroladdr\n");
281 return EFI_LOAD_ERROR;
283 fdt = map_sysmem(fdt_addr, 0);
286 /* Install device tree */
287 if (fdt_check_header(fdt)) {
288 printf("ERROR: invalid device tree\n");
289 return EFI_LOAD_ERROR;
292 /* Prepare device tree for payload */
293 ret = copy_fdt(&fdt);
295 printf("ERROR: out of memory\n");
296 return EFI_OUT_OF_RESOURCES;
299 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
300 printf("ERROR: failed to process device tree\n");
301 return EFI_LOAD_ERROR;
304 /* Create memory reservations as indicated by the device tree */
305 efi_carve_out_dt_rsv(fdt);
307 /* Install device tree as UEFI table */
308 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
309 if (ret != EFI_SUCCESS) {
310 printf("ERROR: failed to install device tree\n");
313 #endif /* GENERATE_ACPI_TABLE */
319 * do_bootefi_exec() - execute EFI binary
321 * @handle: handle of loaded image
322 * Return: status code
324 * Load the EFI binary into a newly assigned memory unwinding the relocation
325 * information, install the loaded image protocol, and call the binary.
327 static efi_status_t do_bootefi_exec(efi_handle_t handle)
330 efi_uintn_t exit_data_size = 0;
331 u16 *exit_data = NULL;
334 /* Transfer environment variable as load options */
335 ret = set_load_options(handle, "bootargs", &load_options);
336 if (ret != EFI_SUCCESS)
339 /* Call our payload! */
340 ret = EFI_CALL(efi_start_image(handle, &exit_data_size, &exit_data));
341 printf("## Application terminated, r = %lu\n", ret & ~EFI_ERROR_MASK);
342 if (ret && exit_data) {
343 printf("## %ls\n", exit_data);
344 efi_free_pool(exit_data);
355 * do_efibootmgr() - execute EFI boot manager
357 * Return: status code
359 static int do_efibootmgr(void)
364 ret = efi_bootmgr_load(&handle);
365 if (ret != EFI_SUCCESS) {
366 printf("EFI boot manager: Cannot load any image\n");
367 return CMD_RET_FAILURE;
370 ret = do_bootefi_exec(handle);
372 if (ret != EFI_SUCCESS)
373 return CMD_RET_FAILURE;
375 return CMD_RET_SUCCESS;
379 * do_bootefi_image() - execute EFI binary
381 * Set up memory image for the binary to be loaded, prepare device path, and
382 * then call do_bootefi_exec() to execute it.
384 * @image_opt: string of image start address
385 * Return: status code
387 static int do_bootefi_image(const char *image_opt)
390 unsigned long addr, size;
391 const char *size_str;
394 #ifdef CONFIG_CMD_BOOTEFI_HELLO
395 if (!strcmp(image_opt, "hello")) {
398 saddr = env_get("loadaddr");
399 size = __efi_helloworld_end - __efi_helloworld_begin;
402 addr = simple_strtoul(saddr, NULL, 16);
404 addr = CONFIG_SYS_LOAD_ADDR;
406 image_buf = map_sysmem(addr, size);
407 memcpy(image_buf, __efi_helloworld_begin, size);
409 efi_free_pool(bootefi_device_path);
410 efi_free_pool(bootefi_image_path);
411 bootefi_device_path = NULL;
412 bootefi_image_path = NULL;
416 size_str = env_get("filesize");
418 size = simple_strtoul(size_str, NULL, 16);
422 addr = simple_strtoul(image_opt, NULL, 16);
423 /* Check that a numeric value was passed */
424 if (!addr && *image_opt != '0')
425 return CMD_RET_USAGE;
427 image_buf = map_sysmem(addr, size);
429 ret = efi_run_image(image_buf, size);
431 if (ret != EFI_SUCCESS)
432 return CMD_RET_FAILURE;
434 return CMD_RET_SUCCESS;
438 * efi_run_image() - run loaded UEFI image
440 * @source_buffer: memory address of the UEFI image
441 * @source_size: size of the UEFI image
442 * Return: status code
444 efi_status_t efi_run_image(void *source_buffer, efi_uintn_t source_size)
446 efi_handle_t mem_handle = NULL, handle;
447 struct efi_device_path *file_path = NULL;
450 if (!bootefi_device_path || !bootefi_image_path) {
452 * Special case for efi payload not loaded from disk,
453 * such as 'bootefi hello' or for example payload
454 * loaded directly into memory via JTAG, etc:
456 file_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
457 (uintptr_t)source_buffer,
460 * Make sure that device for device_path exist
461 * in load_image(). Otherwise, shell and grub will fail.
463 ret = efi_create_handle(&mem_handle);
464 if (ret != EFI_SUCCESS)
467 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
469 if (ret != EFI_SUCCESS)
472 file_path = efi_dp_append(bootefi_device_path,
476 ret = EFI_CALL(efi_load_image(false, efi_root, file_path, source_buffer,
477 source_size, &handle));
478 if (ret != EFI_SUCCESS)
481 ret = do_bootefi_exec(handle);
484 efi_delete_handle(mem_handle);
485 efi_free_pool(file_path);
489 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
490 static efi_status_t bootefi_run_prepare(const char *load_options_path,
491 struct efi_device_path *device_path,
492 struct efi_device_path *image_path,
493 struct efi_loaded_image_obj **image_objp,
494 struct efi_loaded_image **loaded_image_infop)
499 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
501 if (ret != EFI_SUCCESS)
504 /* Transfer environment variable as load options */
505 return set_load_options((efi_handle_t)*image_objp, load_options_path,
510 * bootefi_test_prepare() - prepare to run an EFI test
512 * Prepare to run a test as if it were provided by a loaded image.
514 * @image_objp: pointer to be set to the loaded image handle
515 * @loaded_image_infop: pointer to be set to the loaded image protocol
516 * @path: dummy file path used to construct the device path
517 * set in the loaded image protocol
518 * @load_options_path: name of a U-Boot environment variable. Its value is
519 * set as load options in the loaded image protocol.
520 * Return: status code
522 static efi_status_t bootefi_test_prepare
523 (struct efi_loaded_image_obj **image_objp,
524 struct efi_loaded_image **loaded_image_infop, const char *path,
525 const char *load_options_path)
529 /* Construct a dummy device path */
530 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
531 if (!bootefi_device_path)
532 return EFI_OUT_OF_RESOURCES;
534 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
535 if (!bootefi_image_path) {
536 ret = EFI_OUT_OF_RESOURCES;
540 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
541 bootefi_image_path, image_objp,
543 if (ret == EFI_SUCCESS)
546 efi_free_pool(bootefi_image_path);
547 bootefi_image_path = NULL;
549 efi_free_pool(bootefi_device_path);
550 bootefi_device_path = NULL;
555 * bootefi_run_finish() - finish up after running an EFI test
557 * @loaded_image_info: Pointer to a struct which holds the loaded image info
558 * @image_obj: Pointer to a struct which holds the loaded image object
560 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
561 struct efi_loaded_image *loaded_image_info)
564 free(loaded_image_info->load_options);
565 efi_delete_handle(&image_obj->header);
569 * do_efi_selftest() - execute EFI selftest
571 * Return: status code
573 static int do_efi_selftest(void)
575 struct efi_loaded_image_obj *image_obj;
576 struct efi_loaded_image *loaded_image_info;
579 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
580 "\\selftest", "efi_selftest");
581 if (ret != EFI_SUCCESS)
582 return CMD_RET_FAILURE;
584 /* Execute the test */
585 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
586 bootefi_run_finish(image_obj, loaded_image_info);
588 return ret != EFI_SUCCESS;
590 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
593 * do_bootefi() - execute `bootefi` command
595 * @cmdtp: table entry describing command
596 * @flag: bitmap indicating how the command was invoked
597 * @argc: number of arguments
598 * @argv: command line arguments
599 * Return: status code
601 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
607 return CMD_RET_USAGE;
609 /* Initialize EFI drivers */
610 ret = efi_init_obj_list();
611 if (ret != EFI_SUCCESS) {
612 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
613 ret & ~EFI_ERROR_MASK);
614 return CMD_RET_FAILURE;
620 fdt_addr = simple_strtoul(argv[2], NULL, 16);
621 fdt = map_sysmem(fdt_addr, 0);
623 fdt = EFI_FDT_USE_INTERNAL;
625 ret = efi_install_fdt(fdt);
626 if (ret == EFI_INVALID_PARAMETER)
627 return CMD_RET_USAGE;
628 else if (ret != EFI_SUCCESS)
629 return CMD_RET_FAILURE;
631 if (!strcmp(argv[1], "bootmgr"))
632 return do_efibootmgr();
633 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
634 else if (!strcmp(argv[1], "selftest"))
635 return do_efi_selftest();
638 return do_bootefi_image(argv[1]);
641 #ifdef CONFIG_SYS_LONGHELP
642 static char bootefi_help_text[] =
643 "<image address> [fdt address]\n"
644 " - boot EFI payload stored at address <image address>.\n"
645 " If specified, the device tree located at <fdt address> gets\n"
646 " exposed as EFI configuration table.\n"
647 #ifdef CONFIG_CMD_BOOTEFI_HELLO
649 " - boot a sample Hello World application stored within U-Boot\n"
651 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
652 "bootefi selftest [fdt address]\n"
653 " - boot an EFI selftest application stored within U-Boot\n"
654 " Use environment variable efi_selftest to select a single test.\n"
655 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
657 "bootefi bootmgr [fdt address]\n"
658 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
660 " If specified, the device tree located at <fdt address> gets\n"
661 " exposed as EFI configuration table.\n";
665 bootefi, 3, 0, do_bootefi,
666 "Boots an EFI payload from memory",
671 * efi_set_bootdev() - set boot device
673 * This function is called when a file is loaded, e.g. via the 'load' command.
674 * We use the path to this file to inform the UEFI binary about the boot device.
676 * @dev: device, e.g. "MMC"
677 * @devnr: number of the device, e.g. "1:2"
678 * @path: path to file loaded
680 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
682 struct efi_device_path *device, *image;
685 /* efi_set_bootdev is typically called repeatedly, recover memory */
686 efi_free_pool(bootefi_device_path);
687 efi_free_pool(bootefi_image_path);
689 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
690 if (ret == EFI_SUCCESS) {
691 bootefi_device_path = device;
693 /* FIXME: image should not contain device */
694 struct efi_device_path *image_tmp = image;
696 efi_dp_split_file_path(image, &device, &image);
697 efi_free_pool(image_tmp);
699 bootefi_image_path = image;
701 bootefi_device_path = NULL;
702 bootefi_image_path = NULL;