1 /* SPDX-License-Identifier: GPL-2.0+ */
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
7 #ifndef __FDT_SUPPORT_H
8 #define __FDT_SUPPORT_H
10 #if defined(CONFIG_OF_LIBFDT) && !defined(USE_HOSTCC)
12 #include <asm/u-boot.h>
13 #include <linux/libfdt.h>
17 * arch_fixup_fdt() - Write arch-specific information to fdt
19 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
21 * @blob: FDT blob to write to
22 * Return: 0 if ok, or -ve FDT_ERR_... on failure
24 int arch_fixup_fdt(void *blob);
26 void ft_cpu_setup(void *blob, struct bd_info *bd);
28 void ft_pci_setup(void *blob, struct bd_info *bd);
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);
36 * Add data to the root of the FDT before booting the OS.
38 * See doc/device-tree-bindings/root.txt
40 * @param fdt FDT address in memory
41 * Return: 0 if ok, or -FDT_ERR_... on error
43 int fdt_root(void *fdt);
46 * Add chosen data the FDT before booting the OS.
48 * In particular, this adds the kernel command line (bootargs) to the FDT.
50 * @param fdt FDT address in memory
51 * Return: 0 if ok, or -FDT_ERR_... on error
53 int fdt_chosen(void *fdt);
56 * Add initrd information to the FDT before booting the OS.
58 * @param fdt FDT address in memory
59 * Return: 0 if ok, or -FDT_ERR_... on error
61 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
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,
68 static inline void do_fixup_by_path_string(void *fdt, const char *path,
69 const char *prop, const char *status)
71 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
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,
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);
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
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
95 int fdt_fixup_memory(void *blob, u64 start, u64 size);
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.
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
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);
115 static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
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);
128 * Update native-mode property of display-timings node to the phandle
129 * of the timings matching a display by name (case insensitive).
131 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
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
138 int fdt_fixup_display(void *blob, const char *path, const char *display);
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);
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) */
146 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
147 void fdt_fixup_crypto_node(void *blob, int sec_rev);
149 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
153 * Record information about a processed loadable in /fit-images (creating
154 * /fit-images if necessary).
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
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);
173 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
176 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
179 * Add board-specific data to the FDT before booting the OS.
181 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
182 * This function is called if CONFIG_OF_BOARD_SETUP is defined
184 * @param blob FDT blob to update
185 * @param bd Pointer to board data
186 * Return: 0 if ok, or -FDT_ERR_... on error
188 int ft_board_setup(void *blob, struct bd_info *bd);
191 * board_rng_seed() - Provide a seed to be passed via /chosen/rng-seed
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.
197 * @param buf A struct abuf for returning the seed and its size.
198 * @return 0 if ok, negative on error.
200 int board_rng_seed(struct abuf *buf);
203 * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line
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.
208 * @return: pointer to kernel command line arguments in memory
210 char *board_fdt_chosen_bootargs(void);
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.
218 void ft_board_setup_ex(void *blob, struct bd_info *bd);
221 * Add system-specific data to the FDT before booting the OS.
223 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
224 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
226 * @param blob FDT blob to update
227 * @param bd Pointer to board data
228 * Return: 0 if ok, or -FDT_ERR_... on error
230 int ft_system_setup(void *blob, struct bd_info *bd);
232 void set_working_fdt_addr(ulong addr);
235 * shrink down the given blob to minimum size + some extrasize if required
237 * @param blob FDT blob to update
238 * @param extrasize additional bytes needed
239 * Return: 0 if ok, or -FDT_ERR_... on error
241 int fdt_shrink_to_minimum(void *blob, uint extrasize);
242 int fdt_increase_size(void *fdt, int add_len);
244 int fdt_delete_disabled_nodes(void *blob);
246 int fdt_fixup_nor_flash_size(void *blob);
249 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
250 void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
253 static inline void fdt_fixup_mtdparts(void *fdt,
254 const struct node_info *node_info,
260 void fdt_del_node_and_alias(void *blob, const char *alias);
263 * Translate an address from the DT into a CPU physical address
265 * The translation relies on the "ranges" property.
267 * @param blob Pointer to device tree blob
268 * @param node_offset Node DT offset
269 * @param in_addr Pointer to the address to translate
270 * Return: translated address or OF_BAD_ADDR on error
272 u64 fdt_translate_address(const void *blob, int node_offset,
273 const __be32 *in_addr);
275 * Translate a DMA address from the DT into a CPU physical address
277 * The translation relies on the "dma-ranges" property.
279 * @param blob Pointer to device tree blob
280 * @param node_offset Node DT offset
281 * @param in_addr Pointer to the DMA address to translate
282 * Return: translated DMA address or OF_BAD_ADDR on error
284 u64 fdt_translate_dma_address(const void *blob, int node_offset,
285 const __be32 *in_addr);
288 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
289 * cpu->bus address translations
291 * @param blob Pointer to device tree blob
292 * @param node_offset Node DT offset
293 * @param cpu Pointer to variable storing the range's cpu address
294 * @param bus Pointer to variable storing the range's bus address
295 * @param size Pointer to variable storing the range's size
296 * Return: translated DMA address or OF_BAD_ADDR on error
298 int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu,
299 dma_addr_t *bus, u64 *size);
301 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
302 phys_addr_t compat_off);
303 int fdt_node_offset_by_pathf(void *blob, const char *fmt, ...)
304 __attribute__ ((format (printf, 2, 3)));
306 #define fdt_for_each_node_by_compatible(node, fdt, start, compat) \
307 for (node = fdt_node_offset_by_compatible(fdt, start, compat); \
309 node = fdt_node_offset_by_compatible(fdt, node, compat))
311 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
312 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
313 unsigned int fdt_create_phandle_by_compatible(void *fdt, const char *compat);
314 unsigned int fdt_create_phandle_by_pathf(void *fdt, const char *fmt, ...)
315 __attribute__ ((format (printf, 2, 3)));
316 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
318 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
320 u64 fdt_get_base_address(const void *fdt, int node);
321 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
322 uint64_t *addr, uint64_t *len);
329 int fdt_set_node_status(void *fdt, int nodeoffset, enum fdt_status status);
330 static inline int fdt_status_okay(void *fdt, int nodeoffset)
332 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY);
334 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
336 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED);
338 static inline int fdt_status_fail(void *fdt, int nodeoffset)
340 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL);
343 int fdt_set_status_by_alias(void *fdt, const char *alias,
344 enum fdt_status status);
345 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
347 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY);
349 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
351 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED);
353 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
355 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL);
358 int fdt_set_status_by_compatible(void *fdt, const char *compat,
359 enum fdt_status status);
360 static inline int fdt_status_okay_by_compatible(void *fdt, const char *compat)
362 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_OKAY);
364 static inline int fdt_status_disabled_by_compatible(void *fdt,
367 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_DISABLED);
369 static inline int fdt_status_fail_by_compatible(void *fdt, const char *compat)
371 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_FAIL);
374 int fdt_set_status_by_pathf(void *fdt, enum fdt_status status, const char *fmt,
375 ...) __attribute__ ((format (printf, 3, 4)));
376 #define fdt_status_okay_by_pathf(fdt, fmt, ...) \
377 fdt_set_status_by_pathf((fdt), FDT_STATUS_OKAY, (fmt), ##__VA_ARGS__)
378 #define fdt_status_disabled_by_pathf(fdt, fmt, ...) \
379 fdt_set_status_by_pathf((fdt), FDT_STATUS_DISABLED, (fmt), ##__VA_ARGS__)
380 #define fdt_status_fail_by_pathf(fdt, fmt, ...) \
381 fdt_set_status_by_pathf((fdt), FDT_STATUS_FAIL, (fmt), ##__VA_ARGS__)
383 /* Helper to read a big number; size is in cells (not bytes) */
384 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
388 r = (r << 32) | fdt32_to_cpu(*(cell++));
392 void fdt_support_default_count_cells(const void *blob, int parentoffset,
393 int *addrc, int *sizec);
394 int ft_verify_fdt(void *fdt);
395 int arch_fixup_memory_node(void *blob);
397 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
398 u32 height, u32 stride, const char *format);
400 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
402 int fdt_valid(struct fdt_header **blobp);
405 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
407 * Returns the length of the cell type in bytes (4 or 8).
409 * @blob: Pointer to device tree blob
410 * @nr_cells_name: Name to lookup, e.g. "#address-cells"
412 int fdt_get_cells_len(const void *blob, char *nr_cells_name);
414 #endif /* ifdef CONFIG_OF_LIBFDT */
417 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
421 * Count child nodes of one parent node.
423 * @param blob FDT blob
424 * @param node parent node
425 * Return: number of child node; 0 if there is not child node
427 int fdtdec_get_child_count(const void *blob, int node);
429 #ifdef CONFIG_FMAN_ENET
430 int fdt_update_ethernet_dt(void *blob);
432 #ifdef CONFIG_FSL_MC_ENET
433 void fdt_fixup_board_enet(void *blob);
435 #ifdef CONFIG_CMD_PSTORE
436 void fdt_fixup_pstore(void *blob);
438 #endif /* ifndef __FDT_SUPPORT_H */