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