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>
18 #include <asm/global_data.h>
19 #include <asm-generic/sections.h>
20 #include <asm-generic/unaligned.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 * Allow unaligned memory access.
89 * This routine is overridden by architectures providing this feature.
91 void __weak allow_unaligned(void)
96 * Set the load options of an image from an environment variable.
98 * @loaded_image_info: the image
99 * @env_var: name of the environment variable
101 static void set_load_options(struct efi_loaded_image *loaded_image_info,
105 const char *env = env_get(env_var);
107 loaded_image_info->load_options = NULL;
108 loaded_image_info->load_options_size = 0;
111 size = strlen(env) + 1;
112 loaded_image_info->load_options = calloc(size, sizeof(u16));
113 if (!loaded_image_info->load_options) {
114 printf("ERROR: Out of memory\n");
117 utf8_to_utf16(loaded_image_info->load_options, (u8 *)env, size);
118 loaded_image_info->load_options_size = size * 2;
121 static void *copy_fdt(void *fdt)
123 u64 fdt_size = fdt_totalsize(fdt);
124 unsigned long fdt_ram_start = -1L, fdt_pages;
129 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
130 u64 ram_start = gd->bd->bi_dram[i].start;
131 u64 ram_size = gd->bd->bi_dram[i].size;
136 if (ram_start < fdt_ram_start)
137 fdt_ram_start = ram_start;
140 /* Give us at least 4kb breathing room */
141 fdt_size = ALIGN(fdt_size + 4096, EFI_PAGE_SIZE);
142 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
144 /* Safe fdt location is at 128MB */
145 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
146 if (efi_allocate_pages(1, EFI_RUNTIME_SERVICES_DATA, fdt_pages,
147 &new_fdt_addr) != EFI_SUCCESS) {
148 /* If we can't put it there, put it somewhere */
149 new_fdt_addr = (ulong)memalign(EFI_PAGE_SIZE, fdt_size);
150 if (efi_allocate_pages(1, EFI_RUNTIME_SERVICES_DATA, fdt_pages,
151 &new_fdt_addr) != EFI_SUCCESS) {
152 printf("ERROR: Failed to reserve space for FDT\n");
157 new_fdt = (void*)(ulong)new_fdt_addr;
158 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
159 fdt_set_totalsize(new_fdt, fdt_size);
164 static efi_status_t efi_do_enter(
165 efi_handle_t image_handle, struct efi_system_table *st,
166 EFIAPI efi_status_t (*entry)(
167 efi_handle_t image_handle,
168 struct efi_system_table *st))
170 efi_status_t ret = EFI_LOAD_ERROR;
173 ret = entry(image_handle, st);
174 st->boottime->exit(image_handle, ret, 0, NULL);
179 static efi_status_t efi_run_in_el2(EFIAPI efi_status_t (*entry)(
180 efi_handle_t image_handle, struct efi_system_table *st),
181 efi_handle_t image_handle, struct efi_system_table *st)
183 /* Enable caches again */
186 return efi_do_enter(image_handle, st, entry);
190 /* Carve out DT reserved memory ranges */
191 static efi_status_t efi_carve_out_dt_rsv(void *fdt)
194 uint64_t addr, size, pages;
196 nr_rsv = fdt_num_mem_rsv(fdt);
198 /* Look for an existing entry and add it to the efi mem map. */
199 for (i = 0; i < nr_rsv; i++) {
200 if (fdt_get_mem_rsv(fdt, i, &addr, &size) != 0)
203 pages = ALIGN(size, EFI_PAGE_SIZE) >> EFI_PAGE_SHIFT;
204 efi_add_memory_map(addr, pages, EFI_RESERVED_MEMORY_TYPE,
211 static efi_status_t efi_install_fdt(void *fdt)
213 bootm_headers_t img = { 0 };
214 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
217 if (fdt_check_header(fdt)) {
218 printf("ERROR: invalid device tree\n");
219 return EFI_INVALID_PARAMETER;
222 /* Prepare fdt for payload */
225 return EFI_OUT_OF_RESOURCES;
227 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
228 printf("ERROR: failed to process device tree\n");
229 return EFI_LOAD_ERROR;
232 if (efi_carve_out_dt_rsv(fdt) != EFI_SUCCESS) {
233 printf("ERROR: failed to carve out memory\n");
234 return EFI_LOAD_ERROR;
237 /* Link to it in the efi tables */
238 ret = efi_install_configuration_table(&efi_guid_fdt, fdt);
239 if (ret != EFI_SUCCESS)
240 return EFI_OUT_OF_RESOURCES;
242 /* And reserve the space in the memory map */
243 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
244 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
245 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
246 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
247 /* Give a bootloader the chance to modify the device tree */
249 ret = efi_add_memory_map(fdt_start, fdt_pages,
250 EFI_BOOT_SERVICES_DATA, true);
255 * Load an EFI payload into a newly allocated piece of memory, register all
256 * EFI objects it would want to access and jump to it.
258 static efi_status_t do_bootefi_exec(void *efi,
259 struct efi_device_path *device_path,
260 struct efi_device_path *image_path)
262 struct efi_loaded_image loaded_image_info = {};
263 struct efi_object loaded_image_info_obj = {};
264 struct efi_device_path *memdp = NULL;
267 EFIAPI efi_status_t (*entry)(efi_handle_t image_handle,
268 struct efi_system_table *st);
271 * Special case for efi payload not loaded from disk, such as
272 * 'bootefi hello' or for example payload loaded directly into
273 * memory via jtag/etc:
275 if (!device_path && !image_path) {
276 printf("WARNING: using memory device/image path, this may confuse some payloads!\n");
277 /* actual addresses filled in after efi_load_pe() */
278 memdp = efi_dp_from_mem(0, 0, 0);
279 device_path = image_path = memdp;
281 assert(device_path && image_path);
284 efi_setup_loaded_image(&loaded_image_info, &loaded_image_info_obj,
285 device_path, image_path);
288 * gd lives in a fixed register which may get clobbered while we execute
289 * the payload. So save it here and restore it on every callback entry
293 /* Transfer environment variable bootargs as load options */
294 set_load_options(&loaded_image_info, "bootargs");
295 /* Load the EFI payload */
296 entry = efi_load_pe(efi, &loaded_image_info);
298 ret = EFI_LOAD_ERROR;
303 struct efi_device_path_memory *mdp = (void *)memdp;
304 mdp->memory_type = loaded_image_info.image_code_type;
305 mdp->start_address = (uintptr_t)loaded_image_info.image_base;
306 mdp->end_address = mdp->start_address +
307 loaded_image_info.image_size;
310 /* we don't support much: */
311 env_set("efi_8be4df61-93ca-11d2-aa0d-00e098032b8c_OsIndicationsSupported",
312 "{ro,boot}(blob)0000000000000000");
314 /* Call our payload! */
315 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
317 if (setjmp(&loaded_image_info.exit_jmp)) {
318 ret = loaded_image_info.exit_status;
323 /* On AArch64 we need to make sure we call our payload in < EL3 */
324 if (current_el() == 3) {
326 dcache_disable(); /* flush cache before switch to EL2 */
328 /* Move into EL2 and keep running there */
329 armv8_switch_to_el2((ulong)entry,
330 (ulong)&loaded_image_info_obj.handle,
331 (ulong)&systab, 0, (ulong)efi_run_in_el2,
334 /* Should never reach here, efi exits with longjmp */
339 ret = efi_do_enter(loaded_image_info_obj.handle, &systab, entry);
342 /* image has returned, loaded-image obj goes *poof*: */
343 list_del(&loaded_image_info_obj.link);
348 static int do_bootefi_bootmgr_exec(void)
350 struct efi_device_path *device_path, *file_path;
355 * gd lives in a fixed register which may get clobbered while we execute
356 * the payload. So save it here and restore it on every callback entry
360 addr = efi_bootmgr_load(&device_path, &file_path);
364 printf("## Starting EFI application at %p ...\n", addr);
365 r = do_bootefi_exec(addr, device_path, file_path);
366 printf("## Application terminated, r = %lu\n",
367 r & ~EFI_ERROR_MASK);
369 if (r != EFI_SUCCESS)
375 /* Interpreter command to boot an arbitrary EFI image from memory */
376 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
383 /* Allow unaligned memory access */
386 /* Initialize EFI drivers */
387 r = efi_init_obj_list();
388 if (r != EFI_SUCCESS) {
389 printf("Error: Cannot set up EFI drivers, r = %lu\n",
390 r & ~EFI_ERROR_MASK);
391 return CMD_RET_FAILURE;
395 return CMD_RET_USAGE;
398 fdt_addr = (void *)simple_strtoul(argv[2], NULL, 16);
399 if (!fdt_addr && *argv[2] != '0')
400 return CMD_RET_USAGE;
401 /* Install device tree */
402 r = efi_install_fdt(fdt_addr);
403 if (r != EFI_SUCCESS) {
404 printf("ERROR: failed to install device tree\n");
405 return CMD_RET_FAILURE;
408 /* Remove device tree. EFI_NOT_FOUND can be ignored here */
409 efi_install_configuration_table(&efi_guid_fdt, NULL);
410 printf("WARNING: booting without device tree\n");
412 #ifdef CONFIG_CMD_BOOTEFI_HELLO
413 if (!strcmp(argv[1], "hello")) {
414 ulong size = __efi_helloworld_end - __efi_helloworld_begin;
416 saddr = env_get("loadaddr");
418 addr = simple_strtoul(saddr, NULL, 16);
420 addr = CONFIG_SYS_LOAD_ADDR;
421 memcpy((char *)addr, __efi_helloworld_begin, size);
424 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
425 if (!strcmp(argv[1], "selftest")) {
426 struct efi_loaded_image loaded_image_info = {};
427 struct efi_object loaded_image_info_obj = {};
429 /* Construct a dummy device path. */
430 bootefi_device_path = efi_dp_from_mem(EFI_RESERVED_MEMORY_TYPE,
431 (uintptr_t)&efi_selftest,
432 (uintptr_t)&efi_selftest);
433 bootefi_image_path = efi_dp_from_file(NULL, 0, "\\selftest");
435 efi_setup_loaded_image(&loaded_image_info,
436 &loaded_image_info_obj,
437 bootefi_device_path, bootefi_image_path);
439 * gd lives in a fixed register which may get clobbered while we
440 * execute the payload. So save it here and restore it on every
444 /* Transfer environment variable efi_selftest as load options */
445 set_load_options(&loaded_image_info, "efi_selftest");
446 /* Execute the test */
447 r = efi_selftest(loaded_image_info_obj.handle, &systab);
449 free(loaded_image_info.load_options);
450 list_del(&loaded_image_info_obj.link);
451 return r != EFI_SUCCESS;
454 if (!strcmp(argv[1], "bootmgr")) {
455 return do_bootefi_bootmgr_exec();
459 addr = simple_strtoul(saddr, NULL, 16);
460 /* Check that a numeric value was passed */
461 if (!addr && *saddr != '0')
462 return CMD_RET_USAGE;
466 printf("## Starting EFI application at %08lx ...\n", addr);
467 r = do_bootefi_exec((void *)addr, bootefi_device_path,
469 printf("## Application terminated, r = %lu\n",
470 r & ~EFI_ERROR_MASK);
472 if (r != EFI_SUCCESS)
478 #ifdef CONFIG_SYS_LONGHELP
479 static char bootefi_help_text[] =
480 "<image address> [fdt address]\n"
481 " - boot EFI payload stored at address <image address>.\n"
482 " If specified, the device tree located at <fdt address> gets\n"
483 " exposed as EFI configuration table.\n"
484 #ifdef CONFIG_CMD_BOOTEFI_HELLO
486 " - boot a sample Hello World application stored within U-Boot\n"
488 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
489 "bootefi selftest [fdt address]\n"
490 " - boot an EFI selftest application stored within U-Boot\n"
491 " Use environment variable efi_selftest to select a single test.\n"
492 " Use 'setenv efi_selftest list' to enumerate all tests.\n"
494 "bootefi bootmgr [fdt addr]\n"
495 " - load and boot EFI payload based on BootOrder/BootXXXX variables.\n"
497 " If specified, the device tree located at <fdt address> gets\n"
498 " exposed as EFI configuration table.\n";
502 bootefi, 3, 0, do_bootefi,
503 "Boots an EFI payload from memory",
507 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
509 char filename[32] = { 0 }; /* dp->str is u16[32] long */
512 if (strcmp(dev, "Net")) {
513 struct blk_desc *desc;
514 disk_partition_t fs_partition;
517 part = blk_get_device_part_str(dev, devnr, &desc, &fs_partition,
522 bootefi_device_path = efi_dp_from_part(desc, part);
525 bootefi_device_path = efi_dp_from_eth();
532 if (strcmp(dev, "Net")) {
533 /* Add leading / to fs paths, because they're absolute */
534 snprintf(filename, sizeof(filename), "/%s", path);
536 snprintf(filename, sizeof(filename), "%s", path);
538 /* DOS style file path: */
540 while ((s = strchr(s, '/')))
542 bootefi_image_path = efi_dp_from_file(NULL, 0, filename);