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>
15 #include <linux/libfdt.h>
16 #include <linux/libfdt_env.h>
19 #include <asm/global_data.h>
20 #include <asm-generic/sections.h>
21 #include <asm-generic/unaligned.h>
22 #include <linux/linkage.h>
24 #ifdef CONFIG_ARMV7_NONSEC
25 #include <asm/armv7.h>
26 #include <asm/secure.h>
29 DECLARE_GLOBAL_DATA_PTR
;
31 #define OBJ_LIST_NOT_INITIALIZED 1
33 static efi_status_t efi_obj_list_initialized
= OBJ_LIST_NOT_INITIALIZED
;
35 static struct efi_device_path
*bootefi_image_path
;
36 static struct efi_device_path
*bootefi_device_path
;
38 /* Initialize and populate EFI object list */
39 efi_status_t
efi_init_obj_list(void)
41 efi_status_t ret
= EFI_SUCCESS
;
44 * On the ARM architecture gd is mapped to a fixed register (r9 or x18).
45 * As this register may be overwritten by an EFI payload we save it here
46 * and restore it on every callback entered.
50 /* Initialize once only */
51 if (efi_obj_list_initialized
!= OBJ_LIST_NOT_INITIALIZED
)
52 return efi_obj_list_initialized
;
54 /* Initialize system table */
55 ret
= efi_initialize_system_table();
56 if (ret
!= EFI_SUCCESS
)
59 /* Initialize root node */
60 ret
= efi_root_node_register();
61 if (ret
!= EFI_SUCCESS
)
64 /* Initialize EFI driver uclass */
65 ret
= efi_driver_init();
66 if (ret
!= EFI_SUCCESS
)
69 ret
= efi_console_register();
70 if (ret
!= EFI_SUCCESS
)
72 #ifdef CONFIG_PARTITIONS
73 ret
= efi_disk_register();
74 if (ret
!= EFI_SUCCESS
)
77 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
78 ret
= efi_gop_register();
79 if (ret
!= EFI_SUCCESS
)
83 ret
= efi_net_register();
84 if (ret
!= EFI_SUCCESS
)
87 #ifdef CONFIG_GENERATE_ACPI_TABLE
88 ret
= efi_acpi_register();
89 if (ret
!= EFI_SUCCESS
)
92 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
93 ret
= efi_smbios_register();
94 if (ret
!= EFI_SUCCESS
)
97 ret
= efi_watchdog_register();
98 if (ret
!= EFI_SUCCESS
)
101 /* Initialize EFI runtime services */
102 ret
= efi_reset_system_init();
103 if (ret
!= EFI_SUCCESS
)
107 efi_obj_list_initialized
= ret
;
112 * Allow unaligned memory access.
114 * This routine is overridden by architectures providing this feature.
116 void __weak
allow_unaligned(void)
121 * Set the load options of an image from an environment variable.
123 * @loaded_image_info: the image
124 * @env_var: name of the environment variable
126 static void set_load_options(struct efi_loaded_image
*loaded_image_info
,
130 const char *env
= env_get(env_var
);
133 loaded_image_info
->load_options
= NULL
;
134 loaded_image_info
->load_options_size
= 0;
137 size
= utf8_utf16_strlen(env
) + 1;
138 loaded_image_info
->load_options
= calloc(size
, sizeof(u16
));
139 if (!loaded_image_info
->load_options
) {
140 printf("ERROR: Out of memory\n");
143 pos
= loaded_image_info
->load_options
;
144 utf8_utf16_strcpy(&pos
, env
);
145 loaded_image_info
->load_options_size
= size
* 2;
149 * copy_fdt() - Copy the device tree to a new location available to EFI
151 * The FDT is relocated into a suitable location within the EFI memory map.
152 * Additional 12 KiB are added to the space in case the device tree needs to be
153 * expanded later with fdt_open_into().
155 * @fdt_addr: On entry, address of start of FDT. On exit, address of relocated
157 * Return: status code
159 static efi_status_t
copy_fdt(ulong
*fdt_addrp
)
161 unsigned long fdt_ram_start
= -1L, fdt_pages
;
162 efi_status_t ret
= 0;
168 for (i
= 0; i
< CONFIG_NR_DRAM_BANKS
; i
++) {
169 u64 ram_start
= gd
->bd
->bi_dram
[i
].start
;
170 u64 ram_size
= gd
->bd
->bi_dram
[i
].size
;
175 if (ram_start
< fdt_ram_start
)
176 fdt_ram_start
= ram_start
;
180 * Give us at least 12 KiB of breathing room in case the device tree
181 * needs to be expanded later.
183 fdt
= map_sysmem(*fdt_addrp
, 0);
184 fdt_pages
= efi_size_in_pages(fdt_totalsize(fdt
) + 0x3000);
185 fdt_size
= fdt_pages
<< EFI_PAGE_SHIFT
;
187 /* Safe fdt location is at 127MB */
188 new_fdt_addr
= fdt_ram_start
+ (127 * 1024 * 1024) + fdt_size
;
189 ret
= efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS
,
190 EFI_RUNTIME_SERVICES_DATA
, fdt_pages
,
192 if (ret
!= EFI_SUCCESS
) {
193 /* If we can't put it there, put it somewhere */
194 new_fdt_addr
= (ulong
)memalign(EFI_PAGE_SIZE
, fdt_size
);
195 ret
= efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS
,
196 EFI_RUNTIME_SERVICES_DATA
, fdt_pages
,
198 if (ret
!= EFI_SUCCESS
) {
199 printf("ERROR: Failed to reserve space for FDT\n");
204 new_fdt
= map_sysmem(new_fdt_addr
, fdt_size
);
205 memcpy(new_fdt
, fdt
, fdt_totalsize(fdt
));
206 fdt_set_totalsize(new_fdt
, fdt_size
);
208 *fdt_addrp
= new_fdt_addr
;
213 static efi_status_t
efi_do_enter(
214 efi_handle_t image_handle
, struct efi_system_table
*st
,
215 EFIAPI
efi_status_t (*entry
)(
216 efi_handle_t image_handle
,
217 struct efi_system_table
*st
))
219 efi_status_t ret
= EFI_LOAD_ERROR
;
222 ret
= entry(image_handle
, st
);
223 st
->boottime
->exit(image_handle
, ret
, 0, NULL
);
228 static efi_status_t
efi_run_in_el2(EFIAPI
efi_status_t (*entry
)(
229 efi_handle_t image_handle
, struct efi_system_table
*st
),
230 efi_handle_t image_handle
, struct efi_system_table
*st
)
232 /* Enable caches again */
235 return efi_do_enter(image_handle
, st
, entry
);
239 #ifdef CONFIG_ARMV7_NONSEC
240 static bool is_nonsec
;
242 static efi_status_t
efi_run_in_hyp(EFIAPI
efi_status_t (*entry
)(
243 efi_handle_t image_handle
, struct efi_system_table
*st
),
244 efi_handle_t image_handle
, struct efi_system_table
*st
)
246 /* Enable caches again */
251 return efi_do_enter(image_handle
, st
, entry
);
256 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
258 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
259 * ignored because this is not critical and we would rather continue to try to
262 * @fdt: Pointer to device tree
264 static void efi_carve_out_dt_rsv(void *fdt
)
267 uint64_t addr
, size
, pages
;
269 nr_rsv
= fdt_num_mem_rsv(fdt
);
271 /* Look for an existing entry and add it to the efi mem map. */
272 for (i
= 0; i
< nr_rsv
; i
++) {
273 if (fdt_get_mem_rsv(fdt
, i
, &addr
, &size
) != 0)
277 * Do not carve out the device tree. It is already marked as
278 * EFI_RUNTIME_SERVICES_DATA
280 if (addr
== (uintptr_t)fdt
)
283 pages
= efi_size_in_pages(size
+ (addr
& EFI_PAGE_MASK
));
284 addr
&= ~EFI_PAGE_MASK
;
285 if (!efi_add_memory_map(addr
, pages
, EFI_RESERVED_MEMORY_TYPE
,
287 printf("FDT memrsv map %d: Failed to add to map\n", i
);
291 static efi_status_t
efi_install_fdt(ulong fdt_addr
)
293 bootm_headers_t img
= { 0 };
297 fdt
= map_sysmem(fdt_addr
, 0);
298 if (fdt_check_header(fdt
)) {
299 printf("ERROR: invalid device tree\n");
300 return EFI_INVALID_PARAMETER
;
303 /* Prepare fdt for payload */
304 ret
= copy_fdt(&fdt_addr
);
309 fdt
= map_sysmem(fdt_addr
, 0);
310 if (image_setup_libfdt(&img
, fdt
, 0, NULL
)) {
311 printf("ERROR: failed to process device tree\n");
312 return EFI_LOAD_ERROR
;
315 efi_carve_out_dt_rsv(fdt
);
317 /* Link to it in the efi tables */
318 ret
= efi_install_configuration_table(&efi_guid_fdt
, fdt
);
319 if (ret
!= EFI_SUCCESS
)
320 return EFI_OUT_OF_RESOURCES
;
325 static efi_status_t
bootefi_run_prepare(const char *load_options_path
,
326 struct efi_device_path
*device_path
,
327 struct efi_device_path
*image_path
,
328 struct efi_loaded_image_obj
**image_objp
,
329 struct efi_loaded_image
**loaded_image_infop
)
333 ret
= efi_setup_loaded_image(device_path
, image_path
, image_objp
,
335 if (ret
!= EFI_SUCCESS
)
338 /* Transfer environment variable as load options */
339 set_load_options(*loaded_image_infop
, load_options_path
);
345 * bootefi_run_finish() - finish up after running an EFI test
347 * @loaded_image_info: Pointer to a struct which holds the loaded image info
348 * @image_objj: Pointer to a struct which holds the loaded image object
350 static void bootefi_run_finish(struct efi_loaded_image_obj
*image_obj
,
351 struct efi_loaded_image
*loaded_image_info
)
354 free(loaded_image_info
->load_options
);
355 efi_delete_handle(&image_obj
->header
);
359 * do_bootefi_exec() - execute EFI binary
361 * @efi: address of the binary
362 * @device_path: path of the device from which the binary was loaded
363 * @image_path: device path of the binary
364 * Return: status code
366 * Load the EFI binary into a newly assigned memory unwinding the relocation
367 * information, install the loaded image protocol, and call the binary.
369 static efi_status_t
do_bootefi_exec(void *efi
,
370 struct efi_device_path
*device_path
,
371 struct efi_device_path
*image_path
)
373 efi_handle_t mem_handle
= NULL
;
374 struct efi_device_path
*memdp
= NULL
;
376 struct efi_loaded_image_obj
*image_obj
= NULL
;
377 struct efi_loaded_image
*loaded_image_info
= NULL
;
379 EFIAPI
efi_status_t (*entry
)(efi_handle_t image_handle
,
380 struct efi_system_table
*st
);
383 * Special case for efi payload not loaded from disk, such as
384 * 'bootefi hello' or for example payload loaded directly into
385 * memory via JTAG, etc:
387 if (!device_path
&& !image_path
) {
388 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
389 /* actual addresses filled in after efi_load_pe() */
390 memdp
= efi_dp_from_mem(0, 0, 0);
391 device_path
= image_path
= memdp
;
393 * Grub expects that the device path of the loaded image is
394 * installed on a handle.
396 ret
= efi_create_handle(&mem_handle
);
397 if (ret
!= EFI_SUCCESS
)
398 return ret
; /* TODO: leaks device_path */
399 ret
= efi_add_protocol(mem_handle
, &efi_guid_device_path
,
401 if (ret
!= EFI_SUCCESS
)
402 goto err_add_protocol
;
404 assert(device_path
&& image_path
);
407 ret
= bootefi_run_prepare("bootargs", device_path
, image_path
,
408 &image_obj
, &loaded_image_info
);
412 /* Load the EFI payload */
413 entry
= efi_load_pe(image_obj
, efi
, loaded_image_info
);
415 ret
= EFI_LOAD_ERROR
;
420 struct efi_device_path_memory
*mdp
= (void *)memdp
;
421 mdp
->memory_type
= loaded_image_info
->image_code_type
;
422 mdp
->start_address
= (uintptr_t)loaded_image_info
->image_base
;
423 mdp
->end_address
= mdp
->start_address
+
424 loaded_image_info
->image_size
;
427 /* we don't support much: */
428 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
429 "{ro,boot}(blob)0000000000000000");
431 /* Call our payload! */
432 debug("%s:%d Jumping to 0x%lx\n", __func__
, __LINE__
, (long)entry
);
434 if (setjmp(&image_obj
->exit_jmp
)) {
435 ret
= image_obj
->exit_status
;
440 /* On AArch64 we need to make sure we call our payload in < EL3 */
441 if (current_el() == 3) {
443 dcache_disable(); /* flush cache before switch to EL2 */
445 /* Move into EL2 and keep running there */
446 armv8_switch_to_el2((ulong
)entry
,
447 (ulong
)&image_obj
->header
,
448 (ulong
)&systab
, 0, (ulong
)efi_run_in_el2
,
451 /* Should never reach here, efi exits with longjmp */
456 #ifdef CONFIG_ARMV7_NONSEC
457 if (armv7_boot_nonsec() && !is_nonsec
) {
458 dcache_disable(); /* flush cache before switch to HYP */
461 secure_ram_addr(_do_nonsec_entry
)(
464 (uintptr_t)&image_obj
->header
,
467 /* Should never reach here, efi exits with longjmp */
472 ret
= efi_do_enter(&image_obj
->header
, &systab
, entry
);
475 /* image has returned, loaded-image obj goes *poof*: */
476 bootefi_run_finish(image_obj
, loaded_image_info
);
480 efi_delete_handle(mem_handle
);
485 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
487 * bootefi_test_prepare() - prepare to run an EFI test
489 * This sets things up so we can call EFI functions. This involves preparing
490 * the 'gd' pointer and setting up the load ed image data structures.
492 * @image_objp: loaded_image_infop: Pointer to a struct which will hold the
493 * loaded image object. This struct will be inited by this function before
495 * @loaded_image_infop: Pointer to a struct which will hold the loaded image
496 * info. This struct will be inited by this function before use.
497 * @path: File path to the test being run (often just the test name with a
498 * backslash before it
499 * @test_func: Address of the test function that is being run
500 * @load_options_path: U-Boot environment variable to use as load options
501 * @return 0 if OK, -ve on error
503 static efi_status_t bootefi_test_prepare
504 (struct efi_loaded_image_obj
**image_objp
,
505 struct efi_loaded_image
**loaded_image_infop
, const char *path
,
506 ulong test_func
, const char *load_options_path
)
508 /* Construct a dummy device path */
509 bootefi_device_path
= efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE
,
510 (uintptr_t)test_func
,
511 (uintptr_t)test_func
);
512 if (!bootefi_device_path
)
513 return EFI_OUT_OF_RESOURCES
;
514 bootefi_image_path
= efi_dp_from_file(NULL
, 0, path
);
515 if (!bootefi_image_path
)
516 return EFI_OUT_OF_RESOURCES
;
518 return bootefi_run_prepare(load_options_path
, bootefi_device_path
,
519 bootefi_image_path
, image_objp
,
523 #endif /* CONFIG_CMD_BOOTEFI_SELFTEST */
525 static int do_bootefi_bootmgr_exec(void)
527 struct efi_device_path
*device_path
, *file_path
;
531 addr
= efi_bootmgr_load(&device_path
, &file_path
);
535 printf("## Starting EFI application at %p ...\n", addr
);
536 r
= do_bootefi_exec(addr
, device_path
, file_path
);
537 printf("## Application terminated, r = %lu\n",
538 r
& ~EFI_ERROR_MASK
);
540 if (r
!= EFI_SUCCESS
)
546 /* Interpreter command to boot an arbitrary EFI image from memory */
547 static int do_bootefi(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
552 unsigned long fdt_addr
;
554 /* Allow unaligned memory access */
557 /* Initialize EFI drivers */
558 r
= efi_init_obj_list();
559 if (r
!= EFI_SUCCESS
) {
560 printf("Error: Cannot set up EFI drivers, r = %lu\n",
561 r
& ~EFI_ERROR_MASK
);
562 return CMD_RET_FAILURE
;
566 return CMD_RET_USAGE
;
569 fdt_addr
= simple_strtoul(argv
[2], NULL
, 16);
570 if (!fdt_addr
&& *argv
[2] != '0')
571 return CMD_RET_USAGE
;
572 /* Install device tree */
573 r
= efi_install_fdt(fdt_addr
);
574 if (r
!= EFI_SUCCESS
) {
575 printf("ERROR: failed to install device tree\n");
576 return CMD_RET_FAILURE
;
579 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
580 efi_install_configuration_table(&efi_guid_fdt
, NULL
);
581 printf("WARNING: booting without device tree\n");
583 #ifdef CONFIG_CMD_BOOTEFI_HELLO
584 if (!strcmp(argv
[1], "hello")) {
585 ulong size
= __efi_helloworld_end
- __efi_helloworld_begin
;
587 saddr
= env_get("loadaddr");
589 addr
= simple_strtoul(saddr
, NULL
, 16);
591 addr
= CONFIG_SYS_LOAD_ADDR
;
592 memcpy(map_sysmem(addr
, size
), __efi_helloworld_begin
, size
);
595 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
596 if (!strcmp(argv
[1], "selftest")) {
597 struct efi_loaded_image_obj
*image_obj
;
598 struct efi_loaded_image
*loaded_image_info
;
600 if (bootefi_test_prepare(&image_obj
, &loaded_image_info
,
601 "\\selftest", (uintptr_t)&efi_selftest
,
603 return CMD_RET_FAILURE
;
605 /* Execute the test */
606 r
= efi_selftest(&image_obj
->header
, &systab
);
607 bootefi_run_finish(image_obj
, loaded_image_info
);
608 return r
!= EFI_SUCCESS
;
611 if (!strcmp(argv
[1], "bootmgr")) {
612 return do_bootefi_bootmgr_exec();
616 addr
= simple_strtoul(saddr
, NULL
, 16);
617 /* Check that a numeric value was passed */
618 if (!addr
&& *saddr
!= '0')
619 return CMD_RET_USAGE
;
623 printf("## Starting EFI application at %08lx ...\n", addr
);
624 r
= do_bootefi_exec(map_sysmem(addr
, 0), bootefi_device_path
,
626 printf("## Application terminated, r = %lu\n",
627 r
& ~EFI_ERROR_MASK
);
629 if (r
!= EFI_SUCCESS
)
635 #ifdef CONFIG_SYS_LONGHELP
636 static char bootefi_help_text
[] =
637 "<image address> [fdt address]\n"
638 " - boot EFI payload stored at address <image address>.\n"
639 " If specified, the device tree located at <fdt address> gets\n"
640 " exposed as EFI configuration table.\n"
641 #ifdef CONFIG_CMD_BOOTEFI_HELLO
643 " - boot a sample Hello World application stored within U-Boot\n"
645 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
646 "bootefi selftest [fdt address]\n"
647 " - boot an EFI selftest application stored within U-Boot\n"
648 " Use environment variable efi_selftest to select a single test.\n"
649 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
651 "bootefi bootmgr [fdt addr]\n"
652 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
654 " If specified, the device tree located at <fdt address> gets\n"
655 " exposed as EFI configuration table.\n";
659 bootefi
, 3, 0, do_bootefi
,
660 "Boots an EFI payload from memory",
664 void efi_set_bootdev(const char *dev
, const char *devnr
, const char *path
)
666 struct efi_device_path
*device
, *image
;
669 /* efi_set_bootdev is typically called repeatedly, recover memory */
670 efi_free_pool(bootefi_device_path
);
671 efi_free_pool(bootefi_image_path
);
673 ret
= efi_dp_from_name(dev
, devnr
, path
, &device
, &image
);
674 if (ret
== EFI_SUCCESS
) {
675 bootefi_device_path
= device
;
676 bootefi_image_path
= image
;
678 bootefi_device_path
= NULL
;
679 bootefi_image_path
= NULL
;