summaryrefslogtreecommitdiffstats
path: root/drivers/of
diff options
context:
space:
mode:
authorBaruch Siach <baruch@tkos.co.il>2015-03-19 14:03:41 +0200
committerRob Herring <robh@kernel.org>2015-04-17 07:49:28 -0500
commit6480827357923b3977b97c9413a7307be850975d (patch)
tree4c06a5a0e683070272302d90c06091bd03e12c5d /drivers/of
parent4155fc07fa9fd691d424e7f8fb64591cccb88788 (diff)
downloadlinux-6480827357923b3977b97c9413a7307be850975d.tar.bz2
of: base: improve of_get_next_child() kernel-doc
Add two new facts to of_get_next_child() documentation: * of_get_next_child() returns NULL when there is not next child * of_get_next_child() decrements the refcount of prev Signed-off-by: Baruch Siach <baruch@tkos.co.il> Signed-off-by: Rob Herring <robh@kernel.org>
Diffstat (limited to 'drivers/of')
-rw-r--r--drivers/of/base.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/drivers/of/base.c b/drivers/of/base.c
index 31ca3c8dae61..7183e825d658 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -663,8 +663,9 @@ static struct device_node *__of_get_next_child(const struct device_node *node,
* @node: parent node
* @prev: previous child of the parent node, or NULL to get first
*
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
+ * Returns a node pointer with refcount incremented, use of_node_put() on
+ * it when done. Returns NULL when prev is the last child. Decrements the
+ * refcount of prev.
*/
struct device_node *of_get_next_child(const struct device_node *node,
struct device_node *prev)