[u-boot.git] / lib / efi_loader / efi_memory.c

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

#include <common.h>
#include <efi_loader.h>
#include <malloc.h>
#include <mapmem.h>
#include <watchdog.h>
#include <linux/list_sort.h>

DECLARE_GLOBAL_DATA_PTR;

efi_uintn_t efi_memory_map_key;

struct efi_mem_list {
	struct list_head link;
	struct efi_mem_desc desc;
};

#define EFI_CARVE_NO_OVERLAP		-1
#define EFI_CARVE_LOOP_AGAIN		-2
#define EFI_CARVE_OVERLAPS_NONRAM	-3

/* This list contains all memory map items */
LIST_HEAD(efi_mem);

#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
void *efi_bounce_buffer;
#endif

/*
 * U-Boot services each EFI AllocatePool request as a separate
 * (multiple) page allocation.  We have to track the number of pages
 * to be able to free the correct amount later.
 * EFI requires 8 byte alignment for pool allocations, so we can
 * prepend each allocation with an 64 bit header tracking the
 * allocation size, and hand out the remainder to the caller.
 */
struct efi_pool_allocation {
	u64 num_pages;
	char data[] __aligned(ARCH_DMA_MINALIGN);
};

/*
 * Sorts the memory list from highest address to lowest address
 *
 * When allocating memory we should always start from the highest
 * address chunk, so sort the memory list such that the first list
 * iterator gets the highest address and goes lower from there.
 */
static int efi_mem_cmp(void *priv, struct list_head *a, struct list_head *b)
{
	struct efi_mem_list *mema = list_entry(a, struct efi_mem_list, link);
	struct efi_mem_list *memb = list_entry(b, struct efi_mem_list, link);

	if (mema->desc.physical_start == memb->desc.physical_start)
		return 0;
	else if (mema->desc.physical_start < memb->desc.physical_start)
		return 1;
	else
		return -1;
}

static void efi_mem_sort(void)
{
	list_sort(NULL, &efi_mem, efi_mem_cmp);
}

/** efi_mem_carve_out - unmap memory region
 *
 * @map:		memory map
 * @carve_desc:		memory region to unmap
 * @overlap_only_ram:	the carved out region may only overlap RAM
 * Return Value:	the number of overlapping pages which have been
 *			removed from the map,
 *			EFI_CARVE_NO_OVERLAP, if the regions don't overlap,
 *			EFI_CARVE_OVERLAPS_NONRAM, if the carve and map overlap,
 *			and the map contains anything but free ram
 *			(only when overlap_only_ram is true),
 *			EFI_CARVE_LOOP_AGAIN, if the mapping list should be
 *			traversed again, as it has been altered.
 *
 * Unmaps all memory occupied by the carve_desc region from the list entry
 * pointed to by map.
 *
 * In case of EFI_CARVE_OVERLAPS_NONRAM it is the callers responsibility
 * to re-add the already carved out pages to the mapping.
 */
static s64 efi_mem_carve_out(struct efi_mem_list *map,
			     struct efi_mem_desc *carve_desc,
			     bool overlap_only_ram)
{
	struct efi_mem_list *newmap;
	struct efi_mem_desc *map_desc = &map->desc;
	uint64_t map_start = map_desc->physical_start;
	uint64_t map_end = map_start + (map_desc->num_pages << EFI_PAGE_SHIFT);
	uint64_t carve_start = carve_desc->physical_start;
	uint64_t carve_end = carve_start +
			     (carve_desc->num_pages << EFI_PAGE_SHIFT);

	/* check whether we're overlapping */
	if ((carve_end <= map_start) || (carve_start >= map_end))
		return EFI_CARVE_NO_OVERLAP;

	/* We're overlapping with non-RAM, warn the caller if desired */
	if (overlap_only_ram && (map_desc->type != EFI_CONVENTIONAL_MEMORY))
		return EFI_CARVE_OVERLAPS_NONRAM;

	/* Sanitize carve_start and carve_end to lie within our bounds */
	carve_start = max(carve_start, map_start);
	carve_end = min(carve_end, map_end);

	/* Carving at the beginning of our map? Just move it! */
	if (carve_start == map_start) {
		if (map_end == carve_end) {
			/* Full overlap, just remove map */
			list_del(&map->link);
			free(map);
		} else {
			map->desc.physical_start = carve_end;
			map->desc.num_pages = (map_end - carve_end)
					      >> EFI_PAGE_SHIFT;
		}

		return (carve_end - carve_start) >> EFI_PAGE_SHIFT;
	}

	/*
	 * Overlapping maps, just split the list map at carve_start,
	 * it will get moved or removed in the next iteration.
	 *
	 * [ map_desc |__carve_start__| newmap ]
	 */

	/* Create a new map from [ carve_start ... map_end ] */
	newmap = calloc(1, sizeof(*newmap));
	newmap->desc = map->desc;
	newmap->desc.physical_start = carve_start;
	newmap->desc.num_pages = (map_end - carve_start) >> EFI_PAGE_SHIFT;
	/* Insert before current entry (descending address order) */
	list_add_tail(&newmap->link, &map->link);

	/* Shrink the map to [ map_start ... carve_start ] */
	map_desc->num_pages = (carve_start - map_start) >> EFI_PAGE_SHIFT;

	return EFI_CARVE_LOOP_AGAIN;
}

uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
			    bool overlap_only_ram)
{
	struct list_head *lhandle;
	struct efi_mem_list *newlist;
	bool carve_again;
	uint64_t carved_pages = 0;

	debug("%s: 0x%llx 0x%llx %d %s\n", __func__,
	      start, pages, memory_type, overlap_only_ram ? "yes" : "no");

	if (memory_type >= EFI_MAX_MEMORY_TYPE)
		return EFI_INVALID_PARAMETER;

	if (!pages)
		return start;

	++efi_memory_map_key;
	newlist = calloc(1, sizeof(*newlist));
	newlist->desc.type = memory_type;
	newlist->desc.physical_start = start;
	newlist->desc.virtual_start = start;
	newlist->desc.num_pages = pages;

	switch (memory_type) {
	case EFI_RUNTIME_SERVICES_CODE:
	case EFI_RUNTIME_SERVICES_DATA:
		newlist->desc.attribute = EFI_MEMORY_WB | EFI_MEMORY_RUNTIME;
		break;
	case EFI_MMAP_IO:
		newlist->desc.attribute = EFI_MEMORY_RUNTIME;
		break;
	default:
		newlist->desc.attribute = EFI_MEMORY_WB;
		break;
	}

	/* Add our new map */
	do {
		carve_again = false;
		list_for_each(lhandle, &efi_mem) {
			struct efi_mem_list *lmem;
			s64 r;

			lmem = list_entry(lhandle, struct efi_mem_list, link);
			r = efi_mem_carve_out(lmem, &newlist->desc,
					      overlap_only_ram);
			switch (r) {
			case EFI_CARVE_OVERLAPS_NONRAM:
				/*
				 * The user requested to only have RAM overlaps,
				 * but we hit a non-RAM region. Error out.
				 */
				return 0;
			case EFI_CARVE_NO_OVERLAP:
				/* Just ignore this list entry */
				break;
			case EFI_CARVE_LOOP_AGAIN:
				/*
				 * We split an entry, but need to loop through
				 * the list again to actually carve it.
				 */
				carve_again = true;
				break;
			default:
				/* We carved a number of pages */
				carved_pages += r;
				carve_again = true;
				break;
			}

			if (carve_again) {
				/* The list changed, we need to start over */
				break;
			}
		}
	} while (carve_again);

	if (overlap_only_ram && (carved_pages != pages)) {
		/*
		 * The payload wanted to have RAM overlaps, but we overlapped
		 * with an unallocated region. Error out.
		 */
		return 0;
	}

	/* Add our new map */
        list_add_tail(&newlist->link, &efi_mem);

	/* And make sure memory is listed in descending order */
	efi_mem_sort();

	return start;
}

static uint64_t efi_find_free_memory(uint64_t len, uint64_t max_addr)
{
	struct list_head *lhandle;

	list_for_each(lhandle, &efi_mem) {
		struct efi_mem_list *lmem = list_entry(lhandle,
			struct efi_mem_list, link);
		struct efi_mem_desc *desc = &lmem->desc;
		uint64_t desc_len = desc->num_pages << EFI_PAGE_SHIFT;
		uint64_t desc_end = desc->physical_start + desc_len;
		uint64_t curmax = min(max_addr, desc_end);
		uint64_t ret = curmax - len;

		/* We only take memory from free RAM */
		if (desc->type != EFI_CONVENTIONAL_MEMORY)
			continue;

		/* Out of bounds for max_addr */
		if ((ret + len) > max_addr)
			continue;

		/* Out of bounds for upper map limit */
		if ((ret + len) > desc_end)
			continue;

		/* Out of bounds for lower map limit */
		if (ret < desc->physical_start)
			continue;

		/* Return the highest address in this map within bounds */
		return ret;
	}

	return 0;
}

/*
 * Allocate memory pages.
 *
 * @type		type of allocation to be performed
 * @memory_type		usage type of the allocated memory
 * @pages		number of pages to be allocated
 * @memory		allocated memory
 * @return		status code
 */
efi_status_t efi_allocate_pages(int type, int memory_type,
				efi_uintn_t pages, uint64_t *memory)
{
	u64 len = pages << EFI_PAGE_SHIFT;
	efi_status_t r = EFI_SUCCESS;
	uint64_t addr;

	if (!memory)
		return EFI_INVALID_PARAMETER;

	switch (type) {
	case EFI_ALLOCATE_ANY_PAGES:
		/* Any page */
		addr = efi_find_free_memory(len, -1ULL);
		if (!addr) {
			r = EFI_NOT_FOUND;
			break;
		}
		break;
	case EFI_ALLOCATE_MAX_ADDRESS:
		/* Max address */
		addr = efi_find_free_memory(len, *memory);
		if (!addr) {
			r = EFI_NOT_FOUND;
			break;
		}
		break;
	case EFI_ALLOCATE_ADDRESS:
		/* Exact address, reserve it. The addr is already in *memory. */
		addr = *memory;
		break;
	default:
		/* UEFI doesn't specify other allocation types */
		r = EFI_INVALID_PARAMETER;
		break;
	}

	if (r == EFI_SUCCESS) {
		uint64_t ret;

		/* Reserve that map in our memory maps */
		ret = efi_add_memory_map(addr, pages, memory_type, true);
		if (ret == addr) {
			*memory = (uintptr_t)map_sysmem(addr, len);
		} else {
			/* Map would overlap, bail out */
			r = EFI_OUT_OF_RESOURCES;
		}
	}

	return r;
}

