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