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