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 int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int banks);
  98 #else
  99 static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
 100                                          int banks)
 101 {
 102         return 0;
 103 }
 104 #endif
 105
 106 void fdt_fixup_ethernet(void *fdt);
 107 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
 108                          const void *val, int len, int create);
 109 void fdt_fixup_qe_firmware(void *fdt);
 110
 111 /**
 112  * Update native-mode property of display-timings node to the phandle
 113  * of the timings matching a display by name (case insensitive).
 114  *
 115  * see kernel Documentation/devicetree/bindings/video/display-timing.txt
 116  *
 117  * @param blob          FDT blob to update
 118  * @param path          path within dt
 119  * @param display       name of display timing to match
 120  * @return 0 if ok, or -FDT_ERR_... on error
 121  */
 122 int fdt_fixup_display(void *blob, const char *path, const char *display);
 123
 124 #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
 125 void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd);
 126 #else
 127 static inline void fsl_fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
 128 #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
 129
 130 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
 131 void fdt_fixup_crypto_node(void *blob, int sec_rev);
 132 #else
 133 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
 134 #endif
 135
 136 /**
 137  * Record information about a processed loadable in /fit-images (creating
 138  * /fit-images if necessary).
 139  *
 140  * @param blob          FDT blob to update
 141  * @param index         index of this loadable
 142  * @param name          name of the loadable
 143  * @param load_addr     address the loadable was loaded to
 144  * @param size          number of bytes loaded
 145  * @param entry_point   entry point (if specified, otherwise pass -1)
 146  * @param type          type (if specified, otherwise pass NULL)
 147  * @param os            os-type (if specified, otherwise pass NULL)
 148  * @return 0 if ok, or -1 or -FDT_ERR_... on error
 149  */
 150 int fdt_record_loadable(void *blob, u32 index, const char *name,
 151                         uintptr_t load_addr, u32 size, uintptr_t entry_point,
 152                         const char *type, const char *os);
 153
 154 #ifdef CONFIG_PCI
 155 #include <pci.h>
 156 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
 157 #endif
 158
 159 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
 160
 161 /**
 162  * Add board-specific data to the FDT before booting the OS.
 163  *
 164  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
 165  * This function is called if CONFIG_OF_BOARD_SETUP is defined
 166  *
 167  * @param blob          FDT blob to update
 168  * @param bd_t          Pointer to board data
 169  * @return 0 if ok, or -FDT_ERR_... on error
 170  */
 171 int ft_board_setup(void *blob, bd_t *bd);
 172
 173 /*
 174  * The keystone2 SOC requires all 32 bit aliased addresses to be converted
 175  * to their 36 physical format. This has to happen after all fdt nodes
 176  * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
 177  * called at the end of the image_setup_libfdt() is to do that convertion.
 178  */
 179 void ft_board_setup_ex(void *blob, bd_t *bd);
 180 void ft_cpu_setup(void *blob, bd_t *bd);
 181 void ft_pci_setup(void *blob, bd_t *bd);
 182
 183 /**
 184  * Add system-specific data to the FDT before booting the OS.
 185  *
 186  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
 187  * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
 188  *
 189  * @param blob          FDT blob to update
 190  * @param bd_t          Pointer to board data
 191  * @return 0 if ok, or -FDT_ERR_... on error
 192  */
 193 int ft_system_setup(void *blob, bd_t *bd);
 194
 195 void set_working_fdt_addr(ulong addr);
 196
 197 /**
 198  * shrink down the given blob to minimum size + some extrasize if required
 199  *
 200  * @param blob          FDT blob to update
 201  * @param extrasize     additional bytes needed
 202  * @return 0 if ok, or -FDT_ERR_... on error
 203  */
 204 int fdt_shrink_to_minimum(void *blob, uint extrasize);
 205 int fdt_increase_size(void *fdt, int add_len);
 206
 207 int fdt_fixup_nor_flash_size(void *blob);
 208
 209 struct node_info;
 210 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
 211 void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
 212                         int node_info_size);
 213 #else
 214 static inline void fdt_fixup_mtdparts(void *fdt,
 215                                       const struct node_info *node_info,
 216                                       int node_info_size)
 217 {
 218 }
 219 #endif
 220
 221 void fdt_del_node_and_alias(void *blob, const char *alias);
 222
 223 /**
 224  * Translate an address from the DT into a CPU physical address
 225  *
 226  * The translation relies on the "ranges" property.
 227  *
 228  * @param blob          Pointer to device tree blob
 229  * @param node_offset   Node DT offset
 230  * @param in_addr       Pointer to the address to translate
 231  * @return translated address or OF_BAD_ADDR on error
 232  */
 233 u64 fdt_translate_address(const void *blob, int node_offset,
 234                           const __be32 *in_addr);
 235 /**
 236  * Translate a DMA address from the DT into a CPU physical address
 237  *
 238  * The translation relies on the "dma-ranges" property.
 239  *
 240  * @param blob          Pointer to device tree blob
 241  * @param node_offset   Node DT offset
 242  * @param in_addr       Pointer to the DMA address to translate
 243  * @return translated DMA address or OF_BAD_ADDR on error
 244  */
 245 u64 fdt_translate_dma_address(const void *blob, int node_offset,
 246                               const __be32 *in_addr);
 247
 248 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
 249                                         phys_addr_t compat_off);
 250 int fdt_alloc_phandle(void *blob);
 251 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
 252 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
 253 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
 254
 255 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
 256                               u64 addr);
 257 u64 fdt_get_base_address(const void *fdt, int node);
 258 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
 259                    uint64_t *addr, uint64_t *len);
 260
 261 enum fdt_status {
 262         FDT_STATUS_OKAY,
 263         FDT_STATUS_DISABLED,
 264         FDT_STATUS_FAIL,
 265         FDT_STATUS_FAIL_ERROR_CODE,
 266 };
 267 int fdt_set_node_status(void *fdt, int nodeoffset,
 268                         enum fdt_status status, unsigned int error_code);
 269 static inline int fdt_status_okay(void *fdt, int nodeoffset)
 270 {
 271         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
 272 }
 273 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
 274 {
 275         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
 276 }
 277 static inline int fdt_status_fail(void *fdt, int nodeoffset)
 278 {
 279         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
 280 }
 281
 282 int fdt_set_status_by_alias(void *fdt, const char *alias,
 283                             enum fdt_status status, unsigned int error_code);
 284 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
 285 {
 286         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
 287 }
 288 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
 289 {
 290         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
 291 }
 292 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
 293 {
 294         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
 295 }
 296
 297 /* Helper to read a big number; size is in cells (not bytes) */
 298 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
 299 {
 300         u64 r = 0;
 301         while (size--)
 302                 r = (r << 32) | fdt32_to_cpu(*(cell++));
 303         return r;
 304 }
 305
 306 void fdt_support_default_count_cells(const void *blob, int parentoffset,
 307                                         int *addrc, int *sizec);
 308 int ft_verify_fdt(void *fdt);
 309 int arch_fixup_memory_node(void *blob);
 310
 311 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
 312                             u32 height, u32 stride, const char *format);
 313
 314 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
 315
 316 /**
 317  * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
 318  *
 319  * Returns the length of the cell type in bytes (4 or 8).
 320  *
 321  * @blob: Pointer to device tree blob
 322  * @nr_cells_name: Name to lookup, e.g. "#address-cells"
 323  */
 324 int fdt_get_cells_len(const void *blob, char *nr_cells_name);
 325
 326 #endif /* ifdef CONFIG_OF_LIBFDT */
 327
 328 #ifdef USE_HOSTCC
 329 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
 330                 int default_val);
 331 #endif
 332 #ifdef CONFIG_FMAN_ENET
 333 int fdt_update_ethernet_dt(void *blob);
 334 #endif
 335 #ifdef CONFIG_FSL_MC_ENET
 336 void fdt_fixup_board_enet(void *blob);
 337 #endif
 338 #endif /* ifndef __FDT_SUPPORT_H */