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 _BIDRAM_H
7*4882a593Smuzhiyun #define _BIDRAM_H
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #include <memblk.h>
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun typedef struct memblock *(*parse_fn_t)(int *);
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun struct bidram {
14*4882a593Smuzhiyun struct lmb lmb;
15*4882a593Smuzhiyun struct list_head reserved_head;
16*4882a593Smuzhiyun bool has_init;
17*4882a593Smuzhiyun bool fixup;
18*4882a593Smuzhiyun u64 base_u64[MEM_RESV_COUNT]; /* 4GB+ */
19*4882a593Smuzhiyun u64 size_u64[MEM_RESV_COUNT];
20*4882a593Smuzhiyun };
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun #ifdef CONFIG_BIDRAM
23*4882a593Smuzhiyun /**
24*4882a593Smuzhiyun * bidram_initr() - Initial bidram after relocation.
25*4882a593Smuzhiyun *
26*4882a593Smuzhiyun * @return 0 on success, otherwise error
27*4882a593Smuzhiyun */
28*4882a593Smuzhiyun int bidram_initr(void);
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun /**
31*4882a593Smuzhiyun * bidram_get_ram_size() - Initial bidram and get ram size.
32*4882a593Smuzhiyun *
33*4882a593Smuzhiyun * @parse_fn: function to parse ddr memory regions
34*4882a593Smuzhiyun *
35*4882a593Smuzhiyun * @return ram size, 0 on success, otherwise the effect ram size.
36*4882a593Smuzhiyun */
37*4882a593Smuzhiyun phys_size_t bidram_get_ram_size(void);
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun /**
40*4882a593Smuzhiyun * bidram_gen_gd_bi_dram() - Update gd->bd->bi_dram[] according to bidram state.
41*4882a593Smuzhiyun */
42*4882a593Smuzhiyun void bidram_gen_gd_bi_dram(void);
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun /**
45*4882a593Smuzhiyun * bidram_reserve() - Reserve bidram region
46*4882a593Smuzhiyun *
47*4882a593Smuzhiyun * @id: memblk id
48*4882a593Smuzhiyun * @base: region base address
49*4882a593Smuzhiyun * @size: region size
50*4882a593Smuzhiyun *
51*4882a593Smuzhiyun * @return 0 on success, otherwise error
52*4882a593Smuzhiyun */
53*4882a593Smuzhiyun int bidram_reserve(enum memblk_id id, phys_addr_t base, phys_size_t size);
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun /**
56*4882a593Smuzhiyun * bidram_reserve_by_name() - Reserve bidram region by name
57*4882a593Smuzhiyun *
58*4882a593Smuzhiyun * @name: region name
59*4882a593Smuzhiyun * @base: region base address
60*4882a593Smuzhiyun * @size: region size
61*4882a593Smuzhiyun *
62*4882a593Smuzhiyun * @return 0 on success, otherwise error
63*4882a593Smuzhiyun */
64*4882a593Smuzhiyun int bidram_reserve_by_name(const char *name, phys_addr_t base, phys_size_t size);
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun /**
67*4882a593Smuzhiyun * bidram_dump_all() - Dump all bidram stat
68*4882a593Smuzhiyun */
69*4882a593Smuzhiyun void bidram_dump(void);
70*4882a593Smuzhiyun
71*4882a593Smuzhiyun /**
72*4882a593Smuzhiyun * bidram_fixup() - Fixup bi_dram[] for 4GB+ memory
73*4882a593Smuzhiyun *
74*4882a593Smuzhiyun * @return 0 on success, otherwise error
75*4882a593Smuzhiyun */
76*4882a593Smuzhiyun int bidram_fixup(void);
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun /**
79*4882a593Smuzhiyun * bidram_append_size() - Append 4GB+ memory
80*4882a593Smuzhiyun *
81*4882a593Smuzhiyun * @return 4GB+ size
82*4882a593Smuzhiyun */
83*4882a593Smuzhiyun u64 bidram_append_size(void);
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun /**
86*4882a593Smuzhiyun * bidram_reserved_is_overlap() - Check outside memory is overlap with reserved
87*4882a593Smuzhiyun *
88*4882a593Smuzhiyun * @base: region base address
89*4882a593Smuzhiyun * @size: region size
90*4882a593Smuzhiyun *
91*4882a593Smuzhiyun * @return memblk struct when overlap, otherwise NULL
92*4882a593Smuzhiyun */
93*4882a593Smuzhiyun struct memblock *bidram_reserved_is_overlap(phys_addr_t base, phys_size_t size);
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun /**
96*4882a593Smuzhiyun * board_bidram_parse_fn() - Weak function for board to implement
97*4882a593Smuzhiyun */
98*4882a593Smuzhiyun parse_fn_t board_bidram_parse_fn(void);
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun /**
101*4882a593Smuzhiyun * board_bidram_reserve() - Weak function for board to implement
102*4882a593Smuzhiyun *
103*4882a593Smuzhiyun * @bidram: global bidram point, ignored
104*4882a593Smuzhiyun *
105*4882a593Smuzhiyun * @return 0 on success, otherwise error
106*4882a593Smuzhiyun */
107*4882a593Smuzhiyun int board_bidram_reserve(struct bidram *bidram);
108*4882a593Smuzhiyun #else
bidram_initr(void)109*4882a593Smuzhiyun static inline int bidram_initr(void) { return 0; }
bidram_get_ram_size(void)110*4882a593Smuzhiyun static inline phys_size_t bidram_get_ram_size(void) { return 0; }
bidram_gen_gd_bi_dram(void)111*4882a593Smuzhiyun static inline void bidram_gen_gd_bi_dram(void) { }
bidram_reserve(enum memblk_id id,phys_addr_t base,phys_size_t size)112*4882a593Smuzhiyun static inline int bidram_reserve(enum memblk_id id, phys_addr_t base,
113*4882a593Smuzhiyun phys_size_t size) { return 0; }
bidram_reserve_by_name(const char * name,phys_addr_t base,phys_size_t size)114*4882a593Smuzhiyun static inline int bidram_reserve_by_name(const char *name, phys_addr_t base,
115*4882a593Smuzhiyun phys_size_t size) { return 0; }
bidram_dump(void)116*4882a593Smuzhiyun static inline void bidram_dump(void) {}
bidram_fixup(void)117*4882a593Smuzhiyun static inline int bidram_fixup(void) { return 0; }
bidram_append_size(void)118*4882a593Smuzhiyun static inline u64 bidram_append_size(void) { return 0; }
board_bidram_parse_fn(void)119*4882a593Smuzhiyun static inline parse_fn_t board_bidram_parse_fn(void) { return NULL; }
board_bidram_reserve(struct bidram * bidram)120*4882a593Smuzhiyun static inline int board_bidram_reserve(struct bidram *bidram) { return 0; }
121*4882a593Smuzhiyun static inline struct memblock *
bidram_reserved_is_overlap(phys_addr_t base,phys_size_t size)122*4882a593Smuzhiyun bidram_reserved_is_overlap(phys_addr_t base, phys_size_t size)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun return NULL;
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun #endif
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun #endif /* _BIDRAM_H */
130