blob: f4acbee4f9b6cf158bc511f7c01b763ec6eba93d [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Graf8623f922016-03-04 01:10:04 +01002/*
3 * EFI application memory management
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf8623f922016-03-04 01:10:04 +01006 */
7
Alexander Graf8623f922016-03-04 01:10:04 +01008#include <common.h>
9#include <efi_loader.h>
Simon Glass6980b6b2019-11-14 12:57:45 -070010#include <init.h>
Alexander Graf8623f922016-03-04 01:10:04 +010011#include <malloc.h>
Alexander Grafcd405172018-06-18 17:23:15 +020012#include <mapmem.h>
Simon Glass3e852172018-03-08 21:53:27 +010013#include <watchdog.h>
Simon Glass274e0b02020-05-10 11:39:56 -060014#include <asm/cache.h>
Simon Glass3ba929a2020-10-30 21:38:53 -060015#include <asm/global_data.h>
Alexander Grafde2a13b2016-03-30 16:38:29 +020016#include <linux/list_sort.h>
Alexander Graf15937a22018-09-17 13:54:33 +020017#include <linux/sizes.h>
Alexander Graf8623f922016-03-04 01:10:04 +010018
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +010021/* Magic number identifying memory allocated from pool */
22#define EFI_ALLOC_POOL_MAGIC 0x1fe67ddf6491caa2
23
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +020024efi_uintn_t efi_memory_map_key;
25
Alexander Graf8623f922016-03-04 01:10:04 +010026struct efi_mem_list {
27 struct list_head link;
28 struct efi_mem_desc desc;
29};
30
Alexander Graf66d86232016-05-27 12:25:03 +020031#define EFI_CARVE_NO_OVERLAP -1
32#define EFI_CARVE_LOOP_AGAIN -2
33#define EFI_CARVE_OVERLAPS_NONRAM -3
34
Alexander Graf8623f922016-03-04 01:10:04 +010035/* This list contains all memory map items */
36LIST_HEAD(efi_mem);
37
Alexander Graf7c00a3c2016-05-11 18:25:48 +020038#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
39void *efi_bounce_buffer;
40#endif
41
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +010042/**
Heinrich Schuchardt79f882a2019-07-14 12:28:56 +020043 * struct efi_pool_allocation - memory block allocated from pool
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +010044 *
45 * @num_pages: number of pages allocated
46 * @checksum: checksum
Heinrich Schuchardt79f882a2019-07-14 12:28:56 +020047 * @data: allocated pool memory
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +010048 *
Heinrich Schuchardt79f882a2019-07-14 12:28:56 +020049 * U-Boot services each UEFI AllocatePool() request as a separate
50 * (multiple) page allocation. We have to track the number of pages
Stefan Brüns67b67d92016-10-09 22:17:26 +020051 * to be able to free the correct amount later.
Heinrich Schuchardt79f882a2019-07-14 12:28:56 +020052 *
53 * The checksum calculated in function checksum() is used in FreePool() to avoid
54 * freeing memory not allocated by AllocatePool() and duplicate freeing.
55 *
Stefan Brüns67b67d92016-10-09 22:17:26 +020056 * EFI requires 8 byte alignment for pool allocations, so we can
Heinrich Schuchardt79f882a2019-07-14 12:28:56 +020057 * prepend each allocation with these header fields.
Stefan Brüns67b67d92016-10-09 22:17:26 +020058 */
59struct efi_pool_allocation {
60 u64 num_pages;
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +010061 u64 checksum;
Rob Clarke597fd42017-09-13 18:05:36 -040062 char data[] __aligned(ARCH_DMA_MINALIGN);
Stefan Brüns67b67d92016-10-09 22:17:26 +020063};
64
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +010065/**
66 * checksum() - calculate checksum for memory allocated from pool
67 *
68 * @alloc: allocation header
69 * Return: checksum, always non-zero
70 */
71static u64 checksum(struct efi_pool_allocation *alloc)
72{
73 u64 addr = (uintptr_t)alloc;
74 u64 ret = (addr >> 32) ^ (addr << 32) ^ alloc->num_pages ^
75 EFI_ALLOC_POOL_MAGIC;
76 if (!ret)
77 ++ret;
78 return ret;
79}
80
Stefan Brüns67b67d92016-10-09 22:17:26 +020081/*
Alexander Grafde2a13b2016-03-30 16:38:29 +020082 * Sorts the memory list from highest address to lowest address
83 *
84 * When allocating memory we should always start from the highest
85 * address chunk, so sort the memory list such that the first list
86 * iterator gets the highest address and goes lower from there.
87 */
88static int efi_mem_cmp(void *priv, struct list_head *a, struct list_head *b)
89{
90 struct efi_mem_list *mema = list_entry(a, struct efi_mem_list, link);
91 struct efi_mem_list *memb = list_entry(b, struct efi_mem_list, link);
92
93 if (mema->desc.physical_start == memb->desc.physical_start)
94 return 0;
95 else if (mema->desc.physical_start < memb->desc.physical_start)
96 return 1;
97 else
98 return -1;
99}
100
Alexander Grafd7288142018-09-16 17:05:29 +0200101static uint64_t desc_get_end(struct efi_mem_desc *desc)
102{
103 return desc->physical_start + (desc->num_pages << EFI_PAGE_SHIFT);
104}
105
Alexander Grafde2a13b2016-03-30 16:38:29 +0200106static void efi_mem_sort(void)
107{
Alexander Grafd7288142018-09-16 17:05:29 +0200108 struct list_head *lhandle;
109 struct efi_mem_list *prevmem = NULL;
110 bool merge_again = true;
111
Alexander Grafde2a13b2016-03-30 16:38:29 +0200112 list_sort(NULL, &efi_mem, efi_mem_cmp);
Alexander Grafd7288142018-09-16 17:05:29 +0200113
114 /* Now merge entries that can be merged */
115 while (merge_again) {
116 merge_again = false;
117 list_for_each(lhandle, &efi_mem) {
118 struct efi_mem_list *lmem;
119 struct efi_mem_desc *prev = &prevmem->desc;
120 struct efi_mem_desc *cur;
121 uint64_t pages;
122
123 lmem = list_entry(lhandle, struct efi_mem_list, link);
124 if (!prevmem) {
125 prevmem = lmem;
126 continue;
127 }
128
129 cur = &lmem->desc;
130
131 if ((desc_get_end(cur) == prev->physical_start) &&
132 (prev->type == cur->type) &&
133 (prev->attribute == cur->attribute)) {
134 /* There is an existing map before, reuse it */
135 pages = cur->num_pages;
136 prev->num_pages += pages;
137 prev->physical_start -= pages << EFI_PAGE_SHIFT;
138 prev->virtual_start -= pages << EFI_PAGE_SHIFT;
139 list_del(&lmem->link);
140 free(lmem);
141
142 merge_again = true;
143 break;
144 }
145
146 prevmem = lmem;
147 }
148 }
Alexander Grafde2a13b2016-03-30 16:38:29 +0200149}
150
Heinrich Schuchardtf00caa52018-05-27 16:45:09 +0200151/** efi_mem_carve_out - unmap memory region
Alexander Graf8623f922016-03-04 01:10:04 +0100152 *
Heinrich Schuchardtf00caa52018-05-27 16:45:09 +0200153 * @map: memory map
154 * @carve_desc: memory region to unmap
155 * @overlap_only_ram: the carved out region may only overlap RAM
156 * Return Value: the number of overlapping pages which have been
157 * removed from the map,
158 * EFI_CARVE_NO_OVERLAP, if the regions don't overlap,
159 * EFI_CARVE_OVERLAPS_NONRAM, if the carve and map overlap,
160 * and the map contains anything but free ram
161 * (only when overlap_only_ram is true),
162 * EFI_CARVE_LOOP_AGAIN, if the mapping list should be
163 * traversed again, as it has been altered.
164 *
165 * Unmaps all memory occupied by the carve_desc region from the list entry
166 * pointed to by map.
Stefan Brüns1b00dc12016-10-01 23:32:23 +0200167 *
168 * In case of EFI_CARVE_OVERLAPS_NONRAM it is the callers responsibility
Heinrich Schuchardtf00caa52018-05-27 16:45:09 +0200169 * to re-add the already carved out pages to the mapping.
Alexander Graf8623f922016-03-04 01:10:04 +0100170 */
Heinrich Schuchardtf00caa52018-05-27 16:45:09 +0200171static s64 efi_mem_carve_out(struct efi_mem_list *map,
Alexander Graf8623f922016-03-04 01:10:04 +0100172 struct efi_mem_desc *carve_desc,
173 bool overlap_only_ram)
174{
175 struct efi_mem_list *newmap;
176 struct efi_mem_desc *map_desc = &map->desc;
177 uint64_t map_start = map_desc->physical_start;
178 uint64_t map_end = map_start + (map_desc->num_pages << EFI_PAGE_SHIFT);
179 uint64_t carve_start = carve_desc->physical_start;
180 uint64_t carve_end = carve_start +
181 (carve_desc->num_pages << EFI_PAGE_SHIFT);
182
183 /* check whether we're overlapping */
184 if ((carve_end <= map_start) || (carve_start >= map_end))
Alexander Graf66d86232016-05-27 12:25:03 +0200185 return EFI_CARVE_NO_OVERLAP;
Alexander Graf8623f922016-03-04 01:10:04 +0100186
187 /* We're overlapping with non-RAM, warn the caller if desired */
188 if (overlap_only_ram && (map_desc->type != EFI_CONVENTIONAL_MEMORY))
Alexander Graf66d86232016-05-27 12:25:03 +0200189 return EFI_CARVE_OVERLAPS_NONRAM;
Alexander Graf8623f922016-03-04 01:10:04 +0100190
191 /* Sanitize carve_start and carve_end to lie within our bounds */
192 carve_start = max(carve_start, map_start);
193 carve_end = min(carve_end, map_end);
194
195 /* Carving at the beginning of our map? Just move it! */
196 if (carve_start == map_start) {
197 if (map_end == carve_end) {
198 /* Full overlap, just remove map */
199 list_del(&map->link);
Stefan Brüns4e9ad8d2016-10-01 23:32:29 +0200200 free(map);
201 } else {
202 map->desc.physical_start = carve_end;
Heinrich Schuchardte83aafa2019-04-11 20:08:54 +0200203 map->desc.virtual_start = carve_end;
Stefan Brüns4e9ad8d2016-10-01 23:32:29 +0200204 map->desc.num_pages = (map_end - carve_end)
205 >> EFI_PAGE_SHIFT;
Alexander Graf8623f922016-03-04 01:10:04 +0100206 }
207
Alexander Graf66d86232016-05-27 12:25:03 +0200208 return (carve_end - carve_start) >> EFI_PAGE_SHIFT;
Alexander Graf8623f922016-03-04 01:10:04 +0100209 }
210
211 /*
212 * Overlapping maps, just split the list map at carve_start,
213 * it will get moved or removed in the next iteration.
214 *
215 * [ map_desc |__carve_start__| newmap ]
216 */
217
218 /* Create a new map from [ carve_start ... map_end ] */
219 newmap = calloc(1, sizeof(*newmap));
220 newmap->desc = map->desc;
221 newmap->desc.physical_start = carve_start;
Heinrich Schuchardte83aafa2019-04-11 20:08:54 +0200222 newmap->desc.virtual_start = carve_start;
Alexander Graf8623f922016-03-04 01:10:04 +0100223 newmap->desc.num_pages = (map_end - carve_start) >> EFI_PAGE_SHIFT;
Stefan Brüns9d656512016-10-01 23:32:28 +0200224 /* Insert before current entry (descending address order) */
225 list_add_tail(&newmap->link, &map->link);
Alexander Graf8623f922016-03-04 01:10:04 +0100226
227 /* Shrink the map to [ map_start ... carve_start ] */
228 map_desc->num_pages = (carve_start - map_start) >> EFI_PAGE_SHIFT;
229
Alexander Graf66d86232016-05-27 12:25:03 +0200230 return EFI_CARVE_LOOP_AGAIN;
Alexander Graf8623f922016-03-04 01:10:04 +0100231}
232
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100233/**
Michael Walle282d3862020-05-17 12:29:19 +0200234 * efi_add_memory_map_pg() - add pages to the memory map
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100235 *
236 * @start: start address, must be a multiple of EFI_PAGE_SIZE
237 * @pages: number of pages to add
238 * @memory_type: type of memory added
Maxim Uvarovec631ea2020-08-28 22:47:41 +0300239 * @overlap_only_ram: region may only overlap RAM
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100240 * Return: status code
241 */
Michael Walle282d3862020-05-17 12:29:19 +0200242static efi_status_t efi_add_memory_map_pg(u64 start, u64 pages,
243 int memory_type,
244 bool overlap_only_ram)
Alexander Graf8623f922016-03-04 01:10:04 +0100245{
246 struct list_head *lhandle;
247 struct efi_mem_list *newlist;
Alexander Graf66d86232016-05-27 12:25:03 +0200248 bool carve_again;
249 uint64_t carved_pages = 0;
Heinrich Schuchardt485975b2019-06-04 20:55:12 +0200250 struct efi_event *evt;
Alexander Graf8623f922016-03-04 01:10:04 +0100251
Heinrich Schuchardt706a2fe2019-04-04 21:50:02 +0200252 EFI_PRINT("%s: 0x%llx 0x%llx %d %s\n", __func__,
253 start, pages, memory_type, overlap_only_ram ? "yes" : "no");
Andreas Färber102f8bd2016-07-17 06:57:11 +0200254
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200255 if (memory_type >= EFI_MAX_MEMORY_TYPE)
256 return EFI_INVALID_PARAMETER;
257
Alexander Graf8623f922016-03-04 01:10:04 +0100258 if (!pages)
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100259 return EFI_SUCCESS;
Alexander Graf8623f922016-03-04 01:10:04 +0100260
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200261 ++efi_memory_map_key;
Alexander Graf8623f922016-03-04 01:10:04 +0100262 newlist = calloc(1, sizeof(*newlist));
263 newlist->desc.type = memory_type;
264 newlist->desc.physical_start = start;
265 newlist->desc.virtual_start = start;
266 newlist->desc.num_pages = pages;
267
268 switch (memory_type) {
269 case EFI_RUNTIME_SERVICES_CODE:
270 case EFI_RUNTIME_SERVICES_DATA:
Eugeniu Roscac86c0812018-07-14 22:53:30 +0200271 newlist->desc.attribute = EFI_MEMORY_WB | EFI_MEMORY_RUNTIME;
Alexander Graf8623f922016-03-04 01:10:04 +0100272 break;
273 case EFI_MMAP_IO:
Eugeniu Roscac86c0812018-07-14 22:53:30 +0200274 newlist->desc.attribute = EFI_MEMORY_RUNTIME;
Alexander Graf8623f922016-03-04 01:10:04 +0100275 break;
276 default:
Eugeniu Roscac86c0812018-07-14 22:53:30 +0200277 newlist->desc.attribute = EFI_MEMORY_WB;
Alexander Graf8623f922016-03-04 01:10:04 +0100278 break;
279 }
280
281 /* Add our new map */
282 do {
Alexander Graf66d86232016-05-27 12:25:03 +0200283 carve_again = false;
Alexander Graf8623f922016-03-04 01:10:04 +0100284 list_for_each(lhandle, &efi_mem) {
285 struct efi_mem_list *lmem;
Heinrich Schuchardtf00caa52018-05-27 16:45:09 +0200286 s64 r;
Alexander Graf8623f922016-03-04 01:10:04 +0100287
288 lmem = list_entry(lhandle, struct efi_mem_list, link);
289 r = efi_mem_carve_out(lmem, &newlist->desc,
290 overlap_only_ram);
Alexander Graf66d86232016-05-27 12:25:03 +0200291 switch (r) {
292 case EFI_CARVE_OVERLAPS_NONRAM:
293 /*
294 * The user requested to only have RAM overlaps,
295 * but we hit a non-RAM region. Error out.
296 */
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100297 return EFI_NO_MAPPING;
Alexander Graf66d86232016-05-27 12:25:03 +0200298 case EFI_CARVE_NO_OVERLAP:
299 /* Just ignore this list entry */
300 break;
301 case EFI_CARVE_LOOP_AGAIN:
302 /*
303 * We split an entry, but need to loop through
304 * the list again to actually carve it.
305 */
306 carve_again = true;
307 break;
308 default:
309 /* We carved a number of pages */
310 carved_pages += r;
311 carve_again = true;
Alexander Graf8623f922016-03-04 01:10:04 +0100312 break;
313 }
Alexander Graf66d86232016-05-27 12:25:03 +0200314
315 if (carve_again) {
316 /* The list changed, we need to start over */
317 break;
318 }
Alexander Graf8623f922016-03-04 01:10:04 +0100319 }
Alexander Graf66d86232016-05-27 12:25:03 +0200320 } while (carve_again);
321
322 if (overlap_only_ram && (carved_pages != pages)) {
323 /*
324 * The payload wanted to have RAM overlaps, but we overlapped
325 * with an unallocated region. Error out.
326 */
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100327 return EFI_NO_MAPPING;
Alexander Graf66d86232016-05-27 12:25:03 +0200328 }
Alexander Graf8623f922016-03-04 01:10:04 +0100329
330 /* Add our new map */
331 list_add_tail(&newlist->link, &efi_mem);
332
Alexander Grafde2a13b2016-03-30 16:38:29 +0200333 /* And make sure memory is listed in descending order */
334 efi_mem_sort();
335
Heinrich Schuchardt485975b2019-06-04 20:55:12 +0200336 /* Notify that the memory map was changed */
337 list_for_each_entry(evt, &efi_events, link) {
338 if (evt->group &&
339 !guidcmp(evt->group,
340 &efi_guid_event_group_memory_map_change)) {
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200341 efi_signal_event(evt);
Heinrich Schuchardt485975b2019-06-04 20:55:12 +0200342 break;
343 }
344 }
345
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100346 return EFI_SUCCESS;
Alexander Graf8623f922016-03-04 01:10:04 +0100347}
348
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200349/**
Michael Walle282d3862020-05-17 12:29:19 +0200350 * efi_add_memory_map() - add memory area to the memory map
351 *
352 * @start: start address of the memory area
353 * @size: length in bytes of the memory area
354 * @memory_type: type of memory added
355 *
356 * Return: status code
357 *
358 * This function automatically aligns the start and size of the memory area
359 * to EFI_PAGE_SIZE.
360 */
361efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type)
362{
363 u64 pages;
364
365 pages = efi_size_in_pages(size + (start & EFI_PAGE_MASK));
366 start &= ~EFI_PAGE_MASK;
367
368 return efi_add_memory_map_pg(start, pages, memory_type, false);
369}
370
371/**
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200372 * efi_check_allocated() - validate address to be freed
373 *
374 * Check that the address is within allocated memory:
375 *
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200376 * * The address must be in a range of the memory map.
377 * * The address may not point to EFI_CONVENTIONAL_MEMORY.
378 *
379 * Page alignment is not checked as this is not a requirement of
380 * efi_free_pool().
381 *
Heinrich Schuchardt906f6852019-05-11 08:21:17 +0200382 * @addr: address of page to be freed
383 * @must_be_allocated: return success if the page is allocated
384 * Return: status code
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200385 */
Heinrich Schuchardt906f6852019-05-11 08:21:17 +0200386static efi_status_t efi_check_allocated(u64 addr, bool must_be_allocated)
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200387{
388 struct efi_mem_list *item;
389
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200390 list_for_each_entry(item, &efi_mem, link) {
391 u64 start = item->desc.physical_start;
392 u64 end = start + (item->desc.num_pages << EFI_PAGE_SHIFT);
393
394 if (addr >= start && addr < end) {
Heinrich Schuchardt906f6852019-05-11 08:21:17 +0200395 if (must_be_allocated ^
396 (item->desc.type == EFI_CONVENTIONAL_MEMORY))
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200397 return EFI_SUCCESS;
398 else
399 return EFI_NOT_FOUND;
400 }
401 }
402
403 return EFI_NOT_FOUND;
404}
405
Alexander Graf8623f922016-03-04 01:10:04 +0100406static uint64_t efi_find_free_memory(uint64_t len, uint64_t max_addr)
407{
408 struct list_head *lhandle;
409
Alexander Grafc3b2a252018-11-05 00:30:46 +0100410 /*
411 * Prealign input max address, so we simplify our matching
412 * logic below and can just reuse it as return pointer.
413 */
414 max_addr &= ~EFI_PAGE_MASK;
415
Alexander Graf8623f922016-03-04 01:10:04 +0100416 list_for_each(lhandle, &efi_mem) {
417 struct efi_mem_list *lmem = list_entry(lhandle,
418 struct efi_mem_list, link);
419 struct efi_mem_desc *desc = &lmem->desc;
420 uint64_t desc_len = desc->num_pages << EFI_PAGE_SHIFT;
421 uint64_t desc_end = desc->physical_start + desc_len;
422 uint64_t curmax = min(max_addr, desc_end);
423 uint64_t ret = curmax - len;
424
425 /* We only take memory from free RAM */
426 if (desc->type != EFI_CONVENTIONAL_MEMORY)
427 continue;
428
429 /* Out of bounds for max_addr */
430 if ((ret + len) > max_addr)
431 continue;
432
433 /* Out of bounds for upper map limit */
434 if ((ret + len) > desc_end)
435 continue;
436
437 /* Out of bounds for lower map limit */
438 if (ret < desc->physical_start)
439 continue;
440
441 /* Return the highest address in this map within bounds */
442 return ret;
443 }
444
445 return 0;
446}
447
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100448/*
449 * Allocate memory pages.
450 *
451 * @type type of allocation to be performed
452 * @memory_type usage type of the allocated memory
453 * @pages number of pages to be allocated
454 * @memory allocated memory
455 * @return status code
456 */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200457efi_status_t efi_allocate_pages(enum efi_allocate_type type,
458 enum efi_memory_type memory_type,
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100459 efi_uintn_t pages, uint64_t *memory)
Alexander Graf8623f922016-03-04 01:10:04 +0100460{
461 u64 len = pages << EFI_PAGE_SHIFT;
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200462 efi_status_t ret;
Alexander Graf8623f922016-03-04 01:10:04 +0100463 uint64_t addr;
464
Heinrich Schuchardtf7272332019-04-23 00:30:53 +0200465 /* Check import parameters */
466 if (memory_type >= EFI_PERSISTENT_MEMORY_TYPE &&
467 memory_type <= 0x6FFFFFFF)
468 return EFI_INVALID_PARAMETER;
Heinrich Schuchardta137c962018-07-02 12:53:53 +0200469 if (!memory)
470 return EFI_INVALID_PARAMETER;
471
Alexander Graf8623f922016-03-04 01:10:04 +0100472 switch (type) {
Heinrich Schuchardt3b7b3b62018-01-30 21:08:00 +0100473 case EFI_ALLOCATE_ANY_PAGES:
Alexander Graf8623f922016-03-04 01:10:04 +0100474 /* Any page */
Stephen Warren66208b92018-08-30 15:43:45 -0600475 addr = efi_find_free_memory(len, -1ULL);
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200476 if (!addr)
477 return EFI_OUT_OF_RESOURCES;
Alexander Graf8623f922016-03-04 01:10:04 +0100478 break;
Heinrich Schuchardt3b7b3b62018-01-30 21:08:00 +0100479 case EFI_ALLOCATE_MAX_ADDRESS:
Alexander Graf8623f922016-03-04 01:10:04 +0100480 /* Max address */
481 addr = efi_find_free_memory(len, *memory);
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200482 if (!addr)
483 return EFI_OUT_OF_RESOURCES;
Alexander Graf8623f922016-03-04 01:10:04 +0100484 break;
Heinrich Schuchardt3b7b3b62018-01-30 21:08:00 +0100485 case EFI_ALLOCATE_ADDRESS:
Alexander Graf8623f922016-03-04 01:10:04 +0100486 /* Exact address, reserve it. The addr is already in *memory. */
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200487 ret = efi_check_allocated(*memory, false);
488 if (ret != EFI_SUCCESS)
489 return EFI_NOT_FOUND;
Alexander Graf8623f922016-03-04 01:10:04 +0100490 addr = *memory;
491 break;
492 default:
493 /* UEFI doesn't specify other allocation types */
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200494 return EFI_INVALID_PARAMETER;
Alexander Graf8623f922016-03-04 01:10:04 +0100495 }
496
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200497 /* Reserve that map in our memory maps */
Michael Walle282d3862020-05-17 12:29:19 +0200498 ret = efi_add_memory_map_pg(addr, pages, memory_type, true);
499 if (ret != EFI_SUCCESS)
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200500 /* Map would overlap, bail out */
501 return EFI_OUT_OF_RESOURCES;
Alexander Graf8623f922016-03-04 01:10:04 +0100502
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200503 *memory = addr;
Alexander Graf8623f922016-03-04 01:10:04 +0100504
Heinrich Schuchardtfbdb93c2019-05-11 08:43:30 +0200505 return EFI_SUCCESS;
Alexander Graf8623f922016-03-04 01:10:04 +0100506}
507
508void *efi_alloc(uint64_t len, int memory_type)
509{
510 uint64_t ret = 0;
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100511 uint64_t pages = efi_size_in_pages(len);
Alexander Graf8623f922016-03-04 01:10:04 +0100512 efi_status_t r;
513
Heinrich Schuchardt0f7186b2018-05-26 10:32:27 +0200514 r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, memory_type, pages,
515 &ret);
Alexander Graf8623f922016-03-04 01:10:04 +0100516 if (r == EFI_SUCCESS)
517 return (void*)(uintptr_t)ret;
518
519 return NULL;
520}
521
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100522/**
523 * efi_free_pages() - free memory pages
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100524 *
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100525 * @memory: start of the memory area to be freed
526 * @pages: number of pages to be freed
527 * Return: status code
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100528 */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100529efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages)
Alexander Graf8623f922016-03-04 01:10:04 +0100530{
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200531 efi_status_t ret;
532
Heinrich Schuchardt906f6852019-05-11 08:21:17 +0200533 ret = efi_check_allocated(memory, true);
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200534 if (ret != EFI_SUCCESS)
535 return ret;
Stefan Brünsa4f43022016-10-01 23:32:27 +0200536
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100537 /* Sanity check */
Heinrich Schuchardt7bf4bc92019-04-25 18:41:40 +0200538 if (!memory || (memory & EFI_PAGE_MASK) || !pages) {
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100539 printf("%s: illegal free 0x%llx, 0x%zx\n", __func__,
540 memory, pages);
541 return EFI_INVALID_PARAMETER;
542 }
543
Michael Walle282d3862020-05-17 12:29:19 +0200544 ret = efi_add_memory_map_pg(memory, pages, EFI_CONVENTIONAL_MEMORY,
545 false);
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100546 if (ret != EFI_SUCCESS)
547 return EFI_NOT_FOUND;
Stefan Brünsa4f43022016-10-01 23:32:27 +0200548
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100549 return ret;
Alexander Graf8623f922016-03-04 01:10:04 +0100550}
551
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100552/**
553 * efi_allocate_pool - allocate memory from pool
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100554 *
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100555 * @pool_type: type of the pool from which memory is to be allocated
556 * @size: number of bytes to be allocated
557 * @buffer: allocated memory
558 * Return: status code
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100559 */
Heinrich Schuchardt98228942021-08-17 15:05:31 +0200560efi_status_t efi_allocate_pool(enum efi_memory_type pool_type, efi_uintn_t size, void **buffer)
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200561{
562 efi_status_t r;
Heinrich Schuchardt657e9792019-03-18 20:01:59 +0100563 u64 addr;
Alexander Grafcd405172018-06-18 17:23:15 +0200564 struct efi_pool_allocation *alloc;
Heinrich Schuchardtdcdca292018-11-18 17:58:49 +0100565 u64 num_pages = efi_size_in_pages(size +
566 sizeof(struct efi_pool_allocation));
Stefan Brüns67b67d92016-10-09 22:17:26 +0200567
Heinrich Schuchardta137c962018-07-02 12:53:53 +0200568 if (!buffer)
569 return EFI_INVALID_PARAMETER;
570
Stefan Brüns67b67d92016-10-09 22:17:26 +0200571 if (size == 0) {
572 *buffer = NULL;
573 return EFI_SUCCESS;
574 }
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200575
Heinrich Schuchardt0f7186b2018-05-26 10:32:27 +0200576 r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, pool_type, num_pages,
Heinrich Schuchardt657e9792019-03-18 20:01:59 +0100577 &addr);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200578 if (r == EFI_SUCCESS) {
Heinrich Schuchardt657e9792019-03-18 20:01:59 +0100579 alloc = (struct efi_pool_allocation *)(uintptr_t)addr;
Stefan Brüns67b67d92016-10-09 22:17:26 +0200580 alloc->num_pages = num_pages;
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100581 alloc->checksum = checksum(alloc);
Stefan Brüns67b67d92016-10-09 22:17:26 +0200582 *buffer = alloc->data;
583 }
584
585 return r;
586}
587
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100588/**
589 * efi_free_pool() - free memory from pool
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100590 *
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100591 * @buffer: start of memory to be freed
592 * Return: status code
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100593 */
Stefan Brüns67b67d92016-10-09 22:17:26 +0200594efi_status_t efi_free_pool(void *buffer)
595{
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200596 efi_status_t ret;
Stefan Brüns67b67d92016-10-09 22:17:26 +0200597 struct efi_pool_allocation *alloc;
598
Heinrich Schuchardt56b587f72019-06-12 07:17:04 +0200599 if (!buffer)
600 return EFI_INVALID_PARAMETER;
601
Heinrich Schuchardt906f6852019-05-11 08:21:17 +0200602 ret = efi_check_allocated((uintptr_t)buffer, true);
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200603 if (ret != EFI_SUCCESS)
604 return ret;
xypron.glpk@gmx.de34ddae72017-07-14 19:12:39 +0200605
Stefan Brüns67b67d92016-10-09 22:17:26 +0200606 alloc = container_of(buffer, struct efi_pool_allocation, data);
Heinrich Schuchardtb4e2ba32019-03-26 05:31:41 +0100607
608 /* Check that this memory was allocated by efi_allocate_pool() */
609 if (((uintptr_t)alloc & EFI_PAGE_MASK) ||
610 alloc->checksum != checksum(alloc)) {
611 printf("%s: illegal free 0x%p\n", __func__, buffer);
612 return EFI_INVALID_PARAMETER;
613 }
614 /* Avoid double free */
615 alloc->checksum = 0;
Stefan Brüns67b67d92016-10-09 22:17:26 +0200616
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200617 ret = efi_free_pages((uintptr_t)alloc, alloc->num_pages);
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200618
Heinrich Schuchardtac7f8422019-05-10 21:21:30 +0200619 return ret;
Stefan Brüns5a09aef2016-10-09 22:17:18 +0200620}
621
Heinrich Schuchardt1b32cae2017-12-04 20:52:41 +0100622/*
623 * Get map describing memory usage.
624 *
625 * @memory_map_size on entry the size, in bytes, of the memory map buffer,
626 * on exit the size of the copied memory map
627 * @memory_map buffer to which the memory map is written
628 * @map_key key for the memory map
629 * @descriptor_size size of an individual memory descriptor
630 * @descriptor_version version number of the memory descriptor structure
631 * @return status code
632 */
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100633efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
634 struct efi_mem_desc *memory_map,
635 efi_uintn_t *map_key,
636 efi_uintn_t *descriptor_size,
637 uint32_t *descriptor_version)
Alexander Graf8623f922016-03-04 01:10:04 +0100638{
Heinrich Schuchardt798a4412017-11-06 21:17:48 +0100639 efi_uintn_t map_size = 0;
Alexander Graf9b591022016-04-11 23:51:02 +0200640 int map_entries = 0;
Alexander Graf8623f922016-03-04 01:10:04 +0100641 struct list_head *lhandle;
Heinrich Schuchardt9b166462018-08-06 22:28:18 +0200642 efi_uintn_t provided_map_size;
Alexander Graf8623f922016-03-04 01:10:04 +0100643
Heinrich Schuchardte1a1a092018-07-02 12:53:54 +0200644 if (!memory_map_size)
645 return EFI_INVALID_PARAMETER;
646
Heinrich Schuchardt9b166462018-08-06 22:28:18 +0200647 provided_map_size = *memory_map_size;
648
Alexander Graf8623f922016-03-04 01:10:04 +0100649 list_for_each(lhandle, &efi_mem)
Alexander Graf9b591022016-04-11 23:51:02 +0200650 map_entries++;
651
652 map_size = map_entries * sizeof(struct efi_mem_desc);
Alexander Graf8623f922016-03-04 01:10:04 +0100653
Rob Clarka84c9742017-07-26 14:34:05 -0400654 *memory_map_size = map_size;
655
Alexander Graf8623f922016-03-04 01:10:04 +0100656 if (descriptor_size)
657 *descriptor_size = sizeof(struct efi_mem_desc);
658
Mian Yousaf Kaukab338cf562016-09-05 23:59:22 +0200659 if (descriptor_version)
660 *descriptor_version = EFI_MEMORY_DESCRIPTOR_VERSION;
661
AKASHI Takahiro3ee138d2020-03-11 15:18:18 +0900662 if (provided_map_size < map_size)
663 return EFI_BUFFER_TOO_SMALL;
664
665 if (!memory_map)
666 return EFI_INVALID_PARAMETER;
667
Alexander Graf8623f922016-03-04 01:10:04 +0100668 /* Copy list into array */
Heinrich Schuchardte1a1a092018-07-02 12:53:54 +0200669 /* Return the list in ascending order */
670 memory_map = &memory_map[map_entries - 1];
671 list_for_each(lhandle, &efi_mem) {
672 struct efi_mem_list *lmem;
Alexander Graf8623f922016-03-04 01:10:04 +0100673
Heinrich Schuchardte1a1a092018-07-02 12:53:54 +0200674 lmem = list_entry(lhandle, struct efi_mem_list, link);
675 *memory_map = lmem->desc;
676 memory_map--;
Alexander Graf8623f922016-03-04 01:10:04 +0100677 }
678
Heinrich Schuchardte1a1a092018-07-02 12:53:54 +0200679 if (map_key)
Heinrich Schuchardt0f233c42018-07-02 12:53:55 +0200680 *map_key = efi_memory_map_key;
xypron.glpk@gmx.dee436e632017-07-21 19:05:44 +0200681
Alexander Graf8623f922016-03-04 01:10:04 +0100682 return EFI_SUCCESS;
683}
684
Park, Aidene009e7a2019-09-03 17:43:43 +0000685/**
686 * efi_add_conventional_memory_map() - add a RAM memory area to the map
687 *
688 * @ram_start: start address of a RAM memory area
689 * @ram_end: end address of a RAM memory area
690 * @ram_top: max address to be used as conventional memory
691 * Return: status code
692 */
693efi_status_t efi_add_conventional_memory_map(u64 ram_start, u64 ram_end,
694 u64 ram_top)
695{
696 u64 pages;
697
698 /* Remove partial pages */
699 ram_end &= ~EFI_PAGE_MASK;
700 ram_start = (ram_start + EFI_PAGE_MASK) & ~EFI_PAGE_MASK;
701
702 if (ram_end <= ram_start) {
703 /* Invalid mapping */
704 return EFI_INVALID_PARAMETER;
705 }
706
707 pages = (ram_end - ram_start) >> EFI_PAGE_SHIFT;
708
Michael Walle282d3862020-05-17 12:29:19 +0200709 efi_add_memory_map_pg(ram_start, pages,
710 EFI_CONVENTIONAL_MEMORY, false);
Park, Aidene009e7a2019-09-03 17:43:43 +0000711
712 /*
713 * Boards may indicate to the U-Boot memory core that they
714 * can not support memory above ram_top. Let's honor this
715 * in the efi_loader subsystem too by declaring any memory
716 * above ram_top as "already occupied by firmware".
717 */
718 if (ram_top < ram_start) {
719 /* ram_top is before this region, reserve all */
Michael Walle282d3862020-05-17 12:29:19 +0200720 efi_add_memory_map_pg(ram_start, pages,
721 EFI_BOOT_SERVICES_DATA, true);
Park, Aidene009e7a2019-09-03 17:43:43 +0000722 } else if ((ram_top >= ram_start) && (ram_top < ram_end)) {
723 /* ram_top is inside this region, reserve parts */
724 pages = (ram_end - ram_top) >> EFI_PAGE_SHIFT;
725
Michael Walle282d3862020-05-17 12:29:19 +0200726 efi_add_memory_map_pg(ram_top, pages,
727 EFI_BOOT_SERVICES_DATA, true);
Park, Aidene009e7a2019-09-03 17:43:43 +0000728 }
729
730 return EFI_SUCCESS;
731}
732
York Suna8e9f0a2017-03-06 09:02:27 -0800733__weak void efi_add_known_memory(void)
Alexander Graf8623f922016-03-04 01:10:04 +0100734{
Alexander Grafc214edf2018-11-30 21:24:56 +0100735 u64 ram_top = board_get_usable_ram_top(0) & ~EFI_PAGE_MASK;
Alexander Graf8623f922016-03-04 01:10:04 +0100736 int i;
737
Heinrich Schuchardteb8edcf2019-01-05 23:41:36 +0100738 /*
739 * ram_top is just outside mapped memory. So use an offset of one for
740 * mapping the sandbox address.
741 */
742 ram_top = (uintptr_t)map_sysmem(ram_top - 1, 0) + 1;
743
Alexander Grafc214edf2018-11-30 21:24:56 +0100744 /* Fix for 32bit targets with ram_top at 4G */
745 if (!ram_top)
746 ram_top = 0x100000000ULL;
747
Alexander Graf8623f922016-03-04 01:10:04 +0100748 /* Add RAM */
749 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
Park, Aidene009e7a2019-09-03 17:43:43 +0000750 u64 ram_end, ram_start;
Heinrich Schuchardt084091a2018-11-12 18:55:24 +0100751
Heinrich Schuchardt6738fcd2018-11-18 17:58:46 +0100752 ram_start = (uintptr_t)map_sysmem(gd->bd->bi_dram[i].start, 0);
Heinrich Schuchardt084091a2018-11-12 18:55:24 +0100753 ram_end = ram_start + gd->bd->bi_dram[i].size;
754
Park, Aidene009e7a2019-09-03 17:43:43 +0000755 efi_add_conventional_memory_map(ram_start, ram_end, ram_top);
Alexander Graf8623f922016-03-04 01:10:04 +0100756 }
York Suna8e9f0a2017-03-06 09:02:27 -0800757}
758
Simon Glass78639432018-06-18 17:23:12 +0200759/* Add memory regions for U-Boot's memory and for the runtime services code */
760static void add_u_boot_and_runtime(void)
York Suna8e9f0a2017-03-06 09:02:27 -0800761{
762 unsigned long runtime_start, runtime_end, runtime_pages;
Alexander Graf15937a22018-09-17 13:54:33 +0200763 unsigned long runtime_mask = EFI_PAGE_MASK;
York Suna8e9f0a2017-03-06 09:02:27 -0800764 unsigned long uboot_start, uboot_pages;
Heinrich Schuchardtc6dcbe12020-07-29 12:37:35 +0200765 unsigned long uboot_stack_size = CONFIG_STACK_SIZE;
York Suna8e9f0a2017-03-06 09:02:27 -0800766
Alexander Graf8623f922016-03-04 01:10:04 +0100767 /* Add U-Boot */
Heinrich Schuchardta69976e2019-11-08 20:42:53 +0100768 uboot_start = ((uintptr_t)map_sysmem(gd->start_addr_sp, 0) -
769 uboot_stack_size) & ~EFI_PAGE_MASK;
770 uboot_pages = ((uintptr_t)map_sysmem(gd->ram_top - 1, 0) -
771 uboot_start + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
Michael Walle282d3862020-05-17 12:29:19 +0200772 efi_add_memory_map_pg(uboot_start, uboot_pages, EFI_LOADER_DATA,
773 false);
Alexander Graf8623f922016-03-04 01:10:04 +0100774
Alexander Graf15937a22018-09-17 13:54:33 +0200775#if defined(__aarch64__)
776 /*
777 * Runtime Services must be 64KiB aligned according to the
778 * "AArch64 Platforms" section in the UEFI spec (2.7+).
779 */
780
781 runtime_mask = SZ_64K - 1;
782#endif
783
784 /*
785 * Add Runtime Services. We mark surrounding boottime code as runtime as
786 * well to fulfill the runtime alignment constraints but avoid padding.
787 */
788 runtime_start = (ulong)&__efi_runtime_start & ~runtime_mask;
Alexander Graf8623f922016-03-04 01:10:04 +0100789 runtime_end = (ulong)&__efi_runtime_stop;
Alexander Graf15937a22018-09-17 13:54:33 +0200790 runtime_end = (runtime_end + runtime_mask) & ~runtime_mask;
Alexander Graf8623f922016-03-04 01:10:04 +0100791 runtime_pages = (runtime_end - runtime_start) >> EFI_PAGE_SHIFT;
Michael Walle282d3862020-05-17 12:29:19 +0200792 efi_add_memory_map_pg(runtime_start, runtime_pages,
793 EFI_RUNTIME_SERVICES_CODE, false);
Simon Glass78639432018-06-18 17:23:12 +0200794}
795
796int efi_memory_init(void)
797{
798 efi_add_known_memory();
799
Heinrich Schuchardta69976e2019-11-08 20:42:53 +0100800 add_u_boot_and_runtime();
Alexander Graf8623f922016-03-04 01:10:04 +0100801
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200802#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
803 /* Request a 32bit 64MB bounce buffer region */
804 uint64_t efi_bounce_buffer_addr = 0xffffffff;
805
Heinrich Schuchardt0f7186b2018-05-26 10:32:27 +0200806 if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, EFI_LOADER_DATA,
Alexander Graf7c00a3c2016-05-11 18:25:48 +0200807 (64 * 1024 * 1024) >> EFI_PAGE_SHIFT,
808 &efi_bounce_buffer_addr) != EFI_SUCCESS)
809 return -1;
810
811 efi_bounce_buffer = (void*)(uintptr_t)efi_bounce_buffer_addr;
812#endif
813
Alexander Graf8623f922016-03-04 01:10:04 +0100814 return 0;
815}