blob: cefb2b2cce2396efa390a8e0f2c84b1a35b4e19e [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Gerald Van Baren64dbbd42007-04-06 14:19:43 -04002/*
3 * (C) Copyright 2007
4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
Gerald Van Baren64dbbd42007-04-06 14:19:43 -04005 */
6
7#ifndef __FDT_SUPPORT_H
8#define __FDT_SUPPORT_H
9
10#ifdef CONFIG_OF_LIBFDT
11
Masahiro Yamadab08c8c42018-03-05 01:20:11 +090012#include <linux/libfdt.h>
Gerald Van Baren64dbbd42007-04-06 14:19:43 -040013
Alexander Graf94fb1822014-04-11 17:09:40 +020014u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
15 const char *prop, const u32 dflt);
Gabe Black07e12782011-11-08 01:09:44 -080016u32 fdt_getprop_u32_default(const void *fdt, const char *path,
17 const char *prop, const u32 dflt);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020018
19/**
20 * Add data to the root of the FDT before booting the OS.
21 *
22 * See doc/device-tree-bindings/root.txt
23 *
24 * @param fdt FDT address in memory
25 * @return 0 if ok, or -FDT_ERR_... on error
26 */
Paul Kocialkowski10be5b52015-05-21 11:27:03 +020027int fdt_root(void *fdt);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020028
29/**
30 * Add chosen data the FDT before booting the OS.
31 *
32 * In particular, this adds the kernel command line (bootargs) to the FDT.
33 *
34 * @param fdt FDT address in memory
35 * @return 0 if ok, or -FDT_ERR_... on error
36 */
Masahiro Yamadabc6ed0f2014-04-18 17:41:00 +090037int fdt_chosen(void *fdt);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020038
39/**
40 * Add initrd information to the FDT before booting the OS.
41 *
42 * @param fdt FDT address in memory
43 * @return 0 if ok, or -FDT_ERR_... on error
44 */
Masahiro Yamadadbe963a2014-04-18 17:40:59 +090045int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020046
Kumar Galae93becf2007-11-03 19:46:28 -050047void do_fixup_by_path(void *fdt, const char *path, const char *prop,
48 const void *val, int len, int create);
49void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
50 u32 val, int create);
Chunhe Lan8ddb10e2011-08-31 10:36:32 +080051
52static inline void do_fixup_by_path_string(void *fdt, const char *path,
53 const char *prop, const char *status)
54{
55 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
56}
57
Kumar Gala9eb77ce2007-11-21 13:30:15 -060058void do_fixup_by_prop(void *fdt,
59 const char *pname, const void *pval, int plen,
60 const char *prop, const void *val, int len,
61 int create);
62void do_fixup_by_prop_u32(void *fdt,
63 const char *pname, const void *pval, int plen,
64 const char *prop, u32 val, int create);
65void do_fixup_by_compat(void *fdt, const char *compat,
66 const char *prop, const void *val, int len, int create);
67void do_fixup_by_compat_u32(void *fdt, const char *compat,
68 const char *prop, u32 val, int create);
Andre Przywara5c1cf892015-06-21 00:29:54 +010069/**
70 * Setup the memory node in the DT. Creates one if none was existing before.
71 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the
72 * whole memory.
73 *
74 * @param blob FDT blob to update
75 * @param start Begin of DRAM mapping in physical memory
76 * @param size Size of the single memory bank
77 * @return 0 if ok, or -1 or -FDT_ERR_... on error
78 */
Kumar Gala3c927282007-11-26 14:57:45 -060079int fdt_fixup_memory(void *blob, u64 start, u64 size);
Andre Przywara5c1cf892015-06-21 00:29:54 +010080
81/**
82 * Fill the DT memory node with multiple memory banks.
83 * Creates the node if none was existing before.
84 * If banks is 0, it will not touch the existing reg property. This allows
85 * boards to not mess with the existing DT setup, which may have been
86 * filled in properly before.
87 *
88 * @param blob FDT blob to update
89 * @param start Array of size <banks> to hold the start addresses.
90 * @param size Array of size <banks> to hold the size of each region.
91 * @param banks Number of memory banks to create. If 0, the reg
92 * property will be left untouched.
93 * @return 0 if ok, or -1 or -FDT_ERR_... on error
94 */
Masahiro Yamada63c09412016-11-26 11:02:10 +090095#ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
John Rigbya6bd9e82010-10-13 13:57:33 -060096int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
Masahiro Yamada63c09412016-11-26 11:02:10 +090097#else
98static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
99 int banks)
100{
101 return 0;
102}
103#endif
Andre Przywara5c1cf892015-06-21 00:29:54 +0100104
Kumar Galaba37aa02008-08-19 15:41:18 -0500105void fdt_fixup_ethernet(void *fdt);
Matthias Fuchs22fb2242007-12-28 11:56:30 +0100106int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
107 const void *val, int len, int create);
Timur Tabib8ec2382008-01-07 13:31:19 -0600108void fdt_fixup_qe_firmware(void *fdt);
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400109
Tim Harvey08daa252015-04-08 11:45:39 -0700110/**
111 * Update native-mode property of display-timings node to the phandle
112 * of the timings matching a display by name (case insensitive).
113 *
114 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
115 *
116 * @param blob FDT blob to update
117 * @param path path within dt
118 * @param display name of display timing to match
119 * @return 0 if ok, or -FDT_ERR_... on error
120 */
121int fdt_fixup_display(void *blob, const char *path, const char *display);
122
Sriram Dashb9f67862016-04-05 14:41:21 +0530123#if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
Sriram Dasha5c289b2016-09-16 17:12:15 +0530124void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd);
Anton Vorontsov18e69a32008-03-14 23:20:18 +0300125#else
Sriram Dasha5c289b2016-09-16 17:12:15 +0530126static inline void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
Sriram Dashb9f67862016-04-05 14:41:21 +0530127#endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
Anton Vorontsov18e69a32008-03-14 23:20:18 +0300128
Kim Phillips929a2132010-06-01 12:24:27 -0500129#if defined(CONFIG_SYS_FSL_SEC_COMPAT)
Kim Phillips6b70ffb2008-06-16 15:55:53 -0500130void fdt_fixup_crypto_node(void *blob, int sec_rev);
131#else
132static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
133#endif
134
Philipp Tomsich9f45aeb2017-09-13 21:29:33 +0200135/**
136 * Record information about a processed loadable in /fit-images (creating
137 * /fit-images if necessary).
138 *
139 * @param blob FDT blob to update
140 * @param index index of this loadable
141 * @param name name of the loadable
142 * @param load_addr address the loadable was loaded to
143 * @param size number of bytes loaded
144 * @param entry_point entry point (if specified, otherwise pass -1)
145 * @param type type (if specified, otherwise pass NULL)
146 * @param os os-type (if specified, otherwise pass NULL)
147 * @return 0 if ok, or -1 or -FDT_ERR_... on error
148 */
149int fdt_record_loadable(void *blob, u32 index, const char *name,
150 uintptr_t load_addr, u32 size, uintptr_t entry_point,
151 const char *type, const char *os);
Philipp Tomsich9f45aeb2017-09-13 21:29:33 +0200152
Kumar Gala8ab451c2008-10-22 23:33:56 -0500153#ifdef CONFIG_PCI
154#include <pci.h>
155int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
156#endif
157
Simon Glassa9e8e292014-10-23 18:58:49 -0600158int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
159
Simon Glasse895a4b2014-10-23 18:58:47 -0600160/**
161 * Add board-specific data to the FDT before booting the OS.
162 *
163 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
Simon Glass6f4dbc22014-10-23 18:58:53 -0600164 * This function is called if CONFIG_OF_BOARD_SETUP is defined
Simon Glasse895a4b2014-10-23 18:58:47 -0600165 *
166 * @param blob FDT blob to update
167 * @param bd_t Pointer to board data
168 * @return 0 if ok, or -FDT_ERR_... on error
169 */
170int ft_board_setup(void *blob, bd_t *bd);
171
Vitaly Andrianov00c200f2014-04-04 13:16:47 -0400172/*
173 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
174 * to their 36 physical format. This has to happen after all fdt nodes
175 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
176 * called at the end of the image_setup_libfdt() is to do that convertion.
177 */
178void ft_board_setup_ex(void *blob, bd_t *bd);
Gerald Van Barene125a2f2007-07-10 20:40:39 -0400179void ft_cpu_setup(void *blob, bd_t *bd);
180void ft_pci_setup(void *blob, bd_t *bd);
Gerald Van Barene125a2f2007-07-10 20:40:39 -0400181
Simon Glassc654b512014-10-23 18:58:54 -0600182/**
183 * Add system-specific data to the FDT before booting the OS.
184 *
185 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
186 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
187 *
188 * @param blob FDT blob to update
189 * @param bd_t Pointer to board data
190 * @return 0 if ok, or -FDT_ERR_... on error
191 */
192int ft_system_setup(void *blob, bd_t *bd);
193
Joe Hershberger90fbee32015-02-04 21:56:53 -0600194void set_working_fdt_addr(ulong addr);
Hannes Schmelzeref476832016-09-20 18:10:43 +0200195
196/**
197 * shrink down the given blob to minimum size + some extrasize if required
198 *
199 * @param blob FDT blob to update
200 * @param extrasize additional bytes needed
201 * @return 0 if ok, or -FDT_ERR_... on error
202 */
203int fdt_shrink_to_minimum(void *blob, uint extrasize);
Timur Tabib3606f12011-05-03 13:35:10 -0500204int fdt_increase_size(void *fdt, int add_len);
Kumar Gala54f9c862008-08-15 08:24:39 -0500205
Stefan Roese8a805df2010-09-16 14:01:53 +0200206int fdt_fixup_nor_flash_size(void *blob);
Stefan Roese30d45c02009-10-21 11:59:52 +0200207
Masahiro Yamada5f4e32d2018-07-19 16:28:22 +0900208struct node_info;
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200209#if defined(CONFIG_FDT_FIXUP_PARTITIONS)
Masahiro Yamada5f4e32d2018-07-19 16:28:22 +0900210void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
211 int node_info_size);
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200212#else
Masahiro Yamada5f4e32d2018-07-19 16:28:22 +0900213static inline void fdt_fixup_mtdparts(void *fdt,
214 const struct node_info *node_info,
215 int node_info_size)
216{
217}
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200218#endif
219
Kumar Gala49b97d92010-03-30 10:19:26 -0500220void fdt_del_node_and_alias(void *blob, const char *alias);
Fabien Dessenne641067f2019-05-31 15:11:30 +0200221
222/**
223 * Translate an address from the DT into a CPU physical address
224 *
225 * The translation relies on the "ranges" property.
226 *
227 * @param blob Pointer to device tree blob
228 * @param node_offset Node DT offset
229 * @param in_addr Pointer to the address to translate
230 * @return translated address or OF_BAD_ADDR on error
231 */
Stephen Warren11e44fc2016-08-05 09:47:50 -0600232u64 fdt_translate_address(const void *blob, int node_offset,
233 const __be32 *in_addr);
Fabien Dessenne641067f2019-05-31 15:11:30 +0200234/**
235 * Translate a DMA address from the DT into a CPU physical address
236 *
237 * The translation relies on the "dma-ranges" property.
238 *
239 * @param blob Pointer to device tree blob
240 * @param node_offset Node DT offset
241 * @param in_addr Pointer to the DMA address to translate
242 * @return translated DMA address or OF_BAD_ADDR on error
243 */
244u64 fdt_translate_dma_address(const void *blob, int node_offset,
245 const __be32 *in_addr);
246
Kumar Gala75e73af2010-07-04 12:48:21 -0500247int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
248 phys_addr_t compat_off);
Kumar Galab4b847e2010-07-09 16:18:58 -0500249int fdt_alloc_phandle(void *blob);
Kumar Galaf117c0f2011-08-01 00:23:23 -0500250int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
Timur Tabi3c927cc2011-09-20 18:24:34 -0500251unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
Anatolij Gustschinbeca5a52010-08-18 11:25:20 +0200252int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
Anatolij Gustschin3c950e22010-03-16 17:10:05 +0100253
Timur Tabibb682002011-05-03 13:24:07 -0500254int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
255 u64 addr);
Simon Glassec002112017-05-18 20:09:00 -0600256u64 fdt_get_base_address(const void *fdt, int node);
Alexander Grafc48e6862014-04-11 17:09:41 +0200257int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
258 uint64_t *addr, uint64_t *len);
Timur Tabibb682002011-05-03 13:24:07 -0500259
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800260enum fdt_status {
261 FDT_STATUS_OKAY,
262 FDT_STATUS_DISABLED,
263 FDT_STATUS_FAIL,
264 FDT_STATUS_FAIL_ERROR_CODE,
265};
266int fdt_set_node_status(void *fdt, int nodeoffset,
267 enum fdt_status status, unsigned int error_code);
268static inline int fdt_status_okay(void *fdt, int nodeoffset)
269{
270 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
271}
272static inline int fdt_status_disabled(void *fdt, int nodeoffset)
273{
274 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
275}
J. German Riverab940ca62014-06-23 15:15:55 -0700276static inline int fdt_status_fail(void *fdt, int nodeoffset)
277{
278 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
279}
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800280
J. German Riverab940ca62014-06-23 15:15:55 -0700281int fdt_set_status_by_alias(void *fdt, const char *alias,
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800282 enum fdt_status status, unsigned int error_code);
J. German Riverab940ca62014-06-23 15:15:55 -0700283static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800284{
285 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
286}
J. German Riverab940ca62014-06-23 15:15:55 -0700287static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800288{
289 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
290}
J. German Riverab940ca62014-06-23 15:15:55 -0700291static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
292{
293 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
294}
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800295
Arnab Basu08df4a22014-09-08 12:19:58 -0700296/* Helper to read a big number; size is in cells (not bytes) */
Simon Glasseed36602017-05-18 20:09:26 -0600297static inline u64 fdt_read_number(const fdt32_t *cell, int size)
Arnab Basu08df4a22014-09-08 12:19:58 -0700298{
299 u64 r = 0;
300 while (size--)
301 r = (r << 32) | fdt32_to_cpu(*(cell++));
302 return r;
303}
304
Simon Glasseed36602017-05-18 20:09:26 -0600305void fdt_support_default_count_cells(const void *blob, int parentoffset,
Arnab Basuf43b4352014-09-08 12:19:59 -0700306 int *addrc, int *sizec);
Jeroen Hofsteed50b07d2014-10-08 22:58:02 +0200307int ft_verify_fdt(void *fdt);
308int arch_fixup_memory_node(void *blob);
Arnab Basuf43b4352014-09-08 12:19:59 -0700309
Hans de Goeded4f495a2014-11-17 15:29:11 +0100310int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
311 u32 height, u32 stride, const char *format);
312
Pantelis Antonioufc7c3182017-09-04 23:12:11 +0300313int fdt_overlay_apply_verbose(void *fdt, void *fdto);
314
Michael Pratt90c08fa2018-06-11 13:07:09 -0600315/**
316 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
317 *
318 * Returns the length of the cell type in bytes (4 or 8).
319 *
320 * @blob: Pointer to device tree blob
321 * @nr_cells_name: Name to lookup, e.g. "#address-cells"
322 */
323int fdt_get_cells_len(const void *blob, char *nr_cells_name);
324
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400325#endif /* ifdef CONFIG_OF_LIBFDT */
Heiko Schocher29a23f92014-03-03 12:19:30 +0100326
327#ifdef USE_HOSTCC
328int fdtdec_get_int(const void *blob, int node, const char *prop_name,
329 int default_val);
330#endif
Prabhakar Kushwaha6bedf442017-11-23 16:51:41 +0530331#ifdef CONFIG_FMAN_ENET
332int fdt_update_ethernet_dt(void *blob);
333#endif
Yogesh Gaurf9747a52018-01-16 10:08:24 +0530334#ifdef CONFIG_FSL_MC_ENET
335void fdt_fixup_board_enet(void *blob);
336#endif
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400337#endif /* ifndef __FDT_SUPPORT_H */