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
;
43 /* Initialize once only */
44 if (efi_obj_list_initialized
!= OBJ_LIST_NOT_INITIALIZED
)
45 return efi_obj_list_initialized
;
47 /* Initialize system table */
48 ret
= efi_initialize_system_table();
49 if (ret
!= EFI_SUCCESS
)
52 /* Initialize EFI driver uclass */
53 ret
= efi_driver_init();
54 if (ret
!= EFI_SUCCESS
)
57 ret
= efi_console_register();
58 if (ret
!= EFI_SUCCESS
)
60 #ifdef CONFIG_PARTITIONS
61 ret
= efi_disk_register();
62 if (ret
!= EFI_SUCCESS
)
65 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
66 ret
= efi_gop_register();
67 if (ret
!= EFI_SUCCESS
)
71 ret
= efi_net_register();
72 if (ret
!= EFI_SUCCESS
)
75 #ifdef CONFIG_GENERATE_ACPI_TABLE
76 ret
= efi_acpi_register();
77 if (ret
!= EFI_SUCCESS
)
80 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
81 ret
= efi_smbios_register();
82 if (ret
!= EFI_SUCCESS
)
85 ret
= efi_watchdog_register();
86 if (ret
!= EFI_SUCCESS
)
89 /* Initialize EFI runtime services */
90 ret
= efi_reset_system_init();
91 if (ret
!= EFI_SUCCESS
)
95 efi_obj_list_initialized
= ret
;
100 * Allow unaligned memory access.
102 * This routine is overridden by architectures providing this feature.
104 void __weak
allow_unaligned(void)
109 * Set the load options of an image from an environment variable.
111 * @loaded_image_info: the image
112 * @env_var: name of the environment variable
114 static void set_load_options(struct efi_loaded_image
*loaded_image_info
,
118 const char *env
= env_get(env_var
);
120 loaded_image_info
->load_options
= NULL
;
121 loaded_image_info
->load_options_size
= 0;
124 size
= strlen(env
) + 1;
125 loaded_image_info
->load_options
= calloc(size
, sizeof(u16
));
126 if (!loaded_image_info
->load_options
) {
127 printf("ERROR: Out of memory\n");
130 utf8_to_utf16(loaded_image_info
->load_options
, (u8
*)env
, size
);
131 loaded_image_info
->load_options_size
= size
* 2;
134 static void *copy_fdt(void *fdt
)
136 u64 fdt_size
= fdt_totalsize(fdt
);
137 unsigned long fdt_ram_start
= -1L, fdt_pages
;
142 for (i
= 0; i
< CONFIG_NR_DRAM_BANKS
; i
++) {
143 u64 ram_start
= gd
->bd
->bi_dram
[i
].start
;
144 u64 ram_size
= gd
->bd
->bi_dram
[i
].size
;
149 if (ram_start
< fdt_ram_start
)
150 fdt_ram_start
= ram_start
;
154 * Give us at least 4KB of breathing room in case the device tree needs
155 * to be expanded later. Round up to the nearest EFI page boundary.
158 fdt_size
= ALIGN(fdt_size
+ EFI_PAGE_SIZE
- 1, EFI_PAGE_SIZE
);
159 fdt_pages
= fdt_size
>> EFI_PAGE_SHIFT
;
161 /* Safe fdt location is at 128MB */
162 new_fdt_addr
= fdt_ram_start
+ (128 * 1024 * 1024) + fdt_size
;
163 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS
,
164 EFI_RUNTIME_SERVICES_DATA
, fdt_pages
,
165 &new_fdt_addr
) != EFI_SUCCESS
) {
166 /* If we can't put it there, put it somewhere */
167 new_fdt_addr
= (ulong
)memalign(EFI_PAGE_SIZE
, fdt_size
);
168 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS
,
169 EFI_RUNTIME_SERVICES_DATA
, fdt_pages
,
170 &new_fdt_addr
) != EFI_SUCCESS
) {
171 printf("ERROR: Failed to reserve space for FDT\n");
176 new_fdt
= (void*)(ulong
)new_fdt_addr
;
177 memcpy(new_fdt
, fdt
, fdt_totalsize(fdt
));
178 fdt_set_totalsize(new_fdt
, fdt_size
);
183 static efi_status_t
efi_do_enter(
184 efi_handle_t image_handle
, struct efi_system_table
*st
,
185 EFIAPI
efi_status_t (*entry
)(
186 efi_handle_t image_handle
,
187 struct efi_system_table
*st
))
189 efi_status_t ret
= EFI_LOAD_ERROR
;
192 ret
= entry(image_handle
, st
);
193 st
->boottime
->exit(image_handle
, ret
, 0, NULL
);
198 static efi_status_t
efi_run_in_el2(EFIAPI
efi_status_t (*entry
)(
199 efi_handle_t image_handle
, struct efi_system_table
*st
),
200 efi_handle_t image_handle
, struct efi_system_table
*st
)
202 /* Enable caches again */
205 return efi_do_enter(image_handle
, st
, entry
);
209 #ifdef CONFIG_ARMV7_NONSEC
210 static bool is_nonsec
;
212 static efi_status_t
efi_run_in_hyp(EFIAPI
efi_status_t (*entry
)(
213 efi_handle_t image_handle
, struct efi_system_table
*st
),
214 efi_handle_t image_handle
, struct efi_system_table
*st
)
216 /* Enable caches again */
221 return efi_do_enter(image_handle
, st
, entry
);
226 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
228 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
229 * ignored because this is not critical and we would rather continue to try to
232 * @fdt: Pointer to device tree
234 static void efi_carve_out_dt_rsv(void *fdt
)
237 uint64_t addr
, size
, pages
;
239 nr_rsv
= fdt_num_mem_rsv(fdt
);
241 /* Look for an existing entry and add it to the efi mem map. */
242 for (i
= 0; i
< nr_rsv
; i
++) {
243 if (fdt_get_mem_rsv(fdt
, i
, &addr
, &size
) != 0)
246 pages
= ALIGN(size
, EFI_PAGE_SIZE
) >> EFI_PAGE_SHIFT
;
247 if (!efi_add_memory_map(addr
, pages
, EFI_RESERVED_MEMORY_TYPE
,
249 printf("FDT memrsv map %d: Failed to add to map\n", i
);
253 static efi_status_t
efi_install_fdt(void *fdt
)
255 bootm_headers_t img
= { 0 };
256 ulong fdt_pages
, fdt_size
, fdt_start
, fdt_end
;
259 if (fdt_check_header(fdt
)) {
260 printf("ERROR: invalid device tree\n");
261 return EFI_INVALID_PARAMETER
;
264 /* Prepare fdt for payload */
267 return EFI_OUT_OF_RESOURCES
;
269 if (image_setup_libfdt(&img
, fdt
, 0, NULL
)) {
270 printf("ERROR: failed to process device tree\n");
271 return EFI_LOAD_ERROR
;
274 efi_carve_out_dt_rsv(fdt
);
276 /* Link to it in the efi tables */
277 ret
= efi_install_configuration_table(&efi_guid_fdt
, fdt
);
278 if (ret
!= EFI_SUCCESS
)
279 return EFI_OUT_OF_RESOURCES
;
281 /* And reserve the space in the memory map */
282 fdt_start
= ((ulong
)fdt
) & ~EFI_PAGE_MASK
;
283 fdt_end
= ((ulong
)fdt
) + fdt_totalsize(fdt
);
284 fdt_size
= (fdt_end
- fdt_start
) + EFI_PAGE_MASK
;
285 fdt_pages
= fdt_size
>> EFI_PAGE_SHIFT
;
286 /* Give a bootloader the chance to modify the device tree */
288 ret
= efi_add_memory_map(fdt_start
, fdt_pages
,
289 EFI_BOOT_SERVICES_DATA
, true);
294 * Load an EFI payload into a newly allocated piece of memory, register all
295 * EFI objects it would want to access and jump to it.
297 static efi_status_t
do_bootefi_exec(void *efi
,
298 struct efi_device_path
*device_path
,
299 struct efi_device_path
*image_path
)
301 struct efi_loaded_image loaded_image_info
= {};
302 struct efi_object loaded_image_info_obj
= {};
303 struct efi_object mem_obj
= {};
304 struct efi_device_path
*memdp
= NULL
;
307 EFIAPI
efi_status_t (*entry
)(efi_handle_t image_handle
,
308 struct efi_system_table
*st
);
311 * Special case for efi payload not loaded from disk, such as
312 * 'bootefi hello' or for example payload loaded directly into
313 * memory via jtag/etc:
315 if (!device_path
&& !image_path
) {
316 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
317 /* actual addresses filled in after efi_load_pe() */
318 memdp
= efi_dp_from_mem(0, 0, 0);
319 device_path
= image_path
= memdp
;
320 efi_add_handle(&mem_obj
);
322 ret
= efi_add_protocol(mem_obj
.handle
, &efi_guid_device_path
,
324 if (ret
!= EFI_SUCCESS
)
327 assert(device_path
&& image_path
);
330 efi_setup_loaded_image(&loaded_image_info
, &loaded_image_info_obj
,
331 device_path
, image_path
);
334 * gd lives in a fixed register which may get clobbered while we execute
335 * the payload. So save it here and restore it on every callback entry
339 /* Transfer environment variable bootargs as load options */
340 set_load_options(&loaded_image_info
, "bootargs");
341 /* Load the EFI payload */
342 entry
= efi_load_pe(efi
, &loaded_image_info
);
344 ret
= EFI_LOAD_ERROR
;
349 struct efi_device_path_memory
*mdp
= (void *)memdp
;
350 mdp
->memory_type
= loaded_image_info
.image_code_type
;
351 mdp
->start_address
= (uintptr_t)loaded_image_info
.image_base
;
352 mdp
->end_address
= mdp
->start_address
+
353 loaded_image_info
.image_size
;
356 /* we don't support much: */
357 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
358 "{ro,boot}(blob)0000000000000000");
360 /* Call our payload! */
361 debug("%s:%d Jumping to 0x%lx\n", __func__
, __LINE__
, (long)entry
);
363 if (setjmp(&loaded_image_info
.exit_jmp
)) {
364 ret
= loaded_image_info
.exit_status
;
369 /* On AArch64 we need to make sure we call our payload in < EL3 */
370 if (current_el() == 3) {
372 dcache_disable(); /* flush cache before switch to EL2 */
374 /* Move into EL2 and keep running there */
375 armv8_switch_to_el2((ulong
)entry
,
376 (ulong
)&loaded_image_info_obj
.handle
,
377 (ulong
)&systab
, 0, (ulong
)efi_run_in_el2
,
380 /* Should never reach here, efi exits with longjmp */
385 #ifdef CONFIG_ARMV7_NONSEC
386 if (armv7_boot_nonsec() && !is_nonsec
) {
387 dcache_disable(); /* flush cache before switch to HYP */
390 secure_ram_addr(_do_nonsec_entry
)(
393 (uintptr_t)loaded_image_info_obj
.handle
,
396 /* Should never reach here, efi exits with longjmp */
401 ret
= efi_do_enter(loaded_image_info_obj
.handle
, &systab
, entry
);
404 /* image has returned, loaded-image obj goes *poof*: */
405 list_del(&loaded_image_info_obj
.link
);
407 list_del(&mem_obj
.link
);
412 static int do_bootefi_bootmgr_exec(void)
414 struct efi_device_path
*device_path
, *file_path
;
419 * gd lives in a fixed register which may get clobbered while we execute
420 * the payload. So save it here and restore it on every callback entry
424 addr
= efi_bootmgr_load(&device_path
, &file_path
);
428 printf("## Starting EFI application at %p ...\n", addr
);
429 r
= do_bootefi_exec(addr
, device_path
, file_path
);
430 printf("## Application terminated, r = %lu\n",
431 r
& ~EFI_ERROR_MASK
);
433 if (r
!= EFI_SUCCESS
)
439 /* Interpreter command to boot an arbitrary EFI image from memory */
440 static int do_bootefi(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
445 unsigned long fdt_addr
;
448 /* Allow unaligned memory access */
451 /* Initialize EFI drivers */
452 r
= efi_init_obj_list();
453 if (r
!= EFI_SUCCESS
) {
454 printf("Error: Cannot set up EFI drivers, r = %lu\n",
455 r
& ~EFI_ERROR_MASK
);
456 return CMD_RET_FAILURE
;
460 return CMD_RET_USAGE
;
463 fdt_addr
= simple_strtoul(argv
[2], NULL
, 16);
464 if (!fdt_addr
&& *argv
[2] != '0')
465 return CMD_RET_USAGE
;
466 /* Install device tree */
467 fdt
= map_sysmem(fdt_addr
, 0);
468 r
= efi_install_fdt(fdt
);
469 if (r
!= EFI_SUCCESS
) {
470 printf("ERROR: failed to install device tree\n");
471 return CMD_RET_FAILURE
;
474 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
475 efi_install_configuration_table(&efi_guid_fdt
, NULL
);
476 printf("WARNING: booting without device tree\n");
478 #ifdef CONFIG_CMD_BOOTEFI_HELLO
479 if (!strcmp(argv
[1], "hello")) {
480 ulong size
= __efi_helloworld_end
- __efi_helloworld_begin
;
482 saddr
= env_get("loadaddr");
484 addr
= simple_strtoul(saddr
, NULL
, 16);
486 addr
= CONFIG_SYS_LOAD_ADDR
;
487 memcpy(map_sysmem(addr
, size
), __efi_helloworld_begin
, size
);
490 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
491 if (!strcmp(argv
[1], "selftest")) {
492 struct efi_loaded_image loaded_image_info
= {};
493 struct efi_object loaded_image_info_obj
= {};
495 /* Construct a dummy device path. */
496 bootefi_device_path
= efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE
,
497 (uintptr_t)&efi_selftest
,
498 (uintptr_t)&efi_selftest
);
499 bootefi_image_path
= efi_dp_from_file(NULL
, 0, "\\selftest");
501 efi_setup_loaded_image(&loaded_image_info
,
502 &loaded_image_info_obj
,
503 bootefi_device_path
, bootefi_image_path
);
505 * gd lives in a fixed register which may get clobbered while we
506 * execute the payload. So save it here and restore it on every
510 /* Transfer environment variable efi_selftest as load options */
511 set_load_options(&loaded_image_info
, "efi_selftest");
512 /* Execute the test */
513 r
= efi_selftest(loaded_image_info_obj
.handle
, &systab
);
515 free(loaded_image_info
.load_options
);
516 list_del(&loaded_image_info_obj
.link
);
517 return r
!= EFI_SUCCESS
;
520 if (!strcmp(argv
[1], "bootmgr")) {
521 return do_bootefi_bootmgr_exec();
525 addr
= simple_strtoul(saddr
, NULL
, 16);
526 /* Check that a numeric value was passed */
527 if (!addr
&& *saddr
!= '0')
528 return CMD_RET_USAGE
;
532 printf("## Starting EFI application at %08lx ...\n", addr
);
533 r
= do_bootefi_exec(map_sysmem(addr
, 0), bootefi_device_path
,
535 printf("## Application terminated, r = %lu\n",
536 r
& ~EFI_ERROR_MASK
);
538 if (r
!= EFI_SUCCESS
)
544 #ifdef CONFIG_SYS_LONGHELP
545 static char bootefi_help_text
[] =
546 "<image address> [fdt address]\n"
547 " - boot EFI payload stored at address <image address>.\n"
548 " If specified, the device tree located at <fdt address> gets\n"
549 " exposed as EFI configuration table.\n"
550 #ifdef CONFIG_CMD_BOOTEFI_HELLO
552 " - boot a sample Hello World application stored within U-Boot\n"
554 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
555 "bootefi selftest [fdt address]\n"
556 " - boot an EFI selftest application stored within U-Boot\n"
557 " Use environment variable efi_selftest to select a single test.\n"
558 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
560 "bootefi bootmgr [fdt addr]\n"
561 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
563 " If specified, the device tree located at <fdt address> gets\n"
564 " exposed as EFI configuration table.\n";
568 bootefi
, 3, 0, do_bootefi
,
569 "Boots an EFI payload from memory",
573 void efi_set_bootdev(const char *dev
, const char *devnr
, const char *path
)
575 char filename
[32] = { 0 }; /* dp->str is u16[32] long */
578 if (strcmp(dev
, "Net")) {
579 struct blk_desc
*desc
;
580 disk_partition_t fs_partition
;
583 part
= blk_get_device_part_str(dev
, devnr
, &desc
, &fs_partition
,
588 bootefi_device_path
= efi_dp_from_part(desc
, part
);
591 bootefi_device_path
= efi_dp_from_eth();
598 if (strcmp(dev
, "Net")) {
599 /* Add leading / to fs paths, because they're absolute */
600 snprintf(filename
, sizeof(filename
), "/%s", path
);
602 snprintf(filename
, sizeof(filename
), "%s", path
);
604 /* DOS style file path: */
606 while ((s
= strchr(s
, '/')))
608 bootefi_image_path
= efi_dp_from_file(NULL
, 0, filename
);