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 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)
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)
36 /* Information obtained about memory from the FDT */
42 #ifdef CONFIG_SPL_BUILD
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.
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,
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))
73 * The Open Firmware spec defines PCI physical address as follows:
75 * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
77 * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr
78 * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
79 * phys.lo cell: llllllll llllllll llllllll llllllll
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
102 * Compute the size of a resource.
104 * @param res the resource to operate on
105 * @return the size of the resource
107 static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
109 return res->end - res->start + 1;
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
119 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
120 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
121 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
122 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */
123 COMPAT_NVIDIA_TEGRA124_DC, /* Tegra 124 Display controller */
124 COMPAT_NVIDIA_TEGRA124_SOR, /* Tegra 124 Serial Output Resource */
125 COMPAT_NVIDIA_TEGRA124_PMC, /* Tegra 124 power mgmt controller */
126 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */
127 COMPAT_NVIDIA_TEGRA210_SDMMC, /* Tegra210 SDMMC controller */
128 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
129 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
130 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
131 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
132 /* Tegra124 XUSB pad controller */
133 COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
134 /* Tegra210 XUSB pad controller */
135 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
136 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
137 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
138 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
139 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
140 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */
141 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
142 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
143 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
144 COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */
145 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
146 COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */
147 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
148 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
149 COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */
150 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
151 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
152 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
153 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
154 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */
155 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
156 COMPAT_INTEL_MICROCODE, /* Intel microcode update */
157 COMPAT_MEMORY_SPD, /* Memory SPD information */
158 COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */
159 COMPAT_INTEL_MODEL_206AX, /* Intel Model 206AX CPU */
160 COMPAT_INTEL_GMA, /* Intel Graphics Media Accelerator */
161 COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */
162 COMPAT_INTEL_ICH_SPI, /* Intel ICH7/9 SPI controller */
163 COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
164 COMPAT_INTEL_X86_PINCTRL, /* Intel ICH7/9 pin control */
165 COMPAT_SOCIONEXT_XHCI, /* Socionext UniPhier xHCI */
166 COMPAT_INTEL_PCH, /* Intel PCH */
167 COMPAT_INTEL_IRQ_ROUTER, /* Intel Interrupt Router */
168 COMPAT_ALTERA_SOCFPGA_DWMAC, /* SoCFPGA Ethernet controller */
169 COMPAT_ALTERA_SOCFPGA_DWMMC, /* SoCFPGA DWMMC controller */
170 COMPAT_ALTERA_SOCFPGA_DWC2USB, /* SoCFPGA DWC2 USB controller */
171 COMPAT_INTEL_BAYTRAIL_FSP, /* Intel Bay Trail FSP */
172 COMPAT_INTEL_BAYTRAIL_FSP_MDP, /* Intel FSP memory-down params */
177 #define MAX_PHANDLE_ARGS 16
178 struct fdtdec_phandle_args {
181 uint32_t args[MAX_PHANDLE_ARGS];
185 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
187 * This function is useful to parse lists of phandles and their arguments.
200 * list = <&phandle1 1 2 &phandle2 3>;
203 * To get a device_node of the `node2' node you may call this:
204 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
207 * (This function is a modified version of __of_parse_phandle_with_args() from
210 * @blob: Pointer to device tree
211 * @src_node: Offset of device tree node containing a list
212 * @list_name: property name that contains a list
213 * @cells_name: property name that specifies the phandles' arguments count,
214 * or NULL to use @cells_count
215 * @cells_count: Cell count to use if @cells_name is NULL
216 * @index: index of a phandle to parse out
217 * @out_args: optional pointer to output arguments structure (will be filled)
218 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
219 * @list_name does not exist, a phandle was not found, @cells_name
220 * could not be found, the arguments were truncated or there were too
224 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
225 const char *list_name,
226 const char *cells_name,
227 int cell_count, int index,
228 struct fdtdec_phandle_args *out_args);
231 * Find the next numbered alias for a peripheral. This is used to enumerate
232 * all the peripherals of a certain type.
234 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
235 * this function will return a pointer to the node the alias points to, and
236 * then update *upto to 1. Next time you call this function, the next node
239 * All nodes returned will match the compatible ID, as it is assumed that
240 * all peripherals use the same driver.
242 * @param blob FDT blob to use
243 * @param name Root name of alias to search for
244 * @param id Compatible ID to look for
245 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
247 int fdtdec_next_alias(const void *blob, const char *name,
248 enum fdt_compat_id id, int *upto);
251 * Find the compatible ID for a given node.
253 * Generally each node has at least one compatible string attached to it.
254 * This function looks through our list of known compatible strings and
255 * returns the corresponding ID which matches the compatible string.
257 * @param blob FDT blob to use
258 * @param node Node containing compatible string to find
259 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
261 enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
264 * Find the next compatible node for a peripheral.
266 * Do the first call with node = 0. This function will return a pointer to
267 * the next compatible node. Next time you call this function, pass the
268 * value returned, and the next node will be provided.
270 * @param blob FDT blob to use
271 * @param node Start node for search
272 * @param id Compatible ID to look for (enum fdt_compat_id)
273 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
275 int fdtdec_next_compatible(const void *blob, int node,
276 enum fdt_compat_id id);
279 * Find the next compatible subnode for a peripheral.
281 * Do the first call with node set to the parent and depth = 0. This
282 * function will return the offset of the next compatible node. Next time
283 * you call this function, pass the node value returned last time, with
284 * depth unchanged, and the next node will be provided.
286 * @param blob FDT blob to use
287 * @param node Start node for search
288 * @param id Compatible ID to look for (enum fdt_compat_id)
289 * @param depthp Current depth (set to 0 before first call)
290 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
292 int fdtdec_next_compatible_subnode(const void *blob, int node,
293 enum fdt_compat_id id, int *depthp);
296 * Look up an address property in a node and return the parsed address, and
297 * optionally the parsed size.
299 * This variant assumes a known and fixed number of cells are used to
300 * represent the address and size.
302 * You probably don't want to use this function directly except to parse
303 * non-standard properties, and never to parse the "reg" property. Instead,
304 * use one of the "auto" variants below, which automatically honor the
305 * #address-cells and #size-cells properties in the parent node.
307 * @param blob FDT blob
308 * @param node node to examine
309 * @param prop_name name of property to find
310 * @param index which address to retrieve from a list of addresses. Often 0.
311 * @param na the number of cells used to represent an address
312 * @param ns the number of cells used to represent a size
313 * @param sizep a pointer to store the size into. Use NULL if not required
314 * @return address, if found, or FDT_ADDR_T_NONE if not
316 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
317 const char *prop_name, int index, int na, int ns,
321 * Look up an address property in a node and return the parsed address, and
322 * optionally the parsed size.
324 * This variant automatically determines the number of cells used to represent
325 * the address and size by parsing the provided parent node's #address-cells
326 * and #size-cells properties.
328 * @param blob FDT blob
329 * @param parent parent node of @node
330 * @param node node to examine
331 * @param prop_name name of property to find
332 * @param index which address to retrieve from a list of addresses. Often 0.
333 * @param sizep a pointer to store the size into. Use NULL if not required
334 * @return address, if found, or FDT_ADDR_T_NONE if not
336 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
337 int node, const char *prop_name, int index, fdt_size_t *sizep);
340 * Look up an address property in a node and return the parsed address, and
341 * optionally the parsed size.
343 * This variant automatically determines the number of cells used to represent
344 * the address and size by parsing the parent node's #address-cells
345 * and #size-cells properties. The parent node is automatically found.
347 * The automatic parent lookup implemented by this function is slow.
348 * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
351 * @param blob FDT blob
352 * @param parent parent node of @node
353 * @param node node to examine
354 * @param prop_name name of property to find
355 * @param index which address to retrieve from a list of addresses. Often 0.
356 * @param sizep a pointer to store the size into. Use NULL if not required
357 * @return address, if found, or FDT_ADDR_T_NONE if not
359 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
360 const char *prop_name, int index, fdt_size_t *sizep);
363 * Look up an address property in a node and return the parsed address.
365 * This variant hard-codes the number of cells used to represent the address
366 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
367 * always returns the first address value in the property (index 0).
369 * Use of this function is not recommended due to the hard-coding of cell
370 * counts. There is no programmatic validation that these hard-coded values
371 * actually match the device tree content in any way at all. This assumption
372 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
373 * set in the U-Boot build and exercising strict control over DT content to
374 * ensure use of matching #address-cells/#size-cells properties. However, this
375 * approach is error-prone; those familiar with DT will not expect the
376 * assumption to exist, and could easily invalidate it. If the assumption is
377 * invalidated, this function will not report the issue, and debugging will
378 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
380 * @param blob FDT blob
381 * @param node node to examine
382 * @param prop_name name of property to find
383 * @return address, if found, or FDT_ADDR_T_NONE if not
385 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
386 const char *prop_name);
389 * Look up an address property in a node and return the parsed address, and
390 * optionally the parsed size.
392 * This variant hard-codes the number of cells used to represent the address
393 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
394 * always returns the first address value in the property (index 0).
396 * Use of this function is not recommended due to the hard-coding of cell
397 * counts. There is no programmatic validation that these hard-coded values
398 * actually match the device tree content in any way at all. This assumption
399 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
400 * set in the U-Boot build and exercising strict control over DT content to
401 * ensure use of matching #address-cells/#size-cells properties. However, this
402 * approach is error-prone; those familiar with DT will not expect the
403 * assumption to exist, and could easily invalidate it. If the assumption is
404 * invalidated, this function will not report the issue, and debugging will
405 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
407 * @param blob FDT blob
408 * @param node node to examine
409 * @param prop_name name of property to find
410 * @param sizep a pointer to store the size into. Use NULL if not required
411 * @return address, if found, or FDT_ADDR_T_NONE if not
413 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
414 const char *prop_name, fdt_size_t *sizep);
417 * Look at an address property in a node and return the pci address which
418 * corresponds to the given type in the form of fdt_pci_addr.
419 * The property must hold one fdt_pci_addr with a lengh.
421 * @param blob FDT blob
422 * @param node node to examine
423 * @param type pci address type (FDT_PCI_SPACE_xxx)
424 * @param prop_name name of property to find
425 * @param addr returns pci address in the form of fdt_pci_addr
426 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
427 * format of the property was invalid, -ENXIO if the requested
428 * address type was not found
430 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
431 const char *prop_name, struct fdt_pci_addr *addr);
434 * Look at the compatible property of a device node that represents a PCI
435 * device and extract pci vendor id and device id from it.
437 * @param blob FDT blob
438 * @param node node to examine
439 * @param vendor vendor id of the pci device
440 * @param device device id of the pci device
441 * @return 0 if ok, negative on error
443 int fdtdec_get_pci_vendev(const void *blob, int node,
444 u16 *vendor, u16 *device);
447 * Look at the pci address of a device node that represents a PCI device
448 * and return base address of the pci device's registers.
450 * @param dev device to examine
451 * @param addr pci address in the form of fdt_pci_addr
452 * @param bar returns base address of the pci device's registers
453 * @return 0 if ok, negative on error
455 int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
459 * Look up a 32-bit integer property in a node and return it. The property
460 * must have at least 4 bytes of data. The value of the first cell is
463 * @param blob FDT blob
464 * @param node node to examine
465 * @param prop_name name of property to find
466 * @param default_val default value to return if the property is not found
467 * @return integer value, if found, or default_val if not
469 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
473 * Unsigned version of fdtdec_get_int. The property must have at least
474 * 4 bytes of data. The value of the first cell is returned.
476 * @param blob FDT blob
477 * @param node node to examine
478 * @param prop_name name of property to find
479 * @param default_val default value to return if the property is not found
480 * @return unsigned integer value, if found, or default_val if not
482 unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
483 unsigned int default_val);
486 * Get a variable-sized number from a property
488 * This reads a number from one or more cells.
490 * @param ptr Pointer to property
491 * @param cells Number of cells containing the number
492 * @return the value in the cells
494 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
497 * Look up a 64-bit integer property in a node and return it. The property
498 * must have at least 8 bytes of data (2 cells). The first two cells are
499 * concatenated to form a 8 bytes value, where the first cell is top half and
500 * the second cell is bottom half.
502 * @param blob FDT blob
503 * @param node node to examine
504 * @param prop_name name of property to find
505 * @param default_val default value to return if the property is not found
506 * @return integer value, if found, or default_val if not
508 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
509 uint64_t default_val);
512 * Checks whether a node is enabled.
513 * This looks for a 'status' property. If this exists, then returns 1 if
514 * the status is 'ok' and 0 otherwise. If there is no status property,
515 * it returns 1 on the assumption that anything mentioned should be enabled
518 * @param blob FDT blob
519 * @param node node to examine
520 * @return integer value 0 (not enabled) or 1 (enabled)
522 int fdtdec_get_is_enabled(const void *blob, int node);
525 * Make sure we have a valid fdt available to control U-Boot.
527 * If not, a message is printed to the console if the console is ready.
529 * @return 0 if all ok, -1 if not
531 int fdtdec_prepare_fdt(void);
534 * Checks that we have a valid fdt available to control U-Boot.
536 * However, if not then for the moment nothing is done, since this function
537 * is called too early to panic().
541 int fdtdec_check_fdt(void);
544 * Find the nodes for a peripheral and return a list of them in the correct
545 * order. This is used to enumerate all the peripherals of a certain type.
547 * To use this, optionally set up a /aliases node with alias properties for
548 * a peripheral. For example, for usb you could have:
551 * usb0 = "/ehci@c5008000";
552 * usb1 = "/ehci@c5000000";
555 * Pass "usb" as the name to this function and will return a list of two
556 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
558 * All nodes returned will match the compatible ID, as it is assumed that
559 * all peripherals use the same driver.
561 * If no alias node is found, then the node list will be returned in the
562 * order found in the fdt. If the aliases mention a node which doesn't
563 * exist, then this will be ignored. If nodes are found with no aliases,
564 * they will be added in any order.
566 * If there is a gap in the aliases, then this function return a 0 node at
567 * that position. The return value will also count these gaps.
569 * This function checks node properties and will not return nodes which are
570 * marked disabled (status = "disabled").
572 * @param blob FDT blob to use
573 * @param name Root name of alias to search for
574 * @param id Compatible ID to look for
575 * @param node_list Place to put list of found nodes
576 * @param maxcount Maximum number of nodes to find
577 * @return number of nodes found on success, FTD_ERR_... on error
579 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
580 enum fdt_compat_id id, int *node_list, int maxcount);
583 * This function is similar to fdtdec_find_aliases_for_id() except that it
584 * adds to the node_list that is passed in. Any 0 elements are considered
585 * available for allocation - others are considered already used and are
588 * You can use this by calling fdtdec_find_aliases_for_id() with an
589 * uninitialised array, then setting the elements that are returned to -1,
590 * say, then calling this function, perhaps with a different compat id.
591 * Any elements you get back that are >0 are new nodes added by the call
594 * Note that if you have some nodes with aliases and some without, you are
595 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
596 * one compat_id may fill in positions for which you have aliases defined
597 * for another compat_id. When you later call *this* function with the second
598 * compat_id, the alias positions may already be used. A debug warning may
599 * be generated in this case, but it is safest to define aliases for all
600 * nodes when you care about the ordering.
602 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
603 enum fdt_compat_id id, int *node_list, int maxcount);
606 * Get the alias sequence number of a node
608 * This works out whether a node is pointed to by an alias, and if so, the
609 * sequence number of that alias. Aliases are of the form <base><num> where
610 * <num> is the sequence number. For example spi2 would be sequence number
613 * @param blob Device tree blob (if NULL, then error is returned)
614 * @param base Base name for alias (before the underscore)
615 * @param node Node to look up
616 * @param seqp This is set to the sequence number if one is found,
617 * but otherwise the value is left alone
618 * @return 0 if a sequence was found, -ve if not
620 int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
624 * Get a property from the /chosen node
626 * @param blob Device tree blob (if NULL, then NULL is returned)
627 * @param name Property name to look up
628 * @return Value of property, or NULL if it does not exist
630 const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
633 * Get the offset of the given /chosen node
635 * This looks up a property in /chosen containing the path to another node,
636 * then finds the offset of that node.
638 * @param blob Device tree blob (if NULL, then error is returned)
639 * @param name Property name, e.g. "stdout-path"
640 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
642 int fdtdec_get_chosen_node(const void *blob, const char *name);
645 * Get the name for a compatible ID
647 * @param id Compatible ID to look for
648 * @return compatible string for that id
650 const char *fdtdec_get_compatible(enum fdt_compat_id id);
652 /* Look up a phandle and follow it to its node. Then return the offset
655 * @param blob FDT blob
656 * @param node node to examine
657 * @param prop_name name of property to find
658 * @return node offset if found, -ve error code on error
660 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
663 * Look up a property in a node and return its contents in an integer
664 * array of given length. The property must have at least enough data for
665 * the array (4*count bytes). It may have more, but this will be ignored.
667 * @param blob FDT blob
668 * @param node node to examine
669 * @param prop_name name of property to find
670 * @param array array to fill with data
671 * @param count number of array elements
672 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
673 * or -FDT_ERR_BADLAYOUT if not enough data
675 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
676 u32 *array, int count);
679 * Look up a property in a node and return its contents in an integer
680 * array of given length. The property must exist but may have less data that
681 * expected (4*count bytes). It may have more, but this will be ignored.
683 * @param blob FDT blob
684 * @param node node to examine
685 * @param prop_name name of property to find
686 * @param array array to fill with data
687 * @param count number of array elements
688 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
689 * property is not found
691 int fdtdec_get_int_array_count(const void *blob, int node,
692 const char *prop_name, u32 *array, int count);
695 * Look up a property in a node and return a pointer to its contents as a
696 * unsigned int array of given length. The property must have at least enough
697 * data for the array ('count' cells). It may have more, but this will be
698 * ignored. The data is not copied.
700 * Note that you must access elements of the array with fdt32_to_cpu(),
701 * since the elements will be big endian even on a little endian machine.
703 * @param blob FDT blob
704 * @param node node to examine
705 * @param prop_name name of property to find
706 * @param count number of array elements
707 * @return pointer to array if found, or NULL if the property is not
708 * found or there is not enough data
710 const u32 *fdtdec_locate_array(const void *blob, int node,
711 const char *prop_name, int count);
714 * Look up a boolean property in a node and return it.
716 * A boolean properly is true if present in the device tree and false if not
717 * present, regardless of its value.
719 * @param blob FDT blob
720 * @param node node to examine
721 * @param prop_name name of property to find
722 * @return 1 if the properly is present; 0 if it isn't present
724 int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
727 * Look in the FDT for a config item with the given name and return its value
728 * as a 32-bit integer. The property must have at least 4 bytes of data. The
729 * value of the first cell is returned.
731 * @param blob FDT blob to use
732 * @param prop_name Node property name
733 * @param default_val default value to return if the property is not found
734 * @return integer value, if found, or default_val if not
736 int fdtdec_get_config_int(const void *blob, const char *prop_name,
740 * Look in the FDT for a config item with the given name
741 * and return whether it exists.
743 * @param blob FDT blob
744 * @param prop_name property name to look up
745 * @return 1, if it exists, or 0 if not
747 int fdtdec_get_config_bool(const void *blob, const char *prop_name);
750 * Look in the FDT for a config item with the given name and return its value
753 * @param blob FDT blob
754 * @param prop_name property name to look up
755 * @returns property string, NULL on error.
757 char *fdtdec_get_config_string(const void *blob, const char *prop_name);
760 * Look up a property in a node and return its contents in a byte
761 * array of given length. The property must have at least enough data for
762 * the array (count bytes). It may have more, but this will be ignored.
764 * @param blob FDT blob
765 * @param node node to examine
766 * @param prop_name name of property to find
767 * @param array array to fill with data
768 * @param count number of array elements
769 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
770 * or -FDT_ERR_BADLAYOUT if not enough data
772 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
773 u8 *array, int count);
776 * Look up a property in a node and return a pointer to its contents as a
777 * byte array of given length. The property must have at least enough data
778 * for the array (count bytes). It may have more, but this will be ignored.
779 * The data is not copied.
781 * @param blob FDT blob
782 * @param node node to examine
783 * @param prop_name name of property to find
784 * @param count number of array elements
785 * @return pointer to byte array if found, or NULL if the property is not
786 * found or there is not enough data
788 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
789 const char *prop_name, int count);
792 * Look up a property in a node which contains a memory region address and
793 * size. Then return a pointer to this address.
795 * The property must hold one address with a length. This is only tested on
798 * @param blob FDT blob
799 * @param node node to examine
800 * @param prop_name name of property to find
801 * @param basep Returns base address of region
802 * @param size Returns size of region
803 * @return 0 if ok, -1 on error (property not found)
805 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
806 fdt_addr_t *basep, fdt_size_t *sizep);
808 enum fmap_compress_t {
819 /* A flash map entry, containing an offset and length */
823 uint32_t used; /* Number of bytes used in region */
824 enum fmap_compress_t compress_algo; /* Compression type */
825 enum fmap_hash_t hash_algo; /* Hash algorithm */
826 const uint8_t *hash; /* Hash value */
827 int hash_size; /* Hash size */
831 * Read a flash entry from the fdt
833 * @param blob FDT blob
834 * @param node Offset of node to read
835 * @param name Name of node being read
836 * @param entry Place to put offset and size of this node
837 * @return 0 if ok, -ve on error
839 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
840 struct fmap_entry *entry);
843 * Obtain an indexed resource from a device property.
845 * @param fdt FDT blob
846 * @param node node to examine
847 * @param property name of the property to parse
848 * @param index index of the resource to retrieve
849 * @param res returns the resource
850 * @return 0 if ok, negative on error
852 int fdt_get_resource(const void *fdt, int node, const char *property,
853 unsigned int index, struct fdt_resource *res);
856 * Obtain a named resource from a device property.
858 * Look up the index of the name in a list of strings and return the resource
861 * @param fdt FDT blob
862 * @param node node to examine
863 * @param property name of the property to parse
864 * @param prop_names name of the property containing the list of names
865 * @param name the name of the entry to look up
866 * @param res returns the resource
868 int fdt_get_named_resource(const void *fdt, int node, const char *property,
869 const char *prop_names, const char *name,
870 struct fdt_resource *res);
873 * Decode a named region within a memory bank of a given type.
875 * This function handles selection of a memory region. The region is
876 * specified as an offset/size within a particular type of memory.
878 * The properties used are:
880 * <mem_type>-memory<suffix> for the name of the memory bank
881 * <mem_type>-offset<suffix> for the offset in that bank
883 * The property value must have an offset and a size. The function checks
884 * that the region is entirely within the memory bank.5
886 * @param blob FDT blob
887 * @param node Node containing the properties (-1 for /config)
888 * @param mem_type Type of memory to use, which is a name, such as
889 * "u-boot" or "kernel".
890 * @param suffix String to append to the memory/offset
892 * @param basep Returns base of region
893 * @param sizep Returns size of region
894 * @return 0 if OK, -ive on error
896 int fdtdec_decode_memory_region(const void *blob, int node,
897 const char *mem_type, const char *suffix,
898 fdt_addr_t *basep, fdt_size_t *sizep);
900 /* Display timings from linux include/video/display_timing.h */
902 DISPLAY_FLAGS_HSYNC_LOW = 1 << 0,
903 DISPLAY_FLAGS_HSYNC_HIGH = 1 << 1,
904 DISPLAY_FLAGS_VSYNC_LOW = 1 << 2,
905 DISPLAY_FLAGS_VSYNC_HIGH = 1 << 3,
907 /* data enable flag */
908 DISPLAY_FLAGS_DE_LOW = 1 << 4,
909 DISPLAY_FLAGS_DE_HIGH = 1 << 5,
910 /* drive data on pos. edge */
911 DISPLAY_FLAGS_PIXDATA_POSEDGE = 1 << 6,
912 /* drive data on neg. edge */
913 DISPLAY_FLAGS_PIXDATA_NEGEDGE = 1 << 7,
914 DISPLAY_FLAGS_INTERLACED = 1 << 8,
915 DISPLAY_FLAGS_DOUBLESCAN = 1 << 9,
916 DISPLAY_FLAGS_DOUBLECLK = 1 << 10,
920 * A single signal can be specified via a range of minimal and maximal values
921 * with a typical value, that lies somewhere inbetween.
923 struct timing_entry {
930 * Single "mode" entry. This describes one set of signal timings a display can
931 * have in one setting. This struct can later be converted to struct videomode
932 * (see include/video/videomode.h). As each timing_entry can be defined as a
933 * range, one struct display_timing may become multiple struct videomodes.
935 * Example: hsync active high, vsync active low
938 * Video ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
939 * |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
940 * | | porch | | porch |
942 * HSync _|¯¯¯¯¯¯¯¯¯¯|___________________________________________|¯¯¯¯¯¯¯¯¯
944 * VSync ¯|__________|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯|_________
946 struct display_timing {
947 struct timing_entry pixelclock;
949 struct timing_entry hactive; /* hor. active video */
950 struct timing_entry hfront_porch; /* hor. front porch */
951 struct timing_entry hback_porch; /* hor. back porch */
952 struct timing_entry hsync_len; /* hor. sync len */
954 struct timing_entry vactive; /* ver. active video */
955 struct timing_entry vfront_porch; /* ver. front porch */
956 struct timing_entry vback_porch; /* ver. back porch */
957 struct timing_entry vsync_len; /* ver. sync len */
959 enum display_flags flags; /* display flags */
963 * fdtdec_decode_display_timing() - decode display timings
965 * Decode display timings from the supplied 'display-timings' node.
966 * See doc/device-tree-bindings/video/display-timing.txt for binding
969 * @param blob FDT blob
970 * @param node 'display-timing' node containing the timing subnodes
971 * @param index Index number to read (0=first timing subnode)
972 * @param config Place to put timings
973 * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
975 int fdtdec_decode_display_timing(const void *blob, int node, int index,
976 struct display_timing *config);
978 * Set up the device tree ready for use
980 int fdtdec_setup(void);