183d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */
2b5220bc6SSimon Glass /*
3b5220bc6SSimon Glass * Copyright (c) 2011 The Chromium OS Authors.
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
17b08c8c48SMasahiro Yamada #include <linux/libfdt.h>
18a62e84d7SBin Meng #include <pci.h>
19b5220bc6SSimon Glass
20b5220bc6SSimon Glass /*
21b5220bc6SSimon Glass * A typedef for a physical address. Note that fdt data is always big
22b5220bc6SSimon Glass * endian even on a litle endian machine.
23b5220bc6SSimon Glass */
2428445aa7SYork Sun typedef phys_addr_t fdt_addr_t;
2528445aa7SYork Sun typedef phys_size_t fdt_size_t;
26b5220bc6SSimon Glass #ifdef CONFIG_PHYS_64BIT
27c6b89f31SMario Six #define FDT_ADDR_T_NONE (-1U)
28b5220bc6SSimon Glass #define fdt_addr_to_cpu(reg) be64_to_cpu(reg)
29f20c4619SSimon Glass #define fdt_size_to_cpu(reg) be64_to_cpu(reg)
30c20ee0edSSimon Glass typedef fdt64_t fdt_val_t;
31b5220bc6SSimon Glass #else
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)
35c20ee0edSSimon Glass typedef fdt32_t fdt_val_t;
36b5220bc6SSimon Glass #endif
37b5220bc6SSimon Glass
38b5220bc6SSimon Glass /* Information obtained about memory from the FDT */
39b5220bc6SSimon Glass struct fdt_memory {
40b5220bc6SSimon Glass fdt_addr_t start;
41b5220bc6SSimon Glass fdt_addr_t end;
42b5220bc6SSimon Glass };
43b5220bc6SSimon Glass
4490c08fa0SMichael Pratt struct bd_info;
4590c08fa0SMichael Pratt
46af282245SSimon Glass #ifdef CONFIG_SPL_BUILD
47af282245SSimon Glass #define SPL_BUILD 1
48af282245SSimon Glass #else
49af282245SSimon Glass #define SPL_BUILD 0
50af282245SSimon Glass #endif
51af282245SSimon Glass
52894c3ad2SThomas Fitzsimmons #if CONFIG_IS_ENABLED(OF_PRIOR_STAGE)
53894c3ad2SThomas Fitzsimmons extern phys_addr_t prior_stage_fdt_address;
54894c3ad2SThomas Fitzsimmons #endif
55894c3ad2SThomas Fitzsimmons
5656f42242SThierry Reding /*
5756f42242SThierry Reding * Information about a resource. start is the first address of the resource
5856f42242SThierry Reding * and end is the last address (inclusive). The length of the resource will
5956f42242SThierry Reding * be equal to: end - start + 1.
6056f42242SThierry Reding */
6156f42242SThierry Reding struct fdt_resource {
6256f42242SThierry Reding fdt_addr_t start;
6356f42242SThierry Reding fdt_addr_t end;
6456f42242SThierry Reding };
6556f42242SThierry Reding
66a62e84d7SBin Meng enum fdt_pci_space {
67a62e84d7SBin Meng FDT_PCI_SPACE_CONFIG = 0,
68a62e84d7SBin Meng FDT_PCI_SPACE_IO = 0x01000000,
69a62e84d7SBin Meng FDT_PCI_SPACE_MEM32 = 0x02000000,
70a62e84d7SBin Meng FDT_PCI_SPACE_MEM64 = 0x03000000,
71a62e84d7SBin Meng FDT_PCI_SPACE_MEM32_PREF = 0x42000000,
72a62e84d7SBin Meng FDT_PCI_SPACE_MEM64_PREF = 0x43000000,
73a62e84d7SBin Meng };
74a62e84d7SBin Meng
75a62e84d7SBin Meng #define FDT_PCI_ADDR_CELLS 3
76a62e84d7SBin Meng #define FDT_PCI_SIZE_CELLS 2
77a62e84d7SBin Meng #define FDT_PCI_REG_SIZE \
78a62e84d7SBin Meng ((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32))
79a62e84d7SBin Meng
80a62e84d7SBin Meng /*
81a62e84d7SBin Meng * The Open Firmware spec defines PCI physical address as follows:
82a62e84d7SBin Meng *
83a62e84d7SBin Meng * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
84a62e84d7SBin Meng *
85a62e84d7SBin Meng * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr
86a62e84d7SBin Meng * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
87a62e84d7SBin Meng * phys.lo cell: llllllll llllllll llllllll llllllll
88a62e84d7SBin Meng *
89a62e84d7SBin Meng * where:
90a62e84d7SBin Meng *
91a62e84d7SBin Meng * n: is 0 if the address is relocatable, 1 otherwise
92a62e84d7SBin Meng * p: is 1 if addressable region is prefetchable, 0 otherwise
93a62e84d7SBin Meng * t: is 1 if the address is aliased (for non-relocatable I/O) below 1MB
94a62e84d7SBin Meng * (for Memory), or below 64KB (for relocatable I/O)
95a62e84d7SBin Meng * ss: is the space code, denoting the address space
96a62e84d7SBin Meng * bbbbbbbb: is the 8-bit Bus Number
97a62e84d7SBin Meng * ddddd: is the 5-bit Device Number
98a62e84d7SBin Meng * fff: is the 3-bit Function Number
99a62e84d7SBin Meng * rrrrrrrr: is the 8-bit Register Number
100a62e84d7SBin Meng * hhhhhhhh: is a 32-bit unsigned number
101a62e84d7SBin Meng * llllllll: is a 32-bit unsigned number
102a62e84d7SBin Meng */
103a62e84d7SBin Meng struct fdt_pci_addr {
104a62e84d7SBin Meng u32 phys_hi;
105a62e84d7SBin Meng u32 phys_mid;
106a62e84d7SBin Meng u32 phys_lo;
107a62e84d7SBin Meng };
108a62e84d7SBin Meng
10956f42242SThierry Reding /**
11056f42242SThierry Reding * Compute the size of a resource.
11156f42242SThierry Reding *
11256f42242SThierry Reding * @param res the resource to operate on
11356f42242SThierry Reding * @return the size of the resource
11456f42242SThierry Reding */
fdt_resource_size(const struct fdt_resource * res)11556f42242SThierry Reding static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
11656f42242SThierry Reding {
11756f42242SThierry Reding return res->end - res->start + 1;
11856f42242SThierry Reding }
11956f42242SThierry Reding
120b5220bc6SSimon Glass /**
121b5220bc6SSimon Glass * Compat types that we know about and for which we might have drivers.
122b5220bc6SSimon Glass * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
123b5220bc6SSimon Glass * within drivers.
124b5220bc6SSimon Glass */
125b5220bc6SSimon Glass enum fdt_compat_id {
126b5220bc6SSimon Glass COMPAT_UNKNOWN,
12700a2749dSAllen Martin COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
12800a2749dSAllen Martin COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
129312693c3SJim Lin COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
13079c7a90fSThierry Reding COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
13179c7a90fSThierry Reding /* Tegra124 XUSB pad controller */
1327aaa5a60STom Warren COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
1337aaa5a60STom Warren /* Tegra210 XUSB pad controller */
134cc9fe33aSHatim RV COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
135cc9fe33aSHatim RV COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
1366abd1620SRajeshwari Shinde COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
137108b85beSVivek Gautam COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
138618766c0SAkshay Saraswat COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
139de461c52SPiotr Wilczek COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
1407d3ca0f8SJaehoon Chung COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
141bb8215f4SSimon Glass COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
14245c480c9SAjay Kumar COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
14377f9b1fbSSimon Glass COMPAT_INTEL_MICROCODE, /* Intel microcode update */
144c89ada01SBin Meng COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
1456ab00db2SMarek Vasut COMPAT_ALTERA_SOCFPGA_DWMAC, /* SoCFPGA Ethernet controller */
146129adf5bSMarek Vasut COMPAT_ALTERA_SOCFPGA_DWMMC, /* SoCFPGA DWMMC controller */
147ef4b01b2SMarek Vasut COMPAT_ALTERA_SOCFPGA_DWC2USB, /* SoCFPGA DWC2 USB controller */
148f3b84a30SAndrew Bradford COMPAT_INTEL_BAYTRAIL_FSP, /* Intel Bay Trail FSP */
149f3b84a30SAndrew Bradford COMPAT_INTEL_BAYTRAIL_FSP_MDP, /* Intel FSP memory-down params */
150394e0b66SBin Meng COMPAT_INTEL_IVYBRIDGE_FSP, /* Intel Ivy Bridge FSP */
1514ccae81cSBoris Brezillon COMPAT_SUNXI_NAND, /* SUNXI NAND controller */
152e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_CLK, /* SoCFPGA Clock initialization */
153e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_PINCTRL_SINGLE, /* SoCFPGA pinctrl-single */
154e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_H2F_BRG, /* SoCFPGA hps2fpga bridge */
155e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_LWH2F_BRG, /* SoCFPGA lwhps2fpga bridge */
156e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_F2H_BRG, /* SoCFPGA fpga2hps bridge */
157e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_F2SDR0, /* SoCFPGA fpga2SDRAM0 bridge */
158e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_F2SDR1, /* SoCFPGA fpga2SDRAM1 bridge */
159e11b5e8dSLey Foon Tan COMPAT_ALTERA_SOCFPGA_F2SDR2, /* SoCFPGA fpga2SDRAM2 bridge */
160eb57c0beSTien Fong Chee COMPAT_ALTERA_SOCFPGA_FPGA0, /* SOCFPGA FPGA manager */
161eb57c0beSTien Fong Chee COMPAT_ALTERA_SOCFPGA_NOC, /* SOCFPGA Arria 10 NOC */
16219c8fc77SMarek Vasut COMPAT_ALTERA_SOCFPGA_CLK_INIT, /* SOCFPGA Arria 10 clk init */
163b5220bc6SSimon Glass
164b5220bc6SSimon Glass COMPAT_COUNT,
165b5220bc6SSimon Glass };
166b5220bc6SSimon Glass
16757068a7aSSimon Glass #define MAX_PHANDLE_ARGS 16
16857068a7aSSimon Glass struct fdtdec_phandle_args {
16957068a7aSSimon Glass int node;
17057068a7aSSimon Glass int args_count;
17157068a7aSSimon Glass uint32_t args[MAX_PHANDLE_ARGS];
17257068a7aSSimon Glass };
17357068a7aSSimon Glass
17457068a7aSSimon Glass /**
17557068a7aSSimon Glass * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
17657068a7aSSimon Glass *
17757068a7aSSimon Glass * This function is useful to parse lists of phandles and their arguments.
17857068a7aSSimon Glass *
17957068a7aSSimon Glass * Example:
18057068a7aSSimon Glass *
18157068a7aSSimon Glass * phandle1: node1 {
18257068a7aSSimon Glass * #list-cells = <2>;
18357068a7aSSimon Glass * }
18457068a7aSSimon Glass *
18557068a7aSSimon Glass * phandle2: node2 {
18657068a7aSSimon Glass * #list-cells = <1>;
18757068a7aSSimon Glass * }
18857068a7aSSimon Glass *
18957068a7aSSimon Glass * node3 {
19057068a7aSSimon Glass * list = <&phandle1 1 2 &phandle2 3>;
19157068a7aSSimon Glass * }
19257068a7aSSimon Glass *
19357068a7aSSimon Glass * To get a device_node of the `node2' node you may call this:
19457068a7aSSimon Glass * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
19557068a7aSSimon Glass * &args);
19657068a7aSSimon Glass *
19757068a7aSSimon Glass * (This function is a modified version of __of_parse_phandle_with_args() from
19857068a7aSSimon Glass * Linux 3.18)
19957068a7aSSimon Glass *
20057068a7aSSimon Glass * @blob: Pointer to device tree
20157068a7aSSimon Glass * @src_node: Offset of device tree node containing a list
20257068a7aSSimon Glass * @list_name: property name that contains a list
20357068a7aSSimon Glass * @cells_name: property name that specifies the phandles' arguments count,
20457068a7aSSimon Glass * or NULL to use @cells_count
20557068a7aSSimon Glass * @cells_count: Cell count to use if @cells_name is NULL
20657068a7aSSimon Glass * @index: index of a phandle to parse out
20757068a7aSSimon Glass * @out_args: optional pointer to output arguments structure (will be filled)
20857068a7aSSimon Glass * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
20957068a7aSSimon Glass * @list_name does not exist, a phandle was not found, @cells_name
21057068a7aSSimon Glass * could not be found, the arguments were truncated or there were too
21157068a7aSSimon Glass * many arguments.
21257068a7aSSimon Glass *
21357068a7aSSimon Glass */
21457068a7aSSimon Glass int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
21557068a7aSSimon Glass const char *list_name,
21657068a7aSSimon Glass const char *cells_name,
21757068a7aSSimon Glass int cell_count, int index,
21857068a7aSSimon Glass struct fdtdec_phandle_args *out_args);
21957068a7aSSimon Glass
220202ff753SSean Paul /**
221b5220bc6SSimon Glass * Find the next numbered alias for a peripheral. This is used to enumerate
222b5220bc6SSimon Glass * all the peripherals of a certain type.
223b5220bc6SSimon Glass *
224b5220bc6SSimon Glass * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
225b5220bc6SSimon Glass * this function will return a pointer to the node the alias points to, and
226b5220bc6SSimon Glass * then update *upto to 1. Next time you call this function, the next node
227b5220bc6SSimon Glass * will be returned.
228b5220bc6SSimon Glass *
229b5220bc6SSimon Glass * All nodes returned will match the compatible ID, as it is assumed that
230b5220bc6SSimon Glass * all peripherals use the same driver.
231b5220bc6SSimon Glass *
232b5220bc6SSimon Glass * @param blob FDT blob to use
233b5220bc6SSimon Glass * @param name Root name of alias to search for
234b5220bc6SSimon Glass * @param id Compatible ID to look for
235b5220bc6SSimon Glass * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
236b5220bc6SSimon Glass */
237b5220bc6SSimon Glass int fdtdec_next_alias(const void *blob, const char *name,
238b5220bc6SSimon Glass enum fdt_compat_id id, int *upto);
239b5220bc6SSimon Glass
240b5220bc6SSimon Glass /**
2417cde397bSGerald Van Baren * Find the compatible ID for a given node.
2427cde397bSGerald Van Baren *
2437cde397bSGerald Van Baren * Generally each node has at least one compatible string attached to it.
2447cde397bSGerald Van Baren * This function looks through our list of known compatible strings and
2457cde397bSGerald Van Baren * returns the corresponding ID which matches the compatible string.
2467cde397bSGerald Van Baren *
2477cde397bSGerald Van Baren * @param blob FDT blob to use
2487cde397bSGerald Van Baren * @param node Node containing compatible string to find
2497cde397bSGerald Van Baren * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
2507cde397bSGerald Van Baren */
2517cde397bSGerald Van Baren enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
2527cde397bSGerald Van Baren
2537cde397bSGerald Van Baren /**
254f88fe2deSSimon Glass * Find the next compatible node for a peripheral.
255f88fe2deSSimon Glass *
256f88fe2deSSimon Glass * Do the first call with node = 0. This function will return a pointer to
257f88fe2deSSimon Glass * the next compatible node. Next time you call this function, pass the
258f88fe2deSSimon Glass * value returned, and the next node will be provided.
259f88fe2deSSimon Glass *
260f88fe2deSSimon Glass * @param blob FDT blob to use
261f88fe2deSSimon Glass * @param node Start node for search
262f88fe2deSSimon Glass * @param id Compatible ID to look for (enum fdt_compat_id)
263f88fe2deSSimon Glass * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
264f88fe2deSSimon Glass */
265f88fe2deSSimon Glass int fdtdec_next_compatible(const void *blob, int node,
266f88fe2deSSimon Glass enum fdt_compat_id id);
267f88fe2deSSimon Glass
268f88fe2deSSimon Glass /**
2693ddecfc7SSimon Glass * Find the next compatible subnode for a peripheral.
2703ddecfc7SSimon Glass *
2713ddecfc7SSimon Glass * Do the first call with node set to the parent and depth = 0. This
2723ddecfc7SSimon Glass * function will return the offset of the next compatible node. Next time
2733ddecfc7SSimon Glass * you call this function, pass the node value returned last time, with
2743ddecfc7SSimon Glass * depth unchanged, and the next node will be provided.
2753ddecfc7SSimon Glass *
2763ddecfc7SSimon Glass * @param blob FDT blob to use
2773ddecfc7SSimon Glass * @param node Start node for search
2783ddecfc7SSimon Glass * @param id Compatible ID to look for (enum fdt_compat_id)
2793ddecfc7SSimon Glass * @param depthp Current depth (set to 0 before first call)
2803ddecfc7SSimon Glass * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
2813ddecfc7SSimon Glass */
2823ddecfc7SSimon Glass int fdtdec_next_compatible_subnode(const void *blob, int node,
2833ddecfc7SSimon Glass enum fdt_compat_id id, int *depthp);
2843ddecfc7SSimon Glass
28502464e38SStephen Warren /*
28602464e38SStephen Warren * Look up an address property in a node and return the parsed address, and
28702464e38SStephen Warren * optionally the parsed size.
28802464e38SStephen Warren *
28902464e38SStephen Warren * This variant assumes a known and fixed number of cells are used to
29002464e38SStephen Warren * represent the address and size.
29102464e38SStephen Warren *
29202464e38SStephen Warren * You probably don't want to use this function directly except to parse
29302464e38SStephen Warren * non-standard properties, and never to parse the "reg" property. Instead,
29402464e38SStephen Warren * use one of the "auto" variants below, which automatically honor the
29502464e38SStephen Warren * #address-cells and #size-cells properties in the parent node.
29602464e38SStephen Warren *
29702464e38SStephen Warren * @param blob FDT blob
29802464e38SStephen Warren * @param node node to examine
29902464e38SStephen Warren * @param prop_name name of property to find
30002464e38SStephen Warren * @param index which address to retrieve from a list of addresses. Often 0.
30102464e38SStephen Warren * @param na the number of cells used to represent an address
30202464e38SStephen Warren * @param ns the number of cells used to represent a size
30302464e38SStephen Warren * @param sizep a pointer to store the size into. Use NULL if not required
3046e06acb7SStephen Warren * @param translate Indicates whether to translate the returned value
3056e06acb7SStephen Warren * using the parent node's ranges property.
30602464e38SStephen Warren * @return address, if found, or FDT_ADDR_T_NONE if not
30702464e38SStephen Warren */
30802464e38SStephen Warren fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
30902464e38SStephen Warren const char *prop_name, int index, int na, int ns,
3106e06acb7SStephen Warren fdt_size_t *sizep, bool translate);
31102464e38SStephen Warren
31202464e38SStephen Warren /*
31302464e38SStephen Warren * Look up an address property in a node and return the parsed address, and
31402464e38SStephen Warren * optionally the parsed size.
31502464e38SStephen Warren *
31602464e38SStephen Warren * This variant automatically determines the number of cells used to represent
31702464e38SStephen Warren * the address and size by parsing the provided parent node's #address-cells
31802464e38SStephen Warren * and #size-cells properties.
31902464e38SStephen Warren *
32002464e38SStephen Warren * @param blob FDT blob
32102464e38SStephen Warren * @param parent parent node of @node
32202464e38SStephen Warren * @param node node to examine
32302464e38SStephen Warren * @param prop_name name of property to find
32402464e38SStephen Warren * @param index which address to retrieve from a list of addresses. Often 0.
32502464e38SStephen Warren * @param sizep a pointer to store the size into. Use NULL if not required
3266e06acb7SStephen Warren * @param translate Indicates whether to translate the returned value
3276e06acb7SStephen Warren * using the parent node's ranges property.
32802464e38SStephen Warren * @return address, if found, or FDT_ADDR_T_NONE if not
32902464e38SStephen Warren */
33002464e38SStephen Warren fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
3316e06acb7SStephen Warren int node, const char *prop_name, int index, fdt_size_t *sizep,
3326e06acb7SStephen Warren bool translate);
33302464e38SStephen Warren
33402464e38SStephen Warren /*
33502464e38SStephen Warren * Look up an address property in a node and return the parsed address, and
33602464e38SStephen Warren * optionally the parsed size.
33702464e38SStephen Warren *
33802464e38SStephen Warren * This variant automatically determines the number of cells used to represent
33902464e38SStephen Warren * the address and size by parsing the parent node's #address-cells
34002464e38SStephen Warren * and #size-cells properties. The parent node is automatically found.
34102464e38SStephen Warren *
34202464e38SStephen Warren * The automatic parent lookup implemented by this function is slow.
34302464e38SStephen Warren * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
34402464e38SStephen Warren * possible.
34502464e38SStephen Warren *
34602464e38SStephen Warren * @param blob FDT blob
34702464e38SStephen Warren * @param parent parent node of @node
34802464e38SStephen Warren * @param node node to examine
34902464e38SStephen Warren * @param prop_name name of property to find
35002464e38SStephen Warren * @param index which address to retrieve from a list of addresses. Often 0.
35102464e38SStephen Warren * @param sizep a pointer to store the size into. Use NULL if not required
3526e06acb7SStephen Warren * @param translate Indicates whether to translate the returned value
3536e06acb7SStephen Warren * using the parent node's ranges property.
35402464e38SStephen Warren * @return address, if found, or FDT_ADDR_T_NONE if not
35502464e38SStephen Warren */
35602464e38SStephen Warren fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
3576e06acb7SStephen Warren const char *prop_name, int index, fdt_size_t *sizep,
3586e06acb7SStephen Warren bool translate);
35902464e38SStephen Warren
36002464e38SStephen Warren /*
36102464e38SStephen Warren * Look up an address property in a node and return the parsed address.
36202464e38SStephen Warren *
36302464e38SStephen Warren * This variant hard-codes the number of cells used to represent the address
36402464e38SStephen Warren * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
36502464e38SStephen Warren * always returns the first address value in the property (index 0).
36602464e38SStephen Warren *
36702464e38SStephen Warren * Use of this function is not recommended due to the hard-coding of cell
36802464e38SStephen Warren * counts. There is no programmatic validation that these hard-coded values
36902464e38SStephen Warren * actually match the device tree content in any way at all. This assumption
37002464e38SStephen Warren * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
37102464e38SStephen Warren * set in the U-Boot build and exercising strict control over DT content to
37202464e38SStephen Warren * ensure use of matching #address-cells/#size-cells properties. However, this
37302464e38SStephen Warren * approach is error-prone; those familiar with DT will not expect the
37402464e38SStephen Warren * assumption to exist, and could easily invalidate it. If the assumption is
37502464e38SStephen Warren * invalidated, this function will not report the issue, and debugging will
37602464e38SStephen Warren * be required. Instead, use fdtdec_get_addr_size_auto_parent().
377b5220bc6SSimon Glass *
378b5220bc6SSimon Glass * @param blob FDT blob
379b5220bc6SSimon Glass * @param node node to examine
380b5220bc6SSimon Glass * @param prop_name name of property to find
381b5220bc6SSimon Glass * @return address, if found, or FDT_ADDR_T_NONE if not
382b5220bc6SSimon Glass */
383b5220bc6SSimon Glass fdt_addr_t fdtdec_get_addr(const void *blob, int node,
384b5220bc6SSimon Glass const char *prop_name);
385b5220bc6SSimon Glass
38602464e38SStephen Warren /*
38702464e38SStephen Warren * Look up an address property in a node and return the parsed address, and
38802464e38SStephen Warren * optionally the parsed size.
38902464e38SStephen Warren *
39002464e38SStephen Warren * This variant hard-codes the number of cells used to represent the address
39102464e38SStephen Warren * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
39202464e38SStephen Warren * always returns the first address value in the property (index 0).
39302464e38SStephen Warren *
39402464e38SStephen Warren * Use of this function is not recommended due to the hard-coding of cell
39502464e38SStephen Warren * counts. There is no programmatic validation that these hard-coded values
39602464e38SStephen Warren * actually match the device tree content in any way at all. This assumption
39702464e38SStephen Warren * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
39802464e38SStephen Warren * set in the U-Boot build and exercising strict control over DT content to
39902464e38SStephen Warren * ensure use of matching #address-cells/#size-cells properties. However, this
40002464e38SStephen Warren * approach is error-prone; those familiar with DT will not expect the
40102464e38SStephen Warren * assumption to exist, and could easily invalidate it. If the assumption is
40202464e38SStephen Warren * invalidated, this function will not report the issue, and debugging will
40302464e38SStephen Warren * be required. Instead, use fdtdec_get_addr_size_auto_parent().
4044397a2a8SSimon Glass *
4054397a2a8SSimon Glass * @param blob FDT blob
4064397a2a8SSimon Glass * @param node node to examine
4074397a2a8SSimon Glass * @param prop_name name of property to find
40802464e38SStephen Warren * @param sizep a pointer to store the size into. Use NULL if not required
4094397a2a8SSimon Glass * @return address, if found, or FDT_ADDR_T_NONE if not
4104397a2a8SSimon Glass */
4114397a2a8SSimon Glass fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
4124397a2a8SSimon Glass const char *prop_name, fdt_size_t *sizep);
4134397a2a8SSimon Glass
4144397a2a8SSimon Glass /**
415a62e84d7SBin Meng * Look at an address property in a node and return the pci address which
416a62e84d7SBin Meng * corresponds to the given type in the form of fdt_pci_addr.
417a62e84d7SBin Meng * The property must hold one fdt_pci_addr with a lengh.
418a62e84d7SBin Meng *
419a62e84d7SBin Meng * @param blob FDT blob
420a62e84d7SBin Meng * @param node node to examine
421a62e84d7SBin Meng * @param type pci address type (FDT_PCI_SPACE_xxx)
422a62e84d7SBin Meng * @param prop_name name of property to find
423a62e84d7SBin Meng * @param addr returns pci address in the form of fdt_pci_addr
424106cce96SSimon Glass * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
425106cce96SSimon Glass * format of the property was invalid, -ENXIO if the requested
426106cce96SSimon Glass * address type was not found
427a62e84d7SBin Meng */
428a62e84d7SBin Meng int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
429a62e84d7SBin Meng const char *prop_name, struct fdt_pci_addr *addr);
430a62e84d7SBin Meng
431a62e84d7SBin Meng /**
432a62e84d7SBin Meng * Look at the compatible property of a device node that represents a PCI
433a62e84d7SBin Meng * device and extract pci vendor id and device id from it.
434a62e84d7SBin Meng *
435a62e84d7SBin Meng * @param blob FDT blob
436a62e84d7SBin Meng * @param node node to examine
437a62e84d7SBin Meng * @param vendor vendor id of the pci device
438a62e84d7SBin Meng * @param device device id of the pci device
439a62e84d7SBin Meng * @return 0 if ok, negative on error
440a62e84d7SBin Meng */
441a62e84d7SBin Meng int fdtdec_get_pci_vendev(const void *blob, int node,
442a62e84d7SBin Meng u16 *vendor, u16 *device);
443a62e84d7SBin Meng
444a62e84d7SBin Meng /**
445a62e84d7SBin Meng * Look at the pci address of a device node that represents a PCI device
446a62e84d7SBin Meng * and return base address of the pci device's registers.
447a62e84d7SBin Meng *
448fcc0a877SSimon Glass * @param dev device to examine
449a62e84d7SBin Meng * @param addr pci address in the form of fdt_pci_addr
450a62e84d7SBin Meng * @param bar returns base address of the pci device's registers
451a62e84d7SBin Meng * @return 0 if ok, negative on error
452a62e84d7SBin Meng */
453fcc0a877SSimon Glass int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
454fcc0a877SSimon Glass u32 *bar);
455a62e84d7SBin Meng
456a62e84d7SBin Meng /**
457b5220bc6SSimon Glass * Look up a 32-bit integer property in a node and return it. The property
458b5220bc6SSimon Glass * must have at least 4 bytes of data. The value of the first cell is
459b5220bc6SSimon Glass * returned.
460b5220bc6SSimon Glass *
461b5220bc6SSimon Glass * @param blob FDT blob
462b5220bc6SSimon Glass * @param node node to examine
463b5220bc6SSimon Glass * @param prop_name name of property to find
464b5220bc6SSimon Glass * @param default_val default value to return if the property is not found
465b5220bc6SSimon Glass * @return integer value, if found, or default_val if not
466b5220bc6SSimon Glass */
467b5220bc6SSimon Glass s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
468b5220bc6SSimon Glass s32 default_val);
469b5220bc6SSimon Glass
470b5220bc6SSimon Glass /**
471bfa3e55bSChin Liang See * Unsigned version of fdtdec_get_int. The property must have at least
472bfa3e55bSChin Liang See * 4 bytes of data. The value of the first cell is returned.
473bfa3e55bSChin Liang See *
474bfa3e55bSChin Liang See * @param blob FDT blob
475bfa3e55bSChin Liang See * @param node node to examine
476bfa3e55bSChin Liang See * @param prop_name name of property to find
477bfa3e55bSChin Liang See * @param default_val default value to return if the property is not found
478bfa3e55bSChin Liang See * @return unsigned integer value, if found, or default_val if not
479bfa3e55bSChin Liang See */
480bfa3e55bSChin Liang See unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
481bfa3e55bSChin Liang See unsigned int default_val);
482bfa3e55bSChin Liang See
483bfa3e55bSChin Liang See /**
4845f7bfdd6SSimon Glass * Get a variable-sized number from a property
4855f7bfdd6SSimon Glass *
4865f7bfdd6SSimon Glass * This reads a number from one or more cells.
4875f7bfdd6SSimon Glass *
4885f7bfdd6SSimon Glass * @param ptr Pointer to property
4895f7bfdd6SSimon Glass * @param cells Number of cells containing the number
4905f7bfdd6SSimon Glass * @return the value in the cells
4915f7bfdd6SSimon Glass */
4925f7bfdd6SSimon Glass u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
4935f7bfdd6SSimon Glass
4945f7bfdd6SSimon Glass /**
495aadef0a1SChe-Liang Chiou * Look up a 64-bit integer property in a node and return it. The property
496aadef0a1SChe-Liang Chiou * must have at least 8 bytes of data (2 cells). The first two cells are
497aadef0a1SChe-Liang Chiou * concatenated to form a 8 bytes value, where the first cell is top half and
498aadef0a1SChe-Liang Chiou * the second cell is bottom half.
499aadef0a1SChe-Liang Chiou *
500aadef0a1SChe-Liang Chiou * @param blob FDT blob
501aadef0a1SChe-Liang Chiou * @param node node to examine
502aadef0a1SChe-Liang Chiou * @param prop_name name of property to find
503aadef0a1SChe-Liang Chiou * @param default_val default value to return if the property is not found
504aadef0a1SChe-Liang Chiou * @return integer value, if found, or default_val if not
505aadef0a1SChe-Liang Chiou */
506aadef0a1SChe-Liang Chiou uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
507aadef0a1SChe-Liang Chiou uint64_t default_val);
508aadef0a1SChe-Liang Chiou
509aadef0a1SChe-Liang Chiou /**
510b5220bc6SSimon Glass * Checks whether a node is enabled.
511b5220bc6SSimon Glass * This looks for a 'status' property. If this exists, then returns 1 if
512b5220bc6SSimon Glass * the status is 'ok' and 0 otherwise. If there is no status property,
513f88fe2deSSimon Glass * it returns 1 on the assumption that anything mentioned should be enabled
514f88fe2deSSimon Glass * by default.
515b5220bc6SSimon Glass *
516b5220bc6SSimon Glass * @param blob FDT blob
517b5220bc6SSimon Glass * @param node node to examine
518f88fe2deSSimon Glass * @return integer value 0 (not enabled) or 1 (enabled)
519b5220bc6SSimon Glass */
520f88fe2deSSimon Glass int fdtdec_get_is_enabled(const void *blob, int node);
521b5220bc6SSimon Glass
522b5220bc6SSimon Glass /**
5239a263e55SSimon Glass * Make sure we have a valid fdt available to control U-Boot.
5249a263e55SSimon Glass *
5259a263e55SSimon Glass * If not, a message is printed to the console if the console is ready.
5269a263e55SSimon Glass *
5279a263e55SSimon Glass * @return 0 if all ok, -1 if not
5289a263e55SSimon Glass */
5299a263e55SSimon Glass int fdtdec_prepare_fdt(void);
5309a263e55SSimon Glass
5319a263e55SSimon Glass /**
5329a263e55SSimon Glass * Checks that we have a valid fdt available to control U-Boot.
5339a263e55SSimon Glass
5349a263e55SSimon Glass * However, if not then for the moment nothing is done, since this function
5359a263e55SSimon Glass * is called too early to panic().
5369a263e55SSimon Glass *
5379a263e55SSimon Glass * @returns 0
538b5220bc6SSimon Glass */
539b5220bc6SSimon Glass int fdtdec_check_fdt(void);
540a53f4a29SSimon Glass
541a53f4a29SSimon Glass /**
542a53f4a29SSimon Glass * Find the nodes for a peripheral and return a list of them in the correct
543a53f4a29SSimon Glass * order. This is used to enumerate all the peripherals of a certain type.
544a53f4a29SSimon Glass *
545a53f4a29SSimon Glass * To use this, optionally set up a /aliases node with alias properties for
546a53f4a29SSimon Glass * a peripheral. For example, for usb you could have:
547a53f4a29SSimon Glass *
548a53f4a29SSimon Glass * aliases {
549a53f4a29SSimon Glass * usb0 = "/ehci@c5008000";
550a53f4a29SSimon Glass * usb1 = "/ehci@c5000000";
551a53f4a29SSimon Glass * };
552a53f4a29SSimon Glass *
553a53f4a29SSimon Glass * Pass "usb" as the name to this function and will return a list of two
554a53f4a29SSimon Glass * nodes offsets: /ehci@c5008000 and ehci@c5000000.
555a53f4a29SSimon Glass *
556a53f4a29SSimon Glass * All nodes returned will match the compatible ID, as it is assumed that
557a53f4a29SSimon Glass * all peripherals use the same driver.
558a53f4a29SSimon Glass *
559a53f4a29SSimon Glass * If no alias node is found, then the node list will be returned in the
560a53f4a29SSimon Glass * order found in the fdt. If the aliases mention a node which doesn't
561a53f4a29SSimon Glass * exist, then this will be ignored. If nodes are found with no aliases,
562a53f4a29SSimon Glass * they will be added in any order.
563a53f4a29SSimon Glass *
564a53f4a29SSimon Glass * If there is a gap in the aliases, then this function return a 0 node at
565a53f4a29SSimon Glass * that position. The return value will also count these gaps.
566a53f4a29SSimon Glass *
567a53f4a29SSimon Glass * This function checks node properties and will not return nodes which are
568a53f4a29SSimon Glass * marked disabled (status = "disabled").
569a53f4a29SSimon Glass *
570a53f4a29SSimon Glass * @param blob FDT blob to use
571a53f4a29SSimon Glass * @param name Root name of alias to search for
572a53f4a29SSimon Glass * @param id Compatible ID to look for
573a53f4a29SSimon Glass * @param node_list Place to put list of found nodes
574a53f4a29SSimon Glass * @param maxcount Maximum number of nodes to find
5751cc0a9f4SRobert P. J. Day * @return number of nodes found on success, FDT_ERR_... on error
576a53f4a29SSimon Glass */
577a53f4a29SSimon Glass int fdtdec_find_aliases_for_id(const void *blob, const char *name,
578a53f4a29SSimon Glass enum fdt_compat_id id, int *node_list, int maxcount);
579a53f4a29SSimon Glass
580a53f4a29SSimon Glass /*
581c6782270SSimon Glass * This function is similar to fdtdec_find_aliases_for_id() except that it
582c6782270SSimon Glass * adds to the node_list that is passed in. Any 0 elements are considered
583c6782270SSimon Glass * available for allocation - others are considered already used and are
584c6782270SSimon Glass * skipped.
585c6782270SSimon Glass *
586c6782270SSimon Glass * You can use this by calling fdtdec_find_aliases_for_id() with an
587c6782270SSimon Glass * uninitialised array, then setting the elements that are returned to -1,
588c6782270SSimon Glass * say, then calling this function, perhaps with a different compat id.
589c6782270SSimon Glass * Any elements you get back that are >0 are new nodes added by the call
590c6782270SSimon Glass * to this function.
591c6782270SSimon Glass *
592c6782270SSimon Glass * Note that if you have some nodes with aliases and some without, you are
593c6782270SSimon Glass * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
594c6782270SSimon Glass * one compat_id may fill in positions for which you have aliases defined
595c6782270SSimon Glass * for another compat_id. When you later call *this* function with the second
596c6782270SSimon Glass * compat_id, the alias positions may already be used. A debug warning may
597c6782270SSimon Glass * be generated in this case, but it is safest to define aliases for all
598c6782270SSimon Glass * nodes when you care about the ordering.
599c6782270SSimon Glass */
600c6782270SSimon Glass int fdtdec_add_aliases_for_id(const void *blob, const char *name,
601c6782270SSimon Glass enum fdt_compat_id id, int *node_list, int maxcount);
602c6782270SSimon Glass
6035c33c9fdSSimon Glass /**
6045c33c9fdSSimon Glass * Get the alias sequence number of a node
6055c33c9fdSSimon Glass *
6065c33c9fdSSimon Glass * This works out whether a node is pointed to by an alias, and if so, the
6075c33c9fdSSimon Glass * sequence number of that alias. Aliases are of the form <base><num> where
6085c33c9fdSSimon Glass * <num> is the sequence number. For example spi2 would be sequence number
6095c33c9fdSSimon Glass * 2.
6105c33c9fdSSimon Glass *
6115c33c9fdSSimon Glass * @param blob Device tree blob (if NULL, then error is returned)
6125c33c9fdSSimon Glass * @param base Base name for alias (before the underscore)
6135c33c9fdSSimon Glass * @param node Node to look up
6145c33c9fdSSimon Glass * @param seqp This is set to the sequence number if one is found,
6155c33c9fdSSimon Glass * but otherwise the value is left alone
6165c33c9fdSSimon Glass * @return 0 if a sequence was found, -ve if not
6175c33c9fdSSimon Glass */
6185c33c9fdSSimon Glass int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
6195c33c9fdSSimon Glass int *seqp);
6205c33c9fdSSimon Glass
6213234aa4bSSimon Glass /**
622*003c9dc8SMichal Simek * Get the highest alias number for susbystem.
623*003c9dc8SMichal Simek *
624*003c9dc8SMichal Simek * It parses all aliases and find out highest recorded alias for subsystem.
625*003c9dc8SMichal Simek * Aliases are of the form <base><num> where <num> is the sequence number.
626*003c9dc8SMichal Simek *
627*003c9dc8SMichal Simek * @param blob Device tree blob (if NULL, then error is returned)
628*003c9dc8SMichal Simek * @param base Base name for alias susbystem (before the number)
629*003c9dc8SMichal Simek *
630*003c9dc8SMichal Simek * @return 0 highest alias ID, -1 if not found
631*003c9dc8SMichal Simek */
632*003c9dc8SMichal Simek int fdtdec_get_alias_highest_id(const void *blob, const char *base);
633*003c9dc8SMichal Simek
634*003c9dc8SMichal Simek /**
6353bc37a50SSimon Glass * Get a property from the /chosen node
6363bc37a50SSimon Glass *
6373bc37a50SSimon Glass * @param blob Device tree blob (if NULL, then NULL is returned)
6383bc37a50SSimon Glass * @param name Property name to look up
6393bc37a50SSimon Glass * @return Value of property, or NULL if it does not exist
6403bc37a50SSimon Glass */
6413bc37a50SSimon Glass const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
6423bc37a50SSimon Glass
6433bc37a50SSimon Glass /**
6443bc37a50SSimon Glass * Get the offset of the given /chosen node
645aac07d49SSimon Glass *
646aac07d49SSimon Glass * This looks up a property in /chosen containing the path to another node,
647aac07d49SSimon Glass * then finds the offset of that node.
648aac07d49SSimon Glass *
649aac07d49SSimon Glass * @param blob Device tree blob (if NULL, then error is returned)
650aac07d49SSimon Glass * @param name Property name, e.g. "stdout-path"
651aac07d49SSimon Glass * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
652aac07d49SSimon Glass */
653aac07d49SSimon Glass int fdtdec_get_chosen_node(const void *blob, const char *name);
654aac07d49SSimon Glass
655c6782270SSimon Glass /*
656a53f4a29SSimon Glass * Get the name for a compatible ID
657a53f4a29SSimon Glass *
658a53f4a29SSimon Glass * @param id Compatible ID to look for
659a53f4a29SSimon Glass * @return compatible string for that id
660a53f4a29SSimon Glass */
661a53f4a29SSimon Glass const char *fdtdec_get_compatible(enum fdt_compat_id id);
662d17da655SSimon Glass
663d17da655SSimon Glass /* Look up a phandle and follow it to its node. Then return the offset
664d17da655SSimon Glass * of that node.
665d17da655SSimon Glass *
666d17da655SSimon Glass * @param blob FDT blob
667d17da655SSimon Glass * @param node node to examine
668d17da655SSimon Glass * @param prop_name name of property to find
669d17da655SSimon Glass * @return node offset if found, -ve error code on error
670d17da655SSimon Glass */
671d17da655SSimon Glass int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
672d17da655SSimon Glass
673d17da655SSimon Glass /**
674d17da655SSimon Glass * Look up a property in a node and return its contents in an integer
675d17da655SSimon Glass * array of given length. The property must have at least enough data for
676d17da655SSimon Glass * the array (4*count bytes). It may have more, but this will be ignored.
677d17da655SSimon Glass *
678d17da655SSimon Glass * @param blob FDT blob
679d17da655SSimon Glass * @param node node to examine
680d17da655SSimon Glass * @param prop_name name of property to find
681d17da655SSimon Glass * @param array array to fill with data
682d17da655SSimon Glass * @param count number of array elements
683d17da655SSimon Glass * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
684d17da655SSimon Glass * or -FDT_ERR_BADLAYOUT if not enough data
685d17da655SSimon Glass */
686d17da655SSimon Glass int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
687d17da655SSimon Glass u32 *array, int count);
688d17da655SSimon Glass
689d17da655SSimon Glass /**
690a9f04d49SSimon Glass * Look up a property in a node and return its contents in an integer
691a9f04d49SSimon Glass * array of given length. The property must exist but may have less data that
692a9f04d49SSimon Glass * expected (4*count bytes). It may have more, but this will be ignored.
693a9f04d49SSimon Glass *
694a9f04d49SSimon Glass * @param blob FDT blob
695a9f04d49SSimon Glass * @param node node to examine
696a9f04d49SSimon Glass * @param prop_name name of property to find
697a9f04d49SSimon Glass * @param array array to fill with data
698a9f04d49SSimon Glass * @param count number of array elements
699a9f04d49SSimon Glass * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
700a9f04d49SSimon Glass * property is not found
701a9f04d49SSimon Glass */
702a9f04d49SSimon Glass int fdtdec_get_int_array_count(const void *blob, int node,
703a9f04d49SSimon Glass const char *prop_name, u32 *array, int count);
704a9f04d49SSimon Glass
705a9f04d49SSimon Glass /**
70696875e7dSSimon Glass * Look up a property in a node and return a pointer to its contents as a
70796875e7dSSimon Glass * unsigned int array of given length. The property must have at least enough
70896875e7dSSimon Glass * data for the array ('count' cells). It may have more, but this will be
70996875e7dSSimon Glass * ignored. The data is not copied.
71096875e7dSSimon Glass *
71196875e7dSSimon Glass * Note that you must access elements of the array with fdt32_to_cpu(),
71296875e7dSSimon Glass * since the elements will be big endian even on a little endian machine.
71396875e7dSSimon Glass *
71496875e7dSSimon Glass * @param blob FDT blob
71596875e7dSSimon Glass * @param node node to examine
71696875e7dSSimon Glass * @param prop_name name of property to find
71796875e7dSSimon Glass * @param count number of array elements
71896875e7dSSimon Glass * @return pointer to array if found, or NULL if the property is not
71996875e7dSSimon Glass * found or there is not enough data
72096875e7dSSimon Glass */
72196875e7dSSimon Glass const u32 *fdtdec_locate_array(const void *blob, int node,
72296875e7dSSimon Glass const char *prop_name, int count);
72396875e7dSSimon Glass
72496875e7dSSimon Glass /**
725d17da655SSimon Glass * Look up a boolean property in a node and return it.
726d17da655SSimon Glass *
727d17da655SSimon Glass * A boolean properly is true if present in the device tree and false if not
728d17da655SSimon Glass * present, regardless of its value.
729d17da655SSimon Glass *
730d17da655SSimon Glass * @param blob FDT blob
731d17da655SSimon Glass * @param node node to examine
732d17da655SSimon Glass * @param prop_name name of property to find
733d17da655SSimon Glass * @return 1 if the properly is present; 0 if it isn't present
734d17da655SSimon Glass */
735d17da655SSimon Glass int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
736ed3ee5cdSSimon Glass
7371889a7e2SPeng Fan /*
7381889a7e2SPeng Fan * Count child nodes of one parent node.
7391889a7e2SPeng Fan *
7401889a7e2SPeng Fan * @param blob FDT blob
7411889a7e2SPeng Fan * @param node parent node
7421889a7e2SPeng Fan * @return number of child node; 0 if there is not child node
7431889a7e2SPeng Fan */
7441889a7e2SPeng Fan int fdtdec_get_child_count(const void *blob, int node);
7451889a7e2SPeng Fan
746ed3ee5cdSSimon Glass /**
74709258f1eSAbhilash Kesavan * Look in the FDT for a config item with the given name and return its value
74809258f1eSAbhilash Kesavan * as a 32-bit integer. The property must have at least 4 bytes of data. The
74909258f1eSAbhilash Kesavan * value of the first cell is returned.
75009258f1eSAbhilash Kesavan *
75109258f1eSAbhilash Kesavan * @param blob FDT blob to use
75209258f1eSAbhilash Kesavan * @param prop_name Node property name
75309258f1eSAbhilash Kesavan * @param default_val default value to return if the property is not found
75409258f1eSAbhilash Kesavan * @return integer value, if found, or default_val if not
75509258f1eSAbhilash Kesavan */
75609258f1eSAbhilash Kesavan int fdtdec_get_config_int(const void *blob, const char *prop_name,
75709258f1eSAbhilash Kesavan int default_val);
75809258f1eSAbhilash Kesavan
759332ab0d5SSimon Glass /**
76079289c0bSGabe Black * Look in the FDT for a config item with the given name
76179289c0bSGabe Black * and return whether it exists.
76279289c0bSGabe Black *
76379289c0bSGabe Black * @param blob FDT blob
76479289c0bSGabe Black * @param prop_name property name to look up
76579289c0bSGabe Black * @return 1, if it exists, or 0 if not
76679289c0bSGabe Black */
76779289c0bSGabe Black int fdtdec_get_config_bool(const void *blob, const char *prop_name);
76879289c0bSGabe Black
76979289c0bSGabe Black /**
770332ab0d5SSimon Glass * Look in the FDT for a config item with the given name and return its value
771332ab0d5SSimon Glass * as a string.
772332ab0d5SSimon Glass *
773332ab0d5SSimon Glass * @param blob FDT blob
774332ab0d5SSimon Glass * @param prop_name property name to look up
775332ab0d5SSimon Glass * @returns property string, NULL on error.
776332ab0d5SSimon Glass */
777332ab0d5SSimon Glass char *fdtdec_get_config_string(const void *blob, const char *prop_name);
778332ab0d5SSimon Glass
779bed4d892SAnton Staff /*
780bed4d892SAnton Staff * Look up a property in a node and return its contents in a byte
781bed4d892SAnton Staff * array of given length. The property must have at least enough data for
782bed4d892SAnton Staff * the array (count bytes). It may have more, but this will be ignored.
783bed4d892SAnton Staff *
784bed4d892SAnton Staff * @param blob FDT blob
785bed4d892SAnton Staff * @param node node to examine
786bed4d892SAnton Staff * @param prop_name name of property to find
787bed4d892SAnton Staff * @param array array to fill with data
788bed4d892SAnton Staff * @param count number of array elements
789bed4d892SAnton Staff * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
790bed4d892SAnton Staff * or -FDT_ERR_BADLAYOUT if not enough data
791bed4d892SAnton Staff */
792bed4d892SAnton Staff int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
793bed4d892SAnton Staff u8 *array, int count);
794bed4d892SAnton Staff
795bed4d892SAnton Staff /**
796bed4d892SAnton Staff * Look up a property in a node and return a pointer to its contents as a
797bed4d892SAnton Staff * byte array of given length. The property must have at least enough data
798bed4d892SAnton Staff * for the array (count bytes). It may have more, but this will be ignored.
799bed4d892SAnton Staff * The data is not copied.
800bed4d892SAnton Staff *
801bed4d892SAnton Staff * @param blob FDT blob
802bed4d892SAnton Staff * @param node node to examine
803bed4d892SAnton Staff * @param prop_name name of property to find
804bed4d892SAnton Staff * @param count number of array elements
805bed4d892SAnton Staff * @return pointer to byte array if found, or NULL if the property is not
806bed4d892SAnton Staff * found or there is not enough data
807bed4d892SAnton Staff */
808bed4d892SAnton Staff const u8 *fdtdec_locate_byte_array(const void *blob, int node,
809bed4d892SAnton Staff const char *prop_name, int count);
810f20c4619SSimon Glass
811f20c4619SSimon Glass /**
81256f42242SThierry Reding * Obtain an indexed resource from a device property.
81356f42242SThierry Reding *
81456f42242SThierry Reding * @param fdt FDT blob
81556f42242SThierry Reding * @param node node to examine
81656f42242SThierry Reding * @param property name of the property to parse
81756f42242SThierry Reding * @param index index of the resource to retrieve
81856f42242SThierry Reding * @param res returns the resource
81956f42242SThierry Reding * @return 0 if ok, negative on error
82056f42242SThierry Reding */
82156f42242SThierry Reding int fdt_get_resource(const void *fdt, int node, const char *property,
82256f42242SThierry Reding unsigned int index, struct fdt_resource *res);
82356f42242SThierry Reding
82456f42242SThierry Reding /**
82556f42242SThierry Reding * Obtain a named resource from a device property.
82656f42242SThierry Reding *
82756f42242SThierry Reding * Look up the index of the name in a list of strings and return the resource
82856f42242SThierry Reding * at that index.
82956f42242SThierry Reding *
83056f42242SThierry Reding * @param fdt FDT blob
83156f42242SThierry Reding * @param node node to examine
83256f42242SThierry Reding * @param property name of the property to parse
83356f42242SThierry Reding * @param prop_names name of the property containing the list of names
83456f42242SThierry Reding * @param name the name of the entry to look up
83556f42242SThierry Reding * @param res returns the resource
83656f42242SThierry Reding */
83756f42242SThierry Reding int fdt_get_named_resource(const void *fdt, int node, const char *property,
83856f42242SThierry Reding const char *prop_names, const char *name,
83956f42242SThierry Reding struct fdt_resource *res);
84056f42242SThierry Reding
84112e67114SSimon Glass /* Display timings from linux include/video/display_timing.h */
84212e67114SSimon Glass enum display_flags {
84312e67114SSimon Glass DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
84412e67114SSimon Glass DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
84512e67114SSimon Glass DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
84612e67114SSimon Glass DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
84712e67114SSimon Glass
84812e67114SSimon Glass /* data enable flag */
84912e67114SSimon Glass DISPLAY_FLAGS_DE_LOW = 1 << 4,
85012e67114SSimon Glass DISPLAY_FLAGS_DE_HIGH = 1 << 5,
85112e67114SSimon Glass /* drive data on pos. edge */
85212e67114SSimon Glass DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
85312e67114SSimon Glass /* drive data on neg. edge */
85412e67114SSimon Glass DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
85512e67114SSimon Glass DISPLAY_FLAGS_INTERLACED = 1 << 8,
85612e67114SSimon Glass DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
85712e67114SSimon Glass DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
85812e67114SSimon Glass };
85912e67114SSimon Glass
86012e67114SSimon Glass /*
86112e67114SSimon Glass * A single signal can be specified via a range of minimal and maximal values
86212e67114SSimon Glass * with a typical value, that lies somewhere inbetween.
86312e67114SSimon Glass */
86412e67114SSimon Glass struct timing_entry {
86512e67114SSimon Glass u32 min;
86612e67114SSimon Glass u32 typ;
86712e67114SSimon Glass u32 max;
86812e67114SSimon Glass };
86912e67114SSimon Glass
87012e67114SSimon Glass /*
87112e67114SSimon Glass * Single "mode" entry. This describes one set of signal timings a display can
87212e67114SSimon Glass * have in one setting. This struct can later be converted to struct videomode
87312e67114SSimon Glass * (see include/video/videomode.h). As each timing_entry can be defined as a
87412e67114SSimon Glass * range, one struct display_timing may become multiple struct videomodes.
87512e67114SSimon Glass *
87612e67114SSimon Glass * Example: hsync active high, vsync active low
87712e67114SSimon Glass *
87812e67114SSimon Glass * Active Video
87912e67114SSimon Glass * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
88012e67114SSimon Glass * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
88112e67114SSimon Glass * | | porch | | porch |
88212e67114SSimon Glass *
88312e67114SSimon Glass * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
88412e67114SSimon Glass *
88512e67114SSimon Glass * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
88612e67114SSimon Glass */
88712e67114SSimon Glass struct display_timing {
88812e67114SSimon Glass struct timing_entry pixelclock;
88912e67114SSimon Glass
89012e67114SSimon Glass struct timing_entry hactive; /* hor. active video */
89112e67114SSimon Glass struct timing_entry hfront_porch; /* hor. front porch */
89212e67114SSimon Glass struct timing_entry hback_porch; /* hor. back porch */
89312e67114SSimon Glass struct timing_entry hsync_len; /* hor. sync len */
89412e67114SSimon Glass
89512e67114SSimon Glass struct timing_entry vactive; /* ver. active video */
89612e67114SSimon Glass struct timing_entry vfront_porch; /* ver. front porch */
89712e67114SSimon Glass struct timing_entry vback_porch; /* ver. back porch */
89812e67114SSimon Glass struct timing_entry vsync_len; /* ver. sync len */
89912e67114SSimon Glass
90012e67114SSimon Glass enum display_flags flags; /* display flags */
90143c6bdd0SJernej Skrabec bool hdmi_monitor; /* is hdmi monitor? */
90212e67114SSimon Glass };
90312e67114SSimon Glass
90412e67114SSimon Glass /**
90512e67114SSimon Glass * fdtdec_decode_display_timing() - decode display timings
90612e67114SSimon Glass *
90712e67114SSimon Glass * Decode display timings from the supplied 'display-timings' node.
90812e67114SSimon Glass * See doc/device-tree-bindings/video/display-timing.txt for binding
90912e67114SSimon Glass * information.
91012e67114SSimon Glass *
91112e67114SSimon Glass * @param blob FDT blob
91212e67114SSimon Glass * @param node 'display-timing' node containing the timing subnodes
91312e67114SSimon Glass * @param index Index number to read (0=first timing subnode)
91412e67114SSimon Glass * @param config Place to put timings
91512e67114SSimon Glass * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
91612e67114SSimon Glass */
91712e67114SSimon Glass int fdtdec_decode_display_timing(const void *blob, int node, int index,
91812e67114SSimon Glass struct display_timing *config);
919623f6019SNathan Rossi
920623f6019SNathan Rossi /**
92112308b12SSiva Durga Prasad Paladugu * fdtdec_setup_mem_size_base() - decode and setup gd->ram_size and
92212308b12SSiva Durga Prasad Paladugu * gd->ram_start
923623f6019SNathan Rossi *
92412308b12SSiva Durga Prasad Paladugu * Decode the /memory 'reg' property to determine the size and start of the
92512308b12SSiva Durga Prasad Paladugu * first memory bank, populate the global data with the size and start of the
92612308b12SSiva Durga Prasad Paladugu * first bank of memory.
927623f6019SNathan Rossi *
928623f6019SNathan Rossi * This function should be called from a boards dram_init(). This helper
92912308b12SSiva Durga Prasad Paladugu * function allows for boards to query the device tree for DRAM size and start
93012308b12SSiva Durga Prasad Paladugu * address instead of hard coding the value in the case where the memory size
93112308b12SSiva Durga Prasad Paladugu * and start address cannot be detected automatically.
932623f6019SNathan Rossi *
933623f6019SNathan Rossi * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
934623f6019SNathan Rossi * invalid
935623f6019SNathan Rossi */
93612308b12SSiva Durga Prasad Paladugu int fdtdec_setup_mem_size_base(void);
937623f6019SNathan Rossi
938623f6019SNathan Rossi /**
939623f6019SNathan Rossi * fdtdec_setup_memory_banksize() - decode and populate gd->bd->bi_dram
940623f6019SNathan Rossi *
941623f6019SNathan Rossi * Decode the /memory 'reg' property to determine the address and size of the
942623f6019SNathan Rossi * memory banks. Use this data to populate the global data board info with the
943623f6019SNathan Rossi * phys address and size of memory banks.
944623f6019SNathan Rossi *
945623f6019SNathan Rossi * This function should be called from a boards dram_init_banksize(). This
946623f6019SNathan Rossi * helper function allows for boards to query the device tree for memory bank
947623f6019SNathan Rossi * information instead of hard coding the information in cases where it cannot
948623f6019SNathan Rossi * be detected automatically.
949623f6019SNathan Rossi *
950623f6019SNathan Rossi * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
951623f6019SNathan Rossi * invalid
952623f6019SNathan Rossi */
953623f6019SNathan Rossi int fdtdec_setup_memory_banksize(void);
954623f6019SNathan Rossi
955b45122fdSSimon Glass /**
956b45122fdSSimon Glass * Set up the device tree ready for use
957b45122fdSSimon Glass */
9580879361fSSimon Glass int fdtdec_setup(void);
959b45122fdSSimon Glass
960f1d2bc90SJean-Jacques Hiblot #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
961f1d2bc90SJean-Jacques Hiblot /**
962f1d2bc90SJean-Jacques Hiblot * fdtdec_resetup() - Set up the device tree again
963f1d2bc90SJean-Jacques Hiblot *
964f1d2bc90SJean-Jacques Hiblot * The main difference with fdtdec_setup() is that it returns if the fdt has
965f1d2bc90SJean-Jacques Hiblot * changed because a better match has been found.
966f1d2bc90SJean-Jacques Hiblot * This is typically used for boards that rely on a DM driver to detect the
967f1d2bc90SJean-Jacques Hiblot * board type. This function sould be called by the board code after the stuff
968f1d2bc90SJean-Jacques Hiblot * needed by board_fit_config_name_match() to operate porperly is available.
969f1d2bc90SJean-Jacques Hiblot * If this functions signals that a rescan is necessary, the board code must
970f1d2bc90SJean-Jacques Hiblot * unbind all the drivers using dm_uninit() and then rescan the DT with
971f1d2bc90SJean-Jacques Hiblot * dm_init_and_scan().
972f1d2bc90SJean-Jacques Hiblot *
973f1d2bc90SJean-Jacques Hiblot * @param rescan Returns a flag indicating that fdt has changed and rescanning
974f1d2bc90SJean-Jacques Hiblot * the fdt is required
975f1d2bc90SJean-Jacques Hiblot *
976f1d2bc90SJean-Jacques Hiblot * @return 0 if OK, -ve on error
977f1d2bc90SJean-Jacques Hiblot */
978f1d2bc90SJean-Jacques Hiblot int fdtdec_resetup(int *rescan);
979f1d2bc90SJean-Jacques Hiblot #endif
980f1d2bc90SJean-Jacques Hiblot
98182f766d1SAlex Deymo /**
98282f766d1SAlex Deymo * Board-specific FDT initialization. Returns the address to a device tree blob.
9833b595da4SRob Clark * Called when CONFIG_OF_BOARD is defined, or if CONFIG_OF_SEPARATE is defined
9843b595da4SRob Clark * and the board implements it.
98582f766d1SAlex Deymo */
986b2364485SBaruch Siach void *board_fdt_blob_setup(void);
98790c08fa0SMichael Pratt
98890c08fa0SMichael Pratt /*
98990c08fa0SMichael Pratt * Decode the size of memory
99090c08fa0SMichael Pratt *
99190c08fa0SMichael Pratt * RAM size is normally set in a /memory node and consists of a list of
99290c08fa0SMichael Pratt * (base, size) cells in the 'reg' property. This information is used to
99390c08fa0SMichael Pratt * determine the total available memory as well as the address and size
99490c08fa0SMichael Pratt * of each bank.
99590c08fa0SMichael Pratt *
99690c08fa0SMichael Pratt * Optionally the memory configuration can vary depending on a board id,
99790c08fa0SMichael Pratt * typically read from strapping resistors or an EEPROM on the board.
99890c08fa0SMichael Pratt *
99990c08fa0SMichael Pratt * Finally, memory size can be detected (within certain limits) by probing
100090c08fa0SMichael Pratt * the available memory. It is safe to do so within the limits provides by
100190c08fa0SMichael Pratt * the board's device tree information. This makes it possible to produce
100290c08fa0SMichael Pratt * boards with different memory sizes, where the device tree specifies the
100390c08fa0SMichael Pratt * maximum memory configuration, and the smaller memory configuration is
100490c08fa0SMichael Pratt * probed.
100590c08fa0SMichael Pratt *
100690c08fa0SMichael Pratt * This function decodes that information, returning the memory base address,
100790c08fa0SMichael Pratt * size and bank information. See the memory.txt binding for full
100890c08fa0SMichael Pratt * documentation.
100990c08fa0SMichael Pratt *
101090c08fa0SMichael Pratt * @param blob Device tree blob
101190c08fa0SMichael Pratt * @param area Name of node to check (NULL means "/memory")
101290c08fa0SMichael Pratt * @param board_id Board ID to look up
101390c08fa0SMichael Pratt * @param basep Returns base address of first memory bank (NULL to
101490c08fa0SMichael Pratt * ignore)
101590c08fa0SMichael Pratt * @param sizep Returns total memory size (NULL to ignore)
101690c08fa0SMichael Pratt * @param bd Updated with the memory bank information (NULL to skip)
101790c08fa0SMichael Pratt * @return 0 if OK, -ve on error
101890c08fa0SMichael Pratt */
101990c08fa0SMichael Pratt int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id,
102090c08fa0SMichael Pratt phys_addr_t *basep, phys_size_t *sizep,
102190c08fa0SMichael Pratt struct bd_info *bd);
102282f766d1SAlex Deymo
10235bfa78dbSSimon Glass #endif
1024