lib/efi_loader/efi_memory.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  EFI application memory management
   4  *
   5  *  Copyright (c) 2016 Alexander Graf
   6  */
   7
   8 #include <common.h>
   9 #include <efi_loader.h>
  10 #include <init.h>
  11 #include <malloc.h>
  12 #include <mapmem.h>
  13 #include <watchdog.h>
  14 #include <asm/cache.h>
  15 #include <linux/list_sort.h>
  16 #include <linux/sizes.h>
  17
  18 DECLARE_GLOBAL_DATA_PTR;
  19
  20 /* Magic number identifying memory allocated from pool */
  21 #define EFI_ALLOC_POOL_MAGIC 0x1fe67ddf6491caa2
  22
  23 efi_uintn_t efi_memory_map_key;
  24
  25 struct efi_mem_list {
  26         struct list_head link;
  27         struct efi_mem_desc desc;
  28 };
  29
  30 #define EFI_CARVE_NO_OVERLAP            -1
  31 #define EFI_CARVE_LOOP_AGAIN            -2
  32 #define EFI_CARVE_OVERLAPS_NONRAM       -3
  33
  34 /* This list contains all memory map items */
  35 LIST_HEAD(efi_mem);
  36
  37 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
  38 void *efi_bounce_buffer;
  39 #endif
  40
  41 /**
  42  * struct efi_pool_allocation - memory block allocated from pool
  43  *
  44  * @num_pages:  number of pages allocated
  45  * @checksum:   checksum
  46  * @data:       allocated pool memory
  47  *
  48  * U-Boot services each UEFI AllocatePool() request as a separate
  49  * (multiple) page allocation. We have to track the number of pages
  50  * to be able to free the correct amount later.
  51  *
  52  * The checksum calculated in function checksum() is used in FreePool() to avoid
  53  * freeing memory not allocated by AllocatePool() and duplicate freeing.
  54  *
  55  * EFI requires 8 byte alignment for pool allocations, so we can
  56  * prepend each allocation with these header fields.
  57  */
  58 struct efi_pool_allocation {
  59         u64 num_pages;
  60         u64 checksum;
  61         char data[] __aligned(ARCH_DMA_MINALIGN);
  62 };
  63
  64 /**
  65  * checksum() - calculate checksum for memory allocated from pool
  66  *
  67  * @alloc:      allocation header
  68  * Return:      checksum, always non-zero
  69  */
  70 static u64 checksum(struct efi_pool_allocation *alloc)
  71 {
  72         u64 addr = (uintptr_t)alloc;
  73         u64 ret = (addr >> 32) ^ (addr << 32) ^ alloc->num_pages ^
  74                   EFI_ALLOC_POOL_MAGIC;
  75         if (!ret)
  76                 ++ret;
  77         return ret;
  78 }
  79
  80 /*
  81  * Sorts the memory list from highest address to lowest address
  82  *
  83  * When allocating memory we should always start from the highest
  84  * address chunk, so sort the memory list such that the first list
  85  * iterator gets the highest address and goes lower from there.
  86  */
  87 static int efi_mem_cmp(void *priv, struct list_head *a, struct list_head *b)
  88 {
  89         struct efi_mem_list *mema = list_entry(a, struct efi_mem_list, link);
  90         struct efi_mem_list *memb = list_entry(b, struct efi_mem_list, link);
  91
  92         if (mema->desc.physical_start == memb->desc.physical_start)
  93                 return 0;
  94         else if (mema->desc.physical_start < memb->desc.physical_start)
  95                 return 1;
  96         else
  97                 return -1;
  98 }
  99
 100 static uint64_t desc_get_end(struct efi_mem_desc *desc)
 101 {
 102         return desc->physical_start + (desc->num_pages << EFI_PAGE_SHIFT);
 103 }
 104
 105 static void efi_mem_sort(void)
 106 {
 107         struct list_head *lhandle;
 108         struct efi_mem_list *prevmem = NULL;
 109         bool merge_again = true;
 110
 111         list_sort(NULL, &efi_mem, efi_mem_cmp);
 112
 113         /* Now merge entries that can be merged */
 114         while (merge_again) {
 115                 merge_again = false;
 116                 list_for_each(lhandle, &efi_mem) {
 117                         struct efi_mem_list *lmem;
 118                         struct efi_mem_desc *prev = &prevmem->desc;
 119                         struct efi_mem_desc *cur;
 120                         uint64_t pages;
 121
 122                         lmem = list_entry(lhandle, struct efi_mem_list, link);
 123                         if (!prevmem) {
 124                                 prevmem = lmem;
 125                                 continue;
 126                         }
 127
 128                         cur = &lmem->desc;
 129
 130                         if ((desc_get_end(cur) == prev->physical_start) &&
 131                             (prev->type == cur->type) &&
 132                             (prev->attribute == cur->attribute)) {
 133                                 /* There is an existing map before, reuse it */
 134                                 pages = cur->num_pages;
 135                                 prev->num_pages += pages;
 136                                 prev->physical_start -= pages << EFI_PAGE_SHIFT;
 137                                 prev->virtual_start -= pages << EFI_PAGE_SHIFT;
 138                                 list_del(&lmem->link);
 139                                 free(lmem);
 140
 141                                 merge_again = true;
 142                                 break;
 143                         }
 144
 145                         prevmem = lmem;
 146                 }
 147         }
 148 }
 149
 150 /** efi_mem_carve_out - unmap memory region
 151  *
 152  * @map:                memory map
 153  * @carve_desc:         memory region to unmap
 154  * @overlap_only_ram:   the carved out region may only overlap RAM
 155  * Return Value:        the number of overlapping pages which have been
 156  *                      removed from the map,
 157  *                      EFI_CARVE_NO_OVERLAP, if the regions don't overlap,
 158  *                      EFI_CARVE_OVERLAPS_NONRAM, if the carve and map overlap,
 159  *                      and the map contains anything but free ram
 160  *                      (only when overlap_only_ram is true),
 161  *                      EFI_CARVE_LOOP_AGAIN, if the mapping list should be
 162  *                      traversed again, as it has been altered.
 163  *
 164  * Unmaps all memory occupied by the carve_desc region from the list entry
 165  * pointed to by map.
 166  *
 167  * In case of EFI_CARVE_OVERLAPS_NONRAM it is the callers responsibility
 168  * to re-add the already carved out pages to the mapping.
 169  */
 170 static s64 efi_mem_carve_out(struct efi_mem_list *map,
 171                              struct efi_mem_desc *carve_desc,
 172                              bool overlap_only_ram)
 173 {
 174         struct efi_mem_list *newmap;
 175         struct efi_mem_desc *map_desc = &map->desc;
 176         uint64_t map_start = map_desc->physical_start;
 177         uint64_t map_end = map_start + (map_desc->num_pages << EFI_PAGE_SHIFT);
 178         uint64_t carve_start = carve_desc->physical_start;
 179         uint64_t carve_end = carve_start +
 180                              (carve_desc->num_pages << EFI_PAGE_SHIFT);
 181
 182         /* check whether we're overlapping */
 183         if ((carve_end <= map_start) || (carve_start >= map_end))
 184                 return EFI_CARVE_NO_OVERLAP;
 185
 186         /* We're overlapping with non-RAM, warn the caller if desired */
 187         if (overlap_only_ram && (map_desc->type != EFI_CONVENTIONAL_MEMORY))
 188                 return EFI_CARVE_OVERLAPS_NONRAM;
 189
 190         /* Sanitize carve_start and carve_end to lie within our bounds */
 191         carve_start = max(carve_start, map_start);
 192         carve_end = min(carve_end, map_end);
 193
 194         /* Carving at the beginning of our map? Just move it! */
 195         if (carve_start == map_start) {
 196                 if (map_end == carve_end) {
 197                         /* Full overlap, just remove map */
 198                         list_del(&map->link);
 199                         free(map);
 200                 } else {
 201                         map->desc.physical_start = carve_end;
 202                         map->desc.virtual_start = carve_end;
 203                         map->desc.num_pages = (map_end - carve_end)
 204                                               >> EFI_PAGE_SHIFT;
 205                 }
 206
 207                 return (carve_end - carve_start) >> EFI_PAGE_SHIFT;
 208         }
 209
 210         /*
 211          * Overlapping maps, just split the list map at carve_start,
 212          * it will get moved or removed in the next iteration.
 213          *
 214          * [ map_desc |__carve_start__| newmap ]
 215          */
 216
 217         /* Create a new map from [ carve_start ... map_end ] */
 218         newmap = calloc(1, sizeof(*newmap));
 219         newmap->desc = map->desc;
 220         newmap->desc.physical_start = carve_start;
 221         newmap->desc.virtual_start = carve_start;
 222         newmap->desc.num_pages = (map_end - carve_start) >> EFI_PAGE_SHIFT;
 223         /* Insert before current entry (descending address order) */
 224         list_add_tail(&newmap->link, &map->link);
 225
 226         /* Shrink the map to [ map_start ... carve_start ] */
 227         map_desc->num_pages = (carve_start - map_start) >> EFI_PAGE_SHIFT;
 228
 229         return EFI_CARVE_LOOP_AGAIN;
 230 }
 231
 232 /**
 233  * efi_add_memory_map_pg() - add pages to the memory map
 234  *
 235  * @start:              start address, must be a multiple of EFI_PAGE_SIZE
 236  * @pages:              number of pages to add
 237  * @memory_type:        type of memory added
 238  * @overlap_only_ram:   the memory area must overlap existing
 239  * Return:              status code
 240  */
 241 static efi_status_t efi_add_memory_map_pg(u64 start, u64 pages,
 242                                           int memory_type,
 243                                           bool overlap_only_ram)
 244 {
 245         struct list_head *lhandle;
 246         struct efi_mem_list *newlist;
 247         bool carve_again;
 248         uint64_t carved_pages = 0;
 249         struct efi_event *evt;
 250
 251         EFI_PRINT("%s: 0x%llx 0x%llx %d %s\n", __func__,
 252                   start, pages, memory_type, overlap_only_ram ? "yes" : "no");
 253
 254         if (memory_type >= EFI_MAX_MEMORY_TYPE)
 255                 return EFI_INVALID_PARAMETER;
 256
 257         if (!pages)
 258                 return EFI_SUCCESS;
 259
 260         ++efi_memory_map_key;
 261         newlist = calloc(1, sizeof(*newlist));
 262         newlist->desc.type = memory_type;
 263         newlist->desc.physical_start = start;
 264         newlist->desc.virtual_start = start;
 265         newlist->desc.num_pages = pages;
 266
 267         switch (memory_type) {
 268         case EFI_RUNTIME_SERVICES_CODE:
 269         case EFI_RUNTIME_SERVICES_DATA:
 270                 newlist->desc.attribute = EFI_MEMORY_WB | EFI_MEMORY_RUNTIME;
 271                 break;
 272         case EFI_MMAP_IO:
 273                 newlist->desc.attribute = EFI_MEMORY_RUNTIME;
 274                 break;
 275         default:
 276                 newlist->desc.attribute = EFI_MEMORY_WB;
 277                 break;
 278         }
 279
 280         /* Add our new map */
 281         do {
 282                 carve_again = false;
 283                 list_for_each(lhandle, &efi_mem) {
 284                         struct efi_mem_list *lmem;
 285                         s64 r;
 286
 287                         lmem = list_entry(lhandle, struct efi_mem_list, link);
 288                         r = efi_mem_carve_out(lmem, &newlist->desc,
 289                                               overlap_only_ram);
 290                         switch (r) {
 291                         case EFI_CARVE_OVERLAPS_NONRAM:
 292                                 /*
 293                                  * The user requested to only have RAM overlaps,
 294                                  * but we hit a non-RAM region. Error out.
 295                                  */
 296                                 return EFI_NO_MAPPING;
 297                         case EFI_CARVE_NO_OVERLAP:
 298                                 /* Just ignore this list entry */
 299                                 break;
 300                         case EFI_CARVE_LOOP_AGAIN:
 301                                 /*
 302                                  * We split an entry, but need to loop through
 303                                  * the list again to actually carve it.
 304                                  */
 305                                 carve_again = true;
 306                                 break;
 307                         default:
 308                                 /* We carved a number of pages */
 309                                 carved_pages += r;
 310                                 carve_again = true;
 311                                 break;
 312                         }
 313
 314                         if (carve_again) {
 315                                 /* The list changed, we need to start over */
 316                                 break;
 317                         }
 318                 }
 319         } while (carve_again);
 320
 321         if (overlap_only_ram && (carved_pages != pages)) {
 322                 /*
 323                  * The payload wanted to have RAM overlaps, but we overlapped
 324                  * with an unallocated region. Error out.
 325                  */
 326                 return EFI_NO_MAPPING;
 327         }
 328
 329         /* Add our new map */
 330         list_add_tail(&newlist->link, &efi_mem);
 331
 332         /* And make sure memory is listed in descending order */
 333         efi_mem_sort();
 334
 335         /* Notify that the memory map was changed */
 336         list_for_each_entry(evt, &efi_events, link) {
 337                 if (evt->group &&
 338                     !guidcmp(evt->group,
 339                              &efi_guid_event_group_memory_map_change)) {
 340                         efi_signal_event(evt);
 341                         break;
 342                 }
 343         }
 344
 345         return EFI_SUCCESS;
 346 }
 347
 348 /**
 349  * efi_add_memory_map() - add memory area to the memory map
 350  *
 351  * @start:              start address of the memory area
 352  * @size:               length in bytes of the memory area
 353  * @memory_type:        type of memory added
 354  *
 355  * Return:              status code
 356  *
 357  * This function automatically aligns the start and size of the memory area
 358  * to EFI_PAGE_SIZE.
 359  */
 360 efi_status_t efi_add_memory_map(u64 start, u64 size, int memory_type)
 361 {
 362         u64 pages;
 363
 364         pages = efi_size_in_pages(size + (start & EFI_PAGE_MASK));
 365         start &= ~EFI_PAGE_MASK;
 366
 367         return efi_add_memory_map_pg(start, pages, memory_type, false);
 368 }
 369
 370 /**
 371  * efi_check_allocated() - validate address to be freed
 372  *
 373  * Check that the address is within allocated memory:
 374  *
 375  * * The address must be in a range of the memory map.
 376  * * The address may not point to EFI_CONVENTIONAL_MEMORY.
 377  *
 378  * Page alignment is not checked as this is not a requirement of
 379  * efi_free_pool().
 380  *
 381  * @addr:               address of page to be freed
 382  * @must_be_allocated:  return success if the page is allocated
 383  * Return:              status code
 384  */
 385 static efi_status_t efi_check_allocated(u64 addr, bool must_be_allocated)
 386 {
 387         struct efi_mem_list *item;
 388
 389         list_for_each_entry(item, &efi_mem, link) {
 390                 u64 start = item->desc.physical_start;
 391                 u64 end = start + (item->desc.num_pages << EFI_PAGE_SHIFT);
 392
 393                 if (addr >= start && addr < end) {
 394                         if (must_be_allocated ^
 395                             (item->desc.type == EFI_CONVENTIONAL_MEMORY))
 396                                 return EFI_SUCCESS;
 397                         else
 398                                 return EFI_NOT_FOUND;
 399                 }
 400         }
 401
 402         return EFI_NOT_FOUND;
 403 }
 404
 405 static uint64_t efi_find_free_memory(uint64_t len, uint64_t max_addr)
 406 {
 407         struct list_head *lhandle;
 408
 409         /*
 410          * Prealign input max address, so we simplify our matching
 411          * logic below and can just reuse it as return pointer.
 412          */
 413         max_addr &= ~EFI_PAGE_MASK;
 414
 415         list_for_each(lhandle, &efi_mem) {
 416                 struct efi_mem_list *lmem = list_entry(lhandle,
 417                         struct efi_mem_list, link);
 418                 struct efi_mem_desc *desc = &lmem->desc;
 419                 uint64_t desc_len = desc->num_pages << EFI_PAGE_SHIFT;
 420                 uint64_t desc_end = desc->physical_start + desc_len;
 421                 uint64_t curmax = min(max_addr, desc_end);
 422                 uint64_t ret = curmax - len;
 423
 424                 /* We only take memory from free RAM */
 425                 if (desc->type != EFI_CONVENTIONAL_MEMORY)
 426                         continue;
 427
 428                 /* Out of bounds for max_addr */
 429                 if ((ret + len) > max_addr)
 430                         continue;
 431
 432                 /* Out of bounds for upper map limit */
 433                 if ((ret + len) > desc_end)
 434                         continue;
 435
 436                 /* Out of bounds for lower map limit */
 437                 if (ret < desc->physical_start)
 438                         continue;
 439
 440                 /* Return the highest address in this map within bounds */
 441                 return ret;
 442         }
 443
 444         return 0;
 445 }
 446
 447 /*
 448  * Allocate memory pages.
 449  *
 450  * @type                type of allocation to be performed
 451  * @memory_type         usage type of the allocated memory
 452  * @pages               number of pages to be allocated
 453  * @memory              allocated memory
 454  * @return              status code
 455  */
 456 efi_status_t efi_allocate_pages(int type, int memory_type,
 457                                 efi_uintn_t pages, uint64_t *memory)
 458 {
 459         u64 len = pages << EFI_PAGE_SHIFT;
 460         efi_status_t ret;
 461         uint64_t addr;
 462
 463         /* Check import parameters */
 464         if (memory_type >= EFI_PERSISTENT_MEMORY_TYPE &&
 465             memory_type <= 0x6FFFFFFF)
 466                 return EFI_INVALID_PARAMETER;
 467         if (!memory)
 468                 return EFI_INVALID_PARAMETER;
 469
 470         switch (type) {
 471         case EFI_ALLOCATE_ANY_PAGES:
 472                 /* Any page */
 473                 addr = efi_find_free_memory(len, -1ULL);
 474                 if (!addr)
 475                         return EFI_OUT_OF_RESOURCES;
 476                 break;
 477         case EFI_ALLOCATE_MAX_ADDRESS:
 478                 /* Max address */
 479                 addr = efi_find_free_memory(len, *memory);
 480                 if (!addr)
 481                         return EFI_OUT_OF_RESOURCES;
 482                 break;
 483         case EFI_ALLOCATE_ADDRESS:
 484                 /* Exact address, reserve it. The addr is already in *memory. */
 485                 ret = efi_check_allocated(*memory, false);
 486                 if (ret != EFI_SUCCESS)
 487                         return EFI_NOT_FOUND;
 488                 addr = *memory;
 489                 break;
 490         default:
 491                 /* UEFI doesn't specify other allocation types */
 492                 return EFI_INVALID_PARAMETER;
 493         }
 494
 495         /* Reserve that map in our memory maps */
 496         ret = efi_add_memory_map_pg(addr, pages, memory_type, true);
 497         if (ret != EFI_SUCCESS)
 498                 /* Map would overlap, bail out */
 499                 return  EFI_OUT_OF_RESOURCES;
 500
 501         *memory = addr;
 502
 503         return EFI_SUCCESS;
 504 }
 505
 506 void *efi_alloc(uint64_t len, int memory_type)
 507 {
 508         uint64_t ret = 0;
 509         uint64_t pages = efi_size_in_pages(len);
 510         efi_status_t r;
 511
 512         r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, memory_type, pages,
 513                                &ret);
 514         if (r == EFI_SUCCESS)
 515                 return (void*)(uintptr_t)ret;
 516
 517         return NULL;
 518 }
 519
 520 /**
 521  * efi_free_pages() - free memory pages
 522  *
 523  * @memory:     start of the memory area to be freed
 524  * @pages:      number of pages to be freed
 525  * Return:      status code
 526  */
 527 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages)
 528 {
 529         efi_status_t ret;
 530
 531         ret = efi_check_allocated(memory, true);
 532         if (ret != EFI_SUCCESS)
 533                 return ret;
 534
 535         /* Sanity check */
 536         if (!memory || (memory & EFI_PAGE_MASK) || !pages) {
 537                 printf("%s: illegal free 0x%llx, 0x%zx\n", __func__,
 538                        memory, pages);
 539                 return EFI_INVALID_PARAMETER;
 540         }
 541
 542         ret = efi_add_memory_map_pg(memory, pages, EFI_CONVENTIONAL_MEMORY,
 543                                     false);
 544         /* Merging of adjacent free regions is missing */
 545
 546         if (ret != EFI_SUCCESS)
 547                 return EFI_NOT_FOUND;
 548
 549         return ret;
 550 }
 551
 552 /**
 553  * efi_allocate_pool - allocate memory from pool
 554  *
 555  * @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
 559  */
 560 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size, void **buffer)
 561 {
 562         efi_status_t r;
 563         u64 addr;
 564         struct efi_pool_allocation *alloc;
 565         u64 num_pages = efi_size_in_pages(size +
 566                                           sizeof(struct efi_pool_allocation));
 567
 568         if (!buffer)
 569                 return EFI_INVALID_PARAMETER;
 570
 571         if (size == 0) {
 572                 *buffer = NULL;
 573                 return EFI_SUCCESS;
 574         }
 575
 576         r = efi_allocate_pages(EFI_ALLOCATE_ANY_PAGES, pool_type, num_pages,
 577                                &addr);
 578         if (r == EFI_SUCCESS) {
 579                 alloc = (struct efi_pool_allocation *)(uintptr_t)addr;
 580                 alloc->num_pages = num_pages;
 581                 alloc->checksum = checksum(alloc);
 582                 *buffer = alloc->data;
 583         }
 584
 585         return r;
 586 }
 587
 588 /**
 589  * efi_free_pool() - free memory from pool
 590  *
 591  * @buffer:     start of memory to be freed
 592  * Return:      status code
 593  */
 594 efi_status_t efi_free_pool(void *buffer)
 595 {
 596         efi_status_t ret;
 597         struct efi_pool_allocation *alloc;
 598
 599         if (!buffer)
 600                 return EFI_INVALID_PARAMETER;
 601
 602         ret = efi_check_allocated((uintptr_t)buffer, true);
 603         if (ret != EFI_SUCCESS)
 604                 return ret;
 605
 606         alloc = container_of(buffer, struct efi_pool_allocation, data);
 607
 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;
 616
 617         ret = efi_free_pages((uintptr_t)alloc, alloc->num_pages);
 618
 619         return ret;
 620 }
 621
 622 /*
 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  */
 633 efi_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)
 638 {
 639         efi_uintn_t map_size = 0;
 640         int map_entries = 0;
 641         struct list_head *lhandle;
 642         efi_uintn_t provided_map_size;
 643
 644         if (!memory_map_size)
 645                 return EFI_INVALID_PARAMETER;
 646
 647         provided_map_size = *memory_map_size;
 648
 649         list_for_each(lhandle, &efi_mem)
 650                 map_entries++;
 651
 652         map_size = map_entries * sizeof(struct efi_mem_desc);
 653
 654         *memory_map_size = map_size;
 655
 656         if (descriptor_size)
 657                 *descriptor_size = sizeof(struct efi_mem_desc);
 658
 659         if (descriptor_version)
 660                 *descriptor_version = EFI_MEMORY_DESCRIPTOR_VERSION;
 661
 662         if (provided_map_size < map_size)
 663                 return EFI_BUFFER_TOO_SMALL;
 664
 665         if (!memory_map)
 666                 return EFI_INVALID_PARAMETER;
 667
 668         /* Copy list into array */
 669         /* 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;
 673
 674                 lmem = list_entry(lhandle, struct efi_mem_list, link);
 675                 *memory_map = lmem->desc;
 676                 memory_map--;
 677         }
 678
 679         if (map_key)
 680                 *map_key = efi_memory_map_key;
 681
 682         return EFI_SUCCESS;
 683 }
 684
 685 /**
 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  */
 693 efi_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
 709         efi_add_memory_map_pg(ram_start, pages,
 710                               EFI_CONVENTIONAL_MEMORY, false);
 711
 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 */
 720                 efi_add_memory_map_pg(ram_start, pages,
 721                                       EFI_BOOT_SERVICES_DATA, true);
 722         } 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
 726                 efi_add_memory_map_pg(ram_top, pages,
 727                                       EFI_BOOT_SERVICES_DATA, true);
 728         }
 729
 730         return EFI_SUCCESS;
 731 }
 732
 733 __weak void efi_add_known_memory(void)
 734 {
 735         u64 ram_top = board_get_usable_ram_top(0) & ~EFI_PAGE_MASK;
 736         int i;
 737
 738         /*
 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
 744         /* Fix for 32bit targets with ram_top at 4G */
 745         if (!ram_top)
 746                 ram_top = 0x100000000ULL;
 747
 748         /* Add RAM */
 749         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 750                 u64 ram_end, ram_start;
 751
 752                 ram_start = (uintptr_t)map_sysmem(gd->bd->bi_dram[i].start, 0);
 753                 ram_end = ram_start + gd->bd->bi_dram[i].size;
 754
 755                 efi_add_conventional_memory_map(ram_start, ram_end, ram_top);
 756         }
 757 }
 758
 759 /* Add memory regions for U-Boot's memory and for the runtime services code */
 760 static void add_u_boot_and_runtime(void)
 761 {
 762         unsigned long runtime_start, runtime_end, runtime_pages;
 763         unsigned long runtime_mask = EFI_PAGE_MASK;
 764         unsigned long uboot_start, uboot_pages;
 765         unsigned long uboot_stack_size = 16 * 1024 * 1024;
 766
 767         /* Add U-Boot */
 768         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;
 772         efi_add_memory_map_pg(uboot_start, uboot_pages, EFI_LOADER_DATA,
 773                               false);
 774
 775 #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;
 789         runtime_end = (ulong)&__efi_runtime_stop;
 790         runtime_end = (runtime_end + runtime_mask) & ~runtime_mask;
 791         runtime_pages = (runtime_end - runtime_start) >> EFI_PAGE_SHIFT;
 792         efi_add_memory_map_pg(runtime_start, runtime_pages,
 793                               EFI_RUNTIME_SERVICES_CODE, false);
 794 }
 795
 796 int efi_memory_init(void)
 797 {
 798         efi_add_known_memory();
 799
 800         add_u_boot_and_runtime();
 801
 802 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
 803         /* Request a 32bit 64MB bounce buffer region */
 804         uint64_t efi_bounce_buffer_addr = 0xffffffff;
 805
 806         if (efi_allocate_pages(EFI_ALLOCATE_MAX_ADDRESS, EFI_LOADER_DATA,
 807                                (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
 814         return 0;
 815 }