86c203ceb3bc751fe4dc45c2490850cfc134dd57
[karo-tx-uboot.git] / include / fdt_support.h
1 /*
2  * (C) Copyright 2007
3  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  */
7
8 #ifndef __FDT_SUPPORT_H
9 #define __FDT_SUPPORT_H
10
11 #ifdef CONFIG_OF_LIBFDT
12
13 #include <libfdt.h>
14
15 uint32_t fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
16                                 const char *prop, const uint32_t dflt);
17 uint32_t fdt_getprop_u32_default(const void *fdt, const char *path,
18                                 const char *prop, const uint32_t dflt);
19 int fdt_chosen(void *fdt);
20 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
21 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
22                       const void *val, int len, int create);
23 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
24                           uint32_t val, int create);
25
26 static inline void do_fixup_by_path_string(void *fdt, const char *path,
27                                            const char *prop, const char *status)
28 {
29         do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
30 }
31
32 void do_fixup_by_prop(void *fdt,
33                       const char *pname, const void *pval, int plen,
34                       const char *prop, const void *val, int len,
35                       int create);
36 void do_fixup_by_prop_u32(void *fdt,
37                           const char *pname, const void *pval, int plen,
38                           const char *prop, uint32_t val, int create);
39 void do_fixup_by_compat(void *fdt, const char *compat,
40                         const char *prop, const void *val, int len, int create);
41 void do_fixup_by_compat_u32(void *fdt, const char *compat,
42                             const char *prop, uint32_t val, int create);
43 int fdt_fixup_memory(void *blob, uint64_t start, uint64_t size);
44 int fdt_fixup_memory_banks(void *blob, uint64_t start[], uint64_t size[], int banks);
45 void fdt_fixup_ethernet(void *fdt);
46 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
47                          const void *val, int len, int create);
48 void fdt_fixup_qe_firmware(void *fdt);
49
50 /**
51  * Update native-mode property of display-timings node to the phandle
52  * of the timings matching a display by name (case insensitive).
53  *
54  * see kernel Documentation/devicetree/bindings/video/display-timing.txt
55  *
56  * @param blob          FDT blob to update
57  * @param path          path within dt
58  * @param display       name of display timing to match
59  * @return 0 if ok, or -FDT_ERR_... on error
60  */
61 int fdt_fixup_display(void *blob, const char *path, const char *display);
62
63 #if defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB)
64 void fdt_fixup_dr_usb(void *blob, bd_t *bd);
65 #else
66 static inline void fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
67 #endif /* defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB) */
68
69 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
70 void fdt_fixup_crypto_node(void *blob, int sec_rev);
71 #else
72 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
73 #endif
74
75 #ifdef CONFIG_PCI
76 #include <pci.h>
77 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
78 #endif
79
80 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
81
82 /**
83  * Add board-specific data to the FDT before booting the OS.
84  *
85  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
86  * This function is called if CONFIG_OF_BOARD_SETUP is defined
87  *
88  * @param blob          FDT blob to update
89  * @param bd_t          Pointer to board data
90  * @return 0 if ok, or -FDT_ERR_... on error
91  */
92 int ft_board_setup(void *blob, bd_t *bd);
93
94 /*
95  * The keystone2 SOC requires all 32 bit aliased addresses to be converted
96  * to their 36 physical format. This has to happen after all fdt nodes
97  * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
98  * called at the end of the image_setup_libfdt() is to do that convertion.
99  */
100 void ft_board_setup_ex(void *blob, bd_t *bd);
101 void ft_cpu_setup(void *blob, bd_t *bd);
102 void ft_pci_setup(void *blob, bd_t *bd);
103
104 /**
105  * Add system-specific data to the FDT before booting the OS.
106  *
107  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
108  * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
109  *
110  * @param blob          FDT blob to update
111  * @param bd_t          Pointer to board data
112  * @return 0 if ok, or -FDT_ERR_... on error
113  */
114 int ft_system_setup(void *blob, bd_t *bd);
115
116 void set_working_fdt_addr(ulong addr);
117 int fdt_shrink_to_minimum(void *blob);
118 int fdt_increase_size(void *fdt, int add_len);
119
120 int fdt_fixup_nor_flash_size(void *blob);
121
122 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
123 void fdt_del_node_and_alias(void *blob, const char *alias);
124 uint64_t fdt_translate_address(void *blob, int node_offset, const __be32 *in_addr);
125 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
126                                         phys_addr_t compat_off);
127 int fdt_alloc_phandle(void *blob);
128 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
129 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
130 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
131
132 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
133                               uint64_t addr);
134 uint64_t fdt_get_base_address(void *fdt, int node);
135 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
136                    uint64_t *addr, uint64_t *len);
137 #endif /* __UBOOT__ */
138
139 enum fdt_status {
140         FDT_STATUS_OKAY,
141         FDT_STATUS_DISABLED,
142         FDT_STATUS_FAIL,
143         FDT_STATUS_FAIL_ERROR_CODE,
144 };
145 int fdt_set_node_status(void *fdt, int nodeoffset,
146                         enum fdt_status status, unsigned int error_code);
147 static inline int fdt_status_okay(void *fdt, int nodeoffset)
148 {
149         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
150 }
151 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
152 {
153         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
154 }
155 static inline int fdt_status_fail(void *fdt, int nodeoffset)
156 {
157         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
158 }
159
160 int fdt_set_status_by_alias(void *fdt, const char *alias,
161                             enum fdt_status status, unsigned int error_code);
162 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
163 {
164         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
165 }
166 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
167 {
168         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
169 }
170 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
171 {
172         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
173 }
174
175 /* Helper to read a big number; size is in cells (not bytes) */
176 static inline uint64_t of_read_number(const fdt32_t *cell, int size)
177 {
178         uint64_t r = 0;
179
180         while (size--) {
181                 r = (r << 32) | fdt32_to_cpu(*cell);
182                 cell++;
183         }
184         return r;
185 }
186
187 void of_bus_default_count_cells(void *blob, int parentoffset,
188                                         int *addrc, int *sizec);
189 int ft_verify_fdt(void *fdt);
190 int arch_fixup_memory_node(void *blob);
191
192 int fdt_setup_simplefb_node(void *fdt, int node, uint64_t base_address, uint32_t width,
193                             uint32_t height, uint32_t stride, const char *format);
194
195 #endif /* ifdef CONFIG_OF_LIBFDT */
196
197 #ifdef USE_HOSTCC
198 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
199                 int default_val);
200 #endif
201 #endif /* ifndef __FDT_SUPPORT_H */