[PATCH] of: document refcount incrementation of of_get_cpu_node()

[PATCH] of: document refcount incrementation of of_get_cpu_node()

[Masahiro Yamada]

This function increments refcount.  This is worth noting.

Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
---

 drivers/of/base.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/of/base.c b/drivers/of/base.c
index b299de2..365e1c02 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)
 {
-- 
1.9.1

[PATCH] of: document refcount incrementation of of_get_cpu_node()

[Masahiro Yamada]

This function increments refcount.  This is worth noting.

Signed-off-by: Masahiro Yamada <yamada.masahiro-uWyLwvC0a2jby3iVrkZq2A@public.gmane.org>
---

 drivers/of/base.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/of/base.c b/drivers/of/base.c
index b299de2..365e1c02 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)
 {
-- 
1.9.1

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] of: document refcount incrementation of of_get_cpu_node()

[Frank Rowand]

On 4/19/2016 6:18 PM, Masahiro Yamada wrote:
> This function increments refcount.  This is worth noting.
> 
> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
> ---
> 
>  drivers/of/base.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/of/base.c b/drivers/of/base.c
> index b299de2..365e1c02 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)
>  {
> 

Nice catch.

Reviewed-by: Frank Rowand <frank.rowand@am.sony.com>

Re: [PATCH] of: document refcount incrementation of of_get_cpu_node()

[Rob Herring]

On Tue, Apr 19, 2016 at 8:18 PM, Masahiro Yamada
<yamada.masahiro@socionext.com> wrote:
> This function increments refcount.  This is worth noting.
>
> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>

Applied, thanks.

Rob

Re: [PATCH] of: document refcount incrementation of of_get_cpu_node()

[Rob Herring]

On Tue, Apr 19, 2016 at 8:18 PM, Masahiro Yamada
<yamada.masahiro-uWyLwvC0a2jby3iVrkZq2A@public.gmane.org> wrote:
> This function increments refcount.  This is worth noting.
>
> Signed-off-by: Masahiro Yamada <yamada.masahiro-uWyLwvC0a2jby3iVrkZq2A@public.gmane.org>

Applied, thanks.

Rob
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html