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. | |
42 | * @node: list_head to link all cpufreq_cooling_device together. | |
43 | * | |
44 | * This structure is required for keeping information of each | |
45 | * cpufreq_cooling_device registered as a list whose head is represented by | |
46 | * cooling_cpufreq_list. In order to prevent corruption of this list a | |
47 | * mutex lock cooling_cpufreq_lock is used. | |
48 | */ | |
49 | struct cpufreq_cooling_device { | |
50 | int id; | |
51 | struct thermal_cooling_device *cool_dev; | |
52 | unsigned int cpufreq_state; | |
53 | unsigned int cpufreq_val; | |
54 | struct cpumask allowed_cpus; | |
55 | struct list_head node; | |
56 | }; | |
57 | static LIST_HEAD(cooling_cpufreq_list); | |
58 | static DEFINE_IDR(cpufreq_idr); | |
160b7d80 | 59 | static DEFINE_MUTEX(cooling_cpufreq_lock); |
02361418 | 60 | |
160b7d80 | 61 | static unsigned int cpufreq_dev_count; |
02361418 ADK |
62 | |
63 | /* notify_table passes value to the CPUFREQ_ADJUST callback function. */ | |
64 | #define NOTIFY_INVALID NULL | |
a0f846c2 | 65 | static struct cpufreq_cooling_device *notify_device; |
02361418 ADK |
66 | |
67 | /** | |
68 | * get_idr - function to get a unique id. | |
69 | * @idr: struct idr * handle used to create a id. | |
70 | * @id: int * value generated by this function. | |
71 | */ | |
72 | static int get_idr(struct idr *idr, int *id) | |
73 | { | |
6deb69fa | 74 | int ret; |
02361418 ADK |
75 | |
76 | mutex_lock(&cooling_cpufreq_lock); | |
6deb69fa | 77 | ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL); |
02361418 | 78 | mutex_unlock(&cooling_cpufreq_lock); |
6deb69fa TH |
79 | if (unlikely(ret < 0)) |
80 | return ret; | |
81 | *id = ret; | |
02361418 ADK |
82 | return 0; |
83 | } | |
84 | ||
85 | /** | |
86 | * release_idr - function to free the unique id. | |
87 | * @idr: struct idr * handle used for creating the id. | |
88 | * @id: int value representing the unique id. | |
89 | */ | |
90 | static void release_idr(struct idr *idr, int id) | |
91 | { | |
92 | mutex_lock(&cooling_cpufreq_lock); | |
93 | idr_remove(idr, id); | |
94 | mutex_unlock(&cooling_cpufreq_lock); | |
95 | } | |
96 | ||
97 | /* Below code defines functions to be used for cpufreq as cooling device */ | |
98 | ||
99 | /** | |
100 | * is_cpufreq_valid - function to check if a cpu has frequency transition policy. | |
101 | * @cpu: cpu for which check is needed. | |
102 | */ | |
103 | static int is_cpufreq_valid(int cpu) | |
104 | { | |
105 | struct cpufreq_policy policy; | |
106 | return !cpufreq_get_policy(&policy, cpu); | |
107 | } | |
108 | ||
fc35b35c ZR |
109 | enum cpufreq_cooling_property { |
110 | GET_LEVEL, | |
111 | GET_FREQ, | |
112 | GET_MAXL, | |
113 | }; | |
114 | ||
115 | /* | |
116 | * this is the common function to | |
117 | * 1. get maximum cpu cooling states | |
118 | * 2. translate frequency to cooling state | |
119 | * 3. translate cooling state to frequency | |
120 | * Note that the code may be not in good shape | |
121 | * but it is written in this way in order to: | |
122 | * a) reduce duplicate code as most of the code can be shared. | |
123 | * b) make sure the logic is consistent when translating between | |
124 | * cooling states and frequencies. | |
125 | */ | |
126 | static int get_property(unsigned int cpu, unsigned long input, | |
127 | unsigned int* output, enum cpufreq_cooling_property property) | |
02361418 | 128 | { |
fc35b35c ZR |
129 | int i, j; |
130 | unsigned long max_level = 0, level; | |
131 | unsigned int freq = CPUFREQ_ENTRY_INVALID; | |
132 | int descend = -1; | |
02361418 ADK |
133 | struct cpufreq_frequency_table *table = |
134 | cpufreq_frequency_get_table(cpu); | |
fc35b35c ZR |
135 | |
136 | if (!output) | |
137 | return -EINVAL; | |
138 | ||
02361418 | 139 | if (!table) |
fc35b35c | 140 | return -EINVAL; |
02361418 | 141 | |
fc35b35c ZR |
142 | |
143 | for (i = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { | |
144 | /* ignore invalid entries */ | |
02361418 ADK |
145 | if (table[i].frequency == CPUFREQ_ENTRY_INVALID) |
146 | continue; | |
147 | ||
fc35b35c ZR |
148 | /* ignore duplicate entry */ |
149 | if (freq == table[i].frequency) | |
150 | continue; | |
151 | ||
152 | /* get the frequency order */ | |
153 | if (freq != CPUFREQ_ENTRY_INVALID && descend != -1) | |
154 | descend = !!(freq > table[i].frequency); | |
02361418 | 155 | |
fc35b35c ZR |
156 | freq = table[i].frequency; |
157 | max_level++; | |
02361418 | 158 | } |
02361418 | 159 | |
fc35b35c ZR |
160 | /* get max level */ |
161 | if (property == GET_MAXL) { | |
162 | *output = (unsigned int)max_level; | |
163 | return 0; | |
164 | } | |
02361418 | 165 | |
fc35b35c ZR |
166 | if (property == GET_FREQ) |
167 | level = descend ? input : (max_level - input -1); | |
168 | ||
02361418 | 169 | |
fc35b35c ZR |
170 | for (i = 0, j = 0; table[i].frequency != CPUFREQ_TABLE_END; i++) { |
171 | /* ignore invalid entry */ | |
02361418 ADK |
172 | if (table[i].frequency == CPUFREQ_ENTRY_INVALID) |
173 | continue; | |
fc35b35c ZR |
174 | |
175 | /* ignore duplicate entry */ | |
176 | if (freq == table[i].frequency) | |
177 | continue; | |
178 | ||
179 | /* now we have a valid frequency entry */ | |
180 | freq = table[i].frequency; | |
181 | ||
182 | if (property == GET_LEVEL && (unsigned int)input == freq) { | |
183 | /* get level by frequency */ | |
184 | *output = descend ? j : (max_level - j - 1); | |
185 | return 0; | |
186 | } | |
187 | if (property == GET_FREQ && level == j) { | |
188 | /* get frequency by level */ | |
189 | *output = freq; | |
190 | return 0; | |
191 | } | |
192 | j++; | |
02361418 | 193 | } |
fc35b35c ZR |
194 | return -EINVAL; |
195 | } | |
196 | ||
57df8106 ZR |
197 | unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq) |
198 | { | |
199 | unsigned int val; | |
200 | ||
201 | if (get_property(cpu, (unsigned long)freq, &val, GET_LEVEL)) | |
202 | return THERMAL_CSTATE_INVALID; | |
203 | return (unsigned long)val; | |
204 | } | |
205 | ||
206 | EXPORT_SYMBOL(cpufreq_cooling_get_level); | |
207 | ||
fc35b35c ZR |
208 | /** |
209 | * get_cpu_frequency - get the absolute value of frequency from level. | |
210 | * @cpu: cpu for which frequency is fetched. | |
211 | * @level: level of frequency, equals cooling state of cpu cooling device | |
212 | * e.g level=0 --> 1st MAX FREQ, level=1 ---> 2nd MAX FREQ, .... etc | |
213 | */ | |
214 | static unsigned int get_cpu_frequency(unsigned int cpu, unsigned long level) | |
215 | { | |
216 | int ret = 0; | |
217 | unsigned int freq; | |
218 | ||
219 | ret = get_property(cpu, level, &freq, GET_FREQ); | |
220 | if (ret) | |
221 | return 0; | |
222 | return freq; | |
02361418 ADK |
223 | } |
224 | ||
225 | /** | |
226 | * cpufreq_apply_cooling - function to apply frequency clipping. | |
227 | * @cpufreq_device: cpufreq_cooling_device pointer containing frequency | |
228 | * clipping data. | |
229 | * @cooling_state: value of the cooling state. | |
230 | */ | |
231 | static int cpufreq_apply_cooling(struct cpufreq_cooling_device *cpufreq_device, | |
232 | unsigned long cooling_state) | |
233 | { | |
234 | unsigned int cpuid, clip_freq; | |
bde00663 LNM |
235 | struct cpumask *mask = &cpufreq_device->allowed_cpus; |
236 | unsigned int cpu = cpumask_any(mask); | |
02361418 ADK |
237 | |
238 | ||
239 | /* Check if the old cooling action is same as new cooling action */ | |
240 | if (cpufreq_device->cpufreq_state == cooling_state) | |
241 | return 0; | |
242 | ||
243 | clip_freq = get_cpu_frequency(cpu, cooling_state); | |
244 | if (!clip_freq) | |
245 | return -EINVAL; | |
246 | ||
247 | cpufreq_device->cpufreq_state = cooling_state; | |
248 | cpufreq_device->cpufreq_val = clip_freq; | |
249 | notify_device = cpufreq_device; | |
250 | ||
bde00663 | 251 | for_each_cpu(cpuid, mask) { |
02361418 ADK |
252 | if (is_cpufreq_valid(cpuid)) |
253 | cpufreq_update_policy(cpuid); | |
254 | } | |
255 | ||
256 | notify_device = NOTIFY_INVALID; | |
257 | ||
258 | return 0; | |
259 | } | |
260 | ||
261 | /** | |
262 | * cpufreq_thermal_notifier - notifier callback for cpufreq policy change. | |
263 | * @nb: struct notifier_block * with callback info. | |
264 | * @event: value showing cpufreq event for which this function invoked. | |
265 | * @data: callback-specific data | |
266 | */ | |
267 | static int cpufreq_thermal_notifier(struct notifier_block *nb, | |
268 | unsigned long event, void *data) | |
269 | { | |
270 | struct cpufreq_policy *policy = data; | |
271 | unsigned long max_freq = 0; | |
272 | ||
273 | if (event != CPUFREQ_ADJUST || notify_device == NOTIFY_INVALID) | |
274 | return 0; | |
275 | ||
276 | if (cpumask_test_cpu(policy->cpu, ¬ify_device->allowed_cpus)) | |
277 | max_freq = notify_device->cpufreq_val; | |
278 | ||
279 | /* Never exceed user_policy.max*/ | |
280 | if (max_freq > policy->user_policy.max) | |
281 | max_freq = policy->user_policy.max; | |
282 | ||
283 | if (policy->max != max_freq) | |
284 | cpufreq_verify_within_limits(policy, 0, max_freq); | |
285 | ||
286 | return 0; | |
287 | } | |
288 | ||
289 | /* | |
290 | * cpufreq cooling device callback functions are defined below | |
291 | */ | |
292 | ||
293 | /** | |
294 | * cpufreq_get_max_state - callback function to get the max cooling state. | |
295 | * @cdev: thermal cooling device pointer. | |
296 | * @state: fill this variable with the max cooling state. | |
297 | */ | |
298 | static int cpufreq_get_max_state(struct thermal_cooling_device *cdev, | |
299 | unsigned long *state) | |
300 | { | |
160b7d80 | 301 | struct cpufreq_cooling_device *cpufreq_device = cdev->devdata; |
bde00663 | 302 | struct cpumask *mask = &cpufreq_device->allowed_cpus; |
02361418 | 303 | unsigned int cpu; |
4f89038f | 304 | unsigned int count = 0; |
fc35b35c | 305 | int ret; |
02361418 | 306 | |
bde00663 | 307 | cpu = cpumask_any(mask); |
02361418 | 308 | |
4f89038f | 309 | ret = get_property(cpu, 0, &count, GET_MAXL); |
9c51b05a | 310 | |
fc35b35c ZR |
311 | if (count > 0) |
312 | *state = count; | |
02361418 | 313 | |
fc35b35c | 314 | return ret; |
02361418 ADK |
315 | } |
316 | ||
317 | /** | |
318 | * cpufreq_get_cur_state - callback function to get the current cooling state. | |
319 | * @cdev: thermal cooling device pointer. | |
320 | * @state: fill this variable with the current cooling state. | |
321 | */ | |
322 | static int cpufreq_get_cur_state(struct thermal_cooling_device *cdev, | |
323 | unsigned long *state) | |
324 | { | |
160b7d80 | 325 | struct cpufreq_cooling_device *cpufreq_device = cdev->devdata; |
02361418 | 326 | |
160b7d80 | 327 | *state = cpufreq_device->cpufreq_state; |
328 | return 0; | |
02361418 ADK |
329 | } |
330 | ||
331 | /** | |
332 | * cpufreq_set_cur_state - callback function to set the current cooling state. | |
333 | * @cdev: thermal cooling device pointer. | |
334 | * @state: set this variable to the current cooling state. | |
335 | */ | |
336 | static int cpufreq_set_cur_state(struct thermal_cooling_device *cdev, | |
337 | unsigned long state) | |
338 | { | |
160b7d80 | 339 | struct cpufreq_cooling_device *cpufreq_device = cdev->devdata; |
02361418 | 340 | |
160b7d80 | 341 | return cpufreq_apply_cooling(cpufreq_device, state); |
02361418 ADK |
342 | } |
343 | ||
344 | /* Bind cpufreq callbacks to thermal cooling device ops */ | |
345 | static struct thermal_cooling_device_ops const cpufreq_cooling_ops = { | |
346 | .get_max_state = cpufreq_get_max_state, | |
347 | .get_cur_state = cpufreq_get_cur_state, | |
348 | .set_cur_state = cpufreq_set_cur_state, | |
349 | }; | |
350 | ||
351 | /* Notifier for cpufreq policy change */ | |
352 | static struct notifier_block thermal_cpufreq_notifier_block = { | |
353 | .notifier_call = cpufreq_thermal_notifier, | |
354 | }; | |
355 | ||
356 | /** | |
357 | * cpufreq_cooling_register - function to create cpufreq cooling device. | |
358 | * @clip_cpus: cpumask of cpus where the frequency constraints will happen. | |
359 | */ | |
360 | struct thermal_cooling_device *cpufreq_cooling_register( | |
3778ff5c | 361 | const struct cpumask *clip_cpus) |
02361418 ADK |
362 | { |
363 | struct thermal_cooling_device *cool_dev; | |
364 | struct cpufreq_cooling_device *cpufreq_dev = NULL; | |
160b7d80 | 365 | unsigned int min = 0, max = 0; |
02361418 | 366 | char dev_name[THERMAL_NAME_LENGTH]; |
a4b6fec9 | 367 | int ret = 0, i; |
02361418 ADK |
368 | struct cpufreq_policy policy; |
369 | ||
02361418 ADK |
370 | /*Verify that all the clip cpus have same freq_min, freq_max limit*/ |
371 | for_each_cpu(i, clip_cpus) { | |
372 | /*continue if cpufreq policy not found and not return error*/ | |
373 | if (!cpufreq_get_policy(&policy, i)) | |
374 | continue; | |
375 | if (min == 0 && max == 0) { | |
376 | min = policy.cpuinfo.min_freq; | |
377 | max = policy.cpuinfo.max_freq; | |
378 | } else { | |
379 | if (min != policy.cpuinfo.min_freq || | |
380 | max != policy.cpuinfo.max_freq) | |
381 | return ERR_PTR(-EINVAL); | |
6b6519df | 382 | } |
02361418 ADK |
383 | } |
384 | cpufreq_dev = kzalloc(sizeof(struct cpufreq_cooling_device), | |
385 | GFP_KERNEL); | |
386 | if (!cpufreq_dev) | |
387 | return ERR_PTR(-ENOMEM); | |
388 | ||
389 | cpumask_copy(&cpufreq_dev->allowed_cpus, clip_cpus); | |
390 | ||
02361418 ADK |
391 | ret = get_idr(&cpufreq_idr, &cpufreq_dev->id); |
392 | if (ret) { | |
393 | kfree(cpufreq_dev); | |
394 | return ERR_PTR(-EINVAL); | |
395 | } | |
396 | ||
397 | sprintf(dev_name, "thermal-cpufreq-%d", cpufreq_dev->id); | |
398 | ||
399 | cool_dev = thermal_cooling_device_register(dev_name, cpufreq_dev, | |
400 | &cpufreq_cooling_ops); | |
401 | if (!cool_dev) { | |
402 | release_idr(&cpufreq_idr, cpufreq_dev->id); | |
403 | kfree(cpufreq_dev); | |
404 | return ERR_PTR(-EINVAL); | |
405 | } | |
02361418 ADK |
406 | cpufreq_dev->cool_dev = cool_dev; |
407 | cpufreq_dev->cpufreq_state = 0; | |
408 | mutex_lock(&cooling_cpufreq_lock); | |
02361418 ADK |
409 | |
410 | /* Register the notifier for first cpufreq cooling device */ | |
411 | if (cpufreq_dev_count == 0) | |
412 | cpufreq_register_notifier(&thermal_cpufreq_notifier_block, | |
413 | CPUFREQ_POLICY_NOTIFIER); | |
160b7d80 | 414 | cpufreq_dev_count++; |
02361418 ADK |
415 | |
416 | mutex_unlock(&cooling_cpufreq_lock); | |
417 | return cool_dev; | |
418 | } | |
419 | EXPORT_SYMBOL(cpufreq_cooling_register); | |
420 | ||
421 | /** | |
422 | * cpufreq_cooling_unregister - function to remove cpufreq cooling device. | |
423 | * @cdev: thermal cooling device pointer. | |
424 | */ | |
425 | void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev) | |
426 | { | |
160b7d80 | 427 | struct cpufreq_cooling_device *cpufreq_dev = cdev->devdata; |
02361418 ADK |
428 | |
429 | mutex_lock(&cooling_cpufreq_lock); | |
160b7d80 | 430 | cpufreq_dev_count--; |
02361418 ADK |
431 | |
432 | /* Unregister the notifier for the last cpufreq cooling device */ | |
160b7d80 | 433 | if (cpufreq_dev_count == 0) { |
02361418 ADK |
434 | cpufreq_unregister_notifier(&thermal_cpufreq_notifier_block, |
435 | CPUFREQ_POLICY_NOTIFIER); | |
436 | } | |
437 | mutex_unlock(&cooling_cpufreq_lock); | |
160b7d80 | 438 | |
02361418 ADK |
439 | thermal_cooling_device_unregister(cpufreq_dev->cool_dev); |
440 | release_idr(&cpufreq_idr, cpufreq_dev->id); | |
02361418 ADK |
441 | kfree(cpufreq_dev); |
442 | } | |
443 | EXPORT_SYMBOL(cpufreq_cooling_unregister); |