fdt_support.h 8.8 KB

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