Skip to content

Commit

Permalink
Documentation: thermal: document of_cpufreq_cooling_register()
Browse files Browse the repository at this point in the history
Commit 39d99cf ("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>
  • Loading branch information
Javi Merino authored and Eduardo Valentin committed Jan 6, 2015
1 parent d26eef8 commit 9477e18
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions Documentation/thermal/cpu-cooling-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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.

Expand Down

0 comments on commit 9477e18

Please sign in to comment.