2 * Copyright (c) 2011 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
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.
21 * A typedef for a physical address. Note that fdt data is always big
22 * endian even on a litle endian machine.
24 #ifdef CONFIG_PHYS_64BIT
25 typedef u64 fdt_addr_t;
26 typedef u64 fdt_size_t;
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)
31 typedef u32 fdt_addr_t;
32 typedef u32 fdt_size_t;
33 #define FDT_ADDR_T_NONE (-1U)
34 #define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
35 #define fdt_size_to_cpu(reg) be32_to_cpu(reg)
38 /* Information obtained about memory from the FDT */
44 #ifdef CONFIG_OF_CONTROL
45 # if defined(CONFIG_SPL_BUILD) && defined(SPL_DISABLE_OF_CONTROL)
55 * Information about a resource. start is the first address of the resource
56 * and end is the last address (inclusive). The length of the resource will
57 * be equal to: end - start + 1.
65 FDT_PCI_SPACE_CONFIG = 0,
66 FDT_PCI_SPACE_IO = 0x01000000,
67 FDT_PCI_SPACE_MEM32 = 0x02000000,
68 FDT_PCI_SPACE_MEM64 = 0x03000000,
69 FDT_PCI_SPACE_MEM32_PREF = 0x42000000,
70 FDT_PCI_SPACE_MEM64_PREF = 0x43000000,
73 #define FDT_PCI_ADDR_CELLS 3
74 #define FDT_PCI_SIZE_CELLS 2
75 #define FDT_PCI_REG_SIZE \
76 ((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32))
79 * The Open Firmware spec defines PCI physical address as follows:
81 * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
83 * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr
84 * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
85 * phys.lo cell: llllllll llllllll llllllll llllllll
89 * n: is 0 if the address is relocatable, 1 otherwise
90 * p: is 1 if addressable region is prefetchable, 0 otherwise
91 * t: is 1 if the address is aliased (for non-relocatable I/O) below 1MB
92 * (for Memory), or below 64KB (for relocatable I/O)
93 * ss: is the space code, denoting the address space
94 * bbbbbbbb: is the 8-bit Bus Number
95 * ddddd: is the 5-bit Device Number
96 * fff: is the 3-bit Function Number
97 * rrrrrrrr: is the 8-bit Register Number
98 * hhhhhhhh: is a 32-bit unsigned number
99 * llllllll: is a 32-bit unsigned number
101 struct fdt_pci_addr {
108 * Compute the size of a resource.
110 * @param res the resource to operate on
111 * @return the size of the resource
113 static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
115 return res->end - res->start + 1;
119 * Compat types that we know about and for which we might have drivers.
120 * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
125 COMPAT_NVIDIA_TEGRA20_USB, /* Tegra20 USB port */
126 COMPAT_NVIDIA_TEGRA30_USB, /* Tegra30 USB port */
127 COMPAT_NVIDIA_TEGRA114_USB, /* Tegra114 USB port */
128 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
129 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
130 COMPAT_NVIDIA_TEGRA20_KBC, /* Tegra20 Keyboard */
131 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
132 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */
133 COMPAT_NVIDIA_TEGRA124_DC, /* Tegra 124 Display controller */
134 COMPAT_NVIDIA_TEGRA124_SOR, /* Tegra 124 Serial Output Resource */
135 COMPAT_NVIDIA_TEGRA124_PMC, /* Tegra 124 power mgmt controller */
136 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */
137 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
138 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
139 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
140 COMPAT_NVIDIA_TEGRA124_PCIE, /* Tegra 124 PCIe controller */
141 COMPAT_NVIDIA_TEGRA30_PCIE, /* Tegra 30 PCIe controller */
142 COMPAT_NVIDIA_TEGRA20_PCIE, /* Tegra 20 PCIe controller */
143 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
144 /* Tegra124 XUSB pad controller */
145 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
146 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
147 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
148 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
149 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
150 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */
151 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
152 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
153 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
154 COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */
155 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
156 COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */
157 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
158 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
159 COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */
160 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
161 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
162 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
163 COMPAT_INFINEON_SLB9635_TPM, /* Infineon SLB9635 TPM */
164 COMPAT_INFINEON_SLB9645_TPM, /* Infineon SLB9645 TPM */
165 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
166 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */
167 COMPAT_TI_TPS65090, /* Texas Instrument TPS65090 */
168 COMPAT_NXP_PTN3460, /* NXP PTN3460 DP/LVDS bridge */
169 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
170 COMPAT_PARADE_PS8625, /* Parade PS8622 EDP->LVDS bridge */
171 COMPAT_INTEL_MICROCODE, /* Intel microcode update */
172 COMPAT_MEMORY_SPD, /* Memory SPD information */
173 COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */
174 COMPAT_INTEL_MODEL_206AX, /* Intel Model 206AX CPU */
175 COMPAT_INTEL_GMA, /* Intel Graphics Media Accelerator */
176 COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */
177 COMPAT_INTEL_ICH_SPI, /* Intel ICH7/9 SPI controller */
178 COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
179 COMPAT_SOCIONEXT_XHCI, /* Socionext UniPhier xHCI */
180 COMPAT_INTEL_PCH, /* Intel PCH */
181 COMPAT_INTEL_IRQ_ROUTER, /* Intel Interrupt Router */
186 #define MAX_PHANDLE_ARGS 16
187 struct fdtdec_phandle_args {
190 uint32_t args[MAX_PHANDLE_ARGS];
194 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
196 * This function is useful to parse lists of phandles and their arguments.
209 * list = <&phandle1 1 2 &phandle2 3>;
212 * To get a device_node of the `node2' node you may call this:
213 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
216 * (This function is a modified version of __of_parse_phandle_with_args() from
219 * @blob: Pointer to device tree
220 * @src_node: Offset of device tree node containing a list
221 * @list_name: property name that contains a list
222 * @cells_name: property name that specifies the phandles' arguments count,
223 * or NULL to use @cells_count
224 * @cells_count: Cell count to use if @cells_name is NULL
225 * @index: index of a phandle to parse out
226 * @out_args: optional pointer to output arguments structure (will be filled)
227 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
228 * @list_name does not exist, a phandle was not found, @cells_name
229 * could not be found, the arguments were truncated or there were too
233 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
234 const char *list_name,
235 const char *cells_name,
236 int cell_count, int index,
237 struct fdtdec_phandle_args *out_args);
240 * Find the next numbered alias for a peripheral. This is used to enumerate
241 * all the peripherals of a certain type.
243 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
244 * this function will return a pointer to the node the alias points to, and
245 * then update *upto to 1. Next time you call this function, the next node
248 * All nodes returned will match the compatible ID, as it is assumed that
249 * all peripherals use the same driver.
251 * @param blob FDT blob to use
252 * @param name Root name of alias to search for
253 * @param id Compatible ID to look for
254 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
256 int fdtdec_next_alias(const void *blob, const char *name,
257 enum fdt_compat_id id, int *upto);
260 * Find the compatible ID for a given node.
262 * Generally each node has at least one compatible string attached to it.
263 * This function looks through our list of known compatible strings and
264 * returns the corresponding ID which matches the compatible string.
266 * @param blob FDT blob to use
267 * @param node Node containing compatible string to find
268 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
270 enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
273 * Find the next compatible node for a peripheral.
275 * Do the first call with node = 0. This function will return a pointer to
276 * the next compatible node. Next time you call this function, pass the
277 * value returned, and the next node will be provided.
279 * @param blob FDT blob to use
280 * @param node Start node for search
281 * @param id Compatible ID to look for (enum fdt_compat_id)
282 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
284 int fdtdec_next_compatible(const void *blob, int node,
285 enum fdt_compat_id id);
288 * Find the next compatible subnode for a peripheral.
290 * Do the first call with node set to the parent and depth = 0. This
291 * function will return the offset of the next compatible node. Next time
292 * you call this function, pass the node value returned last time, with
293 * depth unchanged, and the next node will be provided.
295 * @param blob FDT blob to use
296 * @param node Start node for search
297 * @param id Compatible ID to look for (enum fdt_compat_id)
298 * @param depthp Current depth (set to 0 before first call)
299 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
301 int fdtdec_next_compatible_subnode(const void *blob, int node,
302 enum fdt_compat_id id, int *depthp);
305 * Look up an address property in a node and return it as an address.
306 * The property must hold either one address with no trailing data or
307 * one address with a length. This is only tested on 32-bit machines.
309 * @param blob FDT blob
310 * @param node node to examine
311 * @param prop_name name of property to find
312 * @return address, if found, or FDT_ADDR_T_NONE if not
314 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
315 const char *prop_name);
318 * Look up an address property in a node and return it as an address.
319 * The property must hold one address with a length. This is only tested
320 * on 32-bit machines.
322 * @param blob FDT blob
323 * @param node node to examine
324 * @param prop_name name of property to find
325 * @return address, if found, or FDT_ADDR_T_NONE if not
327 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
328 const char *prop_name, fdt_size_t *sizep);
331 * Look at an address property in a node and return the pci address which
332 * corresponds to the given type in the form of fdt_pci_addr.
333 * The property must hold one fdt_pci_addr with a lengh.
335 * @param blob FDT blob
336 * @param node node to examine
337 * @param type pci address type (FDT_PCI_SPACE_xxx)
338 * @param prop_name name of property to find
339 * @param addr returns pci address in the form of fdt_pci_addr
340 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
341 * format of the property was invalid, -ENXIO if the requested
342 * address type was not found
344 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
345 const char *prop_name, struct fdt_pci_addr *addr);
348 * Look at the compatible property of a device node that represents a PCI
349 * device and extract pci vendor id and device id from it.
351 * @param blob FDT blob
352 * @param node node to examine
353 * @param vendor vendor id of the pci device
354 * @param device device id of the pci device
355 * @return 0 if ok, negative on error
357 int fdtdec_get_pci_vendev(const void *blob, int node,
358 u16 *vendor, u16 *device);
361 * Look at the pci address of a device node that represents a PCI device
362 * and parse the bus, device and function number from it. For some cases
363 * like the bus number encoded in reg property is not correct after pci
364 * enumeration, this function looks through the node's compatible strings
365 * to get these numbers extracted instead.
367 * @param blob FDT blob
368 * @param node node to examine
369 * @param addr pci address in the form of fdt_pci_addr
370 * @param bdf returns bus, device, function triplet
371 * @return 0 if ok, negative on error
373 int fdtdec_get_pci_bdf(const void *blob, int node,
374 struct fdt_pci_addr *addr, pci_dev_t *bdf);
377 * Look at the pci address of a device node that represents a PCI device
378 * and return base address of the pci device's registers.
380 * @param blob FDT blob
381 * @param node node to examine
382 * @param addr pci address in the form of fdt_pci_addr
383 * @param bar returns base address of the pci device's registers
384 * @return 0 if ok, negative on error
386 int fdtdec_get_pci_bar32(const void *blob, int node,
387 struct fdt_pci_addr *addr, u32 *bar);
390 * Look up a 32-bit integer property in a node and return it. The property
391 * must have at least 4 bytes of data. The value of the first cell is
394 * @param blob FDT blob
395 * @param node node to examine
396 * @param prop_name name of property to find
397 * @param default_val default value to return if the property is not found
398 * @return integer value, if found, or default_val if not
400 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
404 * Get a variable-sized number from a property
406 * This reads a number from one or more cells.
408 * @param ptr Pointer to property
409 * @param cells Number of cells containing the number
410 * @return the value in the cells
412 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
415 * Look up a 64-bit integer property in a node and return it. The property
416 * must have at least 8 bytes of data (2 cells). The first two cells are
417 * concatenated to form a 8 bytes value, where the first cell is top half and
418 * the second cell is bottom half.
420 * @param blob FDT blob
421 * @param node node to examine
422 * @param prop_name name of property to find
423 * @param default_val default value to return if the property is not found
424 * @return integer value, if found, or default_val if not
426 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
427 uint64_t default_val);
430 * Checks whether a node is enabled.
431 * This looks for a 'status' property. If this exists, then returns 1 if
432 * the status is 'ok' and 0 otherwise. If there is no status property,
433 * it returns 1 on the assumption that anything mentioned should be enabled
436 * @param blob FDT blob
437 * @param node node to examine
438 * @return integer value 0 (not enabled) or 1 (enabled)
440 int fdtdec_get_is_enabled(const void *blob, int node);
443 * Make sure we have a valid fdt available to control U-Boot.
445 * If not, a message is printed to the console if the console is ready.
447 * @return 0 if all ok, -1 if not
449 int fdtdec_prepare_fdt(void);
452 * Checks that we have a valid fdt available to control U-Boot.
454 * However, if not then for the moment nothing is done, since this function
455 * is called too early to panic().
459 int fdtdec_check_fdt(void);
462 * Find the nodes for a peripheral and return a list of them in the correct
463 * order. This is used to enumerate all the peripherals of a certain type.
465 * To use this, optionally set up a /aliases node with alias properties for
466 * a peripheral. For example, for usb you could have:
469 * usb0 = "/ehci@c5008000";
470 * usb1 = "/ehci@c5000000";
473 * Pass "usb" as the name to this function and will return a list of two
474 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
476 * All nodes returned will match the compatible ID, as it is assumed that
477 * all peripherals use the same driver.
479 * If no alias node is found, then the node list will be returned in the
480 * order found in the fdt. If the aliases mention a node which doesn't
481 * exist, then this will be ignored. If nodes are found with no aliases,
482 * they will be added in any order.
484 * If there is a gap in the aliases, then this function return a 0 node at
485 * that position. The return value will also count these gaps.
487 * This function checks node properties and will not return nodes which are
488 * marked disabled (status = "disabled").
490 * @param blob FDT blob to use
491 * @param name Root name of alias to search for
492 * @param id Compatible ID to look for
493 * @param node_list Place to put list of found nodes
494 * @param maxcount Maximum number of nodes to find
495 * @return number of nodes found on success, FTD_ERR_... on error
497 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
498 enum fdt_compat_id id, int *node_list, int maxcount);
501 * This function is similar to fdtdec_find_aliases_for_id() except that it
502 * adds to the node_list that is passed in. Any 0 elements are considered
503 * available for allocation - others are considered already used and are
506 * You can use this by calling fdtdec_find_aliases_for_id() with an
507 * uninitialised array, then setting the elements that are returned to -1,
508 * say, then calling this function, perhaps with a different compat id.
509 * Any elements you get back that are >0 are new nodes added by the call
512 * Note that if you have some nodes with aliases and some without, you are
513 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
514 * one compat_id may fill in positions for which you have aliases defined
515 * for another compat_id. When you later call *this* function with the second
516 * compat_id, the alias positions may already be used. A debug warning may
517 * be generated in this case, but it is safest to define aliases for all
518 * nodes when you care about the ordering.
520 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
521 enum fdt_compat_id id, int *node_list, int maxcount);
524 * Get the alias sequence number of a node
526 * This works out whether a node is pointed to by an alias, and if so, the
527 * sequence number of that alias. Aliases are of the form <base><num> where
528 * <num> is the sequence number. For example spi2 would be sequence number
531 * @param blob Device tree blob (if NULL, then error is returned)
532 * @param base Base name for alias (before the underscore)
533 * @param node Node to look up
534 * @param seqp This is set to the sequence number if one is found,
535 * but otherwise the value is left alone
536 * @return 0 if a sequence was found, -ve if not
538 int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
542 * Get the offset of the given chosen node
544 * This looks up a property in /chosen containing the path to another node,
545 * then finds the offset of that node.
547 * @param blob Device tree blob (if NULL, then error is returned)
548 * @param name Property name, e.g. "stdout-path"
549 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
551 int fdtdec_get_chosen_node(const void *blob, const char *name);
554 * Get the name for a compatible ID
556 * @param id Compatible ID to look for
557 * @return compatible string for that id
559 const char *fdtdec_get_compatible(enum fdt_compat_id id);
561 /* Look up a phandle and follow it to its node. Then return the offset
564 * @param blob FDT blob
565 * @param node node to examine
566 * @param prop_name name of property to find
567 * @return node offset if found, -ve error code on error
569 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
572 * Look up a property in a node and return its contents in an integer
573 * array of given length. The property must have at least enough data for
574 * the array (4*count bytes). It may have more, but this will be ignored.
576 * @param blob FDT blob
577 * @param node node to examine
578 * @param prop_name name of property to find
579 * @param array array to fill with data
580 * @param count number of array elements
581 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
582 * or -FDT_ERR_BADLAYOUT if not enough data
584 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
585 u32 *array, int count);
588 * Look up a property in a node and return its contents in an integer
589 * array of given length. The property must exist but may have less data that
590 * expected (4*count bytes). It may have more, but this will be ignored.
592 * @param blob FDT blob
593 * @param node node to examine
594 * @param prop_name name of property to find
595 * @param array array to fill with data
596 * @param count number of array elements
597 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
598 * property is not found
600 int fdtdec_get_int_array_count(const void *blob, int node,
601 const char *prop_name, u32 *array, int count);
604 * Look up a property in a node and return a pointer to its contents as a
605 * unsigned int array of given length. The property must have at least enough
606 * data for the array ('count' cells). It may have more, but this will be
607 * ignored. The data is not copied.
609 * Note that you must access elements of the array with fdt32_to_cpu(),
610 * since the elements will be big endian even on a little endian machine.
612 * @param blob FDT blob
613 * @param node node to examine
614 * @param prop_name name of property to find
615 * @param count number of array elements
616 * @return pointer to array if found, or NULL if the property is not
617 * found or there is not enough data
619 const u32 *fdtdec_locate_array(const void *blob, int node,
620 const char *prop_name, int count);
623 * Look up a boolean property in a node and return it.
625 * A boolean properly is true if present in the device tree and false if not
626 * present, regardless of its value.
628 * @param blob FDT blob
629 * @param node node to examine
630 * @param prop_name name of property to find
631 * @return 1 if the properly is present; 0 if it isn't present
633 int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
636 * Look in the FDT for a config item with the given name and return its value
637 * as a 32-bit integer. The property must have at least 4 bytes of data. The
638 * value of the first cell is returned.
640 * @param blob FDT blob to use
641 * @param prop_name Node property name
642 * @param default_val default value to return if the property is not found
643 * @return integer value, if found, or default_val if not
645 int fdtdec_get_config_int(const void *blob, const char *prop_name,
649 * Look in the FDT for a config item with the given name
650 * and return whether it exists.
652 * @param blob FDT blob
653 * @param prop_name property name to look up
654 * @return 1, if it exists, or 0 if not
656 int fdtdec_get_config_bool(const void *blob, const char *prop_name);
659 * Look in the FDT for a config item with the given name and return its value
662 * @param blob FDT blob
663 * @param prop_name property name to look up
664 * @returns property string, NULL on error.
666 char *fdtdec_get_config_string(const void *blob, const char *prop_name);
669 * Look up a property in a node and return its contents in a byte
670 * array of given length. The property must have at least enough data for
671 * the array (count bytes). It may have more, but this will be ignored.
673 * @param blob FDT blob
674 * @param node node to examine
675 * @param prop_name name of property to find
676 * @param array array to fill with data
677 * @param count number of array elements
678 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
679 * or -FDT_ERR_BADLAYOUT if not enough data
681 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
682 u8 *array, int count);
685 * Look up a property in a node and return a pointer to its contents as a
686 * byte array of given length. The property must have at least enough data
687 * for the array (count bytes). It may have more, but this will be ignored.
688 * The data is not copied.
690 * @param blob FDT blob
691 * @param node node to examine
692 * @param prop_name name of property to find
693 * @param count number of array elements
694 * @return pointer to byte array if found, or NULL if the property is not
695 * found or there is not enough data
697 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
698 const char *prop_name, int count);
701 * Look up a property in a node which contains a memory region address and
702 * size. Then return a pointer to this address.
704 * The property must hold one address with a length. This is only tested on
707 * @param blob FDT blob
708 * @param node node to examine
709 * @param prop_name name of property to find
710 * @param basep Returns base address of region
711 * @param size Returns size of region
712 * @return 0 if ok, -1 on error (property not found)
714 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
715 fdt_addr_t *basep, fdt_size_t *sizep);
717 enum fmap_compress_t {
728 /* A flash map entry, containing an offset and length */
732 uint32_t used; /* Number of bytes used in region */
733 enum fmap_compress_t compress_algo; /* Compression type */
734 enum fmap_hash_t hash_algo; /* Hash algorithm */
735 const uint8_t *hash; /* Hash value */
736 int hash_size; /* Hash size */
740 * Read a flash entry from the fdt
742 * @param blob FDT blob
743 * @param node Offset of node to read
744 * @param name Name of node being read
745 * @param entry Place to put offset and size of this node
746 * @return 0 if ok, -ve on error
748 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
749 struct fmap_entry *entry);
752 * Obtain an indexed resource from a device property.
754 * @param fdt FDT blob
755 * @param node node to examine
756 * @param property name of the property to parse
757 * @param index index of the resource to retrieve
758 * @param res returns the resource
759 * @return 0 if ok, negative on error
761 int fdt_get_resource(const void *fdt, int node, const char *property,
762 unsigned int index, struct fdt_resource *res);
765 * Obtain a named resource from a device property.
767 * Look up the index of the name in a list of strings and return the resource
770 * @param fdt FDT blob
771 * @param node node to examine
772 * @param property name of the property to parse
773 * @param prop_names name of the property containing the list of names
774 * @param name the name of the entry to look up
775 * @param res returns the resource
777 int fdt_get_named_resource(const void *fdt, int node, const char *property,
778 const char *prop_names, const char *name,
779 struct fdt_resource *res);
782 * Decode a named region within a memory bank of a given type.
784 * This function handles selection of a memory region. The region is
785 * specified as an offset/size within a particular type of memory.
787 * The properties used are:
789 * <mem_type>-memory<suffix> for the name of the memory bank
790 * <mem_type>-offset<suffix> for the offset in that bank
792 * The property value must have an offset and a size. The function checks
793 * that the region is entirely within the memory bank.5
795 * @param blob FDT blob
796 * @param node Node containing the properties (-1 for /config)
797 * @param mem_type Type of memory to use, which is a name, such as
798 * "u-boot" or "kernel".
799 * @param suffix String to append to the memory/offset
801 * @param basep Returns base of region
802 * @param sizep Returns size of region
803 * @return 0 if OK, -ive on error
805 int fdtdec_decode_memory_region(const void *blob, int node,
806 const char *mem_type, const char *suffix,
807 fdt_addr_t *basep, fdt_size_t *sizep);
809 /* Display timings from linux include/video/display_timing.h */
811 DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
812 DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
813 DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
814 DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
816 /* data enable flag */
817 DISPLAY_FLAGS_DE_LOW = 1 << 4,
818 DISPLAY_FLAGS_DE_HIGH = 1 << 5,
819 /* drive data on pos. edge */
820 DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
821 /* drive data on neg. edge */
822 DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
823 DISPLAY_FLAGS_INTERLACED = 1 << 8,
824 DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
825 DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
829 * A single signal can be specified via a range of minimal and maximal values
830 * with a typical value, that lies somewhere inbetween.
832 struct timing_entry {
839 * Single "mode" entry. This describes one set of signal timings a display can
840 * have in one setting. This struct can later be converted to struct videomode
841 * (see include/video/videomode.h). As each timing_entry can be defined as a
842 * range, one struct display_timing may become multiple struct videomodes.
844 * Example: hsync active high, vsync active low
847 * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
848 * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
849 * | | porch | | porch |
851 * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
853 * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
855 struct display_timing {
856 struct timing_entry pixelclock;
858 struct timing_entry hactive; /* hor. active video */
859 struct timing_entry hfront_porch; /* hor. front porch */
860 struct timing_entry hback_porch; /* hor. back porch */
861 struct timing_entry hsync_len; /* hor. sync len */
863 struct timing_entry vactive; /* ver. active video */
864 struct timing_entry vfront_porch; /* ver. front porch */
865 struct timing_entry vback_porch; /* ver. back porch */
866 struct timing_entry vsync_len; /* ver. sync len */
868 enum display_flags flags; /* display flags */
872 * fdtdec_decode_display_timing() - decode display timings
874 * Decode display timings from the supplied 'display-timings' node.
875 * See doc/device-tree-bindings/video/display-timing.txt for binding
878 * @param blob FDT blob
879 * @param node 'display-timing' node containing the timing subnodes
880 * @param index Index number to read (0=first timing subnode)
881 * @param config Place to put timings
882 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
884 int fdtdec_decode_display_timing(const void *blob, int node, int index,
885 struct display_timing *config);
887 * Set up the device tree ready for use
889 int fdtdec_setup(void);