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