fdt: Pass the device serial number through devicetree
[oweals/u-boot.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 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
16                                 const char *prop, const u32 dflt);
17 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
18                                 const char *prop, const u32 dflt);
19 int fdt_root(void *fdt);
20 int fdt_chosen(void *fdt);
21 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
22 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
23                       const void *val, int len, int create);
24 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
25                           u32 val, int create);
26
27 static inline void do_fixup_by_path_string(void *fdt, const char *path,
28                                            const char *prop, const char *status)
29 {
30         do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
31 }
32
33 void do_fixup_by_prop(void *fdt,
34                       const char *pname, const void *pval, int plen,
35                       const char *prop, const void *val, int len,
36                       int create);
37 void do_fixup_by_prop_u32(void *fdt,
38                           const char *pname, const void *pval, int plen,
39                           const char *prop, u32 val, int create);
40 void do_fixup_by_compat(void *fdt, const char *compat,
41                         const char *prop, const void *val, int len, int create);
42 void do_fixup_by_compat_u32(void *fdt, const char *compat,
43                             const char *prop, u32 val, int create);
44 int fdt_fixup_memory(void *blob, u64 start, u64 size);
45 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
46 void fdt_fixup_ethernet(void *fdt);
47 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
48                          const void *val, int len, int create);
49 void fdt_fixup_qe_firmware(void *fdt);
50
51 /**
52  * Update native-mode property of display-timings node to the phandle
53  * of the timings matching a display by name (case insensitive).
54  *
55  * see kernel Documentation/devicetree/bindings/video/display-timing.txt
56  *
57  * @param blob          FDT blob to update
58  * @param path          path within dt
59  * @param display       name of display timing to match
60  * @return 0 if ok, or -FDT_ERR_... on error
61  */
62 int fdt_fixup_display(void *blob, const char *path, const char *display);
63
64 #if defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB)
65 void fdt_fixup_dr_usb(void *blob, bd_t *bd);
66 #else
67 static inline void fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
68 #endif /* defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB) */
69
70 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
71 void fdt_fixup_crypto_node(void *blob, int sec_rev);
72 #else
73 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
74 #endif
75
76 #ifdef CONFIG_PCI
77 #include <pci.h>
78 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
79 #endif
80
81 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
82
83 /**
84  * Add board-specific data to the FDT before booting the OS.
85  *
86  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
87  * This function is called if CONFIG_OF_BOARD_SETUP is defined
88  *
89  * @param blob          FDT blob to update
90  * @param bd_t          Pointer to board data
91  * @return 0 if ok, or -FDT_ERR_... on error
92  */
93 int ft_board_setup(void *blob, bd_t *bd);
94
95 /*
96  * The keystone2 SOC requires all 32 bit aliased addresses to be converted
97  * to their 36 physical format. This has to happen after all fdt nodes
98  * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
99  * called at the end of the image_setup_libfdt() is to do that convertion.
100  */
101 void ft_board_setup_ex(void *blob, bd_t *bd);
102 void ft_cpu_setup(void *blob, bd_t *bd);
103 void ft_pci_setup(void *blob, bd_t *bd);
104
105 /**
106  * Add system-specific data to the FDT before booting the OS.
107  *
108  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
109  * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
110  *
111  * @param blob          FDT blob to update
112  * @param bd_t          Pointer to board data
113  * @return 0 if ok, or -FDT_ERR_... on error
114  */
115 int ft_system_setup(void *blob, bd_t *bd);
116
117 void set_working_fdt_addr(ulong addr);
118 int fdt_shrink_to_minimum(void *blob);
119 int fdt_increase_size(void *fdt, int add_len);
120
121 int fdt_fixup_nor_flash_size(void *blob);
122
123 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
124 void fdt_del_node_and_alias(void *blob, const char *alias);
125 u64 fdt_translate_address(void *blob, int node_offset, const __be32 *in_addr);
126 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
127                                         phys_addr_t compat_off);
128 int fdt_alloc_phandle(void *blob);
129 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
130 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
131 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
132
133 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
134                               u64 addr);
135 u64 fdt_get_base_address(void *fdt, int node);
136 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
137                    uint64_t *addr, uint64_t *len);
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 u64 of_read_number(const fdt32_t *cell, int size)
177 {
178         u64 r = 0;
179         while (size--)
180                 r = (r << 32) | fdt32_to_cpu(*(cell++));
181         return r;
182 }
183
184 void of_bus_default_count_cells(void *blob, int parentoffset,
185                                         int *addrc, int *sizec);
186 int ft_verify_fdt(void *fdt);
187 int arch_fixup_memory_node(void *blob);
188
189 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
190                             u32 height, u32 stride, const char *format);
191
192 #endif /* ifdef CONFIG_OF_LIBFDT */
193
194 #ifdef USE_HOSTCC
195 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
196                 int default_val);
197 #endif
198 #endif /* ifndef __FDT_SUPPORT_H */