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