[people/ms/u-boot.git] / cmd / bootefi.c

/*
 *  EFI application loader
 *
 *  Copyright (c) 2016 Alexander Graf
 *
 *  SPDX-License-Identifier:     GPL-2.0+
 */

#include <common.h>
#include <command.h>
#include <dm/device.h>
#include <efi_loader.h>
#include <errno.h>
#include <libfdt.h>
#include <libfdt_env.h>
#include <memalign.h>
#include <asm/global_data.h>

DECLARE_GLOBAL_DATA_PTR;

/*
 * When booting using the "bootefi" command, we don't know which
 * physical device the file came from. So we create a pseudo-device
 * called "bootefi" with the device path /bootefi.
 *
 * In addition to the originating device we also declare the file path
 * of "bootefi" based loads to be /bootefi.
 */
static struct efi_device_path_file_path bootefi_image_path[] = {
	{
		.dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
		.dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
		.dp.length = sizeof(bootefi_image_path[0]),
		.str = { 'b','o','o','t','e','f','i' },
	}, {
		.dp.type = DEVICE_PATH_TYPE_END,
		.dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
		.dp.length = sizeof(bootefi_image_path[0]),
	}
};

static struct efi_device_path_file_path bootefi_device_path[] = {
	{
		.dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
		.dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
		.dp.length = sizeof(bootefi_image_path[0]),
		.str = { 'b','o','o','t','e','f','i' },
	}, {
		.dp.type = DEVICE_PATH_TYPE_END,
		.dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
		.dp.length = sizeof(bootefi_image_path[0]),
	}
};

static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol,
			void **protocol_interface, void *agent_handle,
			void *controller_handle, uint32_t attributes)
{
	*protocol_interface = bootefi_device_path;
	return EFI_SUCCESS;
}

/* The EFI loaded_image interface for the image executed via "bootefi" */
static struct efi_loaded_image loaded_image_info = {
	.device_handle = bootefi_device_path,
	.file_path = bootefi_image_path,
};

/* The EFI object struct for the image executed via "bootefi" */
static struct efi_object loaded_image_info_obj = {
	.handle = &loaded_image_info,
	.protocols = {
		{
			/*
			 * When asking for the loaded_image interface, just
			 * return handle which points to loaded_image_info
			 */
			.guid = &efi_guid_loaded_image,
			.open = &efi_return_handle,
		},
		{
			/*
			 * When asking for the device path interface, return
			 * bootefi_device_path
			 */
			.guid = &efi_guid_device_path,
			.open = &bootefi_open_dp,
		},
	},
};

/* The EFI object struct for the device the "bootefi" image was loaded from */
static struct efi_object bootefi_device_obj = {
	.handle = bootefi_device_path,
	.protocols = {
		{
			/* When asking for the device path interface, return
			 * bootefi_device_path */
			.guid = &efi_guid_device_path,
			.open = &bootefi_open_dp,
		}
	},
};

static void *copy_fdt(void *fdt)
{
	u64 fdt_size = fdt_totalsize(fdt);
	unsigned long fdt_ram_start = -1L, fdt_pages;
	u64 new_fdt_addr;
	void *new_fdt;
	int i;

        for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
                u64 ram_start = gd->bd->bi_dram[i].start;
                u64 ram_size = gd->bd->bi_dram[i].size;

		if (!ram_size)
			continue;

		if (ram_start < fdt_ram_start)
			fdt_ram_start = ram_start;
	}

	/* Give us at least 4kb breathing room */
	fdt_size = ALIGN(fdt_size + 4096, 4096);
	fdt_pages = fdt_size >> EFI_PAGE_SHIFT;

	/* Safe fdt location is at 128MB */
	new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
	if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages,
			       &new_fdt_addr) != EFI_SUCCESS) {
		/* If we can't put it there, put it somewhere */
		new_fdt_addr = (ulong)memalign(4096, fdt_size);
	}
	new_fdt = (void*)(ulong)new_fdt_addr;
	memcpy(new_fdt, fdt, fdt_totalsize(fdt));
	fdt_set_totalsize(new_fdt, fdt_size);

	return new_fdt;
}

/*
 * Load an EFI payload into a newly allocated piece of memory, register all
 * EFI objects it would want to access and jump to it.
 */
