10de967f2SLukasz Luba // SPDX-License-Identifier: GPL-2.0
2a76caf55SØrjan Eide /*
3a76caf55SØrjan Eide * devfreq_cooling: Thermal cooling device implementation for devices using
4a76caf55SØrjan Eide * devfreq
5a76caf55SØrjan Eide *
6a76caf55SØrjan Eide * Copyright (C) 2014-2015 ARM Limited
7a76caf55SØrjan Eide *
8a76caf55SØrjan Eide * TODO:
9a76caf55SØrjan Eide * - If OPPs are added or removed after devfreq cooling has
10a76caf55SØrjan Eide * registered, the devfreq cooling won't react to it.
11a76caf55SØrjan Eide */
12a76caf55SØrjan Eide
13a76caf55SØrjan Eide #include <linux/devfreq.h>
14a76caf55SØrjan Eide #include <linux/devfreq_cooling.h>
1584e0d87cSLukasz Luba #include <linux/energy_model.h>
16a76caf55SØrjan Eide #include <linux/export.h>
17a76caf55SØrjan Eide #include <linux/slab.h>
18a76caf55SØrjan Eide #include <linux/pm_opp.h>
1904fa9c80SMatthias Kaehlcke #include <linux/pm_qos.h>
20a76caf55SØrjan Eide #include <linux/thermal.h>
2173b718c6SDaniel Lezcano #include <linux/units.h>
22a76caf55SØrjan Eide
2332a7a021SDaniel Lezcano #include "thermal_trace.h"
249876b1a4SJavi Merino
252be83da8SLukasz Luba #define SCALE_ERROR_MITIGATION 100
262be83da8SLukasz Luba
27a76caf55SØrjan Eide /**
28a76caf55SØrjan Eide * struct devfreq_cooling_device - Devfreq cooling device
29a76caf55SØrjan Eide * devfreq_cooling_device registered.
30a76caf55SØrjan Eide * @cdev: Pointer to associated thermal cooling device.
31829f4166SLukasz Luba * @cooling_ops: devfreq callbacks to thermal cooling device ops
32a76caf55SØrjan Eide * @devfreq: Pointer to associated devfreq device.
33a76caf55SØrjan Eide * @cooling_state: Current cooling state.
34a76caf55SØrjan Eide * @freq_table: Pointer to a table with the frequencies sorted in descending
35a76caf55SØrjan Eide * order. You can index the table by cooling device state
36615510feSLukasz Luba * @max_state: It is the last index, that is, one less than the number of the
37615510feSLukasz Luba * OPPs
38615510feSLukasz Luba * @power_ops: Pointer to devfreq_cooling_power, a more precised model.
392be83da8SLukasz Luba * @res_util: Resource utilization scaling factor for the power.
402be83da8SLukasz Luba * It is multiplied by 100 to minimize the error. It is used
412be83da8SLukasz Luba * for estimation of the power budget instead of using
42615510feSLukasz Luba * 'utilization' (which is 'busy_time' / 'total_time').
43615510feSLukasz Luba * The 'res_util' range is from 100 to power * 100 for the
44615510feSLukasz Luba * corresponding 'state'.
451b5cb957SAmit Kucheria * @capped_state: index to cooling state with in dynamic power budget
4604fa9c80SMatthias Kaehlcke * @req_max_freq: PM QoS request for limiting the maximum frequency
4704fa9c80SMatthias Kaehlcke * of the devfreq device.
484401117bSLukasz Luba * @em_pd: Energy Model for the associated Devfreq device
49a76caf55SØrjan Eide */
50a76caf55SØrjan Eide struct devfreq_cooling_device {
51a76caf55SØrjan Eide struct thermal_cooling_device *cdev;
52829f4166SLukasz Luba struct thermal_cooling_device_ops cooling_ops;
53a76caf55SØrjan Eide struct devfreq *devfreq;
54a76caf55SØrjan Eide unsigned long cooling_state;
55a76caf55SØrjan Eide u32 *freq_table;
56615510feSLukasz Luba size_t max_state;
57a76caf55SØrjan Eide struct devfreq_cooling_power *power_ops;
582be83da8SLukasz Luba u32 res_util;
592be83da8SLukasz Luba int capped_state;
6004fa9c80SMatthias Kaehlcke struct dev_pm_qos_request req_max_freq;
614401117bSLukasz Luba struct em_perf_domain *em_pd;
62a76caf55SØrjan Eide };
63a76caf55SØrjan Eide
devfreq_cooling_get_max_state(struct thermal_cooling_device * cdev,unsigned long * state)64a76caf55SØrjan Eide static int devfreq_cooling_get_max_state(struct thermal_cooling_device *cdev,
65a76caf55SØrjan Eide unsigned long *state)
66a76caf55SØrjan Eide {
67a76caf55SØrjan Eide struct devfreq_cooling_device *dfc = cdev->devdata;
68a76caf55SØrjan Eide
69615510feSLukasz Luba *state = dfc->max_state;
70a76caf55SØrjan Eide
71a76caf55SØrjan Eide return 0;
72a76caf55SØrjan Eide }
73a76caf55SØrjan Eide
devfreq_cooling_get_cur_state(struct thermal_cooling_device * cdev,unsigned long * state)74a76caf55SØrjan Eide static int devfreq_cooling_get_cur_state(struct thermal_cooling_device *cdev,
75a76caf55SØrjan Eide unsigned long *state)
76a76caf55SØrjan Eide {
77a76caf55SØrjan Eide struct devfreq_cooling_device *dfc = cdev->devdata;
78a76caf55SØrjan Eide
79a76caf55SØrjan Eide *state = dfc->cooling_state;
80a76caf55SØrjan Eide
81a76caf55SØrjan Eide return 0;
82a76caf55SØrjan Eide }
83a76caf55SØrjan Eide
devfreq_cooling_set_cur_state(struct thermal_cooling_device * cdev,unsigned long state)84a76caf55SØrjan Eide static int devfreq_cooling_set_cur_state(struct thermal_cooling_device *cdev,
85a76caf55SØrjan Eide unsigned long state)
86a76caf55SØrjan Eide {
87a76caf55SØrjan Eide struct devfreq_cooling_device *dfc = cdev->devdata;
88a76caf55SØrjan Eide struct devfreq *df = dfc->devfreq;
89a76caf55SØrjan Eide struct device *dev = df->dev.parent;
9004fa9c80SMatthias Kaehlcke unsigned long freq;
91615510feSLukasz Luba int perf_idx;
92a76caf55SØrjan Eide
93a76caf55SØrjan Eide if (state == dfc->cooling_state)
94a76caf55SØrjan Eide return 0;
95a76caf55SØrjan Eide
96a76caf55SØrjan Eide dev_dbg(dev, "Setting cooling state %lu\n", state);
97a76caf55SØrjan Eide
98615510feSLukasz Luba if (state > dfc->max_state)
99a76caf55SØrjan Eide return -EINVAL;
100a76caf55SØrjan Eide
1014401117bSLukasz Luba if (dfc->em_pd) {
102615510feSLukasz Luba perf_idx = dfc->max_state - state;
1034401117bSLukasz Luba freq = dfc->em_pd->table[perf_idx].frequency * 1000;
104615510feSLukasz Luba } else {
10504fa9c80SMatthias Kaehlcke freq = dfc->freq_table[state];
106615510feSLukasz Luba }
10704fa9c80SMatthias Kaehlcke
10804fa9c80SMatthias Kaehlcke dev_pm_qos_update_request(&dfc->req_max_freq,
10904fa9c80SMatthias Kaehlcke DIV_ROUND_UP(freq, HZ_PER_KHZ));
110a76caf55SØrjan Eide
111a76caf55SØrjan Eide dfc->cooling_state = state;
112a76caf55SØrjan Eide
113a76caf55SØrjan Eide return 0;
114a76caf55SØrjan Eide }
115a76caf55SØrjan Eide
116a76caf55SØrjan Eide /**
117615510feSLukasz Luba * get_perf_idx() - get the performance index corresponding to a frequency
118615510feSLukasz Luba * @em_pd: Pointer to device's Energy Model
119615510feSLukasz Luba * @freq: frequency in kHz
120a76caf55SØrjan Eide *
121615510feSLukasz Luba * Return: the performance index associated with the @freq, or
122615510feSLukasz Luba * -EINVAL if it wasn't found.
123a76caf55SØrjan Eide */
get_perf_idx(struct em_perf_domain * em_pd,unsigned long freq)124615510feSLukasz Luba static int get_perf_idx(struct em_perf_domain *em_pd, unsigned long freq)
125a76caf55SØrjan Eide {
126a76caf55SØrjan Eide int i;
127a76caf55SØrjan Eide
128615510feSLukasz Luba for (i = 0; i < em_pd->nr_perf_states; i++) {
129615510feSLukasz Luba if (em_pd->table[i].frequency == freq)
130a76caf55SØrjan Eide return i;
131a76caf55SØrjan Eide }
132a76caf55SØrjan Eide
133615510feSLukasz Luba return -EINVAL;
134a76caf55SØrjan Eide }
135a76caf55SØrjan Eide
get_voltage(struct devfreq * df,unsigned long freq)136e34cab4cSLukasz Luba static unsigned long get_voltage(struct devfreq *df, unsigned long freq)
137a76caf55SØrjan Eide {
138a76caf55SØrjan Eide struct device *dev = df->dev.parent;
139a76caf55SØrjan Eide unsigned long voltage;
140a76caf55SØrjan Eide struct dev_pm_opp *opp;
141a76caf55SØrjan Eide
142a76caf55SØrjan Eide opp = dev_pm_opp_find_freq_exact(dev, freq, true);
143a4e49c9bSViresh Kumar if (PTR_ERR(opp) == -ERANGE)
144a76caf55SØrjan Eide opp = dev_pm_opp_find_freq_exact(dev, freq, false);
145a76caf55SØrjan Eide
146afd1f4e0SViresh Kumar if (IS_ERR(opp)) {
147afd1f4e0SViresh Kumar dev_err_ratelimited(dev, "Failed to find OPP for frequency %lu: %ld\n",
148afd1f4e0SViresh Kumar freq, PTR_ERR(opp));
149afd1f4e0SViresh Kumar return 0;
150afd1f4e0SViresh Kumar }
151afd1f4e0SViresh Kumar
152a76caf55SØrjan Eide voltage = dev_pm_opp_get_voltage(opp) / 1000; /* mV */
1538a31d9d9SViresh Kumar dev_pm_opp_put(opp);
154a76caf55SØrjan Eide
155a76caf55SØrjan Eide if (voltage == 0) {
1568327b830SViresh Kumar dev_err_ratelimited(dev,
157afd1f4e0SViresh Kumar "Failed to get voltage for frequency %lu\n",
158afd1f4e0SViresh Kumar freq);
159a76caf55SØrjan Eide }
160a76caf55SØrjan Eide
161e34cab4cSLukasz Luba return voltage;
162e34cab4cSLukasz Luba }
163e34cab4cSLukasz Luba
_normalize_load(struct devfreq_dev_status * status)164229794eeSLukasz Luba static void _normalize_load(struct devfreq_dev_status *status)
165229794eeSLukasz Luba {
166229794eeSLukasz Luba if (status->total_time > 0xfffff) {
167229794eeSLukasz Luba status->total_time >>= 10;
168229794eeSLukasz Luba status->busy_time >>= 10;
169229794eeSLukasz Luba }
170229794eeSLukasz Luba
171229794eeSLukasz Luba status->busy_time <<= 10;
172229794eeSLukasz Luba status->busy_time /= status->total_time ? : 1;
173229794eeSLukasz Luba
174229794eeSLukasz Luba status->busy_time = status->busy_time ? : 1;
175229794eeSLukasz Luba status->total_time = 1024;
176229794eeSLukasz Luba }
1772be83da8SLukasz Luba
devfreq_cooling_get_requested_power(struct thermal_cooling_device * cdev,u32 * power)178a76caf55SØrjan Eide static int devfreq_cooling_get_requested_power(struct thermal_cooling_device *cdev,
179a76caf55SØrjan Eide u32 *power)
180a76caf55SØrjan Eide {
181a76caf55SØrjan Eide struct devfreq_cooling_device *dfc = cdev->devdata;
182a76caf55SØrjan Eide struct devfreq *df = dfc->devfreq;
183229794eeSLukasz Luba struct devfreq_dev_status status;
184a76caf55SØrjan Eide unsigned long state;
185229794eeSLukasz Luba unsigned long freq;
1862be83da8SLukasz Luba unsigned long voltage;
187615510feSLukasz Luba int res, perf_idx;
188a76caf55SØrjan Eide
189229794eeSLukasz Luba mutex_lock(&df->lock);
190229794eeSLukasz Luba status = df->last_status;
191229794eeSLukasz Luba mutex_unlock(&df->lock);
192229794eeSLukasz Luba
193229794eeSLukasz Luba freq = status.current_frequency;
194229794eeSLukasz Luba
195615510feSLukasz Luba if (dfc->power_ops && dfc->power_ops->get_real_power) {
1962be83da8SLukasz Luba voltage = get_voltage(df, freq);
1972be83da8SLukasz Luba if (voltage == 0) {
1982be83da8SLukasz Luba res = -EINVAL;
1992be83da8SLukasz Luba goto fail;
2002be83da8SLukasz Luba }
2012be83da8SLukasz Luba
2022be83da8SLukasz Luba res = dfc->power_ops->get_real_power(df, power, freq, voltage);
2032be83da8SLukasz Luba if (!res) {
204be4f3af1SYe Zhang state = dfc->max_state - dfc->capped_state;
205ae6ccaa6SLukasz Luba
206ae6ccaa6SLukasz Luba /* Convert EM power into milli-Watts first */
2074401117bSLukasz Luba dfc->res_util = dfc->em_pd->table[state].power;
208ae6ccaa6SLukasz Luba dfc->res_util /= MICROWATT_PER_MILLIWATT;
209ae6ccaa6SLukasz Luba
2102be83da8SLukasz Luba dfc->res_util *= SCALE_ERROR_MITIGATION;
2112be83da8SLukasz Luba
2122be83da8SLukasz Luba if (*power > 1)
2132be83da8SLukasz Luba dfc->res_util /= *power;
2142be83da8SLukasz Luba } else {
2152be83da8SLukasz Luba goto fail;
2162be83da8SLukasz Luba }
2172be83da8SLukasz Luba } else {
218615510feSLukasz Luba /* Energy Model frequencies are in kHz */
2194401117bSLukasz Luba perf_idx = get_perf_idx(dfc->em_pd, freq / 1000);
220615510feSLukasz Luba if (perf_idx < 0) {
221615510feSLukasz Luba res = -EAGAIN;
222615510feSLukasz Luba goto fail;
223615510feSLukasz Luba }
224a76caf55SØrjan Eide
225229794eeSLukasz Luba _normalize_load(&status);
226229794eeSLukasz Luba
227ae6ccaa6SLukasz Luba /* Convert EM power into milli-Watts first */
2284401117bSLukasz Luba *power = dfc->em_pd->table[perf_idx].power;
229ae6ccaa6SLukasz Luba *power /= MICROWATT_PER_MILLIWATT;
230ae6ccaa6SLukasz Luba /* Scale power for utilization */
231615510feSLukasz Luba *power *= status.busy_time;
232615510feSLukasz Luba *power >>= 10;
2332be83da8SLukasz Luba }
2342be83da8SLukasz Luba
235229794eeSLukasz Luba trace_thermal_power_devfreq_get_power(cdev, &status, freq, *power);
2369876b1a4SJavi Merino
237a76caf55SØrjan Eide return 0;
2382be83da8SLukasz Luba fail:
2392be83da8SLukasz Luba /* It is safe to set max in this case */
2402be83da8SLukasz Luba dfc->res_util = SCALE_ERROR_MITIGATION;
2412be83da8SLukasz Luba return res;
242a76caf55SØrjan Eide }
243a76caf55SØrjan Eide
devfreq_cooling_state2power(struct thermal_cooling_device * cdev,unsigned long state,u32 * power)244a76caf55SØrjan Eide static int devfreq_cooling_state2power(struct thermal_cooling_device *cdev,
245615510feSLukasz Luba unsigned long state, u32 *power)
246a76caf55SØrjan Eide {
247a76caf55SØrjan Eide struct devfreq_cooling_device *dfc = cdev->devdata;
248615510feSLukasz Luba int perf_idx;
249a76caf55SØrjan Eide
250615510feSLukasz Luba if (state > dfc->max_state)
251a76caf55SØrjan Eide return -EINVAL;
252a76caf55SØrjan Eide
253615510feSLukasz Luba perf_idx = dfc->max_state - state;
2544401117bSLukasz Luba *power = dfc->em_pd->table[perf_idx].power;
255ae6ccaa6SLukasz Luba *power /= MICROWATT_PER_MILLIWATT;
256a76caf55SØrjan Eide
257a76caf55SØrjan Eide return 0;
258a76caf55SØrjan Eide }
259a76caf55SØrjan Eide
devfreq_cooling_power2state(struct thermal_cooling_device * cdev,u32 power,unsigned long * state)260a76caf55SØrjan Eide static int devfreq_cooling_power2state(struct thermal_cooling_device *cdev,
261a76caf55SØrjan Eide u32 power, unsigned long *state)
262a76caf55SØrjan Eide {
263a76caf55SØrjan Eide struct devfreq_cooling_device *dfc = cdev->devdata;
264a76caf55SØrjan Eide struct devfreq *df = dfc->devfreq;
265229794eeSLukasz Luba struct devfreq_dev_status status;
266ae6ccaa6SLukasz Luba unsigned long freq, em_power_mw;
2672be83da8SLukasz Luba s32 est_power;
268a76caf55SØrjan Eide int i;
269a76caf55SØrjan Eide
270229794eeSLukasz Luba mutex_lock(&df->lock);
271229794eeSLukasz Luba status = df->last_status;
272229794eeSLukasz Luba mutex_unlock(&df->lock);
273229794eeSLukasz Luba
274229794eeSLukasz Luba freq = status.current_frequency;
275229794eeSLukasz Luba
276615510feSLukasz Luba if (dfc->power_ops && dfc->power_ops->get_real_power) {
2772be83da8SLukasz Luba /* Scale for resource utilization */
2782be83da8SLukasz Luba est_power = power * dfc->res_util;
2792be83da8SLukasz Luba est_power /= SCALE_ERROR_MITIGATION;
2802be83da8SLukasz Luba } else {
281a76caf55SØrjan Eide /* Scale dynamic power for utilization */
282229794eeSLukasz Luba _normalize_load(&status);
283615510feSLukasz Luba est_power = power << 10;
284615510feSLukasz Luba est_power /= status.busy_time;
2852be83da8SLukasz Luba }
286a76caf55SØrjan Eide
287a76caf55SØrjan Eide /*
288a76caf55SØrjan Eide * Find the first cooling state that is within the power
289615510feSLukasz Luba * budget. The EM power table is sorted ascending.
290a76caf55SØrjan Eide */
291ae6ccaa6SLukasz Luba for (i = dfc->max_state; i > 0; i--) {
292ae6ccaa6SLukasz Luba /* Convert EM power to milli-Watts to make safe comparison */
293ae6ccaa6SLukasz Luba em_power_mw = dfc->em_pd->table[i].power;
294ae6ccaa6SLukasz Luba em_power_mw /= MICROWATT_PER_MILLIWATT;
295ae6ccaa6SLukasz Luba if (est_power >= em_power_mw)
296a76caf55SØrjan Eide break;
297ae6ccaa6SLukasz Luba }
298a76caf55SØrjan Eide
299615510feSLukasz Luba *state = dfc->max_state - i;
300615510feSLukasz Luba dfc->capped_state = *state;
301615510feSLukasz Luba
3029876b1a4SJavi Merino trace_thermal_power_devfreq_limit(cdev, freq, *state, power);
303a76caf55SØrjan Eide return 0;
304a76caf55SØrjan Eide }
305a76caf55SØrjan Eide
306a76caf55SØrjan Eide /**
307615510feSLukasz Luba * devfreq_cooling_gen_tables() - Generate frequency table.
308a76caf55SØrjan Eide * @dfc: Pointer to devfreq cooling device.
309615510feSLukasz Luba * @num_opps: Number of OPPs
310a76caf55SØrjan Eide *
311615510feSLukasz Luba * Generate frequency table which holds the frequencies in descending
312615510feSLukasz Luba * order. That way its indexed by cooling device state. This is for
313615510feSLukasz Luba * compatibility with drivers which do not register Energy Model.
314a76caf55SØrjan Eide *
315a76caf55SØrjan Eide * Return: 0 on success, negative error code on failure.
316a76caf55SØrjan Eide */
devfreq_cooling_gen_tables(struct devfreq_cooling_device * dfc,int num_opps)317615510feSLukasz Luba static int devfreq_cooling_gen_tables(struct devfreq_cooling_device *dfc,
318615510feSLukasz Luba int num_opps)
319a76caf55SØrjan Eide {
320a76caf55SØrjan Eide struct devfreq *df = dfc->devfreq;
321a76caf55SØrjan Eide struct device *dev = df->dev.parent;
322a76caf55SØrjan Eide unsigned long freq;
323a76caf55SØrjan Eide int i;
324a76caf55SØrjan Eide
325615510feSLukasz Luba dfc->freq_table = kcalloc(num_opps, sizeof(*dfc->freq_table),
326a76caf55SØrjan Eide GFP_KERNEL);
327615510feSLukasz Luba if (!dfc->freq_table)
328ce5ee161SDan Carpenter return -ENOMEM;
329a76caf55SØrjan Eide
330a76caf55SØrjan Eide for (i = 0, freq = ULONG_MAX; i < num_opps; i++, freq--) {
331a76caf55SØrjan Eide struct dev_pm_opp *opp;
332a76caf55SØrjan Eide
333a76caf55SØrjan Eide opp = dev_pm_opp_find_freq_floor(dev, &freq);
334a76caf55SØrjan Eide if (IS_ERR(opp)) {
335615510feSLukasz Luba kfree(dfc->freq_table);
336615510feSLukasz Luba return PTR_ERR(opp);
337a76caf55SØrjan Eide }
338a76caf55SØrjan Eide
3398a31d9d9SViresh Kumar dev_pm_opp_put(opp);
340615510feSLukasz Luba dfc->freq_table[i] = freq;
341a76caf55SØrjan Eide }
342a76caf55SØrjan Eide
343a76caf55SØrjan Eide return 0;
344a76caf55SØrjan Eide }
345a76caf55SØrjan Eide
346a76caf55SØrjan Eide /**
347a76caf55SØrjan Eide * of_devfreq_cooling_register_power() - Register devfreq cooling device,
348a76caf55SØrjan Eide * with OF and power information.
349a76caf55SØrjan Eide * @np: Pointer to OF device_node.
350a76caf55SØrjan Eide * @df: Pointer to devfreq device.
351a76caf55SØrjan Eide * @dfc_power: Pointer to devfreq_cooling_power.
352a76caf55SØrjan Eide *
353a76caf55SØrjan Eide * Register a devfreq cooling device. The available OPPs must be
354a76caf55SØrjan Eide * registered on the device.
355a76caf55SØrjan Eide *
356a76caf55SØrjan Eide * If @dfc_power is provided, the cooling device is registered with the
357a76caf55SØrjan Eide * power extensions. For the power extensions to work correctly,
358a76caf55SØrjan Eide * devfreq should use the simple_ondemand governor, other governors
359a76caf55SØrjan Eide * are not currently supported.
360a76caf55SØrjan Eide */
3613c99c2ceSJavi Merino struct thermal_cooling_device *
of_devfreq_cooling_register_power(struct device_node * np,struct devfreq * df,struct devfreq_cooling_power * dfc_power)362a76caf55SØrjan Eide of_devfreq_cooling_register_power(struct device_node *np, struct devfreq *df,
363a76caf55SØrjan Eide struct devfreq_cooling_power *dfc_power)
364a76caf55SØrjan Eide {
365a76caf55SØrjan Eide struct thermal_cooling_device *cdev;
366615510feSLukasz Luba struct device *dev = df->dev.parent;
367a76caf55SØrjan Eide struct devfreq_cooling_device *dfc;
3689926bbecSLukasz Luba struct em_perf_domain *em;
369b947769bSKant Fan struct thermal_cooling_device_ops *ops;
370f8d354e8SDaniel Lezcano char *name;
371615510feSLukasz Luba int err, num_opps;
372a76caf55SØrjan Eide
373a76caf55SØrjan Eide
374b947769bSKant Fan dfc = kzalloc(sizeof(*dfc), GFP_KERNEL);
375829f4166SLukasz Luba if (!dfc)
376829f4166SLukasz Luba return ERR_PTR(-ENOMEM);
377b947769bSKant Fan
378a76caf55SØrjan Eide dfc->devfreq = df;
379a76caf55SØrjan Eide
380829f4166SLukasz Luba ops = &dfc->cooling_ops;
381829f4166SLukasz Luba ops->get_max_state = devfreq_cooling_get_max_state;
382829f4166SLukasz Luba ops->get_cur_state = devfreq_cooling_get_cur_state;
383829f4166SLukasz Luba ops->set_cur_state = devfreq_cooling_set_cur_state;
384829f4166SLukasz Luba
3859926bbecSLukasz Luba em = em_pd_get(dev);
3869926bbecSLukasz Luba if (em && !em_is_artificial(em)) {
3879926bbecSLukasz Luba dfc->em_pd = em;
388b947769bSKant Fan ops->get_requested_power =
389a76caf55SØrjan Eide devfreq_cooling_get_requested_power;
390b947769bSKant Fan ops->state2power = devfreq_cooling_state2power;
391b947769bSKant Fan ops->power2state = devfreq_cooling_power2state;
392a76caf55SØrjan Eide
393615510feSLukasz Luba dfc->power_ops = dfc_power;
394615510feSLukasz Luba
3954401117bSLukasz Luba num_opps = em_pd_nr_perf_states(dfc->em_pd);
396615510feSLukasz Luba } else {
397615510feSLukasz Luba /* Backward compatibility for drivers which do not use IPA */
3989926bbecSLukasz Luba dev_dbg(dev, "missing proper EM for cooling device\n");
399615510feSLukasz Luba
400615510feSLukasz Luba num_opps = dev_pm_opp_get_opp_count(dev);
401615510feSLukasz Luba
402615510feSLukasz Luba err = devfreq_cooling_gen_tables(dfc, num_opps);
403a76caf55SØrjan Eide if (err)
404a76caf55SØrjan Eide goto free_dfc;
405615510feSLukasz Luba }
406a76caf55SØrjan Eide
407615510feSLukasz Luba if (num_opps <= 0) {
408615510feSLukasz Luba err = -EINVAL;
409615510feSLukasz Luba goto free_dfc;
410615510feSLukasz Luba }
411615510feSLukasz Luba
412615510feSLukasz Luba /* max_state is an index, not a counter */
413615510feSLukasz Luba dfc->max_state = num_opps - 1;
414615510feSLukasz Luba
415615510feSLukasz Luba err = dev_pm_qos_add_request(dev, &dfc->req_max_freq,
41604fa9c80SMatthias Kaehlcke DEV_PM_QOS_MAX_FREQUENCY,
41704fa9c80SMatthias Kaehlcke PM_QOS_MAX_FREQUENCY_DEFAULT_VALUE);
4182f96c035SMatthew Wilcox if (err < 0)
419615510feSLukasz Luba goto free_table;
42004fa9c80SMatthias Kaehlcke
4219aa80ab2SDaniel Lezcano err = -ENOMEM;
422f8d354e8SDaniel Lezcano name = kasprintf(GFP_KERNEL, "devfreq-%s", dev_name(dev));
423f8d354e8SDaniel Lezcano if (!name)
42404fa9c80SMatthias Kaehlcke goto remove_qos_req;
425615510feSLukasz Luba
426b947769bSKant Fan cdev = thermal_of_cooling_device_register(np, name, dfc, ops);
427f8d354e8SDaniel Lezcano kfree(name);
428f8d354e8SDaniel Lezcano
429a76caf55SØrjan Eide if (IS_ERR(cdev)) {
430a76caf55SØrjan Eide err = PTR_ERR(cdev);
431615510feSLukasz Luba dev_err(dev,
432a76caf55SØrjan Eide "Failed to register devfreq cooling device (%d)\n",
433a76caf55SØrjan Eide err);
434f8d354e8SDaniel Lezcano goto remove_qos_req;
435a76caf55SØrjan Eide }
436a76caf55SØrjan Eide
437a76caf55SØrjan Eide dfc->cdev = cdev;
438a76caf55SØrjan Eide
4393c99c2ceSJavi Merino return cdev;
440a76caf55SØrjan Eide
44104fa9c80SMatthias Kaehlcke remove_qos_req:
44204fa9c80SMatthias Kaehlcke dev_pm_qos_remove_request(&dfc->req_max_freq);
443615510feSLukasz Luba free_table:
444a76caf55SØrjan Eide kfree(dfc->freq_table);
445a76caf55SØrjan Eide free_dfc:
446a76caf55SØrjan Eide kfree(dfc);
447a76caf55SØrjan Eide
448a76caf55SØrjan Eide return ERR_PTR(err);
449a76caf55SØrjan Eide }
450a76caf55SØrjan Eide EXPORT_SYMBOL_GPL(of_devfreq_cooling_register_power);
451a76caf55SØrjan Eide
452a76caf55SØrjan Eide /**
453a76caf55SØrjan Eide * of_devfreq_cooling_register() - Register devfreq cooling device,
454a76caf55SØrjan Eide * with OF information.
455a76caf55SØrjan Eide * @np: Pointer to OF device_node.
456a76caf55SØrjan Eide * @df: Pointer to devfreq device.
457a76caf55SØrjan Eide */
4583c99c2ceSJavi Merino struct thermal_cooling_device *
of_devfreq_cooling_register(struct device_node * np,struct devfreq * df)459a76caf55SØrjan Eide of_devfreq_cooling_register(struct device_node *np, struct devfreq *df)
460a76caf55SØrjan Eide {
461a76caf55SØrjan Eide return of_devfreq_cooling_register_power(np, df, NULL);
462a76caf55SØrjan Eide }
463a76caf55SØrjan Eide EXPORT_SYMBOL_GPL(of_devfreq_cooling_register);
464a76caf55SØrjan Eide
465a76caf55SØrjan Eide /**
466a76caf55SØrjan Eide * devfreq_cooling_register() - Register devfreq cooling device.
467a76caf55SØrjan Eide * @df: Pointer to devfreq device.
468a76caf55SØrjan Eide */
devfreq_cooling_register(struct devfreq * df)4693c99c2ceSJavi Merino struct thermal_cooling_device *devfreq_cooling_register(struct devfreq *df)
470a76caf55SØrjan Eide {
471a76caf55SØrjan Eide return of_devfreq_cooling_register(NULL, df);
472a76caf55SØrjan Eide }
473a76caf55SØrjan Eide EXPORT_SYMBOL_GPL(devfreq_cooling_register);
474a76caf55SØrjan Eide
475a76caf55SØrjan Eide /**
4768b2ea897SYang Li * devfreq_cooling_em_register() - Register devfreq cooling device with
47784e0d87cSLukasz Luba * power information and automatically register Energy Model (EM)
47884e0d87cSLukasz Luba * @df: Pointer to devfreq device.
47984e0d87cSLukasz Luba * @dfc_power: Pointer to devfreq_cooling_power.
48084e0d87cSLukasz Luba *
48184e0d87cSLukasz Luba * Register a devfreq cooling device and automatically register EM. The
48284e0d87cSLukasz Luba * available OPPs must be registered for the device.
48384e0d87cSLukasz Luba *
48484e0d87cSLukasz Luba * If @dfc_power is provided, the cooling device is registered with the
48584e0d87cSLukasz Luba * power extensions. It is using the simple Energy Model which requires
48684e0d87cSLukasz Luba * "dynamic-power-coefficient" a devicetree property. To not break drivers
48784e0d87cSLukasz Luba * which miss that DT property, the function won't bail out when the EM
48884e0d87cSLukasz Luba * registration failed. The cooling device will be registered if everything
48984e0d87cSLukasz Luba * else is OK.
49084e0d87cSLukasz Luba */
49184e0d87cSLukasz Luba struct thermal_cooling_device *
devfreq_cooling_em_register(struct devfreq * df,struct devfreq_cooling_power * dfc_power)49284e0d87cSLukasz Luba devfreq_cooling_em_register(struct devfreq *df,
49384e0d87cSLukasz Luba struct devfreq_cooling_power *dfc_power)
49484e0d87cSLukasz Luba {
49584e0d87cSLukasz Luba struct thermal_cooling_device *cdev;
49684e0d87cSLukasz Luba struct device *dev;
49784e0d87cSLukasz Luba int ret;
49884e0d87cSLukasz Luba
49984e0d87cSLukasz Luba if (IS_ERR_OR_NULL(df))
50084e0d87cSLukasz Luba return ERR_PTR(-EINVAL);
50184e0d87cSLukasz Luba
50284e0d87cSLukasz Luba dev = df->dev.parent;
50384e0d87cSLukasz Luba
50484e0d87cSLukasz Luba ret = dev_pm_opp_of_register_em(dev, NULL);
50584e0d87cSLukasz Luba if (ret)
50684e0d87cSLukasz Luba dev_dbg(dev, "Unable to register EM for devfreq cooling device (%d)\n",
50784e0d87cSLukasz Luba ret);
50884e0d87cSLukasz Luba
50984e0d87cSLukasz Luba cdev = of_devfreq_cooling_register_power(dev->of_node, df, dfc_power);
51084e0d87cSLukasz Luba
51184e0d87cSLukasz Luba if (IS_ERR_OR_NULL(cdev))
51284e0d87cSLukasz Luba em_dev_unregister_perf_domain(dev);
51384e0d87cSLukasz Luba
51484e0d87cSLukasz Luba return cdev;
51584e0d87cSLukasz Luba }
51684e0d87cSLukasz Luba EXPORT_SYMBOL_GPL(devfreq_cooling_em_register);
51784e0d87cSLukasz Luba
51884e0d87cSLukasz Luba /**
519a76caf55SØrjan Eide * devfreq_cooling_unregister() - Unregister devfreq cooling device.
5201b5cb957SAmit Kucheria * @cdev: Pointer to devfreq cooling device to unregister.
52184e0d87cSLukasz Luba *
52284e0d87cSLukasz Luba * Unregisters devfreq cooling device and related Energy Model if it was
52384e0d87cSLukasz Luba * present.
524a76caf55SØrjan Eide */
devfreq_cooling_unregister(struct thermal_cooling_device * cdev)5253c99c2ceSJavi Merino void devfreq_cooling_unregister(struct thermal_cooling_device *cdev)
526a76caf55SØrjan Eide {
5273c99c2ceSJavi Merino struct devfreq_cooling_device *dfc;
52884e0d87cSLukasz Luba struct device *dev;
5293c99c2ceSJavi Merino
53084e0d87cSLukasz Luba if (IS_ERR_OR_NULL(cdev))
531a76caf55SØrjan Eide return;
532a76caf55SØrjan Eide
5333c99c2ceSJavi Merino dfc = cdev->devdata;
53484e0d87cSLukasz Luba dev = dfc->devfreq->dev.parent;
5353c99c2ceSJavi Merino
536a76caf55SØrjan Eide thermal_cooling_device_unregister(dfc->cdev);
53704fa9c80SMatthias Kaehlcke dev_pm_qos_remove_request(&dfc->req_max_freq);
53884e0d87cSLukasz Luba
53984e0d87cSLukasz Luba em_dev_unregister_perf_domain(dev);
54084e0d87cSLukasz Luba
541a76caf55SØrjan Eide kfree(dfc->freq_table);
542a76caf55SØrjan Eide kfree(dfc);
543a76caf55SØrjan Eide }
544a76caf55SØrjan Eide EXPORT_SYMBOL_GPL(devfreq_cooling_unregister);
545