blob: 5ef78cce6e0f2e27fa6f9b1d4b9ed3b45ca7758b [file] [log] [blame]
Gerald Van Baren64dbbd42007-04-06 14:19:43 -04001/*
2 * (C) Copyright 2007
3 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
4 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
Gerald Van Baren64dbbd42007-04-06 14:19:43 -04006 */
7
8#ifndef __FDT_SUPPORT_H
9#define __FDT_SUPPORT_H
10
11#ifdef CONFIG_OF_LIBFDT
12
Gerald Van Baren58864dd2013-02-07 19:49:54 -050013#include <libfdt.h>
Gerald Van Baren64dbbd42007-04-06 14:19:43 -040014
Alexander Graf94fb1822014-04-11 17:09:40 +020015u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
16 const char *prop, const u32 dflt);
Gabe Black07e12782011-11-08 01:09:44 -080017u32 fdt_getprop_u32_default(const void *fdt, const char *path,
18 const char *prop, const u32 dflt);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020019
20/**
21 * Add data to the root of the FDT before booting the OS.
22 *
23 * See doc/device-tree-bindings/root.txt
24 *
25 * @param fdt FDT address in memory
26 * @return 0 if ok, or -FDT_ERR_... on error
27 */
Paul Kocialkowski10be5b52015-05-21 11:27:03 +020028int fdt_root(void *fdt);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020029
30/**
31 * Add chosen data the FDT before booting the OS.
32 *
33 * In particular, this adds the kernel command line (bootargs) to the FDT.
34 *
35 * @param fdt FDT address in memory
36 * @return 0 if ok, or -FDT_ERR_... on error
37 */
Masahiro Yamadabc6ed0f2014-04-18 17:41:00 +090038int fdt_chosen(void *fdt);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020039
40/**
41 * Add initrd information to the FDT before booting the OS.
42 *
43 * @param fdt FDT address in memory
44 * @return 0 if ok, or -FDT_ERR_... on error
45 */
Masahiro Yamadadbe963a2014-04-18 17:40:59 +090046int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
Paul Kocialkowski3c4c1422015-05-24 12:01:53 +020047
Kumar Galae93becf2007-11-03 19:46:28 -050048void do_fixup_by_path(void *fdt, const char *path, const char *prop,
49 const void *val, int len, int create);
50void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
51 u32 val, int create);
Chunhe Lan8ddb10e2011-08-31 10:36:32 +080052
53static inline void do_fixup_by_path_string(void *fdt, const char *path,
54 const char *prop, const char *status)
55{
56 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
57}
58
Kumar Gala9eb77ce2007-11-21 13:30:15 -060059void do_fixup_by_prop(void *fdt,
60 const char *pname, const void *pval, int plen,
61 const char *prop, const void *val, int len,
62 int create);
63void do_fixup_by_prop_u32(void *fdt,
64 const char *pname, const void *pval, int plen,
65 const char *prop, u32 val, int create);
66void do_fixup_by_compat(void *fdt, const char *compat,
67 const char *prop, const void *val, int len, int create);
68void do_fixup_by_compat_u32(void *fdt, const char *compat,
69 const char *prop, u32 val, int create);
Andre Przywara5c1cf892015-06-21 00:29:54 +010070/**
71 * Setup the memory node in the DT. Creates one if none was existing before.
72 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the
73 * whole memory.
74 *
75 * @param blob FDT blob to update
76 * @param start Begin of DRAM mapping in physical memory
77 * @param size Size of the single memory bank
78 * @return 0 if ok, or -1 or -FDT_ERR_... on error
79 */
Kumar Gala3c927282007-11-26 14:57:45 -060080int fdt_fixup_memory(void *blob, u64 start, u64 size);
Andre Przywara5c1cf892015-06-21 00:29:54 +010081
82/**
83 * Fill the DT memory node with multiple memory banks.
84 * Creates the node if none was existing before.
85 * If banks is 0, it will not touch the existing reg property. This allows
86 * boards to not mess with the existing DT setup, which may have been
87 * filled in properly before.
88 *
89 * @param blob FDT blob to update
90 * @param start Array of size <banks> to hold the start addresses.
91 * @param size Array of size <banks> to hold the size of each region.
92 * @param banks Number of memory banks to create. If 0, the reg
93 * property will be left untouched.
94 * @return 0 if ok, or -1 or -FDT_ERR_... on error
95 */
Masahiro Yamada63c09412016-11-26 11:02:10 +090096#ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
John Rigbya6bd9e82010-10-13 13:57:33 -060097int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
Masahiro Yamada63c09412016-11-26 11:02:10 +090098#else
99static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
100 int banks)
101{
102 return 0;
103}
104#endif
Andre Przywara5c1cf892015-06-21 00:29:54 +0100105
Kumar Galaba37aa02008-08-19 15:41:18 -0500106void fdt_fixup_ethernet(void *fdt);
Matthias Fuchs22fb2242007-12-28 11:56:30 +0100107int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
108 const void *val, int len, int create);
Timur Tabib8ec2382008-01-07 13:31:19 -0600109void fdt_fixup_qe_firmware(void *fdt);
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400110
Tim Harvey08daa252015-04-08 11:45:39 -0700111/**
112 * Update native-mode property of display-timings node to the phandle
113 * of the timings matching a display by name (case insensitive).
114 *
115 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
116 *
117 * @param blob FDT blob to update
118 * @param path path within dt
119 * @param display name of display timing to match
120 * @return 0 if ok, or -FDT_ERR_... on error
121 */
122int fdt_fixup_display(void *blob, const char *path, const char *display);
123
Sriram Dashb9f67862016-04-05 14:41:21 +0530124#if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
Sriram Dasha5c289b2016-09-16 17:12:15 +0530125void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd);
Anton Vorontsov18e69a32008-03-14 23:20:18 +0300126#else
Sriram Dasha5c289b2016-09-16 17:12:15 +0530127static inline void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
Sriram Dashb9f67862016-04-05 14:41:21 +0530128#endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
Anton Vorontsov18e69a32008-03-14 23:20:18 +0300129
Kim Phillips929a2132010-06-01 12:24:27 -0500130#if defined(CONFIG_SYS_FSL_SEC_COMPAT)
Kim Phillips6b70ffb2008-06-16 15:55:53 -0500131void fdt_fixup_crypto_node(void *blob, int sec_rev);
132#else
133static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
134#endif
135
Kumar Gala8ab451c2008-10-22 23:33:56 -0500136#ifdef CONFIG_PCI
137#include <pci.h>
138int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
139#endif
140
Simon Glassa9e8e292014-10-23 18:58:49 -0600141int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
142
Simon Glasse895a4b2014-10-23 18:58:47 -0600143/**
144 * Add board-specific data to the FDT before booting the OS.
145 *
146 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
Simon Glass6f4dbc22014-10-23 18:58:53 -0600147 * This function is called if CONFIG_OF_BOARD_SETUP is defined
Simon Glasse895a4b2014-10-23 18:58:47 -0600148 *
149 * @param blob FDT blob to update
150 * @param bd_t Pointer to board data
151 * @return 0 if ok, or -FDT_ERR_... on error
152 */
153int ft_board_setup(void *blob, bd_t *bd);
154
Vitaly Andrianov00c200f2014-04-04 13:16:47 -0400155/*
156 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
157 * to their 36 physical format. This has to happen after all fdt nodes
158 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
159 * called at the end of the image_setup_libfdt() is to do that convertion.
160 */
161void ft_board_setup_ex(void *blob, bd_t *bd);
Gerald Van Barene125a2f2007-07-10 20:40:39 -0400162void ft_cpu_setup(void *blob, bd_t *bd);
163void ft_pci_setup(void *blob, bd_t *bd);
Gerald Van Barene125a2f2007-07-10 20:40:39 -0400164
Simon Glassc654b512014-10-23 18:58:54 -0600165/**
166 * Add system-specific data to the FDT before booting the OS.
167 *
168 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
169 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
170 *
171 * @param blob FDT blob to update
172 * @param bd_t Pointer to board data
173 * @return 0 if ok, or -FDT_ERR_... on error
174 */
175int ft_system_setup(void *blob, bd_t *bd);
176
Joe Hershberger90fbee32015-02-04 21:56:53 -0600177void set_working_fdt_addr(ulong addr);
Hannes Schmelzeref476832016-09-20 18:10:43 +0200178
179/**
180 * shrink down the given blob to minimum size + some extrasize if required
181 *
182 * @param blob FDT blob to update
183 * @param extrasize additional bytes needed
184 * @return 0 if ok, or -FDT_ERR_... on error
185 */
186int fdt_shrink_to_minimum(void *blob, uint extrasize);
Timur Tabib3606f12011-05-03 13:35:10 -0500187int fdt_increase_size(void *fdt, int add_len);
Kumar Gala54f9c862008-08-15 08:24:39 -0500188
Stefan Roese8a805df2010-09-16 14:01:53 +0200189int fdt_fixup_nor_flash_size(void *blob);
Stefan Roese30d45c02009-10-21 11:59:52 +0200190
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200191#if defined(CONFIG_FDT_FIXUP_PARTITIONS)
Anatolij Gustschin3c950e22010-03-16 17:10:05 +0100192void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200193#else
194static inline void fdt_fixup_mtdparts(void *fdt, void *node_info,
195 int node_info_size) {}
196#endif
197
Kumar Gala49b97d92010-03-30 10:19:26 -0500198void fdt_del_node_and_alias(void *blob, const char *alias);
Stephen Warren11e44fc2016-08-05 09:47:50 -0600199u64 fdt_translate_address(const void *blob, int node_offset,
200 const __be32 *in_addr);
Kumar Gala75e73af2010-07-04 12:48:21 -0500201int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
202 phys_addr_t compat_off);
Kumar Galab4b847e2010-07-09 16:18:58 -0500203int fdt_alloc_phandle(void *blob);
Kumar Galaf117c0f2011-08-01 00:23:23 -0500204int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
Timur Tabi3c927cc2011-09-20 18:24:34 -0500205unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
Anatolij Gustschinbeca5a52010-08-18 11:25:20 +0200206int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
Anatolij Gustschin3c950e22010-03-16 17:10:05 +0100207
Timur Tabibb682002011-05-03 13:24:07 -0500208int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
209 u64 addr);
Simon Glassec002112017-05-18 20:09:00 -0600210u64 fdt_get_base_address(const void *fdt, int node);
Alexander Grafc48e6862014-04-11 17:09:41 +0200211int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
212 uint64_t *addr, uint64_t *len);
Timur Tabibb682002011-05-03 13:24:07 -0500213
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800214enum fdt_status {
215 FDT_STATUS_OKAY,
216 FDT_STATUS_DISABLED,
217 FDT_STATUS_FAIL,
218 FDT_STATUS_FAIL_ERROR_CODE,
219};
220int fdt_set_node_status(void *fdt, int nodeoffset,
221 enum fdt_status status, unsigned int error_code);
222static inline int fdt_status_okay(void *fdt, int nodeoffset)
223{
224 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
225}
226static inline int fdt_status_disabled(void *fdt, int nodeoffset)
227{
228 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
229}
J. German Riverab940ca62014-06-23 15:15:55 -0700230static inline int fdt_status_fail(void *fdt, int nodeoffset)
231{
232 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
233}
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800234
J. German Riverab940ca62014-06-23 15:15:55 -0700235int fdt_set_status_by_alias(void *fdt, const char *alias,
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800236 enum fdt_status status, unsigned int error_code);
J. German Riverab940ca62014-06-23 15:15:55 -0700237static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800238{
239 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
240}
J. German Riverab940ca62014-06-23 15:15:55 -0700241static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800242{
243 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
244}
J. German Riverab940ca62014-06-23 15:15:55 -0700245static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
246{
247 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
248}
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800249
Arnab Basu08df4a22014-09-08 12:19:58 -0700250/* Helper to read a big number; size is in cells (not bytes) */
Simon Glasseed36602017-05-18 20:09:26 -0600251static inline u64 fdt_read_number(const fdt32_t *cell, int size)
Arnab Basu08df4a22014-09-08 12:19:58 -0700252{
253 u64 r = 0;
254 while (size--)
255 r = (r << 32) | fdt32_to_cpu(*(cell++));
256 return r;
257}
258
Simon Glasseed36602017-05-18 20:09:26 -0600259void fdt_support_default_count_cells(const void *blob, int parentoffset,
Arnab Basuf43b4352014-09-08 12:19:59 -0700260 int *addrc, int *sizec);
Jeroen Hofsteed50b07d2014-10-08 22:58:02 +0200261int ft_verify_fdt(void *fdt);
262int arch_fixup_memory_node(void *blob);
Arnab Basuf43b4352014-09-08 12:19:59 -0700263
Hans de Goeded4f495a2014-11-17 15:29:11 +0100264int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
265 u32 height, u32 stride, const char *format);
266
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400267#endif /* ifdef CONFIG_OF_LIBFDT */
Heiko Schocher29a23f92014-03-03 12:19:30 +0100268
269#ifdef USE_HOSTCC
270int fdtdec_get_int(const void *blob, int node, const char *prop_name,
271 int default_val);
272#endif
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400273#endif /* ifndef __FDT_SUPPORT_H */