[J-u-boot.git] / lib / efi_loader / efi_image_loader.c

/*
 *  EFI image loader
 *
 *  based partly on wine code
 *
 *  Copyright (c) 2016 Alexander Graf
 *
 *  SPDX-License-Identifier:     GPL-2.0+
 */

#include <common.h>
#include <efi_loader.h>
#include <pe.h>
#include <asm/global_data.h>

DECLARE_GLOBAL_DATA_PTR;

const efi_guid_t efi_global_variable_guid = EFI_GLOBAL_VARIABLE_GUID;
const efi_guid_t efi_guid_device_path = DEVICE_PATH_GUID;
const efi_guid_t efi_guid_loaded_image = LOADED_IMAGE_GUID;
const efi_guid_t efi_simple_file_system_protocol_guid =
		EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID;
const efi_guid_t efi_file_info_guid = EFI_FILE_INFO_GUID;

static efi_status_t efi_loader_relocate(const IMAGE_BASE_RELOCATION *rel,
			unsigned long rel_size, void *efi_reloc)
{
	const IMAGE_BASE_RELOCATION *end;
	int i;

	end = (const IMAGE_BASE_RELOCATION *)((const char *)rel + rel_size);
	while (rel < end - 1 && rel->SizeOfBlock) {
		const uint16_t *relocs = (const uint16_t *)(rel + 1);
		i = (rel->SizeOfBlock - sizeof(*rel)) / sizeof(uint16_t);
		while (i--) {
			uint32_t offset = (uint32_t)(*relocs & 0xfff) +
					  rel->VirtualAddress;
			int type = *relocs >> EFI_PAGE_SHIFT;
			unsigned long delta = (unsigned long)efi_reloc;
			uint64_t *x64 = efi_reloc + offset;
			uint32_t *x32 = efi_reloc + offset;
			uint16_t *x16 = efi_reloc + offset;

			switch (type) {
			case IMAGE_REL_BASED_ABSOLUTE:
				break;
			case IMAGE_REL_BASED_HIGH:
				*x16 += ((uint32_t)delta) >> 16;
				break;
			case IMAGE_REL_BASED_LOW:
				*x16 += (uint16_t)delta;
				break;
			case IMAGE_REL_BASED_HIGHLOW:
				*x32 += (uint32_t)delta;
				break;
			case IMAGE_REL_BASED_DIR64:
				*x64 += (uint64_t)delta;
				break;
			default:
				printf("Unknown Relocation off %x type %x\n",
				       offset, type);
				return EFI_LOAD_ERROR;
			}
			relocs++;
		}
		rel = (const IMAGE_BASE_RELOCATION *)relocs;
	}
	return EFI_SUCCESS;
}

void __weak invalidate_icache_all(void)
{
	/* If the system doesn't support icache_all flush, cross our fingers */
}

/*
 * Determine the memory types to be used for code and data.
 *
 * @loaded_image_info	image descriptor
 * @image_type		field Subsystem of the optional header for
 *			Windows specific field
 */
static void efi_set_code_and_data_type(
			struct efi_loaded_image *loaded_image_info,
			uint16_t image_type)
{
	switch (image_type) {
	case IMAGE_SUBSYSTEM_EFI_APPLICATION:
		loaded_image_info->image_code_type = EFI_LOADER_CODE;
		loaded_image_info->image_data_type = EFI_LOADER_DATA;
		break;
	case IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER:
		loaded_image_info->image_code_type = EFI_BOOT_SERVICES_CODE;
		loaded_image_info->image_data_type = EFI_BOOT_SERVICES_DATA;
		break;
	case IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER:
	case IMAGE_SUBSYSTEM_EFI_ROM:
		loaded_image_info->image_code_type = EFI_RUNTIME_SERVICES_CODE;
		loaded_image_info->image_data_type = EFI_RUNTIME_SERVICES_DATA;
		break;
	default:
		printf("%s: invalid image type: %u\n", __func__, image_type);
		/* Let's assume it is an application */
		loaded_image_info->image_code_type = EFI_LOADER_CODE;
		loaded_image_info->image_data_type = EFI_LOADER_DATA;
		break;
	}
}

