1 /*
2 * (C) Copyright 2007
3 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
4 *
5 * SPDX-License-Identifier: GPL-2.0+
6 */
7
8 #ifndef __FDT_SUPPORT_H
9 #define __FDT_SUPPORT_H
10
11 #ifdef CONFIG_OF_LIBFDT
12
13 #include <linux/libfdt.h>
14 #include <abuf.h>
15
16 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
17 const char *prop, const u32 dflt);
18 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
19 const char *prop, const u32 dflt);
20 int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
21 uint64_t val, int is_u64);
22 /**
23 * Add data to the root of the FDT before booting the OS.
24 *
25 * See doc/device-tree-bindings/root.txt
26 *
27 * @param fdt FDT address in memory
28 * @return 0 if ok, or -FDT_ERR_... on error
29 */
30 int fdt_root(void *fdt);
31
32 /**
33 * Append info to bootargs
34 *
35 * @param fdt FDT address in memory
36 * @param data string info
37 * @return 0 if ok, else error
38 */
39 int fdt_bootargs_append(void *fdt, char *data);
40
41 /**
42 * Add chosen data the FDT before booting the OS.
43 *
44 * In particular, this adds the kernel command line (bootargs) to the FDT.
45 *
46 * @param fdt FDT address in memory
47 * @return 0 if ok, or -FDT_ERR_... on error
48 */
49 int fdt_chosen(void *fdt);
50
51 /**
52 * Add initrd information to the FDT before booting the OS.
53 *
54 * @param fdt FDT address in memory
55 * @return 0 if ok, or -FDT_ERR_... on error
56 */
57 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
58
59 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
60 const void *val, int len, int create);
61 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
62 u32 val, int create);
63
do_fixup_by_path_string(void * fdt,const char * path,const char * prop,const char * status)64 static inline void do_fixup_by_path_string(void *fdt, const char *path,
65 const char *prop, const char *status)
66 {
67 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
68 }
69
70 void do_fixup_by_prop(void *fdt,
71 const char *pname, const void *pval, int plen,
72 const char *prop, const void *val, int len,
73 int create);
74 void do_fixup_by_prop_u32(void *fdt,
75 const char *pname, const void *pval, int plen,
76 const char *prop, u32 val, int create);
77 void do_fixup_by_compat(void *fdt, const char *compat,
78 const char *prop, const void *val, int len, int create);
79 void do_fixup_by_compat_u32(void *fdt, const char *compat,
80 const char *prop, u32 val, int create);
81 /**
82 * Setup the memory node in the DT. Creates one if none was existing before.
83 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the
84 * whole memory.
85 *
86 * @param blob FDT blob to update
87 * @param start Begin of DRAM mapping in physical memory
88 * @param size Size of the single memory bank
89 * @return 0 if ok, or -1 or -FDT_ERR_... on error
90 */
91 int fdt_fixup_memory(void *blob, u64 start, u64 size);
92
93 /**
94 * Fill the DT memory node with multiple memory banks.
95 * Creates the node if none was existing before.
96 * If banks is 0, it will not touch the existing reg property. This allows
97 * boards to not mess with the existing DT setup, which may have been
98 * filled in properly before.
99 *
100 * @param blob FDT blob to update
101 * @param start Array of size <banks> to hold the start addresses.
102 * @param size Array of size <banks> to hold the size of each region.
103 * @param banks Number of memory banks to create. If 0, the reg
104 * property will be left untouched.
105 * @return 0 if ok, or -1 or -FDT_ERR_... on error
106 */
107 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
108
109 int fdt_update_reserved_memory(void *blob, char *name, u64 start, u64 size);
110
111 void fdt_fixup_ethernet(void *fdt);
112 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
113 const void *val, int len, int create);
114 void fdt_fixup_qe_firmware(void *fdt);
115
116 /**
117 * Update native-mode property of display-timings node to the phandle
118 * of the timings matching a display by name (case insensitive).
119 *
120 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
121 *
122 * @param blob FDT blob to update
123 * @param path path within dt
124 * @param display name of display timing to match
125 * @return 0 if ok, or -FDT_ERR_... on error
126 */
127 int fdt_fixup_display(void *blob, const char *path, const char *display);
128
129 #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
130 void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd);
131 #else
fsl_fdt_fixup_dr_usb(void * blob,bd_t * bd)132 static inline void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
133 #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
134
135 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
136 void fdt_fixup_crypto_node(void *blob, int sec_rev);
137 #else
fdt_fixup_crypto_node(void * blob,int sec_rev)138 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
139 #endif
140
141 /**
142 * Record information about a processed loadable in /fit-images (creating
143 * /fit-images if necessary).
144 *
145 * @param blob FDT blob to update
146 * @param index index of this loadable
147 * @param name name of the loadable
148 * @param load_addr address the loadable was loaded to
149 * @param size number of bytes loaded
150 * @param entry_point entry point (if specified, otherwise pass -1)
151 * @param type type (if specified, otherwise pass NULL)
152 * @param os os-type (if specified, otherwise pass NULL)
153 * @return 0 if ok, or -1 or -FDT_ERR_... on error
154 */
155 int fdt_record_loadable(void *blob, u32 index, const char *name,
156 uintptr_t load_addr, u32 size, uintptr_t entry_point,
157 const char *type, const char *os);
158
159 #ifdef CONFIG_PCI
160 #include <pci.h>
161 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
162 #endif
163
164 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
165
166 /**
167 * Add board-specific data to the FDT before booting the OS.
168 *
169 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
170 * This function is called if CONFIG_OF_BOARD_SETUP is defined
171 *
172 * @param blob FDT blob to update
173 * @param bd_t Pointer to board data
174 * @return 0 if ok, or -FDT_ERR_... on error
175 */
176 int ft_board_setup(void *blob, bd_t *bd);
177
178 /**
179 * board_rng_seed() - Provide a seed to be passed via /chosen/rng-seed
180 *
181 * This function is called if CONFIG_BOARD_RNG_SEED is set, and must
182 * be provided by the board. It should return, via @buf, some suitable
183 * seed value to pass to the kernel.
184 *
185 * @param buf A struct abuf for returning the seed and its size.
186 * @return 0 if ok, negative on error.
187 */
188 int board_rng_seed(struct abuf *buf);
189
190 /**
191 * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line
192 *
193 * This is used for late modification of kernel command line arguments just
194 * before they are added into the /chosen node in flat device tree.
195 *
196 * @fdt: fdt blob
197 * @return: pointer to kernel command line arguments in memory
198 */
199 char *board_fdt_chosen_bootargs(void *fdt);
200
201 /*
202 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
203 * to their 36 physical format. This has to happen after all fdt nodes
204 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
205 * called at the end of the image_setup_libfdt() is to do that convertion.
206 */
207 void ft_board_setup_ex(void *blob, bd_t *bd);
208 void ft_cpu_setup(void *blob, bd_t *bd);
209 void ft_pci_setup(void *blob, bd_t *bd);
210
211 /**
212 * Add system-specific data to the FDT before booting the OS.
213 *
214 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
215 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
216 *
217 * @param blob FDT blob to update
218 * @param bd_t Pointer to board data
219 * @return 0 if ok, or -FDT_ERR_... on error
220 */
221 int ft_system_setup(void *blob, bd_t *bd);
222
223 void set_working_fdt_addr(ulong addr);
224
225 /**
226 * shrink down the given blob to minimum size + some extrasize if required
227 *
228 * @param blob FDT blob to update
229 * @param extrasize additional bytes needed
230 * @return 0 if ok, or -FDT_ERR_... on error
231 */
232 int fdt_shrink_to_minimum(void *blob, uint extrasize);
233 int fdt_increase_size(void *fdt, int add_len);
234
235 int fdt_fixup_nor_flash_size(void *blob);
236
237 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
238 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
239 #else
fdt_fixup_mtdparts(void * fdt,void * node_info,int node_info_size)240 static inline void fdt_fixup_mtdparts(void *fdt, void *node_info,
241 int node_info_size) {}
242 #endif
243
244 void fdt_del_node_and_alias(void *blob, const char *alias);
245 u64 fdt_translate_address(const void *blob, int node_offset,
246 const __be32 *in_addr);
247 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
248 phys_addr_t compat_off);
249 int fdt_alloc_phandle(void *blob);
250 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
251 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
252 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
253
254 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
255 u64 addr);
256 u64 fdt_get_base_address(const void *fdt, int node);
257 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
258 uint64_t *addr, uint64_t *len);
259
260 enum fdt_status {
261 FDT_STATUS_OKAY,
262 FDT_STATUS_DISABLED,
263 FDT_STATUS_FAIL,
264 FDT_STATUS_FAIL_ERROR_CODE,
265 };
266 int fdt_set_node_status(void *fdt, int nodeoffset,
267 enum fdt_status status, unsigned int error_code);
fdt_status_okay(void * fdt,int nodeoffset)268 static inline int fdt_status_okay(void *fdt, int nodeoffset)
269 {
270 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
271 }
fdt_status_disabled(void * fdt,int nodeoffset)272 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
273 {
274 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
275 }
fdt_status_fail(void * fdt,int nodeoffset)276 static inline int fdt_status_fail(void *fdt, int nodeoffset)
277 {
278 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
279 }
280
281 int fdt_set_status_by_alias(void *fdt, const char *alias,
282 enum fdt_status status, unsigned int error_code);
fdt_status_okay_by_alias(void * fdt,const char * alias)283 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
284 {
285 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
286 }
fdt_status_disabled_by_alias(void * fdt,const char * alias)287 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
288 {
289 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
290 }
fdt_status_fail_by_alias(void * fdt,const char * alias)291 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
292 {
293 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
294 }
295
296 /* Helper to read a big number; size is in cells (not bytes) */
fdt_read_number(const fdt32_t * cell,int size)297 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
298 {
299 u64 r = 0;
300 while (size--)
301 r = (r << 32) | fdt32_to_cpu(*(cell++));
302 return r;
303 }
304
305 void fdt_support_default_count_cells(const void *blob, int parentoffset,
306 int *addrc, int *sizec);
307 int ft_verify_fdt(void *fdt);
308 int arch_fixup_memory_node(void *blob);
309
310 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
311 u32 height, u32 stride, const char *format);
312
313 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
314
315 #endif /* ifdef CONFIG_OF_LIBFDT */
316
317 #ifdef USE_HOSTCC
318 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
319 int default_val);
320 #endif
321 #ifdef CONFIG_FMAN_ENET
322 int fdt_update_ethernet_dt(void *blob);
323 #endif
324 #endif /* ifndef __FDT_SUPPORT_H */
325