blob: fca24c931ec8dcb737012b6b67f6b88a8fef2223 [file] [log] [blame]
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301CPU cooling APIs How To
2===================================
3
4Written by Amit Daniel Kachhap <amit.kachhap@linaro.org>
5
6Updated: 12 May 2012
7
8Copyright (c) 2012 Samsung Electronics Co., Ltd(http://www.samsung.com)
9
100. Introduction
11
12The generic cpu cooling(freq clipping) provides registration/unregistration APIs
13to the caller. The binding of the cooling devices to the trip point is left for
14the user. The registration APIs returns the cooling device pointer.
15
161. cpu cooling APIs
17
181.1 cpufreq registration/unregistration APIs
191.1.1 struct thermal_cooling_device *cpufreq_cooling_register(
20 struct cpumask *clip_cpus)
21
22 This interface function registers the cpufreq cooling device with the name
23 "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
24 cooling devices.
25
26 clip_cpus: cpumask of cpus where the frequency constraints will happen.
27
281.1.2 void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
29
30 This interface function unregisters the "thermal-cpufreq-%x" cooling device.
31
32 cdev: Cooling device pointer which has to be unregistered.