fdtdec.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663
  1. /*
  2. * Copyright (c) 2011 The Chromium OS Authors.
  3. * SPDX-License-Identifier: GPL-2.0+
  4. */
  5. #ifndef __fdtdec_h
  6. #define __fdtdec_h
  7. /*
  8. * This file contains convenience functions for decoding useful and
  9. * enlightening information from FDTs. It is intended to be used by device
  10. * drivers and board-specific code within U-Boot. It aims to reduce the
  11. * amount of FDT munging required within U-Boot itself, so that driver code
  12. * changes to support FDT are minimized.
  13. */
  14. #include <libfdt.h>
  15. /*
  16. * A typedef for a physical address. Note that fdt data is always big
  17. * endian even on a litle endian machine.
  18. */
  19. #ifdef CONFIG_PHYS_64BIT
  20. typedef u64 fdt_addr_t;
  21. typedef u64 fdt_size_t;
  22. #define FDT_ADDR_T_NONE (-1ULL)
  23. #define fdt_addr_to_cpu(reg) be64_to_cpu(reg)
  24. #define fdt_size_to_cpu(reg) be64_to_cpu(reg)
  25. #else
  26. typedef u32 fdt_addr_t;
  27. typedef u32 fdt_size_t;
  28. #define FDT_ADDR_T_NONE (-1U)
  29. #define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
  30. #define fdt_size_to_cpu(reg) be32_to_cpu(reg)
  31. #endif
  32. /* Information obtained about memory from the FDT */
  33. struct fdt_memory {
  34. fdt_addr_t start;
  35. fdt_addr_t end;
  36. };
  37. /*
  38. * Information about a resource. start is the first address of the resource
  39. * and end is the last address (inclusive). The length of the resource will
  40. * be equal to: end - start + 1.
  41. */
  42. struct fdt_resource {
  43. fdt_addr_t start;
  44. fdt_addr_t end;
  45. };
  46. /**
  47. * Compute the size of a resource.
  48. *
  49. * @param res the resource to operate on
  50. * @return the size of the resource
  51. */
  52. static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
  53. {
  54. return res->end - res->start + 1;
  55. }
  56. /**
  57. * Compat types that we know about and for which we might have drivers.
  58. * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
  59. * within drivers.
  60. */
  61. enum fdt_compat_id {
  62. COMPAT_UNKNOWN,
  63. COMPAT_NVIDIA_TEGRA20_USB, /* Tegra20 USB port */
  64. COMPAT_NVIDIA_TEGRA30_USB, /* Tegra30 USB port */
  65. COMPAT_NVIDIA_TEGRA114_USB, /* Tegra114 USB port */
  66. COMPAT_NVIDIA_TEGRA114_I2C, /* Tegra114 I2C w/single clock source */
  67. COMPAT_NVIDIA_TEGRA20_I2C, /* Tegra20 i2c */
  68. COMPAT_NVIDIA_TEGRA20_DVC, /* Tegra20 dvc (really just i2c) */
  69. COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
  70. COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
  71. COMPAT_NVIDIA_TEGRA20_KBC, /* Tegra20 Keyboard */
  72. COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
  73. COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */
  74. COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */
  75. COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
  76. COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
  77. COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
  78. COMPAT_NVIDIA_TEGRA20_SFLASH, /* Tegra 2 SPI flash controller */
  79. COMPAT_NVIDIA_TEGRA20_SLINK, /* Tegra 2 SPI SLINK controller */
  80. COMPAT_NVIDIA_TEGRA114_SPI, /* Tegra 114 SPI controller */
  81. COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
  82. COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
  83. COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
  84. COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
  85. COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
  86. COMPAT_SAMSUNG_EXYNOS_SPI, /* Exynos SPI */
  87. COMPAT_GOOGLE_CROS_EC, /* Google CROS_EC Protocol */
  88. COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */
  89. COMPAT_SAMSUNG_EXYNOS_EHCI, /* Exynos EHCI controller */
  90. COMPAT_SAMSUNG_EXYNOS5_XHCI, /* Exynos5 XHCI controller */
  91. COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
  92. COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
  93. COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
  94. COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */
  95. COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
  96. COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */
  97. COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
  98. COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
  99. COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */
  100. COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
  101. COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
  102. COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
  103. COMPAT_INFINEON_SLB9635_TPM, /* Infineon SLB9635 TPM */
  104. COMPAT_INFINEON_SLB9645_TPM, /* Infineon SLB9645 TPM */
  105. COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
  106. COMPAT_SANDBOX_HOST_EMULATION, /* Sandbox emulation of a function */
  107. COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */
  108. COMPAT_TI_TPS65090, /* Texas Instrument TPS65090 */
  109. COMPAT_NXP_PTN3460, /* NXP PTN3460 DP/LVDS bridge */
  110. COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
  111. COMPAT_PARADE_PS8625, /* Parade PS8622 EDP->LVDS bridge */
  112. COMPAT_COUNT,
  113. };
  114. /* GPIOs are numbered from 0 */
  115. enum {
  116. FDT_GPIO_NONE = -1U, /* an invalid GPIO used to end our list */
  117. FDT_GPIO_ACTIVE_LOW = 1 << 0, /* input is active low (else high) */
  118. };
  119. /* This is the state of a GPIO pin as defined by the fdt */
  120. struct fdt_gpio_state {
  121. const char *name; /* name of the fdt property defining this */
  122. uint gpio; /* GPIO number, or FDT_GPIO_NONE if none */
  123. u8 flags; /* FDT_GPIO_... flags */
  124. };
  125. /* This tells us whether a fdt_gpio_state record is valid or not */
  126. #define fdt_gpio_isvalid(x) ((x)->gpio != FDT_GPIO_NONE)
  127. /**
  128. * Read the GPIO taking into account the polarity of the pin.
  129. *
  130. * @param gpio pointer to the decoded gpio
  131. * @return value of the gpio if successful, < 0 if unsuccessful
  132. */
  133. int fdtdec_get_gpio(struct fdt_gpio_state *gpio);
  134. /**
  135. * Write the GPIO taking into account the polarity of the pin.
  136. *
  137. * @param gpio pointer to the decoded gpio
  138. * @return 0 if successful
  139. */
  140. int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val);
  141. /**
  142. * Find the next numbered alias for a peripheral. This is used to enumerate
  143. * all the peripherals of a certain type.
  144. *
  145. * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
  146. * this function will return a pointer to the node the alias points to, and
  147. * then update *upto to 1. Next time you call this function, the next node
  148. * will be returned.
  149. *
  150. * All nodes returned will match the compatible ID, as it is assumed that
  151. * all peripherals use the same driver.
  152. *
  153. * @param blob FDT blob to use
  154. * @param name Root name of alias to search for
  155. * @param id Compatible ID to look for
  156. * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
  157. */
  158. int fdtdec_next_alias(const void *blob, const char *name,
  159. enum fdt_compat_id id, int *upto);
  160. /**
  161. * Find the compatible ID for a given node.
  162. *
  163. * Generally each node has at least one compatible string attached to it.
  164. * This function looks through our list of known compatible strings and
  165. * returns the corresponding ID which matches the compatible string.
  166. *
  167. * @param blob FDT blob to use
  168. * @param node Node containing compatible string to find
  169. * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
  170. */
  171. enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
  172. /**
  173. * Find the next compatible node for a peripheral.
  174. *
  175. * Do the first call with node = 0. This function will return a pointer to
  176. * the next compatible node. Next time you call this function, pass the
  177. * value returned, and the next node will be provided.
  178. *
  179. * @param blob FDT blob to use
  180. * @param node Start node for search
  181. * @param id Compatible ID to look for (enum fdt_compat_id)
  182. * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
  183. */
  184. int fdtdec_next_compatible(const void *blob, int node,
  185. enum fdt_compat_id id);
  186. /**
  187. * Find the next compatible subnode for a peripheral.
  188. *
  189. * Do the first call with node set to the parent and depth = 0. This
  190. * function will return the offset of the next compatible node. Next time
  191. * you call this function, pass the node value returned last time, with
  192. * depth unchanged, and the next node will be provided.
  193. *
  194. * @param blob FDT blob to use
  195. * @param node Start node for search
  196. * @param id Compatible ID to look for (enum fdt_compat_id)
  197. * @param depthp Current depth (set to 0 before first call)
  198. * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
  199. */
  200. int fdtdec_next_compatible_subnode(const void *blob, int node,
  201. enum fdt_compat_id id, int *depthp);
  202. /**
  203. * Look up an address property in a node and return it as an address.
  204. * The property must hold either one address with no trailing data or
  205. * one address with a length. This is only tested on 32-bit machines.
  206. *
  207. * @param blob FDT blob
  208. * @param node node to examine
  209. * @param prop_name name of property to find
  210. * @return address, if found, or FDT_ADDR_T_NONE if not
  211. */
  212. fdt_addr_t fdtdec_get_addr(const void *blob, int node,
  213. const char *prop_name);
  214. /**
  215. * Look up an address property in a node and return it as an address.
  216. * The property must hold one address with a length. This is only tested
  217. * on 32-bit machines.
  218. *
  219. * @param blob FDT blob
  220. * @param node node to examine
  221. * @param prop_name name of property to find
  222. * @return address, if found, or FDT_ADDR_T_NONE if not
  223. */
  224. fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
  225. const char *prop_name, fdt_size_t *sizep);
  226. /**
  227. * Look up a 32-bit integer property in a node and return it. The property
  228. * must have at least 4 bytes of data. The value of the first cell is
  229. * returned.
  230. *
  231. * @param blob FDT blob
  232. * @param node node to examine
  233. * @param prop_name name of property to find
  234. * @param default_val default value to return if the property is not found
  235. * @return integer value, if found, or default_val if not
  236. */
  237. s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
  238. s32 default_val);
  239. /**
  240. * Look up a 64-bit integer property in a node and return it. The property
  241. * must have at least 8 bytes of data (2 cells). The first two cells are
  242. * concatenated to form a 8 bytes value, where the first cell is top half and
  243. * the second cell is bottom half.
  244. *
  245. * @param blob FDT blob
  246. * @param node node to examine
  247. * @param prop_name name of property to find
  248. * @param default_val default value to return if the property is not found
  249. * @return integer value, if found, or default_val if not
  250. */
  251. uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
  252. uint64_t default_val);
  253. /**
  254. * Checks whether a node is enabled.
  255. * This looks for a 'status' property. If this exists, then returns 1 if
  256. * the status is 'ok' and 0 otherwise. If there is no status property,
  257. * it returns 1 on the assumption that anything mentioned should be enabled
  258. * by default.
  259. *
  260. * @param blob FDT blob
  261. * @param node node to examine
  262. * @return integer value 0 (not enabled) or 1 (enabled)
  263. */
  264. int fdtdec_get_is_enabled(const void *blob, int node);
  265. /**
  266. * Make sure we have a valid fdt available to control U-Boot.
  267. *
  268. * If not, a message is printed to the console if the console is ready.
  269. *
  270. * @return 0 if all ok, -1 if not
  271. */
  272. int fdtdec_prepare_fdt(void);
  273. /**
  274. * Checks that we have a valid fdt available to control U-Boot.
  275. * However, if not then for the moment nothing is done, since this function
  276. * is called too early to panic().
  277. *
  278. * @returns 0
  279. */
  280. int fdtdec_check_fdt(void);
  281. /**
  282. * Find the nodes for a peripheral and return a list of them in the correct
  283. * order. This is used to enumerate all the peripherals of a certain type.
  284. *
  285. * To use this, optionally set up a /aliases node with alias properties for
  286. * a peripheral. For example, for usb you could have:
  287. *
  288. * aliases {
  289. * usb0 = "/ehci@c5008000";
  290. * usb1 = "/ehci@c5000000";
  291. * };
  292. *
  293. * Pass "usb" as the name to this function and will return a list of two
  294. * nodes offsets: /ehci@c5008000 and ehci@c5000000.
  295. *
  296. * All nodes returned will match the compatible ID, as it is assumed that
  297. * all peripherals use the same driver.
  298. *
  299. * If no alias node is found, then the node list will be returned in the
  300. * order found in the fdt. If the aliases mention a node which doesn't
  301. * exist, then this will be ignored. If nodes are found with no aliases,
  302. * they will be added in any order.
  303. *
  304. * If there is a gap in the aliases, then this function return a 0 node at
  305. * that position. The return value will also count these gaps.
  306. *
  307. * This function checks node properties and will not return nodes which are
  308. * marked disabled (status = "disabled").
  309. *
  310. * @param blob FDT blob to use
  311. * @param name Root name of alias to search for
  312. * @param id Compatible ID to look for
  313. * @param node_list Place to put list of found nodes
  314. * @param maxcount Maximum number of nodes to find
  315. * @return number of nodes found on success, FTD_ERR_... on error
  316. */
  317. int fdtdec_find_aliases_for_id(const void *blob, const char *name,
  318. enum fdt_compat_id id, int *node_list, int maxcount);
  319. /*
  320. * This function is similar to fdtdec_find_aliases_for_id() except that it
  321. * adds to the node_list that is passed in. Any 0 elements are considered
  322. * available for allocation - others are considered already used and are
  323. * skipped.
  324. *
  325. * You can use this by calling fdtdec_find_aliases_for_id() with an
  326. * uninitialised array, then setting the elements that are returned to -1,
  327. * say, then calling this function, perhaps with a different compat id.
  328. * Any elements you get back that are >0 are new nodes added by the call
  329. * to this function.
  330. *
  331. * Note that if you have some nodes with aliases and some without, you are
  332. * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
  333. * one compat_id may fill in positions for which you have aliases defined
  334. * for another compat_id. When you later call *this* function with the second
  335. * compat_id, the alias positions may already be used. A debug warning may
  336. * be generated in this case, but it is safest to define aliases for all
  337. * nodes when you care about the ordering.
  338. */
  339. int fdtdec_add_aliases_for_id(const void *blob, const char *name,
  340. enum fdt_compat_id id, int *node_list, int maxcount);
  341. /**
  342. * Get the alias sequence number of a node
  343. *
  344. * This works out whether a node is pointed to by an alias, and if so, the
  345. * sequence number of that alias. Aliases are of the form <base><num> where
  346. * <num> is the sequence number. For example spi2 would be sequence number
  347. * 2.
  348. *
  349. * @param blob Device tree blob (if NULL, then error is returned)
  350. * @param base Base name for alias (before the underscore)
  351. * @param node Node to look up
  352. * @param seqp This is set to the sequence number if one is found,
  353. * but otherwise the value is left alone
  354. * @return 0 if a sequence was found, -ve if not
  355. */
  356. int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
  357. int *seqp);
  358. /**
  359. * Get the offset of the given alias node
  360. *
  361. * This looks up an alias in /aliases then finds the offset of that node.
  362. *
  363. * @param blob Device tree blob (if NULL, then error is returned)
  364. * @param name Alias name, e.g. "console"
  365. * @return Node offset referred to by that alias, or -ve FDT_ERR_...
  366. */
  367. int fdtdec_get_alias_node(const void *blob, const char *name);
  368. /**
  369. * Get the offset of the given chosen node
  370. *
  371. * This looks up a property in /chosen containing the path to another node,
  372. * then finds the offset of that node.
  373. *
  374. * @param blob Device tree blob (if NULL, then error is returned)
  375. * @param name Property name, e.g. "stdout-path"
  376. * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
  377. */
  378. int fdtdec_get_chosen_node(const void *blob, const char *name);
  379. /*
  380. * Get the name for a compatible ID
  381. *
  382. * @param id Compatible ID to look for
  383. * @return compatible string for that id
  384. */
  385. const char *fdtdec_get_compatible(enum fdt_compat_id id);
  386. /* Look up a phandle and follow it to its node. Then return the offset
  387. * of that node.
  388. *
  389. * @param blob FDT blob
  390. * @param node node to examine
  391. * @param prop_name name of property to find
  392. * @return node offset if found, -ve error code on error
  393. */
  394. int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
  395. /**
  396. * Look up a property in a node and return its contents in an integer
  397. * array of given length. The property must have at least enough data for
  398. * the array (4*count bytes). It may have more, but this will be ignored.
  399. *
  400. * @param blob FDT blob
  401. * @param node node to examine
  402. * @param prop_name name of property to find
  403. * @param array array to fill with data
  404. * @param count number of array elements
  405. * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
  406. * or -FDT_ERR_BADLAYOUT if not enough data
  407. */
  408. int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
  409. u32 *array, int count);
  410. /**
  411. * Look up a property in a node and return a pointer to its contents as a
  412. * unsigned int array of given length. The property must have at least enough
  413. * data for the array ('count' cells). It may have more, but this will be
  414. * ignored. The data is not copied.
  415. *
  416. * Note that you must access elements of the array with fdt32_to_cpu(),
  417. * since the elements will be big endian even on a little endian machine.
  418. *
  419. * @param blob FDT blob
  420. * @param node node to examine
  421. * @param prop_name name of property to find
  422. * @param count number of array elements
  423. * @return pointer to array if found, or NULL if the property is not
  424. * found or there is not enough data
  425. */
  426. const u32 *fdtdec_locate_array(const void *blob, int node,
  427. const char *prop_name, int count);
  428. /**
  429. * Look up a boolean property in a node and return it.
  430. *
  431. * A boolean properly is true if present in the device tree and false if not
  432. * present, regardless of its value.
  433. *
  434. * @param blob FDT blob
  435. * @param node node to examine
  436. * @param prop_name name of property to find
  437. * @return 1 if the properly is present; 0 if it isn't present
  438. */
  439. int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
  440. /**
  441. * Decode a single GPIOs from an FDT.
  442. *
  443. * If the property is not found, then the GPIO structure will still be
  444. * initialised, with gpio set to FDT_GPIO_NONE. This makes it easy to
  445. * provide optional GPIOs.
  446. *
  447. * @param blob FDT blob to use
  448. * @param node Node to look at
  449. * @param prop_name Node property name
  450. * @param gpio gpio elements to fill from FDT
  451. * @return 0 if ok, -FDT_ERR_NOTFOUND if the property is missing.
  452. */
  453. int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
  454. struct fdt_gpio_state *gpio);
  455. /**
  456. * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
  457. * terminating item.
  458. *
  459. * @param blob FDT blob to use
  460. * @param node Node to look at
  461. * @param prop_name Node property name
  462. * @param gpio Array of gpio elements to fill from FDT. This will be
  463. * untouched if either 0 or an error is returned
  464. * @param max_count Maximum number of elements allowed
  465. * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
  466. * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
  467. */
  468. int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
  469. struct fdt_gpio_state *gpio, int max_count);
  470. /**
  471. * Set up a GPIO pin according to the provided gpio information. At present this
  472. * just requests the GPIO.
  473. *
  474. * If the gpio is FDT_GPIO_NONE, no action is taken. This makes it easy to
  475. * deal with optional GPIOs.
  476. *
  477. * @param gpio GPIO info to use for set up
  478. * @return 0 if all ok or gpio was FDT_GPIO_NONE; -1 on error
  479. */
  480. int fdtdec_setup_gpio(struct fdt_gpio_state *gpio);
  481. /**
  482. * Look in the FDT for a config item with the given name and return its value
  483. * as a 32-bit integer. The property must have at least 4 bytes of data. The
  484. * value of the first cell is returned.
  485. *
  486. * @param blob FDT blob to use
  487. * @param prop_name Node property name
  488. * @param default_val default value to return if the property is not found
  489. * @return integer value, if found, or default_val if not
  490. */
  491. int fdtdec_get_config_int(const void *blob, const char *prop_name,
  492. int default_val);
  493. /**
  494. * Look in the FDT for a config item with the given name
  495. * and return whether it exists.
  496. *
  497. * @param blob FDT blob
  498. * @param prop_name property name to look up
  499. * @return 1, if it exists, or 0 if not
  500. */
  501. int fdtdec_get_config_bool(const void *blob, const char *prop_name);
  502. /**
  503. * Look in the FDT for a config item with the given name and return its value
  504. * as a string.
  505. *
  506. * @param blob FDT blob
  507. * @param prop_name property name to look up
  508. * @returns property string, NULL on error.
  509. */
  510. char *fdtdec_get_config_string(const void *blob, const char *prop_name);
  511. /*
  512. * Look up a property in a node and return its contents in a byte
  513. * array of given length. The property must have at least enough data for
  514. * the array (count bytes). It may have more, but this will be ignored.
  515. *
  516. * @param blob FDT blob
  517. * @param node node to examine
  518. * @param prop_name name of property to find
  519. * @param array array to fill with data
  520. * @param count number of array elements
  521. * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
  522. * or -FDT_ERR_BADLAYOUT if not enough data
  523. */
  524. int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
  525. u8 *array, int count);
  526. /**
  527. * Look up a property in a node and return a pointer to its contents as a
  528. * byte array of given length. The property must have at least enough data
  529. * for the array (count bytes). It may have more, but this will be ignored.
  530. * The data is not copied.
  531. *
  532. * @param blob FDT blob
  533. * @param node node to examine
  534. * @param prop_name name of property to find
  535. * @param count number of array elements
  536. * @return pointer to byte array if found, or NULL if the property is not
  537. * found or there is not enough data
  538. */
  539. const u8 *fdtdec_locate_byte_array(const void *blob, int node,
  540. const char *prop_name, int count);
  541. /**
  542. * Look up a property in a node which contains a memory region address and
  543. * size. Then return a pointer to this address.
  544. *
  545. * The property must hold one address with a length. This is only tested on
  546. * 32-bit machines.
  547. *
  548. * @param blob FDT blob
  549. * @param node node to examine
  550. * @param prop_name name of property to find
  551. * @param ptrp returns pointer to region, or NULL if no address
  552. * @param size returns size of region
  553. * @return 0 if ok, -1 on error (propery not found)
  554. */
  555. int fdtdec_decode_region(const void *blob, int node,
  556. const char *prop_name, void **ptrp, size_t *size);
  557. /* A flash map entry, containing an offset and length */
  558. struct fmap_entry {
  559. uint32_t offset;
  560. uint32_t length;
  561. };
  562. /**
  563. * Read a flash entry from the fdt
  564. *
  565. * @param blob FDT blob
  566. * @param node Offset of node to read
  567. * @param name Name of node being read
  568. * @param entry Place to put offset and size of this node
  569. * @return 0 if ok, -ve on error
  570. */
  571. int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
  572. struct fmap_entry *entry);
  573. /**
  574. * Obtain an indexed resource from a device property.
  575. *
  576. * @param fdt FDT blob
  577. * @param node node to examine
  578. * @param property name of the property to parse
  579. * @param index index of the resource to retrieve
  580. * @param res returns the resource
  581. * @return 0 if ok, negative on error
  582. */
  583. int fdt_get_resource(const void *fdt, int node, const char *property,
  584. unsigned int index, struct fdt_resource *res);
  585. /**
  586. * Obtain a named resource from a device property.
  587. *
  588. * Look up the index of the name in a list of strings and return the resource
  589. * at that index.
  590. *
  591. * @param fdt FDT blob
  592. * @param node node to examine
  593. * @param property name of the property to parse
  594. * @param prop_names name of the property containing the list of names
  595. * @param name the name of the entry to look up
  596. * @param res returns the resource
  597. */
  598. int fdt_get_named_resource(const void *fdt, int node, const char *property,
  599. const char *prop_names, const char *name,
  600. struct fdt_resource *res);
  601. /**
  602. * Look at the reg property of a device node that represents a PCI device
  603. * and parse the bus, device and function number from it.
  604. *
  605. * @param fdt FDT blob
  606. * @param node node to examine
  607. * @param bdf returns bus, device, function triplet
  608. * @return 0 if ok, negative on error
  609. */
  610. int fdtdec_pci_get_bdf(const void *fdt, int node, int *bdf);
  611. #endif