Commit 82b9ee40 authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Zhang Rui

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: default avatarEduardo Valentin <eduardo.valentin@ti.com>
Acked-by: default avatarAmit Daniel Kachhap <amit.daniel@samsung.com>
Signed-off-by: default avatarZhang Rui <rui.zhang@intel.com>
parent 4469b997
......@@ -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)
{
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment