Browse Source

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>
Simon Glass 4 years ago
parent
commit
74d594a20e
1 changed files with 6 additions and 3 deletions
  1. 6 3
      include/dm/ofnode.h

+ 6 - 3
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;
 /**