xref: /openbmc/u-boot/include/fdt_support.h (revision aa8e00fa)
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_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 			  u32 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, u32 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, u32 val, int create);
43 int fdt_fixup_memory(void *blob, u64 start, u64 size);
44 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 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 #if defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB)
51 void fdt_fixup_dr_usb(void *blob, bd_t *bd);
52 #else
53 static inline void fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
54 #endif /* defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB) */
55 
56 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
57 void fdt_fixup_crypto_node(void *blob, int sec_rev);
58 #else
59 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
60 #endif
61 
62 #ifdef CONFIG_PCI
63 #include <pci.h>
64 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
65 #endif
66 
67 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
68 
69 /**
70  * Add board-specific data to the FDT before booting the OS.
71  *
72  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
73  * This function is called if CONFIG_OF_BOARD_SETUP is defined
74  *
75  * @param blob		FDT blob to update
76  * @param bd_t		Pointer to board data
77  * @return 0 if ok, or -FDT_ERR_... on error
78  */
79 int ft_board_setup(void *blob, bd_t *bd);
80 
81 /*
82  * The keystone2 SOC requires all 32 bit aliased addresses to be converted
83  * to their 36 physical format. This has to happen after all fdt nodes
84  * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
85  * called at the end of the image_setup_libfdt() is to do that convertion.
86  */
87 void ft_board_setup_ex(void *blob, bd_t *bd);
88 void ft_cpu_setup(void *blob, bd_t *bd);
89 void ft_pci_setup(void *blob, bd_t *bd);
90 
91 /**
92  * Add system-specific data to the FDT before booting the OS.
93  *
94  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
95  * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
96  *
97  * @param blob		FDT blob to update
98  * @param bd_t		Pointer to board data
99  * @return 0 if ok, or -FDT_ERR_... on error
100  */
101 int ft_system_setup(void *blob, bd_t *bd);
102 
103 void set_working_fdt_addr(void *addr);
104 int fdt_shrink_to_minimum(void *blob);
105 int fdt_increase_size(void *fdt, int add_len);
106 
107 int fdt_fixup_nor_flash_size(void *blob);
108 
109 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
110 void fdt_del_node_and_alias(void *blob, const char *alias);
111 u64 fdt_translate_address(void *blob, int node_offset, const __be32 *in_addr);
112 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
113 					phys_addr_t compat_off);
114 int fdt_alloc_phandle(void *blob);
115 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
116 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
117 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
118 
119 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
120 			      u64 addr);
121 u64 fdt_get_base_address(void *fdt, int node);
122 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
123 		   uint64_t *addr, uint64_t *len);
124 
125 enum fdt_status {
126 	FDT_STATUS_OKAY,
127 	FDT_STATUS_DISABLED,
128 	FDT_STATUS_FAIL,
129 	FDT_STATUS_FAIL_ERROR_CODE,
130 };
131 int fdt_set_node_status(void *fdt, int nodeoffset,
132 			enum fdt_status status, unsigned int error_code);
133 static inline int fdt_status_okay(void *fdt, int nodeoffset)
134 {
135 	return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
136 }
137 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
138 {
139 	return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
140 }
141 static inline int fdt_status_fail(void *fdt, int nodeoffset)
142 {
143 	return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
144 }
145 
146 int fdt_set_status_by_alias(void *fdt, const char *alias,
147 			    enum fdt_status status, unsigned int error_code);
148 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
149 {
150 	return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
151 }
152 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
153 {
154 	return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
155 }
156 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
157 {
158 	return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
159 }
160 
161 /* Helper to read a big number; size is in cells (not bytes) */
162 static inline u64 of_read_number(const fdt32_t *cell, int size)
163 {
164 	u64 r = 0;
165 	while (size--)
166 		r = (r << 32) | fdt32_to_cpu(*(cell++));
167 	return r;
168 }
169 
170 void of_bus_default_count_cells(void *blob, int parentoffset,
171 					int *addrc, int *sizec);
172 int ft_verify_fdt(void *fdt);
173 int arch_fixup_memory_node(void *blob);
174 
175 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
176 			    u32 height, u32 stride, const char *format);
177 
178 #endif /* ifdef CONFIG_OF_LIBFDT */
179 
180 #ifdef USE_HOSTCC
181 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
182 		int default_val);
183 #endif
184 #endif /* ifndef __FDT_SUPPORT_H */
185