fdtdec.h 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987
  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. #include <pci.h>
  16. /*
  17. * A typedef for a physical address. Note that fdt data is always big
  18. * endian even on a litle endian machine.
  19. */
  20. typedef phys_addr_t fdt_addr_t;
  21. typedef phys_size_t fdt_size_t;
  22. #ifdef CONFIG_PHYS_64BIT
  23. #define FDT_ADDR_T_NONE (-1ULL)
  24. #define fdt_addr_to_cpu(reg) be64_to_cpu(reg)
  25. #define fdt_size_to_cpu(reg) be64_to_cpu(reg)
  26. #else
  27. #define FDT_ADDR_T_NONE (-1U)
  28. #define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
  29. #define fdt_size_to_cpu(reg) be32_to_cpu(reg)
  30. #endif
  31. /* Information obtained about memory from the FDT */
  32. struct fdt_memory {
  33. fdt_addr_t start;
  34. fdt_addr_t end;
  35. };
  36. #ifdef CONFIG_SPL_BUILD
  37. #define SPL_BUILD 1
  38. #else
  39. #define SPL_BUILD 0
  40. #endif
  41. /*
  42. * Information about a resource. start is the first address of the resource
  43. * and end is the last address (inclusive). The length of the resource will
  44. * be equal to: end - start + 1.
  45. */
  46. struct fdt_resource {
  47. fdt_addr_t start;
  48. fdt_addr_t end;
  49. };
  50. enum fdt_pci_space {
  51. FDT_PCI_SPACE_CONFIG = 0,
  52. FDT_PCI_SPACE_IO = 0x01000000,
  53. FDT_PCI_SPACE_MEM32 = 0x02000000,
  54. FDT_PCI_SPACE_MEM64 = 0x03000000,
  55. FDT_PCI_SPACE_MEM32_PREF = 0x42000000,
  56. FDT_PCI_SPACE_MEM64_PREF = 0x43000000,
  57. };
  58. #define FDT_PCI_ADDR_CELLS 3
  59. #define FDT_PCI_SIZE_CELLS 2
  60. #define FDT_PCI_REG_SIZE \
  61. ((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32))
  62. /*
  63. * The Open Firmware spec defines PCI physical address as follows:
  64. *
  65. * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
  66. *
  67. * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr
  68. * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
  69. * phys.lo cell: llllllll llllllll llllllll llllllll
  70. *
  71. * where:
  72. *
  73. * n: is 0 if the address is relocatable, 1 otherwise
  74. * p: is 1 if addressable region is prefetchable, 0 otherwise
  75. * t: is 1 if the address is aliased (for non-relocatable I/O) below 1MB
  76. * (for Memory), or below 64KB (for relocatable I/O)
  77. * ss: is the space code, denoting the address space
  78. * bbbbbbbb: is the 8-bit Bus Number
  79. * ddddd: is the 5-bit Device Number
  80. * fff: is the 3-bit Function Number
  81. * rrrrrrrr: is the 8-bit Register Number
  82. * hhhhhhhh: is a 32-bit unsigned number
  83. * llllllll: is a 32-bit unsigned number
  84. */
  85. struct fdt_pci_addr {
  86. u32 phys_hi;
  87. u32 phys_mid;
  88. u32 phys_lo;
  89. };
  90. /**
  91. * Compute the size of a resource.
  92. *
  93. * @param res the resource to operate on
  94. * @return the size of the resource
  95. */
  96. static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
  97. {
  98. return res->end - res->start + 1;
  99. }
  100. /**
  101. * Compat types that we know about and for which we might have drivers.
  102. * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
  103. * within drivers.
  104. */
  105. enum fdt_compat_id {
  106. COMPAT_UNKNOWN,
  107. COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
  108. COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
  109. COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
  110. COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */
  111. COMPAT_NVIDIA_TEGRA124_SOR, /* Tegra 124 Serial Output Resource */
  112. COMPAT_NVIDIA_TEGRA124_PMC, /* Tegra 124 power mgmt controller */
  113. COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */
  114. COMPAT_NVIDIA_TEGRA210_SDMMC, /* Tegra210 SDMMC controller */
  115. COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
  116. COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
  117. COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
  118. COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
  119. /* Tegra124 XUSB pad controller */
  120. COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
  121. /* Tegra210 XUSB pad controller */
  122. COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
  123. COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
  124. COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
  125. COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
  126. COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
  127. COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */
  128. COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
  129. COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
  130. COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
  131. COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */
  132. COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
  133. COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */
  134. COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
  135. COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
  136. COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */
  137. COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
  138. COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
  139. COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
  140. COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
  141. COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
  142. COMPAT_INTEL_MICROCODE, /* Intel microcode update */
  143. COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */
  144. COMPAT_INTEL_MODEL_206AX, /* Intel Model 206AX CPU */
  145. COMPAT_INTEL_GMA, /* Intel Graphics Media Accelerator */
  146. COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */
  147. COMPAT_INTEL_ICH_SPI, /* Intel ICH7/9 SPI controller */
  148. COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
  149. COMPAT_SOCIONEXT_XHCI, /* Socionext UniPhier xHCI */
  150. COMPAT_INTEL_PCH, /* Intel PCH */
  151. COMPAT_ALTERA_SOCFPGA_DWMAC, /* SoCFPGA Ethernet controller */
  152. COMPAT_ALTERA_SOCFPGA_DWMMC, /* SoCFPGA DWMMC controller */
  153. COMPAT_ALTERA_SOCFPGA_DWC2USB, /* SoCFPGA DWC2 USB controller */
  154. COMPAT_INTEL_BAYTRAIL_FSP, /* Intel Bay Trail FSP */
  155. COMPAT_INTEL_BAYTRAIL_FSP_MDP, /* Intel FSP memory-down params */
  156. COMPAT_INTEL_IVYBRIDGE_FSP, /* Intel Ivy Bridge FSP */
  157. COMPAT_COUNT,
  158. };
  159. #define MAX_PHANDLE_ARGS 16
  160. struct fdtdec_phandle_args {
  161. int node;
  162. int args_count;
  163. uint32_t args[MAX_PHANDLE_ARGS];
  164. };
  165. /**
  166. * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
  167. *
  168. * This function is useful to parse lists of phandles and their arguments.
  169. *
  170. * Example:
  171. *
  172. * phandle1: node1 {
  173. * #list-cells = <2>;
  174. * }
  175. *
  176. * phandle2: node2 {
  177. * #list-cells = <1>;
  178. * }
  179. *
  180. * node3 {
  181. * list = <&phandle1 1 2 &phandle2 3>;
  182. * }
  183. *
  184. * To get a device_node of the `node2' node you may call this:
  185. * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
  186. * &args);
  187. *
  188. * (This function is a modified version of __of_parse_phandle_with_args() from
  189. * Linux 3.18)
  190. *
  191. * @blob: Pointer to device tree
  192. * @src_node: Offset of device tree node containing a list
  193. * @list_name: property name that contains a list
  194. * @cells_name: property name that specifies the phandles' arguments count,
  195. * or NULL to use @cells_count
  196. * @cells_count: Cell count to use if @cells_name is NULL
  197. * @index: index of a phandle to parse out
  198. * @out_args: optional pointer to output arguments structure (will be filled)
  199. * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
  200. * @list_name does not exist, a phandle was not found, @cells_name
  201. * could not be found, the arguments were truncated or there were too
  202. * many arguments.
  203. *
  204. */
  205. int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
  206. const char *list_name,
  207. const char *cells_name,
  208. int cell_count, int index,
  209. struct fdtdec_phandle_args *out_args);
  210. /**
  211. * Find the next numbered alias for a peripheral. This is used to enumerate
  212. * all the peripherals of a certain type.
  213. *
  214. * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
  215. * this function will return a pointer to the node the alias points to, and
  216. * then update *upto to 1. Next time you call this function, the next node
  217. * will be returned.
  218. *
  219. * All nodes returned will match the compatible ID, as it is assumed that
  220. * all peripherals use the same driver.
  221. *
  222. * @param blob FDT blob to use
  223. * @param name Root name of alias to search for
  224. * @param id Compatible ID to look for
  225. * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
  226. */
  227. int fdtdec_next_alias(const void *blob, const char *name,
  228. enum fdt_compat_id id, int *upto);
  229. /**
  230. * Find the compatible ID for a given node.
  231. *
  232. * Generally each node has at least one compatible string attached to it.
  233. * This function looks through our list of known compatible strings and
  234. * returns the corresponding ID which matches the compatible string.
  235. *
  236. * @param blob FDT blob to use
  237. * @param node Node containing compatible string to find
  238. * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
  239. */
  240. enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
  241. /**
  242. * Find the next compatible node for a peripheral.
  243. *
  244. * Do the first call with node = 0. This function will return a pointer to
  245. * the next compatible node. Next time you call this function, pass the
  246. * value returned, and the next node will be provided.
  247. *
  248. * @param blob FDT blob to use
  249. * @param node Start node for search
  250. * @param id Compatible ID to look for (enum fdt_compat_id)
  251. * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
  252. */
  253. int fdtdec_next_compatible(const void *blob, int node,
  254. enum fdt_compat_id id);
  255. /**
  256. * Find the next compatible subnode for a peripheral.
  257. *
  258. * Do the first call with node set to the parent and depth = 0. This
  259. * function will return the offset of the next compatible node. Next time
  260. * you call this function, pass the node value returned last time, with
  261. * depth unchanged, and the next node will be provided.
  262. *
  263. * @param blob FDT blob to use
  264. * @param node Start node for search
  265. * @param id Compatible ID to look for (enum fdt_compat_id)
  266. * @param depthp Current depth (set to 0 before first call)
  267. * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
  268. */
  269. int fdtdec_next_compatible_subnode(const void *blob, int node,
  270. enum fdt_compat_id id, int *depthp);
  271. /*
  272. * Look up an address property in a node and return the parsed address, and
  273. * optionally the parsed size.
  274. *
  275. * This variant assumes a known and fixed number of cells are used to
  276. * represent the address and size.
  277. *
  278. * You probably don't want to use this function directly except to parse
  279. * non-standard properties, and never to parse the "reg" property. Instead,
  280. * use one of the "auto" variants below, which automatically honor the
  281. * #address-cells and #size-cells properties in the parent node.
  282. *
  283. * @param blob FDT blob
  284. * @param node node to examine
  285. * @param prop_name name of property to find
  286. * @param index which address to retrieve from a list of addresses. Often 0.
  287. * @param na the number of cells used to represent an address
  288. * @param ns the number of cells used to represent a size
  289. * @param sizep a pointer to store the size into. Use NULL if not required
  290. * @return address, if found, or FDT_ADDR_T_NONE if not
  291. */
  292. fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
  293. const char *prop_name, int index, int na, int ns,
  294. fdt_size_t *sizep);
  295. /*
  296. * Look up an address property in a node and return the parsed address, and
  297. * optionally the parsed size.
  298. *
  299. * This variant automatically determines the number of cells used to represent
  300. * the address and size by parsing the provided parent node's #address-cells
  301. * and #size-cells properties.
  302. *
  303. * @param blob FDT blob
  304. * @param parent parent node of @node
  305. * @param node node to examine
  306. * @param prop_name name of property to find
  307. * @param index which address to retrieve from a list of addresses. Often 0.
  308. * @param sizep a pointer to store the size into. Use NULL if not required
  309. * @return address, if found, or FDT_ADDR_T_NONE if not
  310. */
  311. fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
  312. int node, const char *prop_name, int index, fdt_size_t *sizep);
  313. /*
  314. * Look up an address property in a node and return the parsed address, and
  315. * optionally the parsed size.
  316. *
  317. * This variant automatically determines the number of cells used to represent
  318. * the address and size by parsing the parent node's #address-cells
  319. * and #size-cells properties. The parent node is automatically found.
  320. *
  321. * The automatic parent lookup implemented by this function is slow.
  322. * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
  323. * possible.
  324. *
  325. * @param blob FDT blob
  326. * @param parent parent node of @node
  327. * @param node node to examine
  328. * @param prop_name name of property to find
  329. * @param index which address to retrieve from a list of addresses. Often 0.
  330. * @param sizep a pointer to store the size into. Use NULL if not required
  331. * @return address, if found, or FDT_ADDR_T_NONE if not
  332. */
  333. fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
  334. const char *prop_name, int index, fdt_size_t *sizep);
  335. /*
  336. * Look up an address property in a node and return the parsed address.
  337. *
  338. * This variant hard-codes the number of cells used to represent the address
  339. * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
  340. * always returns the first address value in the property (index 0).
  341. *
  342. * Use of this function is not recommended due to the hard-coding of cell
  343. * counts. There is no programmatic validation that these hard-coded values
  344. * actually match the device tree content in any way at all. This assumption
  345. * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
  346. * set in the U-Boot build and exercising strict control over DT content to
  347. * ensure use of matching #address-cells/#size-cells properties. However, this
  348. * approach is error-prone; those familiar with DT will not expect the
  349. * assumption to exist, and could easily invalidate it. If the assumption is
  350. * invalidated, this function will not report the issue, and debugging will
  351. * be required. Instead, use fdtdec_get_addr_size_auto_parent().
  352. *
  353. * @param blob FDT blob
  354. * @param node node to examine
  355. * @param prop_name name of property to find
  356. * @return address, if found, or FDT_ADDR_T_NONE if not
  357. */
  358. fdt_addr_t fdtdec_get_addr(const void *blob, int node,
  359. const char *prop_name);
  360. /*
  361. * Look up an address property in a node and return the parsed address, and
  362. * optionally the parsed size.
  363. *
  364. * This variant hard-codes the number of cells used to represent the address
  365. * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
  366. * always returns the first address value in the property (index 0).
  367. *
  368. * Use of this function is not recommended due to the hard-coding of cell
  369. * counts. There is no programmatic validation that these hard-coded values
  370. * actually match the device tree content in any way at all. This assumption
  371. * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
  372. * set in the U-Boot build and exercising strict control over DT content to
  373. * ensure use of matching #address-cells/#size-cells properties. However, this
  374. * approach is error-prone; those familiar with DT will not expect the
  375. * assumption to exist, and could easily invalidate it. If the assumption is
  376. * invalidated, this function will not report the issue, and debugging will
  377. * be required. Instead, use fdtdec_get_addr_size_auto_parent().
  378. *
  379. * @param blob FDT blob
  380. * @param node node to examine
  381. * @param prop_name name of property to find
  382. * @param sizep a pointer to store the size into. Use NULL if not required
  383. * @return address, if found, or FDT_ADDR_T_NONE if not
  384. */
  385. fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
  386. const char *prop_name, fdt_size_t *sizep);
  387. /**
  388. * Look at an address property in a node and return the pci address which
  389. * corresponds to the given type in the form of fdt_pci_addr.
  390. * The property must hold one fdt_pci_addr with a lengh.
  391. *
  392. * @param blob FDT blob
  393. * @param node node to examine
  394. * @param type pci address type (FDT_PCI_SPACE_xxx)
  395. * @param prop_name name of property to find
  396. * @param addr returns pci address in the form of fdt_pci_addr
  397. * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
  398. * format of the property was invalid, -ENXIO if the requested
  399. * address type was not found
  400. */
  401. int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
  402. const char *prop_name, struct fdt_pci_addr *addr);
  403. /**
  404. * Look at the compatible property of a device node that represents a PCI
  405. * device and extract pci vendor id and device id from it.
  406. *
  407. * @param blob FDT blob
  408. * @param node node to examine
  409. * @param vendor vendor id of the pci device
  410. * @param device device id of the pci device
  411. * @return 0 if ok, negative on error
  412. */
  413. int fdtdec_get_pci_vendev(const void *blob, int node,
  414. u16 *vendor, u16 *device);
  415. /**
  416. * Look at the pci address of a device node that represents a PCI device
  417. * and return base address of the pci device's registers.
  418. *
  419. * @param dev device to examine
  420. * @param addr pci address in the form of fdt_pci_addr
  421. * @param bar returns base address of the pci device's registers
  422. * @return 0 if ok, negative on error
  423. */
  424. int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
  425. u32 *bar);
  426. /**
  427. * Look up a 32-bit integer property in a node and return it. The property
  428. * must have at least 4 bytes of data. The value of the first cell is
  429. * returned.
  430. *
  431. * @param blob FDT blob
  432. * @param node node to examine
  433. * @param prop_name name of property to find
  434. * @param default_val default value to return if the property is not found
  435. * @return integer value, if found, or default_val if not
  436. */
  437. s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
  438. s32 default_val);
  439. /**
  440. * Unsigned version of fdtdec_get_int. The property must have at least
  441. * 4 bytes of data. The value of the first cell is returned.
  442. *
  443. * @param blob FDT blob
  444. * @param node node to examine
  445. * @param prop_name name of property to find
  446. * @param default_val default value to return if the property is not found
  447. * @return unsigned integer value, if found, or default_val if not
  448. */
  449. unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
  450. unsigned int default_val);
  451. /**
  452. * Get a variable-sized number from a property
  453. *
  454. * This reads a number from one or more cells.
  455. *
  456. * @param ptr Pointer to property
  457. * @param cells Number of cells containing the number
  458. * @return the value in the cells
  459. */
  460. u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
  461. /**
  462. * Look up a 64-bit integer property in a node and return it. The property
  463. * must have at least 8 bytes of data (2 cells). The first two cells are
  464. * concatenated to form a 8 bytes value, where the first cell is top half and
  465. * the second cell is bottom half.
  466. *
  467. * @param blob FDT blob
  468. * @param node node to examine
  469. * @param prop_name name of property to find
  470. * @param default_val default value to return if the property is not found
  471. * @return integer value, if found, or default_val if not
  472. */
  473. uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
  474. uint64_t default_val);
  475. /**
  476. * Checks whether a node is enabled.
  477. * This looks for a 'status' property. If this exists, then returns 1 if
  478. * the status is 'ok' and 0 otherwise. If there is no status property,
  479. * it returns 1 on the assumption that anything mentioned should be enabled
  480. * by default.
  481. *
  482. * @param blob FDT blob
  483. * @param node node to examine
  484. * @return integer value 0 (not enabled) or 1 (enabled)
  485. */
  486. int fdtdec_get_is_enabled(const void *blob, int node);
  487. /**
  488. * Make sure we have a valid fdt available to control U-Boot.
  489. *
  490. * If not, a message is printed to the console if the console is ready.
  491. *
  492. * @return 0 if all ok, -1 if not
  493. */
  494. int fdtdec_prepare_fdt(void);
  495. /**
  496. * Checks that we have a valid fdt available to control U-Boot.
  497. * However, if not then for the moment nothing is done, since this function
  498. * is called too early to panic().
  499. *
  500. * @returns 0
  501. */
  502. int fdtdec_check_fdt(void);
  503. /**
  504. * Find the nodes for a peripheral and return a list of them in the correct
  505. * order. This is used to enumerate all the peripherals of a certain type.
  506. *
  507. * To use this, optionally set up a /aliases node with alias properties for
  508. * a peripheral. For example, for usb you could have:
  509. *
  510. * aliases {
  511. * usb0 = "/ehci@c5008000";
  512. * usb1 = "/ehci@c5000000";
  513. * };
  514. *
  515. * Pass "usb" as the name to this function and will return a list of two
  516. * nodes offsets: /ehci@c5008000 and ehci@c5000000.
  517. *
  518. * All nodes returned will match the compatible ID, as it is assumed that
  519. * all peripherals use the same driver.
  520. *
  521. * If no alias node is found, then the node list will be returned in the
  522. * order found in the fdt. If the aliases mention a node which doesn't
  523. * exist, then this will be ignored. If nodes are found with no aliases,
  524. * they will be added in any order.
  525. *
  526. * If there is a gap in the aliases, then this function return a 0 node at
  527. * that position. The return value will also count these gaps.
  528. *
  529. * This function checks node properties and will not return nodes which are
  530. * marked disabled (status = "disabled").
  531. *
  532. * @param blob FDT blob to use
  533. * @param name Root name of alias to search for
  534. * @param id Compatible ID to look for
  535. * @param node_list Place to put list of found nodes
  536. * @param maxcount Maximum number of nodes to find
  537. * @return number of nodes found on success, FDT_ERR_... on error
  538. */
  539. int fdtdec_find_aliases_for_id(const void *blob, const char *name,
  540. enum fdt_compat_id id, int *node_list, int maxcount);
  541. /*
  542. * This function is similar to fdtdec_find_aliases_for_id() except that it
  543. * adds to the node_list that is passed in. Any 0 elements are considered
  544. * available for allocation - others are considered already used and are
  545. * skipped.
  546. *
  547. * You can use this by calling fdtdec_find_aliases_for_id() with an
  548. * uninitialised array, then setting the elements that are returned to -1,
  549. * say, then calling this function, perhaps with a different compat id.
  550. * Any elements you get back that are >0 are new nodes added by the call
  551. * to this function.
  552. *
  553. * Note that if you have some nodes with aliases and some without, you are
  554. * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
  555. * one compat_id may fill in positions for which you have aliases defined
  556. * for another compat_id. When you later call *this* function with the second
  557. * compat_id, the alias positions may already be used. A debug warning may
  558. * be generated in this case, but it is safest to define aliases for all
  559. * nodes when you care about the ordering.
  560. */
  561. int fdtdec_add_aliases_for_id(const void *blob, const char *name,
  562. enum fdt_compat_id id, int *node_list, int maxcount);
  563. /**
  564. * Get the alias sequence number of a node
  565. *
  566. * This works out whether a node is pointed to by an alias, and if so, the
  567. * sequence number of that alias. Aliases are of the form <base><num> where
  568. * <num> is the sequence number. For example spi2 would be sequence number
  569. * 2.
  570. *
  571. * @param blob Device tree blob (if NULL, then error is returned)
  572. * @param base Base name for alias (before the underscore)
  573. * @param node Node to look up
  574. * @param seqp This is set to the sequence number if one is found,
  575. * but otherwise the value is left alone
  576. * @return 0 if a sequence was found, -ve if not
  577. */
  578. int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
  579. int *seqp);
  580. /**
  581. * Get a property from the /chosen node
  582. *
  583. * @param blob Device tree blob (if NULL, then NULL is returned)
  584. * @param name Property name to look up
  585. * @return Value of property, or NULL if it does not exist
  586. */
  587. const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
  588. /**
  589. * Get the offset of the given /chosen node
  590. *
  591. * This looks up a property in /chosen containing the path to another node,
  592. * then finds the offset of that node.
  593. *
  594. * @param blob Device tree blob (if NULL, then error is returned)
  595. * @param name Property name, e.g. "stdout-path"
  596. * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
  597. */
  598. int fdtdec_get_chosen_node(const void *blob, const char *name);
  599. /*
  600. * Get the name for a compatible ID
  601. *
  602. * @param id Compatible ID to look for
  603. * @return compatible string for that id
  604. */
  605. const char *fdtdec_get_compatible(enum fdt_compat_id id);
  606. /* Look up a phandle and follow it to its node. Then return the offset
  607. * of that node.
  608. *
  609. * @param blob FDT blob
  610. * @param node node to examine
  611. * @param prop_name name of property to find
  612. * @return node offset if found, -ve error code on error
  613. */
  614. int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
  615. /**
  616. * Look up a property in a node and return its contents in an integer
  617. * array of given length. The property must have at least enough data for
  618. * the array (4*count bytes). It may have more, but this will be ignored.
  619. *
  620. * @param blob FDT blob
  621. * @param node node to examine
  622. * @param prop_name name of property to find
  623. * @param array array to fill with data
  624. * @param count number of array elements
  625. * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
  626. * or -FDT_ERR_BADLAYOUT if not enough data
  627. */
  628. int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
  629. u32 *array, int count);
  630. /**
  631. * Look up a property in a node and return its contents in an integer
  632. * array of given length. The property must exist but may have less data that
  633. * expected (4*count bytes). It may have more, but this will be ignored.
  634. *
  635. * @param blob FDT blob
  636. * @param node node to examine
  637. * @param prop_name name of property to find
  638. * @param array array to fill with data
  639. * @param count number of array elements
  640. * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
  641. * property is not found
  642. */
  643. int fdtdec_get_int_array_count(const void *blob, int node,
  644. const char *prop_name, u32 *array, int count);
  645. /**
  646. * Look up a property in a node and return a pointer to its contents as a
  647. * unsigned int array of given length. The property must have at least enough
  648. * data for the array ('count' cells). It may have more, but this will be
  649. * ignored. The data is not copied.
  650. *
  651. * Note that you must access elements of the array with fdt32_to_cpu(),
  652. * since the elements will be big endian even on a little endian machine.
  653. *
  654. * @param blob FDT blob
  655. * @param node node to examine
  656. * @param prop_name name of property to find
  657. * @param count number of array elements
  658. * @return pointer to array if found, or NULL if the property is not
  659. * found or there is not enough data
  660. */
  661. const u32 *fdtdec_locate_array(const void *blob, int node,
  662. const char *prop_name, int count);
  663. /**
  664. * Look up a boolean property in a node and return it.
  665. *
  666. * A boolean properly is true if present in the device tree and false if not
  667. * present, regardless of its value.
  668. *
  669. * @param blob FDT blob
  670. * @param node node to examine
  671. * @param prop_name name of property to find
  672. * @return 1 if the properly is present; 0 if it isn't present
  673. */
  674. int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
  675. /*
  676. * Count child nodes of one parent node.
  677. *
  678. * @param blob FDT blob
  679. * @param node parent node
  680. * @return number of child node; 0 if there is not child node
  681. */
  682. int fdtdec_get_child_count(const void *blob, int node);
  683. /**
  684. * Look in the FDT for a config item with the given name and return its value
  685. * as a 32-bit integer. The property must have at least 4 bytes of data. The
  686. * value of the first cell is returned.
  687. *
  688. * @param blob FDT blob to use
  689. * @param prop_name Node property name
  690. * @param default_val default value to return if the property is not found
  691. * @return integer value, if found, or default_val if not
  692. */
  693. int fdtdec_get_config_int(const void *blob, const char *prop_name,
  694. int default_val);
  695. /**
  696. * Look in the FDT for a config item with the given name
  697. * and return whether it exists.
  698. *
  699. * @param blob FDT blob
  700. * @param prop_name property name to look up
  701. * @return 1, if it exists, or 0 if not
  702. */
  703. int fdtdec_get_config_bool(const void *blob, const char *prop_name);
  704. /**
  705. * Look in the FDT for a config item with the given name and return its value
  706. * as a string.
  707. *
  708. * @param blob FDT blob
  709. * @param prop_name property name to look up
  710. * @returns property string, NULL on error.
  711. */
  712. char *fdtdec_get_config_string(const void *blob, const char *prop_name);
  713. /*
  714. * Look up a property in a node and return its contents in a byte
  715. * array of given length. The property must have at least enough data for
  716. * the array (count bytes). It may have more, but this will be ignored.
  717. *
  718. * @param blob FDT blob
  719. * @param node node to examine
  720. * @param prop_name name of property to find
  721. * @param array array to fill with data
  722. * @param count number of array elements
  723. * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
  724. * or -FDT_ERR_BADLAYOUT if not enough data
  725. */
  726. int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
  727. u8 *array, int count);
  728. /**
  729. * Look up a property in a node and return a pointer to its contents as a
  730. * byte array of given length. The property must have at least enough data
  731. * for the array (count bytes). It may have more, but this will be ignored.
  732. * The data is not copied.
  733. *
  734. * @param blob FDT blob
  735. * @param node node to examine
  736. * @param prop_name name of property to find
  737. * @param count number of array elements
  738. * @return pointer to byte array if found, or NULL if the property is not
  739. * found or there is not enough data
  740. */
  741. const u8 *fdtdec_locate_byte_array(const void *blob, int node,
  742. const char *prop_name, int count);
  743. /**
  744. * Look up a property in a node which contains a memory region address and
  745. * size. Then return a pointer to this address.
  746. *
  747. * The property must hold one address with a length. This is only tested on
  748. * 32-bit machines.
  749. *
  750. * @param blob FDT blob
  751. * @param node node to examine
  752. * @param prop_name name of property to find
  753. * @param basep Returns base address of region
  754. * @param size Returns size of region
  755. * @return 0 if ok, -1 on error (property not found)
  756. */
  757. int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
  758. fdt_addr_t *basep, fdt_size_t *sizep);
  759. enum fmap_compress_t {
  760. FMAP_COMPRESS_NONE,
  761. FMAP_COMPRESS_LZO,
  762. };
  763. enum fmap_hash_t {
  764. FMAP_HASH_NONE,
  765. FMAP_HASH_SHA1,
  766. FMAP_HASH_SHA256,
  767. };
  768. /* A flash map entry, containing an offset and length */
  769. struct fmap_entry {
  770. uint32_t offset;
  771. uint32_t length;
  772. uint32_t used; /* Number of bytes used in region */
  773. enum fmap_compress_t compress_algo; /* Compression type */
  774. enum fmap_hash_t hash_algo; /* Hash algorithm */
  775. const uint8_t *hash; /* Hash value */
  776. int hash_size; /* Hash size */
  777. };
  778. /**
  779. * Read a flash entry from the fdt
  780. *
  781. * @param blob FDT blob
  782. * @param node Offset of node to read
  783. * @param name Name of node being read
  784. * @param entry Place to put offset and size of this node
  785. * @return 0 if ok, -ve on error
  786. */
  787. int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
  788. struct fmap_entry *entry);
  789. /**
  790. * Obtain an indexed resource from a device property.
  791. *
  792. * @param fdt FDT blob
  793. * @param node node to examine
  794. * @param property name of the property to parse
  795. * @param index index of the resource to retrieve
  796. * @param res returns the resource
  797. * @return 0 if ok, negative on error
  798. */
  799. int fdt_get_resource(const void *fdt, int node, const char *property,
  800. unsigned int index, struct fdt_resource *res);
  801. /**
  802. * Obtain a named resource from a device property.
  803. *
  804. * Look up the index of the name in a list of strings and return the resource
  805. * at that index.
  806. *
  807. * @param fdt FDT blob
  808. * @param node node to examine
  809. * @param property name of the property to parse
  810. * @param prop_names name of the property containing the list of names
  811. * @param name the name of the entry to look up
  812. * @param res returns the resource
  813. */
  814. int fdt_get_named_resource(const void *fdt, int node, const char *property,
  815. const char *prop_names, const char *name,
  816. struct fdt_resource *res);
  817. /**
  818. * Decode a named region within a memory bank of a given type.
  819. *
  820. * This function handles selection of a memory region. The region is
  821. * specified as an offset/size within a particular type of memory.
  822. *
  823. * The properties used are:
  824. *
  825. * <mem_type>-memory<suffix> for the name of the memory bank
  826. * <mem_type>-offset<suffix> for the offset in that bank
  827. *
  828. * The property value must have an offset and a size. The function checks
  829. * that the region is entirely within the memory bank.5
  830. *
  831. * @param blob FDT blob
  832. * @param node Node containing the properties (-1 for /config)
  833. * @param mem_type Type of memory to use, which is a name, such as
  834. * "u-boot" or "kernel".
  835. * @param suffix String to append to the memory/offset
  836. * property names
  837. * @param basep Returns base of region
  838. * @param sizep Returns size of region
  839. * @return 0 if OK, -ive on error
  840. */
  841. int fdtdec_decode_memory_region(const void *blob, int node,
  842. const char *mem_type, const char *suffix,
  843. fdt_addr_t *basep, fdt_size_t *sizep);
  844. /* Display timings from linux include/video/display_timing.h */
  845. enum display_flags {
  846. DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
  847. DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
  848. DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
  849. DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
  850. /* data enable flag */
  851. DISPLAY_FLAGS_DE_LOW = 1 << 4,
  852. DISPLAY_FLAGS_DE_HIGH = 1 << 5,
  853. /* drive data on pos. edge */
  854. DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
  855. /* drive data on neg. edge */
  856. DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
  857. DISPLAY_FLAGS_INTERLACED = 1 << 8,
  858. DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
  859. DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
  860. };
  861. /*
  862. * A single signal can be specified via a range of minimal and maximal values
  863. * with a typical value, that lies somewhere inbetween.
  864. */
  865. struct timing_entry {
  866. u32 min;
  867. u32 typ;
  868. u32 max;
  869. };
  870. /*
  871. * Single "mode" entry. This describes one set of signal timings a display can
  872. * have in one setting. This struct can later be converted to struct videomode
  873. * (see include/video/videomode.h). As each timing_entry can be defined as a
  874. * range, one struct display_timing may become multiple struct videomodes.
  875. *
  876. * Example: hsync active high, vsync active low
  877. *
  878. * Active Video
  879. * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
  880. * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
  881. * | | porch | | porch |
  882. *
  883. * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
  884. *
  885. * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
  886. */
  887. struct display_timing {
  888. struct timing_entry pixelclock;
  889. struct timing_entry hactive; /* hor. active video */
  890. struct timing_entry hfront_porch; /* hor. front porch */
  891. struct timing_entry hback_porch; /* hor. back porch */
  892. struct timing_entry hsync_len; /* hor. sync len */
  893. struct timing_entry vactive; /* ver. active video */
  894. struct timing_entry vfront_porch; /* ver. front porch */
  895. struct timing_entry vback_porch; /* ver. back porch */
  896. struct timing_entry vsync_len; /* ver. sync len */
  897. enum display_flags flags; /* display flags */
  898. };
  899. /**
  900. * fdtdec_decode_display_timing() - decode display timings
  901. *
  902. * Decode display timings from the supplied 'display-timings' node.
  903. * See doc/device-tree-bindings/video/display-timing.txt for binding
  904. * information.
  905. *
  906. * @param blob FDT blob
  907. * @param node 'display-timing' node containing the timing subnodes
  908. * @param index Index number to read (0=first timing subnode)
  909. * @param config Place to put timings
  910. * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
  911. */
  912. int fdtdec_decode_display_timing(const void *blob, int node, int index,
  913. struct display_timing *config);
  914. /**
  915. * Set up the device tree ready for use
  916. */
  917. int fdtdec_setup(void);
  918. #endif