static unsigned long do_bootefi_exec(void *efi, void *fdt)
{
	ulong (*entry)(void *image_handle, struct efi_system_table *st);
	ulong fdt_pages, fdt_size, fdt_start, fdt_end;
	bootm_headers_t img = { 0 };

	/*
	 * gd lives in a fixed register which may get clobbered while we execute
	 * the payload. So save it here and restore it on every callback entry
	 */
	efi_save_gd();

	if (fdt && !fdt_check_header(fdt)) {
		/* Prepare fdt for payload */
		fdt = copy_fdt(fdt);

		if (image_setup_libfdt(&img, fdt, 0, NULL)) {
			printf("ERROR: Failed to process device tree\n");
			return -EINVAL;
		}

		/* Link to it in the efi tables */
		systab.tables[0].guid = EFI_FDT_GUID;
		systab.tables[0].table = fdt;
		systab.nr_tables = 1;

		/* And reserve the space in the memory map */
		fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
		fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
		fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
		fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
		/* Give a bootloader the chance to modify the device tree */
		fdt_pages += 2;
		efi_add_memory_map(fdt_start, fdt_pages,
				   EFI_BOOT_SERVICES_DATA, true);
	} else {
		printf("WARNING: Invalid device tree, expect boot to fail\n");
		systab.nr_tables = 0;
	}

	/* Load the EFI payload */
	entry = efi_load_pe(efi, &loaded_image_info);
	if (!entry)
		return -ENOENT;

	/* Initialize and populate EFI object list */
	INIT_LIST_HEAD(&efi_obj_list);
	list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
	list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
#ifdef CONFIG_PARTITIONS
	efi_disk_register();
#endif
#ifdef CONFIG_LCD
	efi_gop_register();
#endif
#ifdef CONFIG_NET
	void *nethandle = loaded_image_info.device_handle;
	efi_net_register(&nethandle);

	if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6))
		loaded_image_info.device_handle = nethandle;
#endif

	/* Call our payload! */
	debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);

	if (setjmp(&loaded_image_info.exit_jmp)) {
		efi_status_t status = loaded_image_info.exit_status;
		return status == EFI_SUCCESS ? 0 : -EINVAL;
	}

	return entry(&loaded_image_info, &systab);
}


/* Interpreter command to boot an arbitrary EFI image from memory */
static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	char *saddr, *sfdt;
	unsigned long addr, fdt_addr = 0;
	int r = 0;

	if (argc < 2)
		return 1;
	saddr = argv[1];

	addr = simple_strtoul(saddr, NULL, 16);

	if (argc > 2) {
		sfdt = argv[2];
		fdt_addr = simple_strtoul(sfdt, NULL, 16);
	}

	printf("## Starting EFI application at 0x%08lx ...\n", addr);
	r = do_bootefi_exec((void *)addr, (void*)fdt_addr);
	printf("## Application terminated, r = %d\n", r);

	if (r != 0)
		r = 1;

	return r;
}

#ifdef CONFIG_SYS_LONGHELP
static char bootefi_help_text[] =
	"<image address> [fdt address]\n"
	"  - boot EFI payload stored at address <image address>.\n"
	"    If specified, the device tree located at <fdt address> gets\n"
	"    exposed as EFI configuration table.\n";
#endif

U_BOOT_CMD(
	bootefi, 3, 0, do_bootefi,
	"Boots an EFI payload from memory",
	bootefi_help_text
);

void efi_set_bootdev(const char *dev, const char *devnr, const char *path)
{
	__maybe_unused struct blk_desc *desc;
	char devname[32] = { 0 }; /* dp->str is u16[32] long */
	char *colon;

#if defined(CONFIG_BLK) || defined(CONFIG_ISO_PARTITION)
	desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
#endif

#ifdef CONFIG_BLK
	if (desc) {
		snprintf(devname, sizeof(devname), "%s", desc->bdev->name);
	} else
#endif

	{
		/* Assemble the condensed device name we use in efi_disk.c */
		snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
	}

	colon = strchr(devname, ':');

#ifdef CONFIG_ISO_PARTITION
	/* For ISOs we create partition block devices */
	if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
	    (desc->part_type == PART_TYPE_ISO)) {
		if (!colon)
			snprintf(devname, sizeof(devname), "%s:1", devname);

		colon = NULL;
	}
