fdt_support.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338
  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. int fdt_set_usable_memory(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. /**
  121. * Record information about a processed loadable in /fit-images (creating
  122. * /fit-images if necessary).
  123. *
  124. * @param blob FDT blob to update
  125. * @param index index of this loadable
  126. * @param name name of the loadable
  127. * @param load_addr address the loadable was loaded to
  128. * @param size number of bytes loaded
  129. * @param entry_point entry point (if specified, otherwise pass -1)
  130. * @param type type (if specified, otherwise pass NULL)
  131. * @param os os-type (if specified, otherwise pass NULL)
  132. * @return 0 if ok, or -1 or -FDT_ERR_... on error
  133. */
  134. int fdt_record_loadable(void *blob, u32 index, const char *name,
  135. uintptr_t load_addr, u32 size, uintptr_t entry_point,
  136. const char *type, const char *os);
  137. #ifdef CONFIG_PCI
  138. #include <pci.h>
  139. int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
  140. #endif
  141. int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
  142. /**
  143. * Add board-specific data to the FDT before booting the OS.
  144. *
  145. * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
  146. * This function is called if CONFIG_OF_BOARD_SETUP is defined
  147. *
  148. * @param blob FDT blob to update
  149. * @param bd_t Pointer to board data
  150. * @return 0 if ok, or -FDT_ERR_... on error
  151. */
  152. int ft_board_setup(void *blob, bd_t *bd);
  153. /*
  154. * The keystone2 SOC requires all 32 bit aliased addresses to be converted
  155. * to their 36 physical format. This has to happen after all fdt nodes
  156. * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
  157. * called at the end of the image_setup_libfdt() is to do that convertion.
  158. */
  159. void ft_board_setup_ex(void *blob, bd_t *bd);
  160. void ft_cpu_setup(void *blob, bd_t *bd);
  161. void ft_pci_setup(void *blob, bd_t *bd);
  162. /**
  163. * Add system-specific data to the FDT before booting the OS.
  164. *
  165. * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
  166. * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
  167. *
  168. * @param blob FDT blob to update
  169. * @param bd_t Pointer to board data
  170. * @return 0 if ok, or -FDT_ERR_... on error
  171. */
  172. int ft_system_setup(void *blob, bd_t *bd);
  173. void set_working_fdt_addr(ulong addr);
  174. /**
  175. * shrink down the given blob to minimum size + some extrasize if required
  176. *
  177. * @param blob FDT blob to update
  178. * @param extrasize additional bytes needed
  179. * @return 0 if ok, or -FDT_ERR_... on error
  180. */
  181. int fdt_shrink_to_minimum(void *blob, uint extrasize);
  182. int fdt_increase_size(void *fdt, int add_len);
  183. int fdt_fixup_nor_flash_size(void *blob);
  184. struct node_info;
  185. #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
  186. void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
  187. int node_info_size);
  188. #else
  189. static inline void fdt_fixup_mtdparts(void *fdt,
  190. const struct node_info *node_info,
  191. int node_info_size)
  192. {
  193. }
  194. #endif
  195. void fdt_del_node_and_alias(void *blob, const char *alias);
  196. /**
  197. * Translate an address from the DT into a CPU physical address
  198. *
  199. * The translation relies on the "ranges" property.
  200. *
  201. * @param blob Pointer to device tree blob
  202. * @param node_offset Node DT offset
  203. * @param in_addr Pointer to the address to translate
  204. * @return translated address or OF_BAD_ADDR on error
  205. */
  206. u64 fdt_translate_address(const void *blob, int node_offset,
  207. const __be32 *in_addr);
  208. /**
  209. * Translate a DMA address from the DT into a CPU physical address
  210. *
  211. * The translation relies on the "dma-ranges" property.
  212. *
  213. * @param blob Pointer to device tree blob
  214. * @param node_offset Node DT offset
  215. * @param in_addr Pointer to the DMA address to translate
  216. * @return translated DMA address or OF_BAD_ADDR on error
  217. */
  218. u64 fdt_translate_dma_address(const void *blob, int node_offset,
  219. const __be32 *in_addr);
  220. int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
  221. phys_addr_t compat_off);
  222. int fdt_alloc_phandle(void *blob);
  223. int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
  224. unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
  225. int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
  226. int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
  227. u64 addr);
  228. u64 fdt_get_base_address(const void *fdt, int node);
  229. int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
  230. uint64_t *addr, uint64_t *len);
  231. enum fdt_status {
  232. FDT_STATUS_OKAY,
  233. FDT_STATUS_DISABLED,
  234. FDT_STATUS_FAIL,
  235. FDT_STATUS_FAIL_ERROR_CODE,
  236. };
  237. int fdt_set_node_status(void *fdt, int nodeoffset,
  238. enum fdt_status status, unsigned int error_code);
  239. static inline int fdt_status_okay(void *fdt, int nodeoffset)
  240. {
  241. return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY, 0);
  242. }
  243. static inline int fdt_status_disabled(void *fdt, int nodeoffset)
  244. {
  245. return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED, 0);
  246. }
  247. static inline int fdt_status_fail(void *fdt, int nodeoffset)
  248. {
  249. return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL, 0);
  250. }
  251. int fdt_set_status_by_alias(void *fdt, const char *alias,
  252. enum fdt_status status, unsigned int error_code);
  253. static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
  254. {
  255. return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY, 0);
  256. }
  257. static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
  258. {
  259. return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED, 0);
  260. }
  261. static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
  262. {
  263. return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL, 0);
  264. }
  265. /* Helper to read a big number; size is in cells (not bytes) */
  266. static inline u64 fdt_read_number(const fdt32_t *cell, int size)
  267. {
  268. u64 r = 0;
  269. while (size--)
  270. r = (r << 32) | fdt32_to_cpu(*(cell++));
  271. return r;
  272. }
  273. void fdt_support_default_count_cells(const void *blob, int parentoffset,
  274. int *addrc, int *sizec);
  275. int ft_verify_fdt(void *fdt);
  276. int arch_fixup_memory_node(void *blob);
  277. int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
  278. u32 height, u32 stride, const char *format);
  279. int fdt_overlay_apply_verbose(void *fdt, void *fdto);
  280. /**
  281. * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
  282. *
  283. * Returns the length of the cell type in bytes (4 or 8).
  284. *
  285. * @blob: Pointer to device tree blob
  286. * @nr_cells_name: Name to lookup, e.g. "#address-cells"
  287. */
  288. int fdt_get_cells_len(const void *blob, char *nr_cells_name);
  289. #endif /* ifdef CONFIG_OF_LIBFDT */
  290. #ifdef USE_HOSTCC
  291. int fdtdec_get_int(const void *blob, int node, const char *prop_name,
  292. int default_val);
  293. #endif
  294. #ifdef CONFIG_FMAN_ENET
  295. int fdt_update_ethernet_dt(void *blob);
  296. #endif
  297. #ifdef CONFIG_FSL_MC_ENET
  298. void fdt_fixup_board_enet(void *blob);
  299. #endif
  300. #endif /* ifndef __FDT_SUPPORT_H */