void *efi_alloc(uint64_t len, int memory_type)
{
	uint64_t ret = 0;
	uint64_t pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
	efi_status_t r;

	r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, memory_type, pages,
			       &ret);
	if (r == EFI_SUCCESS)
		return (void*)(uintptr_t)ret;

	return NULL;
}

/*
 * Free memory pages.
 *
 * @memory	start of the memory area to be freed
 * @pages	number of pages to be freed
 * @return	status code
 */
efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages)
{
	uint64_t r = 0;
	uint64_t addr = map_to_sysmem((void *)(uintptr_t)memory);

	r = efi_add_memory_map(addr, pages, EFI_CONVENTIONAL_MEMORY, false);
	/* Merging of adjacent free regions is missing */

	if (r == addr)
		return EFI_SUCCESS;

	return EFI_NOT_FOUND;
}

/*
 * Allocate memory from pool.
 *
 * @pool_type	type of the pool from which memory is to be allocated
 * @size	number of bytes to be allocated
 * @buffer	allocated memory
 * @return	status code
 */
efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size, void **buffer)
{
	efi_status_t r;
	struct efi_pool_allocation *alloc;
	u64 num_pages = (size + sizeof(struct efi_pool_allocation) +
			 EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;

	if (!buffer)
		return EFI_INVALID_PARAMETER;

	if (size == 0) {
		*buffer = NULL;
		return EFI_SUCCESS;
	}

	r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, pool_type, num_pages,
			       (uint64_t *)&alloc);

	if (r == EFI_SUCCESS) {
		alloc->num_pages = num_pages;
		*buffer = alloc->data;
	}

	return r;
}

/*
 * Free memory from pool.
 *
 * @buffer	start of memory to be freed
 * @return	status code
 */
efi_status_t efi_free_pool(void *buffer)
{
	efi_status_t r;
	struct efi_pool_allocation *alloc;

	if (buffer == NULL)
		return EFI_INVALID_PARAMETER;

	alloc = container_of(buffer, struct efi_pool_allocation, data);
	/* Sanity check, was the supplied address returned by allocate_pool */
	assert(((uintptr_t)alloc & EFI_PAGE_MASK) == 0);

	r = efi_free_pages((uintptr_t)alloc, alloc->num_pages);

	return r;
}

/*
 * Get map describing memory usage.
 *
 * @memory_map_size	on entry the size, in bytes, of the memory map buffer,
 *			on exit the size of the copied memory map
 * @memory_map		buffer to which the memory map is written
 * @map_key		key for the memory map
 * @descriptor_size	size of an individual memory descriptor
 * @descriptor_version	version number of the memory descriptor structure
 * @return		status code
 */
efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
				struct efi_mem_desc *memory_map,
				efi_uintn_t *map_key,
				efi_uintn_t *descriptor_size,
				uint32_t *descriptor_version)
{
	efi_uintn_t map_size = 0;
	int map_entries = 0;
	struct list_head *lhandle;
	efi_uintn_t provided_map_size;

	if (!memory_map_size)
		return EFI_INVALID_PARAMETER;

	provided_map_size = *memory_map_size;

	list_for_each(lhandle, &efi_mem)
		map_entries++;

	map_size = map_entries * sizeof(struct efi_mem_desc);

	*memory_map_size = map_size;

	if (provided_map_size < map_size)
		return EFI_BUFFER_TOO_SMALL;

	if (!memory_map)
		return EFI_INVALID_PARAMETER;

	if (descriptor_size)
		*descriptor_size = sizeof(struct efi_mem_desc);

	if (descriptor_version)
		*descriptor_version = EFI_MEMORY_DESCRIPTOR_VERSION;

	/* Copy list into array */
	/* Return the list in ascending order */
	memory_map = &memory_map[map_entries - 1];
	list_for_each(lhandle, &efi_mem) {
		struct efi_mem_list *lmem;

		lmem = list_entry(lhandle, struct efi_mem_list, link);
		*memory_map = lmem->desc;
		memory_map--;
	}

	if (map_key)
		*map_key = efi_memory_map_key;

	return EFI_SUCCESS;
}

__weak void efi_add_known_memory(void)
{
	int i;

	/* Add RAM */
	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;
		u64 start = (ram_start + EFI_PAGE_MASK) & ~EFI_PAGE_MASK;
		u64 pages = (ram_size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;

		efi_add_memory_map(start, pages, EFI_CONVENTIONAL_MEMORY,
				   false);
	}
}