/*
 * This function loads all sections from a PE binary into a newly reserved
 * piece of memory. On successful load it then returns the entry point for
 * the binary. Otherwise NULL.
 */
void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info)
{
	IMAGE_NT_HEADERS32 *nt;
	IMAGE_DOS_HEADER *dos;
	IMAGE_SECTION_HEADER *sections;
	int num_sections;
	void *efi_reloc;
	int i;
	const IMAGE_BASE_RELOCATION *rel;
	unsigned long rel_size;
	int rel_idx = IMAGE_DIRECTORY_ENTRY_BASERELOC;
	void *entry;
	uint64_t image_size;
	unsigned long virt_size = 0;
	bool can_run_nt64 = true;
	bool can_run_nt32 = true;

#if defined(CONFIG_ARM64)
	can_run_nt32 = false;
#elif defined(CONFIG_ARM)
	can_run_nt64 = false;
#endif

	dos = efi;
	if (dos->e_magic != IMAGE_DOS_SIGNATURE) {
		printf("%s: Invalid DOS Signature\n", __func__);
		return NULL;
	}

	nt = (void *) ((char *)efi + dos->e_lfanew);
	if (nt->Signature != IMAGE_NT_SIGNATURE) {
		printf("%s: Invalid NT Signature\n", __func__);
		return NULL;
	}

	/* Calculate upper virtual address boundary */
	num_sections = nt->FileHeader.NumberOfSections;
	sections = (void *)&nt->OptionalHeader +
			    nt->FileHeader.SizeOfOptionalHeader;

	for (i = num_sections - 1; i >= 0; i--) {
		IMAGE_SECTION_HEADER *sec = &sections[i];
		virt_size = max_t(unsigned long, virt_size,
				  sec->VirtualAddress + sec->Misc.VirtualSize);
	}

	/* Read 32/64bit specific header bits */
	if (can_run_nt64 &&
	    (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC)) {
		IMAGE_NT_HEADERS64 *nt64 = (void *)nt;
		IMAGE_OPTIONAL_HEADER64 *opt = &nt64->OptionalHeader;
		image_size = opt->SizeOfImage;
		efi_set_code_and_data_type(loaded_image_info, opt->Subsystem);
		efi_reloc = efi_alloc(virt_size,
				      loaded_image_info->image_code_type);
		if (!efi_reloc) {
			printf("%s: Could not allocate %lu bytes\n",
			       __func__, virt_size);
			return NULL;
		}
		entry = efi_reloc + opt->AddressOfEntryPoint;
		rel_size = opt->DataDirectory[rel_idx].Size;
		rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
		virt_size = ALIGN(virt_size, opt->SectionAlignment);
	} else if (can_run_nt32 &&
		   (nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)) {
		IMAGE_OPTIONAL_HEADER32 *opt = &nt->OptionalHeader;
		image_size = opt->SizeOfImage;
		efi_set_code_and_data_type(loaded_image_info, opt->Subsystem);
		efi_reloc = efi_alloc(virt_size,
				      loaded_image_info->image_code_type);
		if (!efi_reloc) {
			printf("%s: Could not allocate %lu bytes\n",
			       __func__, virt_size);
			return NULL;
		}
		entry = efi_reloc + opt->AddressOfEntryPoint;
		rel_size = opt->DataDirectory[rel_idx].Size;
		rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
		virt_size = ALIGN(virt_size, opt->SectionAlignment);
	} else {
		printf("%s: Invalid optional header magic %x\n", __func__,
		       nt->OptionalHeader.Magic);
		return NULL;
	}

	/* Load sections into RAM */
	for (i = num_sections - 1; i >= 0; i--) {
		IMAGE_SECTION_HEADER *sec = &sections[i];
		memset(efi_reloc + sec->VirtualAddress, 0,
		       sec->Misc.VirtualSize);
		memcpy(efi_reloc + sec->VirtualAddress,
		       efi + sec->PointerToRawData,
		       sec->SizeOfRawData);
	}

	/* Run through relocations */
	if (efi_loader_relocate(rel, rel_size, efi_reloc) != EFI_SUCCESS) {
		efi_free_pages((uintptr_t) efi_reloc,
			       (virt_size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT);
		return NULL;
	}

	/* Flush cache */
	flush_cache((ulong)efi_reloc,
		    ALIGN(virt_size, CONFIG_SYS_CACHELINE_SIZE));
	invalidate_icache_all();

	/* Populate the loaded image interface bits */
	loaded_image_info->image_base = efi;
	loaded_image_info->image_size = image_size;
	loaded_image_info->reloc_base = efi_reloc;
	loaded_image_info->reloc_size = virt_size;

	return entry;
}
Commit	Line	Data
cb149c66 AG	1	/*
	2	* EFI image loader
	3	*
	4	* based partly on wine code
	5	*
	6	* Copyright (c) 2016 Alexander Graf
	7	*
	8	* SPDX-License-Identifier: GPL-2.0+
	9	*/
	10
	11	#include <common.h>
	12	#include <efi_loader.h>
	13	#include <pe.h>
	14	#include <asm/global_data.h>
	15
	16	DECLARE_GLOBAL_DATA_PTR;
	17
9975fe96	18	const efi_guid_t efi_global_variable_guid = EFI_GLOBAL_VARIABLE_GUID;
cb149c66 AG	19	const efi_guid_t efi_guid_device_path = DEVICE_PATH_GUID;
cb149c66 AG	20	const efi_guid_t efi_guid_loaded_image = LOADED_IMAGE_GUID;
2a92080d RC	21	const efi_guid_t efi_simple_file_system_protocol_guid =
	22	EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID;
	23	const efi_guid_t efi_file_info_guid = EFI_FILE_INFO_GUID;
cb149c66	24
da684a64	25	static efi_status_t efi_loader_relocate(const IMAGE_BASE_RELOCATION *rel,
cb149c66 AG	26	unsigned long rel_size, void *efi_reloc)
	27	{
	28	const IMAGE_BASE_RELOCATION *end;
	29	int i;
	30
	31	end = (const IMAGE_BASE_RELOCATION )((const char )rel + rel_size);
	32	while (rel < end - 1 && rel->SizeOfBlock) {
	33	const uint16_t relocs = (const uint16_t )(rel + 1);
	34	i = (rel->SizeOfBlock - sizeof(*rel)) / sizeof(uint16_t);
	35	while (i--) {
b1237c6e	36	uint32_t offset = (uint32_t)(*relocs & 0xfff) +
cb149c66 AG	37	rel->VirtualAddress;
	38	int type = *relocs >> EFI_PAGE_SHIFT;
	39	unsigned long delta = (unsigned long)efi_reloc;
	40	uint64_t *x64 = efi_reloc + offset;
	41	uint32_t *x32 = efi_reloc + offset;
	42	uint16_t *x16 = efi_reloc + offset;
	43
	44	switch (type) {
	45	case IMAGE_REL_BASED_ABSOLUTE:
	46	break;
	47	case IMAGE_REL_BASED_HIGH:
	48	*x16 += ((uint32_t)delta) >> 16;
	49	break;
	50	case IMAGE_REL_BASED_LOW:
	51	*x16 += (uint16_t)delta;
	52	break;
	53	case IMAGE_REL_BASED_HIGHLOW:
	54	*x32 += (uint32_t)delta;
	55	break;
	56	case IMAGE_REL_BASED_DIR64:
	57	*x64 += (uint64_t)delta;
	58	break;
	59	default:
	60	printf("Unknown Relocation off %x type %x\n",
	61	offset, type);
da684a64	62	return EFI_LOAD_ERROR;
cb149c66 AG	63	}
	64	relocs++;
	65	}
	66	rel = (const IMAGE_BASE_RELOCATION *)relocs;
	67	}
da684a64	68	return EFI_SUCCESS;
cb149c66 AG	69	}
	70
	71	void __weak invalidate_icache_all(void)
	72	{
	73	/* If the system doesn't support icache_all flush, cross our fingers */
	74	}
	75
36b41a3c HS	76	/*
	77	* Determine the memory types to be used for code and data.
	78	*
	79	* @loaded_image_info image descriptor
	80	* @image_type field Subsystem of the optional header for
	81	* Windows specific field
	82	*/
	83	static void efi_set_code_and_data_type(
	84	struct efi_loaded_image *loaded_image_info,
	85	uint16_t image_type)
	86	{
	87	switch (image_type) {
	88	case IMAGE_SUBSYSTEM_EFI_APPLICATION:
	89	loaded_image_info->image_code_type = EFI_LOADER_CODE;
	90	loaded_image_info->image_data_type = EFI_LOADER_DATA;
	91	break;
	92	case IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER:
	93	loaded_image_info->image_code_type = EFI_BOOT_SERVICES_CODE;
	94	loaded_image_info->image_data_type = EFI_BOOT_SERVICES_DATA;
	95	break;
	96	case IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER:
268ec6e0	97	case IMAGE_SUBSYSTEM_EFI_ROM:
36b41a3c HS	98	loaded_image_info->image_code_type = EFI_RUNTIME_SERVICES_CODE;
	99	loaded_image_info->image_data_type = EFI_RUNTIME_SERVICES_DATA;
	100	break;
	101	default:
	102	printf("%s: invalid image type: %u\n", __func__, image_type);
	103	/* Let's assume it is an application */
	104	loaded_image_info->image_code_type = EFI_LOADER_CODE;
	105	loaded_image_info->image_data_type = EFI_LOADER_DATA;
	106	break;
	107	}
	108	}
	109
cb149c66 AG	110	/*
	111	* This function loads all sections from a PE binary into a newly reserved
	112	* piece of memory. On successful load it then returns the entry point for
	113	* the binary. Otherwise NULL.
	114	*/
	115	void efi_load_pe(void efi, struct efi_loaded_image *loaded_image_info)
	116	{
	117	IMAGE_NT_HEADERS32 *nt;
	118	IMAGE_DOS_HEADER *dos;
	119	IMAGE_SECTION_HEADER *sections;
	120	int num_sections;
	121	void *efi_reloc;
	122	int i;
	123	const IMAGE_BASE_RELOCATION *rel;
	124	unsigned long rel_size;
	125	int rel_idx = IMAGE_DIRECTORY_ENTRY_BASERELOC;
	126	void *entry;
	127	uint64_t image_size;
	128	unsigned long virt_size = 0;
	129	bool can_run_nt64 = true;
	130	bool can_run_nt32 = true;
	131
	132	#if defined(CONFIG_ARM64)
	133	can_run_nt32 = false;
	134	#elif defined(CONFIG_ARM)
	135	can_run_nt64 = false;
	136	#endif
	137
	138	dos = efi;
	139	if (dos->e_magic != IMAGE_DOS_SIGNATURE) {
	140	printf("%s: Invalid DOS Signature\n", __func__);
	141	return NULL;
	142	}
	143
	144	nt = (void ) ((char )efi + dos->e_lfanew);
	145	if (nt->Signature != IMAGE_NT_SIGNATURE) {
	146	printf("%s: Invalid NT Signature\n", __func__);
	147	return NULL;
	148	}
	149
	150	/* Calculate upper virtual address boundary */
	151	num_sections = nt->FileHeader.NumberOfSections;
	152	sections = (void *)&nt->OptionalHeader +
	153	nt->FileHeader.SizeOfOptionalHeader;
	154
	155	for (i = num_sections - 1; i >= 0; i--) {
	156	IMAGE_SECTION_HEADER *sec = &sections[i];
	157	virt_size = max_t(unsigned long, virt_size,
	158	sec->VirtualAddress + sec->Misc.VirtualSize);
	159	}
	160
	161	/* Read 32/64bit specific header bits */
	162	if (can_run_nt64 &&
	163	(nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR64_MAGIC)) {
	164	IMAGE_NT_HEADERS64 nt64 = (void )nt;
	165	IMAGE_OPTIONAL_HEADER64 *opt = &nt64->OptionalHeader;
	166	image_size = opt->SizeOfImage;
36b41a3c HS	167	efi_set_code_and_data_type(loaded_image_info, opt->Subsystem);
	168	efi_reloc = efi_alloc(virt_size,
	169	loaded_image_info->image_code_type);
cb149c66	170	if (!efi_reloc) {
e540c486 HS	171	printf("%s: Could not allocate %lu bytes\n",
e540c486 HS	172	__func__, virt_size);
cb149c66 AG	173	return NULL;
	174	}
	175	entry = efi_reloc + opt->AddressOfEntryPoint;
	176	rel_size = opt->DataDirectory[rel_idx].Size;
	177	rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
82786754	178	virt_size = ALIGN(virt_size, opt->SectionAlignment);
cb149c66 AG	179	} else if (can_run_nt32 &&
	180	(nt->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)) {
	181	IMAGE_OPTIONAL_HEADER32 *opt = &nt->OptionalHeader;
	182	image_size = opt->SizeOfImage;
36b41a3c HS	183	efi_set_code_and_data_type(loaded_image_info, opt->Subsystem);
	184	efi_reloc = efi_alloc(virt_size,
	185	loaded_image_info->image_code_type);
cb149c66	186	if (!efi_reloc) {
e540c486 HS	187	printf("%s: Could not allocate %lu bytes\n",
e540c486 HS	188	__func__, virt_size);
cb149c66 AG	189	return NULL;
	190	}
	191	entry = efi_reloc + opt->AddressOfEntryPoint;
	192	rel_size = opt->DataDirectory[rel_idx].Size;
	193	rel = efi_reloc + opt->DataDirectory[rel_idx].VirtualAddress;
82786754	194	virt_size = ALIGN(virt_size, opt->SectionAlignment);
cb149c66 AG	195	} else {
	196	printf("%s: Invalid optional header magic %x\n", __func__,
	197	nt->OptionalHeader.Magic);
	198	return NULL;
	199	}
	200
	201	/* Load sections into RAM */
	202	for (i = num_sections - 1; i >= 0; i--) {
	203	IMAGE_SECTION_HEADER *sec = &sections[i];
	204	memset(efi_reloc + sec->VirtualAddress, 0,
	205	sec->Misc.VirtualSize);
	206	memcpy(efi_reloc + sec->VirtualAddress,
	207	efi + sec->PointerToRawData,
	208	sec->SizeOfRawData);
	209	}
	210
	211	/* Run through relocations */
da684a64 HS	212	if (efi_loader_relocate(rel, rel_size, efi_reloc) != EFI_SUCCESS) {
	213	efi_free_pages((uintptr_t) efi_reloc,
	214	(virt_size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT);
	215	return NULL;
	216	}
cb149c66 AG	217
cb149c66 AG	218	/* Flush cache */
d0d90993 SG	219	flush_cache((ulong)efi_reloc,
d0d90993 SG	220	ALIGN(virt_size, CONFIG_SYS_CACHELINE_SIZE));
cb149c66 AG	221	invalidate_icache_all();
	222
	223	/* Populate the loaded image interface bits */
	224	loaded_image_info->image_base = efi;
	225	loaded_image_info->image_size = image_size;
84b40b40 HS	226	loaded_image_info->reloc_base = efi_reloc;
84b40b40 HS	227	loaded_image_info->reloc_size = virt_size;
cb149c66 AG	228
	229	return entry;
	230	}