#endif

	if (colon)
		*colon = '\0';

	/* Patch bootefi_device_path to the target device */
	memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
	ascii2unicode(bootefi_device_path[0].str, devname);

	/* Patch bootefi_image_path to the target file path */
	memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
	if (strcmp(dev, "Net")) {
		/* Add leading / to fs paths, because they're absolute */
		snprintf(devname, sizeof(devname), "/%s", path);
	} else {
		snprintf(devname, sizeof(devname), "%s", path);
	}
	ascii2unicode(bootefi_image_path[0].str, devname);
}
Commit	Line	Data
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>
f9d334bd	11	#include <dm/device.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 AG	17	#include <asm/global_data.h>
	18
	19	DECLARE_GLOBAL_DATA_PTR;
b9939336 AG	20
	21	/*
	22	* When booting using the "bootefi" command, we don't know which
	23	* physical device the file came from. So we create a pseudo-device
	24	* called "bootefi" with the device path /bootefi.
	25	*
	26	* In addition to the originating device we also declare the file path
	27	* of "bootefi" based loads to be /bootefi.
	28	*/
0f4060eb	29	static struct efi_device_path_file_path bootefi_image_path[] = {
b9939336 AG	30	{
	31	.dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
	32	.dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
0f4060eb	33	.dp.length = sizeof(bootefi_image_path[0]),
b9939336 AG	34	.str = { 'b','o','o','t','e','f','i' },
	35	}, {
	36	.dp.type = DEVICE_PATH_TYPE_END,
	37	.dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
0f4060eb	38	.dp.length = sizeof(bootefi_image_path[0]),
b9939336 AG	39	}
	40	};
	41
c07ad7c0 AG	42	static struct efi_device_path_file_path bootefi_device_path[] = {
	43	{
	44	.dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE,
	45	.dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH,
	46	.dp.length = sizeof(bootefi_image_path[0]),
	47	.str = { 'b','o','o','t','e','f','i' },
	48	}, {
	49	.dp.type = DEVICE_PATH_TYPE_END,
	50	.dp.sub_type = DEVICE_PATH_SUB_TYPE_END,
	51	.dp.length = sizeof(bootefi_image_path[0]),
	52	}
	53	};
	54
b9939336 AG	55	static efi_status_t bootefi_open_dp(void handle, efi_guid_t protocol,
	56	void *protocol_interface, void agent_handle,
	57	void *controller_handle, uint32_t attributes)
	58	{
c07ad7c0	59	*protocol_interface = bootefi_device_path;
b9939336 AG	60	return EFI_SUCCESS;
	61	}
	62
	63	/* The EFI loaded_image interface for the image executed via "bootefi" */
	64	static struct efi_loaded_image loaded_image_info = {
c07ad7c0	65	.device_handle = bootefi_device_path,
0f4060eb	66	.file_path = bootefi_image_path,
b9939336 AG	67	};
	68
	69	/* The EFI object struct for the image executed via "bootefi" */
	70	static struct efi_object loaded_image_info_obj = {
	71	.handle = &loaded_image_info,
	72	.protocols = {
	73	{
	74	/*
	75	* When asking for the loaded_image interface, just
	76	* return handle which points to loaded_image_info
	77	*/
	78	.guid = &efi_guid_loaded_image,
	79	.open = &efi_return_handle,
	80	},
	81	{
	82	/*
	83	* When asking for the device path interface, return
c07ad7c0	84	* bootefi_device_path
b9939336 AG	85	*/
	86	.guid = &efi_guid_device_path,
	87	.open = &bootefi_open_dp,
	88	},
	89	},
	90	};
	91
	92	/* The EFI object struct for the device the "bootefi" image was loaded from */
	93	static struct efi_object bootefi_device_obj = {
c07ad7c0	94	.handle = bootefi_device_path,
b9939336 AG	95	.protocols = {
	96	{
	97	/* When asking for the device path interface, return
c07ad7c0	98	* bootefi_device_path */
b9939336 AG	99	.guid = &efi_guid_device_path,
	100	.open = &bootefi_open_dp,
	101	}
	102	},
	103	};
	104
