From: Masahiro Yamada <yamada.masahiro@socionext.com>
Date: Wed, 20 Apr 2016 01:18:46 +0000 (+0900)
Subject: of: document refcount incrementation of of_get_cpu_node()
X-Git-Tag: v4.7-rc1~100^2~13
X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=commitdiff_plain;h=1c986e3643d278d93e9ca67b3c752f486cc32318;p=linux.git

of: document refcount incrementation of of_get_cpu_node()

This function increments refcount.  This is worth noting.

Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Reviewed-by: Frank Rowand <frank.rowand@am.sony.com>
Signed-off-by: Rob Herring <robh@kernel.org>
---

diff --git a/drivers/of/base.c b/drivers/of/base.c
index e87e21df19d8..116666b088cc 100644
--- a/drivers/of/base.c
+++ b/drivers/of/base.c
@@ -394,7 +394,8 @@ bool __weak arch_find_n_match_cpu_physical_id(struct device_node *cpun,
  * before booting secondary cores. This function uses arch_match_cpu_phys_id
  * which can be overridden by architecture specific implementation.
  *
- * Returns a node pointer for the logical cpu if found, else NULL.
+ * Returns a node pointer for the logical cpu with refcount incremented, use
+ * of_node_put() on it when done. Returns NULL if not found.
  */
 struct device_node *of_get_cpu_node(int cpu, unsigned int *thread)
 {