9477e18dd5
Commit 39d99cff76 ("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: Javi Merino <javi.merino@arm.com>
Signed-off-by: Eduardo Valentin <edubezval@gmail.com>
44 lines
1.6 KiB
Plaintext
44 lines
1.6 KiB
Plaintext
CPU cooling APIs How To
|
|
===================================
|
|
|
|
Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>
|
|
|
|
Updated: 6 Jan 2015
|
|
|
|
Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
|
|
|
|
0. Introduction
|
|
|
|
The generic cpu cooling(freq clipping) provides registration/unregistration APIs
|
|
to the caller. The binding of the cooling devices to the trip point is left for
|
|
the user. The registration APIs returns the cooling device pointer.
|
|
|
|
1. cpu cooling APIs
|
|
|
|
1.1 cpufreq registration/unregistration APIs
|
|
1.1.1 struct thermal_cooling_device *cpufreq_cooling_register(
|
|
struct cpumask *clip_cpus)
|
|
|
|
This interface function registers the cpufreq cooling device with the name
|
|
"thermal-cpufreq-%x". This api can support multiple instances of cpufreq
|
|
cooling devices.
|
|
|
|
clip_cpus: cpumask of cpus where the frequency constraints will happen.
|
|
|
|
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.
|
|
|
|
cdev: Cooling device pointer which has to be unregistered.
|