u-boot/include/fdtdec.h

3  * SPDX-License-Identifier:	GPL-2.0+
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
27 #define FDT_ADDR_T_NONE (-1ULL)
32 #define FDT_ADDR_T_NONE (-1U)
57  * be equal to: end - start + 1.
91  * t:        is 1 if the address is aliased (for non-relocatable I/O) below 1MB
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
115 	return res->end - res->start + 1;  in fdt_resource_size()
155 	COMPAT_INTEL_BAYTRAIL_FSP_MDP,	/* Intel FSP memory-down params */
159 	COMPAT_ALTERA_SOCFPGA_PINCTRL_SINGLE,	/* SoCFPGA pinctrl-single */
179  * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
186  *	#list-cells = <2>;
190  *	#list-cells = <1>;
198  * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
212  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
238  * @param id		Compatible ID to look for
239  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
266  * @param id		Compatible ID to look for (enum fdt_compat_id)
267  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
282  * @param id		Compatible ID to look for (enum fdt_compat_id)
284  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
290  * Look up an address property in a node and return the parsed address, and
297  * non-standard properties, and never to parse the "reg" property. Instead,
299  * #address-cells and #size-cells properties in the parent node.
317  * Look up an address property in a node and return the parsed address, and
321  * the address and size by parsing the provided parent node's #address-cells
322  * and #size-cells properties.
339  * Look up an address property in a node and return the parsed address, and
343  * the address and size by parsing the parent node's #address-cells
344  * and #size-cells properties. The parent node is automatically found.
365  * Look up an address property in a node and return the parsed address.
367  * This variant hard-codes the number of cells used to represent the address
371  * Use of this function is not recommended due to the hard-coding of cell
372  * counts. There is no programmatic validation that these hard-coded values
375  * set in the U-Boot build and exercising strict control over DT content to
376  * ensure use of matching #address-cells/#size-cells properties. However, this
377  * approach is error-prone; those familiar with DT will not expect the
391  * Look up an address property in a node and return the parsed address, and
394  * This variant hard-codes the number of cells used to represent the address
398  * Use of this function is not recommended due to the hard-coding of cell
399  * counts. There is no programmatic validation that these hard-coded values
402  * set in the U-Boot build and exercising strict control over DT content to
403  * ensure use of matching #address-cells/#size-cells properties. However, this
404  * approach is error-prone; those familiar with DT will not expect the
419  * Look at an address property in a node and return the pci address which
428  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
429  *		format of the property was invalid, -ENXIO if the requested
436  * Look at the compatible property of a device node that represents a PCI
449  * Look at the pci address of a device node that represents a PCI device
461  * Look up a 32-bit integer property in a node and return it. The property
488  * Get a variable-sized number from a property
499  * Look up a 64-bit integer property in a node and return it. The property
527  * Make sure we have a valid fdt available to control U-Boot.
531  * @return 0 if all ok, -1 if not
536  * Checks that we have a valid fdt available to control U-Boot.
549  * To use this, optionally set up a /aliases node with alias properties for
576  * @param id		Compatible ID to look for
587  * available for allocation - others are considered already used and are
591  * uninitialised array, then setting the elements that are returned to -1,
617  * @param node		Node to look up
620  * @return 0 if a sequence was found, -ve if not
629  * @param name		Property name to look up
637  * This looks up a property in /chosen containing the path to another node,
641  * @param name		Property name, e.g. "stdout-path"
642  * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
649  * @param id		Compatible ID to look for
654 /* Look up a phandle and follow it to its node. Then return the offset
660  * @return node offset if found, -ve error code on error
665  * Look up a property in a node and return its contents in an integer
674  * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
675  *		or -FDT_ERR_BADLAYOUT if not enough data
681  * Look up a property in a node and return its contents in an integer
690  * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
697  * Look up a property in a node and return a pointer to its contents as a
716  * Look up a boolean property in a node and return it.
738  * Look in the FDT for a config item with the given name and return its value
739  * as a 32-bit integer. The property must have at least 4 bytes of data. The
751  * Look in the FDT for a config item with the given name
755  * @param prop_name	property name to look up
761  * Look in the FDT for a config item with the given name and return its value
765  * @param prop_name     property name to look up
771  * Look up a property in a node and return its contents in a byte
780  * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
781  *		or -FDT_ERR_BADLAYOUT if not enough data
787  * Look up a property in a node and return a pointer to its contents as a
803  * Look up a property in a node which contains a memory region address and
807  * 32-bit machines.
814  * @return 0 if ok, -1 on error (property not found)
835  * Look up the index of the name in a list of strings and return the resource
842  * @param name		the name of the entry to look up
857  *	<mem_type>-memory<suffix> for the name of the memory bank
858  *	<mem_type>-offset<suffix> for the offset in that bank
864  * @param node		Node containing the properties (-1 for /config)
866  *			"u-boot" or "kernel".
871  * @return 0 if OK, -ive on error
916  *	  |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
941  * fdtdec_decode_display_timing() - decode display timings
943  * Decode display timings from the supplied 'display-timings' node.
944  * See doc/device-tree-bindings/video/display-timing.txt for binding
948  * @param node		'display-timing' node containing the timing subnodes
951  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
957  * fdtdec_setup_memory_size() - decode and setup gd->ram_size
967  * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
973  * fdtdec_setup_memory_banksize() - decode and populate gd->bd->bi_dram
984  * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
990  * Set up the device tree ready for use
995  * Board-specific FDT initialization. Returns the address to a device tree blob.