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 #ifdef CONFIG_OF_LIBFDT
12 #include <asm/u-boot.h>
13 #include <linux/libfdt.h>
16 * arch_fixup_fdt() - Write arch-specific information to fdt
18 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
20 * @blob: FDT blob to write to
21 * @return 0 if ok, or -ve FDT_ERR_... on failure
23 int arch_fixup_fdt(void *blob
);
25 void ft_cpu_setup(void *blob
, bd_t
*bd
);
27 void ft_pci_setup(void *blob
, bd_t
*bd
);
29 u32
fdt_getprop_u32_default_node(const void *fdt
, int off
, int cell
,
30 const char *prop
, const u32 dflt
);
31 u32
fdt_getprop_u32_default(const void *fdt
, const char *path
,
32 const char *prop
, const u32 dflt
);
35 * Add data to the root of the FDT before booting the OS.
37 * See doc/device-tree-bindings/root.txt
39 * @param fdt FDT address in memory
40 * @return 0 if ok, or -FDT_ERR_... on error
42 int fdt_root(void *fdt
);
45 * Add chosen data the FDT before booting the OS.
47 * In particular, this adds the kernel command line (bootargs) to the FDT.
49 * @param fdt FDT address in memory
50 * @return 0 if ok, or -FDT_ERR_... on error
52 int fdt_chosen(void *fdt
);
55 * Add initrd information to the FDT before booting the OS.
57 * @param fdt FDT address in memory
58 * @return 0 if ok, or -FDT_ERR_... on error
60 int fdt_initrd(void *fdt
, ulong initrd_start
, ulong initrd_end
);
62 void do_fixup_by_path(void *fdt
, const char *path
, const char *prop
,
63 const void *val
, int len
, int create
);
64 void do_fixup_by_path_u32(void *fdt
, const char *path
, const char *prop
,
67 static inline void do_fixup_by_path_string(void *fdt
, const char *path
,
68 const char *prop
, const char *status
)
70 do_fixup_by_path(fdt
, path
, prop
, status
, strlen(status
) + 1, 1);
73 void do_fixup_by_prop(void *fdt
,
74 const char *pname
, const void *pval
, int plen
,
75 const char *prop
, const void *val
, int len
,
77 void do_fixup_by_prop_u32(void *fdt
,
78 const char *pname
, const void *pval
, int plen
,
79 const char *prop
, u32 val
, int create
);
80 void do_fixup_by_compat(void *fdt
, const char *compat
,
81 const char *prop
, const void *val
, int len
, int create
);
82 void do_fixup_by_compat_u32(void *fdt
, const char *compat
,
83 const char *prop
, u32 val
, int create
);
85 * Setup the memory node in the DT. Creates one if none was existing before.
86 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the
89 * @param blob FDT blob to update
90 * @param start Begin of DRAM mapping in physical memory
91 * @param size Size of the single memory bank
92 * @return 0 if ok, or -1 or -FDT_ERR_... on error
94 int fdt_fixup_memory(void *blob
, u64 start
, u64 size
);
97 * Fill the DT memory node with multiple memory banks.
98 * Creates the node if none was existing before.
99 * If banks is 0, it will not touch the existing reg property. This allows
100 * boards to not mess with the existing DT setup, which may have been
101 * filled in properly before.
103 * @param blob FDT blob to update
104 * @param start Array of size <banks> to hold the start addresses.
105 * @param size Array of size <banks> to hold the size of each region.
106 * @param banks Number of memory banks to create. If 0, the reg
107 * property will be left untouched.
108 * @return 0 if ok, or -1 or -FDT_ERR_... on error
110 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
111 int fdt_fixup_memory_banks(void *blob
, u64 start
[], u64 size
[], int banks
);
112 int fdt_set_usable_memory(void *blob
, u64 start
[], u64 size
[], int banks
);
114 static inline int fdt_fixup_memory_banks(void *blob
, u64 start
[], u64 size
[],
121 void fdt_fixup_ethernet(void *fdt
);
122 int fdt_find_and_setprop(void *fdt
, const char *node
, const char *prop
,
123 const void *val
, int len
, int create
);
124 void fdt_fixup_qe_firmware(void *fdt
);
127 * Update native-mode property of display-timings node to the phandle
128 * of the timings matching a display by name (case insensitive).
130 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
132 * @param blob FDT blob to update
133 * @param path path within dt
134 * @param display name of display timing to match
135 * @return 0 if ok, or -FDT_ERR_... on error
137 int fdt_fixup_display(void *blob
, const char *path
, const char *display
);
139 #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
140 void fsl_fdt_fixup_dr_usb(void *blob
, bd_t
*bd
);
142 static inline void fsl_fdt_fixup_dr_usb(void *blob
, bd_t
*bd
) {}
143 #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
145 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
146 void fdt_fixup_crypto_node(void *blob
, int sec_rev
);
148 static inline void fdt_fixup_crypto_node(void *blob
, int sec_rev
) {}
152 * Record information about a processed loadable in /fit-images (creating
153 * /fit-images if necessary).
155 * @param blob FDT blob to update
156 * @param index index of this loadable
157 * @param name name of the loadable
158 * @param load_addr address the loadable was loaded to
159 * @param size number of bytes loaded
160 * @param entry_point entry point (if specified, otherwise pass -1)
161 * @param type type (if specified, otherwise pass NULL)
162 * @param os os-type (if specified, otherwise pass NULL)
163 * @return 0 if ok, or -1 or -FDT_ERR_... on error
165 int fdt_record_loadable(void *blob
, u32 index
, const char *name
,
166 uintptr_t load_addr
, u32 size
, uintptr_t entry_point
,
167 const char *type
, const char *os
);
171 int fdt_pci_dma_ranges(void *blob
, int phb_off
, struct pci_controller
*hose
);
174 int fdt_find_or_add_subnode(void *fdt
, int parentoffset
, const char *name
);
177 * Add board-specific data to the FDT before booting the OS.
179 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
180 * This function is called if CONFIG_OF_BOARD_SETUP is defined
182 * @param blob FDT blob to update
183 * @param bd_t Pointer to board data
184 * @return 0 if ok, or -FDT_ERR_... on error
186 int ft_board_setup(void *blob
, bd_t
*bd
);
189 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
190 * to their 36 physical format. This has to happen after all fdt nodes
191 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
192 * called at the end of the image_setup_libfdt() is to do that convertion.
194 void ft_board_setup_ex(void *blob
, bd_t
*bd
);
195 void ft_cpu_setup(void *blob
, bd_t
*bd
);
196 void ft_pci_setup(void *blob
, bd_t
*bd
);
199 * Add system-specific data to the FDT before booting the OS.
201 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
202 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
204 * @param blob FDT blob to update
205 * @param bd_t Pointer to board data
206 * @return 0 if ok, or -FDT_ERR_... on error
208 int ft_system_setup(void *blob
, bd_t
*bd
);
210 void set_working_fdt_addr(ulong addr
);
213 * shrink down the given blob to minimum size + some extrasize if required
215 * @param blob FDT blob to update
216 * @param extrasize additional bytes needed
217 * @return 0 if ok, or -FDT_ERR_... on error
219 int fdt_shrink_to_minimum(void *blob
, uint extrasize
);
220 int fdt_increase_size(void *fdt
, int add_len
);
222 int fdt_fixup_nor_flash_size(void *blob
);
225 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
226 void fdt_fixup_mtdparts(void *fdt
, const struct node_info
*node_info
,
229 static inline void fdt_fixup_mtdparts(void *fdt
,
230 const struct node_info
*node_info
,
236 void fdt_del_node_and_alias(void *blob
, const char *alias
);
239 * Translate an address from the DT into a CPU physical address
241 * The translation relies on the "ranges" property.
243 * @param blob Pointer to device tree blob
244 * @param node_offset Node DT offset
245 * @param in_addr Pointer to the address to translate
246 * @return translated address or OF_BAD_ADDR on error
248 u64
fdt_translate_address(const void *blob
, int node_offset
,
249 const __be32
*in_addr
);
251 * Translate a DMA address from the DT into a CPU physical address
253 * The translation relies on the "dma-ranges" property.
255 * @param blob Pointer to device tree blob
256 * @param node_offset Node DT offset
257 * @param in_addr Pointer to the DMA address to translate
258 * @return translated DMA address or OF_BAD_ADDR on error
260 u64
fdt_translate_dma_address(const void *blob
, int node_offset
,
261 const __be32
*in_addr
);
263 int fdt_node_offset_by_compat_reg(void *blob
, const char *compat
,
264 phys_addr_t compat_off
);
265 int fdt_alloc_phandle(void *blob
);
266 int fdt_set_phandle(void *fdt
, int nodeoffset
, uint32_t phandle
);
267 unsigned int fdt_create_phandle(void *fdt
, int nodeoffset
);
268 int fdt_add_edid(void *blob
, const char *compat
, unsigned char *buf
);
270 int fdt_verify_alias_address(void *fdt
, int anode
, const char *alias
,
272 u64
fdt_get_base_address(const void *fdt
, int node
);
273 int fdt_read_range(void *fdt
, int node
, int n
, uint64_t *child_addr
,
274 uint64_t *addr
, uint64_t *len
);
280 FDT_STATUS_FAIL_ERROR_CODE
,
282 int fdt_set_node_status(void *fdt
, int nodeoffset
,
283 enum fdt_status status
, unsigned int error_code
);
284 static inline int fdt_status_okay(void *fdt
, int nodeoffset
)
286 return fdt_set_node_status(fdt
, nodeoffset
, FDT_STATUS_OKAY
, 0);
288 static inline int fdt_status_disabled(void *fdt
, int nodeoffset
)
290 return fdt_set_node_status(fdt
, nodeoffset
, FDT_STATUS_DISABLED
, 0);
292 static inline int fdt_status_fail(void *fdt
, int nodeoffset
)
294 return fdt_set_node_status(fdt
, nodeoffset
, FDT_STATUS_FAIL
, 0);
297 int fdt_set_status_by_alias(void *fdt
, const char *alias
,
298 enum fdt_status status
, unsigned int error_code
);
299 static inline int fdt_status_okay_by_alias(void *fdt
, const char *alias
)
301 return fdt_set_status_by_alias(fdt
, alias
, FDT_STATUS_OKAY
, 0);
303 static inline int fdt_status_disabled_by_alias(void *fdt
, const char *alias
)
305 return fdt_set_status_by_alias(fdt
, alias
, FDT_STATUS_DISABLED
, 0);
307 static inline int fdt_status_fail_by_alias(void *fdt
, const char *alias
)
309 return fdt_set_status_by_alias(fdt
, alias
, FDT_STATUS_FAIL
, 0);
312 /* Helper to read a big number; size is in cells (not bytes) */
313 static inline u64
fdt_read_number(const fdt32_t
*cell
, int size
)
317 r
= (r
<< 32) | fdt32_to_cpu(*(cell
++));
321 void fdt_support_default_count_cells(const void *blob
, int parentoffset
,
322 int *addrc
, int *sizec
);
323 int ft_verify_fdt(void *fdt
);
324 int arch_fixup_memory_node(void *blob
);
326 int fdt_setup_simplefb_node(void *fdt
, int node
, u64 base_address
, u32 width
,
327 u32 height
, u32 stride
, const char *format
);
329 int fdt_overlay_apply_verbose(void *fdt
, void *fdto
);
332 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
334 * Returns the length of the cell type in bytes (4 or 8).
336 * @blob: Pointer to device tree blob
337 * @nr_cells_name: Name to lookup, e.g. "#address-cells"
339 int fdt_get_cells_len(const void *blob
, char *nr_cells_name
);
341 #endif /* ifdef CONFIG_OF_LIBFDT */
344 int fdtdec_get_int(const void *blob
, int node
, const char *prop_name
,
348 * Count child nodes of one parent node.
350 * @param blob FDT blob
351 * @param node parent node
352 * @return number of child node; 0 if there is not child node
354 int fdtdec_get_child_count(const void *blob
, int node
);
356 #ifdef CONFIG_FMAN_ENET
357 int fdt_update_ethernet_dt(void *blob
);
359 #ifdef CONFIG_FSL_MC_ENET
360 void fdt_fixup_board_enet(void *blob
);
362 #endif /* ifndef __FDT_SUPPORT_H */