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