1/* SPDX-License-Identifier: GPL-2.0+ */ 2/* 3 * (C) Copyright 2007 4 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com 5 */ 6 7#ifndef __FDT_SUPPORT_H 8#define __FDT_SUPPORT_H 9 10#if !defined(USE_HOSTCC) 11 12#include <asm/u-boot.h> 13#include <linux/libfdt.h> 14#include <abuf.h> 15 16/** 17 * arch_fixup_fdt() - Write arch-specific information to fdt 18 * 19 * Defined in arch/$(ARCH)/lib/bootm-fdt.c 20 * 21 * @blob: FDT blob to write to 22 * Return: 0 if ok, or -ve FDT_ERR_... on failure 23 */ 24int arch_fixup_fdt(void *blob); 25 26void ft_cpu_setup(void *blob, struct bd_info *bd); 27 28void ft_pci_setup(void *blob, struct bd_info *bd); 29 30u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell, 31 const char *prop, const u32 dflt); 32u32 fdt_getprop_u32_default(const void *fdt, const char *path, 33 const char *prop, const u32 dflt); 34 35/** 36 * Add data to the root of the FDT before booting the OS. 37 * 38 * See doc/device-tree-bindings/root.txt 39 * 40 * @param fdt FDT address in memory 41 * Return: 0 if ok, or -FDT_ERR_... on error 42 */ 43int fdt_root(void *fdt); 44 45/** 46 * Add chosen data the FDT before booting the OS. 47 * 48 * In particular, this adds the kernel command line (bootargs) to the FDT. 49 * 50 * @param fdt FDT address in memory 51 * Return: 0 if ok, or -FDT_ERR_... on error 52 */ 53int fdt_chosen(void *fdt); 54 55/** 56 * Add initrd information to the FDT before booting the OS. 57 * 58 * Adds linux,initrd-start and linux,initrd-end properties to the /chosen node, 59 * creating it if necessary. 60 * 61 * A memory reservation for the ramdisk is added to the FDT, or an existing one 62 * (with matching @initrd_start) updated. 63 * 64 * If @initrd_start == @initrd_end this function does nothing and returns 0. 65 * 66 * @fdt: Pointer to FDT in memory 67 * @initrd_start: Start of ramdisk 68 * @initrd_end: End of ramdisk 69 * Return: 0 if ok, or -FDT_ERR_... on error 70 */ 71int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end); 72 73void do_fixup_by_path(void *fdt, const char *path, const char *prop, 74 const void *val, int len, int create); 75void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop, 76 u32 val, int create); 77 78static inline void do_fixup_by_path_string(void *fdt, const char *path, 79 const char *prop, const char *status) 80{ 81 do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1); 82} 83 84void do_fixup_by_prop(void *fdt, 85 const char *pname, const void *pval, int plen, 86 const char *prop, const void *val, int len, 87 int create); 88void do_fixup_by_prop_u32(void *fdt, 89 const char *pname, const void *pval, int plen, 90 const char *prop, u32 val, int create); 91void do_fixup_by_compat(void *fdt, const char *compat, 92 const char *prop, const void *val, int len, int create); 93void do_fixup_by_compat_u32(void *fdt, const char *compat, 94 const char *prop, u32 val, int create); 95/** 96 * Setup the memory node in the DT. Creates one if none was existing before. 97 * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the 98 * whole memory. 99 * 100 * @param blob FDT blob to update 101 * @param start Begin of DRAM mapping in physical memory 102 * @param size Size of the single memory bank 103 * Return: 0 if ok, or -1 or -FDT_ERR_... on error 104 */ 105int fdt_fixup_memory(void *blob, u64 start, u64 size); 106 107/** 108 * Fill the DT memory node with multiple memory banks. 109 * Creates the node if none was existing before. 110 * If banks is 0, it will not touch the existing reg property. This allows 111 * boards to not mess with the existing DT setup, which may have been 112 * filled in properly before. 113 * 114 * @param blob FDT blob to update 115 * @param start Array of size <banks> to hold the start addresses. 116 * @param size Array of size <banks> to hold the size of each region. 117 * @param banks Number of memory banks to create. If 0, the reg 118 * property will be left untouched. 119 * Return: 0 if ok, or -1 or -FDT_ERR_... on error 120 */ 121#ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY 122int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks); 123int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int banks); 124#else 125static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], 126 int banks) 127{ 128 return 0; 129} 130#endif 131 132void fdt_fixup_ethernet(void *fdt); 133int fdt_find_and_setprop(void *fdt, const char *node, const char *prop, 134 const void *val, int len, int create); 135void fdt_fixup_qe_firmware(void *fdt); 136 137/** 138 * Update native-mode property of display-timings node to the phandle 139 * of the timings matching a display by name (case insensitive). 140 * 141 * see kernel Documentation/devicetree/bindings/video/display-timing.txt 142 * 143 * @param blob FDT blob to update 144 * @param path path within dt 145 * @param display name of display timing to match 146 * Return: 0 if ok, or -FDT_ERR_... on error 147 */ 148int fdt_fixup_display(void *blob, const char *path, const char *display); 149 150#if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) 151void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd); 152#else 153static inline void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd) {} 154#endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */ 155 156#if defined(CONFIG_SYS_FSL_SEC_COMPAT) 157void fdt_fixup_crypto_node(void *blob, int sec_rev); 158#else 159static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {} 160#endif 161 162/** 163 * Record information about a processed loadable in /fit-images (creating 164 * /fit-images if necessary). 165 * 166 * @param blob FDT blob to update 167 * @param index index of this loadable 168 * @param name name of the loadable 169 * @param load_addr address the loadable was loaded to 170 * @param size number of bytes loaded 171 * @param entry_point entry point (if specified, otherwise pass -1) 172 * @param type type (if specified, otherwise pass NULL) 173 * @param os os-type (if specified, otherwise pass NULL) 174 * @param arch architecture (if specified, otherwise pass NULL) 175 * Return: 0 if ok, or -1 or -FDT_ERR_... on error 176 */ 177int fdt_record_loadable(void *blob, u32 index, const char *name, 178 uintptr_t load_addr, u32 size, uintptr_t entry_point, 179 const char *type, const char *os, const char *arch); 180 181#ifdef CONFIG_PCI 182#include <pci.h> 183int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose); 184#endif 185 186int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name); 187 188/** 189 * Add board-specific data to the FDT before booting the OS. 190 * 191 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space. 192 * This function is called if CONFIG_OF_BOARD_SETUP is defined 193 * 194 * @param blob FDT blob to update 195 * @param bd Pointer to board data 196 * Return: 0 if ok, or -FDT_ERR_... on error 197 */ 198int ft_board_setup(void *blob, struct bd_info *bd); 199 200/** 201 * board_rng_seed() - Provide a seed to be passed via /chosen/rng-seed 202 * 203 * This function is called if CONFIG_BOARD_RNG_SEED is set, and must 204 * be provided by the board. It should return, via @buf, some suitable 205 * seed value to pass to the kernel. 206 * 207 * @param buf A struct abuf for returning the seed and its size. 208 * @return 0 if ok, negative on error. 209 */ 210int board_rng_seed(struct abuf *buf); 211 212/** 213 * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line 214 * 215 * This is used for late modification of kernel command line arguments just 216 * before they are added into the /chosen node in flat device tree. 217 * 218 * @return: pointer to kernel command line arguments in memory 219 */ 220char *board_fdt_chosen_bootargs(void); 221 222/* 223 * The keystone2 SOC requires all 32 bit aliased addresses to be converted 224 * to their 36 physical format. This has to happen after all fdt nodes 225 * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex() 226 * called at the end of the image_setup_libfdt() is to do that convertion. 227 */ 228void ft_board_setup_ex(void *blob, struct bd_info *bd); 229 230/** 231 * Add system-specific data to the FDT before booting the OS. 232 * 233 * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space. 234 * This function is called if CONFIG_OF_SYSTEM_SETUP is defined 235 * 236 * @param blob FDT blob to update 237 * @param bd Pointer to board data 238 * Return: 0 if ok, or -FDT_ERR_... on error 239 */ 240int ft_system_setup(void *blob, struct bd_info *bd); 241 242void set_working_fdt_addr(ulong addr); 243 244/** 245 * fdt_shrink_to_minimum() - shrink FDT while allowing for some margin 246 * 247 * Shrink down the given blob to 'minimum' size + some extrasize. 248 * 249 * The new size is enough to hold the existing contents plus @extrasize bytes, 250 * plus 5 memory reservations. Also, the end of the FDT is aligned to a 4KB 251 * boundary, so it might end up up to 4KB larger than needed. 252 * 253 * If there is an existing memory reservation for @blob in the FDT, it is 254 * updated for the new size. 255 * 256 * @param blob FDT blob to update 257 * @param extrasize additional bytes needed 258 * Return: 0 if ok, or -FDT_ERR_... on error 259 */ 260int fdt_shrink_to_minimum(void *blob, uint extrasize); 261 262int fdt_increase_size(void *fdt, int add_len); 263 264int fdt_delete_disabled_nodes(void *blob); 265 266struct node_info; 267#if defined(CONFIG_FDT_FIXUP_PARTITIONS) 268void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info, 269 int node_info_size); 270#else 271static inline void fdt_fixup_mtdparts(void *fdt, 272 const struct node_info *node_info, 273 int node_info_size) 274{ 275} 276#endif 277 278/** 279 * copy the fixed-partition nodes from U-Boot device tree to external blob 280 * 281 * @param blob FDT blob to update 282 * Return: 0 if ok, or non-zero on error 283 */ 284int fdt_copy_fixed_partitions(void *blob); 285 286void fdt_del_node_and_alias(void *blob, const char *alias); 287 288/** 289 * Translate an address from the DT into a CPU physical address 290 * 291 * The translation relies on the "ranges" property. 292 * 293 * @param blob Pointer to device tree blob 294 * @param node_offset Node DT offset 295 * @param in_addr Pointer to the address to translate 296 * Return: translated address or OF_BAD_ADDR on error 297 */ 298u64 fdt_translate_address(const void *blob, int node_offset, 299 const __be32 *in_addr); 300/** 301 * Translate a DMA address from the DT into a CPU physical address 302 * 303 * The translation relies on the "dma-ranges" property. 304 * 305 * @param blob Pointer to device tree blob 306 * @param node_offset Node DT offset 307 * @param in_addr Pointer to the DMA address to translate 308 * Return: translated DMA address or OF_BAD_ADDR on error 309 */ 310u64 fdt_translate_dma_address(const void *blob, int node_offset, 311 const __be32 *in_addr); 312 313/** 314 * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and 315 * cpu->bus address translations 316 * 317 * @param blob Pointer to device tree blob 318 * @param node_offset Node DT offset 319 * @param cpu Pointer to variable storing the range's cpu address 320 * @param bus Pointer to variable storing the range's bus address 321 * @param size Pointer to variable storing the range's size 322 * Return: translated DMA address or OF_BAD_ADDR on error 323 */ 324int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu, 325 dma_addr_t *bus, u64 *size); 326 327int fdt_node_offset_by_compat_reg(void *blob, const char *compat, 328 phys_addr_t compat_off); 329int fdt_node_offset_by_pathf(void *blob, const char *fmt, ...) 330 __attribute__ ((format (printf, 2, 3))); 331 332#define fdt_for_each_node_by_compatible(node, fdt, start, compat) \ 333 for (node = fdt_node_offset_by_compatible(fdt, start, compat); \ 334 node >= 0; \ 335 node = fdt_node_offset_by_compatible(fdt, node, compat)) 336 337int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle); 338unsigned int fdt_create_phandle(void *fdt, int nodeoffset); 339unsigned int fdt_create_phandle_by_compatible(void *fdt, const char *compat); 340unsigned int fdt_create_phandle_by_pathf(void *fdt, const char *fmt, ...) 341 __attribute__ ((format (printf, 2, 3))); 342int fdt_add_edid(void *blob, const char *compat, unsigned char *buf); 343 344int fdt_verify_alias_address(void *fdt, int anode, const char *alias, 345 u64 addr); 346u64 fdt_get_base_address(const void *fdt, int node); 347int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr, 348 uint64_t *addr, uint64_t *len); 349 350enum fdt_status { 351 FDT_STATUS_OKAY, 352 FDT_STATUS_DISABLED, 353 FDT_STATUS_FAIL, 354}; 355int fdt_set_node_status(void *fdt, int nodeoffset, enum fdt_status status); 356static inline int fdt_status_okay(void *fdt, int nodeoffset) 357{ 358 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY); 359} 360static inline int fdt_status_disabled(void *fdt, int nodeoffset) 361{ 362 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED); 363} 364static inline int fdt_status_fail(void *fdt, int nodeoffset) 365{ 366 return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL); 367} 368 369int fdt_set_status_by_alias(void *fdt, const char *alias, 370 enum fdt_status status); 371static inline int fdt_status_okay_by_alias(void *fdt, const char *alias) 372{ 373 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY); 374} 375static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias) 376{ 377 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED); 378} 379static inline int fdt_status_fail_by_alias(void *fdt, const char *alias) 380{ 381 return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL); 382} 383 384int fdt_set_status_by_compatible(void *fdt, const char *compat, 385 enum fdt_status status); 386static inline int fdt_status_okay_by_compatible(void *fdt, const char *compat) 387{ 388 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_OKAY); 389} 390static inline int fdt_status_disabled_by_compatible(void *fdt, 391 const char *compat) 392{ 393 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_DISABLED); 394} 395static inline int fdt_status_fail_by_compatible(void *fdt, const char *compat) 396{ 397 return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_FAIL); 398} 399 400int fdt_set_status_by_pathf(void *fdt, enum fdt_status status, const char *fmt, 401 ...) __attribute__ ((format (printf, 3, 4))); 402#define fdt_status_okay_by_pathf(fdt, fmt, ...) \ 403 fdt_set_status_by_pathf((fdt), FDT_STATUS_OKAY, (fmt), ##__VA_ARGS__) 404#define fdt_status_disabled_by_pathf(fdt, fmt, ...) \ 405 fdt_set_status_by_pathf((fdt), FDT_STATUS_DISABLED, (fmt), ##__VA_ARGS__) 406#define fdt_status_fail_by_pathf(fdt, fmt, ...) \ 407 fdt_set_status_by_pathf((fdt), FDT_STATUS_FAIL, (fmt), ##__VA_ARGS__) 408 409/* Helper to read a big number; size is in cells (not bytes) */ 410static inline u64 fdt_read_number(const fdt32_t *cell, int size) 411{ 412 u64 r = 0; 413 while (size--) 414 r = (r << 32) | fdt32_to_cpu(*(cell++)); 415 return r; 416} 417 418void fdt_support_default_count_cells(const void *blob, int parentoffset, 419 int *addrc, int *sizec); 420int ft_verify_fdt(void *fdt); 421int arch_fixup_memory_node(void *blob); 422 423int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width, 424 u32 height, u32 stride, const char *format); 425 426int fdt_add_fb_mem_rsv(void *blob); 427 428int fdt_overlay_apply_verbose(void *fdt, void *fdto); 429 430int fdt_valid(struct fdt_header **blobp); 431 432/** 433 * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes 434 * 435 * Returns the length of the cell type in bytes (4 or 8). 436 * 437 * @blob: Pointer to device tree blob 438 * @nr_cells_name: Name to lookup, e.g. "#address-cells" 439 */ 440int fdt_get_cells_len(const void *blob, char *nr_cells_name); 441 442#endif /* !USE_HOSTCC */ 443 444#ifdef USE_HOSTCC 445int fdtdec_get_int(const void *blob, int node, const char *prop_name, 446 int default_val); 447 448/* 449 * Count child nodes of one parent node. 450 * 451 * @param blob FDT blob 452 * @param node parent node 453 * Return: number of child node; 0 if there is not child node 454 */ 455int fdtdec_get_child_count(const void *blob, int node); 456#endif 457#ifdef CONFIG_FMAN_ENET 458int fdt_update_ethernet_dt(void *blob); 459#endif 460#ifdef CONFIG_FSL_MC_ENET 461void fdt_fixup_board_enet(void *blob); 462#endif 463#ifdef CONFIG_CMD_PSTORE 464void fdt_fixup_pstore(void *blob); 465#endif 466#endif /* ifndef __FDT_SUPPORT_H */ 467