aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Glass2022-10-11 09:47:19 -0600
committerSimon Glass2022-10-17 21:17:13 -0600
commite7a18f751117ab38567d3929eacdcd9f3d6f5693 (patch)
tree07230907bc96924512a41d51049df64ef476a659
parent8aaacd61368929cd2af2296f00ee15fa4bf0ae55 (diff)
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>
-rw-r--r--doc/develop/driver-model/livetree.rst2
-rw-r--r--include/dm/ofnode.h3
2 files changed, 4 insertions, 1 deletions
diff --git a/doc/develop/driver-model/livetree.rst b/doc/develop/driver-model/livetree.rst
index 55aa3eac929..579eef5ca9f 100644
--- a/doc/develop/driver-model/livetree.rst
+++ b/doc/develop/driver-model/livetree.rst
@@ -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.
diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h
index 7aae2c29ef1..fa9865602d8 100644
--- a/include/dm/ofnode.h
+++ b/include/dm/ofnode.h
@@ -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