dm: core: Update comment for ofnode_get_chosen_node()
authorSimon Glass <sjg@chromium.org>
Mon, 27 Jan 2020 15:49:42 +0000 (08:49 -0700)
committerSimon Glass <sjg@chromium.org>
Thu, 6 Feb 2020 02:33:45 +0000 (19:33 -0700)
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>
include/dm/ofnode.h

index 4282169..62ba0c1 100644 (file)
@@ -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;
 /**