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