blob: e9f3497ab64216a0aaf396e7e64e42535de2ccc9 [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 */
John Rigbya6bd9e82010-10-13 13:57:33 -060096int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
Andre Przywara5c1cf892015-06-21 00:29:54 +010097
Kumar Galaba37aa02008-08-19 15:41:18 -050098void fdt_fixup_ethernet(void *fdt);
Matthias Fuchs22fb2242007-12-28 11:56:30 +010099int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
100 const void *val, int len, int create);
Timur Tabib8ec2382008-01-07 13:31:19 -0600101void fdt_fixup_qe_firmware(void *fdt);
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400102
Tim Harvey08daa252015-04-08 11:45:39 -0700103/**
104 * Update native-mode property of display-timings node to the phandle
105 * of the timings matching a display by name (case insensitive).
106 *
107 * see kernel Documentation/devicetree/bindings/video/display-timing.txt
108 *
109 * @param blob FDT blob to update
110 * @param path path within dt
111 * @param display name of display timing to match
112 * @return 0 if ok, or -FDT_ERR_... on error
113 */
114int fdt_fixup_display(void *blob, const char *path, const char *display);
115
Sriram Dashb9f67862016-04-05 14:41:21 +0530116#if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
Anton Vorontsov18e69a32008-03-14 23:20:18 +0300117void fdt_fixup_dr_usb(void *blob, bd_t *bd);
118#else
119static inline void fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
Sriram Dashb9f67862016-04-05 14:41:21 +0530120#endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
Anton Vorontsov18e69a32008-03-14 23:20:18 +0300121
Kim Phillips929a2132010-06-01 12:24:27 -0500122#if defined(CONFIG_SYS_FSL_SEC_COMPAT)
Kim Phillips6b70ffb2008-06-16 15:55:53 -0500123void fdt_fixup_crypto_node(void *blob, int sec_rev);
124#else
125static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
126#endif
127
Kumar Gala8ab451c2008-10-22 23:33:56 -0500128#ifdef CONFIG_PCI
129#include <pci.h>
130int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
131#endif
132
Simon Glassa9e8e292014-10-23 18:58:49 -0600133int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
134
Simon Glasse895a4b2014-10-23 18:58:47 -0600135/**
136 * Add board-specific data to the FDT before booting the OS.
137 *
138 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
Simon Glass6f4dbc22014-10-23 18:58:53 -0600139 * This function is called if CONFIG_OF_BOARD_SETUP is defined
Simon Glasse895a4b2014-10-23 18:58:47 -0600140 *
141 * @param blob FDT blob to update
142 * @param bd_t Pointer to board data
143 * @return 0 if ok, or -FDT_ERR_... on error
144 */
145int ft_board_setup(void *blob, bd_t *bd);
146
Vitaly Andrianov00c200f2014-04-04 13:16:47 -0400147/*
148 * The keystone2 SOC requires all 32 bit aliased addresses to be converted
149 * to their 36 physical format. This has to happen after all fdt nodes
150 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
151 * called at the end of the image_setup_libfdt() is to do that convertion.
152 */
153void ft_board_setup_ex(void *blob, bd_t *bd);
Gerald Van Barene125a2f2007-07-10 20:40:39 -0400154void ft_cpu_setup(void *blob, bd_t *bd);
155void ft_pci_setup(void *blob, bd_t *bd);
Gerald Van Barene125a2f2007-07-10 20:40:39 -0400156
Simon Glassc654b512014-10-23 18:58:54 -0600157/**
158 * Add system-specific data to the FDT before booting the OS.
159 *
160 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
161 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
162 *
163 * @param blob FDT blob to update
164 * @param bd_t Pointer to board data
165 * @return 0 if ok, or -FDT_ERR_... on error
166 */
167int ft_system_setup(void *blob, bd_t *bd);
168
Joe Hershberger90fbee32015-02-04 21:56:53 -0600169void set_working_fdt_addr(ulong addr);
Simon Glass5bf58cc2014-07-30 03:59:02 -0600170int fdt_shrink_to_minimum(void *blob);
Timur Tabib3606f12011-05-03 13:35:10 -0500171int fdt_increase_size(void *fdt, int add_len);
Kumar Gala54f9c862008-08-15 08:24:39 -0500172
Stefan Roese8a805df2010-09-16 14:01:53 +0200173int fdt_fixup_nor_flash_size(void *blob);
Stefan Roese30d45c02009-10-21 11:59:52 +0200174
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200175#if defined(CONFIG_FDT_FIXUP_PARTITIONS)
Anatolij Gustschin3c950e22010-03-16 17:10:05 +0100176void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
Christopher Spinrathf4ae23a2016-07-12 23:37:35 +0200177#else
178static inline void fdt_fixup_mtdparts(void *fdt, void *node_info,
179 int node_info_size) {}
180#endif
181
Kumar Gala49b97d92010-03-30 10:19:26 -0500182void fdt_del_node_and_alias(void *blob, const char *alias);
Stephen Warren11e44fc2016-08-05 09:47:50 -0600183u64 fdt_translate_address(const void *blob, int node_offset,
184 const __be32 *in_addr);
Kumar Gala75e73af2010-07-04 12:48:21 -0500185int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
186 phys_addr_t compat_off);
Kumar Galab4b847e2010-07-09 16:18:58 -0500187int fdt_alloc_phandle(void *blob);
Kumar Galaf117c0f2011-08-01 00:23:23 -0500188int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
Timur Tabi3c927cc2011-09-20 18:24:34 -0500189unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
Anatolij Gustschinbeca5a52010-08-18 11:25:20 +0200190int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
Anatolij Gustschin3c950e22010-03-16 17:10:05 +0100191
Timur Tabibb682002011-05-03 13:24:07 -0500192int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
193 u64 addr);
194u64 fdt_get_base_address(void *fdt, int node);
Alexander Grafc48e6862014-04-11 17:09:41 +0200195int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
196 uint64_t *addr, uint64_t *len);
Timur Tabibb682002011-05-03 13:24:07 -0500197
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800198enum fdt_status {
199 FDT_STATUS_OKAY,
200 FDT_STATUS_DISABLED,
201 FDT_STATUS_FAIL,
202 FDT_STATUS_FAIL_ERROR_CODE,
203};
204int fdt_set_node_status(void *fdt, int nodeoffset,
205 enum fdt_status status, unsigned int error_code);
206static inline int fdt_status_okay(void *fdt, int nodeoffset)
207{
208 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
209}
210static inline int fdt_status_disabled(void *fdt, int nodeoffset)
211{
212 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
213}
J. German Riverab940ca62014-06-23 15:15:55 -0700214static inline int fdt_status_fail(void *fdt, int nodeoffset)
215{
216 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
217}
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800218
J. German Riverab940ca62014-06-23 15:15:55 -0700219int fdt_set_status_by_alias(void *fdt, const char *alias,
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800220 enum fdt_status status, unsigned int error_code);
J. German Riverab940ca62014-06-23 15:15:55 -0700221static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800222{
223 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
224}
J. German Riverab940ca62014-06-23 15:15:55 -0700225static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800226{
227 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
228}
J. German Riverab940ca62014-06-23 15:15:55 -0700229static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
230{
231 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
232}
Shengzhou Liu2a523f52011-10-14 16:26:05 +0800233
Arnab Basu08df4a22014-09-08 12:19:58 -0700234/* Helper to read a big number; size is in cells (not bytes) */
235static inline u64 of_read_number(const fdt32_t *cell, int size)
236{
237 u64 r = 0;
238 while (size--)
239 r = (r << 32) | fdt32_to_cpu(*(cell++));
240 return r;
241}
242
Stephen Warren11e44fc2016-08-05 09:47:50 -0600243void of_bus_default_count_cells(const void *blob, int parentoffset,
Arnab Basuf43b4352014-09-08 12:19:59 -0700244 int *addrc, int *sizec);
Jeroen Hofsteed50b07d2014-10-08 22:58:02 +0200245int ft_verify_fdt(void *fdt);
246int arch_fixup_memory_node(void *blob);
Arnab Basuf43b4352014-09-08 12:19:59 -0700247
Hans de Goeded4f495a2014-11-17 15:29:11 +0100248int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
249 u32 height, u32 stride, const char *format);
250
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400251#endif /* ifdef CONFIG_OF_LIBFDT */
Heiko Schocher29a23f92014-03-03 12:19:30 +0100252
253#ifdef USE_HOSTCC
254int fdtdec_get_int(const void *blob, int node, const char *prop_name,
255 int default_val);
256#endif
Gerald Van Baren64dbbd42007-04-06 14:19:43 -0400257#endif /* ifndef __FDT_SUPPORT_H */