xref: /rk3399_rockchip-uboot/include/fdtdec.h (revision 9f85eee72a2a3918b2d5cd7b1bf88da69232dede)
1b5220bc6SSimon Glass /*
2b5220bc6SSimon Glass  * Copyright (c) 2011 The Chromium OS Authors.
31a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
4b5220bc6SSimon Glass  */
5b5220bc6SSimon Glass 
65bfa78dbSSimon Glass #ifndef __fdtdec_h
75bfa78dbSSimon Glass #define __fdtdec_h
8b5220bc6SSimon Glass 
9b5220bc6SSimon Glass /*
10b5220bc6SSimon Glass  * This file contains convenience functions for decoding useful and
11b5220bc6SSimon Glass  * enlightening information from FDTs. It is intended to be used by device
12b5220bc6SSimon Glass  * drivers and board-specific code within U-Boot. It aims to reduce the
13b5220bc6SSimon Glass  * amount of FDT munging required within U-Boot itself, so that driver code
14b5220bc6SSimon Glass  * changes to support FDT are minimized.
15b5220bc6SSimon Glass  */
16b5220bc6SSimon Glass 
17b5220bc6SSimon Glass #include <libfdt.h>
18b5220bc6SSimon Glass 
19b5220bc6SSimon Glass /*
20b5220bc6SSimon Glass  * A typedef for a physical address. Note that fdt data is always big
21b5220bc6SSimon Glass  * endian even on a litle endian machine.
22b5220bc6SSimon Glass  */
23b5220bc6SSimon Glass #ifdef CONFIG_PHYS_64BIT
24b5220bc6SSimon Glass typedef u64 fdt_addr_t;
254397a2a8SSimon Glass typedef u64 fdt_size_t;
26b5220bc6SSimon Glass #define FDT_ADDR_T_NONE (-1ULL)
27b5220bc6SSimon Glass #define fdt_addr_to_cpu(reg) be64_to_cpu(reg)
28f20c4619SSimon Glass #define fdt_size_to_cpu(reg) be64_to_cpu(reg)
29b5220bc6SSimon Glass #else
30b5220bc6SSimon Glass typedef u32 fdt_addr_t;
314397a2a8SSimon Glass typedef u32 fdt_size_t;
32b5220bc6SSimon Glass #define FDT_ADDR_T_NONE (-1U)
33b5220bc6SSimon Glass #define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
34f20c4619SSimon Glass #define fdt_size_to_cpu(reg) be32_to_cpu(reg)
35b5220bc6SSimon Glass #endif
36b5220bc6SSimon Glass 
37b5220bc6SSimon Glass /* Information obtained about memory from the FDT */
38b5220bc6SSimon Glass struct fdt_memory {
39b5220bc6SSimon Glass 	fdt_addr_t start;
40b5220bc6SSimon Glass 	fdt_addr_t end;
41b5220bc6SSimon Glass };
42b5220bc6SSimon Glass 
4356f42242SThierry Reding /*
4456f42242SThierry Reding  * Information about a resource. start is the first address of the resource
4556f42242SThierry Reding  * and end is the last address (inclusive). The length of the resource will
4656f42242SThierry Reding  * be equal to: end - start + 1.
4756f42242SThierry Reding  */
4856f42242SThierry Reding struct fdt_resource {
4956f42242SThierry Reding 	fdt_addr_t start;
5056f42242SThierry Reding 	fdt_addr_t end;
5156f42242SThierry Reding };
5256f42242SThierry Reding 
5356f42242SThierry Reding /**
5456f42242SThierry Reding  * Compute the size of a resource.
5556f42242SThierry Reding  *
5656f42242SThierry Reding  * @param res	the resource to operate on
5756f42242SThierry Reding  * @return the size of the resource
5856f42242SThierry Reding  */
5956f42242SThierry Reding static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
6056f42242SThierry Reding {
6156f42242SThierry Reding 	return res->end - res->start + 1;
6256f42242SThierry Reding }
6356f42242SThierry Reding 
64b5220bc6SSimon Glass /**
65b5220bc6SSimon Glass  * Compat types that we know about and for which we might have drivers.
66b5220bc6SSimon Glass  * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
67b5220bc6SSimon Glass  * within drivers.
68b5220bc6SSimon Glass  */
69b5220bc6SSimon Glass enum fdt_compat_id {
70b5220bc6SSimon Glass 	COMPAT_UNKNOWN,
7100a2749dSAllen Martin 	COMPAT_NVIDIA_TEGRA20_USB,	/* Tegra20 USB port */
727e44d932SJim Lin 	COMPAT_NVIDIA_TEGRA30_USB,	/* Tegra30 USB port */
737e44d932SJim Lin 	COMPAT_NVIDIA_TEGRA114_USB,	/* Tegra114 USB port */
74e32624efSTom Warren 	COMPAT_NVIDIA_TEGRA114_I2C,	/* Tegra114 I2C w/single clock source */
7500a2749dSAllen Martin 	COMPAT_NVIDIA_TEGRA20_I2C,	/* Tegra20 i2c */
7600a2749dSAllen Martin 	COMPAT_NVIDIA_TEGRA20_DVC,	/* Tegra20 dvc (really just i2c) */
7700a2749dSAllen Martin 	COMPAT_NVIDIA_TEGRA20_EMC,	/* Tegra20 memory controller */
7800a2749dSAllen Martin 	COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
7900a2749dSAllen Martin 	COMPAT_NVIDIA_TEGRA20_KBC,	/* Tegra20 Keyboard */
80312693c3SJim Lin 	COMPAT_NVIDIA_TEGRA20_NAND,	/* Tegra2 NAND controller */
81e1ae0d1fSSimon Glass 	COMPAT_NVIDIA_TEGRA20_PWM,	/* Tegra 2 PWM controller */
8287540de3SWei Ni 	COMPAT_NVIDIA_TEGRA20_DC,	/* Tegra 2 Display controller */
83a73ca478SStephen Warren 	COMPAT_NVIDIA_TEGRA124_SDMMC,	/* Tegra124 SDMMC controller */
84f4e4e0b0STom Warren 	COMPAT_NVIDIA_TEGRA30_SDMMC,	/* Tegra30 SDMMC controller */
85f4e4e0b0STom Warren 	COMPAT_NVIDIA_TEGRA20_SDMMC,	/* Tegra20 SDMMC controller */
868f1b46b1SAllen Martin 	COMPAT_NVIDIA_TEGRA20_SFLASH,	/* Tegra 2 SPI flash controller */
87b19f5749SAllen Martin 	COMPAT_NVIDIA_TEGRA20_SLINK,	/* Tegra 2 SPI SLINK controller */
88c3bb3c8bSAllen Martin 	COMPAT_NVIDIA_TEGRA114_SPI,	/* Tegra 114 SPI controller */
89cc9fe33aSHatim RV 	COMPAT_SMSC_LAN9215,		/* SMSC 10/100 Ethernet LAN9215 */
90cc9fe33aSHatim RV 	COMPAT_SAMSUNG_EXYNOS5_SROMC,	/* Exynos5 SROMC */
91c34253d1SRajeshwari Shinde 	COMPAT_SAMSUNG_S3C2440_I2C,	/* Exynos I2C Controller */
9272dbff12SRajeshwari Shinde 	COMPAT_SAMSUNG_EXYNOS5_SOUND,	/* Exynos Sound */
9372dbff12SRajeshwari Shinde 	COMPAT_WOLFSON_WM8994_CODEC,	/* Wolfson WM8994 Sound Codec */
945d50659dSRajeshwari Shinde 	COMPAT_SAMSUNG_EXYNOS_SPI,	/* Exynos SPI */
9588364387SHung-ying Tyan 	COMPAT_GOOGLE_CROS_EC,		/* Google CROS_EC Protocol */
96713cb680SHung-ying Tyan 	COMPAT_GOOGLE_CROS_EC_KEYB,	/* Google CROS_EC Keyboard */
976abd1620SRajeshwari Shinde 	COMPAT_SAMSUNG_EXYNOS_EHCI,	/* Exynos EHCI controller */
98108b85beSVivek Gautam 	COMPAT_SAMSUNG_EXYNOS5_XHCI,	/* Exynos5 XHCI controller */
996abd1620SRajeshwari Shinde 	COMPAT_SAMSUNG_EXYNOS_USB_PHY,	/* Exynos phy controller for usb2.0 */
100108b85beSVivek Gautam 	COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
101618766c0SAkshay Saraswat 	COMPAT_SAMSUNG_EXYNOS_TMU,	/* Exynos TMU */
102d7377b51SAjay Kumar 	COMPAT_SAMSUNG_EXYNOS_FIMD,	/* Exynos Display controller */
103de461c52SPiotr Wilczek 	COMPAT_SAMSUNG_EXYNOS_MIPI_DSI,	/* Exynos mipi dsi */
1041e4706a7SAjay Kumar 	COMPAT_SAMSUNG_EXYNOS5_DP,	/* Exynos Display port controller */
1057d3ca0f8SJaehoon Chung 	COMPAT_SAMSUNG_EXYNOS_DWMMC,	/* Exynos DWMMC controller */
1063577fe8bSPiotr Wilczek 	COMPAT_SAMSUNG_EXYNOS_MMC,	/* Exynos MMC controller */
107ee1e3c2fSRajeshwari Shinde 	COMPAT_SAMSUNG_EXYNOS_SERIAL,	/* Exynos UART */
108cd577e2bSRajeshwari Shinde 	COMPAT_MAXIM_MAX77686_PMIC,	/* MAX77686 PMIC */
109bb8215f4SSimon Glass 	COMPAT_GENERIC_SPI_FLASH,	/* Generic SPI Flash chip */
1107772bb78SRajeshwari Shinde 	COMPAT_MAXIM_98095_CODEC,	/* MAX98095 Codec */
111f6267998SRong Chang 	COMPAT_INFINEON_SLB9635_TPM,	/* Infineon SLB9635 TPM */
112ec34fa5eSVincent Palatin 	COMPAT_INFINEON_SLB9645_TPM,	/* Infineon SLB9645 TPM */
113ecbd7e1eSnaveen krishna chatradhi 	COMPAT_SAMSUNG_EXYNOS5_I2C,	/* Exynos5 High Speed I2C Controller */
114df93d90aSSimon Glass 	COMPAT_SANDBOX_HOST_EMULATION,	/* Sandbox emulation of a function */
1157d95f2a3SSimon Glass 	COMPAT_SANDBOX_LCD_SDL,		/* Sandbox LCD emulation with SDL */
116ac1058fdSTom Wai-Hong Tam 	COMPAT_TI_TPS65090,		/* Texas Instrument TPS65090 */
117a9cf6da9SSimon Glass 	COMPAT_NXP_PTN3460,		/* NXP PTN3460 DP/LVDS bridge */
11845c480c9SAjay Kumar 	COMPAT_SAMSUNG_EXYNOS_SYSMMU,	/* Exynos sysmmu */
1199e8f664eSVadim Bendebury 	COMPAT_PARADE_PS8625,		/* Parade PS8622 EDP->LVDS bridge */
120b5220bc6SSimon Glass 
121b5220bc6SSimon Glass 	COMPAT_COUNT,
122b5220bc6SSimon Glass };
123b5220bc6SSimon Glass 
124ed3ee5cdSSimon Glass /* GPIOs are numbered from 0 */
125ed3ee5cdSSimon Glass enum {
126ed3ee5cdSSimon Glass 	FDT_GPIO_NONE = -1U,	/* an invalid GPIO used to end our list */
127ed3ee5cdSSimon Glass 
128ed3ee5cdSSimon Glass 	FDT_GPIO_ACTIVE_LOW = 1 << 0,	/* input is active low (else high) */
129ed3ee5cdSSimon Glass };
130ed3ee5cdSSimon Glass 
131ed3ee5cdSSimon Glass /* This is the state of a GPIO pin as defined by the fdt */
132ed3ee5cdSSimon Glass struct fdt_gpio_state {
133ed3ee5cdSSimon Glass 	const char *name;	/* name of the fdt property defining this */
134ed3ee5cdSSimon Glass 	uint gpio;		/* GPIO number, or FDT_GPIO_NONE if none */
135ed3ee5cdSSimon Glass 	u8 flags;		/* FDT_GPIO_... flags */
136ed3ee5cdSSimon Glass };
137ed3ee5cdSSimon Glass 
138ed3ee5cdSSimon Glass /* This tells us whether a fdt_gpio_state record is valid or not */
139ed3ee5cdSSimon Glass #define fdt_gpio_isvalid(x) ((x)->gpio != FDT_GPIO_NONE)
140ed3ee5cdSSimon Glass 
141b5220bc6SSimon Glass /**
142202ff753SSean Paul  * Read the GPIO taking into account the polarity of the pin.
143202ff753SSean Paul  *
144202ff753SSean Paul  * @param gpio		pointer to the decoded gpio
145202ff753SSean Paul  * @return value of the gpio if successful, < 0 if unsuccessful
146202ff753SSean Paul  */
147202ff753SSean Paul int fdtdec_get_gpio(struct fdt_gpio_state *gpio);
148202ff753SSean Paul 
149202ff753SSean Paul /**
150202ff753SSean Paul  * Write the GPIO taking into account the polarity of the pin.
151202ff753SSean Paul  *
152202ff753SSean Paul  * @param gpio		pointer to the decoded gpio
153202ff753SSean Paul  * @return 0 if successful
154202ff753SSean Paul  */
155202ff753SSean Paul int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val);
156202ff753SSean Paul 
157202ff753SSean Paul /**
158b5220bc6SSimon Glass  * Find the next numbered alias for a peripheral. This is used to enumerate
159b5220bc6SSimon Glass  * all the peripherals of a certain type.
160b5220bc6SSimon Glass  *
161b5220bc6SSimon Glass  * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
162b5220bc6SSimon Glass  * this function will return a pointer to the node the alias points to, and
163b5220bc6SSimon Glass  * then update *upto to 1. Next time you call this function, the next node
164b5220bc6SSimon Glass  * will be returned.
165b5220bc6SSimon Glass  *
166b5220bc6SSimon Glass  * All nodes returned will match the compatible ID, as it is assumed that
167b5220bc6SSimon Glass  * all peripherals use the same driver.
168b5220bc6SSimon Glass  *
169b5220bc6SSimon Glass  * @param blob		FDT blob to use
170b5220bc6SSimon Glass  * @param name		Root name of alias to search for
171b5220bc6SSimon Glass  * @param id		Compatible ID to look for
172b5220bc6SSimon Glass  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
173b5220bc6SSimon Glass  */
174b5220bc6SSimon Glass int fdtdec_next_alias(const void *blob, const char *name,
175b5220bc6SSimon Glass 		enum fdt_compat_id id, int *upto);
176b5220bc6SSimon Glass 
177b5220bc6SSimon Glass /**
1787cde397bSGerald Van Baren  * Find the compatible ID for a given node.
1797cde397bSGerald Van Baren  *
1807cde397bSGerald Van Baren  * Generally each node has at least one compatible string attached to it.
1817cde397bSGerald Van Baren  * This function looks through our list of known compatible strings and
1827cde397bSGerald Van Baren  * returns the corresponding ID which matches the compatible string.
1837cde397bSGerald Van Baren  *
1847cde397bSGerald Van Baren  * @param blob		FDT blob to use
1857cde397bSGerald Van Baren  * @param node		Node containing compatible string to find
1867cde397bSGerald Van Baren  * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
1877cde397bSGerald Van Baren  */
1887cde397bSGerald Van Baren enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
1897cde397bSGerald Van Baren 
1907cde397bSGerald Van Baren /**
191f88fe2deSSimon Glass  * Find the next compatible node for a peripheral.
192f88fe2deSSimon Glass  *
193f88fe2deSSimon Glass  * Do the first call with node = 0. This function will return a pointer to
194f88fe2deSSimon Glass  * the next compatible node. Next time you call this function, pass the
195f88fe2deSSimon Glass  * value returned, and the next node will be provided.
196f88fe2deSSimon Glass  *
197f88fe2deSSimon Glass  * @param blob		FDT blob to use
198f88fe2deSSimon Glass  * @param node		Start node for search
199f88fe2deSSimon Glass  * @param id		Compatible ID to look for (enum fdt_compat_id)
200f88fe2deSSimon Glass  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
201f88fe2deSSimon Glass  */
202f88fe2deSSimon Glass int fdtdec_next_compatible(const void *blob, int node,
203f88fe2deSSimon Glass 		enum fdt_compat_id id);
204f88fe2deSSimon Glass 
205f88fe2deSSimon Glass /**
2063ddecfc7SSimon Glass  * Find the next compatible subnode for a peripheral.
2073ddecfc7SSimon Glass  *
2083ddecfc7SSimon Glass  * Do the first call with node set to the parent and depth = 0. This
2093ddecfc7SSimon Glass  * function will return the offset of the next compatible node. Next time
2103ddecfc7SSimon Glass  * you call this function, pass the node value returned last time, with
2113ddecfc7SSimon Glass  * depth unchanged, and the next node will be provided.
2123ddecfc7SSimon Glass  *
2133ddecfc7SSimon Glass  * @param blob		FDT blob to use
2143ddecfc7SSimon Glass  * @param node		Start node for search
2153ddecfc7SSimon Glass  * @param id		Compatible ID to look for (enum fdt_compat_id)
2163ddecfc7SSimon Glass  * @param depthp	Current depth (set to 0 before first call)
2173ddecfc7SSimon Glass  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
2183ddecfc7SSimon Glass  */
2193ddecfc7SSimon Glass int fdtdec_next_compatible_subnode(const void *blob, int node,
2203ddecfc7SSimon Glass 		enum fdt_compat_id id, int *depthp);
2213ddecfc7SSimon Glass 
2223ddecfc7SSimon Glass /**
223b5220bc6SSimon Glass  * Look up an address property in a node and return it as an address.
224b5220bc6SSimon Glass  * The property must hold either one address with no trailing data or
225b5220bc6SSimon Glass  * one address with a length. This is only tested on 32-bit machines.
226b5220bc6SSimon Glass  *
227b5220bc6SSimon Glass  * @param blob	FDT blob
228b5220bc6SSimon Glass  * @param node	node to examine
229b5220bc6SSimon Glass  * @param prop_name	name of property to find
230b5220bc6SSimon Glass  * @return address, if found, or FDT_ADDR_T_NONE if not
231b5220bc6SSimon Glass  */
232b5220bc6SSimon Glass fdt_addr_t fdtdec_get_addr(const void *blob, int node,
233b5220bc6SSimon Glass 		const char *prop_name);
234b5220bc6SSimon Glass 
235b5220bc6SSimon Glass /**
2364397a2a8SSimon Glass  * Look up an address property in a node and return it as an address.
2374397a2a8SSimon Glass  * The property must hold one address with a length. This is only tested
2384397a2a8SSimon Glass  * on 32-bit machines.
2394397a2a8SSimon Glass  *
2404397a2a8SSimon Glass  * @param blob	FDT blob
2414397a2a8SSimon Glass  * @param node	node to examine
2424397a2a8SSimon Glass  * @param prop_name	name of property to find
2434397a2a8SSimon Glass  * @return address, if found, or FDT_ADDR_T_NONE if not
2444397a2a8SSimon Glass  */
2454397a2a8SSimon Glass fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
2464397a2a8SSimon Glass 		const char *prop_name, fdt_size_t *sizep);
2474397a2a8SSimon Glass 
2484397a2a8SSimon Glass /**
249b5220bc6SSimon Glass  * Look up a 32-bit integer property in a node and return it. The property
250b5220bc6SSimon Glass  * must have at least 4 bytes of data. The value of the first cell is
251b5220bc6SSimon Glass  * returned.
252b5220bc6SSimon Glass  *
253b5220bc6SSimon Glass  * @param blob	FDT blob
254b5220bc6SSimon Glass  * @param node	node to examine
255b5220bc6SSimon Glass  * @param prop_name	name of property to find
256b5220bc6SSimon Glass  * @param default_val	default value to return if the property is not found
257b5220bc6SSimon Glass  * @return integer value, if found, or default_val if not
258b5220bc6SSimon Glass  */
259b5220bc6SSimon Glass s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
260b5220bc6SSimon Glass 		s32 default_val);
261b5220bc6SSimon Glass 
262b5220bc6SSimon Glass /**
263aadef0a1SChe-Liang Chiou  * Look up a 64-bit integer property in a node and return it. The property
264aadef0a1SChe-Liang Chiou  * must have at least 8 bytes of data (2 cells). The first two cells are
265aadef0a1SChe-Liang Chiou  * concatenated to form a 8 bytes value, where the first cell is top half and
266aadef0a1SChe-Liang Chiou  * the second cell is bottom half.
267aadef0a1SChe-Liang Chiou  *
268aadef0a1SChe-Liang Chiou  * @param blob	FDT blob
269aadef0a1SChe-Liang Chiou  * @param node	node to examine
270aadef0a1SChe-Liang Chiou  * @param prop_name	name of property to find
271aadef0a1SChe-Liang Chiou  * @param default_val	default value to return if the property is not found
272aadef0a1SChe-Liang Chiou  * @return integer value, if found, or default_val if not
273aadef0a1SChe-Liang Chiou  */
274aadef0a1SChe-Liang Chiou uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
275aadef0a1SChe-Liang Chiou 		uint64_t default_val);
276aadef0a1SChe-Liang Chiou 
277aadef0a1SChe-Liang Chiou /**
278b5220bc6SSimon Glass  * Checks whether a node is enabled.
279b5220bc6SSimon Glass  * This looks for a 'status' property. If this exists, then returns 1 if
280b5220bc6SSimon Glass  * the status is 'ok' and 0 otherwise. If there is no status property,
281f88fe2deSSimon Glass  * it returns 1 on the assumption that anything mentioned should be enabled
282f88fe2deSSimon Glass  * by default.
283b5220bc6SSimon Glass  *
284b5220bc6SSimon Glass  * @param blob	FDT blob
285b5220bc6SSimon Glass  * @param node	node to examine
286f88fe2deSSimon Glass  * @return integer value 0 (not enabled) or 1 (enabled)
287b5220bc6SSimon Glass  */
288f88fe2deSSimon Glass int fdtdec_get_is_enabled(const void *blob, int node);
289b5220bc6SSimon Glass 
290b5220bc6SSimon Glass /**
2919a263e55SSimon Glass  * Make sure we have a valid fdt available to control U-Boot.
2929a263e55SSimon Glass  *
2939a263e55SSimon Glass  * If not, a message is printed to the console if the console is ready.
2949a263e55SSimon Glass  *
2959a263e55SSimon Glass  * @return 0 if all ok, -1 if not
2969a263e55SSimon Glass  */
2979a263e55SSimon Glass int fdtdec_prepare_fdt(void);
2989a263e55SSimon Glass 
2999a263e55SSimon Glass /**
3009a263e55SSimon Glass  * Checks that we have a valid fdt available to control U-Boot.
3019a263e55SSimon Glass 
3029a263e55SSimon Glass  * However, if not then for the moment nothing is done, since this function
3039a263e55SSimon Glass  * is called too early to panic().
3049a263e55SSimon Glass  *
3059a263e55SSimon Glass  * @returns 0
306b5220bc6SSimon Glass  */
307b5220bc6SSimon Glass int fdtdec_check_fdt(void);
308a53f4a29SSimon Glass 
309a53f4a29SSimon Glass /**
310a53f4a29SSimon Glass  * Find the nodes for a peripheral and return a list of them in the correct
311a53f4a29SSimon Glass  * order. This is used to enumerate all the peripherals of a certain type.
312a53f4a29SSimon Glass  *
313a53f4a29SSimon Glass  * To use this, optionally set up a /aliases node with alias properties for
314a53f4a29SSimon Glass  * a peripheral. For example, for usb you could have:
315a53f4a29SSimon Glass  *
316a53f4a29SSimon Glass  * aliases {
317a53f4a29SSimon Glass  *		usb0 = "/ehci@c5008000";
318a53f4a29SSimon Glass  *		usb1 = "/ehci@c5000000";
319a53f4a29SSimon Glass  * };
320a53f4a29SSimon Glass  *
321a53f4a29SSimon Glass  * Pass "usb" as the name to this function and will return a list of two
322a53f4a29SSimon Glass  * nodes offsets: /ehci@c5008000 and ehci@c5000000.
323a53f4a29SSimon Glass  *
324a53f4a29SSimon Glass  * All nodes returned will match the compatible ID, as it is assumed that
325a53f4a29SSimon Glass  * all peripherals use the same driver.
326a53f4a29SSimon Glass  *
327a53f4a29SSimon Glass  * If no alias node is found, then the node list will be returned in the
328a53f4a29SSimon Glass  * order found in the fdt. If the aliases mention a node which doesn't
329a53f4a29SSimon Glass  * exist, then this will be ignored. If nodes are found with no aliases,
330a53f4a29SSimon Glass  * they will be added in any order.
331a53f4a29SSimon Glass  *
332a53f4a29SSimon Glass  * If there is a gap in the aliases, then this function return a 0 node at
333a53f4a29SSimon Glass  * that position. The return value will also count these gaps.
334a53f4a29SSimon Glass  *
335a53f4a29SSimon Glass  * This function checks node properties and will not return nodes which are
336a53f4a29SSimon Glass  * marked disabled (status = "disabled").
337a53f4a29SSimon Glass  *
338a53f4a29SSimon Glass  * @param blob		FDT blob to use
339a53f4a29SSimon Glass  * @param name		Root name of alias to search for
340a53f4a29SSimon Glass  * @param id		Compatible ID to look for
341a53f4a29SSimon Glass  * @param node_list	Place to put list of found nodes
342a53f4a29SSimon Glass  * @param maxcount	Maximum number of nodes to find
343a53f4a29SSimon Glass  * @return number of nodes found on success, FTD_ERR_... on error
344a53f4a29SSimon Glass  */
345a53f4a29SSimon Glass int fdtdec_find_aliases_for_id(const void *blob, const char *name,
346a53f4a29SSimon Glass 			enum fdt_compat_id id, int *node_list, int maxcount);
347a53f4a29SSimon Glass 
348a53f4a29SSimon Glass /*
349c6782270SSimon Glass  * This function is similar to fdtdec_find_aliases_for_id() except that it
350c6782270SSimon Glass  * adds to the node_list that is passed in. Any 0 elements are considered
351c6782270SSimon Glass  * available for allocation - others are considered already used and are
352c6782270SSimon Glass  * skipped.
353c6782270SSimon Glass  *
354c6782270SSimon Glass  * You can use this by calling fdtdec_find_aliases_for_id() with an
355c6782270SSimon Glass  * uninitialised array, then setting the elements that are returned to -1,
356c6782270SSimon Glass  * say, then calling this function, perhaps with a different compat id.
357c6782270SSimon Glass  * Any elements you get back that are >0 are new nodes added by the call
358c6782270SSimon Glass  * to this function.
359c6782270SSimon Glass  *
360c6782270SSimon Glass  * Note that if you have some nodes with aliases and some without, you are
361c6782270SSimon Glass  * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
362c6782270SSimon Glass  * one compat_id may fill in positions for which you have aliases defined
363c6782270SSimon Glass  * for another compat_id. When you later call *this* function with the second
364c6782270SSimon Glass  * compat_id, the alias positions may already be used. A debug warning may
365c6782270SSimon Glass  * be generated in this case, but it is safest to define aliases for all
366c6782270SSimon Glass  * nodes when you care about the ordering.
367c6782270SSimon Glass  */
368c6782270SSimon Glass int fdtdec_add_aliases_for_id(const void *blob, const char *name,
369c6782270SSimon Glass 			enum fdt_compat_id id, int *node_list, int maxcount);
370c6782270SSimon Glass 
3715c33c9fdSSimon Glass /**
3725c33c9fdSSimon Glass  * Get the alias sequence number of a node
3735c33c9fdSSimon Glass  *
3745c33c9fdSSimon Glass  * This works out whether a node is pointed to by an alias, and if so, the
3755c33c9fdSSimon Glass  * sequence number of that alias. Aliases are of the form <base><num> where
3765c33c9fdSSimon Glass  * <num> is the sequence number. For example spi2 would be sequence number
3775c33c9fdSSimon Glass  * 2.
3785c33c9fdSSimon Glass  *
3795c33c9fdSSimon Glass  * @param blob		Device tree blob (if NULL, then error is returned)
3805c33c9fdSSimon Glass  * @param base		Base name for alias (before the underscore)
3815c33c9fdSSimon Glass  * @param node		Node to look up
3825c33c9fdSSimon Glass  * @param seqp		This is set to the sequence number if one is found,
3835c33c9fdSSimon Glass  *			but otherwise the value is left alone
3845c33c9fdSSimon Glass  * @return 0 if a sequence was found, -ve if not
3855c33c9fdSSimon Glass  */
3865c33c9fdSSimon Glass int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
3875c33c9fdSSimon Glass 			 int *seqp);
3885c33c9fdSSimon Glass 
3893234aa4bSSimon Glass /**
3903234aa4bSSimon Glass  * Get the offset of the given alias node
3913234aa4bSSimon Glass  *
3923234aa4bSSimon Glass  * This looks up an alias in /aliases then finds the offset of that node.
3933234aa4bSSimon Glass  *
3943234aa4bSSimon Glass  * @param blob		Device tree blob (if NULL, then error is returned)
3953234aa4bSSimon Glass  * @param name		Alias name, e.g. "console"
3963234aa4bSSimon Glass  * @return Node offset referred to by that alias, or -ve FDT_ERR_...
3973234aa4bSSimon Glass  */
3983234aa4bSSimon Glass int fdtdec_get_alias_node(const void *blob, const char *name);
3993234aa4bSSimon Glass 
400aac07d49SSimon Glass /**
401aac07d49SSimon Glass  * Get the offset of the given chosen node
402aac07d49SSimon Glass  *
403aac07d49SSimon Glass  * This looks up a property in /chosen containing the path to another node,
404aac07d49SSimon Glass  * then finds the offset of that node.
405aac07d49SSimon Glass  *
406aac07d49SSimon Glass  * @param blob		Device tree blob (if NULL, then error is returned)
407aac07d49SSimon Glass  * @param name		Property name, e.g. "stdout-path"
408aac07d49SSimon Glass  * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
409aac07d49SSimon Glass  */
410aac07d49SSimon Glass int fdtdec_get_chosen_node(const void *blob, const char *name);
411aac07d49SSimon Glass 
412c6782270SSimon Glass /*
413a53f4a29SSimon Glass  * Get the name for a compatible ID
414a53f4a29SSimon Glass  *
415a53f4a29SSimon Glass  * @param id		Compatible ID to look for
416a53f4a29SSimon Glass  * @return compatible string for that id
417a53f4a29SSimon Glass  */
418a53f4a29SSimon Glass const char *fdtdec_get_compatible(enum fdt_compat_id id);
419d17da655SSimon Glass 
420d17da655SSimon Glass /* Look up a phandle and follow it to its node. Then return the offset
421d17da655SSimon Glass  * of that node.
422d17da655SSimon Glass  *
423d17da655SSimon Glass  * @param blob		FDT blob
424d17da655SSimon Glass  * @param node		node to examine
425d17da655SSimon Glass  * @param prop_name	name of property to find
426d17da655SSimon Glass  * @return node offset if found, -ve error code on error
427d17da655SSimon Glass  */
428d17da655SSimon Glass int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
429d17da655SSimon Glass 
430d17da655SSimon Glass /**
431d17da655SSimon Glass  * Look up a property in a node and return its contents in an integer
432d17da655SSimon Glass  * array of given length. The property must have at least enough data for
433d17da655SSimon Glass  * the array (4*count bytes). It may have more, but this will be ignored.
434d17da655SSimon Glass  *
435d17da655SSimon Glass  * @param blob		FDT blob
436d17da655SSimon Glass  * @param node		node to examine
437d17da655SSimon Glass  * @param prop_name	name of property to find
438d17da655SSimon Glass  * @param array		array to fill with data
439d17da655SSimon Glass  * @param count		number of array elements
440d17da655SSimon Glass  * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
441d17da655SSimon Glass  *		or -FDT_ERR_BADLAYOUT if not enough data
442d17da655SSimon Glass  */
443d17da655SSimon Glass int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
444d17da655SSimon Glass 		u32 *array, int count);
445d17da655SSimon Glass 
446d17da655SSimon Glass /**
44796875e7dSSimon Glass  * Look up a property in a node and return a pointer to its contents as a
44896875e7dSSimon Glass  * unsigned int array of given length. The property must have at least enough
44996875e7dSSimon Glass  * data for the array ('count' cells). It may have more, but this will be
45096875e7dSSimon Glass  * ignored. The data is not copied.
45196875e7dSSimon Glass  *
45296875e7dSSimon Glass  * Note that you must access elements of the array with fdt32_to_cpu(),
45396875e7dSSimon Glass  * since the elements will be big endian even on a little endian machine.
45496875e7dSSimon Glass  *
45596875e7dSSimon Glass  * @param blob		FDT blob
45696875e7dSSimon Glass  * @param node		node to examine
45796875e7dSSimon Glass  * @param prop_name	name of property to find
45896875e7dSSimon Glass  * @param count		number of array elements
45996875e7dSSimon Glass  * @return pointer to array if found, or NULL if the property is not
46096875e7dSSimon Glass  *		found or there is not enough data
46196875e7dSSimon Glass  */
46296875e7dSSimon Glass const u32 *fdtdec_locate_array(const void *blob, int node,
46396875e7dSSimon Glass 			       const char *prop_name, int count);
46496875e7dSSimon Glass 
46596875e7dSSimon Glass /**
466d17da655SSimon Glass  * Look up a boolean property in a node and return it.
467d17da655SSimon Glass  *
468d17da655SSimon Glass  * A boolean properly is true if present in the device tree and false if not
469d17da655SSimon Glass  * present, regardless of its value.
470d17da655SSimon Glass  *
471d17da655SSimon Glass  * @param blob	FDT blob
472d17da655SSimon Glass  * @param node	node to examine
473d17da655SSimon Glass  * @param prop_name	name of property to find
474d17da655SSimon Glass  * @return 1 if the properly is present; 0 if it isn't present
475d17da655SSimon Glass  */
476d17da655SSimon Glass int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
477ed3ee5cdSSimon Glass 
478ed3ee5cdSSimon Glass /**
479ed3ee5cdSSimon Glass  * Decode a single GPIOs from an FDT.
480ed3ee5cdSSimon Glass  *
481ed3ee5cdSSimon Glass  * If the property is not found, then the GPIO structure will still be
482ed3ee5cdSSimon Glass  * initialised, with gpio set to FDT_GPIO_NONE. This makes it easy to
483ed3ee5cdSSimon Glass  * provide optional GPIOs.
484ed3ee5cdSSimon Glass  *
485ed3ee5cdSSimon Glass  * @param blob		FDT blob to use
486ed3ee5cdSSimon Glass  * @param node		Node to look at
487ed3ee5cdSSimon Glass  * @param prop_name	Node property name
488ed3ee5cdSSimon Glass  * @param gpio		gpio elements to fill from FDT
489ed3ee5cdSSimon Glass  * @return 0 if ok, -FDT_ERR_NOTFOUND if the property is missing.
490ed3ee5cdSSimon Glass  */
491ed3ee5cdSSimon Glass int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
492ed3ee5cdSSimon Glass 		struct fdt_gpio_state *gpio);
493ed3ee5cdSSimon Glass 
494ed3ee5cdSSimon Glass /**
4955921f6a2SAbhilash Kesavan  * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
4965921f6a2SAbhilash Kesavan  * terminating item.
4975921f6a2SAbhilash Kesavan  *
4985921f6a2SAbhilash Kesavan  * @param blob         FDT blob to use
4995921f6a2SAbhilash Kesavan  * @param node         Node to look at
5005921f6a2SAbhilash Kesavan  * @param prop_name    Node property name
5015921f6a2SAbhilash Kesavan  * @param gpio         Array of gpio elements to fill from FDT. This will be
5025921f6a2SAbhilash Kesavan  *                     untouched if either 0 or an error is returned
5035921f6a2SAbhilash Kesavan  * @param max_count    Maximum number of elements allowed
5045921f6a2SAbhilash Kesavan  * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
5055921f6a2SAbhilash Kesavan  * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
5065921f6a2SAbhilash Kesavan  */
5075921f6a2SAbhilash Kesavan int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
5085921f6a2SAbhilash Kesavan 		struct fdt_gpio_state *gpio, int max_count);
5095921f6a2SAbhilash Kesavan 
5105921f6a2SAbhilash Kesavan /**
511ed3ee5cdSSimon Glass  * Set up a GPIO pin according to the provided gpio information. At present this
512ed3ee5cdSSimon Glass  * just requests the GPIO.
513ed3ee5cdSSimon Glass  *
514ed3ee5cdSSimon Glass  * If the gpio is FDT_GPIO_NONE, no action is taken. This makes it easy to
515ed3ee5cdSSimon Glass  * deal with optional GPIOs.
516ed3ee5cdSSimon Glass  *
517ed3ee5cdSSimon Glass  * @param gpio		GPIO info to use for set up
518ed3ee5cdSSimon Glass  * @return 0 if all ok or gpio was FDT_GPIO_NONE; -1 on error
519ed3ee5cdSSimon Glass  */
520ed3ee5cdSSimon Glass int fdtdec_setup_gpio(struct fdt_gpio_state *gpio);
521bed4d892SAnton Staff 
52209258f1eSAbhilash Kesavan /**
52309258f1eSAbhilash Kesavan  * Look in the FDT for a config item with the given name and return its value
52409258f1eSAbhilash Kesavan  * as a 32-bit integer. The property must have at least 4 bytes of data. The
52509258f1eSAbhilash Kesavan  * value of the first cell is returned.
52609258f1eSAbhilash Kesavan  *
52709258f1eSAbhilash Kesavan  * @param blob		FDT blob to use
52809258f1eSAbhilash Kesavan  * @param prop_name	Node property name
52909258f1eSAbhilash Kesavan  * @param default_val	default value to return if the property is not found
53009258f1eSAbhilash Kesavan  * @return integer value, if found, or default_val if not
53109258f1eSAbhilash Kesavan  */
53209258f1eSAbhilash Kesavan int fdtdec_get_config_int(const void *blob, const char *prop_name,
53309258f1eSAbhilash Kesavan 		int default_val);
53409258f1eSAbhilash Kesavan 
535332ab0d5SSimon Glass /**
53679289c0bSGabe Black  * Look in the FDT for a config item with the given name
53779289c0bSGabe Black  * and return whether it exists.
53879289c0bSGabe Black  *
53979289c0bSGabe Black  * @param blob		FDT blob
54079289c0bSGabe Black  * @param prop_name	property name to look up
54179289c0bSGabe Black  * @return 1, if it exists, or 0 if not
54279289c0bSGabe Black  */
54379289c0bSGabe Black int fdtdec_get_config_bool(const void *blob, const char *prop_name);
54479289c0bSGabe Black 
54579289c0bSGabe Black /**
546332ab0d5SSimon Glass  * Look in the FDT for a config item with the given name and return its value
547332ab0d5SSimon Glass  * as a string.
548332ab0d5SSimon Glass  *
549332ab0d5SSimon Glass  * @param blob          FDT blob
550332ab0d5SSimon Glass  * @param prop_name     property name to look up
551332ab0d5SSimon Glass  * @returns property string, NULL on error.
552332ab0d5SSimon Glass  */
553332ab0d5SSimon Glass char *fdtdec_get_config_string(const void *blob, const char *prop_name);
554332ab0d5SSimon Glass 
555bed4d892SAnton Staff /*
556bed4d892SAnton Staff  * Look up a property in a node and return its contents in a byte
557bed4d892SAnton Staff  * array of given length. The property must have at least enough data for
558bed4d892SAnton Staff  * the array (count bytes). It may have more, but this will be ignored.
559bed4d892SAnton Staff  *
560bed4d892SAnton Staff  * @param blob		FDT blob
561bed4d892SAnton Staff  * @param node		node to examine
562bed4d892SAnton Staff  * @param prop_name	name of property to find
563bed4d892SAnton Staff  * @param array		array to fill with data
564bed4d892SAnton Staff  * @param count		number of array elements
565bed4d892SAnton Staff  * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
566bed4d892SAnton Staff  *		or -FDT_ERR_BADLAYOUT if not enough data
567bed4d892SAnton Staff  */
568bed4d892SAnton Staff int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
569bed4d892SAnton Staff 		u8 *array, int count);
570bed4d892SAnton Staff 
571bed4d892SAnton Staff /**
572bed4d892SAnton Staff  * Look up a property in a node and return a pointer to its contents as a
573bed4d892SAnton Staff  * byte array of given length. The property must have at least enough data
574bed4d892SAnton Staff  * for the array (count bytes). It may have more, but this will be ignored.
575bed4d892SAnton Staff  * The data is not copied.
576bed4d892SAnton Staff  *
577bed4d892SAnton Staff  * @param blob		FDT blob
578bed4d892SAnton Staff  * @param node		node to examine
579bed4d892SAnton Staff  * @param prop_name	name of property to find
580bed4d892SAnton Staff  * @param count		number of array elements
581bed4d892SAnton Staff  * @return pointer to byte array if found, or NULL if the property is not
582bed4d892SAnton Staff  *		found or there is not enough data
583bed4d892SAnton Staff  */
584bed4d892SAnton Staff const u8 *fdtdec_locate_byte_array(const void *blob, int node,
585bed4d892SAnton Staff 			     const char *prop_name, int count);
586f20c4619SSimon Glass 
587f20c4619SSimon Glass /**
588f20c4619SSimon Glass  * Look up a property in a node which contains a memory region address and
589f20c4619SSimon Glass  * size. Then return a pointer to this address.
590f20c4619SSimon Glass  *
591f20c4619SSimon Glass  * The property must hold one address with a length. This is only tested on
592f20c4619SSimon Glass  * 32-bit machines.
593f20c4619SSimon Glass  *
594f20c4619SSimon Glass  * @param blob		FDT blob
595f20c4619SSimon Glass  * @param node		node to examine
596f20c4619SSimon Glass  * @param prop_name	name of property to find
597f20c4619SSimon Glass  * @param ptrp		returns pointer to region, or NULL if no address
598f20c4619SSimon Glass  * @param size		returns size of region
599f20c4619SSimon Glass  * @return 0 if ok, -1 on error (propery not found)
600f20c4619SSimon Glass  */
601f20c4619SSimon Glass int fdtdec_decode_region(const void *blob, int node,
602f20c4619SSimon Glass 		const char *prop_name, void **ptrp, size_t *size);
603006e73b9SSimon Glass 
604006e73b9SSimon Glass /* A flash map entry, containing an offset and length */
605006e73b9SSimon Glass struct fmap_entry {
606006e73b9SSimon Glass 	uint32_t offset;
607006e73b9SSimon Glass 	uint32_t length;
608006e73b9SSimon Glass };
609006e73b9SSimon Glass 
610006e73b9SSimon Glass /**
611006e73b9SSimon Glass  * Read a flash entry from the fdt
612006e73b9SSimon Glass  *
613006e73b9SSimon Glass  * @param blob		FDT blob
614006e73b9SSimon Glass  * @param node		Offset of node to read
615006e73b9SSimon Glass  * @param name		Name of node being read
616006e73b9SSimon Glass  * @param entry		Place to put offset and size of this node
617006e73b9SSimon Glass  * @return 0 if ok, -ve on error
618006e73b9SSimon Glass  */
619006e73b9SSimon Glass int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
620006e73b9SSimon Glass 			   struct fmap_entry *entry);
62156f42242SThierry Reding 
62256f42242SThierry Reding /**
62356f42242SThierry Reding  * Obtain an indexed resource from a device property.
62456f42242SThierry Reding  *
62556f42242SThierry Reding  * @param fdt		FDT blob
62656f42242SThierry Reding  * @param node		node to examine
62756f42242SThierry Reding  * @param property	name of the property to parse
62856f42242SThierry Reding  * @param index		index of the resource to retrieve
62956f42242SThierry Reding  * @param res		returns the resource
63056f42242SThierry Reding  * @return 0 if ok, negative on error
63156f42242SThierry Reding  */
63256f42242SThierry Reding int fdt_get_resource(const void *fdt, int node, const char *property,
63356f42242SThierry Reding 		     unsigned int index, struct fdt_resource *res);
63456f42242SThierry Reding 
63556f42242SThierry Reding /**
63656f42242SThierry Reding  * Obtain a named resource from a device property.
63756f42242SThierry Reding  *
63856f42242SThierry Reding  * Look up the index of the name in a list of strings and return the resource
63956f42242SThierry Reding  * at that index.
64056f42242SThierry Reding  *
64156f42242SThierry Reding  * @param fdt		FDT blob
64256f42242SThierry Reding  * @param node		node to examine
64356f42242SThierry Reding  * @param property	name of the property to parse
64456f42242SThierry Reding  * @param prop_names	name of the property containing the list of names
64556f42242SThierry Reding  * @param name		the name of the entry to look up
64656f42242SThierry Reding  * @param res		returns the resource
64756f42242SThierry Reding  */
64856f42242SThierry Reding int fdt_get_named_resource(const void *fdt, int node, const char *property,
64956f42242SThierry Reding 			   const char *prop_names, const char *name,
65056f42242SThierry Reding 			   struct fdt_resource *res);
65156f42242SThierry Reding 
652*9f85eee7SThierry Reding /**
653*9f85eee7SThierry Reding  * Look at the reg property of a device node that represents a PCI device
654*9f85eee7SThierry Reding  * and parse the bus, device and function number from it.
655*9f85eee7SThierry Reding  *
656*9f85eee7SThierry Reding  * @param fdt		FDT blob
657*9f85eee7SThierry Reding  * @param node		node to examine
658*9f85eee7SThierry Reding  * @param bdf		returns bus, device, function triplet
659*9f85eee7SThierry Reding  * @return 0 if ok, negative on error
660*9f85eee7SThierry Reding  */
661*9f85eee7SThierry Reding int fdtdec_pci_get_bdf(const void *fdt, int node, int *bdf);
662*9f85eee7SThierry Reding 
6635bfa78dbSSimon Glass #endif
664