xref: /rk3399_rockchip-uboot/lib/sysmem.c (revision 48802b420ed64314c357b48219c791ec7c6eb8f8)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2019 Fuzhou Rockchip Electronics Co., Ltd
4  */
5 
6 #include <common.h>
7 #include <sysmem.h>
8 #include <lmb.h>
9 #include <malloc.h>
10 #include <asm/io.h>
11 
12 DECLARE_GLOBAL_DATA_PTR;
13 
14 #define SYSMEM_MAGIC		0x4D454D53	/* "SMEM" */
15 
16 #define LMB_ALLOC_ANYWHERE	0		/* sync with lmb.c */
17 #define SYSMEM_ALLOC_NO_ALIGN	1
18 #define SYSMEM_ALLOC_ANYWHERE	2
19 
20 #define SYSMEM_I(fmt, args...)	printf("Sysmem: "fmt, ##args)
21 #define SYSMEM_W(fmt, args...)	printf("Sysmem Warn: "fmt, ##args)
22 #define SYSMEM_E(fmt, args...)	printf("Sysmem Error: "fmt, ##args)
23 #define SYSMEM_D(fmt, args...)	 debug("Sysmem Debug: "fmt, ##args)
24 
25 struct memcheck {
26 	uint32_t magic;
27 };
28 
29 /* Global for platform, must in data section */
30 struct sysmem plat_sysmem __section(".data") = {
31 	.has_initf = false,
32 	.has_initr = false,
33 };
34 
35 bool sysmem_has_init(void)
36 {
37 	return gd->flags & GD_FLG_RELOC ?
38 	       plat_sysmem.has_initr : plat_sysmem.has_initf;
39 }
40 
41 void sysmem_dump(void)
42 {
43 	struct sysmem *sysmem = &plat_sysmem;
44 	struct lmb *lmb = &sysmem->lmb;
45 	struct memblock *mem;
46 	struct memcheck *check;
47 	struct list_head *node;
48 	ulong memory_size = 0;
49 	ulong reserved_size = 0;
50 	ulong allocated_size = 0;
51 	bool overflow = false;
52 	ulong i;
53 
54 	if (!sysmem_has_init())
55 		return;
56 
57 	printf("\nsysmem_dump_all:\n");
58 
59 	/* Memory pool */
60 	printf("    --------------------------------------------------------------------\n");
61 	for (i = 0; i < lmb->memory.cnt; i++) {
62 		memory_size += lmb->memory.region[i].size;
63 		printf("    memory.rgn[%ld].addr     = 0x%08lx - 0x%08lx (size: 0x%08lx)\n", i,
64 		       (ulong)lmb->memory.region[i].base,
65 		       (ulong)lmb->memory.region[i].base +
66 		       (ulong)lmb->memory.region[i].size,
67 		       (ulong)lmb->memory.region[i].size);
68 	}
69 	printf("\n    memory.total	   = 0x%08lx (%ld MiB. %ld KiB)\n",
70 	       (ulong)memory_size,
71 	       SIZE_MB((ulong)memory_size),
72 	       SIZE_KB((ulong)memory_size));
73 
74 	/* Allocated */
75 	i = 0;
76 	printf("    --------------------------------------------------------------------\n");
77 	list_for_each(node, &sysmem->allocated_head) {
78 		mem = list_entry(node, struct memblock, node);
79 		allocated_size += mem->size;
80 		if (mem->attr.flags & M_ATTR_OFC) {
81 			check = (struct memcheck *)
82 				(mem->base + mem->size - sizeof(*check));
83 			overflow = (check->magic != SYSMEM_MAGIC);
84 		} else if (mem->attr.flags & M_ATTR_HOFC) {
85 			check = (struct memcheck *)
86 				(mem->base - sizeof(*check));
87 			overflow = (check->magic != SYSMEM_MAGIC);
88 		} else {
89 			overflow = false;
90 		}
91 
92 		printf("    allocated.rgn[%ld].name  = \"%s\" %s\n",
93 		       i, mem->attr.name, overflow ? "	   <Overflow!>" : "");
94 		printf("		    .addr  = 0x%08lx - 0x%08lx (size: 0x%08lx)\n",
95 		       (ulong)mem->base, (ulong)(mem->base + mem->size),
96 		       (ulong)mem->size);
97 		i++;
98 	}
99 
100 	printf("\n    malloc_r: %d MiB, malloc_f: %d KiB\n",
101 	       SIZE_MB(CONFIG_SYS_MALLOC_LEN), SIZE_KB(CONFIG_SYS_MALLOC_F_LEN));
102 	printf("\n    allocated.total	   = 0x%08lx (%ld MiB. %ld KiB)\n",
103 	       (ulong)allocated_size,
104 	       SIZE_MB((ulong)allocated_size),
105 	       SIZE_KB((ulong)allocated_size));
106 
107 	/* LMB core reserved */
108 	printf("    --------------------------------------------------------------------\n");
109 	reserved_size = 0;
110 	for (i = 0; i < lmb->reserved.cnt; i++) {
111 		reserved_size += lmb->reserved.region[i].size;
112 		printf("    LMB.reserved[%ld].addr   = 0x%08lx - 0x%08lx (size: 0x%08lx)\n", i,
113 		       (ulong)lmb->reserved.region[i].base,
114 		       (ulong)lmb->reserved.region[i].base +
115 		       (ulong)lmb->reserved.region[i].size,
116 		       (ulong)lmb->reserved.region[i].size);
117 	}
118 
119 	printf("\n    reserved.core.total	   = 0x%08lx (%ld MiB. %ld KiB)\n",
120 	       (ulong)reserved_size,
121 	       SIZE_MB((ulong)reserved_size),
122 	       SIZE_KB((ulong)reserved_size));
123 	printf("    --------------------------------------------------------------------\n\n");
124 }
125 
126 static inline int sysmem_is_overlap(phys_addr_t base1, phys_size_t size1,
127 				    phys_addr_t base2, phys_size_t size2)
128 {
129 	return ((base1 < (base2 + size2)) && (base2 < (base1 + size1)));
130 }
131 
132 static int sysmem_add(phys_addr_t base, phys_size_t size)
133 {
134 	struct sysmem *sysmem = &plat_sysmem;
135 	int ret;
136 
137 	if (!size)
138 		return -EINVAL;
139 
140 	ret = lmb_add(&sysmem->lmb, base, size);
141 	if (ret < 0)
142 		SYSMEM_E("Failed to add sysmem at 0x%08lx for 0x%08lx size\n",
143 			 (ulong)base, (ulong)size);
144 
145 	return (ret >= 0) ? 0 : ret;
146 }
147 
148 static const char *sysmem_alias2name(const char *name, int *id)
149 {
150 	const char *alias;
151 	int n, i, j;
152 	int match = 0;
153 
154 	for (i = 0; i < MEMBLK_ID_MAX; i++) {
155 		/* Pirmary name */
156 		if (mem_attr[i].name && !strcasecmp(mem_attr[i].name, name)) {
157 			match = 1;
158 			goto finish;
159 		}
160 
161 		/* Alias name */
162 		alias = mem_attr[i].alias[0];
163 		if (!alias)
164 			continue;
165 
166 		n = ARRAY_SIZE(mem_attr[i].alias);
167 		for (j = 0; j < n; j++, alias++) {
168 			if (alias && !strcasecmp(alias, name)) {
169 				match = 1;
170 				goto finish;
171 			}
172 		}
173 	}
174 
175 finish:
176 	if (match) {
177 		*id = i;
178 		return mem_attr[i].name;
179 	}
180 
181 	return name;
182 }
183 
184 static void *sysmem_alloc_align_base(enum memblk_id id,
185 				     const char *mem_name,
186 				     phys_addr_t base,
187 				     phys_size_t size,
188 				     ulong align)
189 {
190 	struct sysmem *sysmem = &plat_sysmem;
191 	struct memblk_attr attr;
192 	struct memblock *mem;
193 	struct memcheck *check;
194 	struct list_head *node;
195 	const char *name;
196 	phys_addr_t paddr;
197 	phys_addr_t alloc_base;
198 	phys_size_t alloc_size;
199 	phys_addr_t bank_base;
200 	phys_size_t bank_size;
201 	bool req_overlap = false; /* Only for kernel reserved-memory */
202 	int i;
203 
204 	if (!sysmem_has_init())
205 		goto out;
206 
207 	if (id == MEMBLK_ID_BY_NAME || id == MEMBLK_ID_FDT_RESV) {
208 		if (!mem_name) {
209 			SYSMEM_E("NULL name for alloc sysmem\n");
210 			goto out;
211 		} else if (id == MEMBLK_ID_FDT_RESV) {
212 
213 			/*
214 			 * Allow fdt reserved memory to overlap with the region
215 			 * only used in U-Boot, like: stack, fastboot, u-boot...
216 			 * these regions are marked as M_ATTR_OVERLAP in flags.
217 			 *
218 			 * Here we check whether it overlaps with others, if
219 			 * so, set req_overlap as true.
220 			 */
221 			for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
222 				if (!gd->bd->bi_dram[i].size)
223 					continue;
224 
225 				bank_base = gd->bd->bi_dram[i].start;
226 				bank_size = gd->bd->bi_dram[i].size;
227 				if (sysmem_is_overlap(base, size,
228 						      bank_base, bank_size)) {
229 					req_overlap = true;
230 					break;
231 				}
232 			}
233 
234 			/*
235 			 * If this request region is out size of all available
236 			 * region, ignore and return success.
237 			 */
238 			if (!req_overlap)
239 				return (void *)base;
240 		}
241 
242 		/* Find name, id and attr by outer mem_name */
243 		name = sysmem_alias2name(mem_name, (int *)&id);
244 		attr = mem_attr[id];
245 		if (!attr.name)
246 			attr.name = strdup(name);
247 	} else if (id > MEMBLK_ID_UNK && id < MEMBLK_ID_MAX) {
248 		attr = mem_attr[id];
249 		name = attr.name;
250 
251 		/*
252 		 * Fixup base and place right after U-Boot stack, adding a lot
253 		 * of space(4KB) maybe safer.
254 		 */
255 		if ((id == MEMBLK_ID_AVB_ANDROID) &&
256 		    (base == SYSMEM_ALLOC_ANYWHERE)) {
257 			base = gd->start_addr_sp -
258 					CONFIG_SYS_STACK_SIZE - size - 0x1000;
259 		/*
260 		 * So far, we use M_ATTR_PEEK for uncompress kernel alloc, and
261 		 * for ARMv8 enabling AArch32 mode, the ATF is still AArch64
262 		 * and ocuppies 0~1MB and shmem 1~2M. So let's ignore the region
263 		 * which overlap with them.
264 		 */
265 		} else if (attr.flags & M_ATTR_PEEK) {
266 			if (base <= gd->bd->bi_dram[0].start)
267 				base = gd->bd->bi_dram[0].start;
268 		}
269 	} else {
270 		SYSMEM_E("Unsupport memblk id %d for alloc sysmem\n", id);
271 		goto out;
272 	}
273 
274 	if (!size) {
275 		SYSMEM_E("\"%s\" size is 0 for alloc sysmem\n", name);
276 		goto out;
277 	}
278 
279 	if (!IS_ALIGNED(base, 4)) {
280 		SYSMEM_E("\"%s\" base=0x%08lx is not 4-byte aligned\n",
281 			 name, (ulong)base);
282 		goto out;
283 	}
284 
285 	/* Must be 4-byte aligned */
286 	size = ALIGN(size, 4);
287 
288 	SYSMEM_D("Enter alloc: \"%s\" 0x%08lx - 0x%08lx\n",
289 		 name, (ulong)base, (ulong)(base + size));
290 
291 	/* Already allocated ? */
292 	list_for_each(node, &sysmem->allocated_head) {
293 		mem = list_entry(node, struct memblock, node);
294 		SYSMEM_D("Has allcated: %s, 0x%08lx - 0x%08lx\n",
295 			 mem->attr.name, (ulong)mem->base,
296 			 (ulong)(mem->base + mem->size));
297 		if (!strcmp(mem->attr.name, name)) {
298 			/* Allow double alloc for same but smaller region */
299 			if (mem->base <= base && mem->size >= size)
300 				return (void *)base;
301 
302 			SYSMEM_E("Failed to double alloc for existence \"%s\"\n", name);
303 			goto out;
304 		} else if (sysmem_is_overlap(mem->base, mem->size, base, size)) {
305 			/*
306 			 * If this new alloc region expects overlap and the old
307 			 * region is also allowed to be overlap, just do reserve.
308 			 */
309 			if (req_overlap && mem->attr.flags & M_ATTR_OVERLAP) {
310 				if (lmb_reserve(&sysmem->lmb, base, size))
311 					SYSMEM_E("Failed to overlap alloc \"%s\" "
312 						 "at 0x%08lx - 0x%08lx\n",
313 						 name, (ulong)base,
314 						 (ulong)(base + size));
315 				return (void *)base;
316 			}
317 
318 			SYSMEM_E("\"%s\" (0x%08lx - 0x%08lx) alloc is "
319 				 "overlap with existence \"%s\" (0x%08lx - "
320 				 "0x%08lx)\n",
321 				 name, (ulong)base, (ulong)(base + size),
322 				 mem->attr.name, (ulong)mem->base,
323 				 (ulong)(mem->base + mem->size));
324 			goto out;
325 		}
326 	}
327 
328 	/* Add overflow check magic ? */
329 	if (attr.flags & M_ATTR_OFC)
330 		alloc_size = size + sizeof(*check);
331 	else
332 		alloc_size = size;
333 
334 	/* Alloc anywhere ? */
335 	if (base == SYSMEM_ALLOC_ANYWHERE)
336 		alloc_base = LMB_ALLOC_ANYWHERE;
337 	else
338 		alloc_base = base + alloc_size;	/* LMB is align down alloc mechanism */
339 
340 	paddr = lmb_alloc_base(&sysmem->lmb, alloc_size, align, alloc_base);
341 	if (paddr) {
342 		if ((paddr == base) || (base == SYSMEM_ALLOC_ANYWHERE)) {
343 			mem = malloc(sizeof(*mem));
344 			if (!mem) {
345 				SYSMEM_E("No memory for \"%s\" alloc sysmem\n", name);
346 				goto out;
347 			}
348 
349 			mem->base = paddr;
350 			mem->size = alloc_size;
351 			mem->attr = attr;
352 			sysmem->allocated_cnt++;
353 			list_add_tail(&mem->node, &sysmem->allocated_head);
354 
355 			/* Add overflow check magic */
356 			if (mem->attr.flags & M_ATTR_OFC) {
357 				check = (struct memcheck *)(paddr + size);
358 				check->magic = SYSMEM_MAGIC;
359 			} else if (mem->attr.flags & M_ATTR_HOFC) {
360 				check = (struct memcheck *)(paddr - sizeof(*check));
361 				check->magic = SYSMEM_MAGIC;
362 			}
363 		} else {
364 			SYSMEM_E("Failed to alloc \"%s\" expect at 0x%08lx - 0x%08lx "
365 				 "but at 0x%08lx - x%08lx\n",
366 				 name, (ulong)base, (ulong)(base + size),
367 				 (ulong)paddr, (ulong)(paddr + size));
368 			/* Free what we don't want allocated region */
369 			if (lmb_free(&sysmem->lmb, paddr, alloc_size) < 0)
370 				SYSMEM_E("Failed to free \"%s\"\n", name);
371 
372 			goto out;
373 		}
374 	} else {
375 		SYSMEM_E("Failed to alloc \"%s\" at 0x%08lx - 0x%08lx\n",
376 			 name, (ulong)base, (ulong)(base + size));
377 		goto out;
378 	}
379 
380 	SYSMEM_D("Exit alloc: \"%s\", paddr=0x%08lx, size=0x%08lx, align=0x%x, anywhere=%d\n",
381 		 name, (ulong)paddr, (ulong)size, (u32)align, !base);
382 
383 	return (void *)paddr;
384 
385 out:
386 	/*
387 	 * Why: base + sizeof(ulong) ?
388 	 * It's a not standard way to handle the case: the input base is 0.
389 	 */
390 	if (base == 0)
391 		base = base + sizeof(ulong);
392 
393 	return (attr.flags & M_ATTR_PEEK) ? (void *)base : NULL;
394 }
395 
396 void *sysmem_alloc(enum memblk_id id, phys_size_t size)
397 {
398 	void *paddr;
399 
400 	paddr = sysmem_alloc_align_base(id,
401 					NULL,
402 					SYSMEM_ALLOC_ANYWHERE,
403 					size,
404 					SYSMEM_ALLOC_NO_ALIGN);
405 	if (!paddr)
406 		sysmem_dump();
407 
408 	return paddr;
409 }
410 
411 void *sysmem_alloc_base(enum memblk_id id, phys_addr_t base, phys_size_t size)
412 {
413 	void *paddr;
414 
415 	paddr = sysmem_alloc_align_base(id,
416 					NULL,
417 					base,
418 					size,
419 					SYSMEM_ALLOC_NO_ALIGN);
420 	if (!paddr)
421 		sysmem_dump();
422 
423 	return paddr;
424 }
425 
426 void *sysmem_alloc_base_by_name(const char *name,
427 				phys_addr_t base, phys_size_t size)
428 {
429 	void *paddr;
430 
431 	paddr = sysmem_alloc_align_base(MEMBLK_ID_BY_NAME,
432 					name,
433 					base,
434 					size,
435 					SYSMEM_ALLOC_NO_ALIGN);
436 	if (!paddr)
437 		sysmem_dump();
438 
439 	return paddr;
440 }
441 
442 void *sysmem_fdt_reserve_alloc_base(const char *name,
443 				    phys_addr_t base, phys_size_t size)
444 {
445 	void *paddr;
446 
447 	paddr = sysmem_alloc_align_base(MEMBLK_ID_FDT_RESV,
448 					name,
449 					base,
450 					size,
451 					SYSMEM_ALLOC_NO_ALIGN);
452 	if (!paddr)
453 		sysmem_dump();
454 
455 	return paddr;
456 }
457 
458 bool sysmem_can_alloc(phys_size_t base, phys_size_t size)
459 {
460 	struct sysmem *sysmem = &plat_sysmem;
461 	phys_addr_t alloc_base;
462 	phys_addr_t paddr;
463 	int ret;
464 
465 	if (!sysmem_has_init())
466 		return false;
467 
468 	/* LMB is align down alloc mechanism */
469 	alloc_base = base + size;
470 	paddr = __lmb_alloc_base(&sysmem->lmb,
471 				 size,
472 				 SYSMEM_ALLOC_NO_ALIGN,
473 				 alloc_base);
474 	if (paddr) {
475 		/* If free failed, return false */
476 		ret = lmb_free(&sysmem->lmb, base, size);
477 		if (ret < 0) {
478 			SYSMEM_E("Can't free at 0x%08lx - 0x%08lx, ret=%d\n",
479 				 (ulong)base, (ulong)(base + size), ret);
480 			return false;
481 		}
482 	} else {
483 		SYSMEM_D("Can't alloc at 0x%08lx - 0x%08lx\n",
484 			 (ulong)base, (ulong)(base + size));
485 	}
486 
487 	return (paddr == base) ? true : false;
488 }
489 
490 int sysmem_free(phys_addr_t base)
491 {
492 	struct sysmem *sysmem = &plat_sysmem;
493 	struct memblock *mem;
494 	struct list_head *node;
495 	int ret, found = 0;
496 
497 	if (!sysmem_has_init())
498 		return -ENOSYS;
499 
500 	/* Find existence */
501 	list_for_each(node, &sysmem->allocated_head) {
502 		mem = list_entry(node, struct memblock, node);
503 		if (mem->base == base) {
504 			found = 1;
505 			break;
506 		}
507 	}
508 
509 	if (!found) {
510 		SYSMEM_E("Failed to free no allocated sysmem at 0x%08lx\n",
511 			 (ulong)base);
512 		return -EINVAL;
513 	}
514 
515 	ret = lmb_free(&sysmem->lmb, mem->base, mem->size);
516 	if (ret >= 0) {
517 		SYSMEM_D("Free: \"%s\" 0x%08lx - 0x%08lx\n",
518 			 mem->attr.name, (ulong)mem->base,
519 			 (ulong)(mem->base + mem->size));
520 		sysmem->allocated_cnt--;
521 		list_del(&mem->node);
522 		free(mem);
523 	} else {
524 		SYSMEM_E("Failed to free \"%s\" at 0x%08lx\n",
525 			 mem->attr.name, (ulong)base);
526 	}
527 
528 	return (ret >= 0) ? 0 : ret;
529 }
530 
531 int sysmem_initr(void)
532 {
533 	return sysmem_init();
534 }
535 
536 int sysmem_init(void)
537 {
538 	struct sysmem *sysmem = &plat_sysmem;
539 	phys_addr_t mem_start;
540 	phys_size_t mem_size;
541 	int ret;
542 
543 	lmb_init(&sysmem->lmb);
544 	INIT_LIST_HEAD(&sysmem->allocated_head);
545 	sysmem->allocated_cnt = 0;
546 	if (gd->flags & GD_FLG_RELOC) {
547 		sysmem->has_initr = true;
548 	} else {
549 		SYSMEM_I("init\n");
550 		sysmem->has_initf = true;
551 	}
552 
553 	/* Add all available system memory */
554 #ifdef CONFIG_NR_DRAM_BANKS
555 	int i;
556 
557 	for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
558 		if (!gd->bd->bi_dram[i].size)
559 			continue;
560 
561 		ret = sysmem_add(gd->bd->bi_dram[i].start,
562 				 gd->bd->bi_dram[i].size);
563 		if (ret) {
564 			SYSMEM_E("Failed to add sysmem from bi_dram[%d]\n", i);
565 			goto fail;
566 		}
567 	}
568 #else
569 	mem_start = env_get_bootm_low();
570 	mem_size = env_get_bootm_size();
571 	ret = sysmem_add(mem_start, mem_size);
572 	if (ret) {
573 		SYSMEM_E("Failed to add sysmem from bootm_low/size\n");
574 		goto fail;
575 	}
576 #endif
577 	/* Reserved for board */
578 	ret = board_sysmem_reserve(sysmem);
579 	if (ret) {
580 		SYSMEM_E("Failed to reserve sysmem for board\n");
581 		goto fail;
582 	}
583 
584 	/* Reserved for U-boot framework: 'reserve_xxx()' */
585 	mem_start = gd->start_addr_sp;
586 	mem_size = gd->ram_top - mem_start;
587 	if (!sysmem_alloc_base(MEMBLK_ID_UBOOT, mem_start, mem_size)) {
588 		SYSMEM_E("Failed to reserve sysmem for U-Boot framework\n");
589 		ret = -ENOMEM;
590 		goto fail;
591 	}
592 
593 	/* Reserved for U-Boot stack */
594 	mem_start = gd->start_addr_sp - CONFIG_SYS_STACK_SIZE;
595 	mem_size = CONFIG_SYS_STACK_SIZE;
596 	if (!sysmem_alloc_base(MEMBLK_ID_STACK, mem_start, mem_size)) {
597 		SYSMEM_E("Failed to reserve sysmem for stack\n");
598 		ret = -ENOMEM;
599 		goto fail;
600 	}
601 
602 	return 0;
603 
604 fail:
605 	if (ret && !(gd->flags & GD_FLG_RELOC)) {
606 		sysmem_dump();
607 		SYSMEM_W("Maybe malloc size %d MiB is too large?\n\n",
608 			 SIZE_MB(CONFIG_SYS_MALLOC_LEN));
609 	}
610 
611 	return ret;
612 }
613 
614 __weak int board_sysmem_reserve(struct sysmem *sysmem)
615 {
616 	/* please define platform specific board_sysmem_reserve() */
617 	return 0;
618 }
619 
620 static int do_dump_sysmem(cmd_tbl_t *cmdtp, int flag,
621 			  int argc, char *const argv[])
622 {
623 	sysmem_dump();
624 	return 0;
625 }
626 
627 U_BOOT_CMD(
628 	dump_sysmem, 1, 1, do_dump_sysmem,
629 	"Dump sysmem layout",
630 	""
631 );
632