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