summaryrefslogtreecommitdiffstats
path: root/drivers/thermal/cpu_cooling.c
diff options
context:
space:
mode:
authorEduardo Valentin2013-04-17 19:12:15 +0200
committerZhang Rui2013-04-24 18:34:42 +0200
commit12cb08ba50b73be97e555bcdf84e8f21a196794b (patch)
tree3ddaa2452662e18c6cde7bdd5fe2b348492f7a31 /drivers/thermal/cpu_cooling.c
parentthermal: cpu_cooling: update documentation for cpufreq_set_cur_state (diff)
downloadkernel-qcow2-linux-12cb08ba50b73be97e555bcdf84e8f21a196794b.tar.gz
kernel-qcow2-linux-12cb08ba50b73be97e555bcdf84e8f21a196794b.tar.xz
kernel-qcow2-linux-12cb08ba50b73be97e555bcdf84e8f21a196794b.zip
thermal: cpu_cooling: update kernel-doc for cpufreq_cooling_register
Add proper documentation for exported function cpufreq_cooling_register. 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/cpu_cooling.c')
-rw-r--r--drivers/thermal/cpu_cooling.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/drivers/thermal/cpu_cooling.c b/drivers/thermal/cpu_cooling.c
index aa9c38b1c3ac..9a1d82ef491e 100644
--- a/drivers/thermal/cpu_cooling.c
+++ b/drivers/thermal/cpu_cooling.c
@@ -413,6 +413,13 @@ static struct notifier_block thermal_cpufreq_notifier_block = {
/**
* cpufreq_cooling_register - function to create cpufreq cooling device.
* @clip_cpus: cpumask of cpus where the frequency constraints will happen.
+ *
+ * This interface function registers the cpufreq cooling device with the name
+ * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
+ * cooling devices.
+ *
+ * Return: a valid struct thermal_cooling_device pointer on success,
+ * on failure, it returns a corresponding ERR_PTR().
*/
struct thermal_cooling_device *cpufreq_cooling_register(
const struct cpumask *clip_cpus)