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