lib/libfdt/libfdt.h

24 	/* FDT_ERR_EXISTS: Attempted to create a node or property which
27 	/* FDT_ERR_NOSPACE: Operation needed to expand the device
28 	 * tree, but its buffer did not have sufficient space to
29 	 * contain the expanded tree. Use fdt_open_into() to move the
30 	 * device tree to a buffer with more space. */
35 	 * offset which is out-of-bounds, or which points to an
57 	/* FDT_ERR_BADMAGIC: Given "device tree" appears not to be a
64 	 * required to convert the tree to the expected version. */
73 	 * then strings).  Use fdt_open_into() to reorganize the tree
89 	 * value. For example: a property expected to contain a string list
94 	 * correctly structured, cannot be applied due to some
113 	/* Valid values for phandles range from 1 to 2^32-2. */
130  * External helpers to access words from a device tree blob. They're built
131  * to work even with unaligned pointers on platforms (such as ARMv5) that don't
191  * @offset:	Offset of node to check
202  * After first calling fdt_first_subnode(), call this function repeatedly to
273  * @fdt: pointer to a flattened device tree
280  * fdt_header_size_ - internal function to get header size from a version number
289  * @fdt: pointer to data which might be a flattened device tree
292  * appears to be a flattened device tree, and that the header contains
293  * valid information (to the extent that can be determined from the
297  *     0, if the buffer appears to contain a valid device tree
307  * @fdt: pointer to the device tree to move
308  * @buf: pointer to memory where the device is to be moved
312  * fdt to the buffer at buf of size bufsize.  The buffer may overlap
319  *     -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree
334  * @fdt: pointer to the device tree blob
336  * @lenp: optional pointer to return the string's length
338  * fdt_get_string() retrieves a pointer to a single string from the
343  *     a pointer to the string, on success
344  *     NULL, if stroffset is out of bounds, or doesn't point to a valid string
350  * @fdt: pointer to the device tree blob
353  * fdt_string() retrieves a pointer to a single string from the
357  *     a pointer to the string, on success
358  *     NULL, if stroffset is out of bounds, or doesn't point to a valid string
364  * @fdt: pointer to the device tree blob
378  * @fdt: pointer to the device tree blob
405  * @fdt: pointer to the device tree blob
419  * @fdt: pointer to the device tree blob
432  * @fdt: pointer to the device tree blob
434  * @address: pointer to 64-bit variable to hold the start address
435  * @size: pointer to 64-bit variable to hold the size of the entry
451  * @fdt: pointer to the device tree blob
453  * @name: name of the subnode to locate
454  * @namelen: number of characters of name to consider
456  * Identical to fdt_subnode_offset(), but only examine the first
469  * @fdt: pointer to the device tree blob
471  * @name: name of the subnode to locate
483  *	-FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE
495  * @fdt: pointer to the device tree blob
496  * @path: full path of the node to locate
497  * @namelen: number of characters of path to consider
499  * Identical to fdt_path_offset(), but only consider the first namelen
510  * @fdt: pointer to the device tree blob
511  * @path: full path of the node to locate
535  * @fdt: pointer to the device tree blob
537  * @lenp: pointer to an integer variable (will be overwritten) or NULL
542  * pointed to by lenp.
545  *	pointer to the node's name, on success
550  *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE
560  * @fdt: pointer to the device tree blob
569  *	-FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_BEGIN_NODE tag
580  * @fdt: pointer to the device tree blob
590  *	-FDT_ERR_BADOFFSET, if nodeoffset did not point to an FDT_PROP tag
628  * @fdt: pointer to the device tree blob
629  * @offset: offset of the property to retrieve
630  * @lenp: pointer to an integer variable (will be overwritten) or NULL
632  * fdt_get_property_by_offset() retrieves a pointer to the
635  * also returned, in the integer pointed to by lenp.
641  *	pointer to the structure representing the property
646  *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag
659  * @fdt: pointer to the device tree blob
660  * @nodeoffset: offset of the node whose property to find
661  * @name: name of the property to find
662  * @namelen: number of characters of name to consider
663  * @lenp: pointer to an integer variable (will be overwritten) or NULL
665  * Identical to fdt_get_property(), but only examine the first namelen
668  * Return: pointer to the structure representing the property, or NULL
680  * @fdt: pointer to the device tree blob
681  * @nodeoffset: offset of the node whose property to find
682  * @name: name of the property to find
683  * @lenp: pointer to an integer variable (will be overwritten) or NULL
685  * fdt_get_property() retrieves a pointer to the fdt_property
686  * structure within the device tree blob corresponding to the property
689  * integer pointed to by lenp.
692  *	pointer to the structure representing the property
698  *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE
718  * @fdt: pointer to the device tree blob
719  * @offset: offset of the property to read
720  * @namep: pointer to a string variable (will be overwritten) or NULL
721  * @lenp: pointer to an integer variable (will be overwritten) or NULL
723  * fdt_getprop_by_offset() retrieves a pointer to the value of the
725  * to within the device blob itself, not a copy of the value).  If
727  * returned, in the integer pointed to by lenp.  If namep is non-NULL,
728  * the property's namne will also be returned in the char * pointed to
729  * by namep (this will be a pointer to within the device tree's string
733  *	pointer to the property's value
736  *		if namep is non-NULL *namep contiains a pointer to the property
740  *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_PROP tag
754  * @fdt: pointer to the device tree blob
755  * @nodeoffset: offset of the node whose property to find
756  * @name: name of the property to find
757  * @namelen: number of characters of name to consider
758  * @lenp: pointer to an integer variable (will be overwritten) or NULL
760  * Identical to fdt_getprop(), but only examine the first namelen
763  * Return: pointer to the property's value or NULL on error
779  * @fdt: pointer to the device tree blob
780  * @nodeoffset: offset of the node whose property to find
781  * @name: name of the property to find
782  * @lenp: pointer to an integer variable (will be overwritten) or NULL
784  * fdt_getprop() retrieves a pointer to the value of the property
786  * pointer to within the device blob itself, not a copy of the value).
788  * returned, in the integer pointed to by @lenp.
791  *	pointer to the property's value
797  *		-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE
815  * @fdt: pointer to the device tree blob
829  * @fdt: pointer to the device tree blob
831  * @namelen: number of characters of name to consider
833  * Identical to fdt_get_alias(), but only examine the first @namelen
836  * Return: a pointer to the expansion of the alias named @name, if it exists,
846  * @fdt: pointer to the device tree blob
853  *	a pointer to the expansion of the alias named 'name', if it exists
860  * @fdt: pointer to the device tree blob
861  * @nodeoffset: offset of the node whose path to find
862  * @buf: character buffer to contain the returned path (will be overwritten)
869  * structure from the start to nodeoffset.
875  *	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
887  * @fdt: pointer to the device tree blob
888  * @nodeoffset: offset of the node whose parent to find
889  * @supernodedepth: depth of the ancestor to find
890  * @nodedepth: pointer to an integer variable (will be overwritten) or NULL
902  * structure from the start to nodeoffset.
907  *	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
920  * @fdt: pointer to the device tree blob
921  * @nodeoffset: offset of the node whose parent to find
927  * structure from the start to nodeoffset.
931  *	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
941  * @fdt: pointer to the device tree blob
942  * @nodeoffset: offset of the node whose parent to find
949  * structure from the start to nodeoffset, *twice*.
954  *	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
964  * @fdt: pointer to the device tree blob
966  * @propname: property name to check
967  * @propval: property value to search for
972  * value is of length proplen and has value equal to propval; or if
975  * To iterate through all nodes matching the criterion, the following
985  * Note the -1 in the first call to the function, if 0 is used here
994  *	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
1006  * @fdt: pointer to the device tree blob
1027  * @fdt: pointer to the device tree blob
1029  * @compatible: string to match against
1040  *	-FDT_ERR_BADOFFSET, if nodeoffset does not refer to a BEGIN_NODE tag
1051  * @fdt: pointer to the device tree blob
1053  * @compatible: 'compatible' string to match against
1060  * To iterate through all nodes matching the criterion, the following
1068  * Note the -1 in the first call to the function, if 0 is used here
1077  *	-FDT_ERR_BADOFFSET, nodeoffset does not refer to a BEGIN_NODE tag
1088  * @strlist: Property containing a list of strings to check
1090  * @str: String to search for
1102  * @fdt: pointer to the device tree blob
1115  * @fdt: pointer to the device tree blob
1118  * @string: string to look up in the string list
1120  * Note that it is possible for this function to succeed on property values
1137  * @fdt: pointer to the device tree blob
1140  * @index: index of the string to return
1148  * (on failure) will be stored in the integer pointer to by lenp.
1151  *   A pointer to the string at the given index in the string list or NULL on
1153  *   location pointed to by the lenp parameter, if non-NULL. On failure one of
1172  * requires that OF implementations handle values up to 4.
1180  * @fdt: pointer to the device tree blob
1181  * @nodeoffset: offset of the node to find the address size for
1201  * @fdt: pointer to the device tree blob
1202  * @nodeoffset: offset of the node to find the address range size for
1227  * @fdt: pointer to the device tree blob
1228  * @nodeoffset: offset of the node whose property to change
1229  * @name: name of the property to change
1230  * @namelen: number of characters of name to consider
1231  * @idx: index of the property to change in the array
1232  * @val: pointer to data to replace the property value with
1235  * Identical to fdt_setprop_inplace(), but modifies the given property
1237  * of the name. It is useful when you want to manipulate only one value of
1251  * @fdt: pointer to the device tree blob
1252  * @nodeoffset: offset of the node whose property to change
1253  * @name: name of the property to change
1254  * @val: pointer to data to replace the property value with
1259  * size of a property, and so will only work if len is equal to the
1268  *	-FDT_ERR_NOSPACE, if len is not equal to the property's current length
1270  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1284  * @fdt: pointer to the device tree blob
1285  * @nodeoffset: offset of the node whose property to change
1286  * @name: name of the property to change
1287  * @val: 32-bit integer value to replace the property with
1290  * with the 32-bit integer value in val, converting val to big-endian
1301  *	-FDT_ERR_NOSPACE, if the property's length is not equal to 4
1303  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1319  * @fdt: pointer to the device tree blob
1320  * @nodeoffset: offset of the node whose property to change
1321  * @name: name of the property to change
1322  * @val: 64-bit integer value to replace the property with
1325  * with the 64-bit integer value in val, converting val to big-endian
1336  *	-FDT_ERR_NOSPACE, if the property's length is not equal to 8
1338  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1354  * @fdt: pointer to the device tree blob
1356  * @name: name of the property to change the value of
1370  * @fdt: pointer to the device tree blob
1371  * @nodeoffset: offset of the node whose property to nop
1372  * @name: name of the property to nop
1385  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1396  * @fdt: pointer to the device tree blob
1397  * @nodeoffset: offset of the node to nop
1409  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1424 	/* FDT_CREATE_FLAG_NO_NAME_DEDUP: Do not try to de-duplicate property
1432  * @buf: pointer to memory allocated where fdt will be created
1439  * fdt creation process must end with fdt_finished() to produce a valid fdt.
1450  * @buf: pointer to memory allocated where fdt will be created
1453  * fdt_create() is equivalent to fdt_create_with_flags() with flags=0.
1485  * fdt_property_placeholder - add a new property and return a ptr to its value
1487  * @fdt: pointer to the device tree blob
1488  * @name: name of property to add
1490  * @valp: returns a pointer to where where the value should be placed
1514  * @fdt: pointer to the device tree blob
1518  * Adds a reserve map entry to the given blob reserving a region at
1526  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1539  * @fdt: pointer to the device tree blob
1540  * @n: entry to remove
1563  * @fdt: pointer to the device tree blob
1565  * @name: name to give the node
1571  * with a name equal to one of the given node's siblings.
1579  *		to contain the new name
1580  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1589  * @fdt: pointer to the device tree blob
1590  * @nodeoffset: offset of the node whose property to change
1591  * @name: name of the property to change
1592  * @val: pointer to data to set the property value to
1596  * node to the given value and length, creating the property if it
1604  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1606  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1620  * @fdt: pointer to the device tree blob
1621  * @nodeoffset: offset of the node whose property to change
1622  * @name: name of the property to change
1624  * @prop_data: return pointer to property data
1627  * If the property exists it is resized. In either case a pointer to the
1635  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1637  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1650  * fdt_setprop_u32 - set a property to a 32-bit integer
1651  * @fdt: pointer to the device tree blob
1652  * @nodeoffset: offset of the node whose property to change
1653  * @name: name of the property to change
1657  * node to the given 32-bit integer value (converting to big-endian if
1666  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1668  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1685  * fdt_setprop_u64 - set a property to a 64-bit integer
1686  * @fdt: pointer to the device tree blob
1687  * @nodeoffset: offset of the node whose property to change
1688  * @name: name of the property to change
1692  * node to the given 64-bit integer value (converting to big-endian if
1701  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1703  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1720  * fdt_setprop_cell - set a property to a single cell value
1721  * @fdt: pointer to the device tree blob
1722  * @nodeoffset: offset of the node whose property to change
1723  * @name: name of the property to change
1737  * fdt_setprop_string - set a property to a string value
1738  * @fdt: pointer to the device tree blob
1739  * @nodeoffset: offset of the node whose property to change
1740  * @name: name of the property to change
1744  * given node to the given string value (using the length of the
1745  * string to determine the new length of the property), or creates a
1753  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1755  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1769  * fdt_setprop_empty - set a property to an empty value
1770  * @fdt: pointer to the device tree blob
1771  * @nodeoffset: offset of the node whose property to change
1772  * @name: name of the property to change
1775  * given node to an empty (zero length) value, or creates a new empty
1783  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1785  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1798  * fdt_appendprop - append to or create a property
1799  * @fdt: pointer to the device tree blob
1800  * @nodeoffset: offset of the node whose property to change
1801  * @name: name of the property to append to
1802  * @val: pointer to data to append to the property value
1803  * @len: length of the data to append to the property value
1805  * fdt_appendprop() appends the value to the named property in the
1813  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1815  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1828  * fdt_appendprop_u32 - append a 32-bit integer value to a property
1829  * @fdt: pointer to the device tree blob
1830  * @nodeoffset: offset of the node whose property to change
1831  * @name: name of the property to change
1832  * @val: 32-bit integer value to append to the property (native endian)
1835  * (converting to big-endian if necessary) to the value of the named
1844  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1846  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1863  * fdt_appendprop_u64 - append a 64-bit integer value to a property
1864  * @fdt: pointer to the device tree blob
1865  * @nodeoffset: offset of the node whose property to change
1866  * @name: name of the property to change
1867  * @val: 64-bit integer value to append to the property (native endian)
1870  * (converting to big-endian if necessary) to the value of the named
1879  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1881  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1898  * fdt_appendprop_cell - append a single cell value to a property
1899  * @fdt: pointer to the device tree blob
1900  * @nodeoffset: offset of the node whose property to change
1901  * @name: name of the property to change
1902  * @val: 32-bit integer value to append to the property (native endian)
1915  * fdt_appendprop_string - append a string to a property
1916  * @fdt: pointer to the device tree blob
1917  * @nodeoffset: offset of the node whose property to change
1918  * @name: name of the property to change
1919  * @str: string value to append to the property
1921  * fdt_appendprop_string() appends the given string to the value of
1930  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1932  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1946  * @fdt: pointer to the device tree blob
1948  * @nodeoffset: offset of the node to add a property at
1954  * address and size) to the value of the named property in the given
1969  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
1973  *	-FDT_ERR_BADVALUE, addr or size doesn't fit to respective cells size
1974  *	-FDT_ERR_NOSPACE, there is insufficient free space in the blob to
1983  * @fdt: pointer to the device tree blob
1984  * @nodeoffset: offset of the node whose property to nop
1985  * @name: name of the property to nop
1995  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
2007  * @fdt: pointer to the device tree blob
2009  * @name: name of the subnode to create
2010  * @namelen: number of characters of name to consider
2012  * Identical to fdt_add_subnode(), but use only the first @namelen
2027  * @fdt: pointer to the device tree blob
2029  * @name: name of the subnode to locate
2042  *	-FDT_ERR_BADOFFSET, if parentoffset did not point to an FDT_BEGIN_NODE
2047  *		blob to contain the new node
2060  * @fdt: pointer to the device tree blob
2061  * @nodeoffset: offset of the node to nop
2071  *	-FDT_ERR_BADOFFSET, nodeoffset did not point to FDT_BEGIN_NODE tag
2083  * @fdt: pointer to the base device tree blob
2084  * @fdto: pointer to the device tree overlay blob
2089  * Expect the base device tree to be modified, even if the function
2095  *	-FDT_ERR_NOTFOUND, the overlay points to some inexistant nodes or