lib/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
130  * External helpers to access words from a device tree blob. They're built
272  * fdt_header_size - return the size of the tree's header
273  * @fdt: pointer to a flattened device tree
288  * fdt_check_header - sanity check a device tree header
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
297  *     0, if the buffer appears to contain a valid device tree
306  * fdt_move - move a device tree around in memory
307  * @fdt: pointer to the device tree to move
311  * fdt_move() relocates, if possible, the device tree blob located at
313  * with the existing device tree blob at fdt.  Therefore,
319  *     -FDT_ERR_NOSPACE, bufsize is insufficient to contain the device tree
333  * fdt_get_string - retrieve a string from the strings block of a device tree
334  * @fdt: pointer to the device tree blob
339  * strings block of the device tree blob at fdt, and optionally also
349  * fdt_string - retrieve a string from the strings block of a device tree
350  * @fdt: pointer to the device tree blob
354  * strings block of the device tree blob at fdt.
363  * fdt_find_max_phandle - find and return the highest phandle in a tree
364  * @fdt: pointer to the device tree blob
365  * @phandle: return location for the highest phandle value found in the tree
368  * tree. The value returned in @phandle is only valid if the function returns
377  * fdt_get_max_phandle - retrieves the highest phandle in a tree
378  * @fdt: pointer to the device tree blob
381  * device tree. This will ignore badly formatted phandles, or phandles
388  *      0, if no phandle was found in the device tree
404  * fdt_generate_phandle - return a new, unused phandle for a device tree blob
405  * @fdt: pointer to the device tree blob
408  * Walks the device tree blob and looks for the highest phandle value. On
410  * highest phandle value in the device tree blob) will be returned in the
419  * @fdt: pointer to the device tree blob
421  * Returns the number of entries in the device tree blob's memory
432  * @fdt: pointer to the device tree blob
438  * the n-th reserve map entry from the device tree blob, in
451  * @fdt: pointer to the device tree blob
469  * @fdt: pointer to the device tree blob
494  * fdt_path_offset_namelen - find a tree node by its full path
495  * @fdt: pointer to the device tree blob
509  * fdt_path_offset - find a tree node by its full path
510  * @fdt: pointer to the device tree blob
513  * fdt_path_offset() finds a node of a given path in the device tree.
535  * @fdt: pointer to the device tree blob
540  * device tree node at structure block offset nodeoffset.  If lenp is
560  * @fdt: pointer to the device tree blob
580  * @fdt: pointer to the device tree blob
628  * @fdt: pointer to the device tree blob
633  * fdt_property structure within the device tree blob at the given
637  * Note that this code only works on device tree versions >= 16. fdt_getprop()
659  * @fdt: pointer to the device tree blob
680  * @fdt: pointer to the device tree blob
686  * structure within the device tree blob corresponding to the property
718  * @fdt: pointer to the device tree blob
729  * by namep (this will be a pointer to within the device tree's string
754  * @fdt: pointer to the device tree blob
779  * @fdt: pointer to the device tree blob
815  * @fdt: pointer to the device tree blob
818  * fdt_get_phandle() retrieves the phandle of the device tree node at
829  * @fdt: pointer to the device tree blob
846  * @fdt: pointer to the device tree blob
860  * @fdt: pointer to the device tree blob
868  * NOTE: This function is expensive, as it must scan the device tree
887  * @fdt: pointer to the device tree blob
901  * NOTE: This function is expensive, as it must scan the device tree
920  * @fdt: pointer to the device tree blob
926  * NOTE: This function is expensive, as it must scan the device tree
941  * @fdt: pointer to the device tree blob
948  * NOTE: This function is expensive, as it must scan the device tree
964  * @fdt: pointer to the device tree blob
973  * startoffset is -1, the very first such node in the tree.
993  *		tree after startoffset
1006  * @fdt: pointer to the device tree blob
1011  * in the tree with the given phandle (an invalid tree), results are
1027  * @fdt: pointer to the device tree blob
1028  * @nodeoffset: offset of a tree node
1051  * @fdt: pointer to the device tree blob
1058  * very first such node in the tree.
1076  *		tree after startoffset
1093  * one or more strings, each terminated by \0, as is found in a device tree
1102  * @fdt: pointer to the device tree blob
1103  * @nodeoffset: offset of a tree node
1115  * @fdt: pointer to the device tree blob
1116  * @nodeoffset: offset of a tree node
1137  * @fdt: pointer to the device tree blob
1138  * @nodeoffset: offset of a tree node
1179  * fdt_address_cells - retrieve address size for a bus represented in the tree
1180  * @fdt: pointer to the device tree blob
1200  *                  tree
1201  * @fdt: pointer to the device tree blob
1227  * @fdt: pointer to the device tree blob
1251  * @fdt: pointer to the device tree blob
1264  * of the tree.
1284  * @fdt: pointer to the device tree blob
1297  * of the tree.
1319  * @fdt: pointer to the device tree blob
1332  * of the tree.
1354  * @fdt: pointer to the device tree blob
1370  * @fdt: pointer to the device tree blob
1376  * tree.
1380  * tree.
1396  * @fdt: pointer to the device tree blob
1401  * effectively removing it from the tree.
1405  * move any other part of the tree.
1487  * @fdt: pointer to the device tree blob
1514  * @fdt: pointer to the device tree blob
1539  * @fdt: pointer to the device tree blob
1563  * @fdt: pointer to the device tree blob
1589  * @fdt: pointer to the device tree blob
1620  * @fdt: pointer to the device tree blob
1651  * @fdt: pointer to the device tree blob
1686  * @fdt: pointer to the device tree blob
1721  * @fdt: pointer to the device tree blob
1738  * @fdt: pointer to the device tree blob
1770  * @fdt: pointer to the device tree blob
1799  * @fdt: pointer to the device tree blob
1829  * @fdt: pointer to the device tree blob
1864  * @fdt: pointer to the device tree blob
1899  * @fdt: pointer to the device tree blob
1916  * @fdt: pointer to the device tree blob
1946  * @fdt: pointer to the device tree blob
1983  * @fdt: pointer to the device tree blob
2007  * @fdt: pointer to the device tree blob
2027  * @fdt: pointer to the device tree blob
2060  * @fdt: pointer to the device tree blob
2083  * @fdt: pointer to the base device tree blob
2084  * @fdto: pointer to the device tree overlay blob
2086  * fdt_overlay_apply() will apply the given device tree overlay on the
2087  * given base device tree.
2089  * Expect the base device tree to be modified, even if the function
2094  *	-FDT_ERR_NOSPACE, there's not enough space in the base device tree