blob: 7fe657d0a0cdbad0d14fb810abfeff8af8fe0893 [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 Glasse1ae0d12012-10-17 13:24:49 +0000122 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */
Simon Glass00f37322015-04-14 21:03:40 -0600123 COMPAT_NVIDIA_TEGRA124_DC, /* Tegra 124 Display controller */
124 COMPAT_NVIDIA_TEGRA124_SOR, /* Tegra 124 Serial Output Resource */
125 COMPAT_NVIDIA_TEGRA124_PMC, /* Tegra 124 power mgmt controller */
Wei Ni87540de2012-10-17 13:24:50 +0000126 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */
Tom Warren7aaa5a62015-03-04 16:36:00 -0700127 COMPAT_NVIDIA_TEGRA210_SDMMC, /* Tegra210 SDMMC controller */
Stephen Warrena73ca472014-01-24 12:46:06 -0700128 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
Tom Warrenf4e4e0b2013-03-04 14:07:18 -0700129 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
130 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
Thierry Reding79c7a902014-12-09 22:25:09 -0700131 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
132 /* Tegra124 XUSB pad controller */
Tom Warren7aaa5a62015-03-04 16:36:00 -0700133 COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
134 /* Tegra210 XUSB pad controller */
Hatim RVcc9fe332012-12-11 00:52:46 +0000135 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
136 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
Rajeshwari Shindec34253d2012-12-26 20:03:10 +0000137 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
Rajeshwari Shinde72dbff12012-12-26 20:03:16 +0000138 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
139 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
Hung-ying Tyan713cb682013-05-15 18:27:32 +0800140 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */
Rajeshwari Shinde6abd1622013-01-07 23:35:05 +0000141 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
Vivek Gautam108b85b2013-09-14 14:02:48 +0530142 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
Akshay Saraswat618766c2013-02-25 01:13:01 +0000143 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
Ajay Kumard7377b52013-02-21 23:53:00 +0000144 COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */
Piotr Wilczekde461c52014-03-07 14:59:39 +0100145 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
Ajay Kumar1e4706a2013-02-21 23:53:05 +0000146 COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */
Jaehoon Chung7d3ca0f2014-05-16 13:59:51 +0900147 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
Piotr Wilczek3577fe82014-03-07 14:59:41 +0100148 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
Rajeshwari Shindeee1e3c22013-06-24 16:47:20 +0530149 COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */
Rajeshwari Shindecd577e22013-01-08 21:03:38 +0000150 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
Simon Glassbb8215f2013-03-11 06:08:08 +0000151 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
Rajeshwari Shinde7772bb72013-02-14 19:46:15 +0000152 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
naveen krishna chatradhiecbd7e12013-04-29 15:58:52 -0700153 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
Simon Glass7d95f2a2014-02-27 13:26:19 -0700154 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */
Ajay Kumar45c480c2014-09-05 16:53:33 +0530155 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
Simon Glass77f9b1f2014-11-12 22:42:21 -0700156 COMPAT_INTEL_MICROCODE, /* Intel microcode update */
Simon Glass65dd74a2014-11-12 22:42:28 -0700157 COMPAT_MEMORY_SPD, /* Memory SPD information */
Simon Glass3ac83932014-11-14 18:18:38 -0700158 COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */
Simon Glassbb80be32014-11-24 21:18:16 -0700159 COMPAT_INTEL_MODEL_206AX, /* Intel Model 206AX CPU */
Simon Glasseffcf062014-11-14 20:56:36 -0700160 COMPAT_INTEL_GMA, /* Intel Graphics Media Accelerator */
Thierry Reding6173c452014-12-09 22:25:05 -0700161 COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */
Simon Glass5da38082015-01-19 22:16:06 -0700162 COMPAT_INTEL_ICH_SPI, /* Intel ICH7/9 SPI controller */
Bin Mengc89ada02015-02-05 23:42:26 +0800163 COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
Gabriel Huau5318f182015-05-25 22:27:37 -0700164 COMPAT_INTEL_X86_PINCTRL, /* Intel ICH7/9 pin control */
Masahiro Yamada6462cde2015-03-11 15:54:46 +0900165 COMPAT_SOCIONEXT_XHCI, /* Socionext UniPhier xHCI */
Simon Glass90b16d12015-03-26 09:29:29 -0600166 COMPAT_INTEL_PCH, /* Intel PCH */
Bin Meng9c7dea62015-05-25 22:35:04 +0800167 COMPAT_INTEL_IRQ_ROUTER, /* Intel Interrupt Router */
Marek Vasut6ab00db2015-07-25 19:33:56 +0200168 COMPAT_ALTERA_SOCFPGA_DWMAC, /* SoCFPGA Ethernet controller */
Marek Vasut129adf52015-07-25 10:48:14 +0200169 COMPAT_ALTERA_SOCFPGA_DWMMC, /* SoCFPGA DWMMC controller */
Andrew Bradfordf3b84a32015-08-07 08:36:35 -0400170 COMPAT_INTEL_BAYTRAIL_FSP, /* Intel Bay Trail FSP */
171 COMPAT_INTEL_BAYTRAIL_FSP_MDP, /* Intel FSP memory-down params */
Simon Glassb5220bc2011-10-24 19:15:32 +0000172
173 COMPAT_COUNT,
174};
175
Simon Glass57068a72015-01-05 20:05:26 -0700176#define MAX_PHANDLE_ARGS 16
177struct fdtdec_phandle_args {
178 int node;
179 int args_count;
180 uint32_t args[MAX_PHANDLE_ARGS];
181};
182
183/**
184 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
185 *
186 * This function is useful to parse lists of phandles and their arguments.
187 *
188 * Example:
189 *
190 * phandle1: node1 {
191 * #list-cells = <2>;
192 * }
193 *
194 * phandle2: node2 {
195 * #list-cells = <1>;
196 * }
197 *
198 * node3 {
199 * list = <&phandle1 1 2 &phandle2 3>;
200 * }
201 *
202 * To get a device_node of the `node2' node you may call this:
203 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
204 * &args);
205 *
206 * (This function is a modified version of __of_parse_phandle_with_args() from
207 * Linux 3.18)
208 *
209 * @blob: Pointer to device tree
210 * @src_node: Offset of device tree node containing a list
211 * @list_name: property name that contains a list
212 * @cells_name: property name that specifies the phandles' arguments count,
213 * or NULL to use @cells_count
214 * @cells_count: Cell count to use if @cells_name is NULL
215 * @index: index of a phandle to parse out
216 * @out_args: optional pointer to output arguments structure (will be filled)
217 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
218 * @list_name does not exist, a phandle was not found, @cells_name
219 * could not be found, the arguments were truncated or there were too
220 * many arguments.
221 *
222 */
223int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
224 const char *list_name,
225 const char *cells_name,
226 int cell_count, int index,
227 struct fdtdec_phandle_args *out_args);
228
Sean Paul202ff752012-10-25 16:31:06 +0000229/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000230 * Find the next numbered alias for a peripheral. This is used to enumerate
231 * all the peripherals of a certain type.
232 *
233 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
234 * this function will return a pointer to the node the alias points to, and
235 * then update *upto to 1. Next time you call this function, the next node
236 * will be returned.
237 *
238 * All nodes returned will match the compatible ID, as it is assumed that
239 * all peripherals use the same driver.
240 *
241 * @param blob FDT blob to use
242 * @param name Root name of alias to search for
243 * @param id Compatible ID to look for
244 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
245 */
246int fdtdec_next_alias(const void *blob, const char *name,
247 enum fdt_compat_id id, int *upto);
248
249/**
Gerald Van Baren7cde3972012-11-12 23:13:54 -0500250 * Find the compatible ID for a given node.
251 *
252 * Generally each node has at least one compatible string attached to it.
253 * This function looks through our list of known compatible strings and
254 * returns the corresponding ID which matches the compatible string.
255 *
256 * @param blob FDT blob to use
257 * @param node Node containing compatible string to find
258 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
259 */
260enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
261
262/**
Simon Glassf88fe2d2012-02-27 10:52:34 +0000263 * Find the next compatible node for a peripheral.
264 *
265 * Do the first call with node = 0. This function will return a pointer to
266 * the next compatible node. Next time you call this function, pass the
267 * value returned, and the next node will be provided.
268 *
269 * @param blob FDT blob to use
270 * @param node Start node for search
271 * @param id Compatible ID to look for (enum fdt_compat_id)
272 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
273 */
274int fdtdec_next_compatible(const void *blob, int node,
275 enum fdt_compat_id id);
276
277/**
Simon Glass3ddecfc2012-04-02 13:18:42 +0000278 * Find the next compatible subnode for a peripheral.
279 *
280 * Do the first call with node set to the parent and depth = 0. This
281 * function will return the offset of the next compatible node. Next time
282 * you call this function, pass the node value returned last time, with
283 * depth unchanged, and the next node will be provided.
284 *
285 * @param blob FDT blob to use
286 * @param node Start node for search
287 * @param id Compatible ID to look for (enum fdt_compat_id)
288 * @param depthp Current depth (set to 0 before first call)
289 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
290 */
291int fdtdec_next_compatible_subnode(const void *blob, int node,
292 enum fdt_compat_id id, int *depthp);
293
Stephen Warren02464e32015-08-06 15:31:02 -0600294/*
295 * Look up an address property in a node and return the parsed address, and
296 * optionally the parsed size.
297 *
298 * This variant assumes a known and fixed number of cells are used to
299 * represent the address and size.
300 *
301 * You probably don't want to use this function directly except to parse
302 * non-standard properties, and never to parse the "reg" property. Instead,
303 * use one of the "auto" variants below, which automatically honor the
304 * #address-cells and #size-cells properties in the parent node.
305 *
306 * @param blob FDT blob
307 * @param node node to examine
308 * @param prop_name name of property to find
309 * @param index which address to retrieve from a list of addresses. Often 0.
310 * @param na the number of cells used to represent an address
311 * @param ns the number of cells used to represent a size
312 * @param sizep a pointer to store the size into. Use NULL if not required
313 * @return address, if found, or FDT_ADDR_T_NONE if not
314 */
315fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
316 const char *prop_name, int index, int na, int ns,
317 fdt_size_t *sizep);
318
319/*
320 * Look up an address property in a node and return the parsed address, and
321 * optionally the parsed size.
322 *
323 * This variant automatically determines the number of cells used to represent
324 * the address and size by parsing the provided parent node's #address-cells
325 * and #size-cells properties.
326 *
327 * @param blob FDT blob
328 * @param parent parent node of @node
329 * @param node node to examine
330 * @param prop_name name of property to find
331 * @param index which address to retrieve from a list of addresses. Often 0.
332 * @param sizep a pointer to store the size into. Use NULL if not required
333 * @return address, if found, or FDT_ADDR_T_NONE if not
334 */
335fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
336 int node, const char *prop_name, int index, fdt_size_t *sizep);
337
338/*
339 * Look up an address property in a node and return the parsed address, and
340 * optionally the parsed size.
341 *
342 * This variant automatically determines the number of cells used to represent
343 * the address and size by parsing the parent node's #address-cells
344 * and #size-cells properties. The parent node is automatically found.
345 *
346 * The automatic parent lookup implemented by this function is slow.
347 * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
348 * possible.
349 *
350 * @param blob FDT blob
351 * @param parent parent node of @node
352 * @param node node to examine
353 * @param prop_name name of property to find
354 * @param index which address to retrieve from a list of addresses. Often 0.
355 * @param sizep a pointer to store the size into. Use NULL if not required
356 * @return address, if found, or FDT_ADDR_T_NONE if not
357 */
358fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
359 const char *prop_name, int index, fdt_size_t *sizep);
360
361/*
362 * Look up an address property in a node and return the parsed address.
363 *
364 * This variant hard-codes the number of cells used to represent the address
365 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
366 * always returns the first address value in the property (index 0).
367 *
368 * Use of this function is not recommended due to the hard-coding of cell
369 * counts. There is no programmatic validation that these hard-coded values
370 * actually match the device tree content in any way at all. This assumption
371 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
372 * set in the U-Boot build and exercising strict control over DT content to
373 * ensure use of matching #address-cells/#size-cells properties. However, this
374 * approach is error-prone; those familiar with DT will not expect the
375 * assumption to exist, and could easily invalidate it. If the assumption is
376 * invalidated, this function will not report the issue, and debugging will
377 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
Simon Glassb5220bc2011-10-24 19:15:32 +0000378 *
379 * @param blob FDT blob
380 * @param node node to examine
381 * @param prop_name name of property to find
382 * @return address, if found, or FDT_ADDR_T_NONE if not
383 */
384fdt_addr_t fdtdec_get_addr(const void *blob, int node,
385 const char *prop_name);
386
Stephen Warren02464e32015-08-06 15:31:02 -0600387/*
388 * Look up an address property in a node and return the parsed address, and
389 * optionally the parsed size.
390 *
391 * This variant hard-codes the number of cells used to represent the address
392 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
393 * always returns the first address value in the property (index 0).
394 *
395 * Use of this function is not recommended due to the hard-coding of cell
396 * counts. There is no programmatic validation that these hard-coded values
397 * actually match the device tree content in any way at all. This assumption
398 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
399 * set in the U-Boot build and exercising strict control over DT content to
400 * ensure use of matching #address-cells/#size-cells properties. However, this
401 * approach is error-prone; those familiar with DT will not expect the
402 * assumption to exist, and could easily invalidate it. If the assumption is
403 * invalidated, this function will not report the issue, and debugging will
404 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
Simon Glass4397a2a2013-03-19 04:58:51 +0000405 *
406 * @param blob FDT blob
407 * @param node node to examine
408 * @param prop_name name of property to find
Stephen Warren02464e32015-08-06 15:31:02 -0600409 * @param sizep a pointer to store the size into. Use NULL if not required
Simon Glass4397a2a2013-03-19 04:58:51 +0000410 * @return address, if found, or FDT_ADDR_T_NONE if not
411 */
412fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
413 const char *prop_name, fdt_size_t *sizep);
414
415/**
Bin Menga62e84d2014-12-31 16:05:11 +0800416 * Look at an address property in a node and return the pci address which
417 * corresponds to the given type in the form of fdt_pci_addr.
418 * The property must hold one fdt_pci_addr with a lengh.
419 *
420 * @param blob FDT blob
421 * @param node node to examine
422 * @param type pci address type (FDT_PCI_SPACE_xxx)
423 * @param prop_name name of property to find
424 * @param addr returns pci address in the form of fdt_pci_addr
Simon Glass106cce92015-03-05 12:25:19 -0700425 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
426 * format of the property was invalid, -ENXIO if the requested
427 * address type was not found
Bin Menga62e84d2014-12-31 16:05:11 +0800428 */
429int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
430 const char *prop_name, struct fdt_pci_addr *addr);
431
432/**
433 * Look at the compatible property of a device node that represents a PCI
434 * device and extract pci vendor id and device id from it.
435 *
436 * @param blob FDT blob
437 * @param node node to examine
438 * @param vendor vendor id of the pci device
439 * @param device device id of the pci device
440 * @return 0 if ok, negative on error
441 */
442int fdtdec_get_pci_vendev(const void *blob, int node,
443 u16 *vendor, u16 *device);
444
445/**
446 * Look at the pci address of a device node that represents a PCI device
Bin Meng0eb9dc72015-03-04 15:08:26 +0800447 * and parse the bus, device and function number from it. For some cases
448 * like the bus number encoded in reg property is not correct after pci
449 * enumeration, this function looks through the node's compatible strings
450 * to get these numbers extracted instead.
Bin Menga62e84d2014-12-31 16:05:11 +0800451 *
452 * @param blob FDT blob
453 * @param node node to examine
454 * @param addr pci address in the form of fdt_pci_addr
455 * @param bdf returns bus, device, function triplet
456 * @return 0 if ok, negative on error
457 */
458int fdtdec_get_pci_bdf(const void *blob, int node,
459 struct fdt_pci_addr *addr, pci_dev_t *bdf);
460
461/**
462 * Look at the pci address of a device node that represents a PCI device
463 * and return base address of the pci device's registers.
464 *
465 * @param blob FDT blob
466 * @param node node to examine
467 * @param addr pci address in the form of fdt_pci_addr
468 * @param bar returns base address of the pci device's registers
469 * @return 0 if ok, negative on error
470 */
471int fdtdec_get_pci_bar32(const void *blob, int node,
472 struct fdt_pci_addr *addr, u32 *bar);
473
474/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000475 * Look up a 32-bit integer property in a node and return it. The property
476 * must have at least 4 bytes of data. The value of the first cell is
477 * returned.
478 *
479 * @param blob FDT blob
480 * @param node node to examine
481 * @param prop_name name of property to find
482 * @param default_val default value to return if the property is not found
483 * @return integer value, if found, or default_val if not
484 */
485s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
486 s32 default_val);
487
488/**
Chin Liang Seebfa3e552015-10-17 08:30:32 -0500489 * Unsigned version of fdtdec_get_int. The property must have at least
490 * 4 bytes of data. The value of the first cell is returned.
491 *
492 * @param blob FDT blob
493 * @param node node to examine
494 * @param prop_name name of property to find
495 * @param default_val default value to return if the property is not found
496 * @return unsigned integer value, if found, or default_val if not
497 */
498unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
499 unsigned int default_val);
500
501/**
Simon Glass5f7bfdd2015-03-05 12:25:14 -0700502 * Get a variable-sized number from a property
503 *
504 * This reads a number from one or more cells.
505 *
506 * @param ptr Pointer to property
507 * @param cells Number of cells containing the number
508 * @return the value in the cells
509 */
510u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
511
512/**
Che-Liang Chiouaadef0a2012-10-25 16:31:05 +0000513 * Look up a 64-bit integer property in a node and return it. The property
514 * must have at least 8 bytes of data (2 cells). The first two cells are
515 * concatenated to form a 8 bytes value, where the first cell is top half and
516 * the second cell is bottom half.
517 *
518 * @param blob FDT blob
519 * @param node node to examine
520 * @param prop_name name of property to find
521 * @param default_val default value to return if the property is not found
522 * @return integer value, if found, or default_val if not
523 */
524uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
525 uint64_t default_val);
526
527/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000528 * Checks whether a node is enabled.
529 * This looks for a 'status' property. If this exists, then returns 1 if
530 * the status is 'ok' and 0 otherwise. If there is no status property,
Simon Glassf88fe2d2012-02-27 10:52:34 +0000531 * it returns 1 on the assumption that anything mentioned should be enabled
532 * by default.
Simon Glassb5220bc2011-10-24 19:15:32 +0000533 *
534 * @param blob FDT blob
535 * @param node node to examine
Simon Glassf88fe2d2012-02-27 10:52:34 +0000536 * @return integer value 0 (not enabled) or 1 (enabled)
Simon Glassb5220bc2011-10-24 19:15:32 +0000537 */
Simon Glassf88fe2d2012-02-27 10:52:34 +0000538int fdtdec_get_is_enabled(const void *blob, int node);
Simon Glassb5220bc2011-10-24 19:15:32 +0000539
540/**
Simon Glass9a263e52012-03-28 10:08:24 +0000541 * Make sure we have a valid fdt available to control U-Boot.
542 *
543 * If not, a message is printed to the console if the console is ready.
544 *
545 * @return 0 if all ok, -1 if not
546 */
547int fdtdec_prepare_fdt(void);
548
549/**
550 * Checks that we have a valid fdt available to control U-Boot.
551
552 * However, if not then for the moment nothing is done, since this function
553 * is called too early to panic().
554 *
555 * @returns 0
Simon Glassb5220bc2011-10-24 19:15:32 +0000556 */
557int fdtdec_check_fdt(void);
Simon Glassa53f4a22012-01-17 08:20:50 +0000558
559/**
560 * Find the nodes for a peripheral and return a list of them in the correct
561 * order. This is used to enumerate all the peripherals of a certain type.
562 *
563 * To use this, optionally set up a /aliases node with alias properties for
564 * a peripheral. For example, for usb you could have:
565 *
566 * aliases {
567 * usb0 = "/ehci@c5008000";
568 * usb1 = "/ehci@c5000000";
569 * };
570 *
571 * Pass "usb" as the name to this function and will return a list of two
572 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
573 *
574 * All nodes returned will match the compatible ID, as it is assumed that
575 * all peripherals use the same driver.
576 *
577 * If no alias node is found, then the node list will be returned in the
578 * order found in the fdt. If the aliases mention a node which doesn't
579 * exist, then this will be ignored. If nodes are found with no aliases,
580 * they will be added in any order.
581 *
582 * If there is a gap in the aliases, then this function return a 0 node at
583 * that position. The return value will also count these gaps.
584 *
585 * This function checks node properties and will not return nodes which are
586 * marked disabled (status = "disabled").
587 *
588 * @param blob FDT blob to use
589 * @param name Root name of alias to search for
590 * @param id Compatible ID to look for
591 * @param node_list Place to put list of found nodes
592 * @param maxcount Maximum number of nodes to find
593 * @return number of nodes found on success, FTD_ERR_... on error
594 */
595int fdtdec_find_aliases_for_id(const void *blob, const char *name,
596 enum fdt_compat_id id, int *node_list, int maxcount);
597
598/*
Simon Glassc6782272012-02-03 15:13:53 +0000599 * This function is similar to fdtdec_find_aliases_for_id() except that it
600 * adds to the node_list that is passed in. Any 0 elements are considered
601 * available for allocation - others are considered already used and are
602 * skipped.
603 *
604 * You can use this by calling fdtdec_find_aliases_for_id() with an
605 * uninitialised array, then setting the elements that are returned to -1,
606 * say, then calling this function, perhaps with a different compat id.
607 * Any elements you get back that are >0 are new nodes added by the call
608 * to this function.
609 *
610 * Note that if you have some nodes with aliases and some without, you are
611 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
612 * one compat_id may fill in positions for which you have aliases defined
613 * for another compat_id. When you later call *this* function with the second
614 * compat_id, the alias positions may already be used. A debug warning may
615 * be generated in this case, but it is safest to define aliases for all
616 * nodes when you care about the ordering.
617 */
618int fdtdec_add_aliases_for_id(const void *blob, const char *name,
619 enum fdt_compat_id id, int *node_list, int maxcount);
620
Simon Glass5c33c9f2014-07-23 06:55:09 -0600621/**
622 * Get the alias sequence number of a node
623 *
624 * This works out whether a node is pointed to by an alias, and if so, the
625 * sequence number of that alias. Aliases are of the form <base><num> where
626 * <num> is the sequence number. For example spi2 would be sequence number
627 * 2.
628 *
629 * @param blob Device tree blob (if NULL, then error is returned)
630 * @param base Base name for alias (before the underscore)
631 * @param node Node to look up
632 * @param seqp This is set to the sequence number if one is found,
633 * but otherwise the value is left alone
634 * @return 0 if a sequence was found, -ve if not
635 */
636int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
637 int *seqp);
638
Simon Glass3234aa42014-07-23 06:55:16 -0600639/**
Simon Glass3bc37a52015-10-17 19:41:14 -0600640 * Get a property from the /chosen node
641 *
642 * @param blob Device tree blob (if NULL, then NULL is returned)
643 * @param name Property name to look up
644 * @return Value of property, or NULL if it does not exist
645 */
646const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
647
648/**
649 * Get the offset of the given /chosen node
Simon Glassaac07d42014-09-04 16:27:24 -0600650 *
651 * This looks up a property in /chosen containing the path to another node,
652 * then finds the offset of that node.
653 *
654 * @param blob Device tree blob (if NULL, then error is returned)
655 * @param name Property name, e.g. "stdout-path"
656 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
657 */
658int fdtdec_get_chosen_node(const void *blob, const char *name);
659
Simon Glassc6782272012-02-03 15:13:53 +0000660/*
Simon Glassa53f4a22012-01-17 08:20:50 +0000661 * Get the name for a compatible ID
662 *
663 * @param id Compatible ID to look for
664 * @return compatible string for that id
665 */
666const char *fdtdec_get_compatible(enum fdt_compat_id id);
Simon Glassd17da652012-02-27 10:52:35 +0000667
668/* Look up a phandle and follow it to its node. Then return the offset
669 * of that node.
670 *
671 * @param blob FDT blob
672 * @param node node to examine
673 * @param prop_name name of property to find
674 * @return node offset if found, -ve error code on error
675 */
676int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
677
678/**
679 * Look up a property in a node and return its contents in an integer
680 * array of given length. The property must have at least enough data for
681 * the array (4*count bytes). It may have more, but this will be ignored.
682 *
683 * @param blob FDT blob
684 * @param node node to examine
685 * @param prop_name name of property to find
686 * @param array array to fill with data
687 * @param count number of array elements
688 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
689 * or -FDT_ERR_BADLAYOUT if not enough data
690 */
691int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
692 u32 *array, int count);
693
694/**
Simon Glassa9f04d42014-11-10 18:00:19 -0700695 * Look up a property in a node and return its contents in an integer
696 * array of given length. The property must exist but may have less data that
697 * expected (4*count bytes). It may have more, but this will be ignored.
698 *
699 * @param blob FDT blob
700 * @param node node to examine
701 * @param prop_name name of property to find
702 * @param array array to fill with data
703 * @param count number of array elements
704 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
705 * property is not found
706 */
707int fdtdec_get_int_array_count(const void *blob, int node,
708 const char *prop_name, u32 *array, int count);
709
710/**
Simon Glass96875e72012-04-02 13:18:41 +0000711 * Look up a property in a node and return a pointer to its contents as a
712 * unsigned int array of given length. The property must have at least enough
713 * data for the array ('count' cells). It may have more, but this will be
714 * ignored. The data is not copied.
715 *
716 * Note that you must access elements of the array with fdt32_to_cpu(),
717 * since the elements will be big endian even on a little endian machine.
718 *
719 * @param blob FDT blob
720 * @param node node to examine
721 * @param prop_name name of property to find
722 * @param count number of array elements
723 * @return pointer to array if found, or NULL if the property is not
724 * found or there is not enough data
725 */
726const u32 *fdtdec_locate_array(const void *blob, int node,
727 const char *prop_name, int count);
728
729/**
Simon Glassd17da652012-02-27 10:52:35 +0000730 * Look up a boolean property in a node and return it.
731 *
732 * A boolean properly is true if present in the device tree and false if not
733 * present, regardless of its value.
734 *
735 * @param blob FDT blob
736 * @param node node to examine
737 * @param prop_name name of property to find
738 * @return 1 if the properly is present; 0 if it isn't present
739 */
740int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
Simon Glassed3ee5c2012-02-27 10:52:36 +0000741
742/**
Abhilash Kesavan09258f12012-10-25 16:30:58 +0000743 * Look in the FDT for a config item with the given name and return its value
744 * as a 32-bit integer. The property must have at least 4 bytes of data. The
745 * value of the first cell is returned.
746 *
747 * @param blob FDT blob to use
748 * @param prop_name Node property name
749 * @param default_val default value to return if the property is not found
750 * @return integer value, if found, or default_val if not
751 */
752int fdtdec_get_config_int(const void *blob, const char *prop_name,
753 int default_val);
754
Simon Glass332ab0d2012-10-25 16:30:59 +0000755/**
Gabe Black79289c02012-10-25 16:31:04 +0000756 * Look in the FDT for a config item with the given name
757 * and return whether it exists.
758 *
759 * @param blob FDT blob
760 * @param prop_name property name to look up
761 * @return 1, if it exists, or 0 if not
762 */
763int fdtdec_get_config_bool(const void *blob, const char *prop_name);
764
765/**
Simon Glass332ab0d2012-10-25 16:30:59 +0000766 * Look in the FDT for a config item with the given name and return its value
767 * as a string.
768 *
769 * @param blob FDT blob
770 * @param prop_name property name to look up
771 * @returns property string, NULL on error.
772 */
773char *fdtdec_get_config_string(const void *blob, const char *prop_name);
774
Anton Staffbed4d892012-04-17 09:01:28 +0000775/*
776 * Look up a property in a node and return its contents in a byte
777 * array of given length. The property must have at least enough data for
778 * the array (count bytes). It may have more, but this will be ignored.
779 *
780 * @param blob FDT blob
781 * @param node node to examine
782 * @param prop_name name of property to find
783 * @param array array to fill with data
784 * @param count number of array elements
785 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
786 * or -FDT_ERR_BADLAYOUT if not enough data
787 */
788int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
789 u8 *array, int count);
790
791/**
792 * Look up a property in a node and return a pointer to its contents as a
793 * byte array of given length. The property must have at least enough data
794 * for the array (count bytes). It may have more, but this will be ignored.
795 * The data is not copied.
796 *
797 * @param blob FDT blob
798 * @param node node to examine
799 * @param prop_name name of property to find
800 * @param count number of array elements
801 * @return pointer to byte array if found, or NULL if the property is not
802 * found or there is not enough data
803 */
804const u8 *fdtdec_locate_byte_array(const void *blob, int node,
805 const char *prop_name, int count);
Simon Glassf20c4612012-10-25 16:31:00 +0000806
807/**
808 * Look up a property in a node which contains a memory region address and
809 * size. Then return a pointer to this address.
810 *
811 * The property must hold one address with a length. This is only tested on
812 * 32-bit machines.
813 *
814 * @param blob FDT blob
815 * @param node node to examine
816 * @param prop_name name of property to find
Simon Glass76489832014-10-23 18:58:51 -0600817 * @param basep Returns base address of region
818 * @param size Returns size of region
819 * @return 0 if ok, -1 on error (property not found)
Simon Glassf20c4612012-10-25 16:31:00 +0000820 */
Simon Glass76489832014-10-23 18:58:51 -0600821int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
822 fdt_addr_t *basep, fdt_size_t *sizep);
Simon Glass006e73b2014-02-27 13:26:01 -0700823
Simon Glassf3cc44f2014-10-23 18:58:52 -0600824enum fmap_compress_t {
825 FMAP_COMPRESS_NONE,
826 FMAP_COMPRESS_LZO,
827};
828
829enum fmap_hash_t {
830 FMAP_HASH_NONE,
831 FMAP_HASH_SHA1,
832 FMAP_HASH_SHA256,
833};
Simon Glass006e73b2014-02-27 13:26:01 -0700834
835/* A flash map entry, containing an offset and length */
836struct fmap_entry {
837 uint32_t offset;
838 uint32_t length;
Simon Glassf3cc44f2014-10-23 18:58:52 -0600839 uint32_t used; /* Number of bytes used in region */
840 enum fmap_compress_t compress_algo; /* Compression type */
841 enum fmap_hash_t hash_algo; /* Hash algorithm */
842 const uint8_t *hash; /* Hash value */
843 int hash_size; /* Hash size */
Simon Glass006e73b2014-02-27 13:26:01 -0700844};
845
846/**
847 * Read a flash entry from the fdt
848 *
849 * @param blob FDT blob
850 * @param node Offset of node to read
851 * @param name Name of node being read
852 * @param entry Place to put offset and size of this node
853 * @return 0 if ok, -ve on error
854 */
855int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
856 struct fmap_entry *entry);
Thierry Reding56f42242014-08-26 17:33:53 +0200857
858/**
859 * Obtain an indexed resource from a device property.
860 *
861 * @param fdt FDT blob
862 * @param node node to examine
863 * @param property name of the property to parse
864 * @param index index of the resource to retrieve
865 * @param res returns the resource
866 * @return 0 if ok, negative on error
867 */
868int fdt_get_resource(const void *fdt, int node, const char *property,
869 unsigned int index, struct fdt_resource *res);
870
871/**
872 * Obtain a named resource from a device property.
873 *
874 * Look up the index of the name in a list of strings and return the resource
875 * at that index.
876 *
877 * @param fdt FDT blob
878 * @param node node to examine
879 * @param property name of the property to parse
880 * @param prop_names name of the property containing the list of names
881 * @param name the name of the entry to look up
882 * @param res returns the resource
883 */
884int fdt_get_named_resource(const void *fdt, int node, const char *property,
885 const char *prop_names, const char *name,
886 struct fdt_resource *res);
887
Thierry Reding9f85eee2014-08-26 17:33:54 +0200888/**
Simon Glass26403872014-10-23 18:58:56 -0600889 * Decode a named region within a memory bank of a given type.
890 *
891 * This function handles selection of a memory region. The region is
892 * specified as an offset/size within a particular type of memory.
893 *
894 * The properties used are:
895 *
896 * <mem_type>-memory<suffix> for the name of the memory bank
897 * <mem_type>-offset<suffix> for the offset in that bank
898 *
899 * The property value must have an offset and a size. The function checks
900 * that the region is entirely within the memory bank.5
901 *
902 * @param blob FDT blob
903 * @param node Node containing the properties (-1 for /config)
904 * @param mem_type Type of memory to use, which is a name, such as
905 * "u-boot" or "kernel".
906 * @param suffix String to append to the memory/offset
907 * property names
908 * @param basep Returns base of region
909 * @param sizep Returns size of region
910 * @return 0 if OK, -ive on error
911 */
912int fdtdec_decode_memory_region(const void *blob, int node,
913 const char *mem_type, const char *suffix,
914 fdt_addr_t *basep, fdt_size_t *sizep);
Simon Glassb45122f2015-02-27 22:06:34 -0700915
Simon Glass12e67112015-04-14 21:03:21 -0600916/* Display timings from linux include/video/display_timing.h */
917enum display_flags {
918 DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
919 DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
920 DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
921 DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
922
923 /* data enable flag */
924 DISPLAY_FLAGS_DE_LOW = 1 << 4,
925 DISPLAY_FLAGS_DE_HIGH = 1 << 5,
926 /* drive data on pos. edge */
927 DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
928 /* drive data on neg. edge */
929 DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
930 DISPLAY_FLAGS_INTERLACED = 1 << 8,
931 DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
932 DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
933};
934
935/*
936 * A single signal can be specified via a range of minimal and maximal values
937 * with a typical value, that lies somewhere inbetween.
938 */
939struct timing_entry {
940 u32 min;
941 u32 typ;
942 u32 max;
943};
944
945/*
946 * Single "mode" entry. This describes one set of signal timings a display can
947 * have in one setting. This struct can later be converted to struct videomode
948 * (see include/video/videomode.h). As each timing_entry can be defined as a
949 * range, one struct display_timing may become multiple struct videomodes.
950 *
951 * Example: hsync active high, vsync active low
952 *
953 * Active Video
954 * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
955 * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
956 * | | porch | | porch |
957 *
958 * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
959 *
960 * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
961 */
962struct display_timing {
963 struct timing_entry pixelclock;
964
965 struct timing_entry hactive; /* hor. active video */
966 struct timing_entry hfront_porch; /* hor. front porch */
967 struct timing_entry hback_porch; /* hor. back porch */
968 struct timing_entry hsync_len; /* hor. sync len */
969
970 struct timing_entry vactive; /* ver. active video */
971 struct timing_entry vfront_porch; /* ver. front porch */
972 struct timing_entry vback_porch; /* ver. back porch */
973 struct timing_entry vsync_len; /* ver. sync len */
974
975 enum display_flags flags; /* display flags */
976};
977
978/**
979 * fdtdec_decode_display_timing() - decode display timings
980 *
981 * Decode display timings from the supplied 'display-timings' node.
982 * See doc/device-tree-bindings/video/display-timing.txt for binding
983 * information.
984 *
985 * @param blob FDT blob
986 * @param node 'display-timing' node containing the timing subnodes
987 * @param index Index number to read (0=first timing subnode)
988 * @param config Place to put timings
989 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
990 */
991int fdtdec_decode_display_timing(const void *blob, int node, int index,
992 struct display_timing *config);
Simon Glassb45122f2015-02-27 22:06:34 -0700993/**
994 * Set up the device tree ready for use
995 */
Simon Glass08793612015-02-27 22:06:35 -0700996int fdtdec_setup(void);
Simon Glassb45122f2015-02-27 22:06:34 -0700997
Simon Glass5bfa78d2012-07-12 05:25:02 +0000998#endif