/* Add memory regions for U-Boot's memory and for the runtime services code */
static void add_u_boot_and_runtime(void)
{
	unsigned long runtime_start, runtime_end, runtime_pages;
	unsigned long uboot_start, uboot_pages;
	unsigned long uboot_stack_size = 16 * 1024 * 1024;

	/* Add U-Boot */
	uboot_start = (gd->start_addr_sp - uboot_stack_size) & ~EFI_PAGE_MASK;
	uboot_pages = (gd->ram_top - uboot_start) >> EFI_PAGE_SHIFT;
	efi_add_memory_map(uboot_start, uboot_pages, EFI_LOADER_DATA, false);

	/* Add Runtime Services */
	runtime_start = (ulong)&__efi_runtime_start & ~EFI_PAGE_MASK;
	runtime_end = (ulong)&__efi_runtime_stop;
	runtime_end = (runtime_end + EFI_PAGE_MASK) & ~EFI_PAGE_MASK;
	runtime_pages = (runtime_end - runtime_start) >> EFI_PAGE_SHIFT;
	efi_add_memory_map(runtime_start, runtime_pages,
			   EFI_RUNTIME_SERVICES_CODE, false);
}

int efi_memory_init(void)
{
	efi_add_known_memory();

	if (!IS_ENABLED(CONFIG_SANDBOX))
		add_u_boot_and_runtime();

#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
	/* Request a 32bit 64MB bounce buffer region */
	uint64_t efi_bounce_buffer_addr = 0xffffffff;

	if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, EFI_LOADER_DATA,
			       (64 * 1024 * 1024) >> EFI_PAGE_SHIFT,
			       &efi_bounce_buffer_addr) != EFI_SUCCESS)
		return -1;

	efi_bounce_buffer = (void*)(uintptr_t)efi_bounce_buffer_addr;
#endif

	return 0;
}
Commit	Line	Data
f739fcd8	1	// SPDX-License-Identifier: GPL-2.0+
5d00995c AG	2	/*
	3	* EFI application memory management
	4	*
	5	* Copyright (c) 2016 Alexander Graf
5d00995c AG	6	*/
5d00995c AG	7
5d00995c AG	8	#include <common.h>
	9	#include <efi_loader.h>
	10	#include <malloc.h>
282a06cb	11	#include <mapmem.h>
bdecaebd	12	#include <watchdog.h>
38ce65e1	13	#include <linux/list_sort.h>
5d00995c AG	14
	15	DECLARE_GLOBAL_DATA_PTR;
	16
1fcb7ea2 HS	17	efi_uintn_t efi_memory_map_key;
1fcb7ea2 HS	18
5d00995c AG	19	struct efi_mem_list {
	20	struct list_head link;
	21	struct efi_mem_desc desc;
	22	};
	23
74c16acc AG	24	#define EFI_CARVE_NO_OVERLAP -1
	25	#define EFI_CARVE_LOOP_AGAIN -2
	26	#define EFI_CARVE_OVERLAPS_NONRAM -3
	27
5d00995c AG	28	/* This list contains all memory map items */
	29	LIST_HEAD(efi_mem);
	30
51735ae0 AG	31	#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
	32	void *efi_bounce_buffer;
	33	#endif
	34
42417bc8 SB	35	/*
	36	* U-Boot services each EFI AllocatePool request as a separate
	37	* (multiple) page allocation. We have to track the number of pages
	38	* to be able to free the correct amount later.
	39	* EFI requires 8 byte alignment for pool allocations, so we can
	40	* prepend each allocation with an 64 bit header tracking the
	41	* allocation size, and hand out the remainder to the caller.
	42	*/
	43	struct efi_pool_allocation {
	44	u64 num_pages;
946160f3	45	char data[] __aligned(ARCH_DMA_MINALIGN);
42417bc8 SB	46	};
42417bc8 SB	47
38ce65e1 AG	48	/*
	49	* Sorts the memory list from highest address to lowest address
	50	*
	51	* When allocating memory we should always start from the highest
	52	* address chunk, so sort the memory list such that the first list
	53	* iterator gets the highest address and goes lower from there.
	54	*/
	55	static int efi_mem_cmp(void priv, struct list_head a, struct list_head *b)
	56	{
	57	struct efi_mem_list *mema = list_entry(a, struct efi_mem_list, link);
	58	struct efi_mem_list *memb = list_entry(b, struct efi_mem_list, link);
	59
	60	if (mema->desc.physical_start == memb->desc.physical_start)
	61	return 0;
	62	else if (mema->desc.physical_start < memb->desc.physical_start)
	63	return 1;
	64	else
	65	return -1;
	66	}
	67
	68	static void efi_mem_sort(void)
	69	{
	70	list_sort(NULL, &efi_mem, efi_mem_cmp);
	71	}
	72
