Commit 41518c41 authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Zhang Rui

thermal: cpu_cooling: improve documentation for get_cpu_frequency

Fix kernel-doc warning on get_cpu_frequency and improve
documentation comments.
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 44952d33
...@@ -232,8 +232,14 @@ EXPORT_SYMBOL_GPL(cpufreq_cooling_get_level); ...@@ -232,8 +232,14 @@ EXPORT_SYMBOL_GPL(cpufreq_cooling_get_level);
/** /**
* get_cpu_frequency - get the absolute value of frequency from level. * get_cpu_frequency - get the absolute value of frequency from level.
* @cpu: cpu for which frequency is fetched. * @cpu: cpu for which frequency is fetched.
* @level: level of frequency, equals cooling state of cpu cooling device * @level: cooling level
*
* This function matches cooling level with frequency. Based on a cooling level
* of frequency, equals cooling state of cpu cooling device, it will return
* the corresponding frequency.
* e.g level=0 --> 1st MAX FREQ, level=1 ---> 2nd MAX FREQ, .... etc * e.g level=0 --> 1st MAX FREQ, level=1 ---> 2nd MAX FREQ, .... etc
*
* Return: 0 on error, the corresponding frequency otherwise.
*/ */
static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level) static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level)
{ {
......
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