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