]> git.ipfire.org Git - thirdparty/u-boot.git/blame - cmd/bootefi.c
efi_loader: provide a sufficient number of protocols
[thirdparty/u-boot.git] / cmd / bootefi.c
CommitLineData
b9939336
AG
1/*
2 * EFI application loader
3 *
4 * Copyright (c) 2016 Alexander Graf
5 *
6 * SPDX-License-Identifier: GPL-2.0+
7 */
8
9#include <common.h>
10#include <command.h>
9d922450 11#include <dm.h>
b9939336
AG
12#include <efi_loader.h>
13#include <errno.h>
14#include <libfdt.h>
15#include <libfdt_env.h>
ad0c1a3d 16#include <memalign.h>
0d9d501f 17#include <asm/global_data.h>
e275458c
SG
18#include <asm-generic/sections.h>
19#include <linux/linkage.h>
0d9d501f
AG
20
21DECLARE_GLOBAL_DATA_PTR;
b9939336
AG
22
23/*
24 * When booting using the "bootefi" command, we don't know which
25 * physical device the file came from. So we create a pseudo-device
26 * called "bootefi" with the device path /bootefi.
27 *
28 * In addition to the originating device we also declare the file path
29 * of "bootefi" based loads to be /bootefi.
30 */
0f4060eb 31static struct efi_device_path_file_path bootefi_image_path[] = {
b9939336
AG
32 {
33 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
34 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
0f4060eb 35 .dp.length = sizeof(bootefi_image_path[0]),
b9939336
AG
36 .str = { 'b','o','o','t','e','f','i' },
37 }, {
38 .dp.type = DEVICE_PATH_TYPE_END,
39 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
0f4060eb 40 .dp.length = sizeof(bootefi_image_path[0]),
b9939336
AG
41 }
42};
43
c07ad7c0
AG
44static struct efi_device_path_file_path bootefi_device_path[] = {
45 {
46 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
47 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
48 .dp.length = sizeof(bootefi_image_path[0]),
49 .str = { 'b','o','o','t','e','f','i' },
50 }, {
51 .dp.type = DEVICE_PATH_TYPE_END,
52 .dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
53 .dp.length = sizeof(bootefi_image_path[0]),
54 }
55};
56
b9939336
AG
57/* The EFI loaded_image interface for the image executed via "bootefi" */
58static struct efi_loaded_image loaded_image_info = {
c07ad7c0 59 .device_handle = bootefi_device_path,
0f4060eb 60 .file_path = bootefi_image_path,
b9939336
AG
61};
62
63/* The EFI object struct for the image executed via "bootefi" */
64static struct efi_object loaded_image_info_obj = {
65 .handle = &loaded_image_info,
66 .protocols = {
67 {
68 /*
69 * When asking for the loaded_image interface, just
70 * return handle which points to loaded_image_info
71 */
72 .guid = &efi_guid_loaded_image,
b5349f74 73 .protocol_interface = &loaded_image_info,
b9939336
AG
74 },
75 {
76 /*
77 * When asking for the device path interface, return
c07ad7c0 78 * bootefi_device_path
b9939336
AG
79 */
80 .guid = &efi_guid_device_path,
b5349f74 81 .protocol_interface = bootefi_device_path,
b9939336
AG
82 },
83 },
84};
85
86/* The EFI object struct for the device the "bootefi" image was loaded from */
87static struct efi_object bootefi_device_obj = {
c07ad7c0 88 .handle = bootefi_device_path,
b9939336
AG
89 .protocols = {
90 {
91 /* When asking for the device path interface, return
c07ad7c0 92 * bootefi_device_path */
b9939336 93 .guid = &efi_guid_device_path,
b5349f74 94 .protocol_interface = bootefi_device_path
b9939336
AG
95 }
96 },
97};
98
0d9d501f
AG
99static void *copy_fdt(void *fdt)
100{
101 u64 fdt_size = fdt_totalsize(fdt);
ad0c1a3d
AG
102 unsigned long fdt_ram_start = -1L, fdt_pages;
103 u64 new_fdt_addr;
0d9d501f 104 void *new_fdt;
ad0c1a3d 105 int i;
0d9d501f 106
ad0c1a3d
AG
107 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
108 u64 ram_start = gd->bd->bi_dram[i].start;
109 u64 ram_size = gd->bd->bi_dram[i].size;
0d9d501f 110
ad0c1a3d
AG
111 if (!ram_size)
112 continue;
113
114 if (ram_start < fdt_ram_start)
115 fdt_ram_start = ram_start;
116 }
117
118 /* Give us at least 4kb breathing room */
119 fdt_size = ALIGN(fdt_size + 4096, 4096);
120 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
121
122 /* Safe fdt location is at 128MB */
123 new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
124 if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages,
125 &new_fdt_addr) != EFI_SUCCESS) {
126 /* If we can't put it there, put it somewhere */
127 new_fdt_addr = (ulong)memalign(4096, fdt_size);
85a6e9b3
AG
128 if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages,
129 &new_fdt_addr) != EFI_SUCCESS) {
130 printf("ERROR: Failed to reserve space for FDT\n");
131 return NULL;
132 }
ad0c1a3d 133 }
85a6e9b3 134
ad0c1a3d 135 new_fdt = (void*)(ulong)new_fdt_addr;
0d9d501f
AG
136 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
137 fdt_set_totalsize(new_fdt, fdt_size);
138
139 return new_fdt;
140}
141
ec6617c3
AW
142#ifdef CONFIG_ARM64
143static unsigned long efi_run_in_el2(ulong (*entry)(void *image_handle,
144 struct efi_system_table *st), void *image_handle,
145 struct efi_system_table *st)
146{
147 /* Enable caches again */
148 dcache_enable();
149
150 return entry(image_handle, st);
151}
152#endif
153
b9939336
AG
154/*
155 * Load an EFI payload into a newly allocated piece of memory, register all
156 * EFI objects it would want to access and jump to it.
157 */
1c39809b 158static unsigned long do_bootefi_exec(void *efi, void *fdt)
b9939336 159{
e275458c
SG
160 ulong (*entry)(void *image_handle, struct efi_system_table *st)
161 asmlinkage;
b9939336 162 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
dea2174d 163 bootm_headers_t img = { 0 };
b9939336
AG
164
165 /*
166 * gd lives in a fixed register which may get clobbered while we execute
167 * the payload. So save it here and restore it on every callback entry
168 */
169 efi_save_gd();
170
1c39809b 171 if (fdt && !fdt_check_header(fdt)) {
dea2174d 172 /* Prepare fdt for payload */
0d9d501f
AG
173 fdt = copy_fdt(fdt);
174
175 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
dea2174d
AG
176 printf("ERROR: Failed to process device tree\n");
177 return -EINVAL;
178 }
179
180 /* Link to it in the efi tables */
b9939336 181 systab.tables[0].guid = EFI_FDT_GUID;
0d9d501f 182 systab.tables[0].table = fdt;
b9939336
AG
183 systab.nr_tables = 1;
184
185 /* And reserve the space in the memory map */
0d9d501f
AG
186 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
187 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
b9939336
AG
188 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
189 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
190 /* Give a bootloader the chance to modify the device tree */
191 fdt_pages += 2;
192 efi_add_memory_map(fdt_start, fdt_pages,
193 EFI_BOOT_SERVICES_DATA, true);
b9939336 194 } else {
1c39809b 195 printf("WARNING: Invalid device tree, expect boot to fail\n");
b9939336
AG
196 systab.nr_tables = 0;
197 }
198
199 /* Load the EFI payload */
200 entry = efi_load_pe(efi, &loaded_image_info);
201 if (!entry)
202 return -ENOENT;
203
204 /* Initialize and populate EFI object list */
205 INIT_LIST_HEAD(&efi_obj_list);
206 list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
207 list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
208#ifdef CONFIG_PARTITIONS
209 efi_disk_register();
210#endif
be8d3241
AG
211#ifdef CONFIG_LCD
212 efi_gop_register();
213#endif
0efe1bcf
AG
214#ifdef CONFIG_NET
215 void *nethandle = loaded_image_info.device_handle;
216 efi_net_register(&nethandle);
217
218 if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6))
219 loaded_image_info.device_handle = nethandle;
3fb97e26
AG
220 else
221 loaded_image_info.device_handle = bootefi_device_path;
0efe1bcf 222#endif
e663b350
AG
223#ifdef CONFIG_GENERATE_SMBIOS_TABLE
224 efi_smbios_register();
225#endif
b9939336 226
80a4800e
AG
227 /* Initialize EFI runtime services */
228 efi_reset_system_init();
229 efi_get_time_init();
230
b9939336 231 /* Call our payload! */
edcef3ba 232 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
a86aeaf2
AG
233
234 if (setjmp(&loaded_image_info.exit_jmp)) {
235 efi_status_t status = loaded_image_info.exit_status;
236 return status == EFI_SUCCESS ? 0 : -EINVAL;
237 }
238
69bd459d
AG
239#ifdef CONFIG_ARM64
240 /* On AArch64 we need to make sure we call our payload in < EL3 */
241 if (current_el() == 3) {
242 smp_kick_all_cpus();
243 dcache_disable(); /* flush cache before switch to EL2 */
ec6617c3
AW
244
245 /* Move into EL2 and keep running there */
246 armv8_switch_to_el2((ulong)entry, (ulong)&loaded_image_info,
7c5e1feb 247 (ulong)&systab, 0, (ulong)efi_run_in_el2,
ec6617c3
AW
248 ES_TO_AARCH64);
249
250 /* Should never reach here, efi exits with longjmp */
251 while (1) { }
69bd459d
AG
252 }
253#endif
254
b9939336
AG
255 return entry(&loaded_image_info, &systab);
256}
257
258
259/* Interpreter command to boot an arbitrary EFI image from memory */
260static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
261{
1c39809b
AG
262 char *saddr, *sfdt;
263 unsigned long addr, fdt_addr = 0;
b9939336
AG
264 int r = 0;
265
266 if (argc < 2)
3c1dcef6 267 return CMD_RET_USAGE;
c7ae3dfd
SG
268#ifdef CONFIG_CMD_BOOTEFI_HELLO
269 if (!strcmp(argv[1], "hello")) {
270 ulong size = __efi_hello_world_end - __efi_hello_world_begin;
b9939336 271
c7ae3dfd
SG
272 addr = CONFIG_SYS_LOAD_ADDR;
273 memcpy((char *)addr, __efi_hello_world_begin, size);
274 } else
275#endif
276 {
277 saddr = argv[1];
b9939336 278
c7ae3dfd
SG
279 addr = simple_strtoul(saddr, NULL, 16);
280
281 if (argc > 2) {
282 sfdt = argv[2];
283 fdt_addr = simple_strtoul(sfdt, NULL, 16);
284 }
1c39809b
AG
285 }
286
5ee31baf 287 printf("## Starting EFI application at %08lx ...\n", addr);
1c39809b 288 r = do_bootefi_exec((void *)addr, (void*)fdt_addr);
b9939336
AG
289 printf("## Application terminated, r = %d\n", r);
290
291 if (r != 0)
292 r = 1;
293
294 return r;
295}
296
297#ifdef CONFIG_SYS_LONGHELP
298static char bootefi_help_text[] =
1c39809b
AG
299 "<image address> [fdt address]\n"
300 " - boot EFI payload stored at address <image address>.\n"
301 " If specified, the device tree located at <fdt address> gets\n"
c7ae3dfd
SG
302 " exposed as EFI configuration table.\n"
303#ifdef CONFIG_CMD_BOOTEFI_HELLO
304 "hello\n"
305 " - boot a sample Hello World application stored within U-Boot"
306#endif
307 ;
b9939336
AG
308#endif
309
310U_BOOT_CMD(
1c39809b 311 bootefi, 3, 0, do_bootefi,
92dfd922 312 "Boots an EFI payload from memory",
b9939336
AG
313 bootefi_help_text
314);
0f4060eb 315
c07ad7c0 316void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
0f4060eb 317{
8c3df0bf 318 __maybe_unused struct blk_desc *desc;
ecbe1a07 319 char devname[32] = { 0 }; /* dp->str is u16[32] long */
0f4060eb
AG
320 char *colon;
321
1acc0087 322#if defined(CONFIG_BLK) || CONFIG_IS_ENABLED(ISO_PARTITION)
f9d334bd
AG
323 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
324#endif
325
326#ifdef CONFIG_BLK
327 if (desc) {
328 snprintf(devname, sizeof(devname), "%s", desc->bdev->name);
329 } else
330#endif
331
332 {
333 /* Assemble the condensed device name we use in efi_disk.c */
334 snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
335 }
336
0f4060eb 337 colon = strchr(devname, ':');
8c3df0bf 338
1acc0087 339#if CONFIG_IS_ENABLED(ISO_PARTITION)
8c3df0bf 340 /* For ISOs we create partition block devices */
8c3df0bf
AG
341 if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
342 (desc->part_type == PART_TYPE_ISO)) {
343 if (!colon)
f9d334bd
AG
344 snprintf(devname, sizeof(devname), "%s:1", devname);
345
8c3df0bf
AG
346 colon = NULL;
347 }
348#endif
349
0f4060eb
AG
350 if (colon)
351 *colon = '\0';
352
c07ad7c0
AG
353 /* Patch bootefi_device_path to the target device */
354 memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
355 ascii2unicode(bootefi_device_path[0].str, devname);
356
357 /* Patch bootefi_image_path to the target file path */
0f4060eb 358 memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
49271666
AG
359 if (strcmp(dev, "Net")) {
360 /* Add leading / to fs paths, because they're absolute */
361 snprintf(devname, sizeof(devname), "/%s", path);
362 } else {
363 snprintf(devname, sizeof(devname), "%s", path);
364 }
0f4060eb
AG
365 ascii2unicode(bootefi_image_path[0].str, devname);
366}