path: root/drivers
diff options
authorEduardo Valentin <eduardo.valentin@ti.com>2013-04-17 17:12:00 +0000
committerZhang Rui <rui.zhang@intel.com>2013-04-25 00:34:38 +0800
commit82b9ee402fa9867edde8dbf17a55f615f80bc3ba (patch)
tree9a4e5b0b63550fb579f26dbc9bc95ec2098d8b84 /drivers
parent4469b99743d296e24aefc5f8ed7df1bc9cfbbac8 (diff)
thermal: cpu_cooling: fix kernel doc for is_cpufreq_valid
Update documentation for is_cpufreq_valid function so that kernel-doc does not complain about return value. Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com> Acked-by: Amit Daniel Kachhap <amit.daniel@samsung.com> Signed-off-by: Zhang Rui <rui.zhang@intel.com>
Diffstat (limited to 'drivers')
1 files changed, 7 insertions, 1 deletions
diff --git a/drivers/thermal/cpu_cooling.c b/drivers/thermal/cpu_cooling.c
index 14c64b2a146..b8b8a1ef85e 100644
--- a/drivers/thermal/cpu_cooling.c
+++ b/drivers/thermal/cpu_cooling.c
@@ -97,8 +97,14 @@ static void release_idr(struct idr *idr, int id)
/* Below code defines functions to be used for cpufreq as cooling device */
- * is_cpufreq_valid - function to check if a cpu has frequency transition policy.
+ * is_cpufreq_valid - function to check frequency transitioning capability.
* @cpu: cpu for which check is needed.
+ *
+ * This function will check the current state of the system if
+ * it is capable of changing the frequency for a given @cpu.
+ *
+ * Return: 0 if the system is not currently capable of changing
+ * the frequency of given cpu. !0 in case the frequency is changeable.
static int is_cpufreq_valid(int cpu)