32826140 HS	73	/** efi_mem_carve_out - unmap memory region
	74	*
	75	* @map: memory map
	76	* @carve_desc: memory region to unmap
	77	* @overlap_only_ram: the carved out region may only overlap RAM
	78	* Return Value: the number of overlapping pages which have been
	79	* removed from the map,
	80	* EFI_CARVE_NO_OVERLAP, if the regions don't overlap,
	81	* EFI_CARVE_OVERLAPS_NONRAM, if the carve and map overlap,
	82	* and the map contains anything but free ram
	83	* (only when overlap_only_ram is true),
	84	* EFI_CARVE_LOOP_AGAIN, if the mapping list should be
	85	* traversed again, as it has been altered.
5d00995c	86	*
32826140 HS	87	* Unmaps all memory occupied by the carve_desc region from the list entry
32826140 HS	88	* pointed to by map.
852efbf5 SB	89	*
852efbf5 SB	90	* In case of EFI_CARVE_OVERLAPS_NONRAM it is the callers responsibility
32826140	91	* to re-add the already carved out pages to the mapping.
5d00995c	92	*/
32826140	93	static s64 efi_mem_carve_out(struct efi_mem_list *map,
5d00995c AG	94	struct efi_mem_desc *carve_desc,
	95	bool overlap_only_ram)
	96	{
	97	struct efi_mem_list *newmap;
	98	struct efi_mem_desc *map_desc = &map->desc;
	99	uint64_t map_start = map_desc->physical_start;
	100	uint64_t map_end = map_start + (map_desc->num_pages << EFI_PAGE_SHIFT);
	101	uint64_t carve_start = carve_desc->physical_start;
	102	uint64_t carve_end = carve_start +
	103	(carve_desc->num_pages << EFI_PAGE_SHIFT);
	104
	105	/* check whether we're overlapping */
	106	if ((carve_end <= map_start) \|\| (carve_start >= map_end))
74c16acc	107	return EFI_CARVE_NO_OVERLAP;
5d00995c AG	108
	109	/* We're overlapping with non-RAM, warn the caller if desired */
	110	if (overlap_only_ram && (map_desc->type != EFI_CONVENTIONAL_MEMORY))
74c16acc	111	return EFI_CARVE_OVERLAPS_NONRAM;
5d00995c AG	112
	113	/* Sanitize carve_start and carve_end to lie within our bounds */
	114	carve_start = max(carve_start, map_start);
	115	carve_end = min(carve_end, map_end);
	116
	117	/* Carving at the beginning of our map? Just move it! */
	118	if (carve_start == map_start) {
	119	if (map_end == carve_end) {
	120	/* Full overlap, just remove map */
	121	list_del(&map->link);
511d0b97 SB	122	free(map);
	123	} else {
	124	map->desc.physical_start = carve_end;
	125	map->desc.num_pages = (map_end - carve_end)
	126	>> EFI_PAGE_SHIFT;
5d00995c AG	127	}
5d00995c AG	128
74c16acc	129	return (carve_end - carve_start) >> EFI_PAGE_SHIFT;
5d00995c AG	130	}
	131
	132	/*
	133	* Overlapping maps, just split the list map at carve_start,
	134	* it will get moved or removed in the next iteration.
	135	*
	136	* [ map_desc \|__carve_start__\| newmap ]
	137	*/
	138
	139	/* Create a new map from [ carve_start ... map_end ] */
	140	newmap = calloc(1, sizeof(*newmap));
	141	newmap->desc = map->desc;
	142	newmap->desc.physical_start = carve_start;
	143	newmap->desc.num_pages = (map_end - carve_start) >> EFI_PAGE_SHIFT;
b6a95172 SB	144	/* Insert before current entry (descending address order) */
b6a95172 SB	145	list_add_tail(&newmap->link, &map->link);
5d00995c AG	146
	147	/* Shrink the map to [ map_start ... carve_start ] */
	148	map_desc->num_pages = (carve_start - map_start) >> EFI_PAGE_SHIFT;
	149
74c16acc	150	return EFI_CARVE_LOOP_AGAIN;
5d00995c AG	151	}
	152
	153	uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
	154	bool overlap_only_ram)
	155	{
	156	struct list_head *lhandle;
	157	struct efi_mem_list *newlist;
74c16acc AG	158	bool carve_again;
74c16acc AG	159	uint64_t carved_pages = 0;
5d00995c	160
dee37fc9	161	debug("%s: 0x%llx 0x%llx %d %s\n", __func__,
c933ed94 AF	162	start, pages, memory_type, overlap_only_ram ? "yes" : "no");
c933ed94 AF	163
1fcb7ea2 HS	164	if (memory_type >= EFI_MAX_MEMORY_TYPE)
	165	return EFI_INVALID_PARAMETER;
	166
5d00995c AG	167	if (!pages)
	168	return start;
	169
1fcb7ea2	170	++efi_memory_map_key;
5d00995c AG	171	newlist = calloc(1, sizeof(*newlist));
	172	newlist->desc.type = memory_type;
	173	newlist->desc.physical_start = start;
	174	newlist->desc.virtual_start = start;
	175	newlist->desc.num_pages = pages;
	176
	177	switch (memory_type) {
	178	case EFI_RUNTIME_SERVICES_CODE:
	179	case EFI_RUNTIME_SERVICES_DATA:
9b89183b	180	newlist->desc.attribute = EFI_MEMORY_WB \| EFI_MEMORY_RUNTIME;
5d00995c AG	181	break;
5d00995c AG	182	case EFI_MMAP_IO:
9b89183b	183	newlist->desc.attribute = EFI_MEMORY_RUNTIME;
5d00995c AG	184	break;
5d00995c AG	185	default:
9b89183b	186	newlist->desc.attribute = EFI_MEMORY_WB;
5d00995c AG	187	break;
	188	}
	189
	190	/* Add our new map */
	191	do {
74c16acc	192	carve_again = false;
5d00995c AG	193	list_for_each(lhandle, &efi_mem) {
5d00995c AG	194	struct efi_mem_list *lmem;
32826140	195	s64 r;
5d00995c AG	196
	197	lmem = list_entry(lhandle, struct efi_mem_list, link);
	198	r = efi_mem_carve_out(lmem, &newlist->desc,
	199	overlap_only_ram);
74c16acc AG	200	switch (r) {
	201	case EFI_CARVE_OVERLAPS_NONRAM:
	202	/*
	203	* The user requested to only have RAM overlaps,
	204	* but we hit a non-RAM region. Error out.
	205	*/
5d00995c	206	return 0;
74c16acc AG	207	case EFI_CARVE_NO_OVERLAP:
	208	/* Just ignore this list entry */
	209	break;
	210	case EFI_CARVE_LOOP_AGAIN:
	211	/*
	212	* We split an entry, but need to loop through
	213	* the list again to actually carve it.
	214	*/
	215	carve_again = true;
	216	break;
	217	default:
	218	/* We carved a number of pages */
	219	carved_pages += r;
	220	carve_again = true;
	221	break;
	222	}
	223
	224	if (carve_again) {
	225	/* The list changed, we need to start over */
5d00995c AG	226	break;
	227	}
	228	}
74c16acc AG	229	} while (carve_again);
	230
	231	if (overlap_only_ram && (carved_pages != pages)) {
	232	/*
	233	* The payload wanted to have RAM overlaps, but we overlapped
	234	* with an unallocated region. Error out.
	235	*/
	236	return 0;
	237	}
5d00995c AG	238
	239	/* Add our new map */
	240	list_add_tail(&newlist->link, &efi_mem);
	241
38ce65e1 AG	242	/* And make sure memory is listed in descending order */
	243	efi_mem_sort();
	244
5d00995c AG	245	return start;
	246	}
	247
	248	static uint64_t efi_find_free_memory(uint64_t len, uint64_t max_addr)
	249	{
	250	struct list_head *lhandle;
	251
	252	list_for_each(lhandle, &efi_mem) {
	253	struct efi_mem_list *lmem = list_entry(lhandle,
	254	struct efi_mem_list, link);
	255	struct efi_mem_desc *desc = &lmem->desc;
	256	uint64_t desc_len = desc->num_pages << EFI_PAGE_SHIFT;
	257	uint64_t desc_end = desc->physical_start + desc_len;
	258	uint64_t curmax = min(max_addr, desc_end);
	259	uint64_t ret = curmax - len;
	260
	261	/* We only take memory from free RAM */
	262	if (desc->type != EFI_CONVENTIONAL_MEMORY)
	263	continue;
	264
	265	/* Out of bounds for max_addr */
	266	if ((ret + len) > max_addr)
	267	continue;
	268
	269	/* Out of bounds for upper map limit */
	270	if ((ret + len) > desc_end)
	271	continue;
	272
	273	/* Out of bounds for lower map limit */
	274	if (ret < desc->physical_start)
	275	continue;
	276
	277	/* Return the highest address in this map within bounds */
	278	return ret;
	279	}
	280
	281	return 0;
	282	}
	283
