提交 2d6f28fe 编写于 作者: E Eduardo Valentin 提交者: Zhang Rui

thermal: cpu_cooling: add documentation for get_property

As this is one of the central functions of this file,
it deserves a proper documentation. This patch improves
the existing comment to format it as a kernel-doc style.
Signed-off-by: NEduardo Valentin <eduardo.valentin@ti.com>
Acked-by: NAmit Daniel Kachhap <amit.daniel@samsung.com>
Signed-off-by: NZhang Rui <rui.zhang@intel.com>
上级 82b9ee40
...@@ -118,8 +118,14 @@ enum cpufreq_cooling_property { ...@@ -118,8 +118,14 @@ enum cpufreq_cooling_property {
GET_MAXL, GET_MAXL,
}; };
/* /**
* this is the common function to * get_property - fetch a property of interest for a give cpu.
* @cpu: cpu for which the property is required
* @input: query parameter
* @output: query return
* @property: type of query (frequency, level, max level)
*
* This is the common function to
* 1. get maximum cpu cooling states * 1. get maximum cpu cooling states
* 2. translate frequency to cooling state * 2. translate frequency to cooling state
* 3. translate cooling state to frequency * 3. translate cooling state to frequency
...@@ -128,7 +134,9 @@ enum cpufreq_cooling_property { ...@@ -128,7 +134,9 @@ enum cpufreq_cooling_property {
* a) reduce duplicate code as most of the code can be shared. * a) reduce duplicate code as most of the code can be shared.
* b) make sure the logic is consistent when translating between * b) make sure the logic is consistent when translating between
* cooling states and frequencies. * cooling states and frequencies.
*/ *
* Return: 0 on success, -EINVAL when invalid parameters are passed.
*/
static int get_property(unsigned int cpu, unsigned long input, static int get_property(unsigned int cpu, unsigned long input,
unsigned int* output, enum cpufreq_cooling_property property) unsigned int* output, enum cpufreq_cooling_property property)
{ {
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册