2 * EFI application loader
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
13 #include <efi_loader.h>
14 #include <efi_selftest.h>
16 #include <linux/libfdt.h>
17 #include <linux/libfdt_env.h>
19 #include <asm/global_data.h>
20 #include <asm-generic/sections.h>
21 #include <linux/linkage.h>
23 DECLARE_GLOBAL_DATA_PTR
;
25 #define OBJ_LIST_NOT_INITIALIZED 1
27 static efi_status_t efi_obj_list_initialized
= OBJ_LIST_NOT_INITIALIZED
;
29 static struct efi_device_path
*bootefi_image_path
;
30 static struct efi_device_path
*bootefi_device_path
;
32 /* Initialize and populate EFI object list */
33 efi_status_t
efi_init_obj_list(void)
35 efi_status_t ret
= EFI_SUCCESS
;
37 /* Initialize once only */
38 if (efi_obj_list_initialized
!= OBJ_LIST_NOT_INITIALIZED
)
39 return efi_obj_list_initialized
;
41 /* Initialize EFI driver uclass */
42 ret
= efi_driver_init();
43 if (ret
!= EFI_SUCCESS
)
46 ret
= efi_console_register();
47 if (ret
!= EFI_SUCCESS
)
49 #ifdef CONFIG_PARTITIONS
50 ret
= efi_disk_register();
51 if (ret
!= EFI_SUCCESS
)
54 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
55 ret
= efi_gop_register();
56 if (ret
!= EFI_SUCCESS
)
60 ret
= efi_net_register();
61 if (ret
!= EFI_SUCCESS
)
64 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
65 ret
= efi_smbios_register();
66 if (ret
!= EFI_SUCCESS
)
69 ret
= efi_watchdog_register();
70 if (ret
!= EFI_SUCCESS
)
73 /* Initialize EFI runtime services */
74 ret
= efi_reset_system_init();
75 if (ret
!= EFI_SUCCESS
)
77 ret
= efi_get_time_init();
78 if (ret
!= EFI_SUCCESS
)
82 efi_obj_list_initialized
= ret
;
87 * Set the load options of an image from an environment variable.
89 * @loaded_image_info: the image
90 * @env_var: name of the environment variable
92 static void set_load_options(struct efi_loaded_image
*loaded_image_info
,
96 const char *env
= env_get(env_var
);
98 loaded_image_info
->load_options
= NULL
;
99 loaded_image_info
->load_options_size
= 0;
102 size
= strlen(env
) + 1;
103 loaded_image_info
->load_options
= calloc(size
, sizeof(u16
));
104 if (!loaded_image_info
->load_options
) {
105 printf("ERROR: Out of memory\n");
108 utf8_to_utf16(loaded_image_info
->load_options
, (u8
*)env
, size
);
109 loaded_image_info
->load_options_size
= size
* 2;
112 static void *copy_fdt(void *fdt
)
114 u64 fdt_size
= fdt_totalsize(fdt
);
115 unsigned long fdt_ram_start
= -1L, fdt_pages
;
120 for (i
= 0; i
< CONFIG_NR_DRAM_BANKS
; i
++) {
121 u64 ram_start
= gd
->bd
->bi_dram
[i
].start
;
122 u64 ram_size
= gd
->bd
->bi_dram
[i
].size
;
127 if (ram_start
< fdt_ram_start
)
128 fdt_ram_start
= ram_start
;
131 /* Give us at least 4kb breathing room */
132 fdt_size
= ALIGN(fdt_size
+ 4096, EFI_PAGE_SIZE
);
133 fdt_pages
= fdt_size
>> EFI_PAGE_SHIFT
;
135 /* Safe fdt location is at 128MB */
136 new_fdt_addr
= fdt_ram_start
+ (128 * 1024 * 1024) + fdt_size
;
137 if (efi_allocate_pages(1, EFI_RUNTIME_SERVICES_DATA
, fdt_pages
,
138 &new_fdt_addr
) != EFI_SUCCESS
) {
139 /* If we can't put it there, put it somewhere */
140 new_fdt_addr
= (ulong
)memalign(EFI_PAGE_SIZE
, fdt_size
);
141 if (efi_allocate_pages(1, EFI_RUNTIME_SERVICES_DATA
, fdt_pages
,
142 &new_fdt_addr
) != EFI_SUCCESS
) {
143 printf("ERROR: Failed to reserve space for FDT\n");
148 new_fdt
= (void*)(ulong
)new_fdt_addr
;
149 memcpy(new_fdt
, fdt
, fdt_totalsize(fdt
));
150 fdt_set_totalsize(new_fdt
, fdt_size
);
155 static efi_status_t
efi_do_enter(
156 efi_handle_t image_handle
, struct efi_system_table
*st
,
157 EFIAPI
efi_status_t (*entry
)(
158 efi_handle_t image_handle
,
159 struct efi_system_table
*st
))
161 efi_status_t ret
= EFI_LOAD_ERROR
;
164 ret
= entry(image_handle
, st
);
165 st
->boottime
->exit(image_handle
, ret
, 0, NULL
);
170 static efi_status_t
efi_run_in_el2(EFIAPI
efi_status_t (*entry
)(
171 efi_handle_t image_handle
, struct efi_system_table
*st
),
172 efi_handle_t image_handle
, struct efi_system_table
*st
)
174 /* Enable caches again */
177 return efi_do_enter(image_handle
, st
, entry
);
181 /* Carve out DT reserved memory ranges */
182 static efi_status_t
efi_carve_out_dt_rsv(void *fdt
)
185 uint64_t addr
, size
, pages
;
187 nr_rsv
= fdt_num_mem_rsv(fdt
);
189 /* Look for an existing entry and add it to the efi mem map. */
190 for (i
= 0; i
< nr_rsv
; i
++) {
191 if (fdt_get_mem_rsv(fdt
, i
, &addr
, &size
) != 0)
194 pages
= ALIGN(size
, EFI_PAGE_SIZE
) >> EFI_PAGE_SHIFT
;
195 efi_add_memory_map(addr
, pages
, EFI_RESERVED_MEMORY_TYPE
,
202 static efi_status_t
efi_install_fdt(void *fdt
)
204 bootm_headers_t img
= { 0 };
205 ulong fdt_pages
, fdt_size
, fdt_start
, fdt_end
;
208 if (fdt_check_header(fdt
)) {
209 printf("ERROR: invalid device tree\n");
210 return EFI_INVALID_PARAMETER
;
213 /* Prepare fdt for payload */
216 return EFI_OUT_OF_RESOURCES
;
218 if (image_setup_libfdt(&img
, fdt
, 0, NULL
)) {
219 printf("ERROR: failed to process device tree\n");
220 return EFI_LOAD_ERROR
;
223 if (efi_carve_out_dt_rsv(fdt
) != EFI_SUCCESS
) {
224 printf("ERROR: failed to carve out memory\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 return EFI_OUT_OF_RESOURCES
;
233 /* And reserve the space in the memory map */
234 fdt_start
= ((ulong
)fdt
) & ~EFI_PAGE_MASK
;
235 fdt_end
= ((ulong
)fdt
) + fdt_totalsize(fdt
);
236 fdt_size
= (fdt_end
- fdt_start
) + EFI_PAGE_MASK
;
237 fdt_pages
= fdt_size
>> EFI_PAGE_SHIFT
;
238 /* Give a bootloader the chance to modify the device tree */
240 ret
= efi_add_memory_map(fdt_start
, fdt_pages
,
241 EFI_BOOT_SERVICES_DATA
, true);
246 * Load an EFI payload into a newly allocated piece of memory, register all
247 * EFI objects it would want to access and jump to it.
249 static efi_status_t
do_bootefi_exec(void *efi
,
250 struct efi_device_path
*device_path
,
251 struct efi_device_path
*image_path
)
253 struct efi_loaded_image loaded_image_info
= {};
254 struct efi_object loaded_image_info_obj
= {};
255 struct efi_device_path
*memdp
= NULL
;
258 EFIAPI
efi_status_t (*entry
)(efi_handle_t image_handle
,
259 struct efi_system_table
*st
);
262 * Special case for efi payload not loaded from disk, such as
263 * 'bootefi hello' or for example payload loaded directly into
264 * memory via jtag/etc:
266 if (!device_path
&& !image_path
) {
267 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
268 /* actual addresses filled in after efi_load_pe() */
269 memdp
= efi_dp_from_mem(0, 0, 0);
270 device_path
= image_path
= memdp
;
272 assert(device_path
&& image_path
);
275 efi_setup_loaded_image(&loaded_image_info
, &loaded_image_info_obj
,
276 device_path
, image_path
);
279 * gd lives in a fixed register which may get clobbered while we execute
280 * the payload. So save it here and restore it on every callback entry
284 /* Transfer environment variable bootargs as load options */
285 set_load_options(&loaded_image_info
, "bootargs");
286 /* Load the EFI payload */
287 entry
= efi_load_pe(efi
, &loaded_image_info
);
289 ret
= EFI_LOAD_ERROR
;
294 struct efi_device_path_memory
*mdp
= (void *)memdp
;
295 mdp
->memory_type
= loaded_image_info
.image_code_type
;
296 mdp
->start_address
= (uintptr_t)loaded_image_info
.image_base
;
297 mdp
->end_address
= mdp
->start_address
+
298 loaded_image_info
.image_size
;
301 /* we don't support much: */
302 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
303 "{ro,boot}(blob)0000000000000000");
305 /* Call our payload! */
306 debug("%s:%d Jumping to 0x%lx\n", __func__
, __LINE__
, (long)entry
);
308 if (setjmp(&loaded_image_info
.exit_jmp
)) {
309 ret
= loaded_image_info
.exit_status
;
314 /* On AArch64 we need to make sure we call our payload in < EL3 */
315 if (current_el() == 3) {
317 dcache_disable(); /* flush cache before switch to EL2 */
319 /* Move into EL2 and keep running there */
320 armv8_switch_to_el2((ulong
)entry
,
321 (ulong
)&loaded_image_info_obj
.handle
,
322 (ulong
)&systab
, 0, (ulong
)efi_run_in_el2
,
325 /* Should never reach here, efi exits with longjmp */
330 ret
= efi_do_enter(loaded_image_info_obj
.handle
, &systab
, entry
);
333 /* image has returned, loaded-image obj goes *poof*: */
334 list_del(&loaded_image_info_obj
.link
);
339 static int do_bootefi_bootmgr_exec(void)
341 struct efi_device_path
*device_path
, *file_path
;
346 * gd lives in a fixed register which may get clobbered while we execute
347 * the payload. So save it here and restore it on every callback entry
351 addr
= efi_bootmgr_load(&device_path
, &file_path
);
355 printf("## Starting EFI application at %p ...\n", addr
);
356 r
= do_bootefi_exec(addr
, device_path
, file_path
);
357 printf("## Application terminated, r = %lu\n",
358 r
& ~EFI_ERROR_MASK
);
360 if (r
!= EFI_SUCCESS
)
366 /* Interpreter command to boot an arbitrary EFI image from memory */
367 static int do_bootefi(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
374 /* Initialize EFI drivers */
375 r
= efi_init_obj_list();
376 if (r
!= EFI_SUCCESS
) {
377 printf("Error: Cannot set up EFI drivers, r = %lu\n",
378 r
& ~EFI_ERROR_MASK
);
379 return CMD_RET_FAILURE
;
383 return CMD_RET_USAGE
;
386 fdt_addr
= (void *)simple_strtoul(argv
[2], NULL
, 16);
387 if (!fdt_addr
&& *argv
[2] != '0')
388 return CMD_RET_USAGE
;
389 /* Install device tree */
390 r
= efi_install_fdt(fdt_addr
);
391 if (r
!= EFI_SUCCESS
) {
392 printf("ERROR: failed to install device tree\n");
393 return CMD_RET_FAILURE
;
396 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
397 efi_install_configuration_table(&efi_guid_fdt
, NULL
);
398 printf("WARNING: booting without device tree\n");
400 #ifdef CONFIG_CMD_BOOTEFI_HELLO
401 if (!strcmp(argv
[1], "hello")) {
402 ulong size
= __efi_helloworld_end
- __efi_helloworld_begin
;
404 saddr
= env_get("loadaddr");
406 addr
= simple_strtoul(saddr
, NULL
, 16);
408 addr
= CONFIG_SYS_LOAD_ADDR
;
409 memcpy((char *)addr
, __efi_helloworld_begin
, size
);
412 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
413 if (!strcmp(argv
[1], "selftest")) {
414 struct efi_loaded_image loaded_image_info
= {};
415 struct efi_object loaded_image_info_obj
= {};
417 /* Construct a dummy device path. */
418 bootefi_device_path
= efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE
,
419 (uintptr_t)&efi_selftest
,
420 (uintptr_t)&efi_selftest
);
421 bootefi_image_path
= efi_dp_from_file(NULL
, 0, "\\selftest");
423 efi_setup_loaded_image(&loaded_image_info
,
424 &loaded_image_info_obj
,
425 bootefi_device_path
, bootefi_image_path
);
427 * gd lives in a fixed register which may get clobbered while we
428 * execute the payload. So save it here and restore it on every
432 /* Initialize and populate EFI object list */
434 /* Transfer environment variable efi_selftest as load options */
435 set_load_options(&loaded_image_info
, "efi_selftest");
436 /* Execute the test */
437 r
= efi_selftest(loaded_image_info_obj
.handle
, &systab
);
439 free(loaded_image_info
.load_options
);
440 list_del(&loaded_image_info_obj
.link
);
441 return r
!= EFI_SUCCESS
;
444 if (!strcmp(argv
[1], "bootmgr")) {
445 return do_bootefi_bootmgr_exec();
449 addr
= simple_strtoul(saddr
, NULL
, 16);
450 /* Check that a numeric value was passed */
451 if (!addr
&& *saddr
!= '0')
452 return CMD_RET_USAGE
;
456 printf("## Starting EFI application at %08lx ...\n", addr
);
457 r
= do_bootefi_exec((void *)addr
, bootefi_device_path
,
459 printf("## Application terminated, r = %lu\n",
460 r
& ~EFI_ERROR_MASK
);
462 if (r
!= EFI_SUCCESS
)
468 #ifdef CONFIG_SYS_LONGHELP
469 static char bootefi_help_text
[] =
470 "<image address> [fdt address]\n"
471 " - boot EFI payload stored at address <image address>.\n"
472 " If specified, the device tree located at <fdt address> gets\n"
473 " exposed as EFI configuration table.\n"
474 #ifdef CONFIG_CMD_BOOTEFI_HELLO
476 " - boot a sample Hello World application stored within U-Boot\n"
478 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
479 "bootefi selftest [fdt address]\n"
480 " - boot an EFI selftest application stored within U-Boot\n"
481 " Use environment variable efi_selftest to select a single test.\n"
482 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
484 "bootefi bootmgr [fdt addr]\n"
485 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
487 " If specified, the device tree located at <fdt address> gets\n"
488 " exposed as EFI configuration table.\n";
492 bootefi
, 3, 0, do_bootefi
,
493 "Boots an EFI payload from memory",
497 void efi_set_bootdev(const char *dev
, const char *devnr
, const char *path
)
499 char filename
[32] = { 0 }; /* dp->str is u16[32] long */
502 if (strcmp(dev
, "Net")) {
503 struct blk_desc
*desc
;
504 disk_partition_t fs_partition
;
507 part
= blk_get_device_part_str(dev
, devnr
, &desc
, &fs_partition
,
512 bootefi_device_path
= efi_dp_from_part(desc
, part
);
515 bootefi_device_path
= efi_dp_from_eth();
522 if (strcmp(dev
, "Net")) {
523 /* Add leading / to fs paths, because they're absolute */
524 snprintf(filename
, sizeof(filename
), "/%s", path
);
526 snprintf(filename
, sizeof(filename
), "%s", path
);
528 /* DOS style file path: */
530 while ((s
= strchr(s
, '/')))
532 bootefi_image_path
= efi_dp_from_file(NULL
, 0, filename
);