[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 <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

	/* Call our payload! */
#ifdef DEBUG_EFI
	printf("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry);
#endif
	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\n",
	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;

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