0d9d501f AG	105	static void copy_fdt(void fdt)
	106	{
	107	u64 fdt_size = fdt_totalsize(fdt);
ad0c1a3d AG	108	unsigned long fdt_ram_start = -1L, fdt_pages;
ad0c1a3d AG	109	u64 new_fdt_addr;
0d9d501f	110	void *new_fdt;
ad0c1a3d	111	int i;
0d9d501f	112
ad0c1a3d AG	113	for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
	114	u64 ram_start = gd->bd->bi_dram[i].start;
	115	u64 ram_size = gd->bd->bi_dram[i].size;
0d9d501f	116
ad0c1a3d AG	117	if (!ram_size)
	118	continue;
	119
	120	if (ram_start < fdt_ram_start)
	121	fdt_ram_start = ram_start;
	122	}
	123
	124	/* Give us at least 4kb breathing room */
	125	fdt_size = ALIGN(fdt_size + 4096, 4096);
	126	fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
	127
	128	/* Safe fdt location is at 128MB */
	129	new_fdt_addr = fdt_ram_start + (128 * 1024 * 1024) + fdt_size;
	130	if (efi_allocate_pages(1, EFI_BOOT_SERVICES_DATA, fdt_pages,
	131	&new_fdt_addr) != EFI_SUCCESS) {
	132	/* If we can't put it there, put it somewhere */
	133	new_fdt_addr = (ulong)memalign(4096, fdt_size);
	134	}
	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
b9939336 AG	142	/*
	143	* Load an EFI payload into a newly allocated piece of memory, register all
	144	* EFI objects it would want to access and jump to it.
	145	*/
