blob: 771300ee94b739e36f16f2c6eed98e539e9b23c0 [file] [log] [blame]
Alexander Grafb9939332016-03-10 00:27:20 +01001/*
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>
Simon Glass9d922452017-05-17 17:18:03 -060011#include <dm.h>
Alexander Grafb9939332016-03-10 00:27:20 +010012#include <efi_loader.h>
13#include <errno.h>
14#include <libfdt.h>
15#include <libfdt_env.h>
Alexander Grafad0c1a32016-04-11 23:51:01 +020016#include <memalign.h>
Alexander Graf0d9d5012016-04-11 16:55:26 +020017#include <asm/global_data.h>
Simon Glasse2754582016-09-25 15:27:32 -060018#include <asm-generic/sections.h>
19#include <linux/linkage.h>
Alexander Graf0d9d5012016-04-11 16:55:26 +020020
21DECLARE_GLOBAL_DATA_PTR;
Alexander Grafb9939332016-03-10 00:27:20 +010022
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 */
Alexander Graf0f4060e2016-03-04 01:10:14 +010031static struct efi_device_path_file_path bootefi_image_path[] = {
Alexander Grafb9939332016-03-10 00:27:20 +010032 {
33 .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
34 .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
Alexander Graf0f4060e2016-03-04 01:10:14 +010035 .dp.length = sizeof(bootefi_image_path[0]),
Alexander Grafb9939332016-03-10 00:27:20 +010036 .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,
Alexander Graf0f4060e2016-03-04 01:10:14 +010040 .dp.length = sizeof(bootefi_image_path[0]),
Alexander Grafb9939332016-03-10 00:27:20 +010041 }
42};
43
Alexander Grafc07ad7c2016-04-11 16:16:19 +020044static 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
Simon Glasse2754582016-09-25 15:27:32 -060057static efi_status_t EFIAPI bootefi_open_dp(void *handle, efi_guid_t *protocol,
Alexander Grafb9939332016-03-10 00:27:20 +010058 void **protocol_interface, void *agent_handle,
59 void *controller_handle, uint32_t attributes)
60{
Alexander Grafc07ad7c2016-04-11 16:16:19 +020061 *protocol_interface = bootefi_device_path;
Alexander Grafb9939332016-03-10 00:27:20 +010062 return EFI_SUCCESS;
63}
64
65/* The EFI loaded_image interface for the image executed via "bootefi" */
66static struct efi_loaded_image loaded_image_info = {
Alexander Grafc07ad7c2016-04-11 16:16:19 +020067 .device_handle = bootefi_device_path,
Alexander Graf0f4060e2016-03-04 01:10:14 +010068 .file_path = bootefi_image_path,
Alexander Grafb9939332016-03-10 00:27:20 +010069};
70
71/* The EFI object struct for the image executed via "bootefi" */
72static struct efi_object loaded_image_info_obj = {
73 .handle = &loaded_image_info,
74 .protocols = {
75 {
76 /*
77 * When asking for the loaded_image interface, just
78 * return handle which points to loaded_image_info
79 */
80 .guid = &efi_guid_loaded_image,
81 .open = &efi_return_handle,
82 },
83 {
84 /*
85 * When asking for the device path interface, return
Alexander Grafc07ad7c2016-04-11 16:16:19 +020086 * bootefi_device_path
Alexander Grafb9939332016-03-10 00:27:20 +010087 */
88 .guid = &efi_guid_device_path,
89 .open = &bootefi_open_dp,
90 },
91 },
92};
93
94/* The EFI object struct for the device the "bootefi" image was loaded from */
95static struct efi_object bootefi_device_obj = {
Alexander Grafc07ad7c2016-04-11 16:16:19 +020096 .handle = bootefi_device_path,
Alexander Grafb9939332016-03-10 00:27:20 +010097 .protocols = {
98 {
99 /* When asking for the device path interface, return
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200100 * bootefi_device_path */
Alexander Grafb9939332016-03-10 00:27:20 +0100101 .guid = &efi_guid_device_path,
102 .open = &bootefi_open_dp,
103 }
104 },
105};
106
Alexander Graf0d9d5012016-04-11 16:55:26 +0200107static void *copy_fdt(void *fdt)
108{
109 u64 fdt_size = fdt_totalsize(fdt);
Alexander Grafad0c1a32016-04-11 23:51:01 +0200110 unsigned long fdt_ram_start = -1L, fdt_pages;
111 u64 new_fdt_addr;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200112 void *new_fdt;
Alexander Grafad0c1a32016-04-11 23:51:01 +0200113 int i;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200114
Alexander Grafad0c1a32016-04-11 23:51:01 +0200115 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;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200118
Alexander Grafad0c1a32016-04-11 23:51:01 +0200119 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);
Alexander Graf85a6e9b2017-07-03 13:32:35 +0200136 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 }
Alexander Grafad0c1a32016-04-11 23:51:01 +0200141 }
Alexander Graf85a6e9b2017-07-03 13:32:35 +0200142
Alexander Grafad0c1a32016-04-11 23:51:01 +0200143 new_fdt = (void*)(ulong)new_fdt_addr;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200144 memcpy(new_fdt, fdt, fdt_totalsize(fdt));
145 fdt_set_totalsize(new_fdt, fdt_size);
146
147 return new_fdt;
148}
149
Alison Wangec6617c2016-11-10 10:49:03 +0800150#ifdef CONFIG_ARM64
151static unsigned long efi_run_in_el2(ulong (*entry)(void *image_handle,
152 struct efi_system_table *st), void *image_handle,
153 struct efi_system_table *st)
154{
155 /* Enable caches again */
156 dcache_enable();
157
158 return entry(image_handle, st);
159}
160#endif
161
Alexander Grafb9939332016-03-10 00:27:20 +0100162/*
163 * Load an EFI payload into a newly allocated piece of memory, register all
164 * EFI objects it would want to access and jump to it.
165 */
Alexander Graf1c398092016-04-14 16:07:53 +0200166static unsigned long do_bootefi_exec(void *efi, void *fdt)
Alexander Grafb9939332016-03-10 00:27:20 +0100167{
Simon Glasse2754582016-09-25 15:27:32 -0600168 ulong (*entry)(void *image_handle, struct efi_system_table *st)
169 asmlinkage;
Alexander Grafb9939332016-03-10 00:27:20 +0100170 ulong fdt_pages, fdt_size, fdt_start, fdt_end;
Alexander Grafdea21742016-03-04 01:10:13 +0100171 bootm_headers_t img = { 0 };
Alexander Grafb9939332016-03-10 00:27:20 +0100172
173 /*
174 * gd lives in a fixed register which may get clobbered while we execute
175 * the payload. So save it here and restore it on every callback entry
176 */
177 efi_save_gd();
178
Alexander Graf1c398092016-04-14 16:07:53 +0200179 if (fdt && !fdt_check_header(fdt)) {
Alexander Grafdea21742016-03-04 01:10:13 +0100180 /* Prepare fdt for payload */
Alexander Graf0d9d5012016-04-11 16:55:26 +0200181 fdt = copy_fdt(fdt);
182
183 if (image_setup_libfdt(&img, fdt, 0, NULL)) {
Alexander Grafdea21742016-03-04 01:10:13 +0100184 printf("ERROR: Failed to process device tree\n");
185 return -EINVAL;
186 }
187
188 /* Link to it in the efi tables */
Alexander Grafb9939332016-03-10 00:27:20 +0100189 systab.tables[0].guid = EFI_FDT_GUID;
Alexander Graf0d9d5012016-04-11 16:55:26 +0200190 systab.tables[0].table = fdt;
Alexander Grafb9939332016-03-10 00:27:20 +0100191 systab.nr_tables = 1;
192
193 /* And reserve the space in the memory map */
Alexander Graf0d9d5012016-04-11 16:55:26 +0200194 fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
195 fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
Alexander Grafb9939332016-03-10 00:27:20 +0100196 fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
197 fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
198 /* Give a bootloader the chance to modify the device tree */
199 fdt_pages += 2;
200 efi_add_memory_map(fdt_start, fdt_pages,
201 EFI_BOOT_SERVICES_DATA, true);
Alexander Grafb9939332016-03-10 00:27:20 +0100202 } else {
Alexander Graf1c398092016-04-14 16:07:53 +0200203 printf("WARNING: Invalid device tree, expect boot to fail\n");
Alexander Grafb9939332016-03-10 00:27:20 +0100204 systab.nr_tables = 0;
205 }
206
207 /* Load the EFI payload */
208 entry = efi_load_pe(efi, &loaded_image_info);
209 if (!entry)
210 return -ENOENT;
211
212 /* Initialize and populate EFI object list */
213 INIT_LIST_HEAD(&efi_obj_list);
214 list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
215 list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
216#ifdef CONFIG_PARTITIONS
217 efi_disk_register();
218#endif
Alexander Grafbe8d3242016-03-15 18:38:21 +0100219#ifdef CONFIG_LCD
220 efi_gop_register();
221#endif
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200222#ifdef CONFIG_NET
223 void *nethandle = loaded_image_info.device_handle;
224 efi_net_register(&nethandle);
225
226 if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6))
227 loaded_image_info.device_handle = nethandle;
Alexander Graf3fb97e22016-10-18 15:49:40 +0200228 else
229 loaded_image_info.device_handle = bootefi_device_path;
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200230#endif
Alexander Grafe663b352016-08-19 01:23:29 +0200231#ifdef CONFIG_GENERATE_SMBIOS_TABLE
232 efi_smbios_register();
233#endif
Alexander Grafb9939332016-03-10 00:27:20 +0100234
Alexander Graf80a48002016-08-16 21:08:45 +0200235 /* Initialize EFI runtime services */
236 efi_reset_system_init();
237 efi_get_time_init();
238
Alexander Grafb9939332016-03-10 00:27:20 +0100239 /* Call our payload! */
Alexander Grafedcef3b2016-06-02 11:38:27 +0200240 debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
Alexander Grafa86aeaf2016-05-20 23:28:23 +0200241
242 if (setjmp(&loaded_image_info.exit_jmp)) {
243 efi_status_t status = loaded_image_info.exit_status;
244 return status == EFI_SUCCESS ? 0 : -EINVAL;
245 }
246
Alexander Graf69bd4592016-11-17 01:02:58 +0100247#ifdef CONFIG_ARM64
248 /* On AArch64 we need to make sure we call our payload in < EL3 */
249 if (current_el() == 3) {
250 smp_kick_all_cpus();
251 dcache_disable(); /* flush cache before switch to EL2 */
Alison Wangec6617c2016-11-10 10:49:03 +0800252
253 /* Move into EL2 and keep running there */
254 armv8_switch_to_el2((ulong)entry, (ulong)&loaded_image_info,
Alison Wang7c5e1fe2017-01-17 09:39:17 +0800255 (ulong)&systab, 0, (ulong)efi_run_in_el2,
Alison Wangec6617c2016-11-10 10:49:03 +0800256 ES_TO_AARCH64);
257
258 /* Should never reach here, efi exits with longjmp */
259 while (1) { }
Alexander Graf69bd4592016-11-17 01:02:58 +0100260 }
261#endif
262
Alexander Grafb9939332016-03-10 00:27:20 +0100263 return entry(&loaded_image_info, &systab);
264}
265
266
267/* Interpreter command to boot an arbitrary EFI image from memory */
268static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
269{
Alexander Graf1c398092016-04-14 16:07:53 +0200270 char *saddr, *sfdt;
271 unsigned long addr, fdt_addr = 0;
Alexander Grafb9939332016-03-10 00:27:20 +0100272 int r = 0;
273
274 if (argc < 2)
Bin Meng3c1dcef2016-08-13 04:02:06 -0700275 return CMD_RET_USAGE;
Simon Glassc7ae3df2016-11-07 08:47:08 -0700276#ifdef CONFIG_CMD_BOOTEFI_HELLO
277 if (!strcmp(argv[1], "hello")) {
278 ulong size = __efi_hello_world_end - __efi_hello_world_begin;
Alexander Grafb9939332016-03-10 00:27:20 +0100279
Simon Glassc7ae3df2016-11-07 08:47:08 -0700280 addr = CONFIG_SYS_LOAD_ADDR;
281 memcpy((char *)addr, __efi_hello_world_begin, size);
282 } else
283#endif
284 {
285 saddr = argv[1];
Alexander Grafb9939332016-03-10 00:27:20 +0100286
Simon Glassc7ae3df2016-11-07 08:47:08 -0700287 addr = simple_strtoul(saddr, NULL, 16);
288
289 if (argc > 2) {
290 sfdt = argv[2];
291 fdt_addr = simple_strtoul(sfdt, NULL, 16);
292 }
Alexander Graf1c398092016-04-14 16:07:53 +0200293 }
294
Simon Glass5ee31ba2016-11-07 08:47:05 -0700295 printf("## Starting EFI application at %08lx ...\n", addr);
Alexander Graf1c398092016-04-14 16:07:53 +0200296 r = do_bootefi_exec((void *)addr, (void*)fdt_addr);
Alexander Grafb9939332016-03-10 00:27:20 +0100297 printf("## Application terminated, r = %d\n", r);
298
299 if (r != 0)
300 r = 1;
301
302 return r;
303}
304
305#ifdef CONFIG_SYS_LONGHELP
306static char bootefi_help_text[] =
Alexander Graf1c398092016-04-14 16:07:53 +0200307 "<image address> [fdt address]\n"
308 " - boot EFI payload stored at address <image address>.\n"
309 " If specified, the device tree located at <fdt address> gets\n"
Simon Glassc7ae3df2016-11-07 08:47:08 -0700310 " exposed as EFI configuration table.\n"
311#ifdef CONFIG_CMD_BOOTEFI_HELLO
312 "hello\n"
313 " - boot a sample Hello World application stored within U-Boot"
314#endif
315 ;
Alexander Grafb9939332016-03-10 00:27:20 +0100316#endif
317
318U_BOOT_CMD(
Alexander Graf1c398092016-04-14 16:07:53 +0200319 bootefi, 3, 0, do_bootefi,
Sergey Kubushyn92dfd922016-06-07 11:14:31 -0700320 "Boots an EFI payload from memory",
Alexander Grafb9939332016-03-10 00:27:20 +0100321 bootefi_help_text
322);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100323
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200324void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
Alexander Graf0f4060e2016-03-04 01:10:14 +0100325{
Alexander Graf8c3df0b2016-04-11 16:16:18 +0200326 __maybe_unused struct blk_desc *desc;
Alexander Grafecbe1a02016-04-11 16:16:20 +0200327 char devname[32] = { 0 }; /* dp->str is u16[32] long */
Alexander Graf0f4060e2016-03-04 01:10:14 +0100328 char *colon;
329
Patrick Delaunay1acc0082017-01-27 11:00:38 +0100330#if defined(CONFIG_BLK) || CONFIG_IS_ENABLED(ISO_PARTITION)
Alexander Graff9d334b2016-08-05 14:49:53 +0200331 desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
332#endif
333
334#ifdef CONFIG_BLK
335 if (desc) {
336 snprintf(devname, sizeof(devname), "%s", desc->bdev->name);
337 } else
338#endif
339
340 {
341 /* Assemble the condensed device name we use in efi_disk.c */
342 snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
343 }
344
Alexander Graf0f4060e2016-03-04 01:10:14 +0100345 colon = strchr(devname, ':');
Alexander Graf8c3df0b2016-04-11 16:16:18 +0200346
Patrick Delaunay1acc0082017-01-27 11:00:38 +0100347#if CONFIG_IS_ENABLED(ISO_PARTITION)
Alexander Graf8c3df0b2016-04-11 16:16:18 +0200348 /* For ISOs we create partition block devices */
Alexander Graf8c3df0b2016-04-11 16:16:18 +0200349 if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
350 (desc->part_type == PART_TYPE_ISO)) {
351 if (!colon)
Alexander Graff9d334b2016-08-05 14:49:53 +0200352 snprintf(devname, sizeof(devname), "%s:1", devname);
353
Alexander Graf8c3df0b2016-04-11 16:16:18 +0200354 colon = NULL;
355 }
356#endif
357
Alexander Graf0f4060e2016-03-04 01:10:14 +0100358 if (colon)
359 *colon = '\0';
360
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200361 /* Patch bootefi_device_path to the target device */
362 memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
363 ascii2unicode(bootefi_device_path[0].str, devname);
364
365 /* Patch bootefi_image_path to the target file path */
Alexander Graf0f4060e2016-03-04 01:10:14 +0100366 memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
Alexander Graf49271662016-07-21 01:44:46 +0200367 if (strcmp(dev, "Net")) {
368 /* Add leading / to fs paths, because they're absolute */
369 snprintf(devname, sizeof(devname), "/%s", path);
370 } else {
371 snprintf(devname, sizeof(devname), "%s", path);
372 }
Alexander Graf0f4060e2016-03-04 01:10:14 +0100373 ascii2unicode(bootefi_image_path[0].str, devname);
374}