Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2d6f28fe authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Zhang Rui
Browse files

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: 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 82b9ee40

drivers/thermal/cpu_cooling.c

+11 −3
Original line number Diff line number Diff line
@@ -118,8 +118,14 @@ enum cpufreq_cooling_property { 
	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

 * 2. translate frequency to cooling state

 * 3. translate cooling state to frequency
@@ -128,6 +134,8 @@ enum cpufreq_cooling_property { 
 * a) reduce duplicate code as most of the code can be shared.

 * b) make sure the logic is consistent when translating between

 *    cooling states and frequencies.

 *

 * Return: 0 on success, -EINVAL when invalid parameters are passed.

 */

static int get_property(unsigned int cpu, unsigned long input,

	unsigned int* output, enum cpufreq_cooling_property property)