474a6f5a HS	284	/*
	285	* Allocate memory pages.
	286	*
	287	* @type type of allocation to be performed
	288	* @memory_type usage type of the allocated memory
	289	* @pages number of pages to be allocated
	290	* @memory allocated memory
	291	* @return status code
	292	*/
5d00995c	293	efi_status_t efi_allocate_pages(int type, int memory_type,
f5a2a938	294	efi_uintn_t pages, uint64_t *memory)
5d00995c AG	295	{
	296	u64 len = pages << EFI_PAGE_SHIFT;
	297	efi_status_t r = EFI_SUCCESS;
	298	uint64_t addr;
	299
4d5e071e HS	300	if (!memory)
	301	return EFI_INVALID_PARAMETER;
	302
5d00995c	303	switch (type) {
7c92fd69	304	case EFI_ALLOCATE_ANY_PAGES:
5d00995c	305	/* Any page */
14deb5e6	306	addr = efi_find_free_memory(len, -1ULL);
5d00995c AG	307	if (!addr) {
	308	r = EFI_NOT_FOUND;
	309	break;
	310	}
	311	break;
7c92fd69	312	case EFI_ALLOCATE_MAX_ADDRESS:
5d00995c AG	313	/* Max address */
	314	addr = efi_find_free_memory(len, *memory);
	315	if (!addr) {
	316	r = EFI_NOT_FOUND;
	317	break;
	318	}
	319	break;
7c92fd69	320	case EFI_ALLOCATE_ADDRESS:
5d00995c AG	321	/* Exact address, reserve it. The addr is already in memory. /
	322	addr = *memory;
	323	break;
	324	default:
	325	/* UEFI doesn't specify other allocation types */
	326	r = EFI_INVALID_PARAMETER;
	327	break;
	328	}
	329
	330	if (r == EFI_SUCCESS) {
	331	uint64_t ret;
	332
	333	/* Reserve that map in our memory maps */
	334	ret = efi_add_memory_map(addr, pages, memory_type, true);
	335	if (ret == addr) {
282a06cb	336	*memory = (uintptr_t)map_sysmem(addr, len);
5d00995c AG	337	} else {
	338	/* Map would overlap, bail out */
	339	r = EFI_OUT_OF_RESOURCES;
	340	}
	341	}
	342
	343	return r;
	344	}
	345
	346	void *efi_alloc(uint64_t len, int memory_type)
	347	{
	348	uint64_t ret = 0;
	349	uint64_t pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
	350	efi_status_t r;
	351
e09159c8 HS	352	r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, memory_type, pages,
e09159c8 HS	353	&ret);
5d00995c AG	354	if (r == EFI_SUCCESS)
	355	return (void*)(uintptr_t)ret;
	356
	357	return NULL;
	358	}
	359
