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 <linux/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 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 */ 28 int fdt_root(void *fdt); 29 30 /** 31 * Append info to bootargs 32 * 33 * @param fdt FDT address in memory 34 * @param data string info 35 * @return 0 if ok, else error 36 */ 37 int fdt_bootargs_append(void *fdt, char *data); 38 39 /** 40 * Append ab info to bootargs 41 * 42 * @param fdt FDT address in memory 43 * @param slot slot info 44 * @return 0 if ok, else error 45 */ 46 int fdt_bootargs_append_ab(void *fdt, char *slot); 47 48 /** 49 * Add chosen data the FDT before booting the OS. 50 * 51 * In particular, this adds the kernel command line (bootargs) to the FDT. 52 * 53 * @param fdt FDT address in memory 54 * @return 0 if ok, or -FDT_ERR_... on error 55 */ 56 int fdt_chosen(void *fdt); 57 58 /** 59 * Add initrd information to the FDT before booting the OS. 60 * 61 * @param fdt FDT address in memory 62 * @return 0 if ok, or -FDT_ERR_... on error 63 */ 64 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end); 65 66 void do_fixup_by_path(void *fdt, const char *path, const char *prop, 67 const void *val, int len, int create); 68 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop, 69 u32 val, int create); 70 71 static inline void do_fixup_by_path_string(void *fdt, const char *path, 72 const char *prop, const char *status) 73 { 74 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1); 75 } 76 77 void do_fixup_by_prop(void *fdt, 78 const char *pname, const void *pval, int plen, 79 const char *prop, const void *val, int len, 80 int create); 81 void do_fixup_by_prop_u32(void *fdt, 82 const char *pname, const void *pval, int plen, 83 const char *prop, u32 val, int create); 84 void do_fixup_by_compat(void *fdt, const char *compat, 85 const char *prop, const void *val, int len, int create); 86 void do_fixup_by_compat_u32(void *fdt, const char *compat, 87 const char *prop, u32 val, int create); 88 /** 89 * Setup the memory node in the DT. Creates one if none was existing before. 90 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the 91 * whole memory. 92 * 93 * @param blob FDT blob to update 94 * @param start Begin of DRAM mapping in physical memory 95 * @param size Size of the single memory bank 96 * @return 0 if ok, or -1 or -FDT_ERR_... on error 97 */ 98 int fdt_fixup_memory(void *blob, u64 start, u64 size); 99 100 /** 101 * Fill the DT memory node with multiple memory banks. 102 * Creates the node if none was existing before. 103 * If banks is 0, it will not touch the existing reg property. This allows 104 * boards to not mess with the existing DT setup, which may have been 105 * filled in properly before. 106 * 107 * @param blob FDT blob to update 108 * @param start Array of size <banks> to hold the start addresses. 109 * @param size Array of size <banks> to hold the size of each region. 110 * @param banks Number of memory banks to create. If 0, the reg 111 * property will be left untouched. 112 * @return 0 if ok, or -1 or -FDT_ERR_... on error 113 */ 114 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY 115 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks); 116 #else 117 static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], 118 int banks) 119 { 120 return 0; 121 } 122 #endif 123 124 int fdt_update_reserved_memory(void *blob, char *name, u64 start, u64 size); 125 126 void fdt_fixup_ethernet(void *fdt); 127 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop, 128 const void *val, int len, int create); 129 void fdt_fixup_qe_firmware(void *fdt); 130 131 /** 132 * Update native-mode property of display-timings node to the phandle 133 * of the timings matching a display by name (case insensitive). 134 * 135 * see kernel Documentation/devicetree/bindings/video/display-timing.txt 136 * 137 * @param blob FDT blob to update 138 * @param path path within dt 139 * @param display name of display timing to match 140 * @return 0 if ok, or -FDT_ERR_... on error 141 */ 142 int fdt_fixup_display(void *blob, const char *path, const char *display); 143 144 #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) 145 void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd); 146 #else 147 static inline void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd) {} 148 #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */ 149 150 #if defined(CONFIG_SYS_FSL_SEC_COMPAT) 151 void fdt_fixup_crypto_node(void *blob, int sec_rev); 152 #else 153 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {} 154 #endif 155 156 /** 157 * Record information about a processed loadable in /fit-images (creating 158 * /fit-images if necessary). 159 * 160 * @param blob FDT blob to update 161 * @param index index of this loadable 162 * @param name name of the loadable 163 * @param load_addr address the loadable was loaded to 164 * @param size number of bytes loaded 165 * @param entry_point entry point (if specified, otherwise pass -1) 166 * @param type type (if specified, otherwise pass NULL) 167 * @param os os-type (if specified, otherwise pass NULL) 168 * @return 0 if ok, or -1 or -FDT_ERR_... on error 169 */ 170 int fdt_record_loadable(void *blob, u32 index, const char *name, 171 uintptr_t load_addr, u32 size, uintptr_t entry_point, 172 const char *type, const char *os); 173 174 #ifdef CONFIG_PCI 175 #include <pci.h> 176 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose); 177 #endif 178 179 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name); 180 181 /** 182 * Add board-specific data to the FDT before booting the OS. 183 * 184 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space. 185 * This function is called if CONFIG_OF_BOARD_SETUP is defined 186 * 187 * @param blob FDT blob to update 188 * @param bd_t Pointer to board data 189 * @return 0 if ok, or -FDT_ERR_... on error 190 */ 191 int ft_board_setup(void *blob, bd_t *bd); 192 193 /* 194 * The keystone2 SOC requires all 32 bit aliased addresses to be converted 195 * to their 36 physical format. This has to happen after all fdt nodes 196 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex() 197 * called at the end of the image_setup_libfdt() is to do that convertion. 198 */ 199 void ft_board_setup_ex(void *blob, bd_t *bd); 200 void ft_cpu_setup(void *blob, bd_t *bd); 201 void ft_pci_setup(void *blob, bd_t *bd); 202 203 /** 204 * Add system-specific data to the FDT before booting the OS. 205 * 206 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space. 207 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined 208 * 209 * @param blob FDT blob to update 210 * @param bd_t Pointer to board data 211 * @return 0 if ok, or -FDT_ERR_... on error 212 */ 213 int ft_system_setup(void *blob, bd_t *bd); 214 215 void set_working_fdt_addr(ulong addr); 216 217 /** 218 * shrink down the given blob to minimum size + some extrasize if required 219 * 220 * @param blob FDT blob to update 221 * @param extrasize additional bytes needed 222 * @return 0 if ok, or -FDT_ERR_... on error 223 */ 224 int fdt_shrink_to_minimum(void *blob, uint extrasize); 225 int fdt_increase_size(void *fdt, int add_len); 226 227 int fdt_fixup_nor_flash_size(void *blob); 228 229 #if defined(CONFIG_FDT_FIXUP_PARTITIONS) 230 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size); 231 #else 232 static inline void fdt_fixup_mtdparts(void *fdt, void *node_info, 233 int node_info_size) {} 234 #endif 235 236 void fdt_del_node_and_alias(void *blob, const char *alias); 237 u64 fdt_translate_address(const void *blob, int node_offset, 238 const __be32 *in_addr); 239 int fdt_node_offset_by_compat_reg(void *blob, const char *compat, 240 phys_addr_t compat_off); 241 int fdt_alloc_phandle(void *blob); 242 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle); 243 unsigned int fdt_create_phandle(void *fdt, int nodeoffset); 244 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf); 245 246 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, 247 u64 addr); 248 u64 fdt_get_base_address(const void *fdt, int node); 249 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr, 250 uint64_t *addr, uint64_t *len); 251 252 enum fdt_status { 253 FDT_STATUS_OKAY, 254 FDT_STATUS_DISABLED, 255 FDT_STATUS_FAIL, 256 FDT_STATUS_FAIL_ERROR_CODE, 257 }; 258 int fdt_set_node_status(void *fdt, int nodeoffset, 259 enum fdt_status status, unsigned int error_code); 260 static inline int fdt_status_okay(void *fdt, int nodeoffset) 261 { 262 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0); 263 } 264 static inline int fdt_status_disabled(void *fdt, int nodeoffset) 265 { 266 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0); 267 } 268 static inline int fdt_status_fail(void *fdt, int nodeoffset) 269 { 270 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0); 271 } 272 273 int fdt_set_status_by_alias(void *fdt, const char *alias, 274 enum fdt_status status, unsigned int error_code); 275 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias) 276 { 277 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0); 278 } 279 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias) 280 { 281 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0); 282 } 283 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias) 284 { 285 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0); 286 } 287 288 /* Helper to read a big number; size is in cells (not bytes) */ 289 static inline u64 fdt_read_number(const fdt32_t *cell, int size) 290 { 291 u64 r = 0; 292 while (size--) 293 r = (r << 32) | fdt32_to_cpu(*(cell++)); 294 return r; 295 } 296 297 void fdt_support_default_count_cells(const void *blob, int parentoffset, 298 int *addrc, int *sizec); 299 int ft_verify_fdt(void *fdt); 300 int arch_fixup_memory_node(void *blob); 301 302 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width, 303 u32 height, u32 stride, const char *format); 304 305 int fdt_overlay_apply_verbose(void *fdt, void *fdto); 306 307 #endif /* ifdef CONFIG_OF_LIBFDT */ 308 309 #ifdef USE_HOSTCC 310 int fdtdec_get_int(const void *blob, int node, const char *prop_name, 311 int default_val); 312 #endif 313 #ifdef CONFIG_FMAN_ENET 314 int fdt_update_ethernet_dt(void *blob); 315 #endif 316 #endif /* ifndef __FDT_SUPPORT_H */ 317