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 EFI driver uclass */
48 ret = efi_driver_init();
49 if (ret != EFI_SUCCESS)
52 ret = efi_console_register();
53 if (ret != EFI_SUCCESS)
55 #ifdef CONFIG_PARTITIONS
56 ret = efi_disk_register();
57 if (ret != EFI_SUCCESS)
60 #if defined(CONFIG_LCD) || defined(CONFIG_DM_VIDEO)
61 ret = efi_gop_register();
62 if (ret != EFI_SUCCESS)
66 ret = efi_net_register();
67 if (ret != EFI_SUCCESS)
70 #ifdef CONFIG_GENERATE_ACPI_TABLE
71 ret = efi_acpi_register();
72 if (ret != EFI_SUCCESS)
75 #ifdef CONFIG_GENERATE_SMBIOS_TABLE
76 ret = efi_smbios_register();
77 if (ret != EFI_SUCCESS)
80 ret = efi_watchdog_register();
81 if (ret != EFI_SUCCESS)
84 /* Initialize EFI runtime services */
85 ret = efi_reset_system_init();
86 if (ret != EFI_SUCCESS)
88 ret = efi_get_time_init();
89 if (ret != EFI_SUCCESS)
93 efi_obj_list_initialized = ret;
98 * Allow unaligned memory access.
100 * This routine is overridden by architectures providing this feature.
102 void __weak allow_unaligned(void)
107 * Set the load options of an image from an environment variable.
109 * @loaded_image_info: the image
110 * @env_var: name of the environment variable
112 static void set_load_options(struct efi_loaded_image *loaded_image_info,
116 const char *env = env_get(env_var);
118 loaded_image_info->load_options = NULL;
119 loaded_image_info->load_options_size = 0;
122 size = strlen(env) + 1;
123 loaded_image_info->load_options = calloc(size, sizeof(u16));
124 if (!loaded_image_info->load_options) {
125 printf("ERROR: Out of memory\n");
128 utf8_to_utf16(loaded_image_info->load_options, (u8 *)env, size);
129 loaded_image_info->load_options_size = size * 2;
132 static void *copy_fdt(void *fdt)
134 u64 fdt_size = fdt_totalsize(fdt);
135 unsigned long fdt_ram_start = -1L, fdt_pages;
140 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
141 u64 ram_start = gd->bd->bi_dram[i].start;
142 u64 ram_size = gd->bd->bi_dram[i].size;
147 if (ram_start < fdt_ram_start)
148 fdt_ram_start = ram_start;
152 * Give us at least 4KB of breathing room in case the device tree needs
153 * to be expanded later. Round up to the nearest EFI page boundary.
156 fdt_size = ALIGN(fdt_size + EFI_PAGE_SIZE - 1, EFI_PAGE_SIZE);
157 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
159 /* Safe fdt location is at 128MB */
160 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
161 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS,
162 EFI_RUNTIME_SERVICES_DATA, fdt_pages,
163 &new_fdt_addr) != EFI_SUCCESS) {
164 /* If we can't put it there, put it somewhere */
165 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, 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 printf("ERROR: Failed to reserve space for FDT\n");
174 new_fdt = (void*)(ulong)new_fdt_addr;
175 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
176 fdt_set_totalsize(new_fdt, fdt_size);
181 static efi_status_t efi_do_enter(
182 efi_handle_t image_handle, struct efi_system_table *st,
183 EFIAPI efi_status_t (*entry)(
184 efi_handle_t image_handle,
185 struct efi_system_table *st))
187 efi_status_t ret = EFI_LOAD_ERROR;
190 ret = entry(image_handle, st);
191 st->boottime->exit(image_handle, ret, 0, NULL);
196 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
197 efi_handle_t image_handle, struct efi_system_table *st),
198 efi_handle_t image_handle, struct efi_system_table *st)
200 /* Enable caches again */
203 return efi_do_enter(image_handle, st, entry);
207 #ifdef CONFIG_ARMV7_NONSEC
208 static bool is_nonsec;
210 static efi_status_t efi_run_in_hyp(EFIAPI efi_status_t (*entry)(
211 efi_handle_t image_handle, struct efi_system_table *st),
212 efi_handle_t image_handle, struct efi_system_table *st)
214 /* Enable caches again */
219 return efi_do_enter(image_handle, st, entry);
223 /* Carve out DT reserved memory ranges */
224 static efi_status_t efi_carve_out_dt_rsv(void *fdt)
227 uint64_t addr, size, pages;
229 nr_rsv = fdt_num_mem_rsv(fdt);
231 /* Look for an existing entry and add it to the efi mem map. */
232 for (i = 0; i < nr_rsv; i++) {
233 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
236 pages = ALIGN(size, EFI_PAGE_SIZE) >> EFI_PAGE_SHIFT;
237 efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
244 static efi_status_t efi_install_fdt(void *fdt)
246 bootm_headers_t img = { 0 };
247 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
250 if (fdt_check_header(fdt)) {
251 printf("ERROR: invalid device tree\n");
252 return EFI_INVALID_PARAMETER;
255 /* Prepare fdt for payload */
258 return EFI_OUT_OF_RESOURCES;
260 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
261 printf("ERROR: failed to process device tree\n");
262 return EFI_LOAD_ERROR;
265 if (efi_carve_out_dt_rsv(fdt) != EFI_SUCCESS) {
266 printf("ERROR: failed to carve out memory\n");
267 return EFI_LOAD_ERROR;
270 /* Link to it in the efi tables */
271 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
272 if (ret != EFI_SUCCESS)
273 return EFI_OUT_OF_RESOURCES;
275 /* And reserve the space in the memory map */
276 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
277 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
278 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
279 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
280 /* Give a bootloader the chance to modify the device tree */
282 ret = efi_add_memory_map(fdt_start, fdt_pages,
283 EFI_BOOT_SERVICES_DATA, true);
288 * Load an EFI payload into a newly allocated piece of memory, register all
289 * EFI objects it would want to access and jump to it.
291 static efi_status_t do_bootefi_exec(void *efi,
292 struct efi_device_path *device_path,
293 struct efi_device_path *image_path)
295 struct efi_loaded_image loaded_image_info = {};
296 struct efi_object loaded_image_info_obj = {};
297 struct efi_object mem_obj = {};
298 struct efi_device_path *memdp = NULL;
301 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
302 struct efi_system_table *st);
305 * Special case for efi payload not loaded from disk, such as
306 * 'bootefi hello' or for example payload loaded directly into
307 * memory via jtag/etc:
309 if (!device_path && !image_path) {
310 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
311 /* actual addresses filled in after efi_load_pe() */
312 memdp = efi_dp_from_mem(0, 0, 0);
313 device_path = image_path = memdp;
314 efi_add_handle(&mem_obj);
316 ret = efi_add_protocol(mem_obj.handle, &efi_guid_device_path,
318 if (ret != EFI_SUCCESS)
321 assert(device_path && image_path);
324 efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
325 device_path, image_path);
328 * gd lives in a fixed register which may get clobbered while we execute
329 * the payload. So save it here and restore it on every callback entry
333 /* Transfer environment variable bootargs as load options */
334 set_load_options(&loaded_image_info, "bootargs");
335 /* Load the EFI payload */
336 entry = efi_load_pe(efi, &loaded_image_info);
338 ret = EFI_LOAD_ERROR;
343 struct efi_device_path_memory *mdp = (void *)memdp;
344 mdp->memory_type = loaded_image_info.image_code_type;
345 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
346 mdp->end_address = mdp->start_address +
347 loaded_image_info.image_size;
350 /* we don't support much: */
351 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
352 "{ro,boot}(blob)0000000000000000");
354 /* Call our payload! */
355 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
357 if (setjmp(&loaded_image_info.exit_jmp)) {
358 ret = loaded_image_info.exit_status;
363 /* On AArch64 we need to make sure we call our payload in < EL3 */
364 if (current_el() == 3) {
366 dcache_disable(); /* flush cache before switch to EL2 */
368 /* Move into EL2 and keep running there */
369 armv8_switch_to_el2((ulong)entry,
370 (ulong)&loaded_image_info_obj.handle,
371 (ulong)&systab, 0, (ulong)efi_run_in_el2,
374 /* Should never reach here, efi exits with longjmp */
379 #ifdef CONFIG_ARMV7_NONSEC
380 if (armv7_boot_nonsec() && !is_nonsec) {
381 dcache_disable(); /* flush cache before switch to HYP */
384 secure_ram_addr(_do_nonsec_entry)(
387 (uintptr_t)loaded_image_info_obj.handle,
390 /* Should never reach here, efi exits with longjmp */
395 ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
398 /* image has returned, loaded-image obj goes *poof*: */
399 list_del(&loaded_image_info_obj.link);
401 list_del(&mem_obj.link);
406 static int do_bootefi_bootmgr_exec(void)
408 struct efi_device_path *device_path, *file_path;
413 * gd lives in a fixed register which may get clobbered while we execute
414 * the payload. So save it here and restore it on every callback entry
418 addr = efi_bootmgr_load(&device_path, &file_path);
422 printf("## Starting EFI application at %p ...\n", addr);
423 r = do_bootefi_exec(addr, device_path, file_path);
424 printf("## Application terminated, r = %lu\n",
425 r & ~EFI_ERROR_MASK);
427 if (r != EFI_SUCCESS)
433 /* Interpreter command to boot an arbitrary EFI image from memory */
434 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
439 unsigned long fdt_addr;
442 /* Allow unaligned memory access */
445 /* Initialize EFI drivers */
446 r = efi_init_obj_list();
447 if (r != EFI_SUCCESS) {
448 printf("Error: Cannot set up EFI drivers, r = %lu\n",
449 r & ~EFI_ERROR_MASK);
450 return CMD_RET_FAILURE;
454 return CMD_RET_USAGE;
457 fdt_addr = simple_strtoul(argv[2], NULL, 16);
458 if (!fdt_addr && *argv[2] != '0')
459 return CMD_RET_USAGE;
460 /* Install device tree */
461 fdt = map_sysmem(fdt_addr, 0);
462 r = efi_install_fdt(fdt);
463 if (r != EFI_SUCCESS) {
464 printf("ERROR: failed to install device tree\n");
465 return CMD_RET_FAILURE;
468 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
469 efi_install_configuration_table(&efi_guid_fdt, NULL);
470 printf("WARNING: booting without device tree\n");
472 #ifdef CONFIG_CMD_BOOTEFI_HELLO
473 if (!strcmp(argv[1], "hello")) {
474 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
476 saddr = env_get("loadaddr");
478 addr = simple_strtoul(saddr, NULL, 16);
480 addr = CONFIG_SYS_LOAD_ADDR;
481 memcpy(map_sysmem(addr, size), __efi_helloworld_begin, size);
484 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
485 if (!strcmp(argv[1], "selftest")) {
486 struct efi_loaded_image loaded_image_info = {};
487 struct efi_object loaded_image_info_obj = {};
489 /* Construct a dummy device path. */
490 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
491 (uintptr_t)&efi_selftest,
492 (uintptr_t)&efi_selftest);
493 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
495 efi_setup_loaded_image(&loaded_image_info,
496 &loaded_image_info_obj,
497 bootefi_device_path, bootefi_image_path);
499 * gd lives in a fixed register which may get clobbered while we
500 * execute the payload. So save it here and restore it on every
504 /* Transfer environment variable efi_selftest as load options */
505 set_load_options(&loaded_image_info, "efi_selftest");
506 /* Execute the test */
507 r = efi_selftest(loaded_image_info_obj.handle, &systab);
509 free(loaded_image_info.load_options);
510 list_del(&loaded_image_info_obj.link);
511 return r != EFI_SUCCESS;
514 if (!strcmp(argv[1], "bootmgr")) {
515 return do_bootefi_bootmgr_exec();
519 addr = simple_strtoul(saddr, NULL, 16);
520 /* Check that a numeric value was passed */
521 if (!addr && *saddr != '0')
522 return CMD_RET_USAGE;
526 printf("## Starting EFI application at %08lx ...\n", addr);
527 r = do_bootefi_exec(map_sysmem(addr, 0), bootefi_device_path,
529 printf("## Application terminated, r = %lu\n",
530 r & ~EFI_ERROR_MASK);
532 if (r != EFI_SUCCESS)
538 #ifdef CONFIG_SYS_LONGHELP
539 static char bootefi_help_text[] =
540 "<image address> [fdt address]\n"
541 " - boot EFI payload stored at address <image address>.\n"
542 " If specified, the device tree located at <fdt address> gets\n"
543 " exposed as EFI configuration table.\n"
544 #ifdef CONFIG_CMD_BOOTEFI_HELLO
546 " - boot a sample Hello World application stored within U-Boot\n"
548 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
549 "bootefi selftest [fdt address]\n"
550 " - boot an EFI selftest application stored within U-Boot\n"
551 " Use environment variable efi_selftest to select a single test.\n"
552 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
554 "bootefi bootmgr [fdt addr]\n"
555 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
557 " If specified, the device tree located at <fdt address> gets\n"
558 " exposed as EFI configuration table.\n";
562 bootefi, 3, 0, do_bootefi,
563 "Boots an EFI payload from memory",
567 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
569 char filename[32] = { 0 }; /* dp->str is u16[32] long */
572 if (strcmp(dev, "Net")) {
573 struct blk_desc *desc;
574 disk_partition_t fs_partition;
577 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
582 bootefi_device_path = efi_dp_from_part(desc, part);
585 bootefi_device_path = efi_dp_from_eth();
592 if (strcmp(dev, "Net")) {
593 /* Add leading / to fs paths, because they're absolute */
594 snprintf(filename, sizeof(filename), "/%s", path);
596 snprintf(filename, sizeof(filename), "%s", path);
598 /* DOS style file path: */
600 while ((s = strchr(s, '/')))
602 bootefi_image_path = efi_dp_from_file(NULL, 0, filename);