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