Commit | Line | Data |
---|---|---|
02361418 ADK |
1 | /* |
2 | * linux/drivers/thermal/cpu_cooling.c | |
3 | * | |
4 | * Copyright (C) 2012 Samsung Electronics Co., Ltd(http://www.samsung.com) | |
5 | * Copyright (C) 2012 Amit Daniel <amit.kachhap@linaro.org> | |
6 | * | |
7 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; version 2 of the License. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License along | |
18 | * with this program; if not, write to the Free Software Foundation, Inc., | |
19 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
20 | * | |
21 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
22 | */ | |
02361418 ADK |
23 | #include <linux/module.h> |
24 | #include <linux/thermal.h> | |
02361418 ADK |
25 | #include <linux/cpufreq.h> |
26 | #include <linux/err.h> | |
27 | #include <linux/slab.h> | |
28 | #include <linux/cpu.h> | |
29 | #include <linux/cpu_cooling.h> | |
30 | ||
31 | /** | |
3b3c0748 | 32 | * struct cpufreq_cooling_device - data for cooling device with cpufreq |
02361418 ADK |
33 | * @id: unique integer value corresponding to each cpufreq_cooling_device |
34 | * registered. | |
3b3c0748 EV |
35 | * @cool_dev: thermal_cooling_device pointer to keep track of the |
36 | * registered cooling device. | |
02361418 ADK |
37 | * @cpufreq_state: integer value representing the current state of cpufreq |
38 | * cooling devices. | |
39 | * @cpufreq_val: integer value representing the absolute value of the clipped | |
40 | * frequency. | |
41 | * @allowed_cpus: all the cpus involved for this cpufreq_cooling_device. | |
02361418 ADK |
42 | * |
43 | * This structure is required for keeping information of each | |
67d0b2a8 | 44 | * cpufreq_cooling_device registered. In order to prevent corruption of this a |
02361418 ADK |
45 | * mutex lock cooling_cpufreq_lock is used. |
46 | */ | |
47 | struct cpufreq_cooling_device { | |
48 | int id; | |
49 | struct thermal_cooling_device *cool_dev; | |
50 | unsigned int cpufreq_state; | |
51 | unsigned int cpufreq_val; | |
52 | struct cpumask allowed_cpus; | |
02361418 | 53 | }; |
02361418 | 54 | static DEFINE_IDR(cpufreq_idr); |
160b7d80 | 55 | static DEFINE_MUTEX(cooling_cpufreq_lock); |
02361418 | 56 | |
160b7d80 | 57 | static unsigned int cpufreq_dev_count; |
02361418 ADK |
58 | |
59 | /* notify_table passes value to the CPUFREQ_ADJUST callback function. */ | |
60 | #define NOTIFY_INVALID NULL | |
a0f846c2 | 61 | static struct cpufreq_cooling_device *notify_device; |
02361418 ADK |
62 | |
63 | /** | |
64 | * get_idr - function to get a unique id. | |
65 | * @idr: struct idr * handle used to create a id. | |
66 | * @id: int * value generated by this function. | |
79491e53 EV |
67 | * |
68 | * This function will populate @id with an unique | |
69 | * id, using the idr API. | |
70 | * | |
71 | * Return: 0 on success, an error code on failure. | |
02361418 ADK |
72 | */ |
73 | static int get_idr(struct idr *idr, int *id) | |
74 | { | |
6deb69fa | 75 | int ret; |
02361418 ADK |
76 | |
77 | mutex_lock(&cooling_cpufreq_lock); | |
6deb69fa | 78 | ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL); |
02361418 | 79 | mutex_unlock(&cooling_cpufreq_lock); |
6deb69fa TH |
80 | if (unlikely(ret < 0)) |
81 | return ret; | |
82 | *id = ret; | |
79491e53 | 83 | |
02361418 ADK |
84 | return 0; |
85 | } | |
86 | ||
87 | /** | |
88 | * release_idr - function to free the unique id. | |
89 | * @idr: struct idr * handle used for creating the id. | |
90 | * @id: int value representing the unique id. | |
91 | */ | |
92 | static void release_idr(struct idr *idr, int id) | |
93 | { | |
94 | mutex_lock(&cooling_cpufreq_lock); | |
95 | idr_remove(idr, id); | |
96 | mutex_unlock(&cooling_cpufreq_lock); | |
97 | } | |
98 | ||
99 | /* Below code defines functions to be used for cpufreq as cooling device */ | |
100 | ||
101 | /** | |
82b9ee40 | 102 | * is_cpufreq_valid - function to check frequency transitioning capability. |
02361418 | 103 | * @cpu: cpu for which check is needed. |
82b9ee40 EV |
104 | * |
105 | * This function will check the current state of the system if | |
106 | * it is capable of changing the frequency for a given @cpu. | |
107 | * | |
108 | * Return: 0 if the system is not currently capable of changing | |
109 | * the frequency of given cpu. !0 in case the frequency is changeable. | |
02361418 ADK |
110 | */ |
111 | static int is_cpufreq_valid(int cpu) | |
112 | { | |
113 | struct cpufreq_policy policy; | |
79491e53 | 114 | |
02361418 ADK |
115 | return !cpufreq_get_policy(&policy, cpu); |
116 | } | |
117 | ||
fc35b35c ZR |
118 | enum cpufreq_cooling_property { |
119 | GET_LEVEL, | |
120 | GET_FREQ, | |
121 | GET_MAXL, | |
122 | }; | |
123 | ||
2d6f28fe EV |
124 | /** |
125 | * get_property - fetch a property of interest for a give cpu. | |
126 | * @cpu: cpu for which the property is required | |
127 | * @input: query parameter | |
128 | * @output: query return | |
129 | * @property: type of query (frequency, level, max level) | |
130 | * | |
131 | * This is the common function to | |
fc35b35c ZR |
132 | * 1. get maximum cpu cooling states |
133 | * 2. translate frequency to cooling state | |
134 | * 3. translate cooling state to frequency | |
135 | * Note that the code may be not in good shape | |
136 | * but it is written in this way in order to: | |
137 | * a) reduce duplicate code as most of the code can be shared. | |
138 | * b) make sure the logic is consistent when translating between | |
139 | * cooling states and frequencies. | |
2d6f28fe EV |
140 | * |
141 | * Return: 0 on success, -EINVAL when invalid parameters are passed. | |
142 | */ | |
fc35b35c | 143 | static int get_property(unsigned int cpu, unsigned long input, |
d8892a01 EV |
144 | unsigned int *output, |
145 | enum cpufreq_cooling_property property) | |
02361418 | 146 | { |
3c84ef3a | 147 | int i; |
4469b997 | 148 | unsigned long max_level = 0, level = 0; |
fc35b35c ZR |
149 | unsigned int freq = CPUFREQ_ENTRY_INVALID; |
150 | int descend = -1; | |
3c84ef3a | 151 | struct cpufreq_frequency_table *pos, *table = |
02361418 | 152 | cpufreq_frequency_get_table(cpu); |
79d26401 | 153 | |
fc35b35c ZR |
154 | if (!output) |
155 | return -EINVAL; | |
156 | ||
02361418 | 157 | if (!table) |
fc35b35c | 158 | return -EINVAL; |
02361418 | 159 | |
3c84ef3a | 160 | cpufreq_for_each_valid_entry(pos, table) { |
fc35b35c | 161 | /* ignore duplicate entry */ |
3c84ef3a | 162 | if (freq == pos->frequency) |
fc35b35c ZR |
163 | continue; |
164 | ||
165 | /* get the frequency order */ | |
24c7a381 | 166 | if (freq != CPUFREQ_ENTRY_INVALID && descend == -1) |
3c84ef3a | 167 | descend = freq > pos->frequency; |
02361418 | 168 | |
3c84ef3a | 169 | freq = pos->frequency; |
fc35b35c | 170 | max_level++; |
02361418 | 171 | } |
a116776f ZR |
172 | |
173 | /* No valid cpu frequency entry */ | |
174 | if (max_level == 0) | |
175 | return -EINVAL; | |
176 | ||
1c9573a4 EV |
177 | /* max_level is an index, not a counter */ |
178 | max_level--; | |
02361418 | 179 | |
fc35b35c ZR |
180 | /* get max level */ |
181 | if (property == GET_MAXL) { | |
182 | *output = (unsigned int)max_level; | |
183 | return 0; | |
184 | } | |
02361418 | 185 | |
fc35b35c | 186 | if (property == GET_FREQ) |
1c9573a4 | 187 | level = descend ? input : (max_level - input); |
fc35b35c | 188 | |
3c84ef3a SK |
189 | i = 0; |
190 | cpufreq_for_each_valid_entry(pos, table) { | |
fc35b35c | 191 | /* ignore duplicate entry */ |
3c84ef3a | 192 | if (freq == pos->frequency) |
fc35b35c ZR |
193 | continue; |
194 | ||
195 | /* now we have a valid frequency entry */ | |
3c84ef3a | 196 | freq = pos->frequency; |
fc35b35c ZR |
197 | |
198 | if (property == GET_LEVEL && (unsigned int)input == freq) { | |
199 | /* get level by frequency */ | |
3c84ef3a | 200 | *output = descend ? i : (max_level - i); |
fc35b35c ZR |
201 | return 0; |
202 | } | |
3c84ef3a | 203 | if (property == GET_FREQ && level == i) { |
fc35b35c ZR |
204 | /* get frequency by level */ |
205 | *output = freq; | |
206 | return 0; | |
207 | } | |
3c84ef3a | 208 | i++; |
02361418 | 209 | } |
79491e53 | 210 | |
fc35b35c ZR |
211 | return -EINVAL; |
212 | } | |
213 | ||
44952d33 EV |
214 | /** |
215 | * cpufreq_cooling_get_level - for a give cpu, return the cooling level. | |
216 | * @cpu: cpu for which the level is required | |
217 | * @freq: the frequency of interest | |
218 | * | |
219 | * This function will match the cooling level corresponding to the | |
220 | * requested @freq and return it. | |
221 | * | |
222 | * Return: The matched cooling level on success or THERMAL_CSTATE_INVALID | |
223 | * otherwise. | |
224 | */ | |
57df8106 ZR |
225 | unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq) |
226 | { | |
227 | unsigned int val; | |
228 | ||
229 | if (get_property(cpu, (unsigned long)freq, &val, GET_LEVEL)) | |
230 | return THERMAL_CSTATE_INVALID; | |
79491e53 | 231 | |
57df8106 ZR |
232 | return (unsigned long)val; |
233 | } | |
243dbd9c | 234 | EXPORT_SYMBOL_GPL(cpufreq_cooling_get_level); |
57df8106 | 235 | |
fc35b35c ZR |
236 | /** |
237 | * get_cpu_frequency - get the absolute value of frequency from level. | |
238 | * @cpu: cpu for which frequency is fetched. | |
41518c41 EV |
239 | * @level: cooling level |
240 | * | |
241 | * This function matches cooling level with frequency. Based on a cooling level | |
242 | * of frequency, equals cooling state of cpu cooling device, it will return | |
243 | * the corresponding frequency. | |
fc35b35c | 244 | * e.g level=0 --> 1st MAX FREQ, level=1 ---> 2nd MAX FREQ, .... etc |
41518c41 EV |
245 | * |
246 | * Return: 0 on error, the corresponding frequency otherwise. | |
fc35b35c ZR |
247 | */ |
248 | static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level) | |
249 | { | |
250 | int ret = 0; | |
251 | unsigned int freq; | |
252 | ||
253 | ret = get_property(cpu, level, &freq, GET_FREQ); | |
254 | if (ret) | |
255 | return 0; | |
79491e53 | 256 | |
fc35b35c | 257 | return freq; |
02361418 ADK |
258 | } |
259 | ||
260 | /** | |
261 | * cpufreq_apply_cooling - function to apply frequency clipping. | |
262 | * @cpufreq_device: cpufreq_cooling_device pointer containing frequency | |
263 | * clipping data. | |
264 | * @cooling_state: value of the cooling state. | |
4b33deb5 EV |
265 | * |
266 | * Function used to make sure the cpufreq layer is aware of current thermal | |
267 | * limits. The limits are applied by updating the cpufreq policy. | |
268 | * | |
269 | * Return: 0 on success, an error code otherwise (-EINVAL in case wrong | |
270 | * cooling state). | |
02361418 ADK |
271 | */ |
272 | static int cpufreq_apply_cooling(struct cpufreq_cooling_device *cpufreq_device, | |
5fda7f68 | 273 | unsigned long cooling_state) |
02361418 ADK |
274 | { |
275 | unsigned int cpuid, clip_freq; | |
bde00663 LNM |
276 | struct cpumask *mask = &cpufreq_device->allowed_cpus; |
277 | unsigned int cpu = cpumask_any(mask); | |
02361418 ADK |
278 | |
279 | ||
280 | /* Check if the old cooling action is same as new cooling action */ | |
281 | if (cpufreq_device->cpufreq_state == cooling_state) | |
282 | return 0; | |
283 | ||
284 | clip_freq = get_cpu_frequency(cpu, cooling_state); | |
285 | if (!clip_freq) | |
286 | return -EINVAL; | |
287 | ||
288 | cpufreq_device->cpufreq_state = cooling_state; | |
289 | cpufreq_device->cpufreq_val = clip_freq; | |
290 | notify_device = cpufreq_device; | |
291 | ||
bde00663 | 292 | for_each_cpu(cpuid, mask) { |
02361418 ADK |
293 | if (is_cpufreq_valid(cpuid)) |
294 | cpufreq_update_policy(cpuid); | |
295 | } | |
296 | ||
297 | notify_device = NOTIFY_INVALID; | |
298 | ||
299 | return 0; | |
300 | } | |
301 | ||
302 | /** | |
303 | * cpufreq_thermal_notifier - notifier callback for cpufreq policy change. | |
304 | * @nb: struct notifier_block * with callback info. | |
305 | * @event: value showing cpufreq event for which this function invoked. | |
306 | * @data: callback-specific data | |
bab30554 | 307 | * |
9746b6e7 | 308 | * Callback to hijack the notification on cpufreq policy transition. |
bab30554 EV |
309 | * Every time there is a change in policy, we will intercept and |
310 | * update the cpufreq policy with thermal constraints. | |
311 | * | |
312 | * Return: 0 (success) | |
02361418 ADK |
313 | */ |
314 | static int cpufreq_thermal_notifier(struct notifier_block *nb, | |
5fda7f68 | 315 | unsigned long event, void *data) |
02361418 ADK |
316 | { |
317 | struct cpufreq_policy *policy = data; | |
318 | unsigned long max_freq = 0; | |
319 | ||
320 | if (event != CPUFREQ_ADJUST || notify_device == NOTIFY_INVALID) | |
321 | return 0; | |
322 | ||
323 | if (cpumask_test_cpu(policy->cpu, ¬ify_device->allowed_cpus)) | |
324 | max_freq = notify_device->cpufreq_val; | |
044d5c26 LT |
325 | else |
326 | return 0; | |
02361418 | 327 | |
1b9e3526 | 328 | /* Never exceed user_policy.max */ |
02361418 ADK |
329 | if (max_freq > policy->user_policy.max) |
330 | max_freq = policy->user_policy.max; | |
331 | ||
332 | if (policy->max != max_freq) | |
333 | cpufreq_verify_within_limits(policy, 0, max_freq); | |
334 | ||
335 | return 0; | |
336 | } | |
337 | ||
1b9e3526 | 338 | /* cpufreq cooling device callback functions are defined below */ |
02361418 ADK |
339 | |
340 | /** | |
341 | * cpufreq_get_max_state - callback function to get the max cooling state. | |
342 | * @cdev: thermal cooling device pointer. | |
343 | * @state: fill this variable with the max cooling state. | |
62c00421 EV |
344 | * |
345 | * Callback for the thermal cooling device to return the cpufreq | |
346 | * max cooling state. | |
347 | * | |
348 | * Return: 0 on success, an error code otherwise. | |
02361418 ADK |
349 | */ |
350 | static int cpufreq_get_max_state(struct thermal_cooling_device *cdev, | |
351 | unsigned long *state) | |
352 | { | |
160b7d80 | 353 | struct cpufreq_cooling_device *cpufreq_device = cdev->devdata; |
bde00663 | 354 | struct cpumask *mask = &cpufreq_device->allowed_cpus; |
02361418 | 355 | unsigned int cpu; |
4f89038f | 356 | unsigned int count = 0; |
fc35b35c | 357 | int ret; |
02361418 | 358 | |
bde00663 | 359 | cpu = cpumask_any(mask); |
02361418 | 360 | |
4f89038f | 361 | ret = get_property(cpu, 0, &count, GET_MAXL); |
9c51b05a | 362 | |
fc35b35c ZR |
363 | if (count > 0) |
364 | *state = count; | |
02361418 | 365 | |
fc35b35c | 366 | return ret; |
02361418 ADK |
367 | } |
368 | ||
369 | /** | |
370 | * cpufreq_get_cur_state - callback function to get the current cooling state. | |
371 | * @cdev: thermal cooling device pointer. | |
372 | * @state: fill this variable with the current cooling state. | |
3672552d EV |
373 | * |
374 | * Callback for the thermal cooling device to return the cpufreq | |
375 | * current cooling state. | |
376 | * | |
377 | * Return: 0 on success, an error code otherwise. | |
02361418 ADK |
378 | */ |
379 | static int cpufreq_get_cur_state(struct thermal_cooling_device *cdev, | |
380 | unsigned long *state) | |
381 | { | |
160b7d80 | 382 | struct cpufreq_cooling_device *cpufreq_device = cdev->devdata; |
02361418 | 383 | |
160b7d80 | 384 | *state = cpufreq_device->cpufreq_state; |
79491e53 | 385 | |
160b7d80 | 386 | return 0; |
02361418 ADK |
387 | } |
388 | ||
389 | /** | |
390 | * cpufreq_set_cur_state - callback function to set the current cooling state. | |
391 | * @cdev: thermal cooling device pointer. | |
392 | * @state: set this variable to the current cooling state. | |
56e05fdb EV |
393 | * |
394 | * Callback for the thermal cooling device to change the cpufreq | |
395 | * current cooling state. | |
396 | * | |
397 | * Return: 0 on success, an error code otherwise. | |
02361418 ADK |
398 | */ |
399 | static int cpufreq_set_cur_state(struct thermal_cooling_device *cdev, | |
400 | unsigned long state) | |
401 | { | |
160b7d80 | 402 | struct cpufreq_cooling_device *cpufreq_device = cdev->devdata; |
02361418 | 403 | |
160b7d80 | 404 | return cpufreq_apply_cooling(cpufreq_device, state); |
02361418 ADK |
405 | } |
406 | ||
407 | /* Bind cpufreq callbacks to thermal cooling device ops */ | |
408 | static struct thermal_cooling_device_ops const cpufreq_cooling_ops = { | |
409 | .get_max_state = cpufreq_get_max_state, | |
410 | .get_cur_state = cpufreq_get_cur_state, | |
411 | .set_cur_state = cpufreq_set_cur_state, | |
412 | }; | |
413 | ||
414 | /* Notifier for cpufreq policy change */ | |
415 | static struct notifier_block thermal_cpufreq_notifier_block = { | |
416 | .notifier_call = cpufreq_thermal_notifier, | |
417 | }; | |
418 | ||
419 | /** | |
39d99cff EV |
420 | * __cpufreq_cooling_register - helper function to create cpufreq cooling device |
421 | * @np: a valid struct device_node to the cooling device device tree node | |
02361418 | 422 | * @clip_cpus: cpumask of cpus where the frequency constraints will happen. |
12cb08ba EV |
423 | * |
424 | * This interface function registers the cpufreq cooling device with the name | |
425 | * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq | |
39d99cff EV |
426 | * cooling devices. It also gives the opportunity to link the cooling device |
427 | * with a device tree node, in order to bind it via the thermal DT code. | |
12cb08ba EV |
428 | * |
429 | * Return: a valid struct thermal_cooling_device pointer on success, | |
430 | * on failure, it returns a corresponding ERR_PTR(). | |
02361418 | 431 | */ |
39d99cff EV |
432 | static struct thermal_cooling_device * |
433 | __cpufreq_cooling_register(struct device_node *np, | |
434 | const struct cpumask *clip_cpus) | |
02361418 ADK |
435 | { |
436 | struct thermal_cooling_device *cool_dev; | |
437 | struct cpufreq_cooling_device *cpufreq_dev = NULL; | |
160b7d80 | 438 | unsigned int min = 0, max = 0; |
02361418 | 439 | char dev_name[THERMAL_NAME_LENGTH]; |
a4b6fec9 | 440 | int ret = 0, i; |
02361418 ADK |
441 | struct cpufreq_policy policy; |
442 | ||
1b9e3526 | 443 | /* Verify that all the clip cpus have same freq_min, freq_max limit */ |
02361418 | 444 | for_each_cpu(i, clip_cpus) { |
1b9e3526 | 445 | /* continue if cpufreq policy not found and not return error */ |
02361418 ADK |
446 | if (!cpufreq_get_policy(&policy, i)) |
447 | continue; | |
448 | if (min == 0 && max == 0) { | |
449 | min = policy.cpuinfo.min_freq; | |
450 | max = policy.cpuinfo.max_freq; | |
451 | } else { | |
452 | if (min != policy.cpuinfo.min_freq || | |
5fda7f68 | 453 | max != policy.cpuinfo.max_freq) |
02361418 | 454 | return ERR_PTR(-EINVAL); |
6b6519df | 455 | } |
02361418 ADK |
456 | } |
457 | cpufreq_dev = kzalloc(sizeof(struct cpufreq_cooling_device), | |
5fda7f68 | 458 | GFP_KERNEL); |
02361418 ADK |
459 | if (!cpufreq_dev) |
460 | return ERR_PTR(-ENOMEM); | |
461 | ||
462 | cpumask_copy(&cpufreq_dev->allowed_cpus, clip_cpus); | |
463 | ||
02361418 ADK |
464 | ret = get_idr(&cpufreq_idr, &cpufreq_dev->id); |
465 | if (ret) { | |
466 | kfree(cpufreq_dev); | |
467 | return ERR_PTR(-EINVAL); | |
468 | } | |
469 | ||
99871a71 EV |
470 | snprintf(dev_name, sizeof(dev_name), "thermal-cpufreq-%d", |
471 | cpufreq_dev->id); | |
02361418 | 472 | |
39d99cff EV |
473 | cool_dev = thermal_of_cooling_device_register(np, dev_name, cpufreq_dev, |
474 | &cpufreq_cooling_ops); | |
73b9bcd7 | 475 | if (IS_ERR(cool_dev)) { |
02361418 ADK |
476 | release_idr(&cpufreq_idr, cpufreq_dev->id); |
477 | kfree(cpufreq_dev); | |
73b9bcd7 | 478 | return cool_dev; |
02361418 | 479 | } |
02361418 ADK |
480 | cpufreq_dev->cool_dev = cool_dev; |
481 | cpufreq_dev->cpufreq_state = 0; | |
482 | mutex_lock(&cooling_cpufreq_lock); | |
02361418 ADK |
483 | |
484 | /* Register the notifier for first cpufreq cooling device */ | |
485 | if (cpufreq_dev_count == 0) | |
486 | cpufreq_register_notifier(&thermal_cpufreq_notifier_block, | |
5fda7f68 | 487 | CPUFREQ_POLICY_NOTIFIER); |
160b7d80 | 488 | cpufreq_dev_count++; |
02361418 ADK |
489 | |
490 | mutex_unlock(&cooling_cpufreq_lock); | |
79491e53 | 491 | |
02361418 ADK |
492 | return cool_dev; |
493 | } | |
39d99cff EV |
494 | |
495 | /** | |
496 | * cpufreq_cooling_register - function to create cpufreq cooling device. | |
497 | * @clip_cpus: cpumask of cpus where the frequency constraints will happen. | |
498 | * | |
499 | * This interface function registers the cpufreq cooling device with the name | |
500 | * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq | |
501 | * cooling devices. | |
502 | * | |
503 | * Return: a valid struct thermal_cooling_device pointer on success, | |
504 | * on failure, it returns a corresponding ERR_PTR(). | |
505 | */ | |
506 | struct thermal_cooling_device * | |
507 | cpufreq_cooling_register(const struct cpumask *clip_cpus) | |
508 | { | |
509 | return __cpufreq_cooling_register(NULL, clip_cpus); | |
510 | } | |
243dbd9c | 511 | EXPORT_SYMBOL_GPL(cpufreq_cooling_register); |
02361418 | 512 | |
39d99cff EV |
513 | /** |
514 | * of_cpufreq_cooling_register - function to create cpufreq cooling device. | |
515 | * @np: a valid struct device_node to the cooling device device tree node | |
516 | * @clip_cpus: cpumask of cpus where the frequency constraints will happen. | |
517 | * | |
518 | * This interface function registers the cpufreq cooling device with the name | |
519 | * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq | |
520 | * cooling devices. Using this API, the cpufreq cooling device will be | |
521 | * linked to the device tree node provided. | |
522 | * | |
523 | * Return: a valid struct thermal_cooling_device pointer on success, | |
524 | * on failure, it returns a corresponding ERR_PTR(). | |
525 | */ | |
526 | struct thermal_cooling_device * | |
527 | of_cpufreq_cooling_register(struct device_node *np, | |
528 | const struct cpumask *clip_cpus) | |
529 | { | |
530 | if (!np) | |
531 | return ERR_PTR(-EINVAL); | |
532 | ||
533 | return __cpufreq_cooling_register(np, clip_cpus); | |
534 | } | |
535 | EXPORT_SYMBOL_GPL(of_cpufreq_cooling_register); | |
536 | ||
02361418 ADK |
537 | /** |
538 | * cpufreq_cooling_unregister - function to remove cpufreq cooling device. | |
539 | * @cdev: thermal cooling device pointer. | |
135266b4 EV |
540 | * |
541 | * This interface function unregisters the "thermal-cpufreq-%x" cooling device. | |
02361418 ADK |
542 | */ |
543 | void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev) | |
544 | { | |
50e66c7e | 545 | struct cpufreq_cooling_device *cpufreq_dev; |
02361418 | 546 | |
50e66c7e EV |
547 | if (!cdev) |
548 | return; | |
549 | ||
550 | cpufreq_dev = cdev->devdata; | |
02361418 | 551 | mutex_lock(&cooling_cpufreq_lock); |
160b7d80 | 552 | cpufreq_dev_count--; |
02361418 ADK |
553 | |
554 | /* Unregister the notifier for the last cpufreq cooling device */ | |
2d9bf71c | 555 | if (cpufreq_dev_count == 0) |
02361418 | 556 | cpufreq_unregister_notifier(&thermal_cpufreq_notifier_block, |
5fda7f68 | 557 | CPUFREQ_POLICY_NOTIFIER); |
02361418 | 558 | mutex_unlock(&cooling_cpufreq_lock); |
160b7d80 | 559 | |
02361418 ADK |
560 | thermal_cooling_device_unregister(cpufreq_dev->cool_dev); |
561 | release_idr(&cpufreq_idr, cpufreq_dev->id); | |
02361418 ADK |
562 | kfree(cpufreq_dev); |
563 | } | |
243dbd9c | 564 | EXPORT_SYMBOL_GPL(cpufreq_cooling_unregister); |