fdt_support.h 10 KB

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