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 #ifdef CONFIG_OF_LIBFDT
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 * @return 0 if ok, or -1 or -FDT_ERR_... on error
164 */
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);
168
169 #ifdef CONFIG_PCI
170 #include <pci.h>
171 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
172 #endif
173
174 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
175
176 /**
177 * Add board-specific data to the FDT before booting the OS.
178 *
179 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
180 * This function is called if CONFIG_OF_BOARD_SETUP is defined
181 *
182 * @param blob FDT blob to update
183 * @param bd Pointer to board data
184 * @return 0 if ok, or -FDT_ERR_... on error
185 */
186 int ft_board_setup(void *blob, struct bd_info *bd);
187
188 /**
189 * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line
190 *
191 * This is used for late modification of kernel command line arguments just
192 * before they are added into the /chosen node in flat device tree.
193 *
194 * @return: pointer to kernel command line arguments in memory
195 */
196 char *board_fdt_chosen_bootargs(void);
197
198 /*
199 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
200 * to their 36 physical format. This has to happen after all fdt nodes
201 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
202 * called at the end of the image_setup_libfdt() is to do that convertion.
203 */
204 void ft_board_setup_ex(void *blob, struct bd_info *bd);
205 void ft_cpu_setup(void *blob, struct bd_info *bd);
206 void ft_pci_setup(void *blob, struct bd_info *bd);
207
208 /**
209 * Add system-specific data to the FDT before booting the OS.
210 *
211 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
212 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
213 *
214 * @param blob FDT blob to update
215 * @param bd Pointer to board data
216 * @return 0 if ok, or -FDT_ERR_... on error
217 */
218 int ft_system_setup(void *blob, struct bd_info *bd);
219
220 void set_working_fdt_addr(ulong addr);
221
222 /**
223 * shrink down the given blob to minimum size + some extrasize if required
224 *
225 * @param blob FDT blob to update
226 * @param extrasize additional bytes needed
227 * @return 0 if ok, or -FDT_ERR_... on error
228 */
229 int fdt_shrink_to_minimum(void *blob, uint extrasize);
230 int fdt_increase_size(void *fdt, int add_len);
231
232 int fdt_fixup_nor_flash_size(void *blob);
233
234 struct node_info;
235 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
236 void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
237 int node_info_size);
238 #else
fdt_fixup_mtdparts(void * fdt,const struct node_info * node_info,int node_info_size)239 static inline void fdt_fixup_mtdparts(void *fdt,
240 const struct node_info *node_info,
241 int node_info_size)
242 {
243 }
244 #endif
245
246 void fdt_del_node_and_alias(void *blob, const char *alias);
247
248 /**
249 * Translate an address from the DT into a CPU physical address
250 *
251 * The translation relies on the "ranges" property.
252 *
253 * @param blob Pointer to device tree blob
254 * @param node_offset Node DT offset
255 * @param in_addr Pointer to the address to translate
256 * @return translated address or OF_BAD_ADDR on error
257 */
258 u64 fdt_translate_address(const void *blob, int node_offset,
259 const __be32 *in_addr);
260 /**
261 * Translate a DMA address from the DT into a CPU physical address
262 *
263 * The translation relies on the "dma-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 DMA address to translate
268 * @return translated DMA address or OF_BAD_ADDR on error
269 */
270 u64 fdt_translate_dma_address(const void *blob, int node_offset,
271 const __be32 *in_addr);
272
273 /**
274 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
275 * cpu->bus address translations
276 *
277 * @param blob Pointer to device tree blob
278 * @param node_offset Node DT offset
279 * @param cpu Pointer to variable storing the range's cpu address
280 * @param bus Pointer to variable storing the range's bus address
281 * @param size Pointer to variable storing the range's size
282 * @return translated DMA address or OF_BAD_ADDR on error
283 */
284 int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu,
285 dma_addr_t *bus, u64 *size);
286
287 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
288 phys_addr_t compat_off);
289 int fdt_alloc_phandle(void *blob);
290 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
291 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
292 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
293
294 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
295 u64 addr);
296 u64 fdt_get_base_address(const void *fdt, int node);
297 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
298 uint64_t *addr, uint64_t *len);
299
300 enum fdt_status {
301 FDT_STATUS_OKAY,
302 FDT_STATUS_DISABLED,
303 FDT_STATUS_FAIL,
304 FDT_STATUS_FAIL_ERROR_CODE,
305 };
306 int fdt_set_node_status(void *fdt, int nodeoffset,
307 enum fdt_status status, unsigned int error_code);
fdt_status_okay(void * fdt,int nodeoffset)308 static inline int fdt_status_okay(void *fdt, int nodeoffset)
309 {
310 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
311 }
fdt_status_disabled(void * fdt,int nodeoffset)312 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
313 {
314 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
315 }
fdt_status_fail(void * fdt,int nodeoffset)316 static inline int fdt_status_fail(void *fdt, int nodeoffset)
317 {
318 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
319 }
320
321 int fdt_set_status_by_alias(void *fdt, const char *alias,
322 enum fdt_status status, unsigned int error_code);
fdt_status_okay_by_alias(void * fdt,const char * alias)323 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
324 {
325 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
326 }
fdt_status_disabled_by_alias(void * fdt,const char * alias)327 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
328 {
329 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
330 }
fdt_status_fail_by_alias(void * fdt,const char * alias)331 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
332 {
333 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
334 }
335
336 /* Helper to read a big number; size is in cells (not bytes) */
fdt_read_number(const fdt32_t * cell,int size)337 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
338 {
339 u64 r = 0;
340 while (size--)
341 r = (r << 32) | fdt32_to_cpu(*(cell++));
342 return r;
343 }
344
345 void fdt_support_default_count_cells(const void *blob, int parentoffset,
346 int *addrc, int *sizec);
347 int ft_verify_fdt(void *fdt);
348 int arch_fixup_memory_node(void *blob);
349
350 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
351 u32 height, u32 stride, const char *format);
352
353 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
354
355 int fdt_valid(struct fdt_header **blobp);
356
357 /**
358 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
359 *
360 * Returns the length of the cell type in bytes (4 or 8).
361 *
362 * @blob: Pointer to device tree blob
363 * @nr_cells_name: Name to lookup, e.g. "#address-cells"
364 */
365 int fdt_get_cells_len(const void *blob, char *nr_cells_name);
366
367 #endif /* ifdef CONFIG_OF_LIBFDT */
368
369 #ifdef USE_HOSTCC
370 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
371 int default_val);
372
373 /*
374 * Count child nodes of one parent node.
375 *
376 * @param blob FDT blob
377 * @param node parent node
378 * @return number of child node; 0 if there is not child node
379 */
380 int fdtdec_get_child_count(const void *blob, int node);
381 #endif
382 #ifdef CONFIG_FMAN_ENET
383 int fdt_update_ethernet_dt(void *blob);
384 #endif
385 #ifdef CONFIG_FSL_MC_ENET
386 void fdt_fixup_board_enet(void *blob);
387 #endif
388 #ifdef CONFIG_CMD_PSTORE
389 void fdt_fixup_pstore(void *blob);
390 #endif
391 #endif /* ifndef __FDT_SUPPORT_H */
392