1 // SPDX-License-Identifier: GPL-2.0+
3 * Procedures for maintaining information about logical memory blocks.
5 * Peter Bergner, IBM Corp. June 2001.
6 * Copyright (C) 2001 Peter Bergner.
10 #include <efi_loader.h>
19 #include <asm/global_data.h>
20 #include <asm/sections.h>
21 #include <linux/kernel.h>
22 #include <linux/sizes.h>
24 DECLARE_GLOBAL_DATA_PTR;
26 #define MAP_OP_RESERVE (u8)0x1
27 #define MAP_OP_FREE (u8)0x2
28 #define MAP_OP_ADD (u8)0x3
31 * The following low level LMB functions must not access the global LMB memory
32 * map since they are also used to manage IOVA memory maps in iommu drivers like
36 static long lmb_addrs_overlap(phys_addr_t base1, phys_size_t size1,
37 phys_addr_t base2, phys_size_t size2)
39 const phys_addr_t base1_end = base1 + size1 - 1;
40 const phys_addr_t base2_end = base2 + size2 - 1;
42 return ((base1 <= base2_end) && (base2 <= base1_end));
45 static long lmb_addrs_adjacent(phys_addr_t base1, phys_size_t size1,
46 phys_addr_t base2, phys_size_t size2)
48 if (base2 == base1 + size1)
50 else if (base1 == base2 + size2)
56 static long lmb_regions_overlap(struct alist *lmb_rgn_lst, unsigned long r1,
59 struct lmb_region *rgn = lmb_rgn_lst->data;
60 phys_addr_t base1 = rgn[r1].base;
61 phys_size_t size1 = rgn[r1].size;
62 phys_addr_t base2 = rgn[r2].base;
63 phys_size_t size2 = rgn[r2].size;
65 return lmb_addrs_overlap(base1, size1, base2, size2);
68 static long lmb_regions_adjacent(struct alist *lmb_rgn_lst, unsigned long r1,
71 struct lmb_region *rgn = lmb_rgn_lst->data;
72 phys_addr_t base1 = rgn[r1].base;
73 phys_size_t size1 = rgn[r1].size;
74 phys_addr_t base2 = rgn[r2].base;
75 phys_size_t size2 = rgn[r2].size;
77 return lmb_addrs_adjacent(base1, size1, base2, size2);
80 static void lmb_remove_region(struct alist *lmb_rgn_lst, unsigned long r)
83 struct lmb_region *rgn = lmb_rgn_lst->data;
85 for (i = r; i < lmb_rgn_lst->count - 1; i++) {
86 rgn[i].base = rgn[i + 1].base;
87 rgn[i].size = rgn[i + 1].size;
88 rgn[i].flags = rgn[i + 1].flags;
93 /* Assumption: base addr of region 1 < base addr of region 2 */
94 static void lmb_coalesce_regions(struct alist *lmb_rgn_lst, unsigned long r1,
97 struct lmb_region *rgn = lmb_rgn_lst->data;
99 rgn[r1].size += rgn[r2].size;
100 lmb_remove_region(lmb_rgn_lst, r2);
103 /*Assumption : base addr of region 1 < base addr of region 2*/
104 static void lmb_fix_over_lap_regions(struct alist *lmb_rgn_lst,
105 unsigned long r1, unsigned long r2)
107 struct lmb_region *rgn = lmb_rgn_lst->data;
109 phys_addr_t base1 = rgn[r1].base;
110 phys_size_t size1 = rgn[r1].size;
111 phys_addr_t base2 = rgn[r2].base;
112 phys_size_t size2 = rgn[r2].size;
114 if (base1 + size1 > base2 + size2) {
115 printf("This will not be a case any time\n");
118 rgn[r1].size = base2 + size2 - base1;
119 lmb_remove_region(lmb_rgn_lst, r2);
122 static long lmb_resize_regions(struct alist *lmb_rgn_lst,
123 unsigned long idx_start,
124 phys_addr_t base, phys_size_t size)
127 unsigned long rgn_cnt, idx, idx_end;
128 phys_addr_t rgnbase, rgnend;
129 phys_addr_t mergebase, mergeend;
130 struct lmb_region *rgn = lmb_rgn_lst->data;
137 * First thing to do is to identify how many regions
138 * the requested region overlaps.
139 * If the flags match, combine all these overlapping
140 * regions into a single region, and remove the merged
143 while (idx <= lmb_rgn_lst->count - 1) {
144 rgnbase = rgn[idx].base;
145 rgnsize = rgn[idx].size;
147 if (lmb_addrs_overlap(base, size, rgnbase,
149 if (rgn[idx].flags != LMB_NONE)
157 /* The merged region's base and size */
158 rgnbase = rgn[idx_start].base;
159 mergebase = min(base, rgnbase);
160 rgnend = rgn[idx_end].base + rgn[idx_end].size;
161 mergeend = max(rgnend, (base + size));
163 rgn[idx_start].base = mergebase;
164 rgn[idx_start].size = mergeend - mergebase;
166 /* Now remove the merged regions */
168 lmb_remove_region(lmb_rgn_lst, idx_start + 1);
174 * lmb_add_region_flags() - Add an lmb region to the given list
175 * @lmb_rgn_lst: LMB list to which region is to be added(free/used)
176 * @base: Start address of the region
177 * @size: Size of the region to be added
178 * @flags: Attributes of the LMB region
180 * Add a region of memory to the list. If the region does not exist, add
181 * it to the list. Depending on the attributes of the region to be added,
182 * the function might resize an already existing region or coalesce two
186 * * %0 - Added successfully, or it's already added (only if LMB_NONE)
187 * * %-EEXIST - The region is already added, and flags != LMB_NONE
190 static long lmb_add_region_flags(struct alist *lmb_rgn_lst, phys_addr_t base,
191 phys_size_t size, u32 flags)
193 unsigned long coalesced = 0;
195 struct lmb_region *rgn = lmb_rgn_lst->data;
197 if (alist_err(lmb_rgn_lst))
200 /* First try and coalesce this LMB with another. */
201 for (i = 0; i < lmb_rgn_lst->count; i++) {
202 phys_addr_t rgnbase = rgn[i].base;
203 phys_size_t rgnsize = rgn[i].size;
204 u32 rgnflags = rgn[i].flags;
206 ret = lmb_addrs_adjacent(base, size, rgnbase, rgnsize);
208 if (flags != rgnflags)
214 } else if (ret < 0) {
215 if (flags != rgnflags)
220 } else if (lmb_addrs_overlap(base, size, rgnbase, rgnsize)) {
221 if (flags != LMB_NONE)
224 ret = lmb_resize_regions(lmb_rgn_lst, i, base, size);
235 if (lmb_rgn_lst->count && i < lmb_rgn_lst->count - 1) {
236 rgn = lmb_rgn_lst->data;
237 if (rgn[i].flags == rgn[i + 1].flags) {
238 if (lmb_regions_adjacent(lmb_rgn_lst, i, i + 1)) {
239 lmb_coalesce_regions(lmb_rgn_lst, i, i + 1);
241 } else if (lmb_regions_overlap(lmb_rgn_lst, i, i + 1)) {
242 /* fix overlapping area */
243 lmb_fix_over_lap_regions(lmb_rgn_lst, i, i + 1);
252 if (alist_full(lmb_rgn_lst) &&
253 !alist_expand_by(lmb_rgn_lst, lmb_rgn_lst->alloc))
255 rgn = lmb_rgn_lst->data;
257 /* Couldn't coalesce the LMB, so add it to the sorted table. */
258 for (i = lmb_rgn_lst->count; i >= 0; i--) {
259 if (i && base < rgn[i - 1].base) {
264 rgn[i].flags = flags;
269 lmb_rgn_lst->count++;
274 static long _lmb_free(struct alist *lmb_rgn_lst, phys_addr_t base,
277 struct lmb_region *rgn;
278 phys_addr_t rgnbegin, rgnend;
279 phys_addr_t end = base + size - 1;
282 /* Suppress GCC warnings */
286 rgn = lmb_rgn_lst->data;
287 /* Find the region where (base, size) belongs to */
288 for (i = 0; i < lmb_rgn_lst->count; i++) {
289 rgnbegin = rgn[i].base;
290 rgnend = rgnbegin + rgn[i].size - 1;
292 if (rgnbegin <= base && end <= rgnend)
296 /* Didn't find the region */
297 if (i == lmb_rgn_lst->count)
300 /* Check to see if we are removing entire region */
301 if (rgnbegin == base && rgnend == end) {
302 lmb_remove_region(lmb_rgn_lst, i);
306 /* Check to see if region is matching at the front */
307 if (rgnbegin == base) {
308 rgn[i].base = end + 1;
313 /* Check to see if the region is matching at the end */
320 * We need to split the entry - adjust the current one to the
321 * beginging of the hole and add the region after hole.
323 rgn[i].size = base - rgn[i].base;
324 return lmb_add_region_flags(lmb_rgn_lst, end + 1, rgnend - end,
328 static long lmb_overlaps_region(struct alist *lmb_rgn_lst, phys_addr_t base,
332 struct lmb_region *rgn = lmb_rgn_lst->data;
334 for (i = 0; i < lmb_rgn_lst->count; i++) {
335 phys_addr_t rgnbase = rgn[i].base;
336 phys_size_t rgnsize = rgn[i].size;
338 if (lmb_addrs_overlap(base, size, rgnbase, rgnsize))
342 return (i < lmb_rgn_lst->count) ? i : -1;
346 * IOVA LMB memory maps using lmb pointers instead of the global LMB memory map.
349 int io_lmb_setup(struct lmb *io_lmb)
353 ret = alist_init(&io_lmb->available_mem, sizeof(struct lmb_region),
354 (uint)LMB_ALIST_INITIAL_SIZE);
356 log_debug("Unable to initialise the list for LMB free IOVA\n");
360 ret = alist_init(&io_lmb->used_mem, sizeof(struct lmb_region),
361 (uint)LMB_ALIST_INITIAL_SIZE);
363 log_debug("Unable to initialise the list for LMB used IOVA\n");
367 io_lmb->test = false;
372 void io_lmb_teardown(struct lmb *io_lmb)
374 alist_uninit(&io_lmb->available_mem);
375 alist_uninit(&io_lmb->used_mem);
378 long io_lmb_add(struct lmb *io_lmb, phys_addr_t base, phys_size_t size)
380 return lmb_add_region_flags(&io_lmb->available_mem, base, size, LMB_NONE);
383 /* derived and simplified from _lmb_alloc_base() */
384 phys_addr_t io_lmb_alloc(struct lmb *io_lmb, phys_size_t size, ulong align)
387 phys_addr_t base = 0;
388 phys_addr_t res_base;
389 struct lmb_region *lmb_used = io_lmb->used_mem.data;
390 struct lmb_region *lmb_memory = io_lmb->available_mem.data;
392 for (i = io_lmb->available_mem.count - 1; i >= 0; i--) {
393 phys_addr_t lmbbase = lmb_memory[i].base;
394 phys_size_t lmbsize = lmb_memory[i].size;
398 base = ALIGN_DOWN(lmbbase + lmbsize - size, align);
400 while (base && lmbbase <= base) {
401 rgn = lmb_overlaps_region(&io_lmb->used_mem, base, size);
403 /* This area isn't reserved, take it */
404 if (lmb_add_region_flags(&io_lmb->used_mem, base,
411 res_base = lmb_used[rgn].base;
414 base = ALIGN_DOWN(res_base - size, align);
420 long io_lmb_free(struct lmb *io_lmb, phys_addr_t base, phys_size_t size)
422 return _lmb_free(&io_lmb->used_mem, base, size);
426 * Low level LMB functions are used to manage IOVA memory maps for the Apple
427 * dart iommu. They must not access the global LMB memory map.
428 * So keep the global LMB variable declaration unreachable from them.
431 static struct lmb lmb;
433 static bool lmb_should_notify(u32 flags)
435 return !lmb.test && !(flags & LMB_NONOTIFY) &&
436 CONFIG_IS_ENABLED(EFI_LOADER);
439 static int lmb_map_update_notify(phys_addr_t addr, phys_size_t size, u8 op,
446 if (op != MAP_OP_RESERVE && op != MAP_OP_FREE && op != MAP_OP_ADD) {
447 log_err("Invalid map update op received (%d)\n", op);
451 if (!lmb_should_notify(flags))
454 efi_addr = (uintptr_t)map_sysmem(addr, 0);
455 pages = efi_size_in_pages(size + (efi_addr & EFI_PAGE_MASK));
456 efi_addr &= ~EFI_PAGE_MASK;
458 status = efi_add_memory_map_pg(efi_addr, pages,
459 op == MAP_OP_RESERVE ?
460 EFI_BOOT_SERVICES_DATA :
461 EFI_CONVENTIONAL_MEMORY,
463 if (status != EFI_SUCCESS) {
464 log_err("%s: LMB Map notify failure %lu\n", __func__,
465 status & ~EFI_ERROR_MASK);
468 unmap_sysmem((void *)(uintptr_t)efi_addr);
473 static void lmb_print_region_flags(u32 flags)
475 const char * const flag_str[] = { "none", "no-map", "no-overwrite",
477 unsigned int pflags = flags &
478 (LMB_NOMAP | LMB_NOOVERWRITE | LMB_NONOTIFY);
480 if (flags != pflags) {
481 printf("invalid %#x\n", flags);
486 int bitpos = pflags ? fls(pflags) - 1 : 0;
488 printf("%s", flag_str[bitpos]);
489 pflags &= ~(1u << bitpos);
490 puts(pflags ? ", " : "\n");
494 static void lmb_dump_region(struct alist *lmb_rgn_lst, char *name)
496 struct lmb_region *rgn = lmb_rgn_lst->data;
497 unsigned long long base, size, end;
501 printf(" %s.count = %#x\n", name, lmb_rgn_lst->count);
503 for (i = 0; i < lmb_rgn_lst->count; i++) {
506 end = base + size - 1;
507 flags = rgn[i].flags;
509 printf(" %s[%d]\t[%#llx-%#llx], %#llx bytes, flags: ",
510 name, i, base, end, size);
511 lmb_print_region_flags(flags);
515 void lmb_dump_all_force(void)
517 printf("lmb_dump_all:\n");
518 lmb_dump_region(&lmb.available_mem, "memory");
519 lmb_dump_region(&lmb.used_mem, "reserved");
522 void lmb_dump_all(void)
525 lmb_dump_all_force();
529 static void lmb_reserve_uboot_region(void)
533 phys_addr_t rsv_start;
535 rsv_start = gd->start_addr_sp - CONFIG_STACK_SIZE;
539 * Reserve memory from aligned address below the bottom of U-Boot stack
540 * until end of RAM area to prevent LMB from overwriting that memory.
542 debug("## Current stack ends at 0x%08lx ", (ulong)rsv_start);
544 for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
545 if (!gd->bd->bi_dram[bank].size ||
546 rsv_start < gd->bd->bi_dram[bank].start)
548 /* Watch out for RAM at end of address space! */
549 bank_end = gd->bd->bi_dram[bank].start +
550 gd->bd->bi_dram[bank].size - 1;
551 if (rsv_start > bank_end)
556 lmb_reserve(rsv_start, bank_end - rsv_start + 1, LMB_NOOVERWRITE);
558 if (gd->flags & GD_FLG_SKIP_RELOC)
559 lmb_reserve((phys_addr_t)(uintptr_t)_start,
560 gd->mon_len, LMB_NOOVERWRITE);
566 static void lmb_reserve_common(void *fdt_blob)
568 lmb_reserve_uboot_region();
570 if (CONFIG_IS_ENABLED(OF_LIBFDT) && fdt_blob)
571 boot_fdt_add_mem_rsv_regions(fdt_blob);
574 static __maybe_unused void lmb_reserve_common_spl(void)
576 phys_addr_t rsv_start;
577 phys_size_t rsv_size;
580 * Assume a SPL stack of 16KB. This must be
581 * more than enough for the SPL stage.
583 if (IS_ENABLED(CONFIG_SPL_STACK_R_ADDR)) {
584 rsv_start = gd->start_addr_sp - 16384;
586 lmb_reserve(rsv_start, rsv_size, LMB_NOOVERWRITE);
589 if (IS_ENABLED(CONFIG_SPL_SEPARATE_BSS)) {
590 /* Reserve the bss region */
591 rsv_start = (phys_addr_t)(uintptr_t)__bss_start;
592 rsv_size = (phys_addr_t)(uintptr_t)__bss_end -
593 (phys_addr_t)(uintptr_t)__bss_start;
594 lmb_reserve(rsv_start, rsv_size, LMB_NOOVERWRITE);
598 void lmb_add_memory(void)
601 phys_addr_t bank_end;
603 u64 ram_top = gd->ram_top;
604 struct bd_info *bd = gd->bd;
606 if (CONFIG_IS_ENABLED(LMB_ARCH_MEM_MAP))
607 return lmb_arch_add_memory();
609 /* Assume a 4GB ram_top if not defined */
611 ram_top = 0x100000000ULL;
613 for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
614 size = bd->bi_dram[i].size;
615 bank_end = bd->bi_dram[i].start + size;
618 lmb_add(bd->bi_dram[i].start, size);
621 * Reserve memory above ram_top as
622 * no-overwrite so that it cannot be
625 if (bd->bi_dram[i].start >= ram_top)
626 lmb_reserve(bd->bi_dram[i].start, size,
628 else if (bank_end > ram_top)
629 lmb_reserve(ram_top, bank_end - ram_top,
635 /* This routine may be called with relocation disabled. */
636 long lmb_add(phys_addr_t base, phys_size_t size)
639 struct alist *lmb_rgn_lst = &lmb.available_mem;
641 ret = lmb_add_region_flags(lmb_rgn_lst, base, size, LMB_NONE);
645 return lmb_map_update_notify(base, size, MAP_OP_ADD, LMB_NONE);
648 long lmb_free_flags(phys_addr_t base, phys_size_t size,
653 ret = _lmb_free(&lmb.used_mem, base, size);
657 return lmb_map_update_notify(base, size, MAP_OP_FREE, flags);
660 long lmb_free(phys_addr_t base, phys_size_t size)
662 return lmb_free_flags(base, size, LMB_NONE);
665 long lmb_reserve(phys_addr_t base, phys_size_t size, u32 flags)
668 struct alist *lmb_rgn_lst = &lmb.used_mem;
670 ret = lmb_add_region_flags(lmb_rgn_lst, base, size, flags);
674 return lmb_map_update_notify(base, size, MAP_OP_RESERVE, flags);
677 static phys_addr_t _lmb_alloc_base(phys_size_t size, ulong align,
678 phys_addr_t max_addr, u32 flags)
682 phys_addr_t base = 0;
683 phys_addr_t res_base;
684 struct lmb_region *lmb_used = lmb.used_mem.data;
685 struct lmb_region *lmb_memory = lmb.available_mem.data;
687 for (i = lmb.available_mem.count - 1; i >= 0; i--) {
688 phys_addr_t lmbbase = lmb_memory[i].base;
689 phys_size_t lmbsize = lmb_memory[i].size;
694 if (max_addr == LMB_ALLOC_ANYWHERE) {
695 base = ALIGN_DOWN(lmbbase + lmbsize - size, align);
696 } else if (lmbbase < max_addr) {
697 base = lmbbase + lmbsize;
700 base = min(base, max_addr);
701 base = ALIGN_DOWN(base - size, align);
706 while (base && lmbbase <= base) {
707 rgn = lmb_overlaps_region(&lmb.used_mem, base, size);
709 /* This area isn't reserved, take it */
710 if (lmb_add_region_flags(&lmb.used_mem, base,
714 ret = lmb_map_update_notify(base, size,
723 res_base = lmb_used[rgn].base;
726 base = ALIGN_DOWN(res_base - size, align);
732 phys_addr_t lmb_alloc(phys_size_t size, ulong align)
734 return lmb_alloc_base(size, align, LMB_ALLOC_ANYWHERE);
737 phys_addr_t lmb_alloc_base(phys_size_t size, ulong align, phys_addr_t max_addr)
741 alloc = _lmb_alloc_base(size, align, max_addr, LMB_NONE);
744 printf("ERROR: Failed to allocate 0x%lx bytes below 0x%lx.\n",
745 (ulong)size, (ulong)max_addr);
750 phys_addr_t lmb_alloc_base_flags(phys_size_t size, ulong align,
751 phys_addr_t max_addr, uint flags)
755 alloc = _lmb_alloc_base(size, align, max_addr, flags);
758 printf("ERROR: Failed to allocate 0x%lx bytes below 0x%lx.\n",
759 (ulong)size, (ulong)max_addr);
764 static phys_addr_t _lmb_alloc_addr(phys_addr_t base, phys_size_t size, u32 flags)
767 struct lmb_region *lmb_memory = lmb.available_mem.data;
769 /* Check if the requested address is in one of the memory regions */
770 rgn = lmb_overlaps_region(&lmb.available_mem, base, size);
773 * Check if the requested end address is in the same memory
776 if (lmb_addrs_overlap(lmb_memory[rgn].base,
777 lmb_memory[rgn].size,
778 base + size - 1, 1)) {
779 /* ok, reserve the memory */
780 if (!lmb_reserve(base, size, flags))
788 phys_addr_t lmb_alloc_addr(phys_addr_t base, phys_size_t size, uint flags)
790 return _lmb_alloc_addr(base, size, flags);
793 /* Return number of bytes from a given address that are free */
794 phys_size_t lmb_get_free_size(phys_addr_t addr)
798 struct lmb_region *lmb_used = lmb.used_mem.data;
799 struct lmb_region *lmb_memory = lmb.available_mem.data;
801 /* check if the requested address is in the memory regions */
802 rgn = lmb_overlaps_region(&lmb.available_mem, addr, 1);
804 for (i = 0; i < lmb.used_mem.count; i++) {
805 if (addr < lmb_used[i].base) {
806 /* first reserved range > requested address */
807 return lmb_used[i].base - addr;
809 if (lmb_used[i].base +
810 lmb_used[i].size > addr) {
811 /* requested addr is in this reserved range */
815 /* if we come here: no reserved ranges above requested addr */
816 return lmb_memory[lmb.available_mem.count - 1].base +
817 lmb_memory[lmb.available_mem.count - 1].size - addr;
822 int lmb_is_reserved_flags(phys_addr_t addr, int flags)
825 struct lmb_region *lmb_used = lmb.used_mem.data;
827 for (i = 0; i < lmb.used_mem.count; i++) {
828 phys_addr_t upper = lmb_used[i].base +
829 lmb_used[i].size - 1;
830 if (addr >= lmb_used[i].base && addr <= upper)
831 return (lmb_used[i].flags & flags) == flags;
836 static int lmb_setup(bool test)
840 ret = alist_init(&lmb.available_mem, sizeof(struct lmb_region),
841 (uint)LMB_ALIST_INITIAL_SIZE);
843 log_debug("Unable to initialise the list for LMB free memory\n");
847 ret = alist_init(&lmb.used_mem, sizeof(struct lmb_region),
848 (uint)LMB_ALIST_INITIAL_SIZE);
850 log_debug("Unable to initialise the list for LMB used memory\n");
863 ret = lmb_setup(false);
865 log_info("Unable to init LMB\n");
871 /* Reserve the U-Boot image region once U-Boot has relocated */
872 if (xpl_phase() == PHASE_SPL)
873 lmb_reserve_common_spl();
874 else if (xpl_phase() == PHASE_BOARD_R)
875 lmb_reserve_common((void *)gd->fdt_blob);
880 struct lmb *lmb_get(void)
885 #if CONFIG_IS_ENABLED(UNIT_TEST)
886 int lmb_push(struct lmb *store)
891 ret = lmb_setup(true);
898 void lmb_pop(struct lmb *store)
900 alist_uninit(&lmb.available_mem);
901 alist_uninit(&lmb.used_mem);
904 #endif /* UNIT_TEST */