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
15 /**
16 * arch_fixup_fdt() - Write arch-specific information to fdt
17 *
18 * Defined in arch/$(ARCH)/lib/bootm-fdt.c
19 *
20 * @blob: FDT blob to write to
21 * @return 0 if ok, or -ve FDT_ERR_... on failure
22 */
23 int arch_fixup_fdt(void *blob);
24
25 void ft_cpu_setup(void *blob, struct bd_info *bd);
26
27 void ft_pci_setup(void *blob, struct bd_info *bd);
28
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);
33
34 /**
35 * Add data to the root of the FDT before booting the OS.
36 *
37 * See doc/device-tree-bindings/root.txt
38 *
39 * @param fdt FDT address in memory
40 * @return 0 if ok, or -FDT_ERR_... on error
41 */
42 int fdt_root(void *fdt);
43
44 /**
45 * Add chosen data the FDT before booting the OS.
46 *
47 * In particular, this adds the kernel command line (bootargs) to the FDT.
48 *
49 * @param fdt FDT address in memory
50 * @return 0 if ok, or -FDT_ERR_... on error
51 */
52 int fdt_chosen(void *fdt);
53
54 /**
55 * Add initrd information to the FDT before booting the OS.
56 *
57 * @param fdt FDT address in memory
58 * @return 0 if ok, or -FDT_ERR_... on error
59 */
60 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
61
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,
65 u32 val, int create);
66
do_fixup_by_path_string(void * fdt,const char * path,const char * prop,const char * status)67 static inline void do_fixup_by_path_string(void *fdt, const char *path,
68 const char *prop, const char *status)
69 {
70 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
71 }
72
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,
76 int create);
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);
84 /**
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
87 * whole memory.
88 *
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
93 */
94 int fdt_fixup_memory(void *blob, u64 start, u64 size);
95
96 /**
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.
102 *
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
109 */
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);
113 #else
fdt_fixup_memory_banks(void * blob,u64 start[],u64 size[],int banks)114 static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
115 int banks)
116 {
117 return 0;
118 }
119 #endif
120
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);
125
126 /**
127 * Update native-mode property of display-timings node to the phandle
128 * of the timings matching a display by name (case insensitive).
129 *
130 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
131 *
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
136 */
137 int fdt_fixup_display(void *blob, const char *path, const char *display);
138
139 #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
140 void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd);
141 #else
fsl_fdt_fixup_dr_usb(void * blob,struct bd_info * bd)142 static inline void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd) {}
143 #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
144
145 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
146 void fdt_fixup_crypto_node(void *blob, int sec_rev);
147 #else
fdt_fixup_crypto_node(void * blob,int sec_rev)148 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
149 #endif
150
151 /**
152 * Record information about a processed loadable in /fit-images (creating
153 * /fit-images if necessary).
154 *
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 * @param arch architecture (if specified, otherwise pass NULL)
164 * @return 0 if ok, or -1 or -FDT_ERR_... on error
165 */
166 int fdt_record_loadable(void *blob, u32 index, const char *name,
167 uintptr_t load_addr, u32 size, uintptr_t entry_point,
168 const char *type, const char *os, const char *arch);
169
170 #ifdef CONFIG_PCI
171 #include <pci.h>
172 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
173 #endif
174
175 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
176
177 /**
178 * Add board-specific data to the FDT before booting the OS.
179 *
180 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
181 * This function is called if CONFIG_OF_BOARD_SETUP is defined
182 *
183 * @param blob FDT blob to update
184 * @param bd Pointer to board data
185 * @return 0 if ok, or -FDT_ERR_... on error
186 */
187 int ft_board_setup(void *blob, struct bd_info *bd);
188
189 /**
190 * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line
191 *
192 * This is used for late modification of kernel command line arguments just
193 * before they are added into the /chosen node in flat device tree.
194 *
195 * @return: pointer to kernel command line arguments in memory
196 */
197 char *board_fdt_chosen_bootargs(void);
198
199 /*
200 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
201 * to their 36 physical format. This has to happen after all fdt nodes
202 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
203 * called at the end of the image_setup_libfdt() is to do that convertion.
204 */
205 void ft_board_setup_ex(void *blob, struct bd_info *bd);
206
207 /**
208 * Add system-specific data to the FDT before booting the OS.
209 *
210 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
211 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
212 *
213 * @param blob FDT blob to update
214 * @param bd Pointer to board data
215 * @return 0 if ok, or -FDT_ERR_... on error
216 */
217 int ft_system_setup(void *blob, struct bd_info *bd);
218
219 void set_working_fdt_addr(ulong addr);
220
221 /**
222 * shrink down the given blob to minimum size + some extrasize if required
223 *
224 * @param blob FDT blob to update
225 * @param extrasize additional bytes needed
226 * @return 0 if ok, or -FDT_ERR_... on error
227 */
228 int fdt_shrink_to_minimum(void *blob, uint extrasize);
229 int fdt_increase_size(void *fdt, int add_len);
230
231 int fdt_fixup_nor_flash_size(void *blob);
232
233 struct node_info;
234 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
235 void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
236 int node_info_size);
237 #else
fdt_fixup_mtdparts(void * fdt,const struct node_info * node_info,int node_info_size)238 static inline void fdt_fixup_mtdparts(void *fdt,
239 const struct node_info *node_info,
240 int node_info_size)
241 {
242 }
243 #endif
244
245 void fdt_del_node_and_alias(void *blob, const char *alias);
246
247 /**
248 * Translate an address from the DT into a CPU physical address
249 *
250 * The translation relies on the "ranges" property.
251 *
252 * @param blob Pointer to device tree blob
253 * @param node_offset Node DT offset
254 * @param in_addr Pointer to the address to translate
255 * @return translated address or OF_BAD_ADDR on error
256 */
257 u64 fdt_translate_address(const void *blob, int node_offset,
258 const __be32 *in_addr);
259 /**
260 * Translate a DMA address from the DT into a CPU physical address
261 *
262 * The translation relies on the "dma-ranges" property.
263 *
264 * @param blob Pointer to device tree blob
265 * @param node_offset Node DT offset
266 * @param in_addr Pointer to the DMA address to translate
267 * @return translated DMA address or OF_BAD_ADDR on error
268 */
269 u64 fdt_translate_dma_address(const void *blob, int node_offset,
270 const __be32 *in_addr);
271
272 /**
273 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
274 * cpu->bus address translations
275 *
276 * @param blob Pointer to device tree blob
277 * @param node_offset Node DT offset
278 * @param cpu Pointer to variable storing the range's cpu address
279 * @param bus Pointer to variable storing the range's bus address
280 * @param size Pointer to variable storing the range's size
281 * @return translated DMA address or OF_BAD_ADDR on error
282 */
283 int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu,
284 dma_addr_t *bus, u64 *size);
285
286 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
287 phys_addr_t compat_off);
288 int fdt_alloc_phandle(void *blob);
289 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
290 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
291 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
292
293 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
294 u64 addr);
295 u64 fdt_get_base_address(const void *fdt, int node);
296 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
297 uint64_t *addr, uint64_t *len);
298
299 enum fdt_status {
300 FDT_STATUS_OKAY,
301 FDT_STATUS_DISABLED,
302 FDT_STATUS_FAIL,
303 FDT_STATUS_FAIL_ERROR_CODE,
304 };
305 int fdt_set_node_status(void *fdt, int nodeoffset,
306 enum fdt_status status, unsigned int error_code);
fdt_status_okay(void * fdt,int nodeoffset)307 static inline int fdt_status_okay(void *fdt, int nodeoffset)
308 {
309 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
310 }
fdt_status_disabled(void * fdt,int nodeoffset)311 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
312 {
313 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
314 }
fdt_status_fail(void * fdt,int nodeoffset)315 static inline int fdt_status_fail(void *fdt, int nodeoffset)
316 {
317 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
318 }
319
320 int fdt_set_status_by_alias(void *fdt, const char *alias,
321 enum fdt_status status, unsigned int error_code);
fdt_status_okay_by_alias(void * fdt,const char * alias)322 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
323 {
324 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
325 }
fdt_status_disabled_by_alias(void * fdt,const char * alias)326 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
327 {
328 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
329 }
fdt_status_fail_by_alias(void * fdt,const char * alias)330 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
331 {
332 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
333 }
334
335 /* Helper to read a big number; size is in cells (not bytes) */
fdt_read_number(const fdt32_t * cell,int size)336 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
337 {
338 u64 r = 0;
339 while (size--)
340 r = (r << 32) | fdt32_to_cpu(*(cell++));
341 return r;
342 }
343
344 void fdt_support_default_count_cells(const void *blob, int parentoffset,
345 int *addrc, int *sizec);
346 int ft_verify_fdt(void *fdt);
347 int arch_fixup_memory_node(void *blob);
348
349 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
350 u32 height, u32 stride, const char *format);
351
352 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
353
354 int fdt_valid(struct fdt_header **blobp);
355
356 /**
357 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
358 *
359 * Returns the length of the cell type in bytes (4 or 8).
360 *
361 * @blob: Pointer to device tree blob
362 * @nr_cells_name: Name to lookup, e.g. "#address-cells"
363 */
364 int fdt_get_cells_len(const void *blob, char *nr_cells_name);
365
366 #endif /* ifdef CONFIG_OF_LIBFDT */
367
368 #ifdef USE_HOSTCC
369 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
370 int default_val);
371
372 /*
373 * Count child nodes of one parent node.
374 *
375 * @param blob FDT blob
376 * @param node parent node
377 * @return number of child node; 0 if there is not child node
378 */
379 int fdtdec_get_child_count(const void *blob, int node);
380 #endif
381 #ifdef CONFIG_FMAN_ENET
382 int fdt_update_ethernet_dt(void *blob);
383 #endif
384 #ifdef CONFIG_FSL_MC_ENET
385 void fdt_fixup_board_enet(void *blob);
386 #endif
387 #ifdef CONFIG_CMD_PSTORE
388 void fdt_fixup_pstore(void *blob);
389 #endif
390 #endif /* ifndef __FDT_SUPPORT_H */
391