474a6f5a HS	360	/*
	361	* Free memory pages.
	362	*
	363	* @memory start of the memory area to be freed
	364	* @pages number of pages to be freed
	365	* @return status code
	366	*/
f5a2a938	367	efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages)
5d00995c	368	{
b61d857b	369	uint64_t r = 0;
282a06cb	370	uint64_t addr = map_to_sysmem((void *)(uintptr_t)memory);
b61d857b	371
282a06cb	372	r = efi_add_memory_map(addr, pages, EFI_CONVENTIONAL_MEMORY, false);
b61d857b SB	373	/* Merging of adjacent free regions is missing */
b61d857b SB	374
282a06cb	375	if (r == addr)
b61d857b SB	376	return EFI_SUCCESS;
	377
	378	return EFI_NOT_FOUND;
5d00995c AG	379	}
5d00995c AG	380
474a6f5a HS	381	/*
	382	* Allocate memory from pool.
	383	*
	384	* @pool_type type of the pool from which memory is to be allocated
	385	* @size number of bytes to be allocated
	386	* @buffer allocated memory
	387	* @return status code
	388	*/
	389	efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size, void **buffer)
ead1274b SB	390	{
ead1274b SB	391	efi_status_t r;
282a06cb	392	struct efi_pool_allocation *alloc;
946160f3 RC	393	u64 num_pages = (size + sizeof(struct efi_pool_allocation) +
946160f3 RC	394	EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
42417bc8	395
4d5e071e HS	396	if (!buffer)
	397	return EFI_INVALID_PARAMETER;
	398
42417bc8 SB	399	if (size == 0) {
	400	*buffer = NULL;
	401	return EFI_SUCCESS;
	402	}
ead1274b	403
e09159c8	404	r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, pool_type, num_pages,
282a06cb	405	(uint64_t *)&alloc);
42417bc8 SB	406
42417bc8 SB	407	if (r == EFI_SUCCESS) {
42417bc8 SB	408	alloc->num_pages = num_pages;
	409	*buffer = alloc->data;
	410	}
	411
	412	return r;
	413	}
	414
474a6f5a HS	415	/*
	416	* Free memory from pool.
	417	*
	418	* @buffer start of memory to be freed
	419	* @return status code
	420	*/
42417bc8 SB	421	efi_status_t efi_free_pool(void *buffer)
	422	{
	423	efi_status_t r;
	424	struct efi_pool_allocation *alloc;
	425
71275a3e HS	426	if (buffer == NULL)
	427	return EFI_INVALID_PARAMETER;
	428
42417bc8 SB	429	alloc = container_of(buffer, struct efi_pool_allocation, data);
	430	/* Sanity check, was the supplied address returned by allocate_pool */
	431	assert(((uintptr_t)alloc & EFI_PAGE_MASK) == 0);
	432
	433	r = efi_free_pages((uintptr_t)alloc, alloc->num_pages);
ead1274b SB	434
	435	return r;
	436	}
	437
474a6f5a HS	438	/*
	439	* Get map describing memory usage.
	440	*
	441	* @memory_map_size on entry the size, in bytes, of the memory map buffer,
	442	* on exit the size of the copied memory map
	443	* @memory_map buffer to which the memory map is written
	444	* @map_key key for the memory map
	445	* @descriptor_size size of an individual memory descriptor
	446	* @descriptor_version version number of the memory descriptor structure
	447	* @return status code
	448	*/
