dm: core: Update docs about oftree_from_fdt()

Update this function's comment and also the livetree documentation, so it
is clear when to use the function.

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass 2022-10-11 09:47:19 -06:00
parent 8aaacd6136
commit e7a18f7511
2 changed files with 4 additions and 1 deletions

View file

@ -255,7 +255,7 @@ So long as OF_LIVE is disabled, it is possible to do fixups using the ofnode
interface. The OF_LIVE support required addition of the flattening step at the
end.
See dm_test_ofnode_root() for some examples. The ofnode_path_root() function
See dm_test_ofnode_root() for some examples. The oftree_from_fdt() function
causes a flat device tree to be 'registered' such that it can be used by the
ofnode interface.

View file

@ -59,6 +59,9 @@ __attribute_const__ int ofnode_to_offset(ofnode node);
/**
* oftree_from_fdt() - Returns an oftree from a flat device tree pointer
*
* If @fdt is not already registered in the list of current device trees, it is
* added to the list.
*
* @fdt: Device tree to use
*
* Returns: reference to the given node