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