From: Eduardo Valentin <eduardo.valentin@ti.com>
Date: Wed, 17 Apr 2013 17:12:05 +0000 (+0000)
Subject: thermal: cpu_cooling: document cpufreq_get_cooling_level
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=44952d338ad73439b993c7a09a93a3a688e49768;p=linux-beck.git

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>
---

diff --git a/drivers/thermal/cpu_cooling.c b/drivers/thermal/cpu_cooling.c
index 084ef0096cc9..f1a041205a0e 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;