fdt_support.h 15 KB

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