2 * EFI application loader
4 * Copyright (c) 2016 Alexander Graf
6 * SPDX-License-Identifier: GPL-2.0+
11 #include <efi_loader.h>
14 #include <libfdt_env.h>
17 * When booting using the "bootefi" command, we don't know which
18 * physical device the file came from. So we create a pseudo-device
19 * called "bootefi" with the device path /bootefi.
21 * In addition to the originating device we also declare the file path
22 * of "bootefi" based loads to be /bootefi.
24 static struct efi_device_path_file_path bootefi_image_path[] = {
26 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
27 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
28 .dp.length = sizeof(bootefi_image_path[0]),
29 .str = { 'b','o','o','t','e','f','i' },
31 .dp.type = DEVICE_PATH_TYPE_END,
32 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
33 .dp.length = sizeof(bootefi_image_path[0]),
37 static struct efi_device_path_file_path bootefi_device_path[] = {
39 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
40 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
41 .dp.length = sizeof(bootefi_image_path[0]),
42 .str = { 'b','o','o','t','e','f','i' },
44 .dp.type = DEVICE_PATH_TYPE_END,
45 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
46 .dp.length = sizeof(bootefi_image_path[0]),
50 static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol,
51 void **protocol_interface, void *agent_handle,
52 void *controller_handle, uint32_t attributes)
54 *protocol_interface = bootefi_device_path;
58 /* The EFI loaded_image interface for the image executed via "bootefi" */
59 static struct efi_loaded_image loaded_image_info = {
60 .device_handle = bootefi_device_path,
61 .file_path = bootefi_image_path,
64 /* The EFI object struct for the image executed via "bootefi" */
65 static struct efi_object loaded_image_info_obj = {
66 .handle = &loaded_image_info,
70 * When asking for the loaded_image interface, just
71 * return handle which points to loaded_image_info
73 .guid = &efi_guid_loaded_image,
74 .open = &efi_return_handle,
78 * When asking for the device path interface, return
81 .guid = &efi_guid_device_path,
82 .open = &bootefi_open_dp,
87 /* The EFI object struct for the device the "bootefi" image was loaded from */
88 static struct efi_object bootefi_device_obj = {
89 .handle = bootefi_device_path,
92 /* When asking for the device path interface, return
93 * bootefi_device_path */
94 .guid = &efi_guid_device_path,
95 .open = &bootefi_open_dp,
101 * Load an EFI payload into a newly allocated piece of memory, register all
102 * EFI objects it would want to access and jump to it.
104 static unsigned long do_bootefi_exec(void *efi)
106 ulong (*entry)(void *image_handle, struct efi_system_table *st);
107 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
108 bootm_headers_t img = { 0 };
111 * gd lives in a fixed register which may get clobbered while we execute
112 * the payload. So save it here and restore it on every callback entry
116 /* Update system table to point to our currently loaded FDT */
119 /* Prepare fdt for payload */
120 if (image_setup_libfdt(&img, working_fdt, 0, NULL)) {
121 printf("ERROR: Failed to process device tree\n");
125 /* Link to it in the efi tables */
126 systab.tables[0].guid = EFI_FDT_GUID;
127 systab.tables[0].table = working_fdt;
128 systab.nr_tables = 1;
130 /* And reserve the space in the memory map */
131 fdt_start = ((ulong)working_fdt) & ~EFI_PAGE_MASK;
132 fdt_end = ((ulong)working_fdt) + fdt_totalsize(working_fdt);
133 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
134 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
135 /* Give a bootloader the chance to modify the device tree */
137 efi_add_memory_map(fdt_start, fdt_pages,
138 EFI_BOOT_SERVICES_DATA, true);
141 printf("WARNING: No device tree loaded, expect boot to fail\n");
142 systab.nr_tables = 0;
145 /* Load the EFI payload */
146 entry = efi_load_pe(efi, &loaded_image_info);
150 /* Initialize and populate EFI object list */
151 INIT_LIST_HEAD(&efi_obj_list);
152 list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
153 list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
154 #ifdef CONFIG_PARTITIONS
161 /* Call our payload! */
163 printf("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
165 return entry(&loaded_image_info, &systab);
169 /* Interpreter command to boot an arbitrary EFI image from memory */
170 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
180 addr = simple_strtoul(saddr, NULL, 16);
182 printf("## Starting EFI application at 0x%08lx ...\n", addr);
183 r = do_bootefi_exec((void *)addr);
184 printf("## Application terminated, r = %d\n", r);
192 #ifdef CONFIG_SYS_LONGHELP
193 static char bootefi_help_text[] =
195 " - boot EFI payload stored at address <image address>\n"
197 "Since most EFI payloads want to have a device tree provided, please\n"
198 "make sure you load a device tree using the fdt addr command before\n"
199 "executing bootefi.\n";
203 bootefi, 2, 0, do_bootefi,
204 "Boots an EFI payload from memory\n",
208 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
210 __maybe_unused struct blk_desc *desc;
211 char devname[32] = { 0 }; /* dp->str is u16[32] long */
214 /* Assemble the condensed device name we use in efi_disk.c */
215 snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
216 colon = strchr(devname, ':');
218 #ifdef CONFIG_ISO_PARTITION
219 /* For ISOs we create partition block devices */
220 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
221 if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
222 (desc->part_type == PART_TYPE_ISO)) {
224 snprintf(devname, sizeof(devname), "%s%s:1", dev,
233 /* Patch bootefi_device_path to the target device */
234 memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
235 ascii2unicode(bootefi_device_path[0].str, devname);
237 /* Patch bootefi_image_path to the target file path */
238 memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
239 snprintf(devname, sizeof(devname), "%s", path);
240 ascii2unicode(bootefi_image_path[0].str, devname);