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

Commit 44952d33 authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Zhang Rui
Browse files

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: 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 2d6f28fe

drivers/thermal/cpu_cooling.c

+11 −0
Original line number Diff line number Diff line
@@ -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;