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>
16 #include <asm/global_data.h>
18 DECLARE_GLOBAL_DATA_PTR;
21 * When booting using the "bootefi" command, we don't know which
22 * physical device the file came from. So we create a pseudo-device
23 * called "bootefi" with the device path /bootefi.
25 * In addition to the originating device we also declare the file path
26 * of "bootefi" based loads to be /bootefi.
28 static struct efi_device_path_file_path bootefi_image_path[] = {
30 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
31 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
32 .dp.length = sizeof(bootefi_image_path[0]),
33 .str = { 'b','o','o','t','e','f','i' },
35 .dp.type = DEVICE_PATH_TYPE_END,
36 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
37 .dp.length = sizeof(bootefi_image_path[0]),
41 static struct efi_device_path_file_path bootefi_device_path[] = {
43 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
44 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
45 .dp.length = sizeof(bootefi_image_path[0]),
46 .str = { 'b','o','o','t','e','f','i' },
48 .dp.type = DEVICE_PATH_TYPE_END,
49 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
50 .dp.length = sizeof(bootefi_image_path[0]),
54 static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol,
55 void **protocol_interface, void *agent_handle,
56 void *controller_handle, uint32_t attributes)
58 *protocol_interface = bootefi_device_path;
62 /* The EFI loaded_image interface for the image executed via "bootefi" */
63 static struct efi_loaded_image loaded_image_info = {
64 .device_handle = bootefi_device_path,
65 .file_path = bootefi_image_path,
68 /* The EFI object struct for the image executed via "bootefi" */
69 static struct efi_object loaded_image_info_obj = {
70 .handle = &loaded_image_info,
74 * When asking for the loaded_image interface, just
75 * return handle which points to loaded_image_info
77 .guid = &efi_guid_loaded_image,
78 .open = &efi_return_handle,
82 * When asking for the device path interface, return
85 .guid = &efi_guid_device_path,
86 .open = &bootefi_open_dp,
91 /* The EFI object struct for the device the "bootefi" image was loaded from */
92 static struct efi_object bootefi_device_obj = {
93 .handle = bootefi_device_path,
96 /* When asking for the device path interface, return
97 * bootefi_device_path */
98 .guid = &efi_guid_device_path,
99 .open = &bootefi_open_dp,
104 static void *copy_fdt(void *fdt)
106 u64 fdt_size = fdt_totalsize(fdt);
109 /* Give us 64kb breathing room */
110 fdt_size += 64 * 1024;
112 new_fdt = malloc(fdt_size);
113 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
114 fdt_set_totalsize(new_fdt, fdt_size);
120 * Load an EFI payload into a newly allocated piece of memory, register all
121 * EFI objects it would want to access and jump to it.
123 static unsigned long do_bootefi_exec(void *efi)
125 ulong (*entry)(void *image_handle, struct efi_system_table *st);
126 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
127 bootm_headers_t img = { 0 };
128 void *fdt = working_fdt;
131 * gd lives in a fixed register which may get clobbered while we execute
132 * the payload. So save it here and restore it on every callback entry
136 /* Update system table to point to our currently loaded FDT */
138 /* Fall back to included fdt if none was manually loaded */
139 if (!fdt && gd->fdt_blob)
140 fdt = (void *)gd->fdt_blob;
143 /* Prepare fdt for payload */
146 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
147 printf("ERROR: Failed to process device tree\n");
151 /* Link to it in the efi tables */
152 systab.tables[0].guid = EFI_FDT_GUID;
153 systab.tables[0].table = fdt;
154 systab.nr_tables = 1;
156 /* And reserve the space in the memory map */
157 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
158 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
159 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
160 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
161 /* Give a bootloader the chance to modify the device tree */
163 efi_add_memory_map(fdt_start, fdt_pages,
164 EFI_BOOT_SERVICES_DATA, true);
166 printf("WARNING: No device tree loaded, expect boot to fail\n");
167 systab.nr_tables = 0;
170 /* Load the EFI payload */
171 entry = efi_load_pe(efi, &loaded_image_info);
175 /* Initialize and populate EFI object list */
176 INIT_LIST_HEAD(&efi_obj_list);
177 list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
178 list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
179 #ifdef CONFIG_PARTITIONS
186 /* Call our payload! */
188 printf("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
190 return entry(&loaded_image_info, &systab);
194 /* Interpreter command to boot an arbitrary EFI image from memory */
195 static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
205 addr = simple_strtoul(saddr, NULL, 16);
207 printf("## Starting EFI application at 0x%08lx ...\n", addr);
208 r = do_bootefi_exec((void *)addr);
209 printf("## Application terminated, r = %d\n", r);
217 #ifdef CONFIG_SYS_LONGHELP
218 static char bootefi_help_text[] =
220 " - boot EFI payload stored at address <image address>\n"
222 "Since most EFI payloads want to have a device tree provided, please\n"
223 "make sure you load a device tree using the fdt addr command before\n"
224 "executing bootefi.\n";
228 bootefi, 2, 0, do_bootefi,
229 "Boots an EFI payload from memory\n",
233 void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
235 __maybe_unused struct blk_desc *desc;
236 char devname[32] = { 0 }; /* dp->str is u16[32] long */
239 /* Assemble the condensed device name we use in efi_disk.c */
240 snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
241 colon = strchr(devname, ':');
243 #ifdef CONFIG_ISO_PARTITION
244 /* For ISOs we create partition block devices */
245 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
246 if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
247 (desc->part_type == PART_TYPE_ISO)) {
249 snprintf(devname, sizeof(devname), "%s%s:1", dev,
258 /* Patch bootefi_device_path to the target device */
259 memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
260 ascii2unicode(bootefi_device_path[0].str, devname);
262 /* Patch bootefi_image_path to the target file path */
263 memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
264 snprintf(devname, sizeof(devname), "%s", path);
265 ascii2unicode(bootefi_image_path[0].str, devname);