include/fdt_support.h

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