blob: 3788ed74c9abe59eaed8e8ce4621cac7ecaffe35 [file] [log] [blame]
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301/*
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 *
Viresh Kumar73904cb2014-12-04 09:42:08 +05307 * Copyright (C) 2014 Viresh Kumar <viresh.kumar@linaro.org>
8 *
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05309 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053025#include <linux/module.h>
26#include <linux/thermal.h>
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053027#include <linux/cpufreq.h>
28#include <linux/err.h>
Javi Merinoc36cf072015-02-26 19:00:29 +000029#include <linux/pm_opp.h>
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053030#include <linux/slab.h>
31#include <linux/cpu.h>
32#include <linux/cpu_cooling.h>
33
Javi Merino6828a472015-03-02 17:17:20 +000034#include <trace/events/thermal.h>
35
Viresh Kumar07d888d2014-12-04 09:41:49 +053036/*
37 * Cooling state <-> CPUFreq frequency
38 *
39 * Cooling states are translated to frequencies throughout this driver and this
40 * is the relation between them.
41 *
42 * Highest cooling state corresponds to lowest possible frequency.
43 *
44 * i.e.
45 * level 0 --> 1st Max Freq
46 * level 1 --> 2nd Max Freq
47 * ...
48 */
49
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053050/**
Javi Merinoc36cf072015-02-26 19:00:29 +000051 * struct power_table - frequency to power conversion
52 * @frequency: frequency in KHz
53 * @power: power in mW
54 *
55 * This structure is built when the cooling device registers and helps
56 * in translating frequency to power and viceversa.
57 */
58struct power_table {
59 u32 frequency;
60 u32 power;
61};
62
63/**
Eduardo Valentin3b3c0742013-04-17 17:11:56 +000064 * struct cpufreq_cooling_device - data for cooling device with cpufreq
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053065 * @id: unique integer value corresponding to each cpufreq_cooling_device
66 * registered.
Eduardo Valentin3b3c0742013-04-17 17:11:56 +000067 * @cool_dev: thermal_cooling_device pointer to keep track of the
68 * registered cooling device.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053069 * @cpufreq_state: integer value representing the current state of cpufreq
70 * cooling devices.
Viresh Kumar59f0d212015-07-30 12:40:33 +053071 * @clipped_freq: integer value representing the absolute value of the clipped
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053072 * frequency.
Viresh Kumardcc6c7f2014-12-04 09:42:02 +053073 * @max_level: maximum cooling level. One less than total number of valid
74 * cpufreq frequencies.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053075 * @allowed_cpus: all the cpus involved for this cpufreq_cooling_device.
Javi Merinofc4de352014-12-15 16:55:52 +000076 * @node: list_head to link all cpufreq_cooling_device together.
Javi Merinoc36cf072015-02-26 19:00:29 +000077 * @last_load: load measured by the latest call to cpufreq_get_actual_power()
78 * @time_in_idle: previous reading of the absolute time that this cpu was idle
79 * @time_in_idle_timestamp: wall time of the last invocation of
80 * get_cpu_idle_time_us()
81 * @dyn_power_table: array of struct power_table for frequency to power
82 * conversion, sorted in ascending order.
83 * @dyn_power_table_entries: number of entries in the @dyn_power_table array
84 * @cpu_dev: the first cpu_device from @allowed_cpus that has OPPs registered
85 * @plat_get_static_power: callback to calculate the static power
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053086 *
Viresh Kumarbeca6052014-12-04 09:41:48 +053087 * This structure is required for keeping information of each registered
88 * cpufreq_cooling_device.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053089 */
90struct cpufreq_cooling_device {
91 int id;
92 struct thermal_cooling_device *cool_dev;
93 unsigned int cpufreq_state;
Viresh Kumar59f0d212015-07-30 12:40:33 +053094 unsigned int clipped_freq;
Viresh Kumardcc6c7f2014-12-04 09:42:02 +053095 unsigned int max_level;
Viresh Kumarf6859012014-12-04 09:42:06 +053096 unsigned int *freq_table; /* In descending order */
Amit Daniel Kachhap02361412012-08-16 17:11:40 +053097 struct cpumask allowed_cpus;
Yadwinder Singh Brar2dcd8512014-11-07 19:12:29 +053098 struct list_head node;
Javi Merinoc36cf072015-02-26 19:00:29 +000099 u32 last_load;
100 u64 *time_in_idle;
101 u64 *time_in_idle_timestamp;
102 struct power_table *dyn_power_table;
103 int dyn_power_table_entries;
104 struct device *cpu_dev;
105 get_static_t plat_get_static_power;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530106};
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530107static DEFINE_IDR(cpufreq_idr);
hongbo.zhang160b7d82012-10-30 17:48:59 +0100108static DEFINE_MUTEX(cooling_cpufreq_lock);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530109
Russell King02373d72015-08-12 15:22:16 +0530110static unsigned int cpufreq_dev_count;
111
112static DEFINE_MUTEX(cooling_list_lock);
Yadwinder Singh Brar2dcd8512014-11-07 19:12:29 +0530113static LIST_HEAD(cpufreq_dev_list);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530114
115/**
116 * get_idr - function to get a unique id.
117 * @idr: struct idr * handle used to create a id.
118 * @id: int * value generated by this function.
Eduardo Valentin79491e52013-04-17 17:11:59 +0000119 *
120 * This function will populate @id with an unique
121 * id, using the idr API.
122 *
123 * Return: 0 on success, an error code on failure.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530124 */
125static int get_idr(struct idr *idr, int *id)
126{
Tejun Heo6deb69f2013-02-27 17:04:46 -0800127 int ret;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530128
129 mutex_lock(&cooling_cpufreq_lock);
Tejun Heo6deb69f2013-02-27 17:04:46 -0800130 ret = idr_alloc(idr, NULL, 0, 0, GFP_KERNEL);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530131 mutex_unlock(&cooling_cpufreq_lock);
Tejun Heo6deb69f2013-02-27 17:04:46 -0800132 if (unlikely(ret < 0))
133 return ret;
134 *id = ret;
Eduardo Valentin79491e52013-04-17 17:11:59 +0000135
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530136 return 0;
137}
138
139/**
140 * release_idr - function to free the unique id.
141 * @idr: struct idr * handle used for creating the id.
142 * @id: int value representing the unique id.
143 */
144static void release_idr(struct idr *idr, int id)
145{
146 mutex_lock(&cooling_cpufreq_lock);
147 idr_remove(idr, id);
148 mutex_unlock(&cooling_cpufreq_lock);
149}
150
151/* Below code defines functions to be used for cpufreq as cooling device */
152
153/**
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530154 * get_level: Find the level for a particular frequency
Viresh Kumarb9f8b412014-12-04 09:42:05 +0530155 * @cpufreq_dev: cpufreq_dev for which the property is required
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530156 * @freq: Frequency
Eduardo Valentin82b9ee42013-04-17 17:12:00 +0000157 *
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530158 * Return: level on success, THERMAL_CSTATE_INVALID on error.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530159 */
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530160static unsigned long get_level(struct cpufreq_cooling_device *cpufreq_dev,
161 unsigned int freq)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530162{
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530163 unsigned long level;
Eduardo Valentin79491e52013-04-17 17:11:59 +0000164
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530165 for (level = 0; level <= cpufreq_dev->max_level; level++) {
166 if (freq == cpufreq_dev->freq_table[level])
167 return level;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530168
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530169 if (freq > cpufreq_dev->freq_table[level])
170 break;
Zhang Ruifc35b352013-02-08 13:09:32 +0800171 }
Zhang Ruia1167762014-01-02 11:57:48 +0800172
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530173 return THERMAL_CSTATE_INVALID;
Zhang Ruifc35b352013-02-08 13:09:32 +0800174}
175
Eduardo Valentin44952d32013-04-17 17:12:05 +0000176/**
Viresh Kumar728c03c2014-12-04 09:41:47 +0530177 * cpufreq_cooling_get_level - for a given cpu, return the cooling level.
Eduardo Valentin44952d32013-04-17 17:12:05 +0000178 * @cpu: cpu for which the level is required
179 * @freq: the frequency of interest
180 *
181 * This function will match the cooling level corresponding to the
182 * requested @freq and return it.
183 *
184 * Return: The matched cooling level on success or THERMAL_CSTATE_INVALID
185 * otherwise.
186 */
Zhang Rui57df8102013-02-08 14:52:06 +0800187unsigned long cpufreq_cooling_get_level(unsigned int cpu, unsigned int freq)
188{
Viresh Kumarb9f8b412014-12-04 09:42:05 +0530189 struct cpufreq_cooling_device *cpufreq_dev;
Zhang Rui57df8102013-02-08 14:52:06 +0800190
Russell King02373d72015-08-12 15:22:16 +0530191 mutex_lock(&cooling_list_lock);
Viresh Kumarb9f8b412014-12-04 09:42:05 +0530192 list_for_each_entry(cpufreq_dev, &cpufreq_dev_list, node) {
193 if (cpumask_test_cpu(cpu, &cpufreq_dev->allowed_cpus)) {
Russell King02373d72015-08-12 15:22:16 +0530194 mutex_unlock(&cooling_list_lock);
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530195 return get_level(cpufreq_dev, freq);
Viresh Kumarb9f8b412014-12-04 09:42:05 +0530196 }
197 }
Russell King02373d72015-08-12 15:22:16 +0530198 mutex_unlock(&cooling_list_lock);
Eduardo Valentin79491e52013-04-17 17:11:59 +0000199
Viresh Kumarb9f8b412014-12-04 09:42:05 +0530200 pr_err("%s: cpu:%d not part of any cooling device\n", __func__, cpu);
201 return THERMAL_CSTATE_INVALID;
Zhang Rui57df8102013-02-08 14:52:06 +0800202}
Eduardo Valentin243dbd92013-04-17 17:11:57 +0000203EXPORT_SYMBOL_GPL(cpufreq_cooling_get_level);
Zhang Rui57df8102013-02-08 14:52:06 +0800204
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530205/**
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530206 * cpufreq_thermal_notifier - notifier callback for cpufreq policy change.
207 * @nb: struct notifier_block * with callback info.
208 * @event: value showing cpufreq event for which this function invoked.
209 * @data: callback-specific data
Eduardo Valentinbab30552013-04-17 17:12:09 +0000210 *
Javi Merino9746b6e2014-06-25 18:11:17 +0100211 * Callback to hijack the notification on cpufreq policy transition.
Eduardo Valentinbab30552013-04-17 17:12:09 +0000212 * Every time there is a change in policy, we will intercept and
213 * update the cpufreq policy with thermal constraints.
214 *
215 * Return: 0 (success)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530216 */
217static int cpufreq_thermal_notifier(struct notifier_block *nb,
Eduardo Valentin5fda7f62013-04-17 17:12:11 +0000218 unsigned long event, void *data)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530219{
220 struct cpufreq_policy *policy = data;
Viresh Kumarabcbcc22015-07-30 12:40:34 +0530221 unsigned long clipped_freq;
Yadwinder Singh Brar2dcd8512014-11-07 19:12:29 +0530222 struct cpufreq_cooling_device *cpufreq_dev;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530223
Viresh Kumara24af232015-07-30 12:40:32 +0530224 if (event != CPUFREQ_ADJUST)
Javi Merinoc36cf072015-02-26 19:00:29 +0000225 return NOTIFY_DONE;
Viresh Kumara24af232015-07-30 12:40:32 +0530226
227 mutex_lock(&cooling_list_lock);
228 list_for_each_entry(cpufreq_dev, &cpufreq_dev_list, node) {
229 if (!cpumask_test_cpu(policy->cpu, &cpufreq_dev->allowed_cpus))
230 continue;
231
Viresh Kumar1afb9c52015-07-30 12:40:35 +0530232 /*
233 * policy->max is the maximum allowed frequency defined by user
234 * and clipped_freq is the maximum that thermal constraints
235 * allow.
236 *
237 * If clipped_freq is lower than policy->max, then we need to
238 * readjust policy->max.
239 *
240 * But, if clipped_freq is greater than policy->max, we don't
241 * need to do anything.
242 */
Viresh Kumarabcbcc22015-07-30 12:40:34 +0530243 clipped_freq = cpufreq_dev->clipped_freq;
Viresh Kumara24af232015-07-30 12:40:32 +0530244
Viresh Kumar1afb9c52015-07-30 12:40:35 +0530245 if (policy->max > clipped_freq)
Viresh Kumarabcbcc22015-07-30 12:40:34 +0530246 cpufreq_verify_within_limits(policy, 0, clipped_freq);
Viresh Kumara24af232015-07-30 12:40:32 +0530247 break;
Yadwinder Singh Brar2dcd8512014-11-07 19:12:29 +0530248 }
Viresh Kumara24af232015-07-30 12:40:32 +0530249 mutex_unlock(&cooling_list_lock);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530250
Javi Merinoc36cf072015-02-26 19:00:29 +0000251 return NOTIFY_OK;
252}
253
254/**
255 * build_dyn_power_table() - create a dynamic power to frequency table
256 * @cpufreq_device: the cpufreq cooling device in which to store the table
257 * @capacitance: dynamic power coefficient for these cpus
258 *
259 * Build a dynamic power to frequency table for this cpu and store it
260 * in @cpufreq_device. This table will be used in cpu_power_to_freq() and
261 * cpu_freq_to_power() to convert between power and frequency
262 * efficiently. Power is stored in mW, frequency in KHz. The
263 * resulting table is in ascending order.
264 *
Javi Merino459ac372015-08-17 19:21:42 +0100265 * Return: 0 on success, -EINVAL if there are no OPPs for any CPUs,
266 * -ENOMEM if we run out of memory or -EAGAIN if an OPP was
267 * added/enabled while the function was executing.
Javi Merinoc36cf072015-02-26 19:00:29 +0000268 */
269static int build_dyn_power_table(struct cpufreq_cooling_device *cpufreq_device,
270 u32 capacitance)
271{
272 struct power_table *power_table;
273 struct dev_pm_opp *opp;
274 struct device *dev = NULL;
Javi Merinoeba4f882015-08-17 19:21:43 +0100275 int num_opps = 0, cpu, i, ret = 0;
Javi Merinoc36cf072015-02-26 19:00:29 +0000276 unsigned long freq;
277
Javi Merinoc36cf072015-02-26 19:00:29 +0000278 for_each_cpu(cpu, &cpufreq_device->allowed_cpus) {
279 dev = get_cpu_device(cpu);
280 if (!dev) {
281 dev_warn(&cpufreq_device->cool_dev->device,
282 "No cpu device for cpu %d\n", cpu);
283 continue;
284 }
285
286 num_opps = dev_pm_opp_get_opp_count(dev);
Javi Merino459ac372015-08-17 19:21:42 +0100287 if (num_opps > 0)
Javi Merinoc36cf072015-02-26 19:00:29 +0000288 break;
Javi Merino459ac372015-08-17 19:21:42 +0100289 else if (num_opps < 0)
290 return num_opps;
Javi Merinoc36cf072015-02-26 19:00:29 +0000291 }
292
Javi Merino459ac372015-08-17 19:21:42 +0100293 if (num_opps == 0)
294 return -EINVAL;
Javi Merinoc36cf072015-02-26 19:00:29 +0000295
296 power_table = kcalloc(num_opps, sizeof(*power_table), GFP_KERNEL);
Javi Merino459ac372015-08-17 19:21:42 +0100297 if (!power_table)
298 return -ENOMEM;
299
300 rcu_read_lock();
Javi Merinoc36cf072015-02-26 19:00:29 +0000301
302 for (freq = 0, i = 0;
303 opp = dev_pm_opp_find_freq_ceil(dev, &freq), !IS_ERR(opp);
304 freq++, i++) {
305 u32 freq_mhz, voltage_mv;
306 u64 power;
307
Javi Merino459ac372015-08-17 19:21:42 +0100308 if (i >= num_opps) {
309 rcu_read_unlock();
Javi Merinoeba4f882015-08-17 19:21:43 +0100310 ret = -EAGAIN;
311 goto free_power_table;
Javi Merino459ac372015-08-17 19:21:42 +0100312 }
313
Javi Merinoc36cf072015-02-26 19:00:29 +0000314 freq_mhz = freq / 1000000;
315 voltage_mv = dev_pm_opp_get_voltage(opp) / 1000;
316
317 /*
318 * Do the multiplication with MHz and millivolt so as
319 * to not overflow.
320 */
321 power = (u64)capacitance * freq_mhz * voltage_mv * voltage_mv;
322 do_div(power, 1000000000);
323
324 /* frequency is stored in power_table in KHz */
325 power_table[i].frequency = freq / 1000;
326
327 /* power is stored in mW */
328 power_table[i].power = power;
329 }
330
Javi Merino459ac372015-08-17 19:21:42 +0100331 rcu_read_unlock();
332
Javi Merinoeba4f882015-08-17 19:21:43 +0100333 if (i != num_opps) {
334 ret = PTR_ERR(opp);
335 goto free_power_table;
336 }
Javi Merinoc36cf072015-02-26 19:00:29 +0000337
338 cpufreq_device->cpu_dev = dev;
339 cpufreq_device->dyn_power_table = power_table;
340 cpufreq_device->dyn_power_table_entries = i;
341
Javi Merino459ac372015-08-17 19:21:42 +0100342 return 0;
Javi Merinoeba4f882015-08-17 19:21:43 +0100343
344free_power_table:
345 kfree(power_table);
346
347 return ret;
Javi Merinoc36cf072015-02-26 19:00:29 +0000348}
349
350static u32 cpu_freq_to_power(struct cpufreq_cooling_device *cpufreq_device,
351 u32 freq)
352{
353 int i;
354 struct power_table *pt = cpufreq_device->dyn_power_table;
355
356 for (i = 1; i < cpufreq_device->dyn_power_table_entries; i++)
357 if (freq < pt[i].frequency)
358 break;
359
360 return pt[i - 1].power;
361}
362
363static u32 cpu_power_to_freq(struct cpufreq_cooling_device *cpufreq_device,
364 u32 power)
365{
366 int i;
367 struct power_table *pt = cpufreq_device->dyn_power_table;
368
369 for (i = 1; i < cpufreq_device->dyn_power_table_entries; i++)
370 if (power < pt[i].power)
371 break;
372
373 return pt[i - 1].frequency;
374}
375
376/**
377 * get_load() - get load for a cpu since last updated
378 * @cpufreq_device: &struct cpufreq_cooling_device for this cpu
379 * @cpu: cpu number
Javi Merinoa53b8392016-02-11 12:00:51 +0000380 * @cpu_idx: index of the cpu in cpufreq_device->allowed_cpus
Javi Merinoc36cf072015-02-26 19:00:29 +0000381 *
382 * Return: The average load of cpu @cpu in percentage since this
383 * function was last called.
384 */
Javi Merinoa53b8392016-02-11 12:00:51 +0000385static u32 get_load(struct cpufreq_cooling_device *cpufreq_device, int cpu,
386 int cpu_idx)
Javi Merinoc36cf072015-02-26 19:00:29 +0000387{
388 u32 load;
389 u64 now, now_idle, delta_time, delta_idle;
390
391 now_idle = get_cpu_idle_time(cpu, &now, 0);
Javi Merinoa53b8392016-02-11 12:00:51 +0000392 delta_idle = now_idle - cpufreq_device->time_in_idle[cpu_idx];
393 delta_time = now - cpufreq_device->time_in_idle_timestamp[cpu_idx];
Javi Merinoc36cf072015-02-26 19:00:29 +0000394
395 if (delta_time <= delta_idle)
396 load = 0;
397 else
398 load = div64_u64(100 * (delta_time - delta_idle), delta_time);
399
Javi Merinoa53b8392016-02-11 12:00:51 +0000400 cpufreq_device->time_in_idle[cpu_idx] = now_idle;
401 cpufreq_device->time_in_idle_timestamp[cpu_idx] = now;
Javi Merinoc36cf072015-02-26 19:00:29 +0000402
403 return load;
404}
405
406/**
407 * get_static_power() - calculate the static power consumed by the cpus
408 * @cpufreq_device: struct &cpufreq_cooling_device for this cpu cdev
409 * @tz: thermal zone device in which we're operating
410 * @freq: frequency in KHz
411 * @power: pointer in which to store the calculated static power
412 *
413 * Calculate the static power consumed by the cpus described by
414 * @cpu_actor running at frequency @freq. This function relies on a
415 * platform specific function that should have been provided when the
416 * actor was registered. If it wasn't, the static power is assumed to
417 * be negligible. The calculated static power is stored in @power.
418 *
419 * Return: 0 on success, -E* on failure.
420 */
421static int get_static_power(struct cpufreq_cooling_device *cpufreq_device,
422 struct thermal_zone_device *tz, unsigned long freq,
423 u32 *power)
424{
425 struct dev_pm_opp *opp;
426 unsigned long voltage;
427 struct cpumask *cpumask = &cpufreq_device->allowed_cpus;
428 unsigned long freq_hz = freq * 1000;
429
430 if (!cpufreq_device->plat_get_static_power ||
431 !cpufreq_device->cpu_dev) {
432 *power = 0;
433 return 0;
434 }
435
436 rcu_read_lock();
437
438 opp = dev_pm_opp_find_freq_exact(cpufreq_device->cpu_dev, freq_hz,
439 true);
440 voltage = dev_pm_opp_get_voltage(opp);
441
442 rcu_read_unlock();
443
444 if (voltage == 0) {
445 dev_warn_ratelimited(cpufreq_device->cpu_dev,
446 "Failed to get voltage for frequency %lu: %ld\n",
447 freq_hz, IS_ERR(opp) ? PTR_ERR(opp) : 0);
448 return -EINVAL;
449 }
450
451 return cpufreq_device->plat_get_static_power(cpumask, tz->passive_delay,
452 voltage, power);
453}
454
455/**
456 * get_dynamic_power() - calculate the dynamic power
457 * @cpufreq_device: &cpufreq_cooling_device for this cdev
458 * @freq: current frequency
459 *
460 * Return: the dynamic power consumed by the cpus described by
461 * @cpufreq_device.
462 */
463static u32 get_dynamic_power(struct cpufreq_cooling_device *cpufreq_device,
464 unsigned long freq)
465{
466 u32 raw_cpu_power;
467
468 raw_cpu_power = cpu_freq_to_power(cpufreq_device, freq);
469 return (raw_cpu_power * cpufreq_device->last_load) / 100;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530470}
471
Eduardo Valentin1b9e3522013-04-17 17:12:02 +0000472/* cpufreq cooling device callback functions are defined below */
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530473
474/**
475 * cpufreq_get_max_state - callback function to get the max cooling state.
476 * @cdev: thermal cooling device pointer.
477 * @state: fill this variable with the max cooling state.
Eduardo Valentin62c00422013-04-17 17:12:12 +0000478 *
479 * Callback for the thermal cooling device to return the cpufreq
480 * max cooling state.
481 *
482 * Return: 0 on success, an error code otherwise.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530483 */
484static int cpufreq_get_max_state(struct thermal_cooling_device *cdev,
485 unsigned long *state)
486{
hongbo.zhang160b7d82012-10-30 17:48:59 +0100487 struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530488
Viresh Kumardcc6c7f2014-12-04 09:42:02 +0530489 *state = cpufreq_device->max_level;
490 return 0;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530491}
492
493/**
494 * cpufreq_get_cur_state - callback function to get the current cooling state.
495 * @cdev: thermal cooling device pointer.
496 * @state: fill this variable with the current cooling state.
Eduardo Valentin36725522013-04-17 17:12:13 +0000497 *
498 * Callback for the thermal cooling device to return the cpufreq
499 * current cooling state.
500 *
501 * Return: 0 on success, an error code otherwise.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530502 */
503static int cpufreq_get_cur_state(struct thermal_cooling_device *cdev,
504 unsigned long *state)
505{
hongbo.zhang160b7d82012-10-30 17:48:59 +0100506 struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530507
hongbo.zhang160b7d82012-10-30 17:48:59 +0100508 *state = cpufreq_device->cpufreq_state;
Eduardo Valentin79491e52013-04-17 17:11:59 +0000509
hongbo.zhang160b7d82012-10-30 17:48:59 +0100510 return 0;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530511}
512
513/**
514 * cpufreq_set_cur_state - callback function to set the current cooling state.
515 * @cdev: thermal cooling device pointer.
516 * @state: set this variable to the current cooling state.
Eduardo Valentin56e05fdb2013-04-17 17:12:14 +0000517 *
518 * Callback for the thermal cooling device to change the cpufreq
519 * current cooling state.
520 *
521 * Return: 0 on success, an error code otherwise.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530522 */
523static int cpufreq_set_cur_state(struct thermal_cooling_device *cdev,
524 unsigned long state)
525{
hongbo.zhang160b7d82012-10-30 17:48:59 +0100526 struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
Viresh Kumar5194fe42014-12-04 09:42:00 +0530527 unsigned int cpu = cpumask_any(&cpufreq_device->allowed_cpus);
528 unsigned int clip_freq;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530529
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530530 /* Request state should be less than max_level */
531 if (WARN_ON(state > cpufreq_device->max_level))
532 return -EINVAL;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530533
Viresh Kumar5194fe42014-12-04 09:42:00 +0530534 /* Check if the old cooling action is same as new cooling action */
535 if (cpufreq_device->cpufreq_state == state)
536 return 0;
537
Viresh Kumar4843c4a2014-12-04 09:42:07 +0530538 clip_freq = cpufreq_device->freq_table[state];
Viresh Kumar5194fe42014-12-04 09:42:00 +0530539 cpufreq_device->cpufreq_state = state;
Viresh Kumar59f0d212015-07-30 12:40:33 +0530540 cpufreq_device->clipped_freq = clip_freq;
Viresh Kumar5194fe42014-12-04 09:42:00 +0530541
542 cpufreq_update_policy(cpu);
543
544 return 0;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530545}
546
Javi Merinoc36cf072015-02-26 19:00:29 +0000547/**
548 * cpufreq_get_requested_power() - get the current power
549 * @cdev: &thermal_cooling_device pointer
550 * @tz: a valid thermal zone device pointer
551 * @power: pointer in which to store the resulting power
552 *
553 * Calculate the current power consumption of the cpus in milliwatts
554 * and store it in @power. This function should actually calculate
555 * the requested power, but it's hard to get the frequency that
556 * cpufreq would have assigned if there were no thermal limits.
557 * Instead, we calculate the current power on the assumption that the
558 * immediate future will look like the immediate past.
559 *
560 * We use the current frequency and the average load since this
561 * function was last called. In reality, there could have been
562 * multiple opps since this function was last called and that affects
563 * the load calculation. While it's not perfectly accurate, this
564 * simplification is good enough and works. REVISIT this, as more
565 * complex code may be needed if experiments show that it's not
566 * accurate enough.
567 *
568 * Return: 0 on success, -E* if getting the static power failed.
569 */
570static int cpufreq_get_requested_power(struct thermal_cooling_device *cdev,
571 struct thermal_zone_device *tz,
572 u32 *power)
573{
574 unsigned long freq;
Javi Merino6828a472015-03-02 17:17:20 +0000575 int i = 0, cpu, ret;
Javi Merinoc36cf072015-02-26 19:00:29 +0000576 u32 static_power, dynamic_power, total_load = 0;
577 struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
Javi Merino6828a472015-03-02 17:17:20 +0000578 u32 *load_cpu = NULL;
Javi Merinoc36cf072015-02-26 19:00:29 +0000579
Kapileshwar Singhdd658e02015-03-16 12:00:51 +0000580 cpu = cpumask_any_and(&cpufreq_device->allowed_cpus, cpu_online_mask);
581
582 /*
583 * All the CPUs are offline, thus the requested power by
584 * the cdev is 0
585 */
586 if (cpu >= nr_cpu_ids) {
587 *power = 0;
588 return 0;
589 }
590
591 freq = cpufreq_quick_get(cpu);
Javi Merinoc36cf072015-02-26 19:00:29 +0000592
Javi Merino6828a472015-03-02 17:17:20 +0000593 if (trace_thermal_power_cpu_get_power_enabled()) {
594 u32 ncpus = cpumask_weight(&cpufreq_device->allowed_cpus);
595
Vaishali Thakkara71544c2015-08-19 11:52:19 +0530596 load_cpu = kcalloc(ncpus, sizeof(*load_cpu), GFP_KERNEL);
Javi Merino6828a472015-03-02 17:17:20 +0000597 }
598
Javi Merinoc36cf072015-02-26 19:00:29 +0000599 for_each_cpu(cpu, &cpufreq_device->allowed_cpus) {
600 u32 load;
601
602 if (cpu_online(cpu))
Javi Merinoa53b8392016-02-11 12:00:51 +0000603 load = get_load(cpufreq_device, cpu, i);
Javi Merinoc36cf072015-02-26 19:00:29 +0000604 else
605 load = 0;
606
607 total_load += load;
Javi Merino6828a472015-03-02 17:17:20 +0000608 if (trace_thermal_power_cpu_limit_enabled() && load_cpu)
609 load_cpu[i] = load;
610
611 i++;
Javi Merinoc36cf072015-02-26 19:00:29 +0000612 }
613
614 cpufreq_device->last_load = total_load;
615
616 dynamic_power = get_dynamic_power(cpufreq_device, freq);
617 ret = get_static_power(cpufreq_device, tz, freq, &static_power);
Javi Merino6828a472015-03-02 17:17:20 +0000618 if (ret) {
Vaishali Thakkara71544c2015-08-19 11:52:19 +0530619 kfree(load_cpu);
Javi Merinoc36cf072015-02-26 19:00:29 +0000620 return ret;
Javi Merino6828a472015-03-02 17:17:20 +0000621 }
622
623 if (load_cpu) {
624 trace_thermal_power_cpu_get_power(
625 &cpufreq_device->allowed_cpus,
626 freq, load_cpu, i, dynamic_power, static_power);
627
Vaishali Thakkara71544c2015-08-19 11:52:19 +0530628 kfree(load_cpu);
Javi Merino6828a472015-03-02 17:17:20 +0000629 }
Javi Merinoc36cf072015-02-26 19:00:29 +0000630
631 *power = static_power + dynamic_power;
632 return 0;
633}
634
635/**
636 * cpufreq_state2power() - convert a cpu cdev state to power consumed
637 * @cdev: &thermal_cooling_device pointer
638 * @tz: a valid thermal zone device pointer
639 * @state: cooling device state to be converted
640 * @power: pointer in which to store the resulting power
641 *
642 * Convert cooling device state @state into power consumption in
643 * milliwatts assuming 100% load. Store the calculated power in
644 * @power.
645 *
646 * Return: 0 on success, -EINVAL if the cooling device state could not
647 * be converted into a frequency or other -E* if there was an error
648 * when calculating the static power.
649 */
650static int cpufreq_state2power(struct thermal_cooling_device *cdev,
651 struct thermal_zone_device *tz,
652 unsigned long state, u32 *power)
653{
654 unsigned int freq, num_cpus;
655 cpumask_t cpumask;
656 u32 static_power, dynamic_power;
657 int ret;
658 struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
659
660 cpumask_and(&cpumask, &cpufreq_device->allowed_cpus, cpu_online_mask);
661 num_cpus = cpumask_weight(&cpumask);
662
663 /* None of our cpus are online, so no power */
664 if (num_cpus == 0) {
665 *power = 0;
666 return 0;
667 }
668
669 freq = cpufreq_device->freq_table[state];
670 if (!freq)
671 return -EINVAL;
672
673 dynamic_power = cpu_freq_to_power(cpufreq_device, freq) * num_cpus;
674 ret = get_static_power(cpufreq_device, tz, freq, &static_power);
675 if (ret)
676 return ret;
677
678 *power = static_power + dynamic_power;
679 return 0;
680}
681
682/**
683 * cpufreq_power2state() - convert power to a cooling device state
684 * @cdev: &thermal_cooling_device pointer
685 * @tz: a valid thermal zone device pointer
686 * @power: power in milliwatts to be converted
687 * @state: pointer in which to store the resulting state
688 *
689 * Calculate a cooling device state for the cpus described by @cdev
690 * that would allow them to consume at most @power mW and store it in
691 * @state. Note that this calculation depends on external factors
692 * such as the cpu load or the current static power. Calling this
693 * function with the same power as input can yield different cooling
694 * device states depending on those external factors.
695 *
696 * Return: 0 on success, -ENODEV if no cpus are online or -EINVAL if
697 * the calculated frequency could not be converted to a valid state.
698 * The latter should not happen unless the frequencies available to
699 * cpufreq have changed since the initialization of the cpu cooling
700 * device.
701 */
702static int cpufreq_power2state(struct thermal_cooling_device *cdev,
703 struct thermal_zone_device *tz, u32 power,
704 unsigned long *state)
705{
706 unsigned int cpu, cur_freq, target_freq;
707 int ret;
708 s32 dyn_power;
709 u32 last_load, normalised_power, static_power;
710 struct cpufreq_cooling_device *cpufreq_device = cdev->devdata;
711
712 cpu = cpumask_any_and(&cpufreq_device->allowed_cpus, cpu_online_mask);
713
714 /* None of our cpus are online */
715 if (cpu >= nr_cpu_ids)
716 return -ENODEV;
717
718 cur_freq = cpufreq_quick_get(cpu);
719 ret = get_static_power(cpufreq_device, tz, cur_freq, &static_power);
720 if (ret)
721 return ret;
722
723 dyn_power = power - static_power;
724 dyn_power = dyn_power > 0 ? dyn_power : 0;
725 last_load = cpufreq_device->last_load ?: 1;
726 normalised_power = (dyn_power * 100) / last_load;
727 target_freq = cpu_power_to_freq(cpufreq_device, normalised_power);
728
729 *state = cpufreq_cooling_get_level(cpu, target_freq);
730 if (*state == THERMAL_CSTATE_INVALID) {
731 dev_warn_ratelimited(&cdev->device,
732 "Failed to convert %dKHz for cpu %d into a cdev state\n",
733 target_freq, cpu);
734 return -EINVAL;
735 }
736
Javi Merino6828a472015-03-02 17:17:20 +0000737 trace_thermal_power_cpu_limit(&cpufreq_device->allowed_cpus,
738 target_freq, *state, power);
Javi Merinoc36cf072015-02-26 19:00:29 +0000739 return 0;
740}
741
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530742/* Bind cpufreq callbacks to thermal cooling device ops */
Javi Merinoc36cf072015-02-26 19:00:29 +0000743static struct thermal_cooling_device_ops cpufreq_cooling_ops = {
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530744 .get_max_state = cpufreq_get_max_state,
745 .get_cur_state = cpufreq_get_cur_state,
746 .set_cur_state = cpufreq_set_cur_state,
747};
748
749/* Notifier for cpufreq policy change */
750static struct notifier_block thermal_cpufreq_notifier_block = {
751 .notifier_call = cpufreq_thermal_notifier,
752};
753
Viresh Kumarf6859012014-12-04 09:42:06 +0530754static unsigned int find_next_max(struct cpufreq_frequency_table *table,
755 unsigned int prev_max)
756{
757 struct cpufreq_frequency_table *pos;
758 unsigned int max = 0;
759
760 cpufreq_for_each_valid_entry(pos, table) {
761 if (pos->frequency > max && pos->frequency < prev_max)
762 max = pos->frequency;
763 }
764
765 return max;
766}
767
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530768/**
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400769 * __cpufreq_cooling_register - helper function to create cpufreq cooling device
770 * @np: a valid struct device_node to the cooling device device tree node
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530771 * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
Viresh Kumar405fb822014-12-04 09:41:55 +0530772 * Normally this should be same as cpufreq policy->related_cpus.
Javi Merinoc36cf072015-02-26 19:00:29 +0000773 * @capacitance: dynamic power coefficient for these cpus
774 * @plat_static_func: function to calculate the static power consumed by these
775 * cpus (optional)
Eduardo Valentin12cb08b2013-04-17 17:12:15 +0000776 *
777 * This interface function registers the cpufreq cooling device with the name
778 * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400779 * cooling devices. It also gives the opportunity to link the cooling device
780 * with a device tree node, in order to bind it via the thermal DT code.
Eduardo Valentin12cb08b2013-04-17 17:12:15 +0000781 *
782 * Return: a valid struct thermal_cooling_device pointer on success,
783 * on failure, it returns a corresponding ERR_PTR().
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530784 */
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400785static struct thermal_cooling_device *
786__cpufreq_cooling_register(struct device_node *np,
Javi Merinoc36cf072015-02-26 19:00:29 +0000787 const struct cpumask *clip_cpus, u32 capacitance,
788 get_static_t plat_static_func)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530789{
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530790 struct cpufreq_policy *policy;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530791 struct thermal_cooling_device *cool_dev;
Viresh Kumar5d3bdb82014-12-04 09:41:52 +0530792 struct cpufreq_cooling_device *cpufreq_dev;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530793 char dev_name[THERMAL_NAME_LENGTH];
Viresh Kumardcc6c7f2014-12-04 09:42:02 +0530794 struct cpufreq_frequency_table *pos, *table;
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530795 struct cpumask temp_mask;
Javi Merinoc36cf072015-02-26 19:00:29 +0000796 unsigned int freq, i, num_cpus;
Viresh Kumar405fb822014-12-04 09:41:55 +0530797 int ret;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530798
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530799 cpumask_and(&temp_mask, clip_cpus, cpu_online_mask);
800 policy = cpufreq_cpu_get(cpumask_first(&temp_mask));
801 if (!policy) {
802 pr_debug("%s: CPUFreq policy not found\n", __func__);
Eduardo Valentin0f1be512014-12-04 09:41:43 +0530803 return ERR_PTR(-EPROBE_DEFER);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530804 }
Eduardo Valentin0f1be512014-12-04 09:41:43 +0530805
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530806 table = policy->freq_table;
807 if (!table) {
808 pr_debug("%s: CPUFreq table not found\n", __func__);
809 cool_dev = ERR_PTR(-ENODEV);
810 goto put_policy;
811 }
812
Viresh Kumar98d522f2014-12-04 09:41:50 +0530813 cpufreq_dev = kzalloc(sizeof(*cpufreq_dev), GFP_KERNEL);
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530814 if (!cpufreq_dev) {
815 cool_dev = ERR_PTR(-ENOMEM);
816 goto put_policy;
817 }
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530818
Javi Merinoc36cf072015-02-26 19:00:29 +0000819 num_cpus = cpumask_weight(clip_cpus);
820 cpufreq_dev->time_in_idle = kcalloc(num_cpus,
821 sizeof(*cpufreq_dev->time_in_idle),
822 GFP_KERNEL);
823 if (!cpufreq_dev->time_in_idle) {
824 cool_dev = ERR_PTR(-ENOMEM);
825 goto free_cdev;
826 }
827
828 cpufreq_dev->time_in_idle_timestamp =
829 kcalloc(num_cpus, sizeof(*cpufreq_dev->time_in_idle_timestamp),
830 GFP_KERNEL);
831 if (!cpufreq_dev->time_in_idle_timestamp) {
832 cool_dev = ERR_PTR(-ENOMEM);
833 goto free_time_in_idle;
834 }
835
Viresh Kumardcc6c7f2014-12-04 09:42:02 +0530836 /* Find max levels */
837 cpufreq_for_each_valid_entry(pos, table)
838 cpufreq_dev->max_level++;
839
Viresh Kumarf6859012014-12-04 09:42:06 +0530840 cpufreq_dev->freq_table = kmalloc(sizeof(*cpufreq_dev->freq_table) *
841 cpufreq_dev->max_level, GFP_KERNEL);
842 if (!cpufreq_dev->freq_table) {
Viresh Kumarf6859012014-12-04 09:42:06 +0530843 cool_dev = ERR_PTR(-ENOMEM);
Javi Merinoc36cf072015-02-26 19:00:29 +0000844 goto free_time_in_idle_timestamp;
Viresh Kumarf6859012014-12-04 09:42:06 +0530845 }
846
Viresh Kumardcc6c7f2014-12-04 09:42:02 +0530847 /* max_level is an index, not a counter */
848 cpufreq_dev->max_level--;
849
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530850 cpumask_copy(&cpufreq_dev->allowed_cpus, clip_cpus);
851
Javi Merinoc36cf072015-02-26 19:00:29 +0000852 if (capacitance) {
853 cpufreq_cooling_ops.get_requested_power =
854 cpufreq_get_requested_power;
855 cpufreq_cooling_ops.state2power = cpufreq_state2power;
856 cpufreq_cooling_ops.power2state = cpufreq_power2state;
857 cpufreq_dev->plat_get_static_power = plat_static_func;
858
859 ret = build_dyn_power_table(cpufreq_dev, capacitance);
860 if (ret) {
861 cool_dev = ERR_PTR(ret);
862 goto free_table;
863 }
864 }
865
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530866 ret = get_idr(&cpufreq_idr, &cpufreq_dev->id);
867 if (ret) {
Viresh Kumar730abe02014-12-04 09:41:58 +0530868 cool_dev = ERR_PTR(ret);
Javi Merinoeba4f882015-08-17 19:21:43 +0100869 goto free_power_table;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530870 }
871
Viresh Kumarf6859012014-12-04 09:42:06 +0530872 /* Fill freq-table in descending order of frequencies */
873 for (i = 0, freq = -1; i <= cpufreq_dev->max_level; i++) {
874 freq = find_next_max(table, freq);
875 cpufreq_dev->freq_table[i] = freq;
876
877 /* Warn for duplicate entries */
878 if (!freq)
879 pr_warn("%s: table has duplicate entries\n", __func__);
880 else
881 pr_debug("%s: freq:%u KHz\n", __func__, freq);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530882 }
Viresh Kumarf6859012014-12-04 09:42:06 +0530883
Lukasz Lubaf840ab12016-05-31 11:32:02 +0100884 snprintf(dev_name, sizeof(dev_name), "thermal-cpufreq-%d",
885 cpufreq_dev->id);
886
887 cool_dev = thermal_of_cooling_device_register(np, dev_name, cpufreq_dev,
888 &cpufreq_cooling_ops);
889 if (IS_ERR(cool_dev))
890 goto remove_idr;
891
Viresh Kumar59f0d212015-07-30 12:40:33 +0530892 cpufreq_dev->clipped_freq = cpufreq_dev->freq_table[0];
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530893 cpufreq_dev->cool_dev = cool_dev;
Viresh Kumar92e615e2014-12-04 09:41:51 +0530894
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530895 mutex_lock(&cooling_cpufreq_lock);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530896
Russell King02373d72015-08-12 15:22:16 +0530897 mutex_lock(&cooling_list_lock);
898 list_add(&cpufreq_dev->node, &cpufreq_dev_list);
899 mutex_unlock(&cooling_list_lock);
900
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530901 /* Register the notifier for first cpufreq cooling device */
Russell King02373d72015-08-12 15:22:16 +0530902 if (!cpufreq_dev_count++)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530903 cpufreq_register_notifier(&thermal_cpufreq_notifier_block,
Eduardo Valentin5fda7f62013-04-17 17:12:11 +0000904 CPUFREQ_POLICY_NOTIFIER);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530905 mutex_unlock(&cooling_cpufreq_lock);
Eduardo Valentin79491e52013-04-17 17:11:59 +0000906
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530907 goto put_policy;
Viresh Kumar730abe02014-12-04 09:41:58 +0530908
909remove_idr:
910 release_idr(&cpufreq_idr, cpufreq_dev->id);
Javi Merinoeba4f882015-08-17 19:21:43 +0100911free_power_table:
912 kfree(cpufreq_dev->dyn_power_table);
Viresh Kumarf6859012014-12-04 09:42:06 +0530913free_table:
914 kfree(cpufreq_dev->freq_table);
Javi Merinoc36cf072015-02-26 19:00:29 +0000915free_time_in_idle_timestamp:
916 kfree(cpufreq_dev->time_in_idle_timestamp);
917free_time_in_idle:
918 kfree(cpufreq_dev->time_in_idle);
Viresh Kumar730abe02014-12-04 09:41:58 +0530919free_cdev:
920 kfree(cpufreq_dev);
Viresh Kumarf8bfc112016-06-03 10:58:47 +0530921put_policy:
922 cpufreq_cpu_put(policy);
Viresh Kumar730abe02014-12-04 09:41:58 +0530923
924 return cool_dev;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530925}
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400926
927/**
928 * cpufreq_cooling_register - function to create cpufreq cooling device.
929 * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
930 *
931 * This interface function registers the cpufreq cooling device with the name
932 * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
933 * cooling devices.
934 *
935 * Return: a valid struct thermal_cooling_device pointer on success,
936 * on failure, it returns a corresponding ERR_PTR().
937 */
938struct thermal_cooling_device *
939cpufreq_cooling_register(const struct cpumask *clip_cpus)
940{
Javi Merinoc36cf072015-02-26 19:00:29 +0000941 return __cpufreq_cooling_register(NULL, clip_cpus, 0, NULL);
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400942}
Eduardo Valentin243dbd92013-04-17 17:11:57 +0000943EXPORT_SYMBOL_GPL(cpufreq_cooling_register);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +0530944
945/**
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400946 * of_cpufreq_cooling_register - function to create cpufreq cooling device.
947 * @np: a valid struct device_node to the cooling device device tree node
948 * @clip_cpus: cpumask of cpus where the frequency constraints will happen.
949 *
950 * This interface function registers the cpufreq cooling device with the name
951 * "thermal-cpufreq-%x". This api can support multiple instances of cpufreq
952 * cooling devices. Using this API, the cpufreq cooling device will be
953 * linked to the device tree node provided.
954 *
955 * Return: a valid struct thermal_cooling_device pointer on success,
956 * on failure, it returns a corresponding ERR_PTR().
957 */
958struct thermal_cooling_device *
959of_cpufreq_cooling_register(struct device_node *np,
960 const struct cpumask *clip_cpus)
961{
962 if (!np)
963 return ERR_PTR(-EINVAL);
964
Javi Merinoc36cf072015-02-26 19:00:29 +0000965 return __cpufreq_cooling_register(np, clip_cpus, 0, NULL);
Eduardo Valentin39d99cf2013-09-12 19:26:45 -0400966}
967EXPORT_SYMBOL_GPL(of_cpufreq_cooling_register);
968
969/**
Javi Merinoc36cf072015-02-26 19:00:29 +0000970 * cpufreq_power_cooling_register() - create cpufreq cooling device with power extensions
971 * @clip_cpus: cpumask of cpus where the frequency constraints will happen
972 * @capacitance: dynamic power coefficient for these cpus
973 * @plat_static_func: function to calculate the static power consumed by these
974 * cpus (optional)
975 *
976 * This interface function registers the cpufreq cooling device with
977 * the name "thermal-cpufreq-%x". This api can support multiple
978 * instances of cpufreq cooling devices. Using this function, the
979 * cooling device will implement the power extensions by using a
980 * simple cpu power model. The cpus must have registered their OPPs
981 * using the OPP library.
982 *
983 * An optional @plat_static_func may be provided to calculate the
984 * static power consumed by these cpus. If the platform's static
985 * power consumption is unknown or negligible, make it NULL.
986 *
987 * Return: a valid struct thermal_cooling_device pointer on success,
988 * on failure, it returns a corresponding ERR_PTR().
989 */
990struct thermal_cooling_device *
991cpufreq_power_cooling_register(const struct cpumask *clip_cpus, u32 capacitance,
992 get_static_t plat_static_func)
993{
994 return __cpufreq_cooling_register(NULL, clip_cpus, capacitance,
995 plat_static_func);
996}
997EXPORT_SYMBOL(cpufreq_power_cooling_register);
998
999/**
1000 * of_cpufreq_power_cooling_register() - create cpufreq cooling device with power extensions
1001 * @np: a valid struct device_node to the cooling device device tree node
1002 * @clip_cpus: cpumask of cpus where the frequency constraints will happen
1003 * @capacitance: dynamic power coefficient for these cpus
1004 * @plat_static_func: function to calculate the static power consumed by these
1005 * cpus (optional)
1006 *
1007 * This interface function registers the cpufreq cooling device with
1008 * the name "thermal-cpufreq-%x". This api can support multiple
1009 * instances of cpufreq cooling devices. Using this API, the cpufreq
1010 * cooling device will be linked to the device tree node provided.
1011 * Using this function, the cooling device will implement the power
1012 * extensions by using a simple cpu power model. The cpus must have
1013 * registered their OPPs using the OPP library.
1014 *
1015 * An optional @plat_static_func may be provided to calculate the
1016 * static power consumed by these cpus. If the platform's static
1017 * power consumption is unknown or negligible, make it NULL.
1018 *
1019 * Return: a valid struct thermal_cooling_device pointer on success,
1020 * on failure, it returns a corresponding ERR_PTR().
1021 */
1022struct thermal_cooling_device *
1023of_cpufreq_power_cooling_register(struct device_node *np,
1024 const struct cpumask *clip_cpus,
1025 u32 capacitance,
1026 get_static_t plat_static_func)
1027{
1028 if (!np)
1029 return ERR_PTR(-EINVAL);
1030
1031 return __cpufreq_cooling_register(np, clip_cpus, capacitance,
1032 plat_static_func);
1033}
1034EXPORT_SYMBOL(of_cpufreq_power_cooling_register);
1035
1036/**
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301037 * cpufreq_cooling_unregister - function to remove cpufreq cooling device.
1038 * @cdev: thermal cooling device pointer.
Eduardo Valentin135266b2013-04-17 17:12:16 +00001039 *
1040 * This interface function unregisters the "thermal-cpufreq-%x" cooling device.
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301041 */
1042void cpufreq_cooling_unregister(struct thermal_cooling_device *cdev)
1043{
Eduardo Valentin50e66c72013-08-15 10:54:46 -04001044 struct cpufreq_cooling_device *cpufreq_dev;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301045
Eduardo Valentin50e66c72013-08-15 10:54:46 -04001046 if (!cdev)
1047 return;
1048
1049 cpufreq_dev = cdev->devdata;
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301050
1051 /* Unregister the notifier for the last cpufreq cooling device */
Russell King02373d72015-08-12 15:22:16 +05301052 mutex_lock(&cooling_cpufreq_lock);
1053 if (!--cpufreq_dev_count)
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301054 cpufreq_unregister_notifier(&thermal_cpufreq_notifier_block,
Eduardo Valentin5fda7f62013-04-17 17:12:11 +00001055 CPUFREQ_POLICY_NOTIFIER);
Russell King02373d72015-08-12 15:22:16 +05301056
1057 mutex_lock(&cooling_list_lock);
1058 list_del(&cpufreq_dev->node);
1059 mutex_unlock(&cooling_list_lock);
1060
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301061 mutex_unlock(&cooling_cpufreq_lock);
hongbo.zhang160b7d82012-10-30 17:48:59 +01001062
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301063 thermal_cooling_device_unregister(cpufreq_dev->cool_dev);
1064 release_idr(&cpufreq_idr, cpufreq_dev->id);
Javi Merinoeba4f882015-08-17 19:21:43 +01001065 kfree(cpufreq_dev->dyn_power_table);
Javi Merinoc36cf072015-02-26 19:00:29 +00001066 kfree(cpufreq_dev->time_in_idle_timestamp);
1067 kfree(cpufreq_dev->time_in_idle);
Viresh Kumarf6859012014-12-04 09:42:06 +05301068 kfree(cpufreq_dev->freq_table);
Amit Daniel Kachhap02361412012-08-16 17:11:40 +05301069 kfree(cpufreq_dev);
1070}
Eduardo Valentin243dbd92013-04-17 17:11:57 +00001071EXPORT_SYMBOL_GPL(cpufreq_cooling_unregister);