include/fdt_support.h

   1 /*
   2  * (C) Copyright 2007
   3  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #ifndef __FDT_SUPPORT_H
   9 #define __FDT_SUPPORT_H
  10
  11 #ifdef CONFIG_OF_LIBFDT
  12
  13 #include <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 #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 #if CONFIG_IS_ENABLED(LOAD_FIT)
 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 #endif
 155
 156 #ifdef CONFIG_PCI
 157 #include <pci.h>
 158 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
 159 #endif
 160
 161 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
 162
 163 /**
 164  * Add board-specific data to the FDT before booting the OS.
 165  *
 166  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
 167  * This function is called if CONFIG_OF_BOARD_SETUP is defined
 168  *
 169  * @param blob          FDT blob to update
 170  * @param bd_t          Pointer to board data
 171  * @return 0 if ok, or -FDT_ERR_... on error
 172  */
 173 int ft_board_setup(void *blob, bd_t *bd);
 174
 175 /*
 176  * The keystone2 SOC requires all 32 bit aliased addresses to be converted
 177  * to their 36 physical format. This has to happen after all fdt nodes
 178  * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
 179  * called at the end of the image_setup_libfdt() is to do that convertion.
 180  */
 181 void ft_board_setup_ex(void *blob, bd_t *bd);
 182 void ft_cpu_setup(void *blob, bd_t *bd);
 183 void ft_pci_setup(void *blob, bd_t *bd);
 184
 185 /**
 186  * Add system-specific data to the FDT before booting the OS.
 187  *
 188  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
 189  * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
 190  *
 191  * @param blob          FDT blob to update
 192  * @param bd_t          Pointer to board data
 193  * @return 0 if ok, or -FDT_ERR_... on error
 194  */
 195 int ft_system_setup(void *blob, bd_t *bd);
 196
 197 void set_working_fdt_addr(ulong addr);
 198
 199 /**
 200  * shrink down the given blob to minimum size + some extrasize if required
 201  *
 202  * @param blob          FDT blob to update
 203  * @param extrasize     additional bytes needed
 204  * @return 0 if ok, or -FDT_ERR_... on error
 205  */
 206 int fdt_shrink_to_minimum(void *blob, uint extrasize);
 207 int fdt_increase_size(void *fdt, int add_len);
 208
 209 int fdt_fixup_nor_flash_size(void *blob);
 210
 211 #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
 212 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
 213 #else
 214 static inline void fdt_fixup_mtdparts(void *fdt, void *node_info,
 215                                         int node_info_size) {}
 216 #endif
 217
 218 void fdt_del_node_and_alias(void *blob, const char *alias);
 219 u64 fdt_translate_address(const void *blob, int node_offset,
 220                           const __be32 *in_addr);
 221 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
 222                                         phys_addr_t compat_off);
 223 int fdt_alloc_phandle(void *blob);
 224 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
 225 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
 226 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
 227
 228 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
 229                               u64 addr);
 230 u64 fdt_get_base_address(const void *fdt, int node);
 231 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
 232                    uint64_t *addr, uint64_t *len);
 233
 234 enum fdt_status {
 235         FDT_STATUS_OKAY,
 236         FDT_STATUS_DISABLED,
 237         FDT_STATUS_FAIL,
 238         FDT_STATUS_FAIL_ERROR_CODE,
 239 };
 240 int fdt_set_node_status(void *fdt, int nodeoffset,
 241                         enum fdt_status status, unsigned int error_code);
 242 static inline int fdt_status_okay(void *fdt, int nodeoffset)
 243 {
 244         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
 245 }
 246 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
 247 {
 248         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
 249 }
 250 static inline int fdt_status_fail(void *fdt, int nodeoffset)
 251 {
 252         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
 253 }
 254
 255 int fdt_set_status_by_alias(void *fdt, const char *alias,
 256                             enum fdt_status status, unsigned int error_code);
 257 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
 258 {
 259         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
 260 }
 261 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
 262 {
 263         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
 264 }
 265 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
 266 {
 267         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
 268 }
 269
 270 /* Helper to read a big number; size is in cells (not bytes) */
 271 static inline u64 fdt_read_number(const fdt32_t *cell, int size)
 272 {
 273         u64 r = 0;
 274         while (size--)
 275                 r = (r << 32) | fdt32_to_cpu(*(cell++));
 276         return r;
 277 }
 278
 279 void fdt_support_default_count_cells(const void *blob, int parentoffset,
 280                                         int *addrc, int *sizec);
 281 int ft_verify_fdt(void *fdt);
 282 int arch_fixup_memory_node(void *blob);
 283
 284 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
 285                             u32 height, u32 stride, const char *format);
 286
 287 int fdt_overlay_apply_verbose(void *fdt, void *fdto);
 288
 289 #endif /* ifdef CONFIG_OF_LIBFDT */
 290
 291 #ifdef USE_HOSTCC
 292 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
 293                 int default_val);
 294 #endif
 295 #endif /* ifndef __FDT_SUPPORT_H */