xref: /rk3399_rockchip-uboot/lib/sysmem.c (revision 6e15146effedeaad2a6687afcbf83d1907a0b996)
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 	bool req_overlap = false;
198 
199 	if (!sysmem_has_init())
200 		return NULL;
201 
202 	if (id == MEMBLK_ID_BY_NAME || id == MEMBLK_ID_FDT_RESV) {
203 		if (!mem_name) {
204 			SYSMEM_E("NULL name for alloc sysmem\n");
205 			return NULL;
206 		} else if (id == MEMBLK_ID_FDT_RESV) {
207 			req_overlap = true;
208 			if (base >= gd->ram_top)
209 				return (void *)base;
210 		}
211 		name = sysmem_alias2name(mem_name, (int *)&id);
212 		attr = mem_attr[id];
213 	} else if (id > MEMBLK_ID_UNK && id < MEMBLK_ID_MAX) {
214 		attr = mem_attr[id];
215 		name = attr.name;
216 	} else {
217 		SYSMEM_E("Unsupport memblk id %d for alloc sysmem\n", id);
218 		return NULL;
219 	}
220 
221 	if (!size) {
222 		SYSMEM_E("\"%s\" size is 0 for alloc sysmem\n", name);
223 		return NULL;
224 	}
225 
226 	if (!IS_ALIGNED(base, 4)) {
227 		SYSMEM_E("\"%s\" base=0x%08lx is not 4-byte aligned\n",
228 			 name, (ulong)base);
229 		return NULL;
230 	}
231 
232 	/* Must be 4-byte aligned */
233 	size = ALIGN(size, 4);
234 
235 	SYSMEM_D("Enter alloc: \"%s\" 0x%08lx - 0x%08lx\n",
236 		 name, (ulong)base, (ulong)(base + size));
237 
238 	/* Already allocated ? */
239 	list_for_each(node, &sysmem->allocated_head) {
240 		mem = list_entry(node, struct memblock, node);
241 		SYSMEM_D("Has allcated: %s, 0x%08lx - 0x%08lx\n",
242 			 mem->attr.name, (ulong)mem->base,
243 			 (ulong)(mem->base + mem->size));
244 		if (!strcmp(mem->attr.name, name)) {
245 			SYSMEM_E("Failed to double alloc for existence \"%s\"\n", name);
246 			return NULL;
247 		} else if (sysmem_is_overlap(mem->base, mem->size, base, size)) {
248 			if (req_overlap && mem->attr.flags & M_ATTR_OVERLAP) {
249 				if (lmb_reserve(&sysmem->lmb, base, size))
250 					SYSMEM_E("Failed to overlap alloc \"%s\" "
251 						 "at 0x%08lx - 0x%08lx\n",
252 						 name, (ulong)base,
253 						 (ulong)(base + size));
254 				return (void *)base;
255 			}
256 
257 			SYSMEM_E("\"%s\" (0x%08lx - 0x%08lx) alloc is "
258 				 "overlap with existence \"%s\" (0x%08lx - "
259 				 "0x%08lx)\n",
260 				 name, (ulong)base, (ulong)(base + size),
261 				 mem->attr.name, (ulong)mem->base,
262 				 (ulong)(mem->base + mem->size));
263 			return NULL;
264 		}
265 	}
266 
267 	/* Add overflow check magic ? */
268 	if (attr.flags & M_ATTR_OFC)
269 		alloc_size = size + sizeof(*check);
270 	else
271 		alloc_size = size;
272 
273 	/* Alloc anywhere ? */
274 	if (base == SYSMEM_ALLOC_ANYWHERE)
275 		alloc_base = base;
276 	else
277 		alloc_base = base + alloc_size;	/* LMB is align down alloc mechanism */
278 
279 	paddr = lmb_alloc_base(&sysmem->lmb, alloc_size, align, alloc_base);
280 	if (paddr) {
281 		if ((paddr == base) || (base == SYSMEM_ALLOC_ANYWHERE)) {
282 			mem = malloc(sizeof(*mem));
283 			if (!mem) {
284 				SYSMEM_E("No memory for \"%s\" alloc sysmem\n", name);
285 				return NULL;
286 			}
287 
288 			mem->base = paddr;
289 			mem->size = alloc_size;
290 			mem->attr = attr;
291 			sysmem->allocated_cnt++;
292 			list_add_tail(&mem->node, &sysmem->allocated_head);
293 
294 			if (mem->attr.flags & M_ATTR_OFC) {
295 				check = (struct memcheck *)(paddr + size);
296 				check->magic = SYSMEM_MAGIC;
297 			} else if (mem->attr.flags & M_ATTR_HOFC) {
298 				check = (struct memcheck *)(paddr - sizeof(*check));
299 				check->magic = SYSMEM_MAGIC;
300 			}
301 		} else {
302 			SYSMEM_E("Failed to alloc \"%s\" expect at 0x%08lx - 0x%08lx "
303 				 "but at 0x%08lx - x%08lx\n",
304 				 name, (ulong)base, (ulong)(base + size),
305 				 (ulong)paddr, (ulong)(paddr + size));
306 			if (lmb_free(&sysmem->lmb, paddr, alloc_size))
307 				SYSMEM_E("Failed to free \"%s\"\n", name);
308 
309 			return NULL;
310 		}
311 	} else {
312 		SYSMEM_E("Failed to alloc \"%s\" at 0x%08lx - 0x%08lx\n",
313 			 name, (ulong)base, (ulong)(base + size));
314 	}
315 
316 	SYSMEM_D("Exit alloc: \"%s\", paddr=0x%08lx, size=0x%08lx, align=0x%x, anywhere=%d\n",
317 		 name, (ulong)paddr, (ulong)size, (u32)align, !base);
318 
319 	return (void *)paddr;
320 }
321 
322 void *sysmem_alloc_base(enum memblk_id id, phys_addr_t base, phys_size_t size)
323 {
324 	void *paddr;
325 
326 	paddr = sysmem_alloc_align_base(id,
327 					NULL,
328 					base,
329 					size,
330 					SYSMEM_ALLOC_NO_ALIGN);
331 	if (!paddr)
332 		sysmem_dump();
333 
334 	return paddr;
335 }
336 
337 void *sysmem_alloc_base_by_name(const char *name,
338 				phys_addr_t base, phys_size_t size)
339 {
340 	void *paddr;
341 
342 	paddr = sysmem_alloc_align_base(MEMBLK_ID_BY_NAME,
343 					name,
344 					base,
345 					size,
346 					SYSMEM_ALLOC_NO_ALIGN);
347 	if (!paddr)
348 		sysmem_dump();
349 
350 	return paddr;
351 }
352 
353 void *sysmem_fdt_reserve_alloc_base(const char *name,
354 				    phys_addr_t base, phys_size_t size)
355 {
356 	void *paddr;
357 
358 	paddr = sysmem_alloc_align_base(MEMBLK_ID_FDT_RESV,
359 					name,
360 					base,
361 					size,
362 					SYSMEM_ALLOC_NO_ALIGN);
363 	if (!paddr)
364 		sysmem_dump();
365 
366 	return paddr;
367 }
368 
369 int sysmem_free(phys_addr_t base)
370 {
371 	struct sysmem *sysmem = &plat_sysmem;
372 	struct memblock *mem;
373 	struct list_head *node;
374 	int ret, found = 0;
375 
376 	if (!sysmem_has_init())
377 		return -ENOSYS;
378 
379 	/* Find existence */
380 	list_for_each(node, &sysmem->allocated_head) {
381 		mem = list_entry(node, struct memblock, node);
382 		if (mem->base == base) {
383 			found = 1;
384 			break;
385 		}
386 	}
387 
388 	if (!found) {
389 		SYSMEM_E("Failed to free no allocated sysmem at 0x%08lx\n",
390 			 (ulong)base);
391 		return -EINVAL;
392 	}
393 
394 	ret = lmb_free(&sysmem->lmb, mem->base, mem->size);
395 	if (ret >= 0) {
396 		SYSMEM_D("Free: \"%s\" 0x%08lx - 0x%08lx\n",
397 			 mem->attr.name, (ulong)mem->base,
398 			 (ulong)(mem->base + mem->size));
399 		sysmem->allocated_cnt--;
400 		list_del(&mem->node);
401 		free(mem);
402 	} else {
403 		SYSMEM_E("Failed to free \"%s\" at 0x%08lx\n",
404 			 mem->attr.name, (ulong)base);
405 	}
406 
407 	return (ret >= 0) ? 0 : ret;
408 }
409 
410 int sysmem_initr(void)
411 {
412 	return sysmem_init();
413 }
414 
415 int sysmem_init(void)
416 {
417 	struct sysmem *sysmem = &plat_sysmem;
418 	phys_addr_t mem_start;
419 	phys_size_t mem_size;
420 	int ret;
421 
422 	lmb_init(&sysmem->lmb);
423 	INIT_LIST_HEAD(&sysmem->allocated_head);
424 	sysmem->allocated_cnt = 0;
425 	if (gd->flags & GD_FLG_RELOC) {
426 		sysmem->has_initr = true;
427 	} else {
428 		SYSMEM_I("init\n");
429 		sysmem->has_initf = true;
430 	}
431 
432 	/* Add all available system memory */
433 #ifdef CONFIG_NR_DRAM_BANKS
434 	int i;
435 
436 	for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
437 		if (!gd->bd->bi_dram[i].size)
438 			continue;
439 
440 		ret = sysmem_add(gd->bd->bi_dram[i].start,
441 				 gd->bd->bi_dram[i].size);
442 		if (ret) {
443 			SYSMEM_E("Failed to add sysmem from bi_dram[%d]\n", i);
444 			goto fail;
445 		}
446 	}
447 #else
448 	mem_start = env_get_bootm_low();
449 	mem_size = env_get_bootm_size();
450 	ret = sysmem_add(mem_start, mem_size);
451 	if (ret) {
452 		SYSMEM_E("Failed to add sysmem from bootm_low/size\n");
453 		goto fail;
454 	}
455 #endif
456 	/* Reserved for board */
457 	ret = board_sysmem_reserve(sysmem);
458 	if (ret) {
459 		SYSMEM_E("Failed to reserve sysmem for board\n");
460 		goto fail;
461 	}
462 
463 	/* Reserved for U-boot framework: 'reserve_xxx()' */
464 	mem_start = gd->start_addr_sp;
465 	mem_size = gd->ram_top - mem_start;
466 	if (!sysmem_alloc_base(MEMBLK_ID_UBOOT, mem_start, mem_size)) {
467 		SYSMEM_E("Failed to reserve sysmem for U-Boot framework\n");
468 		ret = -ENOMEM;
469 		goto fail;
470 	}
471 
472 	/* Reserved for U-Boot stack */
473 	mem_start = gd->start_addr_sp - CONFIG_SYS_STACK_SIZE;
474 	mem_size = CONFIG_SYS_STACK_SIZE;
475 	if (!sysmem_alloc_base(MEMBLK_ID_STACK, mem_start, mem_size)) {
476 		SYSMEM_E("Failed to reserve sysmem for stack\n");
477 		ret = -ENOMEM;
478 		goto fail;
479 	}
480 
481 	return 0;
482 
483 fail:
484 	if (ret && !(gd->flags & GD_FLG_RELOC)) {
485 		sysmem_dump();
486 		SYSMEM_W("Maybe malloc size %d MiB is too large?\n\n",
487 			 SIZE_MB(CONFIG_SYS_MALLOC_LEN));
488 	}
489 
490 	return ret;
491 }
492 
493 __weak int board_sysmem_reserve(struct sysmem *sysmem)
494 {
495 	/* please define platform specific board_sysmem_reserve() */
496 	return 0;
497 }
498 
499 static int do_dump_sysmem(cmd_tbl_t *cmdtp, int flag,
500 			  int argc, char *const argv[])
501 {
502 	sysmem_dump();
503 	return 0;
504 }
505 
506 U_BOOT_CMD(
507 	dump_sysmem, 1, 1, do_dump_sysmem,
508 	"Dump sysmem layout",
509 	""
510 );
511