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

Commit 9477e18d authored by Javi Merino's avatar Javi Merino Committed by Eduardo Valentin
Browse files

Documentation: thermal: document of_cpufreq_cooling_register() 



Commit 39d99cff ("thermal: cpu_cooling: introduce
of_cpufreq_cooling_register") taught the cpu cooling device to register
devices that were linked to the device tree but didn't update the
cpu-cooling-api documentation.  Fix it.

Cc: Amit Daniel Kachhap <amit.kachhap@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Zhang Rui <rui.zhang@intel.com>
Cc: Eduardo Valentin <edubezval@gmail.com>
Signed-off-by: default avatarJavi Merino <javi.merino@arm.com>
Signed-off-by: default avatarEduardo Valentin <edubezval@gmail.com>
parent d26eef8b

Documentation/thermal/cpu-cooling-api.txt

+13 −2
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ CPU cooling APIs How To 


Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>



Updated: 12 May 2012

Updated: 6 Jan 2015



Copyright (c)  2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
@@ -25,7 +25,18 @@ the user. The registration APIs returns the cooling device pointer. 


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



1.1.2 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)

1.1.2 struct thermal_cooling_device *of_cpufreq_cooling_register(

	struct device_node *np, const struct cpumask *clip_cpus)



    This interface function registers the cpufreq cooling device with

    the name "thermal-cpufreq-%x" linking it with a device tree node, in

    order to bind it via the thermal DT code. This api can support multiple

    instances of cpufreq cooling devices.



    np: pointer to the cooling device device tree node

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



1.1.3 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)



    This interface function unregisters the "thermal-cpufreq-%x" cooling device.