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