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