xref: /rk3399_rockchip-uboot/lib/sysmem.c (revision e65f23e90c404d909d0f5d47c829396c247a7986)
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 #define SYSMEM_ALLOC_ANYWHERE	0
16 #define SYSMEM_ALLOC_NO_ALIGN	1
17 
18 #define SYSMEM_I(fmt, args...)	printf("Sysmem: "fmt, ##args)
19 #define SYSMEM_W(fmt, args...)	printf("Sysmem Warn: "fmt, ##args)
20 #define SYSMEM_E(fmt, args...)	printf("Sysmem Error: "fmt, ##args)
21 #define SYSMEM_D(fmt, args...)	 debug("Sysmem Debug: "fmt, ##args)
22 
23 struct memcheck {
24 	uint32_t magic;
25 };
26 
27 /* Global for platform, must in data section */
28 struct sysmem plat_sysmem __section(".data") = {
29 	.has_initf = false,
30 	.has_initr = false,
31 };
32 
33 bool sysmem_has_init(void)
34 {
35 	return gd->flags & GD_FLG_RELOC ?
36 	       plat_sysmem.has_initr : plat_sysmem.has_initf;
37 }
38 
39 void sysmem_dump(void)
40 {
41 	struct sysmem *sysmem = &plat_sysmem;
42 	struct lmb *lmb = &sysmem->lmb;
43 	struct memblock *mem;
44 	struct memcheck *check;
45 	struct list_head *node;
46 	ulong memory_size = 0;
47 	ulong reserved_size = 0;
48 	ulong allocated_size = 0;
49 	bool overflow = false;
50 	ulong i;
51 
52 	if (!sysmem_has_init())
53 		return;
54 
55 	printf("\nsysmem_dump_all:\n");
56 
57 	/* Memory pool */
58 	printf("    --------------------------------------------------------------------\n");
59 	for (i = 0; i < lmb->memory.cnt; i++) {
60 		memory_size += lmb->memory.region[i].size;
61 		printf("    memory.rgn[%ld].addr     = 0x%08lx - 0x%08lx (size: 0x%08lx)\n", i,
62 		       (ulong)lmb->memory.region[i].base,
63 		       (ulong)lmb->memory.region[i].base +
64 		       (ulong)lmb->memory.region[i].size,
65 		       (ulong)lmb->memory.region[i].size);
66 	}
67 	printf("\n    memory.total	   = 0x%08lx (%ld MiB. %ld KiB)\n",
68 	       (ulong)memory_size,
69 	       SIZE_MB((ulong)memory_size),
70 	       SIZE_KB((ulong)memory_size));
71 
72 	/* Allocated */
73 	i = 0;
74 	printf("    --------------------------------------------------------------------\n");
75 	list_for_each(node, &sysmem->allocated_head) {
76 		mem = list_entry(node, struct memblock, node);
77 		allocated_size += mem->size;
78 		if (mem->attr.flags & M_ATTR_OFC) {
79 			check = (struct memcheck *)
80 				(mem->base + mem->size - sizeof(*check));
81 			overflow = (check->magic != SYSMEM_MAGIC);
82 		} else if (mem->attr.flags & M_ATTR_HOFC) {
83 			check = (struct memcheck *)
84 				(mem->base - sizeof(*check));
85 			overflow = (check->magic != SYSMEM_MAGIC);
86 		} else {
87 			overflow = false;
88 		}
89 
90 		printf("    allocated.rgn[%ld].name  = \"%s\" %s\n",
91 		       i, mem->attr.name, overflow ? "	   <Overflow!>" : "");
92 		printf("		    .addr  = 0x%08lx - 0x%08lx (size: 0x%08lx)\n",
93 		       (ulong)mem->base, (ulong)(mem->base + mem->size),
94 		       (ulong)mem->size);
95 		i++;
96 	}
97 
98 	printf("\n    malloc_r: %d MiB, malloc_f: %d KiB\n",
99 	       SIZE_MB(CONFIG_SYS_MALLOC_LEN), SIZE_KB(CONFIG_SYS_MALLOC_F_LEN));
100 	printf("\n    allocated.total	   = 0x%08lx (%ld MiB. %ld KiB)\n",
101 	       (ulong)allocated_size,
102 	       SIZE_MB((ulong)allocated_size),
103 	       SIZE_KB((ulong)allocated_size));
104 
105 	/* LMB core reserved */
106 	printf("    --------------------------------------------------------------------\n");
107 	reserved_size = 0;
108 	for (i = 0; i < lmb->reserved.cnt; i++) {
109 		reserved_size += lmb->reserved.region[i].size;
110 		printf("    LMB.reserved[%ld].addr   = 0x%08lx - 0x%08lx (size: 0x%08lx)\n", i,
111 		       (ulong)lmb->reserved.region[i].base,
112 		       (ulong)lmb->reserved.region[i].base +
113 		       (ulong)lmb->reserved.region[i].size,
114 		       (ulong)lmb->reserved.region[i].size);
115 	}
116 
117 	printf("\n    reserved.core.total	   = 0x%08lx (%ld MiB. %ld KiB)\n",
118 	       (ulong)reserved_size,
119 	       SIZE_MB((ulong)reserved_size),
120 	       SIZE_KB((ulong)reserved_size));
121 	printf("    --------------------------------------------------------------------\n\n");
122 }
123 
124 static inline int sysmem_is_overlap(phys_addr_t base1, phys_size_t size1,
125 				    phys_addr_t base2, phys_size_t size2)
126 {
127 	return ((base1 < (base2 + size2)) && (base2 < (base1 + size1)));
128 }
129 
130 static int sysmem_add(phys_addr_t base, phys_size_t size)
131 {
132 	struct sysmem *sysmem = &plat_sysmem;
133 	int ret;
134 
135 	if (!size)
136 		return -EINVAL;
137 
138 	ret = lmb_add(&sysmem->lmb, base, size);
139 	if (ret < 0)
140 		SYSMEM_E("Failed to add sysmem at 0x%08lx for 0x%08lx size\n",
141 			 (ulong)base, (ulong)size);
142 
143 	return (ret >= 0) ? 0 : ret;
144 }
145 
146 static const char *sysmem_alias2name(const char *name, int *id)
147 {
148 	const char *alias;
149 	int n, i, j;
150 	int match = 0;
151 
152 	for (i = 0; i < MEMBLK_ID_MAX; i++) {
153 		/* Pirmary name */
154 		if (mem_attr[i].name && !strcasecmp(mem_attr[i].name, name)) {
155 			match = 1;
156 			goto finish;
157 		}
158 
159 		/* Alias name */
160 		alias = mem_attr[i].alias[0];
161 		if (!alias)
162 			continue;
163 
164 		n = ARRAY_SIZE(mem_attr[i].alias);
165 		for (j = 0; j < n; j++, alias++) {
166 			if (alias && !strcasecmp(alias, name)) {
167 				match = 1;
168 				goto finish;
169 			}
170 		}
171 	}
172 
173 finish:
174 	if (match) {
175 		*id = i;
176 		return mem_attr[i].name;
177 	}
178 
179 	return name;
180 }
181 
182 static void *sysmem_alloc_align_base(enum memblk_id id,
183 				     const char *mem_name,
184 				     phys_addr_t base,
185 				     phys_size_t size,
186 				     ulong align)
187 {
188 	struct sysmem *sysmem = &plat_sysmem;
189 	struct memblk_attr attr;
190 	struct memblock *mem;
191 	struct memcheck *check;
192 	struct list_head *node;
193 	const char *name;
194 	phys_addr_t paddr;
195 	phys_addr_t alloc_base;
196 	phys_size_t alloc_size;
197 	phys_addr_t bank_base;
198 	phys_size_t bank_size;
199 	bool req_overlap = false; /* Only for kernel reserved-memory */
200 	int i;
201 
202 	if (!sysmem_has_init())
203 		return NULL;
204 
205 	if (id == MEMBLK_ID_BY_NAME || id == MEMBLK_ID_FDT_RESV) {
206 		if (!mem_name) {
207 			SYSMEM_E("NULL name for alloc sysmem\n");
208 			return NULL;
209 		} else if (id == MEMBLK_ID_FDT_RESV) {
210 			for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
211 				if (!gd->bd->bi_dram[i].size)
212 					continue;
213 
214 				bank_base = gd->bd->bi_dram[i].start;
215 				bank_size = gd->bd->bi_dram[i].size;
216 				if (sysmem_is_overlap(base, size,
217 						      bank_base, bank_size)) {
218 					req_overlap = true;
219 					break;
220 				}
221 			}
222 
223 			if (!req_overlap)
224 				return (void *)base;
225 		}
226 		name = sysmem_alias2name(mem_name, (int *)&id);
227 		attr = mem_attr[id];
228 		if (!attr.name)
229 			attr.name = strdup(name);
230 	} else if (id > MEMBLK_ID_UNK && id < MEMBLK_ID_MAX) {
231 		attr = mem_attr[id];
232 		name = attr.name;
233 	} else {
234 		SYSMEM_E("Unsupport memblk id %d for alloc sysmem\n", id);
235 		return NULL;
236 	}
237 
238 	if (!size) {
239 		SYSMEM_E("\"%s\" size is 0 for alloc sysmem\n", name);
240 		return NULL;
241 	}
242 
243 	if (!IS_ALIGNED(base, 4)) {
244 		SYSMEM_E("\"%s\" base=0x%08lx is not 4-byte aligned\n",
245 			 name, (ulong)base);
246 		return NULL;
247 	}
248 
249 	/* Must be 4-byte aligned */
250 	size = ALIGN(size, 4);
251 
252 	SYSMEM_D("Enter alloc: \"%s\" 0x%08lx - 0x%08lx\n",
253 		 name, (ulong)base, (ulong)(base + size));
254 
255 	/* Already allocated ? */
256 	list_for_each(node, &sysmem->allocated_head) {
257 		mem = list_entry(node, struct memblock, node);
258 		SYSMEM_D("Has allcated: %s, 0x%08lx - 0x%08lx\n",
259 			 mem->attr.name, (ulong)mem->base,
260 			 (ulong)(mem->base + mem->size));
261 		if (!strcmp(mem->attr.name, name)) {
262 			if (mem->base <= base && mem->size >= size)
263 				return (void *)base;
264 
265 			SYSMEM_E("Failed to double alloc for existence \"%s\"\n", name);
266 			return NULL;
267 		} else if (sysmem_is_overlap(mem->base, mem->size, base, size)) {
268 			if (req_overlap && mem->attr.flags & M_ATTR_OVERLAP) {
269 				if (lmb_reserve(&sysmem->lmb, base, size))
270 					SYSMEM_E("Failed to overlap alloc \"%s\" "
271 						 "at 0x%08lx - 0x%08lx\n",
272 						 name, (ulong)base,
273 						 (ulong)(base + size));
274 				return (void *)base;
275 			}
276 
277 			SYSMEM_E("\"%s\" (0x%08lx - 0x%08lx) alloc is "
278 				 "overlap with existence \"%s\" (0x%08lx - "
279 				 "0x%08lx)\n",
280 				 name, (ulong)base, (ulong)(base + size),
281 				 mem->attr.name, (ulong)mem->base,
282 				 (ulong)(mem->base + mem->size));
283 			return NULL;
284 		}
285 	}
286 
287 	/* Add overflow check magic ? */
288 	if (attr.flags & M_ATTR_OFC)
289 		alloc_size = size + sizeof(*check);
290 	else
291 		alloc_size = size;
292 
293 	/* Alloc anywhere ? */
294 	if (base == SYSMEM_ALLOC_ANYWHERE)
295 		alloc_base = base;
296 	else
297 		alloc_base = base + alloc_size;	/* LMB is align down alloc mechanism */
298 
299 	paddr = lmb_alloc_base(&sysmem->lmb, alloc_size, align, alloc_base);
300 	if (paddr) {
301 		if ((paddr == base) || (base == SYSMEM_ALLOC_ANYWHERE)) {
302 			mem = malloc(sizeof(*mem));
303 			if (!mem) {
304 				SYSMEM_E("No memory for \"%s\" alloc sysmem\n", name);
305 				return NULL;
306 			}
307 
308 			mem->base = paddr;
309 			mem->size = alloc_size;
310 			mem->attr = attr;
311 			sysmem->allocated_cnt++;
312 			list_add_tail(&mem->node, &sysmem->allocated_head);
313 
314 			if (mem->attr.flags & M_ATTR_OFC) {
315 				check = (struct memcheck *)(paddr + size);
316 				check->magic = SYSMEM_MAGIC;
317 			} else if (mem->attr.flags & M_ATTR_HOFC) {
318 				check = (struct memcheck *)(paddr - sizeof(*check));
319 				check->magic = SYSMEM_MAGIC;
320 			}
321 		} else {
322 			SYSMEM_E("Failed to alloc \"%s\" expect at 0x%08lx - 0x%08lx "
323 				 "but at 0x%08lx - x%08lx\n",
324 				 name, (ulong)base, (ulong)(base + size),
325 				 (ulong)paddr, (ulong)(paddr + size));
326 			if (lmb_free(&sysmem->lmb, paddr, alloc_size))
327 				SYSMEM_E("Failed to free \"%s\"\n", name);
328 
329 			return NULL;
330 		}
331 	} else {
332 		SYSMEM_E("Failed to alloc \"%s\" at 0x%08lx - 0x%08lx\n",
333 			 name, (ulong)base, (ulong)(base + size));
334 	}
335 
336 	SYSMEM_D("Exit alloc: \"%s\", paddr=0x%08lx, size=0x%08lx, align=0x%x, anywhere=%d\n",
337 		 name, (ulong)paddr, (ulong)size, (u32)align, !base);
338 
339 	return (void *)paddr;
340 }
341 
342 void *sysmem_alloc_base(enum memblk_id id, phys_addr_t base, phys_size_t size)
343 {
344 	void *paddr;
345 
346 	paddr = sysmem_alloc_align_base(id,
347 					NULL,
348 					base,
349 					size,
350 					SYSMEM_ALLOC_NO_ALIGN);
351 	if (!paddr)
352 		sysmem_dump();
353 
354 	return paddr;
355 }
356 
357 void *sysmem_alloc_base_by_name(const char *name,
358 				phys_addr_t base, phys_size_t size)
359 {
360 	void *paddr;
361 
362 	paddr = sysmem_alloc_align_base(MEMBLK_ID_BY_NAME,
363 					name,
364 					base,
365 					size,
366 					SYSMEM_ALLOC_NO_ALIGN);
367 	if (!paddr)
368 		sysmem_dump();
369 
370 	return paddr;
371 }
372 
373 void *sysmem_fdt_reserve_alloc_base(const char *name,
374 				    phys_addr_t base, phys_size_t size)
375 {
376 	void *paddr;
377 
378 	paddr = sysmem_alloc_align_base(MEMBLK_ID_FDT_RESV,
379 					name,
380 					base,
381 					size,
382 					SYSMEM_ALLOC_NO_ALIGN);
383 	if (!paddr)
384 		sysmem_dump();
385 
386 	return paddr;
387 }
388 
389 int sysmem_free(phys_addr_t base)
390 {
391 	struct sysmem *sysmem = &plat_sysmem;
392 	struct memblock *mem;
393 	struct list_head *node;
394 	int ret, found = 0;
395 
396 	if (!sysmem_has_init())
397 		return -ENOSYS;
398 
399 	/* Find existence */
400 	list_for_each(node, &sysmem->allocated_head) {
401 		mem = list_entry(node, struct memblock, node);
402 		if (mem->base == base) {
403 			found = 1;
404 			break;
405 		}
406 	}
407 
408 	if (!found) {
409 		SYSMEM_E("Failed to free no allocated sysmem at 0x%08lx\n",
410 			 (ulong)base);
411 		return -EINVAL;
412 	}
413 
414 	ret = lmb_free(&sysmem->lmb, mem->base, mem->size);
415 	if (ret >= 0) {
416 		SYSMEM_D("Free: \"%s\" 0x%08lx - 0x%08lx\n",
417 			 mem->attr.name, (ulong)mem->base,
418 			 (ulong)(mem->base + mem->size));
419 		sysmem->allocated_cnt--;
420 		list_del(&mem->node);
421 		free(mem);
422 	} else {
423 		SYSMEM_E("Failed to free \"%s\" at 0x%08lx\n",
424 			 mem->attr.name, (ulong)base);
425 	}
426 
427 	return (ret >= 0) ? 0 : ret;
428 }
429 
430 int sysmem_initr(void)
431 {
432 	return sysmem_init();
433 }
434 
435 int sysmem_init(void)
436 {
437 	struct sysmem *sysmem = &plat_sysmem;
438 	phys_addr_t mem_start;
439 	phys_size_t mem_size;
440 	int ret;
441 
442 	lmb_init(&sysmem->lmb);
443 	INIT_LIST_HEAD(&sysmem->allocated_head);
444 	sysmem->allocated_cnt = 0;
445 	if (gd->flags & GD_FLG_RELOC) {
446 		sysmem->has_initr = true;
447 	} else {
448 		SYSMEM_I("init\n");
449 		sysmem->has_initf = true;
450 	}
451 
452 	/* Add all available system memory */
453 #ifdef CONFIG_NR_DRAM_BANKS
454 	int i;
455 
456 	for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
457 		if (!gd->bd->bi_dram[i].size)
458 			continue;
459 
460 		ret = sysmem_add(gd->bd->bi_dram[i].start,
461 				 gd->bd->bi_dram[i].size);
462 		if (ret) {
463 			SYSMEM_E("Failed to add sysmem from bi_dram[%d]\n", i);
464 			goto fail;
465 		}
466 	}
467 #else
468 	mem_start = env_get_bootm_low();
469 	mem_size = env_get_bootm_size();
470 	ret = sysmem_add(mem_start, mem_size);
471 	if (ret) {
472 		SYSMEM_E("Failed to add sysmem from bootm_low/size\n");
473 		goto fail;
474 	}
475 #endif
476 	/* Reserved for board */
477 	ret = board_sysmem_reserve(sysmem);
478 	if (ret) {
479 		SYSMEM_E("Failed to reserve sysmem for board\n");
480 		goto fail;
481 	}
482 
483 	/* Reserved for U-boot framework: 'reserve_xxx()' */
484 	mem_start = gd->start_addr_sp;
485 	mem_size = gd->ram_top - mem_start;
486 	if (!sysmem_alloc_base(MEMBLK_ID_UBOOT, mem_start, mem_size)) {
487 		SYSMEM_E("Failed to reserve sysmem for U-Boot framework\n");
488 		ret = -ENOMEM;
489 		goto fail;
490 	}
491 
492 	/* Reserved for U-Boot stack */
493 	mem_start = gd->start_addr_sp - CONFIG_SYS_STACK_SIZE;
494 	mem_size = CONFIG_SYS_STACK_SIZE;
495 	if (!sysmem_alloc_base(MEMBLK_ID_STACK, mem_start, mem_size)) {
496 		SYSMEM_E("Failed to reserve sysmem for stack\n");
497 		ret = -ENOMEM;
498 		goto fail;
499 	}
500 
501 	return 0;
502 
503 fail:
504 	if (ret && !(gd->flags & GD_FLG_RELOC)) {
505 		sysmem_dump();
506 		SYSMEM_W("Maybe malloc size %d MiB is too large?\n\n",
507 			 SIZE_MB(CONFIG_SYS_MALLOC_LEN));
508 	}
509 
510 	return ret;
511 }
512 
513 __weak int board_sysmem_reserve(struct sysmem *sysmem)
514 {
515 	/* please define platform specific board_sysmem_reserve() */
516 	return 0;
517 }
518 
519 static int do_dump_sysmem(cmd_tbl_t *cmdtp, int flag,
520 			  int argc, char *const argv[])
521 {
522 	sysmem_dump();
523 	return 0;
524 }
525 
526 U_BOOT_CMD(
527 	dump_sysmem, 1, 1, do_dump_sysmem,
528 	"Dump sysmem layout",
529 	""
530 );
531