summaryrefslogtreecommitdiff
path: root/include/dm/ofnode.h
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2020-01-27 08:49:42 -0700
committerSimon Glass <sjg@chromium.org>2020-02-05 19:33:45 -0700
commit74d594a20e035a2dfce232093774c50d986cb9ff (patch)
treea0180542767fd742f5c11508fa6e7af25b0d546f /include/dm/ofnode.h
parentba8444a06623b4f9af051aec47247c202937ec00 (diff)
dm: core: Update comment for ofnode_get_chosen_node()
The current comment is a big vague and misleading. Rewrite it to state precisely what the function does. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'include/dm/ofnode.h')
-rw-r--r--include/dm/ofnode.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/include/dm/ofnode.h b/include/dm/ofnode.h
index 4282169706..62ba0c13ea 100644
--- a/include/dm/ofnode.h
+++ b/include/dm/ofnode.h
@@ -520,11 +520,14 @@ ofnode ofnode_path(const char *path);
const char *ofnode_get_chosen_prop(const char *propname);
/**
- * ofnode_get_chosen_node() - get the chosen node
+ * ofnode_get_chosen_node() - get a referenced node from the chosen node
*
- * @return the chosen node if present, else ofnode_null()
+ * This looks up a named property in the chosen node and uses that as a path to
+ * look up a code.
+ *
+ * @return the referenced node if present, else ofnode_null()
*/
-ofnode ofnode_get_chosen_node(const char *name);
+ofnode ofnode_get_chosen_node(const char *propname);
struct display_timing;
/**