f5a2a938 HS	449	efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
	450	struct efi_mem_desc *memory_map,
	451	efi_uintn_t *map_key,
	452	efi_uintn_t *descriptor_size,
	453	uint32_t *descriptor_version)
5d00995c	454	{
f5a2a938	455	efi_uintn_t map_size = 0;
cee752fa	456	int map_entries = 0;
5d00995c	457	struct list_head *lhandle;
fa995d0d	458	efi_uintn_t provided_map_size;
5d00995c	459
8e835554 HS	460	if (!memory_map_size)
	461	return EFI_INVALID_PARAMETER;
	462
fa995d0d HS	463	provided_map_size = *memory_map_size;
fa995d0d HS	464
5d00995c	465	list_for_each(lhandle, &efi_mem)
cee752fa AG	466	map_entries++;
	467
	468	map_size = map_entries * sizeof(struct efi_mem_desc);
5d00995c	469
a1b24823 RC	470	*memory_map_size = map_size;
a1b24823 RC	471
0ecba5db HS	472	if (provided_map_size < map_size)
	473	return EFI_BUFFER_TOO_SMALL;
	474
8e835554 HS	475	if (!memory_map)
	476	return EFI_INVALID_PARAMETER;
	477
5d00995c AG	478	if (descriptor_size)
	479	*descriptor_size = sizeof(struct efi_mem_desc);
	480
4c02c11d MYK	481	if (descriptor_version)
	482	*descriptor_version = EFI_MEMORY_DESCRIPTOR_VERSION;
	483
5d00995c	484	/* Copy list into array */
8e835554 HS	485	/* Return the list in ascending order */
	486	memory_map = &memory_map[map_entries - 1];
	487	list_for_each(lhandle, &efi_mem) {
	488	struct efi_mem_list *lmem;
5d00995c	489
8e835554 HS	490	lmem = list_entry(lhandle, struct efi_mem_list, link);
	491	*memory_map = lmem->desc;
	492	memory_map--;
5d00995c AG	493	}
5d00995c AG	494
8e835554	495	if (map_key)
1fcb7ea2	496	*map_key = efi_memory_map_key;
c6e3c3e6	497
5d00995c AG	498	return EFI_SUCCESS;
	499	}
	500
42633745	501	__weak void efi_add_known_memory(void)
5d00995c	502	{
5d00995c AG	503	int i;
	504
	505	/* Add RAM */
	506	for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
	507	u64 ram_start = gd->bd->bi_dram[i].start;
	508	u64 ram_size = gd->bd->bi_dram[i].size;
	509	u64 start = (ram_start + EFI_PAGE_MASK) & ~EFI_PAGE_MASK;
	510	u64 pages = (ram_size + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
	511
	512	efi_add_memory_map(start, pages, EFI_CONVENTIONAL_MEMORY,
	513	false);
	514	}
42633745 YS	515	}
42633745 YS	516
69259b83 SG	517	/* Add memory regions for U-Boot's memory and for the runtime services code */
69259b83 SG	518	static void add_u_boot_and_runtime(void)
42633745 YS	519	{
	520	unsigned long runtime_start, runtime_end, runtime_pages;
	521	unsigned long uboot_start, uboot_pages;
	522	unsigned long uboot_stack_size = 16 * 1024 * 1024;
	523
5d00995c AG	524	/* Add U-Boot */
	525	uboot_start = (gd->start_addr_sp - uboot_stack_size) & ~EFI_PAGE_MASK;
	526	uboot_pages = (gd->ram_top - uboot_start) >> EFI_PAGE_SHIFT;
	527	efi_add_memory_map(uboot_start, uboot_pages, EFI_LOADER_DATA, false);
	528
	529	/* Add Runtime Services */
	530	runtime_start = (ulong)&__efi_runtime_start & ~EFI_PAGE_MASK;
	531	runtime_end = (ulong)&__efi_runtime_stop;
	532	runtime_end = (runtime_end + EFI_PAGE_MASK) & ~EFI_PAGE_MASK;
	533	runtime_pages = (runtime_end - runtime_start) >> EFI_PAGE_SHIFT;
	534	efi_add_memory_map(runtime_start, runtime_pages,
	535	EFI_RUNTIME_SERVICES_CODE, false);
69259b83 SG	536	}
	537
	538	int efi_memory_init(void)
	539	{
	540	efi_add_known_memory();
	541
	542	if (!IS_ENABLED(CONFIG_SANDBOX))
	543	add_u_boot_and_runtime();
5d00995c	544
51735ae0 AG	545	#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
	546	/* Request a 32bit 64MB bounce buffer region */
	547	uint64_t efi_bounce_buffer_addr = 0xffffffff;
	548
e09159c8	549	if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, EFI_LOADER_DATA,
51735ae0 AG	550	(64 * 1024 * 1024) >> EFI_PAGE_SHIFT,
	551	&efi_bounce_buffer_addr) != EFI_SUCCESS)
	552	return -1;
	553
	554	efi_bounce_buffer = (void*)(uintptr_t)efi_bounce_buffer_addr;
	555	#endif
	556
5d00995c AG	557	return 0;
5d00995c AG	558	}