dtc/libfdt/libfdt.h

5  * libfdt - Flat Device Tree manipulation
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. */
48 	 * tree created by the sequential-write functions, which is
51 /* Error codes: codes for bad device tree blobs */
57 	/* FDT_ERR_BADMAGIC: Given "device tree" appears not to be a
58 	 * device tree at all - it is missing the flattened device
59 	 * tree magic number. */
61 	/* FDT_ERR_BADVERSION: Given device tree has a version which
64 	 * required to convert the tree to the expected version. */
66 	/* FDT_ERR_BADSTRUCTURE: Given device tree has a corrupt
71 	 * device tree has it's sub-blocks in an order that the
73 	 * then strings).  Use fdt_open_into() to reorganize the tree
82 /* Errors in device tree content */
84 	/* FDT_ERR_BADNCELLS: Device tree has a #address-cells, #size-cells
88 	/* FDT_ERR_BADVALUE: Device tree has a property with an unexpected
93 	/* FDT_ERR_BADOVERLAY: The device tree overlay, while
98 	/* FDT_ERR_NOPHANDLES: The device tree doesn't have any
106 	/* FDT_ERR_ALIGNMENT: The device tree base address is not 8-byte
120  * fdt_offset_ptr - safely get a byte range within the device tree blob
121  * @fdt:	Pointer to the device tree blob
126  * the given @offset within the device tree blob, after verifying that the byte
142  * fdt_next_tag - get next tag in the device tree
143  * @fdt:	Pointer to the device tree blob
147  * fdt_next_tag() returns the tag type of the next tag in the device tree
158  * External helpers to access words from a device tree blob. They're built
307  * fdt_header_size - return the size of the tree's header
308  * @fdt: pointer to a flattened device tree
316  * @version: device tree version number
323  * fdt_check_header - sanity check a device tree header
324  * @fdt: pointer to data which might be a flattened device tree
327  * appears to be a flattened device tree, and that the header contains
332  *     0, if the buffer appears to contain a valid device tree
341  * fdt_move - move a device tree around in memory
342  * @fdt: pointer to the device tree to move
346  * fdt_move() relocates, if possible, the device tree blob located at
348  * with the existing device tree blob at fdt.  Therefore,
354  *     -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree
366  * fdt_check_full - check device tree validity
367  * @fdt:	pointer to the device tree blob
368  * @bufsize:	size of the buffer containing the device tree
371  * flattened device tree and that the tree structure is internally
385  * fdt_get_string - retrieve a string from the strings block of a device tree
386  * @fdt: pointer to the device tree blob
391  * strings block of the device tree blob at fdt, and optionally also
401  * fdt_string - retrieve a string from the strings block of a device tree
402  * @fdt: pointer to the device tree blob
406  * strings block of the device tree blob at fdt.
415  * fdt_find_max_phandle - find and return the highest phandle in a tree
416  * @fdt: pointer to the device tree blob
417  * @phandle: return location for the highest phandle value found in the tree
420  * tree. The value returned in @phandle is only valid if the function returns
429  * fdt_get_max_phandle - retrieves the highest phandle in a tree
430  * @fdt: pointer to the device tree blob
433  * device tree. This will ignore badly formatted phandles, or phandles
440  *      0, if no phandle was found in the device tree
456  * fdt_generate_phandle - return a new, unused phandle for a device tree blob
457  * @fdt: pointer to the device tree blob
460  * Walks the device tree blob and looks for the highest phandle value. On
462  * highest phandle value in the device tree blob) will be returned in the
471  * @fdt: pointer to the device tree blob
473  * Returns the number of entries in the device tree blob's memory
484  * @fdt: pointer to the device tree blob
490  * the n-th reserve map entry from the device tree blob, in
503  * @fdt: pointer to the device tree blob
521  * @fdt: pointer to the device tree blob
546  * fdt_path_offset_namelen - find a tree node by its full path
547  * @fdt: pointer to the device tree blob
561  * fdt_path_offset - find a tree node by its full path
562  * @fdt: pointer to the device tree blob
565  * fdt_path_offset() finds a node of a given path in the device tree.
612  * @fdt: pointer to the device tree blob
617  * device tree node at structure block offset nodeoffset.  If lenp is
637  * @fdt: pointer to the device tree blob
657  * @fdt: pointer to the device tree blob
705  * @fdt: pointer to the device tree blob
710  * fdt_property structure within the device tree blob at the given
714  * Note that this code only works on device tree versions >= 16. fdt_getprop()
743  * @fdt: pointer to the device tree blob
771  * @fdt: pointer to the device tree blob
777  * structure within the device tree blob corresponding to the property
809  * @fdt: pointer to the device tree blob
820  * by namep (this will be a pointer to within the device tree's string
845  * @fdt: pointer to the device tree blob
870  * @fdt: pointer to the device tree blob
906  * @fdt: pointer to the device tree blob
909  * fdt_get_phandle() retrieves the phandle of the device tree node at
920  * @fdt: pointer to the device tree blob
937  * @fdt: pointer to the device tree blob
951  * @fdt: pointer to the device tree blob
968  * @fdt: pointer to the device tree blob
973  * /__symbols__. Such a node exists only for a device tree blob that
975  * to a label appearing in the device tree source, with the name of
987  * @fdt: pointer to the device tree blob
995  * NOTE: This function is expensive, as it must scan the device tree
1014  * @fdt: pointer to the device tree blob
1028  * NOTE: This function is expensive, as it must scan the device tree
1047  * @fdt: pointer to the device tree blob
1053  * NOTE: This function is expensive, as it must scan the device tree
1068  * @fdt: pointer to the device tree blob
1075  * NOTE: This function is expensive, as it must scan the device tree
1091  * @fdt: pointer to the device tree blob
1100  * startoffset is -1, the very first such node in the tree.
1120  *		tree after startoffset
1133  * @fdt: pointer to the device tree blob
1138  * in the tree with the given phandle (an invalid tree), results are
1154  * @fdt: pointer to the device tree blob
1155  * @nodeoffset: offset of a tree node
1178  * @fdt: pointer to the device tree blob
1185  * very first such node in the tree.
1203  *		tree after startoffset
1220  * one or more strings, each terminated by \0, as is found in a device tree
1229  * @fdt: pointer to the device tree blob
1230  * @nodeoffset: offset of a tree node
1242  * @fdt: pointer to the device tree blob
1243  * @nodeoffset: offset of a tree node
1264  * @fdt: pointer to the device tree blob
1265  * @nodeoffset: offset of a tree node
1306  * fdt_address_cells - retrieve address size for a bus represented in the tree
1307  * @fdt: pointer to the device tree blob
1327  *                  tree
1328  * @fdt: pointer to the device tree blob
1354  * @fdt: pointer to the device tree blob
1378  * @fdt: pointer to the device tree blob
1391  * of the tree.
1411  * @fdt: pointer to the device tree blob
1424  * of the tree.
1446  * @fdt: pointer to the device tree blob
1459  * of the tree.
1481  * @fdt: pointer to the device tree blob
1497  * @fdt: pointer to the device tree blob
1503  * tree.
1507  * tree.
1523  * @fdt: pointer to the device tree blob
1528  * effectively removing it from the tree.
1532  * move any other part of the tree.
1589  * fdt_resize - move and resize a device tree in sequential write state
1590  * @fdt:	Pointer to the device tree to resize
1591  * @buf:	Buffer where resized tree should be placed
1594  * fdt_resize() moves the device tree blob from @fdt to @buf and
1608  * @fdt:	Pointer to the device tree blob
1613  * device tree blob during the sequential write process. This function
1625  * @fdt:	Pointer to the device tree blob
1628  * of the device tree blob during sequential write. After calling this
1640  * @fdt:	Pointer to the device tree blob
1658  * @fdt:	Pointer to the device tree blob
1694  * @fdt: pointer to the device tree blob
1711  * @fdt:	Pointer to the device tree blob
1725  * fdt_finish - complete device tree creation
1726  * @fdt:	Pointer to the device tree blob
1728  * fdt_finish() completes the device tree creation process started with
1729  * fdt_create(). This function finalizes the device tree blob and makes it ready
1745  * fdt_create_empty_tree - create an empty device tree
1746  * @buf:	Buffer where the empty tree should be created
1749  * fdt_create_empty_tree() creates a minimal empty device tree blob
1750  * in the given buffer. The tree contains only a root node with no
1755  *	-FDT_ERR_NOSPACE, if @bufsize is too small for even an empty tree
1760  * fdt_open_into - move a device tree into a new buffer and make editable
1761  * @fdt:	Pointer to the device tree to move
1762  * @buf:	Buffer where the editable tree should be placed
1765  * fdt_open_into() moves and reorganizes the device tree blob from @fdt
1781  * fdt_pack - pack a device tree blob
1782  * @fdt:	Pointer to the device tree blob
1784  * fdt_pack() reorganizes the device tree blob to eliminate any free space
1800  * @fdt: pointer to the device tree blob
1825  * @fdt: pointer to the device tree blob
1849  * @fdt: pointer to the device tree blob
1875  * @fdt: pointer to the device tree blob
1907  * @fdt: pointer to the device tree blob
1942  * @fdt: pointer to the device tree blob
1974  * @fdt: pointer to the device tree blob
2010  * @fdt: pointer to the device tree blob
2045  * @fdt: pointer to the device tree blob
2080  * @fdt: pointer to the device tree blob
2097  * @fdt: pointer to the device tree blob
2128  * @fdt: pointer to the device tree blob
2161  * @fdt: pointer to the device tree blob
2190  * @fdt: pointer to the device tree blob
2220  * @fdt: pointer to the device tree blob
2255  * @fdt: pointer to the device tree blob
2290  * @fdt: pointer to the device tree blob
2307  * @fdt: pointer to the device tree blob
2337  * @fdt: pointer to the device tree blob
2374  * @fdt: pointer to the device tree blob
2398  * @fdt: pointer to the device tree blob
2418  * @fdt: pointer to the device tree blob
2450  * @fdt: pointer to the device tree blob
2473  * @fdt: pointer to the base device tree blob
2474  * @fdto: pointer to the device tree overlay blob
2476  * fdt_overlay_apply() will apply the given device tree overlay on the
2477  * given base device tree.
2479  * Expect the base device tree to be modified, even if the function
2484  *	-FDT_ERR_NOSPACE, there's not enough space in the base device tree
2504  * @fdt: Base device tree blob
2505  * @fdto: Device tree overlay blob
2510  * device tree of a fragment, no matter how the actual targeting is
2514  *      the targeted node offset in the base device tree