1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3 * (C) Copyright 2007
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
5 */
6
7 #ifndef __FDT_SUPPORT_H
8 #define __FDT_SUPPORT_H
9
10 #if defined(CONFIG_OF_LIBFDT) && !defined(USE_HOSTCC)
11
12 #include <asm/u-boot.h>
13 #include <linux/libfdt.h>
14 #include <abuf.h>
15
16 /**
17 * arch_fixup_fdt() - Write arch-specific information to fdt
18 *
19 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
20 *
21 * @blob: FDT blob to write to
22 * Return: 0 if ok, or -ve FDT_ERR_... on failure
23 */
24 int arch_fixup_fdt(void *blob);
25
26 void ft_cpu_setup(void *blob, struct bd_info *bd);
27
28 void ft_pci_setup(void *blob, struct bd_info *bd);
29
30 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
31 const char *prop, const u32 dflt);
32 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
33 const char *prop, const u32 dflt);
34
35 /**
36 * Add data to the root of the FDT before booting the OS.
37 *
38 * See doc/device-tree-bindings/root.txt
39 *
40 * @param fdt FDT address in memory
41 * Return: 0 if ok, or -FDT_ERR_... on error
42 */
43 int fdt_root(void *fdt);
44
45 /**
46 * Add chosen data the FDT before booting the OS.
47 *
48 * In particular, this adds the kernel command line (bootargs) to the FDT.
49 *
50 * @param fdt FDT address in memory
51 * Return: 0 if ok, or -FDT_ERR_... on error
52 */
53 int fdt_chosen(void *fdt);
54
55 /**
56 * Add initrd information to the FDT before booting the OS.
57 *
58 * @param fdt FDT address in memory
59 * Return: 0 if ok, or -FDT_ERR_... on error
60 */
61 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
62
63 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
64 const void *val, int len, int create);
65 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
66 u32 val, int create);
67
do_fixup_by_path_string(void * fdt,const char * path,const char * prop,const char * status)68 static inline void do_fixup_by_path_string(void *fdt, const char *path,
69 const char *prop, const char *status)
70 {
71 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
72 }
73
74 void do_fixup_by_prop(void *fdt,
75 const char *pname, const void *pval, int plen,
76 const char *prop, const void *val, int len,
77 int create);
78 void do_fixup_by_prop_u32(void *fdt,
79 const char *pname, const void *pval, int plen,
80 const char *prop, u32 val, int create);
81 void do_fixup_by_compat(void *fdt, const char *compat,
82 const char *prop, const void *val, int len, int create);
83 void do_fixup_by_compat_u32(void *fdt, const char *compat,
84 const char *prop, u32 val, int create);
85 /**
86 * Setup the memory node in the DT. Creates one if none was existing before.
87 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the
88 * whole memory.
89 *
90 * @param blob FDT blob to update
91 * @param start Begin of DRAM mapping in physical memory
92 * @param size Size of the single memory bank
93 * Return: 0 if ok, or -1 or -FDT_ERR_... on error
94 */
95 int fdt_fixup_memory(void *blob, u64 start, u64 size);
96
97 /**
98 * Fill the DT memory node with multiple memory banks.
99 * Creates the node if none was existing before.
100 * If banks is 0, it will not touch the existing reg property. This allows
101 * boards to not mess with the existing DT setup, which may have been
102 * filled in properly before.
103 *
104 * @param blob FDT blob to update
105 * @param start Array of size <banks> to hold the start addresses.
106 * @param size Array of size <banks> to hold the size of each region.
107 * @param banks Number of memory banks to create. If 0, the reg
108 * property will be left untouched.
109 * Return: 0 if ok, or -1 or -FDT_ERR_... on error
110 */
111 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
112 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
113 int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int banks);
114 #else
fdt_fixup_memory_banks(void * blob,u64 start[],u64 size[],int banks)115 static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
116 int banks)
117 {
118 return 0;
119 }
120 #endif
121
122 void fdt_fixup_ethernet(void *fdt);
123 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
124 const void *val, int len, int create);
125 void fdt_fixup_qe_firmware(void *fdt);
126
127 /**
128 * Update native-mode property of display-timings node to the phandle
129 * of the timings matching a display by name (case insensitive).
130 *
131 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
132 *
133 * @param blob FDT blob to update
134 * @param path path within dt
135 * @param display name of display timing to match
136 * Return: 0 if ok, or -FDT_ERR_... on error
137 */
138 int fdt_fixup_display(void *blob, const char *path, const char *display);
139
140 #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
141 void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd);
142 #else
fsl_fdt_fixup_dr_usb(void * blob,struct bd_info * bd)143 static inline void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd) {}
144 #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
145
146 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
147 void fdt_fixup_crypto_node(void *blob, int sec_rev);
148 #else
fdt_fixup_crypto_node(void * blob,int sec_rev)149 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
150 #endif
151
152 /**
153 * Record information about a processed loadable in /fit-images (creating
154 * /fit-images if necessary).
155 *
156 * @param blob FDT blob to update
157 * @param index index of this loadable
158 * @param name name of the loadable
159 * @param load_addr address the loadable was loaded to
160 * @param size number of bytes loaded
161 * @param entry_point entry point (if specified, otherwise pass -1)
162 * @param type type (if specified, otherwise pass NULL)
163 * @param os os-type (if specified, otherwise pass NULL)
164 * @param arch architecture (if specified, otherwise pass NULL)
165 * Return: 0 if ok, or -1 or -FDT_ERR_... on error
166 */
167 int fdt_record_loadable(void *blob, u32 index, const char *name,
168 uintptr_t load_addr, u32 size, uintptr_t entry_point,
169 const char *type, const char *os, const char *arch);
170
171 #ifdef CONFIG_PCI
172 #include <pci.h>
173 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
174 #endif
175
176 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
177
178 /**
179 * Add board-specific data to the FDT before booting the OS.
180 *
181 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
182 * This function is called if CONFIG_OF_BOARD_SETUP is defined
183 *
184 * @param blob FDT blob to update
185 * @param bd Pointer to board data
186 * Return: 0 if ok, or -FDT_ERR_... on error
187 */
188 int ft_board_setup(void *blob, struct bd_info *bd);
189
190 /**
191 * board_rng_seed() - Provide a seed to be passed via /chosen/rng-seed
192 *
193 * This function is called if CONFIG_BOARD_RNG_SEED is set, and must
194 * be provided by the board. It should return, via @buf, some suitable
195 * seed value to pass to the kernel.
196 *
197 * @param buf A struct abuf for returning the seed and its size.
198 * @return 0 if ok, negative on error.
199 */
200 int board_rng_seed(struct abuf *buf);
201
202 /**
203 * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line
204 *
205 * This is used for late modification of kernel command line arguments just
206 * before they are added into the /chosen node in flat device tree.
207 *
208 * @return: pointer to kernel command line arguments in memory
209 */
210 char *board_fdt_chosen_bootargs(void);
211
212 /*
213 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
214 * to their 36 physical format. This has to happen after all fdt nodes
215 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
216 * called at the end of the image_setup_libfdt() is to do that convertion.
217 */
218 void ft_board_setup_ex(void *blob, struct bd_info *bd);
219
220 /**
221 * Add system-specific data to the FDT before booting the OS.
222 *
223 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
224 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
225 *
226 * @param blob FDT blob to update
227 * @param bd Pointer to board data
228 * Return: 0 if ok, or -FDT_ERR_... on error
229 */
230 int ft_system_setup(void *blob, struct bd_info *bd);
231
232 void set_working_fdt_addr(ulong addr);
233
234 /**
235 * shrink down the given blob to minimum size + some extrasize if required
236 *
237 * @param blob FDT blob to update
238 * @param extrasize additional bytes needed
239 * Return: 0 if ok, or -FDT_ERR_... on error
240 */
241 int fdt_shrink_to_minimum(void *blob, uint extrasize);
242 int fdt_increase_size(void *fdt, int add_len);
243
244 int fdt_delete_disabled_nodes(void *blob);
245
246 struct node_info;
247 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
248 void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
249 int node_info_size);
250 #else
fdt_fixup_mtdparts(void * fdt,const struct node_info * node_info,int node_info_size)251 static inline void fdt_fixup_mtdparts(void *fdt,
252 const struct node_info *node_info,
253 int node_info_size)
254 {
255 }
256 #endif
257
258 void fdt_del_node_and_alias(void *blob, const char *alias);
259
260 /**
261 * Translate an address from the DT into a CPU physical address
262 *
263 * The translation relies on the "ranges" property.
264 *
265 * @param blob Pointer to device tree blob
266 * @param node_offset Node DT offset
267 * @param in_addr Pointer to the address to translate
268 * Return: translated address or OF_BAD_ADDR on error
269 */
270 u64 fdt_translate_address(const void *blob, int node_offset,
271 const __be32 *in_addr);
272 /**
273 * Translate a DMA address from the DT into a CPU physical address
274 *
275 * The translation relies on the "dma-ranges" property.
276 *
277 * @param blob Pointer to device tree blob
278 * @param node_offset Node DT offset
279 * @param in_addr Pointer to the DMA address to translate
280 * Return: translated DMA address or OF_BAD_ADDR on error
281 */
282 u64 fdt_translate_dma_address(const void *blob, int node_offset,
283 const __be32 *in_addr);
284
285 /**
286 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
287 * cpu->bus address translations
288 *
289 * @param blob Pointer to device tree blob
290 * @param node_offset Node DT offset
291 * @param cpu Pointer to variable storing the range's cpu address
292 * @param bus Pointer to variable storing the range's bus address
293 * @param size Pointer to variable storing the range's size
294 * Return: translated DMA address or OF_BAD_ADDR on error
295 */
296 int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu,
297 dma_addr_t *bus, u64 *size);
298
299 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
300 phys_addr_t compat_off);
301 int fdt_node_offset_by_pathf(void *blob, const char *fmt, ...)
302 __attribute__ ((format (printf, 2, 3)));
303
304 #define fdt_for_each_node_by_compatible(node, fdt, start, compat) \
305 for (node = fdt_node_offset_by_compatible(fdt, start, compat); \
306 node >= 0; \
307 node = fdt_node_offset_by_compatible(fdt, node, compat))
308
309 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
310 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
311 unsigned int fdt_create_phandle_by_compatible(void *fdt, const char *compat);
312 unsigned int fdt_create_phandle_by_pathf(void *fdt, const char *fmt, ...)
313 __attribute__ ((format (printf, 2, 3)));
314 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
315
316 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
317 u64 addr);
318 u64 fdt_get_base_address(const void *fdt, int node);
319 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
320 uint64_t *addr, uint64_t *len);
321
322 enum fdt_status {
323 FDT_STATUS_OKAY,
324 FDT_STATUS_DISABLED,
325 FDT_STATUS_FAIL,
326 };
327 int fdt_set_node_status(void *fdt, int nodeoffset, enum fdt_status status);
fdt_status_okay(void * fdt,int nodeoffset)328 static inline int fdt_status_okay(void *fdt, int nodeoffset)
329 {
330 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY);
331 }
fdt_status_disabled(void * fdt,int nodeoffset)332 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
333 {
334 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED);
335 }
fdt_status_fail(void * fdt,int nodeoffset)336 static inline int fdt_status_fail(void *fdt, int nodeoffset)
337 {
338 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL);
339 }
340
341 int fdt_set_status_by_alias(void *fdt, const char *alias,
342 enum fdt_status status);
fdt_status_okay_by_alias(void * fdt,const char * alias)343 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
344 {
345 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY);
346 }
fdt_status_disabled_by_alias(void * fdt,const char * alias)347 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
348 {
349 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED);
350 }
fdt_status_fail_by_alias(void * fdt,const char * alias)351 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
352 {
353 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL);
354 }
355
356 int fdt_set_status_by_compatible(void *fdt, const char *compat,
357 enum fdt_status status);
fdt_status_okay_by_compatible(void * fdt,const char * compat)358 static inline int fdt_status_okay_by_compatible(void *fdt, const char *compat)
359 {
360 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_OKAY);
361 }
fdt_status_disabled_by_compatible(void * fdt,const char * compat)362 static inline int fdt_status_disabled_by_compatible(void *fdt,
363 const char *compat)
364 {
365 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_DISABLED);
366 }
fdt_status_fail_by_compatible(void * fdt,const char * compat)367 static inline int fdt_status_fail_by_compatible(void *fdt, const char *compat)
368 {
369 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_FAIL);
370 }
371
372 int fdt_set_status_by_pathf(void *fdt, enum fdt_status status, const char *fmt,
373 ...) __attribute__ ((format (printf, 3, 4)));
374 #define fdt_status_okay_by_pathf(fdt, fmt, ...) \
375 fdt_set_status_by_pathf((fdt), FDT_STATUS_OKAY, (fmt), ##__VA_ARGS__)
376 #define fdt_status_disabled_by_pathf(fdt, fmt, ...) \
377 fdt_set_status_by_pathf((fdt), FDT_STATUS_DISABLED, (fmt), ##__VA_ARGS__)
378 #define fdt_status_fail_by_pathf(fdt, fmt, ...) \
379 fdt_set_status_by_pathf((fdt), FDT_STATUS_FAIL, (fmt), ##__VA_ARGS__)
380
381 /* Helper to read a big number; size is in cells (not bytes) */
fdt_read_number(const fdt32_t * cell,int size)382 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
383 {
384 u64 r = 0;
385 while (size--)
386 r = (r << 32) | fdt32_to_cpu(*(cell++));
387 return r;
388 }
389
390 void fdt_support_default_count_cells(const void *blob, int parentoffset,
391 int *addrc, int *sizec);
392 int ft_verify_fdt(void *fdt);
393 int arch_fixup_memory_node(void *blob);
394
395 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
396 u32 height, u32 stride, const char *format);
397
398 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
399
400 int fdt_valid(struct fdt_header **blobp);
401
402 /**
403 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
404 *
405 * Returns the length of the cell type in bytes (4 or 8).
406 *
407 * @blob: Pointer to device tree blob
408 * @nr_cells_name: Name to lookup, e.g. "#address-cells"
409 */
410 int fdt_get_cells_len(const void *blob, char *nr_cells_name);
411
412 #endif /* ifdef CONFIG_OF_LIBFDT */
413
414 #ifdef USE_HOSTCC
415 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
416 int default_val);
417
418 /*
419 * Count child nodes of one parent node.
420 *
421 * @param blob FDT blob
422 * @param node parent node
423 * Return: number of child node; 0 if there is not child node
424 */
425 int fdtdec_get_child_count(const void *blob, int node);
426 #endif
427 #ifdef CONFIG_FMAN_ENET
428 int fdt_update_ethernet_dt(void *blob);
429 #endif
430 #ifdef CONFIG_FSL_MC_ENET
431 void fdt_fixup_board_enet(void *blob);
432 #endif
433 #ifdef CONFIG_CMD_PSTORE
434 void fdt_fixup_pstore(void *blob);
435 #endif
436 #endif /* ifndef __FDT_SUPPORT_H */
437