diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-04-17 17:12:08 +0000 |
|---|---|---|
| committer | Zhang Rui <rui.zhang@intel.com> | 2013-04-25 00:34:39 +0800 |
| commit | 4b33deb5470cda8268d684da6d448c081b6bf641 (patch) | |
| tree | b56a3a606d26b6e22a556bcfca073b4a916cdf5e /drivers/thermal | |
| parent | 41518c41dd6f36a0a951d1850e286a44773f75ca (diff) | |
thermal: cpu_cooling: update documentation for cpufreq_apply_cooling
Update kernel-doc comments for cpufreq_apply_cooling function.
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 | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/drivers/thermal/cpu_cooling.c b/drivers/thermal/cpu_cooling.c index 73944a34fdb9..1ec1591e3fd3 100644 --- a/drivers/thermal/cpu_cooling.c +++ b/drivers/thermal/cpu_cooling.c @@ -257,6 +257,12 @@ static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level) * @cpufreq_device: cpufreq_cooling_device pointer containing frequency * clipping data. * @cooling_state: value of the cooling state. + * + * Function used to make sure the cpufreq layer is aware of current thermal + * limits. The limits are applied by updating the cpufreq policy. + * + * Return: 0 on success, an error code otherwise (-EINVAL in case wrong + * cooling state). */ static int cpufreq_apply_cooling(struct cpufreq_cooling_device *cpufreq_device, unsigned long cooling_state) |