u-boot/include/fdtdec.h

1 /* 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 (-1U)
32 #define FDT_ADDR_T_NONE (-1U)
59  * be equal to: end - start + 1.
93  * t:        is 1 if the address is aliased (for non-relocatable I/O) below 1MB
96  * bbbbbbbb: is the 8-bit Bus Number
97  * ddddd:    is the 5-bit Device Number
98  * fff:      is the 3-bit Function Number
99  * rrrrrrrr: is the 8-bit Register Number
100  * hhhhhhhh: is a 32-bit unsigned number
101  * llllllll: is a 32-bit unsigned number
117 	return res->end - res->start + 1;  in fdt_resource_size()
131 					/* Tegra124 XUSB pad controller */
133 					/* Tegra210 XUSB pad controller */
149 	COMPAT_INTEL_BAYTRAIL_FSP_MDP,	/* Intel FSP memory-down params */
153 	COMPAT_ALTERA_SOCFPGA_PINCTRL_SINGLE,	/* SoCFPGA pinctrl-single */
175  * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
182  *	#list-cells = <2>;
186  *	#list-cells = <1>;
194  * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
208  * @return 0 on success (with @out_args filled out if not NULL), -ENOENT if
235  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
263  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
280  * @return offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
293  * non-standard properties, and never to parse the "reg" property. Instead,
295  * #address-cells and #size-cells properties in the parent node.
317  * the address and size by parsing the provided parent node's #address-cells
318  * and #size-cells properties.
339  * the address and size by parsing the parent node's #address-cells
340  * and #size-cells properties. The parent node is automatically found.
363  * This variant hard-codes the number of cells used to represent the address
367  * Use of this function is not recommended due to the hard-coding of cell
368  * counts. There is no programmatic validation that these hard-coded values
371  * set in the U-Boot build and exercising strict control over DT content to
372  * ensure use of matching #address-cells/#size-cells properties. However, this
373  * approach is error-prone; those familiar with DT will not expect the
390  * This variant hard-codes the number of cells used to represent the address
394  * Use of this function is not recommended due to the hard-coding of cell
395  * counts. There is no programmatic validation that these hard-coded values
398  * set in the U-Boot build and exercising strict control over DT content to
399  * ensure use of matching #address-cells/#size-cells properties. However, this
400  * approach is error-prone; those familiar with DT will not expect the
424  * @return 0 if ok, -ENOENT if the property did not exist, -EINVAL if the
425  *		format of the property was invalid, -ENXIO if the requested
457  * Look up a 32-bit integer property in a node and return it. The property
484  * Get a variable-sized number from a property
495  * Look up a 64-bit integer property in a node and return it. The property
523  * Make sure we have a valid fdt available to control U-Boot.
527  * @return 0 if all ok, -1 if not
532  * Checks that we have a valid fdt available to control U-Boot.
583  * available for allocation - others are considered already used and are
587  * uninitialised array, then setting the elements that are returned to -1,
616  * @return 0 if a sequence was found, -ve if not
630  * @return 0 highest alias ID, -1 if not found
650  * @param name		Property name, e.g. "stdout-path"
651  * @return Node offset referred to by that chosen node, or -ve FDT_ERR_...
669  * @return node offset if found, -ve error code on error
683  * @return 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
684  *		or -FDT_ERR_BADLAYOUT if not enough data
699  * @return number of array elements if ok, or -FDT_ERR_NOTFOUND if the
748  * as a 32-bit integer. The property must have at least 4 bytes of data. The
789  * @return 0 if ok, or -FDT_ERR_MISSING if the property is not found,
790  *		or -FDT_ERR_BADLAYOUT if not enough data
880  *	  |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
905  * fdtdec_decode_display_timing() - decode display timings
907  * Decode display timings from the supplied 'display-timings' node.
908  * See doc/device-tree-bindings/video/display-timing.txt for binding
912  * @param node		'display-timing' node containing the timing subnodes
915  * @return 0 if OK, -FDT_ERR_NOTFOUND if not found
921  * fdtdec_setup_mem_size_base() - decode and setup gd->ram_size and
922  * gd->ram_start
933  * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
939  * fdtdec_setup_memory_banksize() - decode and populate gd->bd->bi_dram
950  * @return 0 if OK, -EINVAL if the /memory node or reg property is missing or
962  * fdtdec_resetup()  - Set up the device tree again
976  * @return 0 if OK, -ve on error
982  * Board-specific FDT initialization. Returns the address to a device tree blob.
1017  * @return 0 if OK, -ve on error