0cb6fa0075028ecc08f44c7e0d9a463a9c7ae0ce
[karo-tx-uboot.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 #else
31 #define FDT_ADDR_T_NONE (-1U)
32 #define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
33 #define fdt_size_to_cpu(reg) be32_to_cpu(reg)
34 #endif
35
36 /* Information obtained about memory from the FDT */
37 struct fdt_memory {
38         fdt_addr_t start;
39         fdt_addr_t end;
40 };
41
42 #ifdef CONFIG_SPL_BUILD
43 #define SPL_BUILD       1
44 #else
45 #define SPL_BUILD       0
46 #endif
47
48 /*
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  */
53 struct fdt_resource {
54         fdt_addr_t start;
55         fdt_addr_t end;
56 };
57
58 enum 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  */
95 struct fdt_pci_addr {
96         u32     phys_hi;
97         u32     phys_mid;
98         u32     phys_lo;
99 };
100
101 /**
102  * Compute the size of a resource.
103  *
104  * @param res   the resource to operate on
105  * @return the size of the resource
106  */
107 static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
108 {
109         return res->end - res->start + 1;
110 }
111
112 /**
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  */
117 enum fdt_compat_id {
118         COMPAT_UNKNOWN,
119         COMPAT_NVIDIA_TEGRA20_EMC,      /* Tegra20 memory controller */
120         COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
121         COMPAT_NVIDIA_TEGRA20_KBC,      /* Tegra20 Keyboard */
122         COMPAT_NVIDIA_TEGRA20_NAND,     /* Tegra2 NAND controller */
123         COMPAT_NVIDIA_TEGRA20_PWM,      /* Tegra 2 PWM controller */
124         COMPAT_NVIDIA_TEGRA124_DC,      /* Tegra 124 Display controller */
125         COMPAT_NVIDIA_TEGRA124_SOR,     /* Tegra 124 Serial Output Resource */
126         COMPAT_NVIDIA_TEGRA124_PMC,     /* Tegra 124 power mgmt controller */
127         COMPAT_NVIDIA_TEGRA20_DC,       /* Tegra 2 Display controller */
128         COMPAT_NVIDIA_TEGRA210_SDMMC,   /* Tegra210 SDMMC controller */
129         COMPAT_NVIDIA_TEGRA124_SDMMC,   /* Tegra124 SDMMC controller */
130         COMPAT_NVIDIA_TEGRA30_SDMMC,    /* Tegra30 SDMMC controller */
131         COMPAT_NVIDIA_TEGRA20_SDMMC,    /* Tegra20 SDMMC controller */
132         COMPAT_NVIDIA_TEGRA124_PCIE,    /* Tegra 124 PCIe controller */
133         COMPAT_NVIDIA_TEGRA30_PCIE,     /* Tegra 30 PCIe controller */
134         COMPAT_NVIDIA_TEGRA20_PCIE,     /* Tegra 20 PCIe controller */
135         COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
136                                         /* Tegra124 XUSB pad controller */
137         COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
138                                         /* Tegra210 XUSB pad controller */
139         COMPAT_SMSC_LAN9215,            /* SMSC 10/100 Ethernet LAN9215 */
140         COMPAT_SAMSUNG_EXYNOS5_SROMC,   /* Exynos5 SROMC */
141         COMPAT_SAMSUNG_S3C2440_I2C,     /* Exynos I2C Controller */
142         COMPAT_SAMSUNG_EXYNOS5_SOUND,   /* Exynos Sound */
143         COMPAT_WOLFSON_WM8994_CODEC,    /* Wolfson WM8994 Sound Codec */
144         COMPAT_GOOGLE_CROS_EC_KEYB,     /* Google CROS_EC Keyboard */
145         COMPAT_SAMSUNG_EXYNOS_USB_PHY,  /* Exynos phy controller for usb2.0 */
146         COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
147         COMPAT_SAMSUNG_EXYNOS_TMU,      /* Exynos TMU */
148         COMPAT_SAMSUNG_EXYNOS_FIMD,     /* Exynos Display controller */
149         COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
150         COMPAT_SAMSUNG_EXYNOS5_DP,      /* Exynos Display port controller */
151         COMPAT_SAMSUNG_EXYNOS_DWMMC,    /* Exynos DWMMC controller */
152         COMPAT_SAMSUNG_EXYNOS_MMC,      /* Exynos MMC controller */
153         COMPAT_SAMSUNG_EXYNOS_SERIAL,   /* Exynos UART */
154         COMPAT_MAXIM_MAX77686_PMIC,     /* MAX77686 PMIC */
155         COMPAT_GENERIC_SPI_FLASH,       /* Generic SPI Flash chip */
156         COMPAT_MAXIM_98095_CODEC,       /* MAX98095 Codec */
157         COMPAT_INFINEON_SLB9635_TPM,    /* Infineon SLB9635 TPM */
158         COMPAT_INFINEON_SLB9645_TPM,    /* Infineon SLB9645 TPM */
159         COMPAT_SAMSUNG_EXYNOS5_I2C,     /* Exynos5 High Speed I2C Controller */
160         COMPAT_SANDBOX_LCD_SDL,         /* Sandbox LCD emulation with SDL */
161         COMPAT_SAMSUNG_EXYNOS_SYSMMU,   /* Exynos sysmmu */
162         COMPAT_INTEL_MICROCODE,         /* Intel microcode update */
163         COMPAT_MEMORY_SPD,              /* Memory SPD information */
164         COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */
165         COMPAT_INTEL_MODEL_206AX,       /* Intel Model 206AX CPU */
166         COMPAT_INTEL_GMA,               /* Intel Graphics Media Accelerator */
167         COMPAT_AMS_AS3722,              /* AMS AS3722 PMIC */
168         COMPAT_INTEL_ICH_SPI,           /* Intel ICH7/9 SPI controller */
169         COMPAT_INTEL_QRK_MRC,           /* Intel Quark MRC */
170         COMPAT_INTEL_X86_PINCTRL,       /* Intel ICH7/9 pin control */
171         COMPAT_SOCIONEXT_XHCI,          /* Socionext UniPhier xHCI */
172         COMPAT_INTEL_PCH,               /* Intel PCH */
173         COMPAT_INTEL_IRQ_ROUTER,        /* Intel Interrupt Router */
174         COMPAT_ALTERA_SOCFPGA_DWMAC,    /* SoCFPGA Ethernet controller */
175         COMPAT_INTEL_BAYTRAIL_FSP,      /* Intel Bay Trail FSP */
176         COMPAT_INTEL_BAYTRAIL_FSP_MDP,  /* Intel FSP memory-down params */
177
178         COMPAT_COUNT,
179 };
180
181 #define MAX_PHANDLE_ARGS 16
182 struct fdtdec_phandle_args {
183         int node;
184         int args_count;
185         uint32_t args[MAX_PHANDLE_ARGS];
186 };
187
188 /**
189  * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
190  *
191  * This function is useful to parse lists of phandles and their arguments.
192  *
193  * Example:
194  *
195  * phandle1: node1 {
196  *      #list-cells = <2>;
197  * }
198  *
199  * phandle2: node2 {
200  *      #list-cells = <1>;
201  * }
202  *
203  * node3 {
204  *      list = <&phandle1 1 2 &phandle2 3>;
205  * }
206  *
207  * To get a device_node of the `node2' node you may call this:
208  * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
209  *                                &args);
210  *
211  * (This function is a modified version of __of_parse_phandle_with_args() from
212  * Linux 3.18)
213  *
214  * @blob:       Pointer to device tree
215  * @src_node:   Offset of device tree node containing a list
216  * @list_name:  property name that contains a list
217  * @cells_name: property name that specifies the phandles' arguments count,
218  *              or NULL to use @cells_count
219  * @cells_count: Cell count to use if @cells_name is NULL
220  * @index:      index of a phandle to parse out
221  * @out_args:   optional pointer to output arguments structure (will be filled)
222  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
223  *      @list_name does not exist, a phandle was not found, @cells_name
224  *      could not be found, the arguments were truncated or there were too
225  *      many arguments.
226  *
227  */
228 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
229                                    const char *list_name,
230                                    const char *cells_name,
231                                    int cell_count, int index,
232                                    struct fdtdec_phandle_args *out_args);
233
234 /**
235  * Find the next numbered alias for a peripheral. This is used to enumerate
236  * all the peripherals of a certain type.
237  *
238  * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
239  * this function will return a pointer to the node the alias points to, and
240  * then update *upto to 1. Next time you call this function, the next node
241  * will be returned.
242  *
243  * All nodes returned will match the compatible ID, as it is assumed that
244  * all peripherals use the same driver.
245  *
246  * @param blob          FDT blob to use
247  * @param name          Root name of alias to search for
248  * @param id            Compatible ID to look for
249  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
250  */
251 int fdtdec_next_alias(const void *blob, const char *name,
252                 enum fdt_compat_id id, int *upto);
253
254 /**
255  * Find the compatible ID for a given node.
256  *
257  * Generally each node has at least one compatible string attached to it.
258  * This function looks through our list of known compatible strings and
259  * returns the corresponding ID which matches the compatible string.
260  *
261  * @param blob          FDT blob to use
262  * @param node          Node containing compatible string to find
263  * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
264  */
265 enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
266
267 /**
268  * Find the next compatible node for a peripheral.
269  *
270  * Do the first call with node = 0. This function will return a pointer to
271  * the next compatible node. Next time you call this function, pass the
272  * value returned, and the next node will be provided.
273  *
274  * @param blob          FDT blob to use
275  * @param node          Start node for search
276  * @param id            Compatible ID to look for (enum fdt_compat_id)
277  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
278  */
279 int fdtdec_next_compatible(const void *blob, int node,
280                 enum fdt_compat_id id);
281
282 /**
283  * Find the next compatible subnode for a peripheral.
284  *
285  * Do the first call with node set to the parent and depth = 0. This
286  * function will return the offset of the next compatible node. Next time
287  * you call this function, pass the node value returned last time, with
288  * depth unchanged, and the next node will be provided.
289  *
290  * @param blob          FDT blob to use
291  * @param node          Start node for search
292  * @param id            Compatible ID to look for (enum fdt_compat_id)
293  * @param depthp        Current depth (set to 0 before first call)
294  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
295  */
296 int fdtdec_next_compatible_subnode(const void *blob, int node,
297                 enum fdt_compat_id id, int *depthp);
298
299 /**
300  * Look up an address property in a node and return it as an address.
301  * The property must hold either one address with no trailing data or
302  * one address with a length. This is only tested on 32-bit machines.
303  *
304  * @param blob  FDT blob
305  * @param node  node to examine
306  * @param prop_name     name of property to find
307  * @return address, if found, or FDT_ADDR_T_NONE if not
308  */
309 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
310                 const char *prop_name);
311
312 /**
313  * Look up an address property in a node and return it as an address.
314  * The property must hold one address with a length. This is only tested
315  * on 32-bit machines.
316  *
317  * @param blob  FDT blob
318  * @param node  node to examine
319  * @param prop_name     name of property to find
320  * @return address, if found, or FDT_ADDR_T_NONE if not
321  */
322 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
323                 const char *prop_name, fdt_size_t *sizep);
324
325 /**
326  * Look at an address property in a node and return the pci address which
327  * corresponds to the given type in the form of fdt_pci_addr.
328  * The property must hold one fdt_pci_addr with a lengh.
329  *
330  * @param blob          FDT blob
331  * @param node          node to examine
332  * @param type          pci address type (FDT_PCI_SPACE_xxx)
333  * @param prop_name     name of property to find
334  * @param addr          returns pci address in the form of fdt_pci_addr
335  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
336  *              format of the property was invalid, -ENXIO if the requested
337  *              address type was not found
338  */
339 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
340                 const char *prop_name, struct fdt_pci_addr *addr);
341
342 /**
343  * Look at the compatible property of a device node that represents a PCI
344  * device and extract pci vendor id and device id from it.
345  *
346  * @param blob          FDT blob
347  * @param node          node to examine
348  * @param vendor        vendor id of the pci device
349  * @param device        device id of the pci device
350  * @return 0 if ok, negative on error
351  */
352 int fdtdec_get_pci_vendev(const void *blob, int node,
353                 u16 *vendor, u16 *device);
354
355 /**
356  * Look at the pci address of a device node that represents a PCI device
357  * and parse the bus, device and function number from it. For some cases
358  * like the bus number encoded in reg property is not correct after pci
359  * enumeration, this function looks through the node's compatible strings
360  * to get these numbers extracted instead.
361  *
362  * @param blob          FDT blob
363  * @param node          node to examine
364  * @param addr          pci address in the form of fdt_pci_addr
365  * @param bdf           returns bus, device, function triplet
366  * @return 0 if ok, negative on error
367  */
368 int fdtdec_get_pci_bdf(const void *blob, int node,
369                 struct fdt_pci_addr *addr, pci_dev_t *bdf);
370
371 /**
372  * Look at the pci address of a device node that represents a PCI device
373  * and return base address of the pci device's registers.
374  *
375  * @param blob          FDT blob
376  * @param node          node to examine
377  * @param addr          pci address in the form of fdt_pci_addr
378  * @param bar           returns base address of the pci device's registers
379  * @return 0 if ok, negative on error
380  */
381 int fdtdec_get_pci_bar32(const void *blob, int node,
382                 struct fdt_pci_addr *addr, u32 *bar);
383
384 /**
385  * Look up a 32-bit integer property in a node and return it. The property
386  * must have at least 4 bytes of data. The value of the first cell is
387  * returned.
388  *
389  * @param blob  FDT blob
390  * @param node  node to examine
391  * @param prop_name     name of property to find
392  * @param default_val   default value to return if the property is not found
393  * @return integer value, if found, or default_val if not
394  */
395 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
396                 s32 default_val);
397
398 /**
399  * Get a variable-sized number from a property
400  *
401  * This reads a number from one or more cells.
402  *
403  * @param ptr   Pointer to property
404  * @param cells Number of cells containing the number
405  * @return the value in the cells
406  */
407 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
408
409 /**
410  * Look up a 64-bit integer property in a node and return it. The property
411  * must have at least 8 bytes of data (2 cells). The first two cells are
412  * concatenated to form a 8 bytes value, where the first cell is top half and
413  * the second cell is bottom half.
414  *
415  * @param blob  FDT blob
416  * @param node  node to examine
417  * @param prop_name     name of property to find
418  * @param default_val   default value to return if the property is not found
419  * @return integer value, if found, or default_val if not
420  */
421 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
422                 uint64_t default_val);
423
424 /**
425  * Checks whether a node is enabled.
426  * This looks for a 'status' property. If this exists, then returns 1 if
427  * the status is 'ok' and 0 otherwise. If there is no status property,
428  * it returns 1 on the assumption that anything mentioned should be enabled
429  * by default.
430  *
431  * @param blob  FDT blob
432  * @param node  node to examine
433  * @return integer value 0 (not enabled) or 1 (enabled)
434  */
435 int fdtdec_get_is_enabled(const void *blob, int node);
436
437 /**
438  * Make sure we have a valid fdt available to control U-Boot.
439  *
440  * If not, a message is printed to the console if the console is ready.
441  *
442  * @return 0 if all ok, -1 if not
443  */
444 int fdtdec_prepare_fdt(void);
445
446 /**
447  * Checks that we have a valid fdt available to control U-Boot.
448
449  * However, if not then for the moment nothing is done, since this function
450  * is called too early to panic().
451  *
452  * @returns 0
453  */
454 int fdtdec_check_fdt(void);
455
456 /**
457  * Find the nodes for a peripheral and return a list of them in the correct
458  * order. This is used to enumerate all the peripherals of a certain type.
459  *
460  * To use this, optionally set up a /aliases node with alias properties for
461  * a peripheral. For example, for usb you could have:
462  *
463  * aliases {
464  *              usb0 = "/ehci@c5008000";
465  *              usb1 = "/ehci@c5000000";
466  * };
467  *
468  * Pass "usb" as the name to this function and will return a list of two
469  * nodes offsets: /ehci@c5008000 and ehci@c5000000.
470  *
471  * All nodes returned will match the compatible ID, as it is assumed that
472  * all peripherals use the same driver.
473  *
474  * If no alias node is found, then the node list will be returned in the
475  * order found in the fdt. If the aliases mention a node which doesn't
476  * exist, then this will be ignored. If nodes are found with no aliases,
477  * they will be added in any order.
478  *
479  * If there is a gap in the aliases, then this function return a 0 node at
480  * that position. The return value will also count these gaps.
481  *
482  * This function checks node properties and will not return nodes which are
483  * marked disabled (status = "disabled").
484  *
485  * @param blob          FDT blob to use
486  * @param name          Root name of alias to search for
487  * @param id            Compatible ID to look for
488  * @param node_list     Place to put list of found nodes
489  * @param maxcount      Maximum number of nodes to find
490  * @return number of nodes found on success, FTD_ERR_... on error
491  */
492 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
493                         enum fdt_compat_id id, int *node_list, int maxcount);
494
495 /*
496  * This function is similar to fdtdec_find_aliases_for_id() except that it
497  * adds to the node_list that is passed in. Any 0 elements are considered
498  * available for allocation - others are considered already used and are
499  * skipped.
500  *
501  * You can use this by calling fdtdec_find_aliases_for_id() with an
502  * uninitialised array, then setting the elements that are returned to -1,
503  * say, then calling this function, perhaps with a different compat id.
504  * Any elements you get back that are >0 are new nodes added by the call
505  * to this function.
506  *
507  * Note that if you have some nodes with aliases and some without, you are
508  * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
509  * one compat_id may fill in positions for which you have aliases defined
510  * for another compat_id. When you later call *this* function with the second
511  * compat_id, the alias positions may already be used. A debug warning may
512  * be generated in this case, but it is safest to define aliases for all
513  * nodes when you care about the ordering.
514  */
515 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
516                         enum fdt_compat_id id, int *node_list, int maxcount);
517
518 /**
519  * Get the alias sequence number of a node
520  *
521  * This works out whether a node is pointed to by an alias, and if so, the
522  * sequence number of that alias. Aliases are of the form <base><num> where
523  * <num> is the sequence number. For example spi2 would be sequence number
524  * 2.
525  *
526  * @param blob          Device tree blob (if NULL, then error is returned)
527  * @param base          Base name for alias (before the underscore)
528  * @param node          Node to look up
529  * @param seqp          This is set to the sequence number if one is found,
530  *                      but otherwise the value is left alone
531  * @return 0 if a sequence was found, -ve if not
532  */
533 int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
534                          int *seqp);
535
536 /**
537  * Get the offset of the given chosen node
538  *
539  * This looks up a property in /chosen containing the path to another node,
540  * then finds the offset of that node.
541  *
542  * @param blob          Device tree blob (if NULL, then error is returned)
543  * @param name          Property name, e.g. "stdout-path"
544  * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
545  */
546 int fdtdec_get_chosen_node(const void *blob, const char *name);
547
548 /*
549  * Get the name for a compatible ID
550  *
551  * @param id            Compatible ID to look for
552  * @return compatible string for that id
553  */
554 const char *fdtdec_get_compatible(enum fdt_compat_id id);
555
556 /* Look up a phandle and follow it to its node. Then return the offset
557  * of that node.
558  *
559  * @param blob          FDT blob
560  * @param node          node to examine
561  * @param prop_name     name of property to find
562  * @return node offset if found, -ve error code on error
563  */
564 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
565
566 /**
567  * Look up a property in a node and return its contents in an integer
568  * array of given length. The property must have at least enough data for
569  * the array (4*count bytes). It may have more, but this will be ignored.
570  *
571  * @param blob          FDT blob
572  * @param node          node to examine
573  * @param prop_name     name of property to find
574  * @param array         array to fill with data
575  * @param count         number of array elements
576  * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
577  *              or -FDT_ERR_BADLAYOUT if not enough data
578  */
579 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
580                 u32 *array, int count);
581
582 /**
583  * Look up a property in a node and return its contents in an integer
584  * array of given length. The property must exist but may have less data that
585  * expected (4*count bytes). It may have more, but this will be ignored.
586  *
587  * @param blob          FDT blob
588  * @param node          node to examine
589  * @param prop_name     name of property to find
590  * @param array         array to fill with data
591  * @param count         number of array elements
592  * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
593  *              property is not found
594  */
595 int fdtdec_get_int_array_count(const void *blob, int node,
596                                const char *prop_name, u32 *array, int count);
597
598 /**
599  * Look up a property in a node and return a pointer to its contents as a
600  * unsigned int array of given length. The property must have at least enough
601  * data for the array ('count' cells). It may have more, but this will be
602  * ignored. The data is not copied.
603  *
604  * Note that you must access elements of the array with fdt32_to_cpu(),
605  * since the elements will be big endian even on a little endian machine.
606  *
607  * @param blob          FDT blob
608  * @param node          node to examine
609  * @param prop_name     name of property to find
610  * @param count         number of array elements
611  * @return pointer to array if found, or NULL if the property is not
612  *              found or there is not enough data
613  */
614 const u32 *fdtdec_locate_array(const void *blob, int node,
615                                const char *prop_name, int count);
616
617 /**
618  * Look up a boolean property in a node and return it.
619  *
620  * A boolean properly is true if present in the device tree and false if not
621  * present, regardless of its value.
622  *
623  * @param blob  FDT blob
624  * @param node  node to examine
625  * @param prop_name     name of property to find
626  * @return 1 if the properly is present; 0 if it isn't present
627  */
628 int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
629
630 /**
631  * Look in the FDT for a config item with the given name and return its value
632  * as a 32-bit integer. The property must have at least 4 bytes of data. The
633  * value of the first cell is returned.
634  *
635  * @param blob          FDT blob to use
636  * @param prop_name     Node property name
637  * @param default_val   default value to return if the property is not found
638  * @return integer value, if found, or default_val if not
639  */
640 int fdtdec_get_config_int(const void *blob, const char *prop_name,
641                 int default_val);
642
643 /**
644  * Look in the FDT for a config item with the given name
645  * and return whether it exists.
646  *
647  * @param blob          FDT blob
648  * @param prop_name     property name to look up
649  * @return 1, if it exists, or 0 if not
650  */
651 int fdtdec_get_config_bool(const void *blob, const char *prop_name);
652
653 /**
654  * Look in the FDT for a config item with the given name and return its value
655  * as a string.
656  *
657  * @param blob          FDT blob
658  * @param prop_name     property name to look up
659  * @returns property string, NULL on error.
660  */
661 char *fdtdec_get_config_string(const void *blob, const char *prop_name);
662
663 /*
664  * Look up a property in a node and return its contents in a byte
665  * array of given length. The property must have at least enough data for
666  * the array (count bytes). It may have more, but this will be ignored.
667  *
668  * @param blob          FDT blob
669  * @param node          node to examine
670  * @param prop_name     name of property to find
671  * @param array         array to fill with data
672  * @param count         number of array elements
673  * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
674  *              or -FDT_ERR_BADLAYOUT if not enough data
675  */
676 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
677                 u8 *array, int count);
678
679 /**
680  * Look up a property in a node and return a pointer to its contents as a
681  * byte array of given length. The property must have at least enough data
682  * for the array (count bytes). It may have more, but this will be ignored.
683  * The data is not copied.
684  *
685  * @param blob          FDT blob
686  * @param node          node to examine
687  * @param prop_name     name of property to find
688  * @param count         number of array elements
689  * @return pointer to byte array if found, or NULL if the property is not
690  *              found or there is not enough data
691  */
692 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
693                              const char *prop_name, int count);
694
695 /**
696  * Look up a property in a node which contains a memory region address and
697  * size. Then return a pointer to this address.
698  *
699  * The property must hold one address with a length. This is only tested on
700  * 32-bit machines.
701  *
702  * @param blob          FDT blob
703  * @param node          node to examine
704  * @param prop_name     name of property to find
705  * @param basep         Returns base address of region
706  * @param size          Returns size of region
707  * @return 0 if ok, -1 on error (property not found)
708  */
709 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
710                          fdt_addr_t *basep, fdt_size_t *sizep);
711
712 enum fmap_compress_t {
713         FMAP_COMPRESS_NONE,
714         FMAP_COMPRESS_LZO,
715 };
716
717 enum fmap_hash_t {
718         FMAP_HASH_NONE,
719         FMAP_HASH_SHA1,
720         FMAP_HASH_SHA256,
721 };
722
723 /* A flash map entry, containing an offset and length */
724 struct fmap_entry {
725         uint32_t offset;
726         uint32_t length;
727         uint32_t used;                  /* Number of bytes used in region */
728         enum fmap_compress_t compress_algo;     /* Compression type */
729         enum fmap_hash_t hash_algo;             /* Hash algorithm */
730         const uint8_t *hash;                    /* Hash value */
731         int hash_size;                          /* Hash size */
732 };
733
734 /**
735  * Read a flash entry from the fdt
736  *
737  * @param blob          FDT blob
738  * @param node          Offset of node to read
739  * @param name          Name of node being read
740  * @param entry         Place to put offset and size of this node
741  * @return 0 if ok, -ve on error
742  */
743 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
744                            struct fmap_entry *entry);
745
746 /**
747  * Obtain an indexed resource from a device property.
748  *
749  * @param fdt           FDT blob
750  * @param node          node to examine
751  * @param property      name of the property to parse
752  * @param index         index of the resource to retrieve
753  * @param res           returns the resource
754  * @return 0 if ok, negative on error
755  */
756 int fdt_get_resource(const void *fdt, int node, const char *property,
757                      unsigned int index, struct fdt_resource *res);
758
759 /**
760  * Obtain a named resource from a device property.
761  *
762  * Look up the index of the name in a list of strings and return the resource
763  * at that index.
764  *
765  * @param fdt           FDT blob
766  * @param node          node to examine
767  * @param property      name of the property to parse
768  * @param prop_names    name of the property containing the list of names
769  * @param name          the name of the entry to look up
770  * @param res           returns the resource
771  */
772 int fdt_get_named_resource(const void *fdt, int node, const char *property,
773                            const char *prop_names, const char *name,
774                            struct fdt_resource *res);
775
776 /**
777  * Decode a named region within a memory bank of a given type.
778  *
779  * This function handles selection of a memory region. The region is
780  * specified as an offset/size within a particular type of memory.
781  *
782  * The properties used are:
783  *
784  *      <mem_type>-memory<suffix> for the name of the memory bank
785  *      <mem_type>-offset<suffix> for the offset in that bank
786  *
787  * The property value must have an offset and a size. The function checks
788  * that the region is entirely within the memory bank.5
789  *
790  * @param blob          FDT blob
791  * @param node          Node containing the properties (-1 for /config)
792  * @param mem_type      Type of memory to use, which is a name, such as
793  *                      "u-boot" or "kernel".
794  * @param suffix        String to append to the memory/offset
795  *                      property names
796  * @param basep         Returns base of region
797  * @param sizep         Returns size of region
798  * @return 0 if OK, -ive on error
799  */
800 int fdtdec_decode_memory_region(const void *blob, int node,
801                                 const char *mem_type, const char *suffix,
802                                 fdt_addr_t *basep, fdt_size_t *sizep);
803
804 /* Display timings from linux include/video/display_timing.h */
805 enum display_flags {
806         DISPLAY_FLAGS_HSYNC_LOW         = 1 << 0,
807         DISPLAY_FLAGS_HSYNC_HIGH        = 1 << 1,
808         DISPLAY_FLAGS_VSYNC_LOW         = 1 << 2,
809         DISPLAY_FLAGS_VSYNC_HIGH        = 1 << 3,
810
811         /* data enable flag */
812         DISPLAY_FLAGS_DE_LOW            = 1 << 4,
813         DISPLAY_FLAGS_DE_HIGH           = 1 << 5,
814         /* drive data on pos. edge */
815         DISPLAY_FLAGS_PIXDATA_POSEDGE   = 1 << 6,
816         /* drive data on neg. edge */
817         DISPLAY_FLAGS_PIXDATA_NEGEDGE   = 1 << 7,
818         DISPLAY_FLAGS_INTERLACED        = 1 << 8,
819         DISPLAY_FLAGS_DOUBLESCAN        = 1 << 9,
820         DISPLAY_FLAGS_DOUBLECLK         = 1 << 10,
821 };
822
823 /*
824  * A single signal can be specified via a range of minimal and maximal values
825  * with a typical value, that lies somewhere inbetween.
826  */
827 struct timing_entry {
828         u32 min;
829         u32 typ;
830         u32 max;
831 };
832
833 /*
834  * Single "mode" entry. This describes one set of signal timings a display can
835  * have in one setting. This struct can later be converted to struct videomode
836  * (see include/video/videomode.h). As each timing_entry can be defined as a
837  * range, one struct display_timing may become multiple struct videomodes.
838  *
839  * Example: hsync active high, vsync active low
840  *
841  *                                  Active Video
842  * Video  ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
843  *        |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
844  *        |          |   porch  |                    |   porch   |
845  *
846  * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
847  *
848  * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
849  */
850 struct display_timing {
851         struct timing_entry pixelclock;
852
853         struct timing_entry hactive;            /* hor. active video */
854         struct timing_entry hfront_porch;       /* hor. front porch */
855         struct timing_entry hback_porch;        /* hor. back porch */
856         struct timing_entry hsync_len;          /* hor. sync len */
857
858         struct timing_entry vactive;            /* ver. active video */
859         struct timing_entry vfront_porch;       /* ver. front porch */
860         struct timing_entry vback_porch;        /* ver. back porch */
861         struct timing_entry vsync_len;          /* ver. sync len */
862
863         enum display_flags flags;               /* display flags */
864 };
865
866 /**
867  * fdtdec_decode_display_timing() - decode display timings
868  *
869  * Decode display timings from the supplied 'display-timings' node.
870  * See doc/device-tree-bindings/video/display-timing.txt for binding
871  * information.
872  *
873  * @param blob          FDT blob
874  * @param node          'display-timing' node containing the timing subnodes
875  * @param index         Index number to read (0=first timing subnode)
876  * @param config        Place to put timings
877  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
878  */
879 int fdtdec_decode_display_timing(const void *blob, int node, int index,
880                                  struct display_timing *config);
881 /**
882  * Set up the device tree ready for use
883  */
884 int fdtdec_setup(void);
885
886 #endif