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 */
45 * Information about a resource. start is the first address of the resource
46 * and end is the last address (inclusive). The length of the resource will
47 * be equal to: end - start + 1.
55 FDT_PCI_SPACE_CONFIG = 0,
56 FDT_PCI_SPACE_IO = 0x01000000,
57 FDT_PCI_SPACE_MEM32 = 0x02000000,
58 FDT_PCI_SPACE_MEM64 = 0x03000000,
59 FDT_PCI_SPACE_MEM32_PREF = 0x42000000,
60 FDT_PCI_SPACE_MEM64_PREF = 0x43000000,
63 #define FDT_PCI_ADDR_CELLS 3
64 #define FDT_PCI_SIZE_CELLS 2
65 #define FDT_PCI_REG_SIZE \
66 ((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32))
69 * The Open Firmware spec defines PCI physical address as follows:
71 * bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
73 * phys.hi cell: npt000ss bbbbbbbb dddddfff rrrrrrrr
74 * phys.mid cell: hhhhhhhh hhhhhhhh hhhhhhhh hhhhhhhh
75 * phys.lo cell: llllllll llllllll llllllll llllllll
79 * n: is 0 if the address is relocatable, 1 otherwise
80 * p: is 1 if addressable region is prefetchable, 0 otherwise
81 * t: is 1 if the address is aliased (for non-relocatable I/O) below 1MB
82 * (for Memory), or below 64KB (for relocatable I/O)
83 * ss: is the space code, denoting the address space
84 * bbbbbbbb: is the 8-bit Bus Number
85 * ddddd: is the 5-bit Device Number
86 * fff: is the 3-bit Function Number
87 * rrrrrrrr: is the 8-bit Register Number
88 * hhhhhhhh: is a 32-bit unsigned number
89 * llllllll: is a 32-bit unsigned number
98 * Compute the size of a resource.
100 * @param res the resource to operate on
101 * @return the size of the resource
103 static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
105 return res->end - res->start + 1;
109 * Compat types that we know about and for which we might have drivers.
110 * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
115 COMPAT_NVIDIA_TEGRA20_USB, /* Tegra20 USB port */
116 COMPAT_NVIDIA_TEGRA30_USB, /* Tegra30 USB port */
117 COMPAT_NVIDIA_TEGRA114_USB, /* Tegra114 USB port */
118 COMPAT_NVIDIA_TEGRA20_EMC, /* Tegra20 memory controller */
119 COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
120 COMPAT_NVIDIA_TEGRA20_KBC, /* Tegra20 Keyboard */
121 COMPAT_NVIDIA_TEGRA20_NAND, /* Tegra2 NAND controller */
122 COMPAT_NVIDIA_TEGRA20_PWM, /* Tegra 2 PWM controller */
123 COMPAT_NVIDIA_TEGRA20_DC, /* Tegra 2 Display controller */
124 COMPAT_NVIDIA_TEGRA124_SDMMC, /* Tegra124 SDMMC controller */
125 COMPAT_NVIDIA_TEGRA30_SDMMC, /* Tegra30 SDMMC controller */
126 COMPAT_NVIDIA_TEGRA20_SDMMC, /* Tegra20 SDMMC controller */
127 COMPAT_NVIDIA_TEGRA124_PCIE, /* Tegra 124 PCIe controller */
128 COMPAT_NVIDIA_TEGRA30_PCIE, /* Tegra 30 PCIe controller */
129 COMPAT_NVIDIA_TEGRA20_PCIE, /* Tegra 20 PCIe controller */
130 COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
131 /* Tegra124 XUSB pad controller */
132 COMPAT_SMSC_LAN9215, /* SMSC 10/100 Ethernet LAN9215 */
133 COMPAT_SAMSUNG_EXYNOS5_SROMC, /* Exynos5 SROMC */
134 COMPAT_SAMSUNG_S3C2440_I2C, /* Exynos I2C Controller */
135 COMPAT_SAMSUNG_EXYNOS5_SOUND, /* Exynos Sound */
136 COMPAT_WOLFSON_WM8994_CODEC, /* Wolfson WM8994 Sound Codec */
137 COMPAT_GOOGLE_CROS_EC_KEYB, /* Google CROS_EC Keyboard */
138 COMPAT_SAMSUNG_EXYNOS_EHCI, /* Exynos EHCI controller */
139 COMPAT_SAMSUNG_EXYNOS5_XHCI, /* Exynos5 XHCI controller */
140 COMPAT_SAMSUNG_EXYNOS_USB_PHY, /* Exynos phy controller for usb2.0 */
141 COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
142 COMPAT_SAMSUNG_EXYNOS_TMU, /* Exynos TMU */
143 COMPAT_SAMSUNG_EXYNOS_FIMD, /* Exynos Display controller */
144 COMPAT_SAMSUNG_EXYNOS_MIPI_DSI, /* Exynos mipi dsi */
145 COMPAT_SAMSUNG_EXYNOS5_DP, /* Exynos Display port controller */
146 COMPAT_SAMSUNG_EXYNOS_DWMMC, /* Exynos DWMMC controller */
147 COMPAT_SAMSUNG_EXYNOS_MMC, /* Exynos MMC controller */
148 COMPAT_SAMSUNG_EXYNOS_SERIAL, /* Exynos UART */
149 COMPAT_MAXIM_MAX77686_PMIC, /* MAX77686 PMIC */
150 COMPAT_GENERIC_SPI_FLASH, /* Generic SPI Flash chip */
151 COMPAT_MAXIM_98095_CODEC, /* MAX98095 Codec */
152 COMPAT_INFINEON_SLB9635_TPM, /* Infineon SLB9635 TPM */
153 COMPAT_INFINEON_SLB9645_TPM, /* Infineon SLB9645 TPM */
154 COMPAT_SAMSUNG_EXYNOS5_I2C, /* Exynos5 High Speed I2C Controller */
155 COMPAT_SANDBOX_HOST_EMULATION, /* Sandbox emulation of a function */
156 COMPAT_SANDBOX_LCD_SDL, /* Sandbox LCD emulation with SDL */
157 COMPAT_TI_TPS65090, /* Texas Instrument TPS65090 */
158 COMPAT_NXP_PTN3460, /* NXP PTN3460 DP/LVDS bridge */
159 COMPAT_SAMSUNG_EXYNOS_SYSMMU, /* Exynos sysmmu */
160 COMPAT_PARADE_PS8625, /* Parade PS8622 EDP->LVDS bridge */
161 COMPAT_INTEL_MICROCODE, /* Intel microcode update */
162 COMPAT_MEMORY_SPD, /* Memory SPD information */
163 COMPAT_INTEL_PANTHERPOINT_AHCI, /* Intel Pantherpoint AHCI */
164 COMPAT_INTEL_MODEL_206AX, /* Intel Model 206AX CPU */
165 COMPAT_INTEL_GMA, /* Intel Graphics Media Accelerator */
166 COMPAT_AMS_AS3722, /* AMS AS3722 PMIC */
167 COMPAT_INTEL_ICH_SPI, /* Intel ICH7/9 SPI controller */
168 COMPAT_INTEL_QRK_MRC, /* Intel Quark MRC */
169 COMPAT_SOCIONEXT_XHCI, /* Socionext UniPhier xHCI */
170 COMPAT_INTEL_PCH, /* Intel PCH */
175 #define MAX_PHANDLE_ARGS 16
176 struct fdtdec_phandle_args {
179 uint32_t args[MAX_PHANDLE_ARGS];
183 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
185 * This function is useful to parse lists of phandles and their arguments.
198 * list = <&phandle1 1 2 &phandle2 3>;
201 * To get a device_node of the `node2' node you may call this:
202 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
205 * (This function is a modified version of __of_parse_phandle_with_args() from
208 * @blob: Pointer to device tree
209 * @src_node: Offset of device tree node containing a list
210 * @list_name: property name that contains a list
211 * @cells_name: property name that specifies the phandles' arguments count,
212 * or NULL to use @cells_count
213 * @cells_count: Cell count to use if @cells_name is NULL
214 * @index: index of a phandle to parse out
215 * @out_args: optional pointer to output arguments structure (will be filled)
216 * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
217 * @list_name does not exist, a phandle was not found, @cells_name
218 * could not be found, the arguments were truncated or there were too
222 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
223 const char *list_name,
224 const char *cells_name,
225 int cell_count, int index,
226 struct fdtdec_phandle_args *out_args);
229 * Find the next numbered alias for a peripheral. This is used to enumerate
230 * all the peripherals of a certain type.
232 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
233 * this function will return a pointer to the node the alias points to, and
234 * then update *upto to 1. Next time you call this function, the next node
237 * All nodes returned will match the compatible ID, as it is assumed that
238 * all peripherals use the same driver.
240 * @param blob FDT blob to use
241 * @param name Root name of alias to search for
242 * @param id Compatible ID to look for
243 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
245 int fdtdec_next_alias(const void *blob, const char *name,
246 enum fdt_compat_id id, int *upto);
249 * Find the compatible ID for a given node.
251 * Generally each node has at least one compatible string attached to it.
252 * This function looks through our list of known compatible strings and
253 * returns the corresponding ID which matches the compatible string.
255 * @param blob FDT blob to use
256 * @param node Node containing compatible string to find
257 * @return compatible ID, or COMPAT_UNKNOWN if we cannot find a match
259 enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
262 * Find the next compatible node for a peripheral.
264 * Do the first call with node = 0. This function will return a pointer to
265 * the next compatible node. Next time you call this function, pass the
266 * value returned, and the next node will be provided.
268 * @param blob FDT blob to use
269 * @param node Start node for search
270 * @param id Compatible ID to look for (enum fdt_compat_id)
271 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
273 int fdtdec_next_compatible(const void *blob, int node,
274 enum fdt_compat_id id);
277 * Find the next compatible subnode for a peripheral.
279 * Do the first call with node set to the parent and depth = 0. This
280 * function will return the offset of the next compatible node. Next time
281 * you call this function, pass the node value returned last time, with
282 * depth unchanged, and the next node will be provided.
284 * @param blob FDT blob to use
285 * @param node Start node for search
286 * @param id Compatible ID to look for (enum fdt_compat_id)
287 * @param depthp Current depth (set to 0 before first call)
288 * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
290 int fdtdec_next_compatible_subnode(const void *blob, int node,
291 enum fdt_compat_id id, int *depthp);
294 * Look up an address property in a node and return it as an address.
295 * The property must hold either one address with no trailing data or
296 * one address with a length. This is only tested on 32-bit machines.
298 * @param blob FDT blob
299 * @param node node to examine
300 * @param prop_name name of property to find
301 * @return address, if found, or FDT_ADDR_T_NONE if not
303 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
304 const char *prop_name);
307 * Look up an address property in a node and return it as an address.
308 * The property must hold one address with a length. This is only tested
309 * on 32-bit machines.
311 * @param blob FDT blob
312 * @param node node to examine
313 * @param prop_name name of property to find
314 * @return address, if found, or FDT_ADDR_T_NONE if not
316 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
317 const char *prop_name, fdt_size_t *sizep);
320 * Look at an address property in a node and return the pci address which
321 * corresponds to the given type in the form of fdt_pci_addr.
322 * The property must hold one fdt_pci_addr with a lengh.
324 * @param blob FDT blob
325 * @param node node to examine
326 * @param type pci address type (FDT_PCI_SPACE_xxx)
327 * @param prop_name name of property to find
328 * @param addr returns pci address in the form of fdt_pci_addr
329 * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
330 * format of the property was invalid, -ENXIO if the requested
331 * address type was not found
333 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
334 const char *prop_name, struct fdt_pci_addr *addr);
337 * Look at the compatible property of a device node that represents a PCI
338 * device and extract pci vendor id and device id from it.
340 * @param blob FDT blob
341 * @param node node to examine
342 * @param vendor vendor id of the pci device
343 * @param device device id of the pci device
344 * @return 0 if ok, negative on error
346 int fdtdec_get_pci_vendev(const void *blob, int node,
347 u16 *vendor, u16 *device);
350 * Look at the pci address of a device node that represents a PCI device
351 * and parse the bus, device and function number from it. For some cases
352 * like the bus number encoded in reg property is not correct after pci
353 * enumeration, this function looks through the node's compatible strings
354 * to get these numbers extracted instead.
356 * @param blob FDT blob
357 * @param node node to examine
358 * @param addr pci address in the form of fdt_pci_addr
359 * @param bdf returns bus, device, function triplet
360 * @return 0 if ok, negative on error
362 int fdtdec_get_pci_bdf(const void *blob, int node,
363 struct fdt_pci_addr *addr, pci_dev_t *bdf);
366 * Look at the pci address of a device node that represents a PCI device
367 * and return base address of the pci device's registers.
369 * @param blob FDT blob
370 * @param node node to examine
371 * @param addr pci address in the form of fdt_pci_addr
372 * @param bar returns base address of the pci device's registers
373 * @return 0 if ok, negative on error
375 int fdtdec_get_pci_bar32(const void *blob, int node,
376 struct fdt_pci_addr *addr, u32 *bar);
379 * Look up a 32-bit integer property in a node and return it. The property
380 * must have at least 4 bytes of data. The value of the first cell is
383 * @param blob FDT blob
384 * @param node node to examine
385 * @param prop_name name of property to find
386 * @param default_val default value to return if the property is not found
387 * @return integer value, if found, or default_val if not
389 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
393 * Get a variable-sized number from a property
395 * This reads a number from one or more cells.
397 * @param ptr Pointer to property
398 * @param cells Number of cells containing the number
399 * @return the value in the cells
401 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
404 * Look up a 64-bit integer property in a node and return it. The property
405 * must have at least 8 bytes of data (2 cells). The first two cells are
406 * concatenated to form a 8 bytes value, where the first cell is top half and
407 * the second cell is bottom half.
409 * @param blob FDT blob
410 * @param node node to examine
411 * @param prop_name name of property to find
412 * @param default_val default value to return if the property is not found
413 * @return integer value, if found, or default_val if not
415 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
416 uint64_t default_val);
419 * Checks whether a node is enabled.
420 * This looks for a 'status' property. If this exists, then returns 1 if
421 * the status is 'ok' and 0 otherwise. If there is no status property,
422 * it returns 1 on the assumption that anything mentioned should be enabled
425 * @param blob FDT blob
426 * @param node node to examine
427 * @return integer value 0 (not enabled) or 1 (enabled)
429 int fdtdec_get_is_enabled(const void *blob, int node);
432 * Make sure we have a valid fdt available to control U-Boot.
434 * If not, a message is printed to the console if the console is ready.
436 * @return 0 if all ok, -1 if not
438 int fdtdec_prepare_fdt(void);
441 * Checks that we have a valid fdt available to control U-Boot.
443 * However, if not then for the moment nothing is done, since this function
444 * is called too early to panic().
448 int fdtdec_check_fdt(void);
451 * Find the nodes for a peripheral and return a list of them in the correct
452 * order. This is used to enumerate all the peripherals of a certain type.
454 * To use this, optionally set up a /aliases node with alias properties for
455 * a peripheral. For example, for usb you could have:
458 * usb0 = "/ehci@c5008000";
459 * usb1 = "/ehci@c5000000";
462 * Pass "usb" as the name to this function and will return a list of two
463 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
465 * All nodes returned will match the compatible ID, as it is assumed that
466 * all peripherals use the same driver.
468 * If no alias node is found, then the node list will be returned in the
469 * order found in the fdt. If the aliases mention a node which doesn't
470 * exist, then this will be ignored. If nodes are found with no aliases,
471 * they will be added in any order.
473 * If there is a gap in the aliases, then this function return a 0 node at
474 * that position. The return value will also count these gaps.
476 * This function checks node properties and will not return nodes which are
477 * marked disabled (status = "disabled").
479 * @param blob FDT blob to use
480 * @param name Root name of alias to search for
481 * @param id Compatible ID to look for
482 * @param node_list Place to put list of found nodes
483 * @param maxcount Maximum number of nodes to find
484 * @return number of nodes found on success, FTD_ERR_... on error
486 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
487 enum fdt_compat_id id, int *node_list, int maxcount);
490 * This function is similar to fdtdec_find_aliases_for_id() except that it
491 * adds to the node_list that is passed in. Any 0 elements are considered
492 * available for allocation - others are considered already used and are
495 * You can use this by calling fdtdec_find_aliases_for_id() with an
496 * uninitialised array, then setting the elements that are returned to -1,
497 * say, then calling this function, perhaps with a different compat id.
498 * Any elements you get back that are >0 are new nodes added by the call
501 * Note that if you have some nodes with aliases and some without, you are
502 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
503 * one compat_id may fill in positions for which you have aliases defined
504 * for another compat_id. When you later call *this* function with the second
505 * compat_id, the alias positions may already be used. A debug warning may
506 * be generated in this case, but it is safest to define aliases for all
507 * nodes when you care about the ordering.
509 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
510 enum fdt_compat_id id, int *node_list, int maxcount);
513 * Get the alias sequence number of a node
515 * This works out whether a node is pointed to by an alias, and if so, the
516 * sequence number of that alias. Aliases are of the form <base><num> where
517 * <num> is the sequence number. For example spi2 would be sequence number
520 * @param blob Device tree blob (if NULL, then error is returned)
521 * @param base Base name for alias (before the underscore)
522 * @param node Node to look up
523 * @param seqp This is set to the sequence number if one is found,
524 * but otherwise the value is left alone
525 * @return 0 if a sequence was found, -ve if not
527 int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
531 * Get the offset of the given chosen node
533 * This looks up a property in /chosen containing the path to another node,
534 * then finds the offset of that node.
536 * @param blob Device tree blob (if NULL, then error is returned)
537 * @param name Property name, e.g. "stdout-path"
538 * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
540 int fdtdec_get_chosen_node(const void *blob, const char *name);
543 * Get the name for a compatible ID
545 * @param id Compatible ID to look for
546 * @return compatible string for that id
548 const char *fdtdec_get_compatible(enum fdt_compat_id id);
550 /* Look up a phandle and follow it to its node. Then return the offset
553 * @param blob FDT blob
554 * @param node node to examine
555 * @param prop_name name of property to find
556 * @return node offset if found, -ve error code on error
558 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
561 * Look up a property in a node and return its contents in an integer
562 * array of given length. The property must have at least enough data for
563 * the array (4*count bytes). It may have more, but this will be ignored.
565 * @param blob FDT blob
566 * @param node node to examine
567 * @param prop_name name of property to find
568 * @param array array to fill with data
569 * @param count number of array elements
570 * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
571 * or -FDT_ERR_BADLAYOUT if not enough data
573 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
574 u32 *array, int count);
577 * Look up a property in a node and return its contents in an integer
578 * array of given length. The property must exist but may have less data that
579 * expected (4*count bytes). It may have more, but this will be ignored.
581 * @param blob FDT blob
582 * @param node node to examine
583 * @param prop_name name of property to find
584 * @param array array to fill with data
585 * @param count number of array elements
586 * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
587 * property is not found
589 int fdtdec_get_int_array_count(const void *blob, int node,
590 const char *prop_name, u32 *array, int count);
593 * Look up a property in a node and return a pointer to its contents as a
594 * unsigned int array of given length. The property must have at least enough
595 * data for the array ('count' cells). It may have more, but this will be
596 * ignored. The data is not copied.
598 * Note that you must access elements of the array with fdt32_to_cpu(),
599 * since the elements will be big endian even on a little endian machine.
601 * @param blob FDT blob
602 * @param node node to examine
603 * @param prop_name name of property to find
604 * @param count number of array elements
605 * @return pointer to array if found, or NULL if the property is not
606 * found or there is not enough data
608 const u32 *fdtdec_locate_array(const void *blob, int node,
609 const char *prop_name, int count);
612 * Look up a boolean property in a node and return it.
614 * A boolean properly is true if present in the device tree and false if not
615 * present, regardless of its value.
617 * @param blob FDT blob
618 * @param node node to examine
619 * @param prop_name name of property to find
620 * @return 1 if the properly is present; 0 if it isn't present
622 int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
625 * Look in the FDT for a config item with the given name and return its value
626 * as a 32-bit integer. The property must have at least 4 bytes of data. The
627 * value of the first cell is returned.
629 * @param blob FDT blob to use
630 * @param prop_name Node property name
631 * @param default_val default value to return if the property is not found
632 * @return integer value, if found, or default_val if not
634 int fdtdec_get_config_int(const void *blob, const char *prop_name,
638 * Look in the FDT for a config item with the given name
639 * and return whether it exists.
641 * @param blob FDT blob
642 * @param prop_name property name to look up
643 * @return 1, if it exists, or 0 if not
645 int fdtdec_get_config_bool(const void *blob, const char *prop_name);
648 * Look in the FDT for a config item with the given name and return its value
651 * @param blob FDT blob
652 * @param prop_name property name to look up
653 * @returns property string, NULL on error.
655 char *fdtdec_get_config_string(const void *blob, const char *prop_name);
658 * Look up a property in a node and return its contents in a byte
659 * array of given length. The property must have at least enough data for
660 * the array (count bytes). It may have more, but this will be ignored.
662 * @param blob FDT blob
663 * @param node node to examine
664 * @param prop_name name of property to find
665 * @param array array to fill with data
666 * @param count number of array elements
667 * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
668 * or -FDT_ERR_BADLAYOUT if not enough data
670 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
671 u8 *array, int count);
674 * Look up a property in a node and return a pointer to its contents as a
675 * byte array of given length. The property must have at least enough data
676 * for the array (count bytes). It may have more, but this will be ignored.
677 * The data is not copied.
679 * @param blob FDT blob
680 * @param node node to examine
681 * @param prop_name name of property to find
682 * @param count number of array elements
683 * @return pointer to byte array if found, or NULL if the property is not
684 * found or there is not enough data
686 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
687 const char *prop_name, int count);
690 * Look up a property in a node which contains a memory region address and
691 * size. Then return a pointer to this address.
693 * The property must hold one address with a length. This is only tested on
696 * @param blob FDT blob
697 * @param node node to examine
698 * @param prop_name name of property to find
699 * @param basep Returns base address of region
700 * @param size Returns size of region
701 * @return 0 if ok, -1 on error (property not found)
703 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
704 fdt_addr_t *basep, fdt_size_t *sizep);
706 enum fmap_compress_t {
717 /* A flash map entry, containing an offset and length */
721 uint32_t used; /* Number of bytes used in region */
722 enum fmap_compress_t compress_algo; /* Compression type */
723 enum fmap_hash_t hash_algo; /* Hash algorithm */
724 const uint8_t *hash; /* Hash value */
725 int hash_size; /* Hash size */
729 * Read a flash entry from the fdt
731 * @param blob FDT blob
732 * @param node Offset of node to read
733 * @param name Name of node being read
734 * @param entry Place to put offset and size of this node
735 * @return 0 if ok, -ve on error
737 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
738 struct fmap_entry *entry);
741 * Obtain an indexed resource from a device property.
743 * @param fdt FDT blob
744 * @param node node to examine
745 * @param property name of the property to parse
746 * @param index index of the resource to retrieve
747 * @param res returns the resource
748 * @return 0 if ok, negative on error
750 int fdt_get_resource(const void *fdt, int node, const char *property,
751 unsigned int index, struct fdt_resource *res);
754 * Obtain a named resource from a device property.
756 * Look up the index of the name in a list of strings and return the resource
759 * @param fdt FDT blob
760 * @param node node to examine
761 * @param property name of the property to parse
762 * @param prop_names name of the property containing the list of names
763 * @param name the name of the entry to look up
764 * @param res returns the resource
766 int fdt_get_named_resource(const void *fdt, int node, const char *property,
767 const char *prop_names, const char *name,
768 struct fdt_resource *res);
771 * Decode a named region within a memory bank of a given type.
773 * This function handles selection of a memory region. The region is
774 * specified as an offset/size within a particular type of memory.
776 * The properties used are:
778 * <mem_type>-memory<suffix> for the name of the memory bank
779 * <mem_type>-offset<suffix> for the offset in that bank
781 * The property value must have an offset and a size. The function checks
782 * that the region is entirely within the memory bank.5
784 * @param blob FDT blob
785 * @param node Node containing the properties (-1 for /config)
786 * @param mem_type Type of memory to use, which is a name, such as
787 * "u-boot" or "kernel".
788 * @param suffix String to append to the memory/offset
790 * @param basep Returns base of region
791 * @param sizep Returns size of region
792 * @return 0 if OK, -ive on error
794 int fdtdec_decode_memory_region(const void *blob, int node,
795 const char *mem_type, const char *suffix,
796 fdt_addr_t *basep, fdt_size_t *sizep);