blob: eda2ffaf66af62e5973ccbba6c1a149ccb0ff2ed [file] [log] [blame]
Simon Glassb5220bc2011-10-24 19:15:32 +00001/*
2 * Copyright (c) 2011 The Chromium OS Authors.
Wolfgang Denk1a459662013-07-08 09:37:19 +02003 * SPDX-License-Identifier: GPL-2.0+
Simon Glassb5220bc2011-10-24 19:15:32 +00004 */
5
Simon Glass5bfa78d2012-07-12 05:25:02 +00006#ifndef __fdtdec_h
7#define __fdtdec_h
Simon Glassb5220bc2011-10-24 19:15:32 +00008
9/*
10 * This file contains convenience functions for decoding useful and
11 * enlightening information from FDTs. It is intended to be used by device
12 * drivers and board-specific code within U-Boot. It aims to reduce the
13 * amount of FDT munging required within U-Boot itself, so that driver code
14 * changes to support FDT are minimized.
15 */
16
17#include <libfdt.h>
Bin Menga62e84d2014-12-31 16:05:11 +080018#include <pci.h>
Simon Glassb5220bc2011-10-24 19:15:32 +000019
20/*
21 * A typedef for a physical address. Note that fdt data is always big
22 * endian even on a litle endian machine.
23 */
York Sun28445aa2015-08-03 12:02:04 -070024typedef phys_addr_t fdt_addr_t;
25typedef phys_size_t fdt_size_t;
Simon Glassb5220bc2011-10-24 19:15:32 +000026#ifdef CONFIG_PHYS_64BIT
Simon Glassb5220bc2011-10-24 19:15:32 +000027#define FDT_ADDR_T_NONE (-1ULL)
28#define fdt_addr_to_cpu(reg) be64_to_cpu(reg)
Simon Glassf20c4612012-10-25 16:31:00 +000029#define fdt_size_to_cpu(reg) be64_to_cpu(reg)
Simon Glassb5220bc2011-10-24 19:15:32 +000030#else
Simon Glassb5220bc2011-10-24 19:15:32 +000031#define FDT_ADDR_T_NONE (-1U)
32#define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
Simon Glassf20c4612012-10-25 16:31:00 +000033#define fdt_size_to_cpu(reg) be32_to_cpu(reg)
Simon Glassb5220bc2011-10-24 19:15:32 +000034#endif
35
36/* Information obtained about memory from the FDT */
37struct fdt_memory {
38 fdt_addr_t start;
39 fdt_addr_t end;
40};
41
Simon Glassaf282242015-03-06 13:19:03 -070042#ifdef CONFIG_SPL_BUILD
43#define SPL_BUILD 1
44#else
45#define SPL_BUILD 0
46#endif
47
Thierry Reding56f42242014-08-26 17:33:53 +020048/*
49 * Information about a resource. start is the first address of the resource
50 * and end is the last address (inclusive). The length of the resource will
51 * be equal to: end - start + 1.
52 */
53struct fdt_resource {
54 fdt_addr_t start;
55 fdt_addr_t end;
56};
57
Bin Menga62e84d2014-12-31 16:05:11 +080058enum fdt_pci_space {
59 FDT_PCI_SPACE_CONFIG = 0,
60 FDT_PCI_SPACE_IO = 0x01000000,
61 FDT_PCI_SPACE_MEM32 = 0x02000000,
62 FDT_PCI_SPACE_MEM64 = 0x03000000,
63 FDT_PCI_SPACE_MEM32_PREF = 0x42000000,
64 FDT_PCI_SPACE_MEM64_PREF = 0x43000000,
65};
66
67#define FDT_PCI_ADDR_CELLS 3
68#define FDT_PCI_SIZE_CELLS 2
69#define FDT_PCI_REG_SIZE \
70 ((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32))
71
72/*
73 * The Open Firmware spec defines PCI physical address as follows:
74 *
75 * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
76 *
77 * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr
78 * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
79 * phys.lo cell: llllllll llllllll llllllll llllllll
80 *
81 * where:
82 *
83 * n: is 0 if the address is relocatable, 1 otherwise
84 * p: is 1 if addressable region is prefetchable, 0 otherwise
85 * t: is 1 if the address is aliased (for non-relocatable I/O) below 1MB
86 * (for Memory), or below 64KB (for relocatable I/O)
87 * ss: is the space code, denoting the address space
88 * bbbbbbbb: is the 8-bit Bus Number
89 * ddddd: is the 5-bit Device Number
90 * fff: is the 3-bit Function Number
91 * rrrrrrrr: is the 8-bit Register Number
92 * hhhhhhhh: is a 32-bit unsigned number
93 * llllllll: is a 32-bit unsigned number
94 */
95struct fdt_pci_addr {
96 u32 phys_hi;
97 u32 phys_mid;
98 u32 phys_lo;
99};
100
Thierry Reding56f42242014-08-26 17:33:53 +0200101/**
102 * Compute the size of a resource.
103 *
104 * @param res the resource to operate on
105 * @return the size of the resource
106 */
107static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
108{
109 return res->end - res->start + 1;
110}
111
Simon Glassb5220bc2011-10-24 19:15:32 +0000112/**
113 * Compat types that we know about and for which we might have drivers.
114 * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
115 * within drivers.
116 */
117enum fdt_compat_id {
118 COMPAT_UNKNOWN,
Allen Martin00a27492012-08-31 08:30:00 +0000119 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
120 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
Jim Lin312693c2012-07-29 20:53:29 +0000121 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
Simon Glass00f37322015-04-14 21:03:40 -0600122 COMPAT_NVIDIA_TEGRA124_PMC, /* Tegra 124 power mgmt controller */
Stephen Warren39f63332016-05-12 12:11:23 -0600123 COMPAT_NVIDIA_TEGRA186_SDMMC, /* Tegra186 SDMMC controller */
Tom Warren7aaa5a62015-03-04 16:36:00 -0700124 COMPAT_NVIDIA_TEGRA210_SDMMC, /* Tegra210 SDMMC controller */
Stephen Warrena73ca472014-01-24 12:46:06 -0700125 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
Tom Warrenf4e4e0b2013-03-04 14:07:18 -0700126 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
127 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
Thierry Reding79c7a902014-12-09 22:25:09 -0700128 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
129 /* Tegra124 XUSB pad controller */
Tom Warren7aaa5a62015-03-04 16:36:00 -0700130 COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
131 /* Tegra210 XUSB pad controller */
Hatim RVcc9fe332012-12-11 00:52:46 +0000132 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
133 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
Rajeshwari Shindec34253d2012-12-26 20:03:10 +0000134 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
Rajeshwari Shinde72dbff12012-12-26 20:03:16 +0000135 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
136 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
Rajeshwari Shinde6abd1622013-01-07 23:35:05 +0000137 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
Vivek Gautam108b85b2013-09-14 14:02:48 +0530138 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
Akshay Saraswat618766c2013-02-25 01:13:01 +0000139 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
Piotr Wilczekde461c52014-03-07 14:59:39 +0100140 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
Jaehoon Chung7d3ca0f2014-05-16 13:59:51 +0900141 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
Piotr Wilczek3577fe82014-03-07 14:59:41 +0100142 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
Rajeshwari Shindecd577e22013-01-08 21:03:38 +0000143 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
Simon Glassbb8215f2013-03-11 06:08:08 +0000144 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
Rajeshwari Shinde7772bb72013-02-14 19:46:15 +0000145 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
naveen krishna chatradhiecbd7e12013-04-29 15:58:52 -0700146 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
Ajay Kumar45c480c2014-09-05 16:53:33 +0530147 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
Simon Glass77f9b1f2014-11-12 22:42:21 -0700148 COMPAT_INTEL_MICROCODE, /* Intel microcode update */
Thierry Reding6173c452014-12-09 22:25:05 -0700149 COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */
Bin Mengc89ada02015-02-05 23:42:26 +0800150 COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
Marek Vasut6ab00db2015-07-25 19:33:56 +0200151 COMPAT_ALTERA_SOCFPGA_DWMAC, /* SoCFPGA Ethernet controller */
Marek Vasut129adf52015-07-25 10:48:14 +0200152 COMPAT_ALTERA_SOCFPGA_DWMMC, /* SoCFPGA DWMMC controller */
Marek Vasutef4b01b2015-12-05 19:28:44 +0100153 COMPAT_ALTERA_SOCFPGA_DWC2USB, /* SoCFPGA DWC2 USB controller */
Andrew Bradfordf3b84a32015-08-07 08:36:35 -0400154 COMPAT_INTEL_BAYTRAIL_FSP, /* Intel Bay Trail FSP */
155 COMPAT_INTEL_BAYTRAIL_FSP_MDP, /* Intel FSP memory-down params */
Bin Meng394e0b62015-12-11 02:55:44 -0800156 COMPAT_INTEL_IVYBRIDGE_FSP, /* Intel Ivy Bridge FSP */
Boris Brezillon4ccae812016-06-15 21:09:23 +0200157 COMPAT_SUNXI_NAND, /* SUNXI NAND controller */
Ley Foon Tane11b5e82017-04-05 17:32:47 +0800158 COMPAT_ALTERA_SOCFPGA_CLK, /* SoCFPGA Clock initialization */
159 COMPAT_ALTERA_SOCFPGA_PINCTRL_SINGLE, /* SoCFPGA pinctrl-single */
160 COMPAT_ALTERA_SOCFPGA_H2F_BRG, /* SoCFPGA hps2fpga bridge */
161 COMPAT_ALTERA_SOCFPGA_LWH2F_BRG, /* SoCFPGA lwhps2fpga bridge */
162 COMPAT_ALTERA_SOCFPGA_F2H_BRG, /* SoCFPGA fpga2hps bridge */
163 COMPAT_ALTERA_SOCFPGA_F2SDR0, /* SoCFPGA fpga2SDRAM0 bridge */
164 COMPAT_ALTERA_SOCFPGA_F2SDR1, /* SoCFPGA fpga2SDRAM1 bridge */
165 COMPAT_ALTERA_SOCFPGA_F2SDR2, /* SoCFPGA fpga2SDRAM2 bridge */
Simon Glassb5220bc2011-10-24 19:15:32 +0000166
167 COMPAT_COUNT,
168};
169
Simon Glass57068a72015-01-05 20:05:26 -0700170#define MAX_PHANDLE_ARGS 16
171struct fdtdec_phandle_args {
172 int node;
173 int args_count;
174 uint32_t args[MAX_PHANDLE_ARGS];
175};
176
177/**
178 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
179 *
180 * This function is useful to parse lists of phandles and their arguments.
181 *
182 * Example:
183 *
184 * phandle1: node1 {
185 * #list-cells = <2>;
186 * }
187 *
188 * phandle2: node2 {
189 * #list-cells = <1>;
190 * }
191 *
192 * node3 {
193 * list = <&phandle1 1 2 &phandle2 3>;
194 * }
195 *
196 * To get a device_node of the `node2' node you may call this:
197 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
198 * &args);
199 *
200 * (This function is a modified version of __of_parse_phandle_with_args() from
201 * Linux 3.18)
202 *
203 * @blob: Pointer to device tree
204 * @src_node: Offset of device tree node containing a list
205 * @list_name: property name that contains a list
206 * @cells_name: property name that specifies the phandles' arguments count,
207 * or NULL to use @cells_count
208 * @cells_count: Cell count to use if @cells_name is NULL
209 * @index: index of a phandle to parse out
210 * @out_args: optional pointer to output arguments structure (will be filled)
211 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
212 * @list_name does not exist, a phandle was not found, @cells_name
213 * could not be found, the arguments were truncated or there were too
214 * many arguments.
215 *
216 */
217int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
218 const char *list_name,
219 const char *cells_name,
220 int cell_count, int index,
221 struct fdtdec_phandle_args *out_args);
222
Sean Paul202ff752012-10-25 16:31:06 +0000223/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000224 * Find the next numbered alias for a peripheral. This is used to enumerate
225 * all the peripherals of a certain type.
226 *
227 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
228 * this function will return a pointer to the node the alias points to, and
229 * then update *upto to 1. Next time you call this function, the next node
230 * will be returned.
231 *
232 * All nodes returned will match the compatible ID, as it is assumed that
233 * all peripherals use the same driver.
234 *
235 * @param blob FDT blob to use
236 * @param name Root name of alias to search for
237 * @param id Compatible ID to look for
238 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
239 */
240int fdtdec_next_alias(const void *blob, const char *name,
241 enum fdt_compat_id id, int *upto);
242
243/**
Gerald Van Baren7cde3972012-11-12 23:13:54 -0500244 * Find the compatible ID for a given node.
245 *
246 * Generally each node has at least one compatible string attached to it.
247 * This function looks through our list of known compatible strings and
248 * returns the corresponding ID which matches the compatible string.
249 *
250 * @param blob FDT blob to use
251 * @param node Node containing compatible string to find
252 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
253 */
254enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
255
256/**
Simon Glassf88fe2d2012-02-27 10:52:34 +0000257 * Find the next compatible node for a peripheral.
258 *
259 * Do the first call with node = 0. This function will return a pointer to
260 * the next compatible node. Next time you call this function, pass the
261 * value returned, and the next node will be provided.
262 *
263 * @param blob FDT blob to use
264 * @param node Start node for search
265 * @param id Compatible ID to look for (enum fdt_compat_id)
266 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
267 */
268int fdtdec_next_compatible(const void *blob, int node,
269 enum fdt_compat_id id);
270
271/**
Simon Glass3ddecfc2012-04-02 13:18:42 +0000272 * Find the next compatible subnode for a peripheral.
273 *
274 * Do the first call with node set to the parent and depth = 0. This
275 * function will return the offset of the next compatible node. Next time
276 * you call this function, pass the node value returned last time, with
277 * depth unchanged, and the next node will be provided.
278 *
279 * @param blob FDT blob to use
280 * @param node Start node for search
281 * @param id Compatible ID to look for (enum fdt_compat_id)
282 * @param depthp Current depth (set to 0 before first call)
283 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
284 */
285int fdtdec_next_compatible_subnode(const void *blob, int node,
286 enum fdt_compat_id id, int *depthp);
287
Stephen Warren02464e32015-08-06 15:31:02 -0600288/*
289 * Look up an address property in a node and return the parsed address, and
290 * optionally the parsed size.
291 *
292 * This variant assumes a known and fixed number of cells are used to
293 * represent the address and size.
294 *
295 * You probably don't want to use this function directly except to parse
296 * non-standard properties, and never to parse the "reg" property. Instead,
297 * use one of the "auto" variants below, which automatically honor the
298 * #address-cells and #size-cells properties in the parent node.
299 *
300 * @param blob FDT blob
301 * @param node node to examine
302 * @param prop_name name of property to find
303 * @param index which address to retrieve from a list of addresses. Often 0.
304 * @param na the number of cells used to represent an address
305 * @param ns the number of cells used to represent a size
306 * @param sizep a pointer to store the size into. Use NULL if not required
Stephen Warren6e06acb2016-08-05 09:47:51 -0600307 * @param translate Indicates whether to translate the returned value
308 * using the parent node's ranges property.
Stephen Warren02464e32015-08-06 15:31:02 -0600309 * @return address, if found, or FDT_ADDR_T_NONE if not
310 */
311fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
312 const char *prop_name, int index, int na, int ns,
Stephen Warren6e06acb2016-08-05 09:47:51 -0600313 fdt_size_t *sizep, bool translate);
Stephen Warren02464e32015-08-06 15:31:02 -0600314
315/*
316 * Look up an address property in a node and return the parsed address, and
317 * optionally the parsed size.
318 *
319 * This variant automatically determines the number of cells used to represent
320 * the address and size by parsing the provided parent node's #address-cells
321 * and #size-cells properties.
322 *
323 * @param blob FDT blob
324 * @param parent parent node of @node
325 * @param node node to examine
326 * @param prop_name name of property to find
327 * @param index which address to retrieve from a list of addresses. Often 0.
328 * @param sizep a pointer to store the size into. Use NULL if not required
Stephen Warren6e06acb2016-08-05 09:47:51 -0600329 * @param translate Indicates whether to translate the returned value
330 * using the parent node's ranges property.
Stephen Warren02464e32015-08-06 15:31:02 -0600331 * @return address, if found, or FDT_ADDR_T_NONE if not
332 */
333fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
Stephen Warren6e06acb2016-08-05 09:47:51 -0600334 int node, const char *prop_name, int index, fdt_size_t *sizep,
335 bool translate);
Stephen Warren02464e32015-08-06 15:31:02 -0600336
337/*
338 * Look up an address property in a node and return the parsed address, and
339 * optionally the parsed size.
340 *
341 * This variant automatically determines the number of cells used to represent
342 * the address and size by parsing the parent node's #address-cells
343 * and #size-cells properties. The parent node is automatically found.
344 *
345 * The automatic parent lookup implemented by this function is slow.
346 * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
347 * possible.
348 *
349 * @param blob FDT blob
350 * @param parent parent node of @node
351 * @param node node to examine
352 * @param prop_name name of property to find
353 * @param index which address to retrieve from a list of addresses. Often 0.
354 * @param sizep a pointer to store the size into. Use NULL if not required
Stephen Warren6e06acb2016-08-05 09:47:51 -0600355 * @param translate Indicates whether to translate the returned value
356 * using the parent node's ranges property.
Stephen Warren02464e32015-08-06 15:31:02 -0600357 * @return address, if found, or FDT_ADDR_T_NONE if not
358 */
359fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
Stephen Warren6e06acb2016-08-05 09:47:51 -0600360 const char *prop_name, int index, fdt_size_t *sizep,
361 bool translate);
Stephen Warren02464e32015-08-06 15:31:02 -0600362
363/*
364 * Look up an address property in a node and return the parsed address.
365 *
366 * This variant hard-codes the number of cells used to represent the address
367 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
368 * always returns the first address value in the property (index 0).
369 *
370 * Use of this function is not recommended due to the hard-coding of cell
371 * counts. There is no programmatic validation that these hard-coded values
372 * actually match the device tree content in any way at all. This assumption
373 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
374 * set in the U-Boot build and exercising strict control over DT content to
375 * ensure use of matching #address-cells/#size-cells properties. However, this
376 * approach is error-prone; those familiar with DT will not expect the
377 * assumption to exist, and could easily invalidate it. If the assumption is
378 * invalidated, this function will not report the issue, and debugging will
379 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
Simon Glassb5220bc2011-10-24 19:15:32 +0000380 *
381 * @param blob FDT blob
382 * @param node node to examine
383 * @param prop_name name of property to find
384 * @return address, if found, or FDT_ADDR_T_NONE if not
385 */
386fdt_addr_t fdtdec_get_addr(const void *blob, int node,
387 const char *prop_name);
388
Stephen Warren02464e32015-08-06 15:31:02 -0600389/*
390 * Look up an address property in a node and return the parsed address, and
391 * optionally the parsed size.
392 *
393 * This variant hard-codes the number of cells used to represent the address
394 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
395 * always returns the first address value in the property (index 0).
396 *
397 * Use of this function is not recommended due to the hard-coding of cell
398 * counts. There is no programmatic validation that these hard-coded values
399 * actually match the device tree content in any way at all. This assumption
400 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
401 * set in the U-Boot build and exercising strict control over DT content to
402 * ensure use of matching #address-cells/#size-cells properties. However, this
403 * approach is error-prone; those familiar with DT will not expect the
404 * assumption to exist, and could easily invalidate it. If the assumption is
405 * invalidated, this function will not report the issue, and debugging will
406 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
Simon Glass4397a2a2013-03-19 04:58:51 +0000407 *
408 * @param blob FDT blob
409 * @param node node to examine
410 * @param prop_name name of property to find
Stephen Warren02464e32015-08-06 15:31:02 -0600411 * @param sizep a pointer to store the size into. Use NULL if not required
Simon Glass4397a2a2013-03-19 04:58:51 +0000412 * @return address, if found, or FDT_ADDR_T_NONE if not
413 */
414fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
415 const char *prop_name, fdt_size_t *sizep);
416
417/**
Bin Menga62e84d2014-12-31 16:05:11 +0800418 * Look at an address property in a node and return the pci address which
419 * corresponds to the given type in the form of fdt_pci_addr.
420 * The property must hold one fdt_pci_addr with a lengh.
421 *
422 * @param blob FDT blob
423 * @param node node to examine
424 * @param type pci address type (FDT_PCI_SPACE_xxx)
425 * @param prop_name name of property to find
426 * @param addr returns pci address in the form of fdt_pci_addr
Simon Glass106cce92015-03-05 12:25:19 -0700427 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
428 * format of the property was invalid, -ENXIO if the requested
429 * address type was not found
Bin Menga62e84d2014-12-31 16:05:11 +0800430 */
431int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
432 const char *prop_name, struct fdt_pci_addr *addr);
433
434/**
435 * Look at the compatible property of a device node that represents a PCI
436 * device and extract pci vendor id and device id from it.
437 *
438 * @param blob FDT blob
439 * @param node node to examine
440 * @param vendor vendor id of the pci device
441 * @param device device id of the pci device
442 * @return 0 if ok, negative on error
443 */
444int fdtdec_get_pci_vendev(const void *blob, int node,
445 u16 *vendor, u16 *device);
446
447/**
448 * Look at the pci address of a device node that represents a PCI device
Bin Menga62e84d2014-12-31 16:05:11 +0800449 * and return base address of the pci device's registers.
450 *
Simon Glassfcc0a872015-11-29 13:17:54 -0700451 * @param dev device to examine
Bin Menga62e84d2014-12-31 16:05:11 +0800452 * @param addr pci address in the form of fdt_pci_addr
453 * @param bar returns base address of the pci device's registers
454 * @return 0 if ok, negative on error
455 */
Simon Glassfcc0a872015-11-29 13:17:54 -0700456int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
457 u32 *bar);
Bin Menga62e84d2014-12-31 16:05:11 +0800458
459/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000460 * Look up a 32-bit integer property in a node and return it. The property
461 * must have at least 4 bytes of data. The value of the first cell is
462 * returned.
463 *
464 * @param blob FDT blob
465 * @param node node to examine
466 * @param prop_name name of property to find
467 * @param default_val default value to return if the property is not found
468 * @return integer value, if found, or default_val if not
469 */
470s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
471 s32 default_val);
472
473/**
Chin Liang Seebfa3e552015-10-17 08:30:32 -0500474 * Unsigned version of fdtdec_get_int. The property must have at least
475 * 4 bytes of data. The value of the first cell is returned.
476 *
477 * @param blob FDT blob
478 * @param node node to examine
479 * @param prop_name name of property to find
480 * @param default_val default value to return if the property is not found
481 * @return unsigned integer value, if found, or default_val if not
482 */
483unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
484 unsigned int default_val);
485
486/**
Simon Glass5f7bfdd2015-03-05 12:25:14 -0700487 * Get a variable-sized number from a property
488 *
489 * This reads a number from one or more cells.
490 *
491 * @param ptr Pointer to property
492 * @param cells Number of cells containing the number
493 * @return the value in the cells
494 */
495u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
496
497/**
Che-Liang Chiouaadef0a2012-10-25 16:31:05 +0000498 * Look up a 64-bit integer property in a node and return it. The property
499 * must have at least 8 bytes of data (2 cells). The first two cells are
500 * concatenated to form a 8 bytes value, where the first cell is top half and
501 * the second cell is bottom half.
502 *
503 * @param blob FDT blob
504 * @param node node to examine
505 * @param prop_name name of property to find
506 * @param default_val default value to return if the property is not found
507 * @return integer value, if found, or default_val if not
508 */
509uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
510 uint64_t default_val);
511
512/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000513 * Checks whether a node is enabled.
514 * This looks for a 'status' property. If this exists, then returns 1 if
515 * the status is 'ok' and 0 otherwise. If there is no status property,
Simon Glassf88fe2d2012-02-27 10:52:34 +0000516 * it returns 1 on the assumption that anything mentioned should be enabled
517 * by default.
Simon Glassb5220bc2011-10-24 19:15:32 +0000518 *
519 * @param blob FDT blob
520 * @param node node to examine
Simon Glassf88fe2d2012-02-27 10:52:34 +0000521 * @return integer value 0 (not enabled) or 1 (enabled)
Simon Glassb5220bc2011-10-24 19:15:32 +0000522 */
Simon Glassf88fe2d2012-02-27 10:52:34 +0000523int fdtdec_get_is_enabled(const void *blob, int node);
Simon Glassb5220bc2011-10-24 19:15:32 +0000524
525/**
Simon Glass9a263e52012-03-28 10:08:24 +0000526 * Make sure we have a valid fdt available to control U-Boot.
527 *
528 * If not, a message is printed to the console if the console is ready.
529 *
530 * @return 0 if all ok, -1 if not
531 */
532int fdtdec_prepare_fdt(void);
533
534/**
535 * Checks that we have a valid fdt available to control U-Boot.
536
537 * However, if not then for the moment nothing is done, since this function
538 * is called too early to panic().
539 *
540 * @returns 0
Simon Glassb5220bc2011-10-24 19:15:32 +0000541 */
542int fdtdec_check_fdt(void);
Simon Glassa53f4a22012-01-17 08:20:50 +0000543
544/**
545 * Find the nodes for a peripheral and return a list of them in the correct
546 * order. This is used to enumerate all the peripherals of a certain type.
547 *
548 * To use this, optionally set up a /aliases node with alias properties for
549 * a peripheral. For example, for usb you could have:
550 *
551 * aliases {
552 * usb0 = "/ehci@c5008000";
553 * usb1 = "/ehci@c5000000";
554 * };
555 *
556 * Pass "usb" as the name to this function and will return a list of two
557 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
558 *
559 * All nodes returned will match the compatible ID, as it is assumed that
560 * all peripherals use the same driver.
561 *
562 * If no alias node is found, then the node list will be returned in the
563 * order found in the fdt. If the aliases mention a node which doesn't
564 * exist, then this will be ignored. If nodes are found with no aliases,
565 * they will be added in any order.
566 *
567 * If there is a gap in the aliases, then this function return a 0 node at
568 * that position. The return value will also count these gaps.
569 *
570 * This function checks node properties and will not return nodes which are
571 * marked disabled (status = "disabled").
572 *
573 * @param blob FDT blob to use
574 * @param name Root name of alias to search for
575 * @param id Compatible ID to look for
576 * @param node_list Place to put list of found nodes
577 * @param maxcount Maximum number of nodes to find
Robert P. J. Day1cc0a9f2016-05-04 04:47:31 -0400578 * @return number of nodes found on success, FDT_ERR_... on error
Simon Glassa53f4a22012-01-17 08:20:50 +0000579 */
580int fdtdec_find_aliases_for_id(const void *blob, const char *name,
581 enum fdt_compat_id id, int *node_list, int maxcount);
582
583/*
Simon Glassc6782272012-02-03 15:13:53 +0000584 * This function is similar to fdtdec_find_aliases_for_id() except that it
585 * adds to the node_list that is passed in. Any 0 elements are considered
586 * available for allocation - others are considered already used and are
587 * skipped.
588 *
589 * You can use this by calling fdtdec_find_aliases_for_id() with an
590 * uninitialised array, then setting the elements that are returned to -1,
591 * say, then calling this function, perhaps with a different compat id.
592 * Any elements you get back that are >0 are new nodes added by the call
593 * to this function.
594 *
595 * Note that if you have some nodes with aliases and some without, you are
596 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
597 * one compat_id may fill in positions for which you have aliases defined
598 * for another compat_id. When you later call *this* function with the second
599 * compat_id, the alias positions may already be used. A debug warning may
600 * be generated in this case, but it is safest to define aliases for all
601 * nodes when you care about the ordering.
602 */
603int fdtdec_add_aliases_for_id(const void *blob, const char *name,
604 enum fdt_compat_id id, int *node_list, int maxcount);
605
Simon Glass5c33c9f2014-07-23 06:55:09 -0600606/**
607 * Get the alias sequence number of a node
608 *
609 * This works out whether a node is pointed to by an alias, and if so, the
610 * sequence number of that alias. Aliases are of the form <base><num> where
611 * <num> is the sequence number. For example spi2 would be sequence number
612 * 2.
613 *
614 * @param blob Device tree blob (if NULL, then error is returned)
615 * @param base Base name for alias (before the underscore)
616 * @param node Node to look up
617 * @param seqp This is set to the sequence number if one is found,
618 * but otherwise the value is left alone
619 * @return 0 if a sequence was found, -ve if not
620 */
621int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
622 int *seqp);
623
Simon Glass3234aa42014-07-23 06:55:16 -0600624/**
Simon Glass3bc37a52015-10-17 19:41:14 -0600625 * Get a property from the /chosen node
626 *
627 * @param blob Device tree blob (if NULL, then NULL is returned)
628 * @param name Property name to look up
629 * @return Value of property, or NULL if it does not exist
630 */
631const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
632
633/**
634 * Get the offset of the given /chosen node
Simon Glassaac07d42014-09-04 16:27:24 -0600635 *
636 * This looks up a property in /chosen containing the path to another node,
637 * then finds the offset of that node.
638 *
639 * @param blob Device tree blob (if NULL, then error is returned)
640 * @param name Property name, e.g. "stdout-path"
641 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
642 */
643int fdtdec_get_chosen_node(const void *blob, const char *name);
644
Simon Glassc6782272012-02-03 15:13:53 +0000645/*
Simon Glassa53f4a22012-01-17 08:20:50 +0000646 * Get the name for a compatible ID
647 *
648 * @param id Compatible ID to look for
649 * @return compatible string for that id
650 */
651const char *fdtdec_get_compatible(enum fdt_compat_id id);
Simon Glassd17da652012-02-27 10:52:35 +0000652
653/* Look up a phandle and follow it to its node. Then return the offset
654 * of that node.
655 *
656 * @param blob FDT blob
657 * @param node node to examine
658 * @param prop_name name of property to find
659 * @return node offset if found, -ve error code on error
660 */
661int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
662
663/**
664 * Look up a property in a node and return its contents in an integer
665 * array of given length. The property must have at least enough data for
666 * the array (4*count bytes). It may have more, but this will be ignored.
667 *
668 * @param blob FDT blob
669 * @param node node to examine
670 * @param prop_name name of property to find
671 * @param array array to fill with data
672 * @param count number of array elements
673 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
674 * or -FDT_ERR_BADLAYOUT if not enough data
675 */
676int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
677 u32 *array, int count);
678
679/**
Simon Glassa9f04d42014-11-10 18:00:19 -0700680 * Look up a property in a node and return its contents in an integer
681 * array of given length. The property must exist but may have less data that
682 * expected (4*count bytes). It may have more, but this will be ignored.
683 *
684 * @param blob FDT blob
685 * @param node node to examine
686 * @param prop_name name of property to find
687 * @param array array to fill with data
688 * @param count number of array elements
689 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
690 * property is not found
691 */
692int fdtdec_get_int_array_count(const void *blob, int node,
693 const char *prop_name, u32 *array, int count);
694
695/**
Simon Glass96875e72012-04-02 13:18:41 +0000696 * Look up a property in a node and return a pointer to its contents as a
697 * unsigned int array of given length. The property must have at least enough
698 * data for the array ('count' cells). It may have more, but this will be
699 * ignored. The data is not copied.
700 *
701 * Note that you must access elements of the array with fdt32_to_cpu(),
702 * since the elements will be big endian even on a little endian machine.
703 *
704 * @param blob FDT blob
705 * @param node node to examine
706 * @param prop_name name of property to find
707 * @param count number of array elements
708 * @return pointer to array if found, or NULL if the property is not
709 * found or there is not enough data
710 */
711const u32 *fdtdec_locate_array(const void *blob, int node,
712 const char *prop_name, int count);
713
714/**
Simon Glassd17da652012-02-27 10:52:35 +0000715 * Look up a boolean property in a node and return it.
716 *
717 * A boolean properly is true if present in the device tree and false if not
718 * present, regardless of its value.
719 *
720 * @param blob FDT blob
721 * @param node node to examine
722 * @param prop_name name of property to find
723 * @return 1 if the properly is present; 0 if it isn't present
724 */
725int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
Simon Glassed3ee5c2012-02-27 10:52:36 +0000726
Peng Fan1889a7e2016-02-01 13:31:15 +0800727/*
728 * Count child nodes of one parent node.
729 *
730 * @param blob FDT blob
731 * @param node parent node
732 * @return number of child node; 0 if there is not child node
733 */
734int fdtdec_get_child_count(const void *blob, int node);
735
Simon Glassed3ee5c2012-02-27 10:52:36 +0000736/**
Abhilash Kesavan09258f12012-10-25 16:30:58 +0000737 * Look in the FDT for a config item with the given name and return its value
738 * as a 32-bit integer. The property must have at least 4 bytes of data. The
739 * value of the first cell is returned.
740 *
741 * @param blob FDT blob to use
742 * @param prop_name Node property name
743 * @param default_val default value to return if the property is not found
744 * @return integer value, if found, or default_val if not
745 */
746int fdtdec_get_config_int(const void *blob, const char *prop_name,
747 int default_val);
748
Simon Glass332ab0d2012-10-25 16:30:59 +0000749/**
Gabe Black79289c02012-10-25 16:31:04 +0000750 * Look in the FDT for a config item with the given name
751 * and return whether it exists.
752 *
753 * @param blob FDT blob
754 * @param prop_name property name to look up
755 * @return 1, if it exists, or 0 if not
756 */
757int fdtdec_get_config_bool(const void *blob, const char *prop_name);
758
759/**
Simon Glass332ab0d2012-10-25 16:30:59 +0000760 * Look in the FDT for a config item with the given name and return its value
761 * as a string.
762 *
763 * @param blob FDT blob
764 * @param prop_name property name to look up
765 * @returns property string, NULL on error.
766 */
767char *fdtdec_get_config_string(const void *blob, const char *prop_name);
768
Anton Staffbed4d892012-04-17 09:01:28 +0000769/*
770 * Look up a property in a node and return its contents in a byte
771 * array of given length. The property must have at least enough data for
772 * the array (count bytes). It may have more, but this will be ignored.
773 *
774 * @param blob FDT blob
775 * @param node node to examine
776 * @param prop_name name of property to find
777 * @param array array to fill with data
778 * @param count number of array elements
779 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
780 * or -FDT_ERR_BADLAYOUT if not enough data
781 */
782int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
783 u8 *array, int count);
784
785/**
786 * Look up a property in a node and return a pointer to its contents as a
787 * byte array of given length. The property must have at least enough data
788 * for the array (count bytes). It may have more, but this will be ignored.
789 * The data is not copied.
790 *
791 * @param blob FDT blob
792 * @param node node to examine
793 * @param prop_name name of property to find
794 * @param count number of array elements
795 * @return pointer to byte array if found, or NULL if the property is not
796 * found or there is not enough data
797 */
798const u8 *fdtdec_locate_byte_array(const void *blob, int node,
799 const char *prop_name, int count);
Simon Glassf20c4612012-10-25 16:31:00 +0000800
801/**
802 * Look up a property in a node which contains a memory region address and
803 * size. Then return a pointer to this address.
804 *
805 * The property must hold one address with a length. This is only tested on
806 * 32-bit machines.
807 *
808 * @param blob FDT blob
809 * @param node node to examine
810 * @param prop_name name of property to find
Simon Glass76489832014-10-23 18:58:51 -0600811 * @param basep Returns base address of region
812 * @param size Returns size of region
813 * @return 0 if ok, -1 on error (property not found)
Simon Glassf20c4612012-10-25 16:31:00 +0000814 */
Simon Glass76489832014-10-23 18:58:51 -0600815int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
816 fdt_addr_t *basep, fdt_size_t *sizep);
Simon Glass006e73b2014-02-27 13:26:01 -0700817
Thierry Reding56f42242014-08-26 17:33:53 +0200818/**
819 * Obtain an indexed resource from a device property.
820 *
821 * @param fdt FDT blob
822 * @param node node to examine
823 * @param property name of the property to parse
824 * @param index index of the resource to retrieve
825 * @param res returns the resource
826 * @return 0 if ok, negative on error
827 */
828int fdt_get_resource(const void *fdt, int node, const char *property,
829 unsigned int index, struct fdt_resource *res);
830
831/**
832 * Obtain a named resource from a device property.
833 *
834 * Look up the index of the name in a list of strings and return the resource
835 * at that index.
836 *
837 * @param fdt FDT blob
838 * @param node node to examine
839 * @param property name of the property to parse
840 * @param prop_names name of the property containing the list of names
841 * @param name the name of the entry to look up
842 * @param res returns the resource
843 */
844int fdt_get_named_resource(const void *fdt, int node, const char *property,
845 const char *prop_names, const char *name,
846 struct fdt_resource *res);
847
Thierry Reding9f85eee2014-08-26 17:33:54 +0200848/**
Simon Glass26403872014-10-23 18:58:56 -0600849 * Decode a named region within a memory bank of a given type.
850 *
851 * This function handles selection of a memory region. The region is
852 * specified as an offset/size within a particular type of memory.
853 *
854 * The properties used are:
855 *
856 * <mem_type>-memory<suffix> for the name of the memory bank
857 * <mem_type>-offset<suffix> for the offset in that bank
858 *
859 * The property value must have an offset and a size. The function checks
860 * that the region is entirely within the memory bank.5
861 *
862 * @param blob FDT blob
863 * @param node Node containing the properties (-1 for /config)
864 * @param mem_type Type of memory to use, which is a name, such as
865 * "u-boot" or "kernel".
866 * @param suffix String to append to the memory/offset
867 * property names
868 * @param basep Returns base of region
869 * @param sizep Returns size of region
870 * @return 0 if OK, -ive on error
871 */
872int fdtdec_decode_memory_region(const void *blob, int node,
873 const char *mem_type, const char *suffix,
874 fdt_addr_t *basep, fdt_size_t *sizep);
Simon Glassb45122f2015-02-27 22:06:34 -0700875
Simon Glass12e67112015-04-14 21:03:21 -0600876/* Display timings from linux include/video/display_timing.h */
877enum display_flags {
878 DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
879 DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
880 DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
881 DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
882
883 /* data enable flag */
884 DISPLAY_FLAGS_DE_LOW = 1 << 4,
885 DISPLAY_FLAGS_DE_HIGH = 1 << 5,
886 /* drive data on pos. edge */
887 DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
888 /* drive data on neg. edge */
889 DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
890 DISPLAY_FLAGS_INTERLACED = 1 << 8,
891 DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
892 DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
893};
894
895/*
896 * A single signal can be specified via a range of minimal and maximal values
897 * with a typical value, that lies somewhere inbetween.
898 */
899struct timing_entry {
900 u32 min;
901 u32 typ;
902 u32 max;
903};
904
905/*
906 * Single "mode" entry. This describes one set of signal timings a display can
907 * have in one setting. This struct can later be converted to struct videomode
908 * (see include/video/videomode.h). As each timing_entry can be defined as a
909 * range, one struct display_timing may become multiple struct videomodes.
910 *
911 * Example: hsync active high, vsync active low
912 *
913 * Active Video
914 * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
915 * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
916 * | | porch | | porch |
917 *
918 * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
919 *
920 * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
921 */
922struct display_timing {
923 struct timing_entry pixelclock;
924
925 struct timing_entry hactive; /* hor. active video */
926 struct timing_entry hfront_porch; /* hor. front porch */
927 struct timing_entry hback_porch; /* hor. back porch */
928 struct timing_entry hsync_len; /* hor. sync len */
929
930 struct timing_entry vactive; /* ver. active video */
931 struct timing_entry vfront_porch; /* ver. front porch */
932 struct timing_entry vback_porch; /* ver. back porch */
933 struct timing_entry vsync_len; /* ver. sync len */
934
935 enum display_flags flags; /* display flags */
Jernej Skrabec43c6bdd2017-04-29 14:43:36 +0200936 bool hdmi_monitor; /* is hdmi monitor? */
Simon Glass12e67112015-04-14 21:03:21 -0600937};
938
939/**
940 * fdtdec_decode_display_timing() - decode display timings
941 *
942 * Decode display timings from the supplied 'display-timings' node.
943 * See doc/device-tree-bindings/video/display-timing.txt for binding
944 * information.
945 *
946 * @param blob FDT blob
947 * @param node 'display-timing' node containing the timing subnodes
948 * @param index Index number to read (0=first timing subnode)
949 * @param config Place to put timings
950 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
951 */
952int fdtdec_decode_display_timing(const void *blob, int node, int index,
953 struct display_timing *config);
Nathan Rossi623f6012016-12-19 00:03:34 +1000954
955/**
956 * fdtdec_setup_memory_size() - decode and setup gd->ram_size
957 *
958 * Decode the /memory 'reg' property to determine the size of the first memory
959 * bank, populate the global data with the size of the first bank of memory.
960 *
961 * This function should be called from a boards dram_init(). This helper
962 * function allows for boards to query the device tree for DRAM size instead of
963 * hard coding the value in the case where the memory size cannot be detected
964 * automatically.
965 *
966 * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
967 * invalid
968 */
969int fdtdec_setup_memory_size(void);
970
971/**
972 * fdtdec_setup_memory_banksize() - decode and populate gd->bd->bi_dram
973 *
974 * Decode the /memory 'reg' property to determine the address and size of the
975 * memory banks. Use this data to populate the global data board info with the
976 * phys address and size of memory banks.
977 *
978 * This function should be called from a boards dram_init_banksize(). This
979 * helper function allows for boards to query the device tree for memory bank
980 * information instead of hard coding the information in cases where it cannot
981 * be detected automatically.
982 *
983 * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
984 * invalid
985 */
986int fdtdec_setup_memory_banksize(void);
987
Simon Glassb45122f2015-02-27 22:06:34 -0700988/**
989 * Set up the device tree ready for use
990 */
Simon Glass08793612015-02-27 22:06:35 -0700991int fdtdec_setup(void);
Simon Glassb45122f2015-02-27 22:06:34 -0700992
Alex Deymo82f766d2017-04-02 01:25:20 -0700993/**
994 * Board-specific FDT initialization. Returns the address to a device tree blob.
995 * Called when CONFIG_OF_BOARD is defined.
996 */
997void *board_fdt_blob_setup(void);
998
Simon Glass5bfa78d2012-07-12 05:25:02 +0000999#endif