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