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

Commit 12cb08ba authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Zhang Rui
Browse files

thermal: cpu_cooling: update kernel-doc for cpufreq_cooling_register 



Add proper documentation for exported function cpufreq_cooling_register.

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

drivers/thermal/cpu_cooling.c

+7 −0
Original line number Diff line number Diff line
@@ -413,6 +413,13 @@ static struct notifier_block thermal_cpufreq_notifier_block = { 
/**

 * cpufreq_cooling_register - function to create cpufreq cooling device.

 * @clip_cpus: cpumask of cpus where the frequency constraints will happen.

 *

 * This interface function registers the cpufreq cooling device with the name

 * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq

 * cooling devices.

 *

 * Return: a valid struct thermal_cooling_device pointer on success,

 * on failure, it returns a corresponding ERR_PTR().

 */

struct thermal_cooling_device *cpufreq_cooling_register(

	const struct cpumask *clip_cpus)