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