[PATCH] Documentation: thermal: document of_cpufreq_cooling_register()

[PATCH] Documentation: thermal: document of_cpufreq_cooling_register()

[Javi Merino]

Commit 39d99cff76bf ("thermal: cpu_cooling: introduce
of_cpufreq_cooling_register") taught the cpu cooling device to register
devices that were linked to the device tree but didn't update the
cpu-cooling-api documentation.  Fix it.

Cc: Amit Daniel Kachhap <amit.kachhap@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Zhang Rui <rui.zhang@intel.com>
Cc: Eduardo Valentin <edubezval@gmail.com>
Signed-off-by: Javi Merino <javi.merino@arm.com>
---
 Documentation/thermal/cpu-cooling-api.txt | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/Documentation/thermal/cpu-cooling-api.txt b/Documentation/thermal/cpu-cooling-api.txt
index fca24c931ec8..753e47cc2e20 100644
--- a/Documentation/thermal/cpu-cooling-api.txt
+++ b/Documentation/thermal/cpu-cooling-api.txt
@@ -3,7 +3,7 @@ CPU cooling APIs How To
 
 Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>
 
-Updated: 12 May 2012
+Updated: 6 Jan 2015
 
 Copyright (c)  2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
 
@@ -25,7 +25,18 @@ the user. The registration APIs returns the cooling device pointer.
 
    clip_cpus: cpumask of cpus where the frequency constraints will happen.
 
-1.1.2 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
+1.1.2 struct thermal_cooling_device *of_cpufreq_cooling_register(
+	struct device_node *np, const struct cpumask *clip_cpus)
+
+    This interface function registers the cpufreq cooling device with
+    the name "thermal-cpufreq-%x" linking it with a device tree node, in
+    order to bind it via the thermal DT code. This api can support multiple
+    instances of cpufreq cooling devices.
+
+    np: pointer to the cooling device device tree node
+    clip_cpus: cpumask of cpus where the frequency constraints will happen.
+
+1.1.3 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
 
     This interface function unregisters the "thermal-cpufreq-%x" cooling device.
 
-- 
1.9.1

Re: [PATCH] Documentation: thermal: document of_cpufreq_cooling_register()

[Eduardo Valentin]

[-- Attachment #1: Type: text/plain, Size: 2225 bytes --]

On Tue, Jan 06, 2015 at 06:14:25PM +0000, Javi Merino wrote:
> Commit 39d99cff76bf ("thermal: cpu_cooling: introduce
> of_cpufreq_cooling_register") taught the cpu cooling device to register
> devices that were linked to the device tree but didn't update the
> cpu-cooling-api documentation.  Fix it.
> 
> Cc: Amit Daniel Kachhap <amit.kachhap@linaro.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Zhang Rui <rui.zhang@intel.com>
> Cc: Eduardo Valentin <edubezval@gmail.com>
> Signed-off-by: Javi Merino <javi.merino@arm.com>

Thanks, applied to my -fixes branch.

> ---
>  Documentation/thermal/cpu-cooling-api.txt | 15 +++++++++++++--
>  1 file changed, 13 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/thermal/cpu-cooling-api.txt b/Documentation/thermal/cpu-cooling-api.txt
> index fca24c931ec8..753e47cc2e20 100644
> --- a/Documentation/thermal/cpu-cooling-api.txt
> +++ b/Documentation/thermal/cpu-cooling-api.txt
> @@ -3,7 +3,7 @@ CPU cooling APIs How To
>  
>  Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>
>  
> -Updated: 12 May 2012
> +Updated: 6 Jan 2015
>  
>  Copyright (c)  2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
>  
> @@ -25,7 +25,18 @@ the user. The registration APIs returns the cooling device pointer.
>  
>     clip_cpus: cpumask of cpus where the frequency constraints will happen.
>  
> -1.1.2 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
> +1.1.2 struct thermal_cooling_device *of_cpufreq_cooling_register(
> +	struct device_node *np, const struct cpumask *clip_cpus)
> +
> +    This interface function registers the cpufreq cooling device with
> +    the name "thermal-cpufreq-%x" linking it with a device tree node, in
> +    order to bind it via the thermal DT code. This api can support multiple
> +    instances of cpufreq cooling devices.
> +
> +    np: pointer to the cooling device device tree node
> +    clip_cpus: cpumask of cpus where the frequency constraints will happen.
> +
> +1.1.3 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
>  
>      This interface function unregisters the "thermal-cpufreq-%x" cooling device.
>  
> -- 
> 1.9.1
> 

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 473 bytes --]