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