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