blob: d074478f1415e4c9ca73b324ef7a856dbe1c93f6 [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 */
Simon Glassb5220bc2011-10-24 19:15:32 +0000158
159 COMPAT_COUNT,
160};
161
Simon Glass57068a72015-01-05 20:05:26 -0700162#define MAX_PHANDLE_ARGS 16
163struct fdtdec_phandle_args {
164 int node;
165 int args_count;
166 uint32_t args[MAX_PHANDLE_ARGS];
167};
168
169/**
170 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
171 *
172 * This function is useful to parse lists of phandles and their arguments.
173 *
174 * Example:
175 *
176 * phandle1: node1 {
177 * #list-cells = <2>;
178 * }
179 *
180 * phandle2: node2 {
181 * #list-cells = <1>;
182 * }
183 *
184 * node3 {
185 * list = <&phandle1 1 2 &phandle2 3>;
186 * }
187 *
188 * To get a device_node of the `node2' node you may call this:
189 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
190 * &args);
191 *
192 * (This function is a modified version of __of_parse_phandle_with_args() from
193 * Linux 3.18)
194 *
195 * @blob: Pointer to device tree
196 * @src_node: Offset of device tree node containing a list
197 * @list_name: property name that contains a list
198 * @cells_name: property name that specifies the phandles' arguments count,
199 * or NULL to use @cells_count
200 * @cells_count: Cell count to use if @cells_name is NULL
201 * @index: index of a phandle to parse out
202 * @out_args: optional pointer to output arguments structure (will be filled)
203 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
204 * @list_name does not exist, a phandle was not found, @cells_name
205 * could not be found, the arguments were truncated or there were too
206 * many arguments.
207 *
208 */
209int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
210 const char *list_name,
211 const char *cells_name,
212 int cell_count, int index,
213 struct fdtdec_phandle_args *out_args);
214
Sean Paul202ff752012-10-25 16:31:06 +0000215/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000216 * Find the next numbered alias for a peripheral. This is used to enumerate
217 * all the peripherals of a certain type.
218 *
219 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
220 * this function will return a pointer to the node the alias points to, and
221 * then update *upto to 1. Next time you call this function, the next node
222 * will be returned.
223 *
224 * All nodes returned will match the compatible ID, as it is assumed that
225 * all peripherals use the same driver.
226 *
227 * @param blob FDT blob to use
228 * @param name Root name of alias to search for
229 * @param id Compatible ID to look for
230 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
231 */
232int fdtdec_next_alias(const void *blob, const char *name,
233 enum fdt_compat_id id, int *upto);
234
235/**
Gerald Van Baren7cde3972012-11-12 23:13:54 -0500236 * Find the compatible ID for a given node.
237 *
238 * Generally each node has at least one compatible string attached to it.
239 * This function looks through our list of known compatible strings and
240 * returns the corresponding ID which matches the compatible string.
241 *
242 * @param blob FDT blob to use
243 * @param node Node containing compatible string to find
244 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
245 */
246enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
247
248/**
Simon Glassf88fe2d2012-02-27 10:52:34 +0000249 * Find the next compatible node for a peripheral.
250 *
251 * Do the first call with node = 0. This function will return a pointer to
252 * the next compatible node. Next time you call this function, pass the
253 * value returned, and the next node will be provided.
254 *
255 * @param blob FDT blob to use
256 * @param node Start node for search
257 * @param id Compatible ID to look for (enum fdt_compat_id)
258 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
259 */
260int fdtdec_next_compatible(const void *blob, int node,
261 enum fdt_compat_id id);
262
263/**
Simon Glass3ddecfc2012-04-02 13:18:42 +0000264 * Find the next compatible subnode for a peripheral.
265 *
266 * Do the first call with node set to the parent and depth = 0. This
267 * function will return the offset of the next compatible node. Next time
268 * you call this function, pass the node value returned last time, with
269 * depth unchanged, and the next node will be provided.
270 *
271 * @param blob FDT blob to use
272 * @param node Start node for search
273 * @param id Compatible ID to look for (enum fdt_compat_id)
274 * @param depthp Current depth (set to 0 before first call)
275 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
276 */
277int fdtdec_next_compatible_subnode(const void *blob, int node,
278 enum fdt_compat_id id, int *depthp);
279
Stephen Warren02464e32015-08-06 15:31:02 -0600280/*
281 * Look up an address property in a node and return the parsed address, and
282 * optionally the parsed size.
283 *
284 * This variant assumes a known and fixed number of cells are used to
285 * represent the address and size.
286 *
287 * You probably don't want to use this function directly except to parse
288 * non-standard properties, and never to parse the "reg" property. Instead,
289 * use one of the "auto" variants below, which automatically honor the
290 * #address-cells and #size-cells properties in the parent node.
291 *
292 * @param blob FDT blob
293 * @param node node to examine
294 * @param prop_name name of property to find
295 * @param index which address to retrieve from a list of addresses. Often 0.
296 * @param na the number of cells used to represent an address
297 * @param ns the number of cells used to represent a size
298 * @param sizep a pointer to store the size into. Use NULL if not required
Stephen Warren6e06acb2016-08-05 09:47:51 -0600299 * @param translate Indicates whether to translate the returned value
300 * using the parent node's ranges property.
Stephen Warren02464e32015-08-06 15:31:02 -0600301 * @return address, if found, or FDT_ADDR_T_NONE if not
302 */
303fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
304 const char *prop_name, int index, int na, int ns,
Stephen Warren6e06acb2016-08-05 09:47:51 -0600305 fdt_size_t *sizep, bool translate);
Stephen Warren02464e32015-08-06 15:31:02 -0600306
307/*
308 * Look up an address property in a node and return the parsed address, and
309 * optionally the parsed size.
310 *
311 * This variant automatically determines the number of cells used to represent
312 * the address and size by parsing the provided parent node's #address-cells
313 * and #size-cells properties.
314 *
315 * @param blob FDT blob
316 * @param parent parent node of @node
317 * @param node node to examine
318 * @param prop_name name of property to find
319 * @param index which address to retrieve from a list of addresses. Often 0.
320 * @param sizep a pointer to store the size into. Use NULL if not required
Stephen Warren6e06acb2016-08-05 09:47:51 -0600321 * @param translate Indicates whether to translate the returned value
322 * using the parent node's ranges property.
Stephen Warren02464e32015-08-06 15:31:02 -0600323 * @return address, if found, or FDT_ADDR_T_NONE if not
324 */
325fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
Stephen Warren6e06acb2016-08-05 09:47:51 -0600326 int node, const char *prop_name, int index, fdt_size_t *sizep,
327 bool translate);
Stephen Warren02464e32015-08-06 15:31:02 -0600328
329/*
330 * Look up an address property in a node and return the parsed address, and
331 * optionally the parsed size.
332 *
333 * This variant automatically determines the number of cells used to represent
334 * the address and size by parsing the parent node's #address-cells
335 * and #size-cells properties. The parent node is automatically found.
336 *
337 * The automatic parent lookup implemented by this function is slow.
338 * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
339 * possible.
340 *
341 * @param blob FDT blob
342 * @param parent parent node of @node
343 * @param node node to examine
344 * @param prop_name name of property to find
345 * @param index which address to retrieve from a list of addresses. Often 0.
346 * @param sizep a pointer to store the size into. Use NULL if not required
Stephen Warren6e06acb2016-08-05 09:47:51 -0600347 * @param translate Indicates whether to translate the returned value
348 * using the parent node's ranges property.
Stephen Warren02464e32015-08-06 15:31:02 -0600349 * @return address, if found, or FDT_ADDR_T_NONE if not
350 */
351fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
Stephen Warren6e06acb2016-08-05 09:47:51 -0600352 const char *prop_name, int index, fdt_size_t *sizep,
353 bool translate);
Stephen Warren02464e32015-08-06 15:31:02 -0600354
355/*
356 * Look up an address property in a node and return the parsed address.
357 *
358 * This variant hard-codes the number of cells used to represent the address
359 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
360 * always returns the first address value in the property (index 0).
361 *
362 * Use of this function is not recommended due to the hard-coding of cell
363 * counts. There is no programmatic validation that these hard-coded values
364 * actually match the device tree content in any way at all. This assumption
365 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
366 * set in the U-Boot build and exercising strict control over DT content to
367 * ensure use of matching #address-cells/#size-cells properties. However, this
368 * approach is error-prone; those familiar with DT will not expect the
369 * assumption to exist, and could easily invalidate it. If the assumption is
370 * invalidated, this function will not report the issue, and debugging will
371 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
Simon Glassb5220bc2011-10-24 19:15:32 +0000372 *
373 * @param blob FDT blob
374 * @param node node to examine
375 * @param prop_name name of property to find
376 * @return address, if found, or FDT_ADDR_T_NONE if not
377 */
378fdt_addr_t fdtdec_get_addr(const void *blob, int node,
379 const char *prop_name);
380
Stephen Warren02464e32015-08-06 15:31:02 -0600381/*
382 * Look up an address property in a node and return the parsed address, and
383 * optionally the parsed size.
384 *
385 * This variant hard-codes the number of cells used to represent the address
386 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
387 * always returns the first address value in the property (index 0).
388 *
389 * Use of this function is not recommended due to the hard-coding of cell
390 * counts. There is no programmatic validation that these hard-coded values
391 * actually match the device tree content in any way at all. This assumption
392 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
393 * set in the U-Boot build and exercising strict control over DT content to
394 * ensure use of matching #address-cells/#size-cells properties. However, this
395 * approach is error-prone; those familiar with DT will not expect the
396 * assumption to exist, and could easily invalidate it. If the assumption is
397 * invalidated, this function will not report the issue, and debugging will
398 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
Simon Glass4397a2a2013-03-19 04:58:51 +0000399 *
400 * @param blob FDT blob
401 * @param node node to examine
402 * @param prop_name name of property to find
Stephen Warren02464e32015-08-06 15:31:02 -0600403 * @param sizep a pointer to store the size into. Use NULL if not required
Simon Glass4397a2a2013-03-19 04:58:51 +0000404 * @return address, if found, or FDT_ADDR_T_NONE if not
405 */
406fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
407 const char *prop_name, fdt_size_t *sizep);
408
409/**
Bin Menga62e84d2014-12-31 16:05:11 +0800410 * Look at an address property in a node and return the pci address which
411 * corresponds to the given type in the form of fdt_pci_addr.
412 * The property must hold one fdt_pci_addr with a lengh.
413 *
414 * @param blob FDT blob
415 * @param node node to examine
416 * @param type pci address type (FDT_PCI_SPACE_xxx)
417 * @param prop_name name of property to find
418 * @param addr returns pci address in the form of fdt_pci_addr
Simon Glass106cce92015-03-05 12:25:19 -0700419 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
420 * format of the property was invalid, -ENXIO if the requested
421 * address type was not found
Bin Menga62e84d2014-12-31 16:05:11 +0800422 */
423int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
424 const char *prop_name, struct fdt_pci_addr *addr);
425
426/**
427 * Look at the compatible property of a device node that represents a PCI
428 * device and extract pci vendor id and device id from it.
429 *
430 * @param blob FDT blob
431 * @param node node to examine
432 * @param vendor vendor id of the pci device
433 * @param device device id of the pci device
434 * @return 0 if ok, negative on error
435 */
436int fdtdec_get_pci_vendev(const void *blob, int node,
437 u16 *vendor, u16 *device);
438
439/**
440 * Look at the pci address of a device node that represents a PCI device
Bin Menga62e84d2014-12-31 16:05:11 +0800441 * and return base address of the pci device's registers.
442 *
Simon Glassfcc0a872015-11-29 13:17:54 -0700443 * @param dev device to examine
Bin Menga62e84d2014-12-31 16:05:11 +0800444 * @param addr pci address in the form of fdt_pci_addr
445 * @param bar returns base address of the pci device's registers
446 * @return 0 if ok, negative on error
447 */
Simon Glassfcc0a872015-11-29 13:17:54 -0700448int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
449 u32 *bar);
Bin Menga62e84d2014-12-31 16:05:11 +0800450
451/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000452 * Look up a 32-bit integer property in a node and return it. The property
453 * must have at least 4 bytes of data. The value of the first cell is
454 * returned.
455 *
456 * @param blob FDT blob
457 * @param node node to examine
458 * @param prop_name name of property to find
459 * @param default_val default value to return if the property is not found
460 * @return integer value, if found, or default_val if not
461 */
462s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
463 s32 default_val);
464
465/**
Chin Liang Seebfa3e552015-10-17 08:30:32 -0500466 * Unsigned version of fdtdec_get_int. The property must have at least
467 * 4 bytes of data. The value of the first cell is returned.
468 *
469 * @param blob FDT blob
470 * @param node node to examine
471 * @param prop_name name of property to find
472 * @param default_val default value to return if the property is not found
473 * @return unsigned integer value, if found, or default_val if not
474 */
475unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
476 unsigned int default_val);
477
478/**
Simon Glass5f7bfdd2015-03-05 12:25:14 -0700479 * Get a variable-sized number from a property
480 *
481 * This reads a number from one or more cells.
482 *
483 * @param ptr Pointer to property
484 * @param cells Number of cells containing the number
485 * @return the value in the cells
486 */
487u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
488
489/**
Che-Liang Chiouaadef0a2012-10-25 16:31:05 +0000490 * Look up a 64-bit integer property in a node and return it. The property
491 * must have at least 8 bytes of data (2 cells). The first two cells are
492 * concatenated to form a 8 bytes value, where the first cell is top half and
493 * the second cell is bottom half.
494 *
495 * @param blob FDT blob
496 * @param node node to examine
497 * @param prop_name name of property to find
498 * @param default_val default value to return if the property is not found
499 * @return integer value, if found, or default_val if not
500 */
501uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
502 uint64_t default_val);
503
504/**
Simon Glassb5220bc2011-10-24 19:15:32 +0000505 * Checks whether a node is enabled.
506 * This looks for a 'status' property. If this exists, then returns 1 if
507 * the status is 'ok' and 0 otherwise. If there is no status property,
Simon Glassf88fe2d2012-02-27 10:52:34 +0000508 * it returns 1 on the assumption that anything mentioned should be enabled
509 * by default.
Simon Glassb5220bc2011-10-24 19:15:32 +0000510 *
511 * @param blob FDT blob
512 * @param node node to examine
Simon Glassf88fe2d2012-02-27 10:52:34 +0000513 * @return integer value 0 (not enabled) or 1 (enabled)
Simon Glassb5220bc2011-10-24 19:15:32 +0000514 */
Simon Glassf88fe2d2012-02-27 10:52:34 +0000515int fdtdec_get_is_enabled(const void *blob, int node);
Simon Glassb5220bc2011-10-24 19:15:32 +0000516
517/**
Simon Glass9a263e52012-03-28 10:08:24 +0000518 * Make sure we have a valid fdt available to control U-Boot.
519 *
520 * If not, a message is printed to the console if the console is ready.
521 *
522 * @return 0 if all ok, -1 if not
523 */
524int fdtdec_prepare_fdt(void);
525
526/**
527 * Checks that we have a valid fdt available to control U-Boot.
528
529 * However, if not then for the moment nothing is done, since this function
530 * is called too early to panic().
531 *
532 * @returns 0
Simon Glassb5220bc2011-10-24 19:15:32 +0000533 */
534int fdtdec_check_fdt(void);
Simon Glassa53f4a22012-01-17 08:20:50 +0000535
536/**
537 * Find the nodes for a peripheral and return a list of them in the correct
538 * order. This is used to enumerate all the peripherals of a certain type.
539 *
540 * To use this, optionally set up a /aliases node with alias properties for
541 * a peripheral. For example, for usb you could have:
542 *
543 * aliases {
544 * usb0 = "/ehci@c5008000";
545 * usb1 = "/ehci@c5000000";
546 * };
547 *
548 * Pass "usb" as the name to this function and will return a list of two
549 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
550 *
551 * All nodes returned will match the compatible ID, as it is assumed that
552 * all peripherals use the same driver.
553 *
554 * If no alias node is found, then the node list will be returned in the
555 * order found in the fdt. If the aliases mention a node which doesn't
556 * exist, then this will be ignored. If nodes are found with no aliases,
557 * they will be added in any order.
558 *
559 * If there is a gap in the aliases, then this function return a 0 node at
560 * that position. The return value will also count these gaps.
561 *
562 * This function checks node properties and will not return nodes which are
563 * marked disabled (status = "disabled").
564 *
565 * @param blob FDT blob to use
566 * @param name Root name of alias to search for
567 * @param id Compatible ID to look for
568 * @param node_list Place to put list of found nodes
569 * @param maxcount Maximum number of nodes to find
Robert P. J. Day1cc0a9f2016-05-04 04:47:31 -0400570 * @return number of nodes found on success, FDT_ERR_... on error
Simon Glassa53f4a22012-01-17 08:20:50 +0000571 */
572int fdtdec_find_aliases_for_id(const void *blob, const char *name,
573 enum fdt_compat_id id, int *node_list, int maxcount);
574
575/*
Simon Glassc6782272012-02-03 15:13:53 +0000576 * This function is similar to fdtdec_find_aliases_for_id() except that it
577 * adds to the node_list that is passed in. Any 0 elements are considered
578 * available for allocation - others are considered already used and are
579 * skipped.
580 *
581 * You can use this by calling fdtdec_find_aliases_for_id() with an
582 * uninitialised array, then setting the elements that are returned to -1,
583 * say, then calling this function, perhaps with a different compat id.
584 * Any elements you get back that are >0 are new nodes added by the call
585 * to this function.
586 *
587 * Note that if you have some nodes with aliases and some without, you are
588 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
589 * one compat_id may fill in positions for which you have aliases defined
590 * for another compat_id. When you later call *this* function with the second
591 * compat_id, the alias positions may already be used. A debug warning may
592 * be generated in this case, but it is safest to define aliases for all
593 * nodes when you care about the ordering.
594 */
595int fdtdec_add_aliases_for_id(const void *blob, const char *name,
596 enum fdt_compat_id id, int *node_list, int maxcount);
597
Simon Glass5c33c9f2014-07-23 06:55:09 -0600598/**
599 * Get the alias sequence number of a node
600 *
601 * This works out whether a node is pointed to by an alias, and if so, the
602 * sequence number of that alias. Aliases are of the form <base><num> where
603 * <num> is the sequence number. For example spi2 would be sequence number
604 * 2.
605 *
606 * @param blob Device tree blob (if NULL, then error is returned)
607 * @param base Base name for alias (before the underscore)
608 * @param node Node to look up
609 * @param seqp This is set to the sequence number if one is found,
610 * but otherwise the value is left alone
611 * @return 0 if a sequence was found, -ve if not
612 */
613int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
614 int *seqp);
615
Simon Glass3234aa42014-07-23 06:55:16 -0600616/**
Simon Glass3bc37a52015-10-17 19:41:14 -0600617 * Get a property from the /chosen node
618 *
619 * @param blob Device tree blob (if NULL, then NULL is returned)
620 * @param name Property name to look up
621 * @return Value of property, or NULL if it does not exist
622 */
623const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
624
625/**
626 * Get the offset of the given /chosen node
Simon Glassaac07d42014-09-04 16:27:24 -0600627 *
628 * This looks up a property in /chosen containing the path to another node,
629 * then finds the offset of that node.
630 *
631 * @param blob Device tree blob (if NULL, then error is returned)
632 * @param name Property name, e.g. "stdout-path"
633 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
634 */
635int fdtdec_get_chosen_node(const void *blob, const char *name);
636
Simon Glassc6782272012-02-03 15:13:53 +0000637/*
Simon Glassa53f4a22012-01-17 08:20:50 +0000638 * Get the name for a compatible ID
639 *
640 * @param id Compatible ID to look for
641 * @return compatible string for that id
642 */
643const char *fdtdec_get_compatible(enum fdt_compat_id id);
Simon Glassd17da652012-02-27 10:52:35 +0000644
645/* Look up a phandle and follow it to its node. Then return the offset
646 * of that node.
647 *
648 * @param blob FDT blob
649 * @param node node to examine
650 * @param prop_name name of property to find
651 * @return node offset if found, -ve error code on error
652 */
653int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
654
655/**
656 * Look up a property in a node and return its contents in an integer
657 * array of given length. The property must have at least enough data for
658 * the array (4*count bytes). It may have more, but this will be ignored.
659 *
660 * @param blob FDT blob
661 * @param node node to examine
662 * @param prop_name name of property to find
663 * @param array array to fill with data
664 * @param count number of array elements
665 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
666 * or -FDT_ERR_BADLAYOUT if not enough data
667 */
668int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
669 u32 *array, int count);
670
671/**
Simon Glassa9f04d42014-11-10 18:00:19 -0700672 * Look up a property in a node and return its contents in an integer
673 * array of given length. The property must exist but may have less data that
674 * expected (4*count bytes). It may have more, but this will be ignored.
675 *
676 * @param blob FDT blob
677 * @param node node to examine
678 * @param prop_name name of property to find
679 * @param array array to fill with data
680 * @param count number of array elements
681 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
682 * property is not found
683 */
684int fdtdec_get_int_array_count(const void *blob, int node,
685 const char *prop_name, u32 *array, int count);
686
687/**
Simon Glass96875e72012-04-02 13:18:41 +0000688 * Look up a property in a node and return a pointer to its contents as a
689 * unsigned int array of given length. The property must have at least enough
690 * data for the array ('count' cells). It may have more, but this will be
691 * ignored. The data is not copied.
692 *
693 * Note that you must access elements of the array with fdt32_to_cpu(),
694 * since the elements will be big endian even on a little endian machine.
695 *
696 * @param blob FDT blob
697 * @param node node to examine
698 * @param prop_name name of property to find
699 * @param count number of array elements
700 * @return pointer to array if found, or NULL if the property is not
701 * found or there is not enough data
702 */
703const u32 *fdtdec_locate_array(const void *blob, int node,
704 const char *prop_name, int count);
705
706/**
Simon Glassd17da652012-02-27 10:52:35 +0000707 * Look up a boolean property in a node and return it.
708 *
709 * A boolean properly is true if present in the device tree and false if not
710 * present, regardless of its value.
711 *
712 * @param blob FDT blob
713 * @param node node to examine
714 * @param prop_name name of property to find
715 * @return 1 if the properly is present; 0 if it isn't present
716 */
717int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
Simon Glassed3ee5c2012-02-27 10:52:36 +0000718
Peng Fan1889a7e2016-02-01 13:31:15 +0800719/*
720 * Count child nodes of one parent node.
721 *
722 * @param blob FDT blob
723 * @param node parent node
724 * @return number of child node; 0 if there is not child node
725 */
726int fdtdec_get_child_count(const void *blob, int node);
727
Simon Glassed3ee5c2012-02-27 10:52:36 +0000728/**
Abhilash Kesavan09258f12012-10-25 16:30:58 +0000729 * Look in the FDT for a config item with the given name and return its value
730 * as a 32-bit integer. The property must have at least 4 bytes of data. The
731 * value of the first cell is returned.
732 *
733 * @param blob FDT blob to use
734 * @param prop_name Node property name
735 * @param default_val default value to return if the property is not found
736 * @return integer value, if found, or default_val if not
737 */
738int fdtdec_get_config_int(const void *blob, const char *prop_name,
739 int default_val);
740
Simon Glass332ab0d2012-10-25 16:30:59 +0000741/**
Gabe Black79289c02012-10-25 16:31:04 +0000742 * Look in the FDT for a config item with the given name
743 * and return whether it exists.
744 *
745 * @param blob FDT blob
746 * @param prop_name property name to look up
747 * @return 1, if it exists, or 0 if not
748 */
749int fdtdec_get_config_bool(const void *blob, const char *prop_name);
750
751/**
Simon Glass332ab0d2012-10-25 16:30:59 +0000752 * Look in the FDT for a config item with the given name and return its value
753 * as a string.
754 *
755 * @param blob FDT blob
756 * @param prop_name property name to look up
757 * @returns property string, NULL on error.
758 */
759char *fdtdec_get_config_string(const void *blob, const char *prop_name);
760
Anton Staffbed4d892012-04-17 09:01:28 +0000761/*
762 * Look up a property in a node and return its contents in a byte
763 * array of given length. The property must have at least enough data for
764 * the array (count bytes). It may have more, but this will be ignored.
765 *
766 * @param blob FDT blob
767 * @param node node to examine
768 * @param prop_name name of property to find
769 * @param array array to fill with data
770 * @param count number of array elements
771 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
772 * or -FDT_ERR_BADLAYOUT if not enough data
773 */
774int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
775 u8 *array, int count);
776
777/**
778 * Look up a property in a node and return a pointer to its contents as a
779 * byte array of given length. The property must have at least enough data
780 * for the array (count bytes). It may have more, but this will be ignored.
781 * The data is not copied.
782 *
783 * @param blob FDT blob
784 * @param node node to examine
785 * @param prop_name name of property to find
786 * @param count number of array elements
787 * @return pointer to byte array if found, or NULL if the property is not
788 * found or there is not enough data
789 */
790const u8 *fdtdec_locate_byte_array(const void *blob, int node,
791 const char *prop_name, int count);
Simon Glassf20c4612012-10-25 16:31:00 +0000792
793/**
794 * Look up a property in a node which contains a memory region address and
795 * size. Then return a pointer to this address.
796 *
797 * The property must hold one address with a length. This is only tested on
798 * 32-bit machines.
799 *
800 * @param blob FDT blob
801 * @param node node to examine
802 * @param prop_name name of property to find
Simon Glass76489832014-10-23 18:58:51 -0600803 * @param basep Returns base address of region
804 * @param size Returns size of region
805 * @return 0 if ok, -1 on error (property not found)
Simon Glassf20c4612012-10-25 16:31:00 +0000806 */
Simon Glass76489832014-10-23 18:58:51 -0600807int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
808 fdt_addr_t *basep, fdt_size_t *sizep);
Simon Glass006e73b2014-02-27 13:26:01 -0700809
Simon Glassf3cc44f2014-10-23 18:58:52 -0600810enum fmap_compress_t {
811 FMAP_COMPRESS_NONE,
812 FMAP_COMPRESS_LZO,
813};
814
815enum fmap_hash_t {
816 FMAP_HASH_NONE,
817 FMAP_HASH_SHA1,
818 FMAP_HASH_SHA256,
819};
Simon Glass006e73b2014-02-27 13:26:01 -0700820
821/* A flash map entry, containing an offset and length */
822struct fmap_entry {
823 uint32_t offset;
824 uint32_t length;
Simon Glassf3cc44f2014-10-23 18:58:52 -0600825 uint32_t used; /* Number of bytes used in region */
826 enum fmap_compress_t compress_algo; /* Compression type */
827 enum fmap_hash_t hash_algo; /* Hash algorithm */
828 const uint8_t *hash; /* Hash value */
829 int hash_size; /* Hash size */
Simon Glass006e73b2014-02-27 13:26:01 -0700830};
831
832/**
833 * Read a flash entry from the fdt
834 *
835 * @param blob FDT blob
836 * @param node Offset of node to read
837 * @param name Name of node being read
838 * @param entry Place to put offset and size of this node
839 * @return 0 if ok, -ve on error
840 */
841int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
842 struct fmap_entry *entry);
Thierry Reding56f42242014-08-26 17:33:53 +0200843
844/**
845 * Obtain an indexed resource from a device property.
846 *
847 * @param fdt FDT blob
848 * @param node node to examine
849 * @param property name of the property to parse
850 * @param index index of the resource to retrieve
851 * @param res returns the resource
852 * @return 0 if ok, negative on error
853 */
854int fdt_get_resource(const void *fdt, int node, const char *property,
855 unsigned int index, struct fdt_resource *res);
856
857/**
858 * Obtain a named resource from a device property.
859 *
860 * Look up the index of the name in a list of strings and return the resource
861 * at that index.
862 *
863 * @param fdt FDT blob
864 * @param node node to examine
865 * @param property name of the property to parse
866 * @param prop_names name of the property containing the list of names
867 * @param name the name of the entry to look up
868 * @param res returns the resource
869 */
870int fdt_get_named_resource(const void *fdt, int node, const char *property,
871 const char *prop_names, const char *name,
872 struct fdt_resource *res);
873
Thierry Reding9f85eee2014-08-26 17:33:54 +0200874/**
Simon Glass26403872014-10-23 18:58:56 -0600875 * Decode a named region within a memory bank of a given type.
876 *
877 * This function handles selection of a memory region. The region is
878 * specified as an offset/size within a particular type of memory.
879 *
880 * The properties used are:
881 *
882 * <mem_type>-memory<suffix> for the name of the memory bank
883 * <mem_type>-offset<suffix> for the offset in that bank
884 *
885 * The property value must have an offset and a size. The function checks
886 * that the region is entirely within the memory bank.5
887 *
888 * @param blob FDT blob
889 * @param node Node containing the properties (-1 for /config)
890 * @param mem_type Type of memory to use, which is a name, such as
891 * "u-boot" or "kernel".
892 * @param suffix String to append to the memory/offset
893 * property names
894 * @param basep Returns base of region
895 * @param sizep Returns size of region
896 * @return 0 if OK, -ive on error
897 */
898int fdtdec_decode_memory_region(const void *blob, int node,
899 const char *mem_type, const char *suffix,
900 fdt_addr_t *basep, fdt_size_t *sizep);
Simon Glassb45122f2015-02-27 22:06:34 -0700901
Simon Glass12e67112015-04-14 21:03:21 -0600902/* Display timings from linux include/video/display_timing.h */
903enum display_flags {
904 DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
905 DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
906 DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
907 DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
908
909 /* data enable flag */
910 DISPLAY_FLAGS_DE_LOW = 1 << 4,
911 DISPLAY_FLAGS_DE_HIGH = 1 << 5,
912 /* drive data on pos. edge */
913 DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
914 /* drive data on neg. edge */
915 DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
916 DISPLAY_FLAGS_INTERLACED = 1 << 8,
917 DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
918 DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
919};
920
921/*
922 * A single signal can be specified via a range of minimal and maximal values
923 * with a typical value, that lies somewhere inbetween.
924 */
925struct timing_entry {
926 u32 min;
927 u32 typ;
928 u32 max;
929};
930
931/*
932 * Single "mode" entry. This describes one set of signal timings a display can
933 * have in one setting. This struct can later be converted to struct videomode
934 * (see include/video/videomode.h). As each timing_entry can be defined as a
935 * range, one struct display_timing may become multiple struct videomodes.
936 *
937 * Example: hsync active high, vsync active low
938 *
939 * Active Video
940 * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
941 * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
942 * | | porch | | porch |
943 *
944 * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
945 *
946 * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
947 */
948struct display_timing {
949 struct timing_entry pixelclock;
950
951 struct timing_entry hactive; /* hor. active video */
952 struct timing_entry hfront_porch; /* hor. front porch */
953 struct timing_entry hback_porch; /* hor. back porch */
954 struct timing_entry hsync_len; /* hor. sync len */
955
956 struct timing_entry vactive; /* ver. active video */
957 struct timing_entry vfront_porch; /* ver. front porch */
958 struct timing_entry vback_porch; /* ver. back porch */
959 struct timing_entry vsync_len; /* ver. sync len */
960
961 enum display_flags flags; /* display flags */
962};
963
964/**
965 * fdtdec_decode_display_timing() - decode display timings
966 *
967 * Decode display timings from the supplied 'display-timings' node.
968 * See doc/device-tree-bindings/video/display-timing.txt for binding
969 * information.
970 *
971 * @param blob FDT blob
972 * @param node 'display-timing' node containing the timing subnodes
973 * @param index Index number to read (0=first timing subnode)
974 * @param config Place to put timings
975 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
976 */
977int fdtdec_decode_display_timing(const void *blob, int node, int index,
978 struct display_timing *config);
Nathan Rossi623f6012016-12-19 00:03:34 +1000979
980/**
981 * fdtdec_setup_memory_size() - decode and setup gd->ram_size
982 *
983 * Decode the /memory 'reg' property to determine the size of the first memory
984 * bank, populate the global data with the size of the first bank of memory.
985 *
986 * This function should be called from a boards dram_init(). This helper
987 * function allows for boards to query the device tree for DRAM size instead of
988 * hard coding the value in the case where the memory size cannot be detected
989 * automatically.
990 *
991 * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
992 * invalid
993 */
994int fdtdec_setup_memory_size(void);
995
996/**
997 * fdtdec_setup_memory_banksize() - decode and populate gd->bd->bi_dram
998 *
999 * Decode the /memory 'reg' property to determine the address and size of the
1000 * memory banks. Use this data to populate the global data board info with the
1001 * phys address and size of memory banks.
1002 *
1003 * This function should be called from a boards dram_init_banksize(). This
1004 * helper function allows for boards to query the device tree for memory bank
1005 * information instead of hard coding the information in cases where it cannot
1006 * be detected automatically.
1007 *
1008 * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
1009 * invalid
1010 */
1011int fdtdec_setup_memory_banksize(void);
1012
Simon Glassb45122f2015-02-27 22:06:34 -07001013/**
1014 * Set up the device tree ready for use
1015 */
Simon Glass08793612015-02-27 22:06:35 -07001016int fdtdec_setup(void);
Simon Glassb45122f2015-02-27 22:06:34 -07001017
Simon Glass5bfa78d2012-07-12 05:25:02 +00001018#endif