libfdt/include/libfdt.h

30 	 * offset which is out-of-bounds, or which points to an
31 	 * unsuitable part of the structure for the operation. */
85 	 * is not NUL-terminated within the length of its value. */
98 	 * contains invalid flags or an invalid combination of flags. */
182  * fdt_first_subnode() - get offset of first direct subnode
185  * @offset:	Offset of node to check
186  * @return offset of first subnode, or -FDT_ERR_NOTFOUND if there is none
191  * fdt_next_subnode() - get offset of next direct subnode
194  * get direct subnodes of a parent node.
197  * @offset:	Offset of previous subnode
198  * @return offset of next subnode, or -FDT_ERR_NOTFOUND if there are no more
204  * fdt_for_each_subnode - iterate over all subnodes of a parent
266  * fdt_header_size - return the size of the tree's header
298  * @bufsize: size of the memory space at buf
301  * fdt to the buffer at buf of size bufsize.  The buffer may overlap
322  * fdt_get_string - retrieve a string from the strings block of a device tree
324  * @stroffset: offset of the string within the strings block (native endian)
328  * strings block of the device tree blob at fdt, and optionally also
333  *     NULL, if stroffset is out of bounds, or doesn't point to a valid string
338  * fdt_string - retrieve a string from the strings block of a device tree
340  * @stroffset: offset of the string within the strings block (native endian)
343  * strings block of the device tree blob at fdt.
347  *     NULL, if stroffset is out of bounds, or doesn't point to a valid string
371  * with a value of 0 or -1.
373  * This function is deprecated in favour of fdt_find_max_phandle().
408  * fdt_num_mem_rsv - retrieve the number of memory reserve map entries
411  * Returns the number of entries in the device tree blob's memory
416  *     the number of entries
425  * On success, *address and *size will contain the address and size of
440  * @parentoffset: structure block offset of a node
441  * @name: name of the subnode to locate
442  * @namelen: number of characters of name to consider
445  * namelen characters of name for matching the subnode name.  This is
446  * useful for finding subnodes based on a portion of a larger string,
454  * fdt_subnode_offset - find a subnode of a given node
456  * @parentoffset: structure block offset of a node
457  * @name: name of the subnode to locate
459  * fdt_subnode_offset() finds a subnode of the node at structure block
467  *	structure block offset of the requested subnode (>=0), on success
482  * @path: full path of the node to locate
483  * @namelen: number of characters of path to consider
486  * characters of path as the path name.
495  * @path: full path of the node to locate
497  * fdt_path_offset() finds a node of a given path in the device tree.
499  * results of this are undefined if any such path component is
505  *	structure block offset of the node with the requested path (>=0), on
518  * fdt_get_name - retrieve the name of a given node
520  * @nodeoffset: structure block offset of the starting node
523  * fdt_get_name() retrieves the name (including unit address) of the
525  * non-NULL, the length of this name is also returned, in the integer
530  *		If lenp is non-NULL, *lenp contains the length of that name
543  * fdt_first_property_offset - find the offset of a node's first property
545  * @nodeoffset: structure block offset of a node
547  * fdt_first_property_offset() finds the first property of the node at
551  *	structure block offset of the property (>=0), on success
565  * @offset: structure block offset of a property
569  * of the same node as the given property.
572  *	structure block offset of the next property (>=0), on success
584  * fdt_for_each_property_offset - iterate over all properties of a node
613  * @offset: offset of the property to retrieve
618  * offset.  If lenp is non-NULL, the length of the property value is
626  *		if lenp is non-NULL, *lenp contains the length of the property
644  * @nodeoffset: offset of the node whose property to find
645  * @name: name of the property to find
646  * @namelen: number of characters of name to consider
650  * characters of name for matching the property name.
662  * @nodeoffset: offset of the node whose property to find
663  * @name: name of the property to find
668  * named 'name' of the node at offset nodeoffset.  If lenp is
669  * non-NULL, the length of the property value is also returned, in the
674  *		if lenp is non-NULL, *lenp contains the length of the property
698  * fdt_getprop_by_offset - retrieve the value of a property at a given offset
700  * @offset: offset of the property to read
704  * fdt_getprop_by_offset() retrieves a pointer to the value of the
706  * to within the device blob itself, not a copy of the value).  If
707  * lenp is non-NULL, the length of the property value is also
711  * block, not a new copy of the name).
715  *		if lenp is non-NULL, *lenp contains the length of the property
736  * @nodeoffset: offset of the node whose property to find
737  * @name: name of the property to find
738  * @namelen: number of characters of name to consider
742  * characters of name for matching the property name.
757  * fdt_getprop - retrieve the value of a given property
759  * @nodeoffset: offset of the node whose property to find
760  * @name: name of the property to find
763  * fdt_getprop() retrieves a pointer to the value of the property
764  * named 'name' of the node at offset nodeoffset (this will be a
765  * pointer to within the device blob itself, not a copy of the value).
766  * If lenp is non-NULL, the length of the property value is also
771  *		if lenp is non-NULL, *lenp contains the length of the property
793  * fdt_get_phandle - retrieve the phandle of a given node
795  * @nodeoffset: structure block offset of the node
797  * fdt_get_phandle() retrieves the phandle of the device tree node at
801  *	the phandle of the node at nodeoffset, on success (!= 0, != -1)
809  * @name: name of the alias th look up
810  * @namelen: number of characters of name to consider
813  * characters of name for matching the alias name.
823  * @name: name of the alias th look up
825  * fdt_get_alias() retrieves the value of a given alias.  That is, the
826  * value of the property named 'name' in the node /aliases.
829  *	a pointer to the expansion of the alias named 'name', if it exists
835  * fdt_get_path - determine the full path of a node
837  * @nodeoffset: offset of the node whose path to find
839  * @buflen: size of the character buffer at buf
841  * fdt_get_path() computes the full path of the node at offset
849  *		buf contains the absolute path of the node at
852  *	-FDT_ERR_NOSPACE, the path of the given node is longer than (bufsize-1)
862  * fdt_supernode_atdepth_offset - find a specific ancestor of a node
864  * @nodeoffset: offset of the node whose parent to find
865  * @supernodedepth: depth of the ancestor to find
868  * fdt_supernode_atdepth_offset() finds an ancestor of the given node
872  * will always return 0, the offset of the root node.  If the node at
881  *	structure block offset of the node at node offset's ancestor
882  *		of depth supernodedepth (>=0), on success
884  *	-FDT_ERR_NOTFOUND, supernodedepth was greater than the depth of
895  * fdt_node_depth - find the depth of a given node
897  * @nodeoffset: offset of the node whose parent to find
899  * fdt_node_depth() finds the depth of a given node.  The root node
906  *	depth of the node at nodeoffset (>=0), on success
916  * fdt_parent_offset - find the parent of a given node
918  * @nodeoffset: offset of the node whose parent to find
920  * fdt_parent_offset() locates the parent node of a given node (that
921  * is, it finds the offset of the node which contains the node at
928  *	structure block offset of the parent of the node at nodeoffset
944  * @proplen: length of the value in propval
946  * fdt_node_offset_by_prop_value() returns the offset of the first
948  * value is of length proplen and has value equal to propval; or if
966  *	structure block offset of the located node (>= 0, >startoffset),
985  * fdt_node_offset_by_phandle() returns the offset of the node
991  *	structure block offset of the located node (>= 0), on success
1004  * @nodeoffset: offset of a tree node
1009  * 'compatible' property with the given string as one of its elements,
1032  * fdt_node_offset_by_compatible() returns the offset of the first
1050  *	structure block offset of the located node (>= 0, >startoffset),
1065  * @strlist: Property containing a list of strings to check
1066  * @listlen: Length of property
1078  * fdt_stringlist_count - count the number of strings in a string list
1080  * @nodeoffset: offset of a tree node
1081  * @property: name of the property containing the string list
1083  *   the number of strings in the given property
1092  * @nodeoffset: offset of a tree node
1093  * @property: name of the property containing the string list
1098  * finding the first occurrence of @string. This can for example happen with
1103  *   the index of the string in the list of strings
1114  * @nodeoffset: offset of a tree node
1115  * @property: name of the property containing the string list
1116  * @index: index of the string to return
1123  * If non-NULL, the length of the string (on success) or a negative error-code
1128  *   failure. On success the length of the string will be stored in the memory
1129  *   location pointed to by the lenp parameter, if non-NULL. On failure one of
1148  * requires that OF implementations handle values up to 4.
1157  * @nodeoffset: offset of the node to find the address size for
1178  * @nodeoffset: offset of the node to find the address range size for
1204  * @nodeoffset: offset of the node whose property to change
1205  * @name: name of the property to change
1206  * @namelen: number of characters of name to consider
1207  * @idx: index of the property to change in the array
1209  * @len: length of the property value
1213  * of the name. It is useful when you want to manipulate only one value of
1226  * @nodeoffset: offset of the node whose property to change
1227  * @name: name of the property to change
1229  * @len: length of the property value
1231  * fdt_setprop_inplace() replaces the value of a given property with
1232  * the data in val, of length len.  This function cannot change the
1233  * size of a property, and so will only work if len is equal to the
1234  * current length of the property.
1238  * of the tree.
1257  * fdt_setprop_inplace_u32 - change the value of a 32-bit integer property
1259  * @nodeoffset: offset of the node whose property to change
1260  * @name: name of the property to change
1263  * fdt_setprop_inplace_u32() replaces the value of a given property
1265  * if necessary.  This function cannot change the size of a property,
1271  * of the tree.
1292  * fdt_setprop_inplace_u64 - change the value of a 64-bit integer property
1294  * @nodeoffset: offset of the node whose property to change
1295  * @name: name of the property to change
1298  * fdt_setprop_inplace_u64() replaces the value of a given property
1300  * if necessary.  This function cannot change the size of a property,
1306  * of the tree.
1327  * fdt_setprop_inplace_cell - change the value of a single-cell property
1340  * @nodeoffset: offset of the node whose property to nop
1341  * @name: name of the property to nop
1348  * the property, and will not alter or move any other part of the
1366  * @nodeoffset: offset of the node to nop
1374  * move any other part of the tree.
1400  * fdt_create_with_flags - begin creation of a new fdt
1402  * @bufsize: size of the memory space at fdt
1403  * @flags: a valid combination of FDT_CREATE_FLAG_ flags, or 0.
1405  * fdt_create_with_flags() begins the process of creating a new fdt with
1418  * fdt_create - begin creation of a new fdt
1420  * @bufsize: size of the memory space at fdt
1457  * @name: name of property to add
1458  * @len: length of property value in bytes
1487  * address address of length size.
1490  * therefore change the indexes of some entries in the table.
1514  * therefore change the indexes of some entries in the table.
1518  *	-FDT_ERR_NOTFOUND, there is no entry of the given index (i.e. there
1530  * fdt_set_name - change the name of a given node
1532  * @nodeoffset: structure block offset of a node
1536  * of the given node with the given string.  NOTE: this function can't
1539  * with a name equal to one of the given node's siblings.
1542  * therefore change the offsets of some existing nodes.
1558  * @nodeoffset: offset of the node whose property to change
1559  * @name: name of the property to change
1561  * @len: length of the property value
1563  * fdt_setprop() sets the value of the named property in the given
1568  * therefore change the offsets of some existing nodes.
1589  * @nodeoffset: offset of the node whose property to change
1590  * @name: name of the property to change
1591  * @len: length of the property value
1599  * therefore change the offsets of some existing nodes.
1620  * @nodeoffset: offset of the node whose property to change
1621  * @name: name of the property to change
1624  * fdt_setprop_u32() sets the value of the named property in the given
1630  * therefore change the offsets of some existing nodes.
1655  * @nodeoffset: offset of the node whose property to change
1656  * @name: name of the property to change
1659  * fdt_setprop_u64() sets the value of the named property in the given
1665  * therefore change the offsets of some existing nodes.
1701  * @nodeoffset: offset of the node whose property to change
1702  * @name: name of the property to change
1705  * fdt_setprop_string() sets the value of the named property in the
1706  * given node to the given string value (using the length of the
1707  * string to determine the new length of the property), or creates a
1711  * therefore change the offsets of some existing nodes.
1733  * @nodeoffset: offset of the node whose property to change
1734  * @name: name of the property to change
1736  * fdt_setprop_empty() sets the value of the named property in the
1741  * therefore change the offsets of some existing nodes.
1762  * @nodeoffset: offset of the node whose property to change
1763  * @name: name of the property to append to
1765  * @len: length of the data to append to the property value
1771  * change the offsets of some existing nodes.
1792  * @nodeoffset: offset of the node whose property to change
1793  * @name: name of the property to change
1797  * (converting to big-endian if necessary) to the value of the named
1802  * change the offsets of some existing nodes.
1827  * @nodeoffset: offset of the node whose property to change
1828  * @name: name of the property to change
1832  * (converting to big-endian if necessary) to the value of the named
1837  * change the offsets of some existing nodes.
1873  * @nodeoffset: offset of the node whose property to change
1874  * @name: name of the property to change
1877  * fdt_appendprop_string() appends the given string to the value of
1882  * change the offsets of some existing nodes.
1903  * @parent: offset of the parent node
1904  * @nodeoffset: offset of the node to add a property at
1905  * @name: name of property
1906  * @addr: start address of a given range
1907  * @size: size of a given range
1910  * address and size) to the value of the named property in the given
1917  * change the offsets of some existing nodes.
1940  * @nodeoffset: offset of the node whose property to nop
1941  * @name: name of the property to nop
1946  * change the offsets of some existing nodes.
1964  * @parentoffset: structure block offset of a node
1965  * @name: name of the subnode to locate
1966  * @namelen: number of characters of name to consider
1969  * characters of name as the name of the new node.  This is useful for
1970  * creating subnodes based on a portion of a larger string, such as a
1981  * @parentoffset: structure block offset of a node
1982  * @name: name of the subnode to locate
1984  * fdt_add_subnode() creates a new node as a subnode of the node at
1989  * change the offsets of some existing nodes.
1992  *	structure block offset of the created nodeequested subnode (>=0), on
1997  *	-FDT_ERR_EXISTS, if the node at parentoffset already has a subnode of
2014  * @nodeoffset: offset of the node to nop
2020  * change the offsets of some existing nodes.