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 uint32_t fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
  16                                 const char *prop, const uint32_t dflt);
  17 uint32_t fdt_getprop_u32_default(const void *fdt, const char *path,
  18                                 const char *prop, const uint32_t 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                           uint32_t 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, uint32_t 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, uint32_t 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, uint64_t start, uint64_t 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 int fdt_fixup_memory_banks(void *blob, uint64_t start[], uint64_t size[], int banks);
  97
  98 void fdt_fixup_ethernet(void *fdt);
  99 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
 100                          const void *val, int len, int create);
 101 void fdt_fixup_qe_firmware(void *fdt);
 102
 103 #if defined(__UBOOT__)
 104 /**
 105  * Update native-mode property of display-timings node to the phandle
 106  * of the timings matching a display by name (case insensitive).
 107  *
 108  * see kernel Documentation/devicetree/bindings/video/display-timing.txt
 109  *
 110  * @param blob          FDT blob to update
 111  * @param path          path within dt
 112  * @param display       name of display timing to match
 113  * @return 0 if ok, or -FDT_ERR_... on error
 114  */
 115 int fdt_fixup_display(void *blob, const char *path, const char *display);
 116
 117 #if defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB)
 118 void fdt_fixup_dr_usb(void *blob, bd_t *bd);
 119 #else
 120 static inline void fdt_fixup_dr_usb(void *blob, bd_t *bd) {}
 121 #endif /* defined(CONFIG_HAS_FSL_DR_USB) || defined(CONFIG_HAS_FSL_MPH_USB) */
 122
 123 #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
 124 void fdt_fixup_crypto_node(void *blob, int sec_rev);
 125 #else
 126 static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
 127 #endif
 128
 129 #ifdef CONFIG_PCI
 130 #include <pci.h>
 131 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
 132 #endif
 133
 134 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
 135
 136 /**
 137  * Add board-specific data to the FDT before booting the OS.
 138  *
 139  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
 140  * This function is called if CONFIG_OF_BOARD_SETUP is defined
 141  *
 142  * @param blob          FDT blob to update
 143  * @param bd_t          Pointer to board data
 144  * @return 0 if ok, or -FDT_ERR_... on error
 145  */
 146 int ft_board_setup(void *blob, bd_t *bd);
 147
 148 /*
 149  * The keystone2 SOC requires all 32 bit aliased addresses to be converted
 150  * to their 36 physical format. This has to happen after all fdt nodes
 151  * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
 152  * called at the end of the image_setup_libfdt() is to do that convertion.
 153  */
 154 void ft_board_setup_ex(void *blob, bd_t *bd);
 155 void ft_cpu_setup(void *blob, bd_t *bd);
 156 void ft_pci_setup(void *blob, bd_t *bd);
 157
 158 /**
 159  * Add system-specific data to the FDT before booting the OS.
 160  *
 161  * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
 162  * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
 163  *
 164  * @param blob          FDT blob to update
 165  * @param bd_t          Pointer to board data
 166  * @return 0 if ok, or -FDT_ERR_... on error
 167  */
 168 int ft_system_setup(void *blob, bd_t *bd);
 169
 170 void set_working_fdt_addr(ulong addr);
 171 int fdt_shrink_to_minimum(void *blob);
 172 int fdt_increase_size(void *fdt, int add_len);
 173
 174 int fdt_fixup_nor_flash_size(void *blob);
 175
 176 void fdt_fixup_mtdparts(void *fdt, void *node_info, int node_info_size);
 177 void fdt_del_node_and_alias(void *blob, const char *alias);
 178 uint64_t fdt_translate_address(void *blob, int node_offset, const __be32 *in_addr);
 179 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
 180                                         phys_addr_t compat_off);
 181 int fdt_alloc_phandle(void *blob);
 182 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
 183 unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
 184 int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
 185
 186 int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
 187                               uint64_t addr);
 188 uint64_t fdt_get_base_address(void *fdt, int node);
 189 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
 190                    uint64_t *addr, uint64_t *len);
 191 #endif /* __UBOOT__ */
 192
 193 enum fdt_status {
 194         FDT_STATUS_OKAY,
 195         FDT_STATUS_DISABLED,
 196         FDT_STATUS_FAIL,
 197         FDT_STATUS_FAIL_ERROR_CODE,
 198 };
 199 int fdt_set_node_status(void *fdt, int nodeoffset,
 200                         enum fdt_status status, unsigned int error_code);
 201 static inline int fdt_status_okay(void *fdt, int nodeoffset)
 202 {
 203         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
 204 }
 205 static inline int fdt_status_disabled(void *fdt, int nodeoffset)
 206 {
 207         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
 208 }
 209 static inline int fdt_status_fail(void *fdt, int nodeoffset)
 210 {
 211         return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
 212 }
 213
 214 int fdt_set_status_by_alias(void *fdt, const char *alias,
 215                             enum fdt_status status, unsigned int error_code);
 216 static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
 217 {
 218         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
 219 }
 220 static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
 221 {
 222         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
 223 }
 224 static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
 225 {
 226         return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
 227 }
 228
 229 /* Helper to read a big number; size is in cells (not bytes) */
 230 static inline uint64_t of_read_number(const fdt32_t *cell, int size)
 231 {
 232         uint64_t r = 0;
 233
 234         while (size--) {
 235                 r = (r << 32) | fdt32_to_cpu(*cell);
 236                 cell++;
 237         }
 238         return r;
 239 }
 240
 241 void of_bus_default_count_cells(void *blob, int parentoffset,
 242                                         int *addrc, int *sizec);
 243 int ft_verify_fdt(void *fdt);
 244 int arch_fixup_memory_node(void *blob);
 245
 246 int fdt_setup_simplefb_node(void *fdt, int node, uint64_t base_address, uint32_t width,
 247                             uint32_t height, uint32_t stride, const char *format);
 248
 249 #endif /* ifdef CONFIG_OF_LIBFDT */
 250
 251 #ifdef USE_HOSTCC
 252 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
 253                 int default_val);
 254 #endif
 255 #endif /* ifndef __FDT_SUPPORT_H */