1 // SPDX-License-Identifier: GPL-2.0+
3 * EFI application loader
5 * Copyright (c) 2016 Alexander Graf
13 #include <efi_loader.h>
14 #include <efi_selftest.h>
16 #include <linux/libfdt.h>
17 #include <linux/libfdt_env.h>
20 #include <asm/global_data.h>
21 #include <asm-generic/sections.h>
22 #include <asm-generic/unaligned.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 * Allow unaligned memory access.
33 * This routine is overridden by architectures providing this feature.
35 void __weak allow_unaligned(void)
40 * Set the load options of an image from an environment variable.
42 * @handle: the image handle
43 * @env_var: name of the environment variable
46 static efi_status_t set_load_options(efi_handle_t handle, const char *env_var)
48 struct efi_loaded_image *loaded_image_info;
50 const char *env = env_get(env_var);
54 ret = EFI_CALL(systab.boottime->open_protocol(
56 &efi_guid_loaded_image,
57 (void **)&loaded_image_info,
59 EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL));
60 if (ret != EFI_SUCCESS)
61 return EFI_INVALID_PARAMETER;
63 loaded_image_info->load_options = NULL;
64 loaded_image_info->load_options_size = 0;
68 size = utf8_utf16_strlen(env) + 1;
69 loaded_image_info->load_options = calloc(size, sizeof(u16));
70 if (!loaded_image_info->load_options) {
71 printf("ERROR: Out of memory\n");
72 EFI_CALL(systab.boottime->close_protocol(handle,
73 &efi_guid_loaded_image,
75 return EFI_OUT_OF_RESOURCES;
77 pos = loaded_image_info->load_options;
78 utf8_utf16_strcpy(&pos, env);
79 loaded_image_info->load_options_size = size * 2;
82 return EFI_CALL(systab.boottime->close_protocol(handle,
83 &efi_guid_loaded_image,
88 * copy_fdt() - Copy the device tree to a new location available to EFI
90 * The FDT is copied to a suitable location within the EFI memory map.
91 * Additional 12 KiB are added to the space in case the device tree needs to be
92 * expanded later with fdt_open_into().
94 * @fdtp: On entry a pointer to the flattened device tree.
95 * On exit a pointer to the copy of the flattened device tree.
99 static efi_status_t copy_fdt(void **fdtp)
101 unsigned long fdt_ram_start = -1L, fdt_pages;
102 efi_status_t ret = 0;
108 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
109 u64 ram_start = gd->bd->bi_dram[i].start;
110 u64 ram_size = gd->bd->bi_dram[i].size;
115 if (ram_start < fdt_ram_start)
116 fdt_ram_start = ram_start;
120 * Give us at least 12 KiB of breathing room in case the device tree
121 * needs to be expanded later.
124 fdt_pages = efi_size_in_pages(fdt_totalsize(fdt) + 0x3000);
125 fdt_size = fdt_pages << EFI_PAGE_SHIFT;
128 * Safe fdt location is at 127 MiB.
129 * On the sandbox convert from the sandbox address space.
131 new_fdt_addr = (uintptr_t)map_sysmem(fdt_ram_start + 0x7f00000 +
133 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
134 EFI_BOOT_SERVICES_DATA, fdt_pages,
136 if (ret != EFI_SUCCESS) {
137 /* If we can't put it there, put it somewhere */
138 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
139 ret = efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
140 EFI_BOOT_SERVICES_DATA, fdt_pages,
142 if (ret != EFI_SUCCESS) {
143 printf("ERROR: Failed to reserve space for FDT\n");
147 new_fdt = (void *)(uintptr_t)new_fdt_addr;
148 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
149 fdt_set_totalsize(new_fdt, fdt_size);
151 *fdtp = (void *)(uintptr_t)new_fdt_addr;
157 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
159 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
160 * ignored because this is not critical and we would rather continue to try to
163 * @fdt: Pointer to device tree
165 static void efi_carve_out_dt_rsv(void *fdt)
168 uint64_t addr, size, pages;
170 nr_rsv = fdt_num_mem_rsv(fdt);
172 /* Look for an existing entry and add it to the efi mem map. */
173 for (i = 0; i < nr_rsv; i++) {
174 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
177 /* Convert from sandbox address space. */
178 addr = (uintptr_t)map_sysmem(addr, 0);
180 pages = efi_size_in_pages(size + (addr & EFI_PAGE_MASK));
181 addr &= ~EFI_PAGE_MASK;
182 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
184 printf("FDT memrsv map %d: Failed to add to map\n", i);
189 * efi_install_fdt() - install fdt passed by a command argument
190 * @fdt_opt: pointer to argument
191 * Return: status code
193 * If specified, fdt will be installed as configuration table,
194 * otherwise no fdt will be passed.
196 static efi_status_t efi_install_fdt(const char *fdt_opt)
198 unsigned long fdt_addr;
200 bootm_headers_t img = { 0 };
204 /* Install device tree */
205 fdt_addr = simple_strtoul(fdt_opt, NULL, 16);
206 if (!fdt_addr && *fdt_opt != '0')
207 return EFI_INVALID_PARAMETER;
209 fdt = map_sysmem(fdt_addr, 0);
210 if (fdt_check_header(fdt)) {
211 printf("ERROR: invalid device tree\n");
212 return EFI_INVALID_PARAMETER;
215 /* Create memory reservation as indicated by the device tree */
216 efi_carve_out_dt_rsv(fdt);
218 /* Prepare fdt for payload */
219 ret = copy_fdt(&fdt);
223 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
224 printf("ERROR: failed to process device tree\n");
225 return EFI_LOAD_ERROR;
228 /* Link to it in the efi tables */
229 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
230 if (ret != EFI_SUCCESS) {
231 printf("ERROR: failed to install device tree\n");
235 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
236 efi_install_configuration_table(&efi_guid_fdt, NULL);
243 * do_bootefi_exec() - execute EFI binary
245 * @efi: address of the binary
246 * @device_path: path of the device from which the binary was loaded
247 * @image_path: device path of the binary
248 * Return: status code
250 * Load the EFI binary into a newly assigned memory unwinding the relocation
251 * information, install the loaded image protocol, and call the binary.
253 static efi_status_t do_bootefi_exec(void *efi,
254 struct efi_device_path *device_path,
255 struct efi_device_path *image_path)
257 efi_handle_t mem_handle = NULL;
258 struct efi_device_path *memdp = NULL;
260 struct efi_loaded_image_obj *image_obj = NULL;
261 struct efi_loaded_image *loaded_image_info = NULL;
264 * Special case for efi payload not loaded from disk, such as
265 * 'bootefi hello' or for example payload loaded directly into
266 * memory via JTAG, etc:
268 if (!device_path && !image_path) {
269 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
270 /* actual addresses filled in after efi_load_pe() */
271 memdp = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
272 device_path = image_path = memdp;
274 * Grub expects that the device path of the loaded image is
275 * installed on a handle.
277 ret = efi_create_handle(&mem_handle);
278 if (ret != EFI_SUCCESS)
279 return ret; /* TODO: leaks device_path */
280 ret = efi_add_protocol(mem_handle, &efi_guid_device_path,
282 if (ret != EFI_SUCCESS)
283 goto err_add_protocol;
285 assert(device_path && image_path);
288 ret = efi_setup_loaded_image(device_path, image_path, &image_obj,
293 /* Transfer environment variable as load options */
294 ret = set_load_options((efi_handle_t)image_obj, "bootargs");
295 if (ret != EFI_SUCCESS)
298 /* Load the EFI payload */
299 ret = efi_load_pe(image_obj, efi, loaded_image_info);
300 if (ret != EFI_SUCCESS)
304 struct efi_device_path_memory *mdp = (void *)memdp;
305 mdp->memory_type = loaded_image_info->image_code_type;
306 mdp->start_address = (uintptr_t)loaded_image_info->image_base;
307 mdp->end_address = mdp->start_address +
308 loaded_image_info->image_size;
311 /* we don't support much: */
312 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
313 "{ro,boot}(blob)0000000000000000");
315 /* Call our payload! */
316 debug("%s: Jumping to 0x%p\n", __func__, image_obj->entry);
317 ret = EFI_CALL(efi_start_image(&image_obj->header, NULL, NULL));
320 /* image has returned, loaded-image obj goes *poof*: */
322 free(loaded_image_info->load_options);
323 efi_delete_handle(&image_obj->header);
327 efi_delete_handle(mem_handle);
333 * do_efibootmgr() - execute EFI Boot Manager
335 * @fdt_opt: string of fdt start address
336 * Return: status code
338 * Execute EFI Boot Manager
340 static int do_efibootmgr(const char *fdt_opt)
342 struct efi_device_path *device_path, *file_path;
346 /* Allow unaligned memory access */
349 switch_to_non_secure_mode();
351 /* Initialize EFI drivers */
352 ret = efi_init_obj_list();
353 if (ret != EFI_SUCCESS) {
354 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
355 ret & ~EFI_ERROR_MASK);
356 return CMD_RET_FAILURE;
359 ret = efi_install_fdt(fdt_opt);
360 if (ret == EFI_INVALID_PARAMETER)
361 return CMD_RET_USAGE;
362 else if (ret != EFI_SUCCESS)
363 return CMD_RET_FAILURE;
365 addr = efi_bootmgr_load(&device_path, &file_path);
369 printf("## Starting EFI application at %p ...\n", addr);
370 ret = do_bootefi_exec(addr, device_path, file_path);
371 printf("## Application terminated, r = %lu\n",
372 ret & ~EFI_ERROR_MASK);
374 if (ret != EFI_SUCCESS)
380 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
381 static efi_status_t bootefi_run_prepare(const char *load_options_path,
382 struct efi_device_path *device_path,
383 struct efi_device_path *image_path,
384 struct efi_loaded_image_obj **image_objp,
385 struct efi_loaded_image **loaded_image_infop)
389 ret = efi_setup_loaded_image(device_path, image_path, image_objp,
391 if (ret != EFI_SUCCESS)
394 /* Transfer environment variable as load options */
395 return set_load_options((efi_handle_t)*image_objp, load_options_path);
399 * bootefi_test_prepare() - prepare to run an EFI test
401 * Prepare to run a test as if it were provided by a loaded image.
403 * @image_objp: pointer to be set to the loaded image handle
404 * @loaded_image_infop: pointer to be set to the loaded image protocol
405 * @path: dummy file path used to construct the device path
406 * set in the loaded image protocol
407 * @load_options_path: name of a U-Boot environment variable. Its value is
408 * set as load options in the loaded image protocol.
409 * Return: status code
411 static efi_status_t bootefi_test_prepare
412 (struct efi_loaded_image_obj **image_objp,
413 struct efi_loaded_image **loaded_image_infop, const char *path,
414 const char *load_options_path)
418 /* Construct a dummy device path */
419 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE, 0, 0);
420 if (!bootefi_device_path)
421 return EFI_OUT_OF_RESOURCES;
423 bootefi_image_path = efi_dp_from_file(NULL, 0, path);
424 if (!bootefi_image_path) {
425 ret = EFI_OUT_OF_RESOURCES;
429 ret = bootefi_run_prepare(load_options_path, bootefi_device_path,
430 bootefi_image_path, image_objp,
432 if (ret == EFI_SUCCESS)
435 efi_free_pool(bootefi_image_path);
436 bootefi_image_path = NULL;
438 efi_free_pool(bootefi_device_path);
439 bootefi_device_path = NULL;
444 * bootefi_run_finish() - finish up after running an EFI test
446 * @loaded_image_info: Pointer to a struct which holds the loaded image info
447 * @image_obj: Pointer to a struct which holds the loaded image object
449 static void bootefi_run_finish(struct efi_loaded_image_obj *image_obj,
450 struct efi_loaded_image *loaded_image_info)
453 free(loaded_image_info->load_options);
454 efi_delete_handle(&image_obj->header);
458 * do_efi_selftest() - execute EFI Selftest
460 * @fdt_opt: string of fdt start address
461 * Return: status code
463 * Execute EFI Selftest
465 static int do_efi_selftest(const char *fdt_opt)
467 struct efi_loaded_image_obj *image_obj;
468 struct efi_loaded_image *loaded_image_info;
471 /* Allow unaligned memory access */
474 switch_to_non_secure_mode();
476 /* Initialize EFI drivers */
477 ret = efi_init_obj_list();
478 if (ret != EFI_SUCCESS) {
479 printf("Error: Cannot initialize UEFI sub-system, r = %lu\n",
480 ret & ~EFI_ERROR_MASK);
481 return CMD_RET_FAILURE;
484 ret = efi_install_fdt(fdt_opt);
485 if (ret == EFI_INVALID_PARAMETER)
486 return CMD_RET_USAGE;
487 else if (ret != EFI_SUCCESS)
488 return CMD_RET_FAILURE;
490 ret = bootefi_test_prepare(&image_obj, &loaded_image_info,
491 "\\selftest", "efi_selftest");
492 if (ret != EFI_SUCCESS)
493 return CMD_RET_FAILURE;
495 /* Execute the test */
496 ret = EFI_CALL(efi_selftest(&image_obj->header, &systab));
497 bootefi_run_finish(image_obj, loaded_image_info);
499 return ret != EFI_SUCCESS;
501 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
503 /* Interpreter command to boot an arbitrary EFI image from memory */
504 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
511 return CMD_RET_USAGE;
513 if (!strcmp(argv[1], "bootmgr"))
514 return do_efibootmgr(argc > 2 ? argv[2] : NULL);
515 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
516 else if (!strcmp(argv[1], "selftest"))
517 return do_efi_selftest(argc > 2 ? argv[2] : NULL);
520 /* Allow unaligned memory access */
523 switch_to_non_secure_mode();
525 /* Initialize EFI drivers */
526 r = efi_init_obj_list();
527 if (r != EFI_SUCCESS) {
528 printf("Error: Cannot set up EFI drivers, r = %lu\n",
529 r & ~EFI_ERROR_MASK);
530 return CMD_RET_FAILURE;
533 r = efi_install_fdt(argc > 2 ? argv[2] : NULL);
534 if (r == EFI_INVALID_PARAMETER)
535 return CMD_RET_USAGE;
536 else if (r != EFI_SUCCESS)
537 return CMD_RET_FAILURE;
539 #ifdef CONFIG_CMD_BOOTEFI_HELLO
540 if (!strcmp(argv[1], "hello")) {
541 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
543 saddr = env_get("loadaddr");
545 addr = simple_strtoul(saddr, NULL, 16);
547 addr = CONFIG_SYS_LOAD_ADDR;
548 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
554 addr = simple_strtoul(saddr, NULL, 16);
555 /* Check that a numeric value was passed */
556 if (!addr && *saddr != '0')
557 return CMD_RET_USAGE;
561 printf("## Starting EFI application at %08lx ...\n", addr);
562 r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
564 printf("## Application terminated, r = %lu\n",
565 r & ~EFI_ERROR_MASK);
567 if (r != EFI_SUCCESS)
573 #ifdef CONFIG_SYS_LONGHELP
574 static char bootefi_help_text[] =
575 "<image address> [fdt address]\n"
576 " - boot EFI payload stored at address <image address>.\n"
577 " If specified, the device tree located at <fdt address> gets\n"
578 " exposed as EFI configuration table.\n"
579 #ifdef CONFIG_CMD_BOOTEFI_HELLO
581 " - boot a sample Hello World application stored within U-Boot\n"
583 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
584 "bootefi selftest [fdt address]\n"
585 " - boot an EFI selftest application stored within U-Boot\n"
586 " Use environment variable efi_selftest to select a single test.\n"
587 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
589 "bootefi bootmgr [fdt addr]\n"
590 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
592 " If specified, the device tree located at <fdt address> gets\n"
593 " exposed as EFI configuration table.\n";
597 bootefi, 3, 0, do_bootefi,
598 "Boots an EFI payload from memory",
602 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
604 struct efi_device_path *device, *image;
607 /* efi_set_bootdev is typically called repeatedly, recover memory */
608 efi_free_pool(bootefi_device_path);
609 efi_free_pool(bootefi_image_path);
611 ret = efi_dp_from_name(dev, devnr, path, &device, &image);
612 if (ret == EFI_SUCCESS) {
613 bootefi_device_path = device;
614 bootefi_image_path = image;
616 bootefi_device_path = NULL;
617 bootefi_image_path = NULL;