fdt_support.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425
  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. #if defined(CONFIG_OF_LIBFDT) && !defined(USE_HOSTCC)
  9. #include <asm/u-boot.h>
  10. #include <linux/libfdt.h>
  11. /**
  12. * arch_fixup_fdt() - Write arch-specific information to fdt
  13. *
  14. * Defined in arch/$(ARCH)/lib/bootm-fdt.c
  15. *
  16. * @blob: FDT blob to write to
  17. * Return: 0 if ok, or -ve FDT_ERR_... on failure
  18. */
  19. int arch_fixup_fdt(void *blob);
  20. void ft_cpu_setup(void *blob, struct bd_info *bd);
  21. void ft_pci_setup(void *blob, struct bd_info *bd);
  22. u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
  23. const char *prop, const u32 dflt);
  24. u32 fdt_getprop_u32_default(const void *fdt, const char *path,
  25. const char *prop, const u32 dflt);
  26. /**
  27. * Add data to the root of the FDT before booting the OS.
  28. *
  29. * See doc/device-tree-bindings/root.txt
  30. *
  31. * @param fdt FDT address in memory
  32. * Return: 0 if ok, or -FDT_ERR_... on error
  33. */
  34. int fdt_root(void *fdt);
  35. /**
  36. * Add chosen data the FDT before booting the OS.
  37. *
  38. * In particular, this adds the kernel command line (bootargs) to the FDT.
  39. *
  40. * @param fdt FDT address in memory
  41. * Return: 0 if ok, or -FDT_ERR_... on error
  42. */
  43. int fdt_chosen(void *fdt);
  44. /**
  45. * Add initrd information to the FDT before booting the OS.
  46. *
  47. * @param fdt FDT address in memory
  48. * Return: 0 if ok, or -FDT_ERR_... on error
  49. */
  50. int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end);
  51. void do_fixup_by_path(void *fdt, const char *path, const char *prop,
  52. const void *val, int len, int create);
  53. void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
  54. u32 val, int create);
  55. static inline void do_fixup_by_path_string(void *fdt, const char *path,
  56. const char *prop, const char *status)
  57. {
  58. do_fixup_by_path(fdt, path, prop, status, strlen(status) + 1, 1);
  59. }
  60. void do_fixup_by_prop(void *fdt,
  61. const char *pname, const void *pval, int plen,
  62. const char *prop, const void *val, int len,
  63. int create);
  64. void do_fixup_by_prop_u32(void *fdt,
  65. const char *pname, const void *pval, int plen,
  66. const char *prop, u32 val, int create);
  67. void do_fixup_by_compat(void *fdt, const char *compat,
  68. const char *prop, const void *val, int len, int create);
  69. void do_fixup_by_compat_u32(void *fdt, const char *compat,
  70. const char *prop, u32 val, int create);
  71. /**
  72. * Setup the memory node in the DT. Creates one if none was existing before.
  73. * Calls fdt_fixup_memory_banks() to populate a single reg pair covering the
  74. * whole memory.
  75. *
  76. * @param blob FDT blob to update
  77. * @param start Begin of DRAM mapping in physical memory
  78. * @param size Size of the single memory bank
  79. * Return: 0 if ok, or -1 or -FDT_ERR_... on error
  80. */
  81. int fdt_fixup_memory(void *blob, u64 start, u64 size);
  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. #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
  97. int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks);
  98. int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int banks);
  99. #else
  100. static inline int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[],
  101. int banks)
  102. {
  103. return 0;
  104. }
  105. #endif
  106. void fdt_fixup_ethernet(void *fdt);
  107. int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
  108. const void *val, int len, int create);
  109. void fdt_fixup_qe_firmware(void *fdt);
  110. /**
  111. * Update native-mode property of display-timings node to the phandle
  112. * of the timings matching a display by name (case insensitive).
  113. *
  114. * see kernel Documentation/devicetree/bindings/video/display-timing.txt
  115. *
  116. * @param blob FDT blob to update
  117. * @param path path within dt
  118. * @param display name of display timing to match
  119. * Return: 0 if ok, or -FDT_ERR_... on error
  120. */
  121. int fdt_fixup_display(void *blob, const char *path, const char *display);
  122. #if defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL)
  123. void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd);
  124. #else
  125. static inline void fsl_fdt_fixup_dr_usb(void *blob, struct bd_info *bd) {}
  126. #endif /* defined(CONFIG_USB_EHCI_FSL) || defined(CONFIG_USB_XHCI_FSL) */
  127. #if defined(CONFIG_SYS_FSL_SEC_COMPAT)
  128. void fdt_fixup_crypto_node(void *blob, int sec_rev);
  129. #else
  130. static inline void fdt_fixup_crypto_node(void *blob, int sec_rev) {}
  131. #endif
  132. /**
  133. * Record information about a processed loadable in /fit-images (creating
  134. * /fit-images if necessary).
  135. *
  136. * @param blob FDT blob to update
  137. * @param index index of this loadable
  138. * @param name name of the loadable
  139. * @param load_addr address the loadable was loaded to
  140. * @param size number of bytes loaded
  141. * @param entry_point entry point (if specified, otherwise pass -1)
  142. * @param type type (if specified, otherwise pass NULL)
  143. * @param os os-type (if specified, otherwise pass NULL)
  144. * @param arch architecture (if specified, otherwise pass NULL)
  145. * Return: 0 if ok, or -1 or -FDT_ERR_... on error
  146. */
  147. int fdt_record_loadable(void *blob, u32 index, const char *name,
  148. uintptr_t load_addr, u32 size, uintptr_t entry_point,
  149. const char *type, const char *os, const char *arch);
  150. #ifdef CONFIG_PCI
  151. #include <pci.h>
  152. int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose);
  153. #endif
  154. int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name);
  155. /**
  156. * Add board-specific data to the FDT before booting the OS.
  157. *
  158. * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
  159. * This function is called if CONFIG_OF_BOARD_SETUP is defined
  160. *
  161. * @param blob FDT blob to update
  162. * @param bd Pointer to board data
  163. * Return: 0 if ok, or -FDT_ERR_... on error
  164. */
  165. int ft_board_setup(void *blob, struct bd_info *bd);
  166. /**
  167. * board_fdt_chosen_bootargs() - Arbitrarily amend fdt kernel command line
  168. *
  169. * This is used for late modification of kernel command line arguments just
  170. * before they are added into the /chosen node in flat device tree.
  171. *
  172. * @return: pointer to kernel command line arguments in memory
  173. */
  174. char *board_fdt_chosen_bootargs(void);
  175. /*
  176. * The keystone2 SOC requires all 32 bit aliased addresses to be converted
  177. * to their 36 physical format. This has to happen after all fdt nodes
  178. * are added or modified by the image_setup_libfdt(). The ft_board_setup_ex()
  179. * called at the end of the image_setup_libfdt() is to do that convertion.
  180. */
  181. void ft_board_setup_ex(void *blob, struct bd_info *bd);
  182. /**
  183. * Add system-specific data to the FDT before booting the OS.
  184. *
  185. * Use CONFIG_SYS_FDT_PAD to ensure there is sufficient space.
  186. * This function is called if CONFIG_OF_SYSTEM_SETUP is defined
  187. *
  188. * @param blob FDT blob to update
  189. * @param bd Pointer to board data
  190. * Return: 0 if ok, or -FDT_ERR_... on error
  191. */
  192. int ft_system_setup(void *blob, struct bd_info *bd);
  193. void set_working_fdt_addr(ulong addr);
  194. /**
  195. * shrink down the given blob to minimum size + some extrasize if required
  196. *
  197. * @param blob FDT blob to update
  198. * @param extrasize additional bytes needed
  199. * Return: 0 if ok, or -FDT_ERR_... on error
  200. */
  201. int fdt_shrink_to_minimum(void *blob, uint extrasize);
  202. int fdt_increase_size(void *fdt, int add_len);
  203. int fdt_delete_disabled_nodes(void *blob);
  204. int fdt_fixup_nor_flash_size(void *blob);
  205. struct node_info;
  206. #if defined(CONFIG_FDT_FIXUP_PARTITIONS)
  207. void fdt_fixup_mtdparts(void *fdt, const struct node_info *node_info,
  208. int node_info_size);
  209. #else
  210. static inline void fdt_fixup_mtdparts(void *fdt,
  211. const struct node_info *node_info,
  212. int node_info_size)
  213. {
  214. }
  215. #endif
  216. void fdt_del_node_and_alias(void *blob, const char *alias);
  217. /**
  218. * Translate an address from the DT into a CPU physical address
  219. *
  220. * The translation relies on the "ranges" property.
  221. *
  222. * @param blob Pointer to device tree blob
  223. * @param node_offset Node DT offset
  224. * @param in_addr Pointer to the address to translate
  225. * Return: translated address or OF_BAD_ADDR on error
  226. */
  227. u64 fdt_translate_address(const void *blob, int node_offset,
  228. const __be32 *in_addr);
  229. /**
  230. * Translate a DMA address from the DT into a CPU physical address
  231. *
  232. * The translation relies on the "dma-ranges" property.
  233. *
  234. * @param blob Pointer to device tree blob
  235. * @param node_offset Node DT offset
  236. * @param in_addr Pointer to the DMA address to translate
  237. * Return: translated DMA address or OF_BAD_ADDR on error
  238. */
  239. u64 fdt_translate_dma_address(const void *blob, int node_offset,
  240. const __be32 *in_addr);
  241. /**
  242. * Get DMA ranges for a specifc node, this is useful to perform bus->cpu and
  243. * cpu->bus address translations
  244. *
  245. * @param blob Pointer to device tree blob
  246. * @param node_offset Node DT offset
  247. * @param cpu Pointer to variable storing the range's cpu address
  248. * @param bus Pointer to variable storing the range's bus address
  249. * @param size Pointer to variable storing the range's size
  250. * Return: translated DMA address or OF_BAD_ADDR on error
  251. */
  252. int fdt_get_dma_range(const void *blob, int node_offset, phys_addr_t *cpu,
  253. dma_addr_t *bus, u64 *size);
  254. int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
  255. phys_addr_t compat_off);
  256. int fdt_node_offset_by_pathf(void *blob, const char *fmt, ...)
  257. __attribute__ ((format (printf, 2, 3)));
  258. #define fdt_for_each_node_by_compatible(node, fdt, start, compat) \
  259. for (node = fdt_node_offset_by_compatible(fdt, start, compat); \
  260. node >= 0; \
  261. node = fdt_node_offset_by_compatible(fdt, node, compat))
  262. int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle);
  263. unsigned int fdt_create_phandle(void *fdt, int nodeoffset);
  264. unsigned int fdt_create_phandle_by_compatible(void *fdt, const char *compat);
  265. unsigned int fdt_create_phandle_by_pathf(void *fdt, const char *fmt, ...)
  266. __attribute__ ((format (printf, 2, 3)));
  267. int fdt_add_edid(void *blob, const char *compat, unsigned char *buf);
  268. int fdt_verify_alias_address(void *fdt, int anode, const char *alias,
  269. u64 addr);
  270. u64 fdt_get_base_address(const void *fdt, int node);
  271. int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
  272. uint64_t *addr, uint64_t *len);
  273. enum fdt_status {
  274. FDT_STATUS_OKAY,
  275. FDT_STATUS_DISABLED,
  276. FDT_STATUS_FAIL,
  277. };
  278. int fdt_set_node_status(void *fdt, int nodeoffset, enum fdt_status status);
  279. static inline int fdt_status_okay(void *fdt, int nodeoffset)
  280. {
  281. return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_OKAY);
  282. }
  283. static inline int fdt_status_disabled(void *fdt, int nodeoffset)
  284. {
  285. return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_DISABLED);
  286. }
  287. static inline int fdt_status_fail(void *fdt, int nodeoffset)
  288. {
  289. return fdt_set_node_status(fdt, nodeoffset, FDT_STATUS_FAIL);
  290. }
  291. int fdt_set_status_by_alias(void *fdt, const char *alias,
  292. enum fdt_status status);
  293. static inline int fdt_status_okay_by_alias(void *fdt, const char *alias)
  294. {
  295. return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_OKAY);
  296. }
  297. static inline int fdt_status_disabled_by_alias(void *fdt, const char *alias)
  298. {
  299. return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_DISABLED);
  300. }
  301. static inline int fdt_status_fail_by_alias(void *fdt, const char *alias)
  302. {
  303. return fdt_set_status_by_alias(fdt, alias, FDT_STATUS_FAIL);
  304. }
  305. int fdt_set_status_by_compatible(void *fdt, const char *compat,
  306. enum fdt_status status);
  307. static inline int fdt_status_okay_by_compatible(void *fdt, const char *compat)
  308. {
  309. return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_OKAY);
  310. }
  311. static inline int fdt_status_disabled_by_compatible(void *fdt,
  312. const char *compat)
  313. {
  314. return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_DISABLED);
  315. }
  316. static inline int fdt_status_fail_by_compatible(void *fdt, const char *compat)
  317. {
  318. return fdt_set_status_by_compatible(fdt, compat, FDT_STATUS_FAIL);
  319. }
  320. int fdt_set_status_by_pathf(void *fdt, enum fdt_status status, const char *fmt,
  321. ...) __attribute__ ((format (printf, 3, 4)));
  322. #define fdt_status_okay_by_pathf(fdt, fmt, ...) \
  323. fdt_set_status_by_pathf((fdt), FDT_STATUS_OKAY, (fmt), ##__VA_ARGS__)
  324. #define fdt_status_disabled_by_pathf(fdt, fmt, ...) \
  325. fdt_set_status_by_pathf((fdt), FDT_STATUS_DISABLED, (fmt), ##__VA_ARGS__)
  326. #define fdt_status_fail_by_pathf(fdt, fmt, ...) \
  327. fdt_set_status_by_pathf((fdt), FDT_STATUS_FAIL, (fmt), ##__VA_ARGS__)
  328. /* Helper to read a big number; size is in cells (not bytes) */
  329. static inline u64 fdt_read_number(const fdt32_t *cell, int size)
  330. {
  331. u64 r = 0;
  332. while (size--)
  333. r = (r << 32) | fdt32_to_cpu(*(cell++));
  334. return r;
  335. }
  336. void fdt_support_default_count_cells(const void *blob, int parentoffset,
  337. int *addrc, int *sizec);
  338. int ft_verify_fdt(void *fdt);
  339. int arch_fixup_memory_node(void *blob);
  340. int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
  341. u32 height, u32 stride, const char *format);
  342. int fdt_overlay_apply_verbose(void *fdt, void *fdto);
  343. int fdt_valid(struct fdt_header **blobp);
  344. /**
  345. * fdt_get_cells_len() - Get the length of a type of cell in top-level nodes
  346. *
  347. * Returns the length of the cell type in bytes (4 or 8).
  348. *
  349. * @blob: Pointer to device tree blob
  350. * @nr_cells_name: Name to lookup, e.g. "#address-cells"
  351. */
  352. int fdt_get_cells_len(const void *blob, char *nr_cells_name);
  353. #endif /* ifdef CONFIG_OF_LIBFDT */
  354. #ifdef USE_HOSTCC
  355. int fdtdec_get_int(const void *blob, int node, const char *prop_name,
  356. int default_val);
  357. /*
  358. * Count child nodes of one parent node.
  359. *
  360. * @param blob FDT blob
  361. * @param node parent node
  362. * Return: number of child node; 0 if there is not child node
  363. */
  364. int fdtdec_get_child_count(const void *blob, int node);
  365. #endif
  366. #ifdef CONFIG_FMAN_ENET
  367. int fdt_update_ethernet_dt(void *blob);
  368. #endif
  369. #ifdef CONFIG_FSL_MC_ENET
  370. void fdt_fixup_board_enet(void *blob);
  371. #endif
  372. #ifdef CONFIG_CMD_PSTORE
  373. void fdt_fixup_pstore(void *blob);
  374. #endif
  375. #endif /* ifndef __FDT_SUPPORT_H */