lib/lmb.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Procedures for maintaining information about logical memory blocks.
   4  *
   5  * Peter Bergner, IBM Corp.     June 2001.
   6  * Copyright (C) 2001 Peter Bergner.
   7  */
   8
   9 #include <common.h>
  10 #include <image.h>
  11 #include <lmb.h>
  12 #include <log.h>
  13 #include <malloc.h>
  14
  15 #define LMB_ALLOC_ANYWHERE      0
  16
  17 void lmb_dump_all_force(struct lmb *lmb)
  18 {
  19         unsigned long i;
  20
  21         printf("lmb_dump_all:\n");
  22         printf("    memory.cnt             = 0x%lx\n", lmb->memory.cnt);
  23         for (i = 0; i < lmb->memory.cnt; i++) {
  24                 printf("    memory.reg[0x%lx].base   = 0x%llx\n", i,
  25                        (unsigned long long)lmb->memory.region[i].base);
  26                 printf("                   .size   = 0x%llx\n",
  27                        (unsigned long long)lmb->memory.region[i].size);
  28         }
  29
  30         printf("\n    reserved.cnt         = 0x%lx\n", lmb->reserved.cnt);
  31         for (i = 0; i < lmb->reserved.cnt; i++) {
  32                 printf("    reserved.reg[0x%lx].base = 0x%llx\n", i,
  33                        (unsigned long long)lmb->reserved.region[i].base);
  34                 printf("                     .size = 0x%llx\n",
  35                        (unsigned long long)lmb->reserved.region[i].size);
  36         }
  37 }
  38
  39 void lmb_dump_all(struct lmb *lmb)
  40 {
  41 #ifdef DEBUG
  42         lmb_dump_all_force(lmb);
  43 #endif
  44 }
  45
  46 static long lmb_addrs_overlap(phys_addr_t base1, phys_size_t size1,
  47                               phys_addr_t base2, phys_size_t size2)
  48 {
  49         const phys_addr_t base1_end = base1 + size1 - 1;
  50         const phys_addr_t base2_end = base2 + size2 - 1;
  51
  52         return ((base1 <= base2_end) && (base2 <= base1_end));
  53 }
  54
  55 static long lmb_addrs_adjacent(phys_addr_t base1, phys_size_t size1,
  56                                phys_addr_t base2, phys_size_t size2)
  57 {
  58         if (base2 == base1 + size1)
  59                 return 1;
  60         else if (base1 == base2 + size2)
  61                 return -1;
  62
  63         return 0;
  64 }
  65
  66 static long lmb_regions_adjacent(struct lmb_region *rgn, unsigned long r1,
  67                                  unsigned long r2)
  68 {
  69         phys_addr_t base1 = rgn->region[r1].base;
  70         phys_size_t size1 = rgn->region[r1].size;
  71         phys_addr_t base2 = rgn->region[r2].base;
  72         phys_size_t size2 = rgn->region[r2].size;
  73
  74         return lmb_addrs_adjacent(base1, size1, base2, size2);
  75 }
  76
  77 static void lmb_remove_region(struct lmb_region *rgn, unsigned long r)
  78 {
  79         unsigned long i;
  80
  81         for (i = r; i < rgn->cnt - 1; i++) {
  82                 rgn->region[i].base = rgn->region[i + 1].base;
  83                 rgn->region[i].size = rgn->region[i + 1].size;
  84         }
  85         rgn->cnt--;
  86 }
  87
  88 /* Assumption: base addr of region 1 < base addr of region 2 */
  89 static void lmb_coalesce_regions(struct lmb_region *rgn, unsigned long r1,
  90                                  unsigned long r2)
  91 {
  92         rgn->region[r1].size += rgn->region[r2].size;
  93         lmb_remove_region(rgn, r2);
  94 }
  95
  96 void lmb_init(struct lmb *lmb)
  97 {
  98         lmb->memory.cnt = 0;
  99         lmb->reserved.cnt = 0;
 100 }
 101
 102 static void lmb_reserve_common(struct lmb *lmb, void *fdt_blob)
 103 {
 104         arch_lmb_reserve(lmb);
 105         board_lmb_reserve(lmb);
 106
 107         if (IMAGE_ENABLE_OF_LIBFDT && fdt_blob)
 108                 boot_fdt_add_mem_rsv_regions(lmb, fdt_blob);
 109 }
 110
 111 /* Initialize the struct, add memory and call arch/board reserve functions */
 112 void lmb_init_and_reserve(struct lmb *lmb, struct bd_info *bd, void *fdt_blob)
 113 {
 114         int i;
 115
 116         lmb_init(lmb);
 117
 118         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 119                 if (bd->bi_dram[i].size) {
 120                         lmb_add(lmb, bd->bi_dram[i].start,
 121                                 bd->bi_dram[i].size);
 122                 }
 123         }
 124
 125         lmb_reserve_common(lmb, fdt_blob);
 126 }
 127
 128 /* Initialize the struct, add memory and call arch/board reserve functions */
 129 void lmb_init_and_reserve_range(struct lmb *lmb, phys_addr_t base,
 130                                 phys_size_t size, void *fdt_blob)
 131 {
 132         lmb_init(lmb);
 133         lmb_add(lmb, base, size);
 134         lmb_reserve_common(lmb, fdt_blob);
 135 }
 136
 137 /* This routine called with relocation disabled. */
 138 static long lmb_add_region(struct lmb_region *rgn, phys_addr_t base, phys_size_t size)
 139 {
 140         unsigned long coalesced = 0;
 141         long adjacent, i;
 142
 143         if (rgn->cnt == 0) {
 144                 rgn->region[0].base = base;
 145                 rgn->region[0].size = size;
 146                 rgn->cnt = 1;
 147                 return 0;
 148         }
 149
 150         /* First try and coalesce this LMB with another. */
 151         for (i = 0; i < rgn->cnt; i++) {
 152                 phys_addr_t rgnbase = rgn->region[i].base;
 153                 phys_size_t rgnsize = rgn->region[i].size;
 154
 155                 if ((rgnbase == base) && (rgnsize == size))
 156                         /* Already have this region, so we're done */
 157                         return 0;
 158
 159                 adjacent = lmb_addrs_adjacent(base, size, rgnbase, rgnsize);
 160                 if (adjacent > 0) {
 161                         rgn->region[i].base -= size;
 162                         rgn->region[i].size += size;
 163                         coalesced++;
 164                         break;
 165                 } else if (adjacent < 0) {
 166                         rgn->region[i].size += size;
 167                         coalesced++;
 168                         break;
 169                 } else if (lmb_addrs_overlap(base, size, rgnbase, rgnsize)) {
 170                         /* regions overlap */
 171                         return -1;
 172                 }
 173         }
 174
 175         if ((i < rgn->cnt - 1) && lmb_regions_adjacent(rgn, i, i + 1)) {
 176                 lmb_coalesce_regions(rgn, i, i + 1);
 177                 coalesced++;
 178         }
 179
 180         if (coalesced)
 181                 return coalesced;
 182         if (rgn->cnt >= MAX_LMB_REGIONS)
 183                 return -1;
 184
 185         /* Couldn't coalesce the LMB, so add it to the sorted table. */
 186         for (i = rgn->cnt-1; i >= 0; i--) {
 187                 if (base < rgn->region[i].base) {
 188                         rgn->region[i + 1].base = rgn->region[i].base;
 189                         rgn->region[i + 1].size = rgn->region[i].size;
 190                 } else {
 191                         rgn->region[i + 1].base = base;
 192                         rgn->region[i + 1].size = size;
 193                         break;
 194                 }
 195         }
 196
 197         if (base < rgn->region[0].base) {
 198                 rgn->region[0].base = base;
 199                 rgn->region[0].size = size;
 200         }
 201
 202         rgn->cnt++;
 203
 204         return 0;
 205 }
 206
 207 /* This routine may be called with relocation disabled. */
 208 long lmb_add(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 209 {
 210         struct lmb_region *_rgn = &(lmb->memory);
 211
 212         return lmb_add_region(_rgn, base, size);
 213 }
 214
 215 long lmb_free(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 216 {
 217         struct lmb_region *rgn = &(lmb->reserved);
 218         phys_addr_t rgnbegin, rgnend;
 219         phys_addr_t end = base + size - 1;
 220         int i;
 221
 222         rgnbegin = rgnend = 0; /* supress gcc warnings */
 223
 224         /* Find the region where (base, size) belongs to */
 225         for (i = 0; i < rgn->cnt; i++) {
 226                 rgnbegin = rgn->region[i].base;
 227                 rgnend = rgnbegin + rgn->region[i].size - 1;
 228
 229                 if ((rgnbegin <= base) && (end <= rgnend))
 230                         break;
 231         }
 232
 233         /* Didn't find the region */
 234         if (i == rgn->cnt)
 235                 return -1;
 236
 237         /* Check to see if we are removing entire region */
 238         if ((rgnbegin == base) && (rgnend == end)) {
 239                 lmb_remove_region(rgn, i);
 240                 return 0;
 241         }
 242
 243         /* Check to see if region is matching at the front */
 244         if (rgnbegin == base) {
 245                 rgn->region[i].base = end + 1;
 246                 rgn->region[i].size -= size;
 247                 return 0;
 248         }
 249
 250         /* Check to see if the region is matching at the end */
 251         if (rgnend == end) {
 252                 rgn->region[i].size -= size;
 253                 return 0;
 254         }
 255
 256         /*
 257          * We need to split the entry -  adjust the current one to the
 258          * beginging of the hole and add the region after hole.
 259          */
 260         rgn->region[i].size = base - rgn->region[i].base;
 261         return lmb_add_region(rgn, end + 1, rgnend - end);
 262 }
 263
 264 long lmb_reserve(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 265 {
 266         struct lmb_region *_rgn = &(lmb->reserved);
 267
 268         return lmb_add_region(_rgn, base, size);
 269 }
 270
 271 static long lmb_overlaps_region(struct lmb_region *rgn, phys_addr_t base,
 272                                 phys_size_t size)
 273 {
 274         unsigned long i;
 275
 276         for (i = 0; i < rgn->cnt; i++) {
 277                 phys_addr_t rgnbase = rgn->region[i].base;
 278                 phys_size_t rgnsize = rgn->region[i].size;
 279                 if (lmb_addrs_overlap(base, size, rgnbase, rgnsize))
 280                         break;
 281         }
 282
 283         return (i < rgn->cnt) ? i : -1;
 284 }
 285
 286 phys_addr_t lmb_alloc(struct lmb *lmb, phys_size_t size, ulong align)
 287 {
 288         return lmb_alloc_base(lmb, size, align, LMB_ALLOC_ANYWHERE);
 289 }
 290
 291 phys_addr_t lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align, phys_addr_t max_addr)
 292 {
 293         phys_addr_t alloc;
 294
 295         alloc = __lmb_alloc_base(lmb, size, align, max_addr);
 296
 297         if (alloc == 0)
 298                 printf("ERROR: Failed to allocate 0x%lx bytes below 0x%lx.\n",
 299                        (ulong)size, (ulong)max_addr);
 300
 301         return alloc;
 302 }
 303
 304 static phys_addr_t lmb_align_down(phys_addr_t addr, phys_size_t size)
 305 {
 306         return addr & ~(size - 1);
 307 }
 308
 309 phys_addr_t __lmb_alloc_base(struct lmb *lmb, phys_size_t size, ulong align, phys_addr_t max_addr)
 310 {
 311         long i, rgn;
 312         phys_addr_t base = 0;
 313         phys_addr_t res_base;
 314
 315         for (i = lmb->memory.cnt - 1; i >= 0; i--) {
 316                 phys_addr_t lmbbase = lmb->memory.region[i].base;
 317                 phys_size_t lmbsize = lmb->memory.region[i].size;
 318
 319                 if (lmbsize < size)
 320                         continue;
 321                 if (max_addr == LMB_ALLOC_ANYWHERE)
 322                         base = lmb_align_down(lmbbase + lmbsize - size, align);
 323                 else if (lmbbase < max_addr) {
 324                         base = lmbbase + lmbsize;
 325                         if (base < lmbbase)
 326                                 base = -1;
 327                         base = min(base, max_addr);
 328                         base = lmb_align_down(base - size, align);
 329                 } else
 330                         continue;
 331
 332                 while (base && lmbbase <= base) {
 333                         rgn = lmb_overlaps_region(&lmb->reserved, base, size);
 334                         if (rgn < 0) {
 335                                 /* This area isn't reserved, take it */
 336                                 if (lmb_add_region(&lmb->reserved, base,
 337                                                    size) < 0)
 338                                         return 0;
 339                                 return base;
 340                         }
 341                         res_base = lmb->reserved.region[rgn].base;
 342                         if (res_base < size)
 343                                 break;
 344                         base = lmb_align_down(res_base - size, align);
 345                 }
 346         }
 347         return 0;
 348 }
 349
 350 /*
 351  * Try to allocate a specific address range: must be in defined memory but not
 352  * reserved
 353  */
 354 phys_addr_t lmb_alloc_addr(struct lmb *lmb, phys_addr_t base, phys_size_t size)
 355 {
 356         long rgn;
 357
 358         /* Check if the requested address is in one of the memory regions */
 359         rgn = lmb_overlaps_region(&lmb->memory, base, size);
 360         if (rgn >= 0) {
 361                 /*
 362                  * Check if the requested end address is in the same memory
 363                  * region we found.
 364                  */
 365                 if (lmb_addrs_overlap(lmb->memory.region[rgn].base,
 366                                       lmb->memory.region[rgn].size,
 367                                       base + size - 1, 1)) {
 368                         /* ok, reserve the memory */
 369                         if (lmb_reserve(lmb, base, size) >= 0)
 370                                 return base;
 371                 }
 372         }
 373         return 0;
 374 }
 375
 376 /* Return number of bytes from a given address that are free */
 377 phys_size_t lmb_get_free_size(struct lmb *lmb, phys_addr_t addr)
 378 {
 379         int i;
 380         long rgn;
 381
 382         /* check if the requested address is in the memory regions */
 383         rgn = lmb_overlaps_region(&lmb->memory, addr, 1);
 384         if (rgn >= 0) {
 385                 for (i = 0; i < lmb->reserved.cnt; i++) {
 386                         if (addr < lmb->reserved.region[i].base) {
 387                                 /* first reserved range > requested address */
 388                                 return lmb->reserved.region[i].base - addr;
 389                         }
 390                         if (lmb->reserved.region[i].base +
 391                             lmb->reserved.region[i].size > addr) {
 392                                 /* requested addr is in this reserved range */
 393                                 return 0;
 394                         }
 395                 }
 396                 /* if we come here: no reserved ranges above requested addr */
 397                 return lmb->memory.region[lmb->memory.cnt - 1].base +
 398                        lmb->memory.region[lmb->memory.cnt - 1].size - addr;
 399         }
 400         return 0;
 401 }
 402
 403 int lmb_is_reserved(struct lmb *lmb, phys_addr_t addr)
 404 {
 405         int i;
 406
 407         for (i = 0; i < lmb->reserved.cnt; i++) {
 408                 phys_addr_t upper = lmb->reserved.region[i].base +
 409                         lmb->reserved.region[i].size - 1;
 410                 if ((addr >= lmb->reserved.region[i].base) && (addr <= upper))
 411                         return 1;
 412         }
 413         return 0;
 414 }
 415
 416 __weak void board_lmb_reserve(struct lmb *lmb)
 417 {
 418         /* please define platform specific board_lmb_reserve() */
 419 }
 420
 421 __weak void arch_lmb_reserve(struct lmb *lmb)
 422 {
 423         /* please define platform specific arch_lmb_reserve() */
 424 }