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)
93 ret = efi_get_time_init();
94 if (ret != EFI_SUCCESS)
98 efi_obj_list_initialized = ret;
103 * Allow unaligned memory access.
105 * This routine is overridden by architectures providing this feature.
107 void __weak allow_unaligned(void)
112 * Set the load options of an image from an environment variable.
114 * @loaded_image_info: the image
115 * @env_var: name of the environment variable
117 static void set_load_options(struct efi_loaded_image *loaded_image_info,
121 const char *env = env_get(env_var);
123 loaded_image_info->load_options = NULL;
124 loaded_image_info->load_options_size = 0;
127 size = strlen(env) + 1;
128 loaded_image_info->load_options = calloc(size, sizeof(u16));
129 if (!loaded_image_info->load_options) {
130 printf("ERROR: Out of memory\n");
133 utf8_to_utf16(loaded_image_info->load_options, (u8 *)env, size);
134 loaded_image_info->load_options_size = size * 2;
137 static void *copy_fdt(void *fdt)
139 u64 fdt_size = fdt_totalsize(fdt);
140 unsigned long fdt_ram_start = -1L, fdt_pages;
145 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
146 u64 ram_start = gd->bd->bi_dram[i].start;
147 u64 ram_size = gd->bd->bi_dram[i].size;
152 if (ram_start < fdt_ram_start)
153 fdt_ram_start = ram_start;
157 * Give us at least 4KB of breathing room in case the device tree needs
158 * to be expanded later. Round up to the nearest EFI page boundary.
161 fdt_size = ALIGN(fdt_size + EFI_PAGE_SIZE - 1, EFI_PAGE_SIZE);
162 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
164 /* Safe fdt location is at 128MB */
165 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
166 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
167 EFI_RUNTIME_SERVICES_DATA, fdt_pages,
168 &new_fdt_addr) != EFI_SUCCESS) {
169 /* If we can't put it there, put it somewhere */
170 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
171 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
172 EFI_RUNTIME_SERVICES_DATA, fdt_pages,
173 &new_fdt_addr) != EFI_SUCCESS) {
174 printf("ERROR: Failed to reserve space for FDT\n");
179 new_fdt = (void*)(ulong)new_fdt_addr;
180 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
181 fdt_set_totalsize(new_fdt, fdt_size);
186 static efi_status_t efi_do_enter(
187 efi_handle_t image_handle, struct efi_system_table *st,
188 EFIAPI efi_status_t (*entry)(
189 efi_handle_t image_handle,
190 struct efi_system_table *st))
192 efi_status_t ret = EFI_LOAD_ERROR;
195 ret = entry(image_handle, st);
196 st->boottime->exit(image_handle, ret, 0, NULL);
201 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
202 efi_handle_t image_handle, struct efi_system_table *st),
203 efi_handle_t image_handle, struct efi_system_table *st)
205 /* Enable caches again */
208 return efi_do_enter(image_handle, st, entry);
212 #ifdef CONFIG_ARMV7_NONSEC
213 static bool is_nonsec;
215 static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)(
216 efi_handle_t image_handle, struct efi_system_table *st),
217 efi_handle_t image_handle, struct efi_system_table *st)
219 /* Enable caches again */
224 return efi_do_enter(image_handle, st, entry);
229 * efi_carve_out_dt_rsv() - Carve out DT reserved memory ranges
231 * The mem_rsv entries of the FDT are added to the memory map. Any failures are
232 * ignored because this is not critical and we would rather continue to try to
235 * @fdt: Pointer to device tree
237 static void efi_carve_out_dt_rsv(void *fdt)
240 uint64_t addr, size, pages;
242 nr_rsv = fdt_num_mem_rsv(fdt);
244 /* Look for an existing entry and add it to the efi mem map. */
245 for (i = 0; i < nr_rsv; i++) {
246 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
249 pages = ALIGN(size, EFI_PAGE_SIZE) >> EFI_PAGE_SHIFT;
250 if (!efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
252 printf("FDT memrsv map %d: Failed to add to map\n", i);
256 static efi_status_t efi_install_fdt(void *fdt)
258 bootm_headers_t img = { 0 };
259 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
262 if (fdt_check_header(fdt)) {
263 printf("ERROR: invalid device tree\n");
264 return EFI_INVALID_PARAMETER;
267 /* Prepare fdt for payload */
270 return EFI_OUT_OF_RESOURCES;
272 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
273 printf("ERROR: failed to process device tree\n");
274 return EFI_LOAD_ERROR;
277 efi_carve_out_dt_rsv(fdt);
279 /* Link to it in the efi tables */
280 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
281 if (ret != EFI_SUCCESS)
282 return EFI_OUT_OF_RESOURCES;
284 /* And reserve the space in the memory map */
285 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
286 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
287 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
288 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
289 /* Give a bootloader the chance to modify the device tree */
291 ret = efi_add_memory_map(fdt_start, fdt_pages,
292 EFI_BOOT_SERVICES_DATA, true);
297 * Load an EFI payload into a newly allocated piece of memory, register all
298 * EFI objects it would want to access and jump to it.
300 static efi_status_t do_bootefi_exec(void *efi,
301 struct efi_device_path *device_path,
302 struct efi_device_path *image_path)
304 struct efi_loaded_image loaded_image_info = {};
305 struct efi_object loaded_image_info_obj = {};
306 struct efi_object mem_obj = {};
307 struct efi_device_path *memdp = NULL;
310 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
311 struct efi_system_table *st);
314 * Special case for efi payload not loaded from disk, such as
315 * 'bootefi hello' or for example payload loaded directly into
316 * memory via jtag/etc:
318 if (!device_path && !image_path) {
319 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
320 /* actual addresses filled in after efi_load_pe() */
321 memdp = efi_dp_from_mem(0, 0, 0);
322 device_path = image_path = memdp;
323 efi_add_handle(&mem_obj);
325 ret = efi_add_protocol(mem_obj.handle, &efi_guid_device_path,
327 if (ret != EFI_SUCCESS)
330 assert(device_path && image_path);
333 efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
334 device_path, image_path);
337 * gd lives in a fixed register which may get clobbered while we execute
338 * the payload. So save it here and restore it on every callback entry
342 /* Transfer environment variable bootargs as load options */
343 set_load_options(&loaded_image_info, "bootargs");
344 /* Load the EFI payload */
345 entry = efi_load_pe(efi, &loaded_image_info);
347 ret = EFI_LOAD_ERROR;
352 struct efi_device_path_memory *mdp = (void *)memdp;
353 mdp->memory_type = loaded_image_info.image_code_type;
354 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
355 mdp->end_address = mdp->start_address +
356 loaded_image_info.image_size;
359 /* we don't support much: */
360 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
361 "{ro,boot}(blob)0000000000000000");
363 /* Call our payload! */
364 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
366 if (setjmp(&loaded_image_info.exit_jmp)) {
367 ret = loaded_image_info.exit_status;
372 /* On AArch64 we need to make sure we call our payload in < EL3 */
373 if (current_el() == 3) {
375 dcache_disable(); /* flush cache before switch to EL2 */
377 /* Move into EL2 and keep running there */
378 armv8_switch_to_el2((ulong)entry,
379 (ulong)&loaded_image_info_obj.handle,
380 (ulong)&systab, 0, (ulong)efi_run_in_el2,
383 /* Should never reach here, efi exits with longjmp */
388 #ifdef CONFIG_ARMV7_NONSEC
389 if (armv7_boot_nonsec() && !is_nonsec) {
390 dcache_disable(); /* flush cache before switch to HYP */
393 secure_ram_addr(_do_nonsec_entry)(
396 (uintptr_t)loaded_image_info_obj.handle,
399 /* Should never reach here, efi exits with longjmp */
404 ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
407 /* image has returned, loaded-image obj goes *poof*: */
408 list_del(&loaded_image_info_obj.link);
410 list_del(&mem_obj.link);
415 static int do_bootefi_bootmgr_exec(void)
417 struct efi_device_path *device_path, *file_path;
422 * gd lives in a fixed register which may get clobbered while we execute
423 * the payload. So save it here and restore it on every callback entry
427 addr = efi_bootmgr_load(&device_path, &file_path);
431 printf("## Starting EFI application at %p ...\n", addr);
432 r = do_bootefi_exec(addr, device_path, file_path);
433 printf("## Application terminated, r = %lu\n",
434 r & ~EFI_ERROR_MASK);
436 if (r != EFI_SUCCESS)
442 /* Interpreter command to boot an arbitrary EFI image from memory */
443 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
448 unsigned long fdt_addr;
451 /* Allow unaligned memory access */
454 /* Initialize EFI drivers */
455 r = efi_init_obj_list();
456 if (r != EFI_SUCCESS) {
457 printf("Error: Cannot set up EFI drivers, r = %lu\n",
458 r & ~EFI_ERROR_MASK);
459 return CMD_RET_FAILURE;
463 return CMD_RET_USAGE;
466 fdt_addr = simple_strtoul(argv[2], NULL, 16);
467 if (!fdt_addr && *argv[2] != '0')
468 return CMD_RET_USAGE;
469 /* Install device tree */
470 fdt = map_sysmem(fdt_addr, 0);
471 r = efi_install_fdt(fdt);
472 if (r != EFI_SUCCESS) {
473 printf("ERROR: failed to install device tree\n");
474 return CMD_RET_FAILURE;
477 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
478 efi_install_configuration_table(&efi_guid_fdt, NULL);
479 printf("WARNING: booting without device tree\n");
481 #ifdef CONFIG_CMD_BOOTEFI_HELLO
482 if (!strcmp(argv[1], "hello")) {
483 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
485 saddr = env_get("loadaddr");
487 addr = simple_strtoul(saddr, NULL, 16);
489 addr = CONFIG_SYS_LOAD_ADDR;
490 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
493 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
494 if (!strcmp(argv[1], "selftest")) {
495 struct efi_loaded_image loaded_image_info = {};
496 struct efi_object loaded_image_info_obj = {};
498 /* Construct a dummy device path. */
499 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
500 (uintptr_t)&efi_selftest,
501 (uintptr_t)&efi_selftest);
502 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
504 efi_setup_loaded_image(&loaded_image_info,
505 &loaded_image_info_obj,
506 bootefi_device_path, bootefi_image_path);
508 * gd lives in a fixed register which may get clobbered while we
509 * execute the payload. So save it here and restore it on every
513 /* Transfer environment variable efi_selftest as load options */
514 set_load_options(&loaded_image_info, "efi_selftest");
515 /* Execute the test */
516 r = efi_selftest(loaded_image_info_obj.handle, &systab);
518 free(loaded_image_info.load_options);
519 list_del(&loaded_image_info_obj.link);
520 return r != EFI_SUCCESS;
523 if (!strcmp(argv[1], "bootmgr")) {
524 return do_bootefi_bootmgr_exec();
528 addr = simple_strtoul(saddr, NULL, 16);
529 /* Check that a numeric value was passed */
530 if (!addr && *saddr != '0')
531 return CMD_RET_USAGE;
535 printf("## Starting EFI application at %08lx ...\n", addr);
536 r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
538 printf("## Application terminated, r = %lu\n",
539 r & ~EFI_ERROR_MASK);
541 if (r != EFI_SUCCESS)
547 #ifdef CONFIG_SYS_LONGHELP
548 static char bootefi_help_text[] =
549 "<image address> [fdt address]\n"
550 " - boot EFI payload stored at address <image address>.\n"
551 " If specified, the device tree located at <fdt address> gets\n"
552 " exposed as EFI configuration table.\n"
553 #ifdef CONFIG_CMD_BOOTEFI_HELLO
555 " - boot a sample Hello World application stored within U-Boot\n"
557 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
558 "bootefi selftest [fdt address]\n"
559 " - boot an EFI selftest application stored within U-Boot\n"
560 " Use environment variable efi_selftest to select a single test.\n"
561 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
563 "bootefi bootmgr [fdt addr]\n"
564 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
566 " If specified, the device tree located at <fdt address> gets\n"
567 " exposed as EFI configuration table.\n";
571 bootefi, 3, 0, do_bootefi,
572 "Boots an EFI payload from memory",
576 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
578 char filename[32] = { 0 }; /* dp->str is u16[32] long */
581 if (strcmp(dev, "Net")) {
582 struct blk_desc *desc;
583 disk_partition_t fs_partition;
586 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
591 bootefi_device_path = efi_dp_from_part(desc, part);
594 bootefi_device_path = efi_dp_from_eth();
601 if (strcmp(dev, "Net")) {
602 /* Add leading / to fs paths, because they're absolute */
603 snprintf(filename, sizeof(filename), "/%s", path);
605 snprintf(filename, sizeof(filename), "%s", path);
607 /* DOS style file path: */
609 while ((s = strchr(s, '/')))
611 bootefi_image_path = efi_dp_from_file(NULL, 0, filename);