1c39809b	146	static unsigned long do_bootefi_exec(void efi, void fdt)
b9939336 AG	147	{
	148	ulong (entry)(void image_handle, struct efi_system_table *st);
	149	ulong fdt_pages, fdt_size, fdt_start, fdt_end;
dea2174d	150	bootm_headers_t img = { 0 };
b9939336 AG	151
	152	/*
	153	* gd lives in a fixed register which may get clobbered while we execute
	154	* the payload. So save it here and restore it on every callback entry
	155	*/
	156	efi_save_gd();
	157
1c39809b	158	if (fdt && !fdt_check_header(fdt)) {
dea2174d	159	/* Prepare fdt for payload */
0d9d501f AG	160	fdt = copy_fdt(fdt);
	161
	162	if (image_setup_libfdt(&img, fdt, 0, NULL)) {
dea2174d AG	163	printf("ERROR: Failed to process device tree\n");
	164	return -EINVAL;
	165	}
	166
	167	/* Link to it in the efi tables */
b9939336	168	systab.tables[0].guid = EFI_FDT_GUID;
0d9d501f	169	systab.tables[0].table = fdt;
b9939336 AG	170	systab.nr_tables = 1;
	171
	172	/* And reserve the space in the memory map */
0d9d501f AG	173	fdt_start = ((ulong)fdt) & ~EFI_PAGE_MASK;
0d9d501f AG	174	fdt_end = ((ulong)fdt) + fdt_totalsize(fdt);
b9939336 AG	175	fdt_size = (fdt_end - fdt_start) + EFI_PAGE_MASK;
	176	fdt_pages = fdt_size >> EFI_PAGE_SHIFT;
	177	/* Give a bootloader the chance to modify the device tree */
	178	fdt_pages += 2;
	179	efi_add_memory_map(fdt_start, fdt_pages,
	180	EFI_BOOT_SERVICES_DATA, true);
b9939336	181	} else {
1c39809b	182	printf("WARNING: Invalid device tree, expect boot to fail\n");
b9939336 AG	183	systab.nr_tables = 0;
	184	}
	185
	186	/* Load the EFI payload */
	187	entry = efi_load_pe(efi, &loaded_image_info);
	188	if (!entry)
	189	return -ENOENT;
	190
	191	/* Initialize and populate EFI object list */
	192	INIT_LIST_HEAD(&efi_obj_list);
	193	list_add_tail(&loaded_image_info_obj.link, &efi_obj_list);
	194	list_add_tail(&bootefi_device_obj.link, &efi_obj_list);
	195	#ifdef CONFIG_PARTITIONS
	196	efi_disk_register();
	197	#endif
be8d3241 AG	198	#ifdef CONFIG_LCD
	199	efi_gop_register();
	200	#endif
0efe1bcf AG	201	#ifdef CONFIG_NET
	202	void *nethandle = loaded_image_info.device_handle;
	203	efi_net_register(&nethandle);
	204
	205	if (!memcmp(bootefi_device_path[0].str, "N\0e\0t", 6))
	206	loaded_image_info.device_handle = nethandle;
	207	#endif
b9939336 AG	208
b9939336 AG	209	/* Call our payload! */
edcef3ba	210	debug("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
a86aeaf2 AG	211
	212	if (setjmp(&loaded_image_info.exit_jmp)) {
	213	efi_status_t status = loaded_image_info.exit_status;
	214	return status == EFI_SUCCESS ? 0 : -EINVAL;
	215	}
	216
b9939336 AG	217	return entry(&loaded_image_info, &systab);
	218	}
	219
	220
	221	/* Interpreter command to boot an arbitrary EFI image from memory */
	222	static int do_bootefi(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
	223	{
1c39809b AG	224	char saddr, sfdt;
1c39809b AG	225	unsigned long addr, fdt_addr = 0;
b9939336 AG	226	int r = 0;
	227
	228	if (argc < 2)
	229	return 1;
	230	saddr = argv[1];
	231
	232	addr = simple_strtoul(saddr, NULL, 16);
	233
1c39809b AG	234	if (argc > 2) {
	235	sfdt = argv[2];
	236	fdt_addr = simple_strtoul(sfdt, NULL, 16);
	237	}
	238
b9939336	239	printf("## Starting EFI application at 0x%08lx ...\n", addr);
1c39809b	240	r = do_bootefi_exec((void )addr, (void)fdt_addr);
b9939336 AG	241	printf("## Application terminated, r = %d\n", r);
	242
	243	if (r != 0)
	244	r = 1;
	245
	246	return r;
	247	}
	248
	249	#ifdef CONFIG_SYS_LONGHELP
	250	static char bootefi_help_text[] =
1c39809b AG	251	"<image address> [fdt address]\n"
	252	" - boot EFI payload stored at address <image address>.\n"
	253	" If specified, the device tree located at <fdt address> gets\n"
	254	" exposed as EFI configuration table.\n";
b9939336 AG	255	#endif
	256
	257	U_BOOT_CMD(
1c39809b	258	bootefi, 3, 0, do_bootefi,
92dfd922	259	"Boots an EFI payload from memory",
b9939336 AG	260	bootefi_help_text
b9939336 AG	261	);
0f4060eb	262
c07ad7c0	263	void efi_set_bootdev(const char dev, const char devnr, const char *path)
0f4060eb	264	{
8c3df0bf	265	__maybe_unused struct blk_desc *desc;
ecbe1a07	266	char devname[32] = { 0 }; /* dp->str is u16[32] long */
0f4060eb AG	267	char *colon;
0f4060eb AG	268
f9d334bd AG	269	#if defined(CONFIG_BLK) \|\| defined(CONFIG_ISO_PARTITION)
	270	desc = blk_get_dev(dev, simple_strtol(devnr, NULL, 10));
	271	#endif
	272
	273	#ifdef CONFIG_BLK
	274	if (desc) {
	275	snprintf(devname, sizeof(devname), "%s", desc->bdev->name);
	276	} else
	277	#endif
	278
	279	{
	280	/* Assemble the condensed device name we use in efi_disk.c */
	281	snprintf(devname, sizeof(devname), "%s%s", dev, devnr);
	282	}
	283
0f4060eb	284	colon = strchr(devname, ':');
8c3df0bf AG	285
	286	#ifdef CONFIG_ISO_PARTITION
	287	/* For ISOs we create partition block devices */
8c3df0bf AG	288	if (desc && (desc->type != DEV_TYPE_UNKNOWN) &&
	289	(desc->part_type == PART_TYPE_ISO)) {
	290	if (!colon)
f9d334bd AG	291	snprintf(devname, sizeof(devname), "%s:1", devname);
f9d334bd AG	292
8c3df0bf AG	293	colon = NULL;
	294	}
	295	#endif
	296
0f4060eb AG	297	if (colon)
	298	*colon = '\0';
	299
c07ad7c0 AG	300	/* Patch bootefi_device_path to the target device */
	301	memset(bootefi_device_path[0].str, 0, sizeof(bootefi_device_path[0].str));
	302	ascii2unicode(bootefi_device_path[0].str, devname);
	303
	304	/* Patch bootefi_image_path to the target file path */
0f4060eb	305	memset(bootefi_image_path[0].str, 0, sizeof(bootefi_image_path[0].str));
49271666 AG	306	if (strcmp(dev, "Net")) {
	307	/* Add leading / to fs paths, because they're absolute */
	308	snprintf(devname, sizeof(devname), "/%s", path);
	309	} else {
	310	snprintf(devname, sizeof(devname), "%s", path);
	311	}
0f4060eb AG	312	ascii2unicode(bootefi_image_path[0].str, devname);
0f4060eb AG	313	}