diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-04-17 17:12:05 +0000 |
|---|---|---|
| committer | Zhang Rui <rui.zhang@intel.com> | 2013-04-25 00:34:38 +0800 |
| commit | 44952d338ad73439b993c7a09a93a3a688e49768 (patch) | |
| tree | 74d08cede932ace552d1c0f7790d992c951d44d6 /drivers/thermal | |
| parent | 2d6f28fedcd2842635a02b29e3823ba9881d5086 (diff) | |
thermal: cpu_cooling: document cpufreq_get_cooling_level
Add documentation for cpufreq_get_cooling_level. As this
is an exported function, it has to be documented.
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 | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/drivers/thermal/cpu_cooling.c b/drivers/thermal/cpu_cooling.c index 084ef0096cc..f1a041205a0 100644 --- a/drivers/thermal/cpu_cooling.c +++ b/drivers/thermal/cpu_cooling.c @@ -208,6 +208,17 @@ static int get_property(unsigned int cpu, unsigned long input, return -EINVAL; } +/** + * cpufreq_cooling_get_level - for a give cpu, return the cooling level. + * @cpu: cpu for which the level is required + * @freq: the frequency of interest + * + * This function will match the cooling level corresponding to the + * requested @freq and return it. + * + * Return: The matched cooling level on success or THERMAL_CSTATE_INVALID + * otherwise. + */ unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq) { unsigned int val; |