diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-04-17 19:12:00 +0200 |
|---|---|---|
| committer | Zhang Rui <rui.zhang@intel.com> | 2013-04-24 18:34:38 +0200 |
| commit | 82b9ee402fa9867edde8dbf17a55f615f80bc3ba (patch) | |
| tree | 9a4e5b0b63550fb579f26dbc9bc95ec2098d8b84 /drivers/thermal | |
| parent | thermal: cpu_cooling: remove compiler warning (diff) | |
| download | linux-82b9ee402fa9867edde8dbf17a55f615f80bc3ba.tar.xz linux-82b9ee402fa9867edde8dbf17a55f615f80bc3ba.zip | |
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/thermal')
| -rw-r--r-- | drivers/thermal/cpu_cooling.c | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/drivers/thermal/cpu_cooling.c b/drivers/thermal/cpu_cooling.c index 14c64b2a1466..b8b8a1ef85ed 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) { |