dtc/libfdt/libfdt.h

62 	/* FDT_ERR_NOTFOUND: The requested node or property does not exist */
64 	/* FDT_ERR_EXISTS: Attempted to create a node or property which
134 	 * unexpected or missing value, property or node. */
166  * @offset:	Offset of node to check
175  * get direct subnodes of a parent node.
187  * @node:	child node (int, lvalue)
189  * @parent:	parent node (int)
193  *	fdt_for_each_subnode(node, fdt, parent) {
194  *		Use node
198  *	if ((node < 0) && (node != -FDT_ERR_NOT_FOUND)) {
202  * Note that this is implemented as a macro and @node is used as
207 #define fdt_for_each_subnode(node, fdt, parent)		\  argument
208 	for (node = fdt_first_subnode(fdt, parent);	\
209 	     node >= 0;					\
210 	     node = fdt_next_subnode(fdt, node))
349  * @parentoffset: structure block offset of a node
363  * fdt_subnode_offset - find a subnode of a given node
365  * @parentoffset: structure block offset of a node
368  * fdt_subnode_offset() finds a subnode of the node at structure block
389  * fdt_path_offset_namelen - find a tree node by its full path
391  * @path: full path of the node to locate
402  * fdt_path_offset - find a tree node by its full path
404  * @path: full path of the node to locate
406  * fdt_path_offset() finds a node of a given path in the device tree.
414  *	structure block offset of the node with the requested path (>=0), on
417  *	-FDT_ERR_NOTFOUND, if the requested node does not exist
427  * fdt_get_name - retrieve the name of a given node
429  * @nodeoffset: structure block offset of the starting node
433  * device tree node at structure block offset nodeoffset.  If lenp is
438  *	pointer to the node's name, on success
452  * fdt_first_property_offset - find the offset of a node's first property
454  * @nodeoffset: structure block offset of a node
456  * fdt_first_property_offset() finds the first property of the node at
461  *	-FDT_ERR_NOTFOUND, if the requested node has no properties
472  * fdt_next_property_offset - step through a node's properties
478  * of the same node as the given property.
482  *	-FDT_ERR_NOTFOUND, if the given property is the last in its node
493  * fdt_for_each_property_offset - iterate over all properties of a node
497  * @node:		node offset (int)
501  *	fdt_for_each_property_offset(property, fdt, node) {
511  * iterator in the loop. The node variable can be constant or even a
514 #define fdt_for_each_property_offset(property, fdt, node)	\  argument
515 	for (property = fdt_first_property_offset(fdt, node);	\
553  * @nodeoffset: offset of the node whose property to find
569  * fdt_get_property - find a given property in a given node
571  * @nodeoffset: offset of the node whose property to find
577  * named 'name' of the node at offset nodeoffset.  If lenp is
587  *		-FDT_ERR_NOTFOUND, node does not have named property
645  * @nodeoffset: offset of the node whose property to find
668  * @nodeoffset: offset of the node whose property to find
673  * named 'name' of the node at offset nodeoffset (this will be a
684  *		-FDT_ERR_NOTFOUND, node does not have named property
702  * fdt_get_phandle - retrieve the phandle of a given node
704  * @nodeoffset: structure block offset of the node
706  * fdt_get_phandle() retrieves the phandle of the device tree node at
710  *	the phandle of the node at nodeoffset, on success (!= 0, != -1)
711  *	0, if the node has no phandle, or another error occurs
735  * value of the property named 'name' in the node /aliases.
739  *	NULL, if the given alias or the /aliases node does not exist
744  * fdt_get_path - determine the full path of a node
746  * @nodeoffset: offset of the node whose path to find
750  * fdt_get_path() computes the full path of the node at offset
758  *		buf contains the absolute path of the node at
761  *	-FDT_ERR_NOSPACE, the path of the given node is longer than (bufsize-1)
771  * fdt_supernode_atdepth_offset - find a specific ancestor of a node
773  * @nodeoffset: offset of the node whose parent to find
777  * fdt_supernode_atdepth_offset() finds an ancestor of the given node
781  * will always return 0, the offset of the root node.  If the node at
790  *	structure block offset of the node at node offset's ancestor
804  * fdt_node_depth - find the depth of a given node
806  * @nodeoffset: offset of the node whose parent to find
808  * fdt_node_depth() finds the depth of a given node.  The root node
815  *	depth of the node at nodeoffset (>=0), on success
825  * fdt_parent_offset - find the parent of a given node
827  * @nodeoffset: offset of the node whose parent to find
829  * fdt_parent_offset() locates the parent node of a given node (that
830  * is, it finds the offset of the node which contains the node at
837  *	structure block offset of the parent of the node at nodeoffset
856  * node after startoffset, which has a property named propname whose
858  * startoffset is -1, the very first such node in the tree.
871  * instead, the function will never locate the root node, even if it
875  *	structure block offset of the located node (>= 0, >startoffset),
877  *	-FDT_ERR_NOTFOUND, no node matching the criterion exists in the
890  * fdt_node_offset_by_phandle - find the node with a given phandle
894  * fdt_node_offset_by_phandle() returns the offset of the node
895  * which has the given phandle value.  If there is more than one node
900  *	structure block offset of the located node (>= 0), on success
901  *	-FDT_ERR_NOTFOUND, no node with that phandle exists
911  * fdt_node_check_compatible: check a node's compatible property
913  * @nodeoffset: offset of a tree node
917  * fdt_node_check_compatible() returns 0 if the given node contains a
922  *	0, if the node has a 'compatible' property listing the given string
923  *	1, if the node has a 'compatible' property, but it does not list
925  *	-FDT_ERR_NOTFOUND, if the given node has no 'compatible' property
942  * node after startoffset, which has a 'compatible' property which
944  * very first such node in the tree.
955  * instead, the function will never locate the root node, even if it
959  *	structure block offset of the located node (>= 0, >startoffset),
961  *	-FDT_ERR_NOTFOUND, no node matching the criterion exists in the
989  * @nodeoffset: offset of a tree node
1001  * @nodeoffset: offset of a tree node
1023  * @nodeoffset: offset of a tree node
1066  * @nodeoffset: offset of the node to find the address size for
1068  * When the node has a valid #address-cells property, returns its value.
1072  *      2, if the node has no #address-cells property
1073  *      -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
1087  * @nodeoffset: offset of the node to find the address range size for
1089  * When the node has a valid #size-cells property, returns its value.
1093  *      2, if the node has no #address-cells property
1094  *      -FDT_ERR_BADNCELLS, if the node has a badly formatted or invalid
1113  * @nodeoffset: offset of the node whose property to change
1135  * @nodeoffset: offset of the node whose property to change
1152  *	-FDT_ERR_NOTFOUND, node does not have the named property
1168  * @nodeoffset: offset of the node whose property to change
1185  *	-FDT_ERR_NOTFOUND, node does not have the named property
1203  * @nodeoffset: offset of the node whose property to change
1220  *	-FDT_ERR_NOTFOUND, node does not have the named property
1249  * @nodeoffset: offset of the node whose property to nop
1262  *	-FDT_ERR_NOTFOUND, node does not have the named property
1273  * fdt_nop_node - replace a node (subtree) with nop tags
1275  * @nodeoffset: offset of the node to nop
1277  * fdt_nop_node() will replace a given node's representation in the
1282  * the node and its properties and subnodes, and will not alter or
1401  * fdt_set_name - change the name of a given node
1403  * @nodeoffset: structure block offset of a node
1404  * @name: name to give the node
1407  * of the given node with the given string.  NOTE: this function can't
1409  * node's siblings; results are undefined if this function is invoked
1410  * with a name equal to one of the given node's siblings.
1429  * @nodeoffset: offset of the node whose property to change
1435  * node to the given value and length, creating the property if it
1460  * @nodeoffset: offset of the node whose property to change
1465  * fdt_setprop_placeholer() allocates the named property in the given node.
1491  * @nodeoffset: offset of the node whose property to change
1496  * node to the given 32-bit integer value (converting to big-endian if
1526  * @nodeoffset: offset of the node whose property to change
1531  * node to the given 64-bit integer value (converting to big-endian if
1572  * @nodeoffset: offset of the node whose property to change
1577  * given node to the given string value (using the length of the
1604  * @nodeoffset: offset of the node whose property to change
1608  * given node to an empty (zero length) value, or creates a new empty
1633  * @nodeoffset: offset of the node whose property to change
1639  * given node, creating the property if it does not already exist.
1663  * @nodeoffset: offset of the node whose property to change
1669  * property in the given node, or creates a new property with that
1698  * @nodeoffset: offset of the node whose property to change
1704  * property in the given node, or creates a new property with that
1744  * @nodeoffset: offset of the node whose property to change
1749  * the named property in the given node, or creates a new property
1774  * @nodeoffset: offset of the node whose property to nop
1784  *	-FDT_ERR_NOTFOUND, node does not have the named property
1796  * fdt_add_subnode_namelen - creates a new node based on substring
1798  * @parentoffset: structure block offset of a node
1803  * characters of name as the name of the new node.  This is useful for
1813  * fdt_add_subnode - creates a new node
1815  * @parentoffset: structure block offset of a node
1818  * fdt_add_subnode() creates a new node as a subnode of the node at
1831  *	-FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of
1834  *		blob to contain the new node
1846  * fdt_del_node - delete a node (subtree)
1848  * @nodeoffset: offset of the node to nop
1850  * fdt_del_node() will remove the given node, including all its