xref: /OK3568_Linux_fs/u-boot/include/sysmem.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier:     GPL-2.0+ */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * (C) Copyright 2019 Rockchip Electronics Co., Ltd
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #ifndef _SYSMEM_H
7*4882a593Smuzhiyun #define _SYSMEM_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <memblk.h>
10*4882a593Smuzhiyun #include <malloc.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun /*
13*4882a593Smuzhiyun  * CONFIG_SYS_FDT_PAD default value is sync with bootm framework in:
14*4882a593Smuzhiyun  * common/image-fdt.c
15*4882a593Smuzhiyun  */
16*4882a593Smuzhiyun #ifndef CONFIG_SYS_FDT_PAD
17*4882a593Smuzhiyun #define CONFIG_SYS_FDT_PAD		0x3000
18*4882a593Smuzhiyun #endif
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun struct sysmem {
21*4882a593Smuzhiyun 	struct lmb lmb;
22*4882a593Smuzhiyun 	struct list_head allocated_head;
23*4882a593Smuzhiyun 	struct list_head kmem_resv_head;
24*4882a593Smuzhiyun 	ulong allocated_cnt;
25*4882a593Smuzhiyun 	ulong kmem_resv_cnt;
26*4882a593Smuzhiyun 	bool has_initf;
27*4882a593Smuzhiyun 	bool has_initr;
28*4882a593Smuzhiyun };
29*4882a593Smuzhiyun 
30*4882a593Smuzhiyun #ifdef CONFIG_SYSMEM
31*4882a593Smuzhiyun /**
32*4882a593Smuzhiyun  * sysmem_has_init() - Is sysmem initialized
33*4882a593Smuzhiyun  *
34*4882a593Smuzhiyun  * @return true or false
35*4882a593Smuzhiyun  */
36*4882a593Smuzhiyun bool sysmem_has_init(void);
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun /**
39*4882a593Smuzhiyun  * sysmem_init() - Sysmem initialization
40*4882a593Smuzhiyun  *
41*4882a593Smuzhiyun  * @return 0 on success, otherwise error
42*4882a593Smuzhiyun  */
43*4882a593Smuzhiyun int sysmem_init(void);
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /**
46*4882a593Smuzhiyun  * sysmem_initr() - Sysmem initialization after relocation
47*4882a593Smuzhiyun  *
48*4882a593Smuzhiyun  * @return 0 on success, otherwise error
49*4882a593Smuzhiyun  */
50*4882a593Smuzhiyun int sysmem_initr(void);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun /**
53*4882a593Smuzhiyun  * sysmem_alloc() - Alloc sysmem region at anywhere
54*4882a593Smuzhiyun  *
55*4882a593Smuzhiyun  * @id: memblk id
56*4882a593Smuzhiyun  * @size: region size
57*4882a593Smuzhiyun  *
58*4882a593Smuzhiyun  * @return NULL on error, otherwise the allocated region address ptr
59*4882a593Smuzhiyun  */
60*4882a593Smuzhiyun void *sysmem_alloc(enum memblk_id id, phys_size_t size);
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /**
63*4882a593Smuzhiyun  * sysmem_alloc_by_name() - Alloc sysmem region by name at the expect addr
64*4882a593Smuzhiyun  *
65*4882a593Smuzhiyun  * @name: memblk name
66*4882a593Smuzhiyun  * @size: region size
67*4882a593Smuzhiyun  *
68*4882a593Smuzhiyun  * @return NULL on error, otherwise the allocated region address ptr
69*4882a593Smuzhiyun  */
70*4882a593Smuzhiyun void *sysmem_alloc_by_name(const char *name, phys_size_t size);
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun /**
73*4882a593Smuzhiyun  * sysmem_alloc_base() - Alloc sysmem region at the expect addr
74*4882a593Smuzhiyun  *
75*4882a593Smuzhiyun  * @id: memblk id
76*4882a593Smuzhiyun  * @base: region base
77*4882a593Smuzhiyun  * @size: region size
78*4882a593Smuzhiyun  *
79*4882a593Smuzhiyun  * @return NULL on error, otherwise the allocated region address ptr
80*4882a593Smuzhiyun  */
81*4882a593Smuzhiyun void *sysmem_alloc_base(enum memblk_id id, phys_addr_t base, phys_size_t size);
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun /**
84*4882a593Smuzhiyun  * sysmem_alloc_base_by_name() - Alloc sysmem region at the expect addr by name
85*4882a593Smuzhiyun  *
86*4882a593Smuzhiyun  * @name: memblk name
87*4882a593Smuzhiyun  * @base: region base
88*4882a593Smuzhiyun  * @size: region size
89*4882a593Smuzhiyun  *
90*4882a593Smuzhiyun  * @return NULL on error, otherwise the allocated region address ptr
91*4882a593Smuzhiyun  */
92*4882a593Smuzhiyun void *sysmem_alloc_base_by_name(const char *name,
93*4882a593Smuzhiyun 				phys_addr_t base, phys_size_t size);
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun /**
96*4882a593Smuzhiyun  * sysmem_fdt_reserve_alloc_base() - Alloc sysmem region at the expect addr by name,
97*4882a593Smuzhiyun  *				     called only for reserve memory from fdt.
98*4882a593Smuzhiyun  *
99*4882a593Smuzhiyun  * @name: memblk name
100*4882a593Smuzhiyun  * @base: region base
101*4882a593Smuzhiyun  * @size: region size
102*4882a593Smuzhiyun  *
103*4882a593Smuzhiyun  * @return NULL on error, otherwise the allocated region address ptr
104*4882a593Smuzhiyun  */
105*4882a593Smuzhiyun void *sysmem_fdt_reserve_alloc_base(const char *name,
106*4882a593Smuzhiyun 				    phys_addr_t base, phys_size_t size);
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun /**
109*4882a593Smuzhiyun  * sysmem_alloc_temporary_mem() - Alloc a temporary shared memory buffer
110*4882a593Smuzhiyun  *
111*4882a593Smuzhiyun  * @size: region size
112*4882a593Smuzhiyun  *
113*4882a593Smuzhiyun  * @return 0 on failed, otherwise allocated addr.
114*4882a593Smuzhiyun  */
115*4882a593Smuzhiyun ulong sysmem_alloc_temporary_mem(phys_size_t size);
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun /**
118*4882a593Smuzhiyun  * sysmem_free() - Free allocated sysmem region
119*4882a593Smuzhiyun  *
120*4882a593Smuzhiyun  * @base: region base
121*4882a593Smuzhiyun  *
122*4882a593Smuzhiyun  * @return 0 on success, otherwise error
123*4882a593Smuzhiyun  */
124*4882a593Smuzhiyun int sysmem_free(phys_addr_t base);
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun /**
127*4882a593Smuzhiyun  * sysmem_dump() - Dump all sysmem region state
128*4882a593Smuzhiyun  */
129*4882a593Smuzhiyun void sysmem_dump(void);
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun /**
132*4882a593Smuzhiyun  * sysmem_overflow_check() - Sysmem regions overflow check
133*4882a593Smuzhiyun  */
134*4882a593Smuzhiyun void sysmem_overflow_check(void);
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun /**
137*4882a593Smuzhiyun  * board_sysmem_reserve() - Weak function for board to implement
138*4882a593Smuzhiyun  *
139*4882a593Smuzhiyun  * @sysmem: global sysmem point, ignored
140*4882a593Smuzhiyun  *
141*4882a593Smuzhiyun  * @return 0 on success, otherwise error
142*4882a593Smuzhiyun  */
143*4882a593Smuzhiyun int board_sysmem_reserve(struct sysmem *sysmem);
144*4882a593Smuzhiyun #else
sysmem_has_init(void)145*4882a593Smuzhiyun static inline bool sysmem_has_init(void) { return false; }
sysmem_init(void)146*4882a593Smuzhiyun static inline int sysmem_init(void) { return 0; }
sysmem_initr(void)147*4882a593Smuzhiyun static inline int sysmem_initr(void) { return 0; }
sysmem_free(phys_addr_t base)148*4882a593Smuzhiyun static inline int sysmem_free(phys_addr_t base) { return 0; }
sysmem_dump(void)149*4882a593Smuzhiyun static inline void sysmem_dump(void) {}
sysmem_overflow_check(void)150*4882a593Smuzhiyun static inline void sysmem_overflow_check(void) {}
board_sysmem_reserve(struct sysmem * sysmem)151*4882a593Smuzhiyun __weak int board_sysmem_reserve(struct sysmem *sysmem) { return 0; }
152*4882a593Smuzhiyun 
sysmem_alloc(enum memblk_id id,phys_size_t size)153*4882a593Smuzhiyun static inline void *sysmem_alloc(enum memblk_id id, phys_size_t size)
154*4882a593Smuzhiyun {
155*4882a593Smuzhiyun 	return malloc(size);
156*4882a593Smuzhiyun }
157*4882a593Smuzhiyun 
sysmem_alloc_temporary_mem(phys_size_t size)158*4882a593Smuzhiyun static inline ulong sysmem_alloc_temporary_mem(phys_size_t size)
159*4882a593Smuzhiyun {
160*4882a593Smuzhiyun 	return 0;
161*4882a593Smuzhiyun }
162*4882a593Smuzhiyun 
sysmem_alloc_base(enum memblk_id id,phys_addr_t base,phys_size_t size)163*4882a593Smuzhiyun static inline void *sysmem_alloc_base(enum memblk_id id,
164*4882a593Smuzhiyun 				      phys_addr_t base, phys_size_t size)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun 	return (void *)base;
167*4882a593Smuzhiyun }
sysmem_alloc_base_by_name(const char * name,phys_addr_t base,phys_size_t size)168*4882a593Smuzhiyun static inline void *sysmem_alloc_base_by_name(const char *name,
169*4882a593Smuzhiyun 					      phys_addr_t base,
170*4882a593Smuzhiyun 					      phys_size_t size)
171*4882a593Smuzhiyun {
172*4882a593Smuzhiyun 	return (void *)base;
173*4882a593Smuzhiyun }
sysmem_fdt_reserve_alloc_base(const char * name,phys_addr_t base,phys_size_t size)174*4882a593Smuzhiyun static inline void *sysmem_fdt_reserve_alloc_base(const char *name,
175*4882a593Smuzhiyun 						  phys_addr_t base,
176*4882a593Smuzhiyun 						  phys_size_t size)
177*4882a593Smuzhiyun {
178*4882a593Smuzhiyun 	return (void *)base;
179*4882a593Smuzhiyun }
180*4882a593Smuzhiyun #endif /* CONFIG_SYSMEM */
181*4882a593Smuzhiyun #endif /* _SYSMEM_H */
182