]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/base/power/opp/core.c
Merge branches 'for-4.11/upstream-fixes', 'for-4.12/accutouch', 'for-4.12/cp2112...
[mirror_ubuntu-artful-kernel.git] / drivers / base / power / opp / core.c
CommitLineData
e1f60b29
NM
1/*
2 * Generic OPP Interface
3 *
4 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
5 * Nishanth Menon
6 * Romit Dasgupta
7 * Kevin Hilman
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
12 */
13
d6d2a528
VK
14#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15
d54974c2 16#include <linux/clk.h>
e1f60b29
NM
17#include <linux/errno.h>
18#include <linux/err.h>
e1f60b29 19#include <linux/slab.h>
51990e82 20#include <linux/device.h>
80126ce7 21#include <linux/export.h>
9f8ea969 22#include <linux/regulator/consumer.h>
e1f60b29 23
f59d3ee8 24#include "opp.h"
e1f60b29
NM
25
26/*
2c2709dc
VK
27 * The root of the list of all opp-tables. All opp_table structures branch off
28 * from here, with each opp_table containing the list of opps it supports in
e1f60b29
NM
29 * various states of availability.
30 */
f47b72a1 31LIST_HEAD(opp_tables);
e1f60b29 32/* Lock to allow exclusive modification to the device and opp lists */
2c2709dc 33DEFINE_MUTEX(opp_table_lock);
e1f60b29 34
8a31d9d9
VK
35static void dev_pm_opp_get(struct dev_pm_opp *opp);
36
2c2709dc
VK
37static struct opp_device *_find_opp_dev(const struct device *dev,
38 struct opp_table *opp_table)
06441658 39{
2c2709dc 40 struct opp_device *opp_dev;
06441658 41
2c2709dc
VK
42 list_for_each_entry(opp_dev, &opp_table->dev_list, node)
43 if (opp_dev->dev == dev)
44 return opp_dev;
06441658
VK
45
46 return NULL;
47}
48
6ac42397 49static struct opp_table *_find_opp_table_unlocked(struct device *dev)
5b650b38
VK
50{
51 struct opp_table *opp_table;
52
53 list_for_each_entry(opp_table, &opp_tables, node) {
54 if (_find_opp_dev(dev, opp_table)) {
55 _get_opp_table_kref(opp_table);
56
57 return opp_table;
58 }
59 }
60
61 return ERR_PTR(-ENODEV);
62}
63
e1f60b29 64/**
2c2709dc
VK
65 * _find_opp_table() - find opp_table struct using device pointer
66 * @dev: device pointer used to lookup OPP table
e1f60b29 67 *
052c6f19 68 * Search OPP table for one containing matching device.
e1f60b29 69 *
2c2709dc 70 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
e1f60b29
NM
71 * -EINVAL based on type of error.
72 *
5b650b38 73 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
e1f60b29 74 */
2c2709dc 75struct opp_table *_find_opp_table(struct device *dev)
e1f60b29 76{
2c2709dc 77 struct opp_table *opp_table;
e1f60b29 78
50a3cb04 79 if (IS_ERR_OR_NULL(dev)) {
e1f60b29
NM
80 pr_err("%s: Invalid parameters\n", __func__);
81 return ERR_PTR(-EINVAL);
82 }
83
5b650b38
VK
84 mutex_lock(&opp_table_lock);
85 opp_table = _find_opp_table_unlocked(dev);
86 mutex_unlock(&opp_table_lock);
e1f60b29 87
5b650b38 88 return opp_table;
e1f60b29
NM
89}
90
91/**
d6d00742 92 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
e1f60b29
NM
93 * @opp: opp for which voltage has to be returned for
94 *
984f16c8 95 * Return: voltage in micro volt corresponding to the opp, else
e1f60b29
NM
96 * return 0
97 *
dfbe4678 98 * This is useful only for devices with single power supply.
e1f60b29 99 */
47d43ba7 100unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
e1f60b29 101{
052c6f19 102 if (IS_ERR_OR_NULL(opp)) {
e1f60b29 103 pr_err("%s: Invalid parameters\n", __func__);
052c6f19
VK
104 return 0;
105 }
e1f60b29 106
052c6f19 107 return opp->supplies[0].u_volt;
e1f60b29 108}
5d4879cd 109EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
e1f60b29
NM
110
111/**
5d4879cd 112 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
e1f60b29
NM
113 * @opp: opp for which frequency has to be returned for
114 *
984f16c8 115 * Return: frequency in hertz corresponding to the opp, else
e1f60b29 116 * return 0
e1f60b29 117 */
47d43ba7 118unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
e1f60b29 119{
052c6f19 120 if (IS_ERR_OR_NULL(opp) || !opp->available) {
e1f60b29 121 pr_err("%s: Invalid parameters\n", __func__);
052c6f19
VK
122 return 0;
123 }
e1f60b29 124
052c6f19 125 return opp->rate;
e1f60b29 126}
5d4879cd 127EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
e1f60b29 128
19445b25
BZ
129/**
130 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
131 * @opp: opp for which turbo mode is being verified
132 *
133 * Turbo OPPs are not for normal use, and can be enabled (under certain
134 * conditions) for short duration of times to finish high throughput work
135 * quickly. Running on them for longer times may overheat the chip.
136 *
137 * Return: true if opp is turbo opp, else false.
19445b25
BZ
138 */
139bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
140{
052c6f19 141 if (IS_ERR_OR_NULL(opp) || !opp->available) {
19445b25
BZ
142 pr_err("%s: Invalid parameters\n", __func__);
143 return false;
144 }
145
052c6f19 146 return opp->turbo;
19445b25
BZ
147}
148EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
149
3ca9bb33
VK
150/**
151 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
152 * @dev: device for which we do this operation
153 *
154 * Return: This function returns the max clock latency in nanoseconds.
3ca9bb33
VK
155 */
156unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
157{
2c2709dc 158 struct opp_table *opp_table;
3ca9bb33
VK
159 unsigned long clock_latency_ns;
160
2c2709dc
VK
161 opp_table = _find_opp_table(dev);
162 if (IS_ERR(opp_table))
5b650b38
VK
163 return 0;
164
165 clock_latency_ns = opp_table->clock_latency_ns_max;
166
167 dev_pm_opp_put_opp_table(opp_table);
3ca9bb33 168
3ca9bb33
VK
169 return clock_latency_ns;
170}
171EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
172
655c9df9
VK
173/**
174 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
175 * @dev: device for which we do this operation
176 *
177 * Return: This function returns the max voltage latency in nanoseconds.
655c9df9
VK
178 */
179unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
180{
2c2709dc 181 struct opp_table *opp_table;
655c9df9 182 struct dev_pm_opp *opp;
dfbe4678 183 struct regulator *reg, **regulators;
655c9df9 184 unsigned long latency_ns = 0;
dfbe4678
VK
185 int ret, i, count;
186 struct {
187 unsigned long min;
188 unsigned long max;
189 } *uV;
190
cdd3e614
VK
191 opp_table = _find_opp_table(dev);
192 if (IS_ERR(opp_table))
193 return 0;
194
195 count = opp_table->regulator_count;
dfbe4678
VK
196
197 /* Regulator may not be required for the device */
198 if (!count)
cdd3e614 199 goto put_opp_table;
dfbe4678
VK
200
201 regulators = kmalloc_array(count, sizeof(*regulators), GFP_KERNEL);
202 if (!regulators)
cdd3e614 203 goto put_opp_table;
dfbe4678
VK
204
205 uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
206 if (!uV)
207 goto free_regulators;
655c9df9 208
dfbe4678 209 memcpy(regulators, opp_table->regulators, count * sizeof(*regulators));
655c9df9 210
052c6f19
VK
211 mutex_lock(&opp_table->lock);
212
dfbe4678
VK
213 for (i = 0; i < count; i++) {
214 uV[i].min = ~0;
215 uV[i].max = 0;
655c9df9 216
052c6f19 217 list_for_each_entry(opp, &opp_table->opp_list, node) {
dfbe4678
VK
218 if (!opp->available)
219 continue;
220
221 if (opp->supplies[i].u_volt_min < uV[i].min)
222 uV[i].min = opp->supplies[i].u_volt_min;
223 if (opp->supplies[i].u_volt_max > uV[i].max)
224 uV[i].max = opp->supplies[i].u_volt_max;
225 }
655c9df9
VK
226 }
227
052c6f19 228 mutex_unlock(&opp_table->lock);
655c9df9
VK
229
230 /*
2c2709dc 231 * The caller needs to ensure that opp_table (and hence the regulator)
655c9df9
VK
232 * isn't freed, while we are executing this routine.
233 */
dfbe4678
VK
234 for (i = 0; reg = regulators[i], i < count; i++) {
235 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
236 if (ret > 0)
237 latency_ns += ret * 1000;
238 }
239
dfbe4678
VK
240 kfree(uV);
241free_regulators:
242 kfree(regulators);
cdd3e614
VK
243put_opp_table:
244 dev_pm_opp_put_opp_table(opp_table);
655c9df9
VK
245
246 return latency_ns;
247}
248EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
249
21743447
VK
250/**
251 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
252 * nanoseconds
253 * @dev: device for which we do this operation
254 *
255 * Return: This function returns the max transition latency, in nanoseconds, to
256 * switch from one OPP to other.
21743447
VK
257 */
258unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
259{
260 return dev_pm_opp_get_max_volt_latency(dev) +
261 dev_pm_opp_get_max_clock_latency(dev);
262}
263EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
264
4eafbd15 265/**
3aa26a3b 266 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
4eafbd15
BZ
267 * @dev: device for which we do this operation
268 *
3aa26a3b
VK
269 * Return: This function returns the frequency of the OPP marked as suspend_opp
270 * if one is available, else returns 0;
4eafbd15 271 */
3aa26a3b 272unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
4eafbd15 273{
2c2709dc 274 struct opp_table *opp_table;
3aa26a3b 275 unsigned long freq = 0;
4eafbd15 276
2c2709dc 277 opp_table = _find_opp_table(dev);
5b650b38
VK
278 if (IS_ERR(opp_table))
279 return 0;
3aa26a3b 280
5b650b38
VK
281 if (opp_table->suspend_opp && opp_table->suspend_opp->available)
282 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
283
284 dev_pm_opp_put_opp_table(opp_table);
4eafbd15 285
3aa26a3b 286 return freq;
4eafbd15 287}
3aa26a3b 288EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
4eafbd15 289
e1f60b29 290/**
2c2709dc 291 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
e1f60b29
NM
292 * @dev: device for which we do this operation
293 *
984f16c8 294 * Return: This function returns the number of available opps if there are any,
e1f60b29 295 * else returns 0 if none or the corresponding error value.
e1f60b29 296 */
5d4879cd 297int dev_pm_opp_get_opp_count(struct device *dev)
e1f60b29 298{
2c2709dc 299 struct opp_table *opp_table;
47d43ba7 300 struct dev_pm_opp *temp_opp;
e1f60b29
NM
301 int count = 0;
302
2c2709dc
VK
303 opp_table = _find_opp_table(dev);
304 if (IS_ERR(opp_table)) {
305 count = PTR_ERR(opp_table);
306 dev_err(dev, "%s: OPP table not found (%d)\n",
b4718c02 307 __func__, count);
5b650b38 308 return count;
e1f60b29
NM
309 }
310
052c6f19 311 mutex_lock(&opp_table->lock);
5b650b38 312
052c6f19 313 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
e1f60b29
NM
314 if (temp_opp->available)
315 count++;
316 }
317
052c6f19 318 mutex_unlock(&opp_table->lock);
5b650b38
VK
319 dev_pm_opp_put_opp_table(opp_table);
320
e1f60b29
NM
321 return count;
322}
5d4879cd 323EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
e1f60b29
NM
324
325/**
5d4879cd 326 * dev_pm_opp_find_freq_exact() - search for an exact frequency
e1f60b29
NM
327 * @dev: device for which we do this operation
328 * @freq: frequency to search for
7ae49618 329 * @available: true/false - match for available opp
e1f60b29 330 *
2c2709dc 331 * Return: Searches for exact match in the opp table and returns pointer to the
984f16c8
NM
332 * matching opp if found, else returns ERR_PTR in case of error and should
333 * be handled using IS_ERR. Error return values can be:
0779726c
NM
334 * EINVAL: for bad pointer
335 * ERANGE: no match found for search
336 * ENODEV: if device not found in list of registered devices
e1f60b29
NM
337 *
338 * Note: available is a modifier for the search. if available=true, then the
339 * match is for exact matching frequency and is available in the stored OPP
340 * table. if false, the match is for exact frequency which is not available.
341 *
342 * This provides a mechanism to enable an opp which is not available currently
343 * or the opposite as well.
344 *
8a31d9d9
VK
345 * The callers are required to call dev_pm_opp_put() for the returned OPP after
346 * use.
e1f60b29 347 */
47d43ba7
NM
348struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
349 unsigned long freq,
350 bool available)
e1f60b29 351{
2c2709dc 352 struct opp_table *opp_table;
47d43ba7 353 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
e1f60b29 354
2c2709dc
VK
355 opp_table = _find_opp_table(dev);
356 if (IS_ERR(opp_table)) {
357 int r = PTR_ERR(opp_table);
358
359 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
e1f60b29
NM
360 return ERR_PTR(r);
361 }
362
052c6f19 363 mutex_lock(&opp_table->lock);
5b650b38 364
052c6f19 365 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
e1f60b29
NM
366 if (temp_opp->available == available &&
367 temp_opp->rate == freq) {
368 opp = temp_opp;
8a31d9d9
VK
369
370 /* Increment the reference count of OPP */
371 dev_pm_opp_get(opp);
e1f60b29
NM
372 break;
373 }
374 }
375
052c6f19 376 mutex_unlock(&opp_table->lock);
5b650b38 377 dev_pm_opp_put_opp_table(opp_table);
8a31d9d9 378
e1f60b29
NM
379 return opp;
380}
5d4879cd 381EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
e1f60b29 382
067b7ce0
JZ
383static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
384 unsigned long *freq)
385{
386 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
387
052c6f19
VK
388 mutex_lock(&opp_table->lock);
389
390 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
067b7ce0
JZ
391 if (temp_opp->available && temp_opp->rate >= *freq) {
392 opp = temp_opp;
393 *freq = opp->rate;
8a31d9d9
VK
394
395 /* Increment the reference count of OPP */
396 dev_pm_opp_get(opp);
067b7ce0
JZ
397 break;
398 }
399 }
400
052c6f19
VK
401 mutex_unlock(&opp_table->lock);
402
067b7ce0
JZ
403 return opp;
404}
405
e1f60b29 406/**
5d4879cd 407 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
e1f60b29
NM
408 * @dev: device for which we do this operation
409 * @freq: Start frequency
410 *
411 * Search for the matching ceil *available* OPP from a starting freq
412 * for a device.
413 *
984f16c8 414 * Return: matching *opp and refreshes *freq accordingly, else returns
0779726c
NM
415 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
416 * values can be:
417 * EINVAL: for bad pointer
418 * ERANGE: no match found for search
419 * ENODEV: if device not found in list of registered devices
e1f60b29 420 *
8a31d9d9
VK
421 * The callers are required to call dev_pm_opp_put() for the returned OPP after
422 * use.
e1f60b29 423 */
47d43ba7
NM
424struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
425 unsigned long *freq)
e1f60b29 426{
2c2709dc 427 struct opp_table *opp_table;
8a31d9d9 428 struct dev_pm_opp *opp;
b02ded24 429
e1f60b29
NM
430 if (!dev || !freq) {
431 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
432 return ERR_PTR(-EINVAL);
433 }
434
2c2709dc 435 opp_table = _find_opp_table(dev);
5b650b38 436 if (IS_ERR(opp_table))
2c2709dc 437 return ERR_CAST(opp_table);
5b650b38 438
8a31d9d9 439 opp = _find_freq_ceil(opp_table, freq);
e1f60b29 440
5b650b38 441 dev_pm_opp_put_opp_table(opp_table);
8a31d9d9
VK
442
443 return opp;
e1f60b29 444}
5d4879cd 445EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
e1f60b29
NM
446
447/**
5d4879cd 448 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
e1f60b29
NM
449 * @dev: device for which we do this operation
450 * @freq: Start frequency
451 *
452 * Search for the matching floor *available* OPP from a starting freq
453 * for a device.
454 *
984f16c8 455 * Return: matching *opp and refreshes *freq accordingly, else returns
0779726c
NM
456 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
457 * values can be:
458 * EINVAL: for bad pointer
459 * ERANGE: no match found for search
460 * ENODEV: if device not found in list of registered devices
e1f60b29 461 *
8a31d9d9
VK
462 * The callers are required to call dev_pm_opp_put() for the returned OPP after
463 * use.
e1f60b29 464 */
47d43ba7
NM
465struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
466 unsigned long *freq)
e1f60b29 467{
2c2709dc 468 struct opp_table *opp_table;
47d43ba7 469 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
e1f60b29
NM
470
471 if (!dev || !freq) {
472 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
473 return ERR_PTR(-EINVAL);
474 }
475
2c2709dc 476 opp_table = _find_opp_table(dev);
5b650b38 477 if (IS_ERR(opp_table))
2c2709dc 478 return ERR_CAST(opp_table);
5b650b38 479
052c6f19 480 mutex_lock(&opp_table->lock);
e1f60b29 481
052c6f19 482 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
e1f60b29
NM
483 if (temp_opp->available) {
484 /* go to the next node, before choosing prev */
485 if (temp_opp->rate > *freq)
486 break;
487 else
488 opp = temp_opp;
489 }
490 }
8a31d9d9
VK
491
492 /* Increment the reference count of OPP */
493 if (!IS_ERR(opp))
494 dev_pm_opp_get(opp);
052c6f19 495 mutex_unlock(&opp_table->lock);
5b650b38 496 dev_pm_opp_put_opp_table(opp_table);
8a31d9d9 497
e1f60b29
NM
498 if (!IS_ERR(opp))
499 *freq = opp->rate;
500
501 return opp;
502}
5d4879cd 503EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
e1f60b29 504
6a0712f6 505static int _set_opp_voltage(struct device *dev, struct regulator *reg,
ce31781a 506 struct dev_pm_opp_supply *supply)
6a0712f6
VK
507{
508 int ret;
509
510 /* Regulator not available for device */
511 if (IS_ERR(reg)) {
512 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
513 PTR_ERR(reg));
514 return 0;
515 }
516
ce31781a
VK
517 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
518 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
6a0712f6 519
ce31781a
VK
520 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
521 supply->u_volt, supply->u_volt_max);
6a0712f6
VK
522 if (ret)
523 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
ce31781a
VK
524 __func__, supply->u_volt_min, supply->u_volt,
525 supply->u_volt_max, ret);
6a0712f6
VK
526
527 return ret;
528}
529
94735585
VK
530static inline int
531_generic_set_opp_clk_only(struct device *dev, struct clk *clk,
532 unsigned long old_freq, unsigned long freq)
533{
534 int ret;
535
536 ret = clk_set_rate(clk, freq);
537 if (ret) {
538 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
539 ret);
540 }
541
542 return ret;
543}
544
545static int _generic_set_opp(struct dev_pm_set_opp_data *data)
546{
547 struct dev_pm_opp_supply *old_supply = data->old_opp.supplies;
548 struct dev_pm_opp_supply *new_supply = data->new_opp.supplies;
549 unsigned long old_freq = data->old_opp.rate, freq = data->new_opp.rate;
550 struct regulator *reg = data->regulators[0];
551 struct device *dev= data->dev;
552 int ret;
553
554 /* This function only supports single regulator per device */
555 if (WARN_ON(data->regulator_count > 1)) {
556 dev_err(dev, "multiple regulators are not supported\n");
557 return -EINVAL;
558 }
559
560 /* Scaling up? Scale voltage before frequency */
561 if (freq > old_freq) {
562 ret = _set_opp_voltage(dev, reg, new_supply);
563 if (ret)
564 goto restore_voltage;
565 }
566
567 /* Change frequency */
568 ret = _generic_set_opp_clk_only(dev, data->clk, old_freq, freq);
569 if (ret)
570 goto restore_voltage;
571
572 /* Scaling down? Scale voltage after frequency */
573 if (freq < old_freq) {
574 ret = _set_opp_voltage(dev, reg, new_supply);
575 if (ret)
576 goto restore_freq;
577 }
578
579 return 0;
580
581restore_freq:
582 if (_generic_set_opp_clk_only(dev, data->clk, freq, old_freq))
583 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
584 __func__, old_freq);
585restore_voltage:
586 /* This shouldn't harm even if the voltages weren't updated earlier */
587 if (old_supply->u_volt)
588 _set_opp_voltage(dev, reg, old_supply);
589
590 return ret;
591}
592
6a0712f6
VK
593/**
594 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
595 * @dev: device for which we do this operation
596 * @target_freq: frequency to achieve
597 *
598 * This configures the power-supplies and clock source to the levels specified
599 * by the OPP corresponding to the target_freq.
6a0712f6
VK
600 */
601int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
602{
2c2709dc 603 struct opp_table *opp_table;
94735585 604 unsigned long freq, old_freq;
4dab160e 605 int (*set_opp)(struct dev_pm_set_opp_data *data);
6a0712f6 606 struct dev_pm_opp *old_opp, *opp;
94735585
VK
607 struct regulator **regulators;
608 struct dev_pm_set_opp_data *data;
6a0712f6 609 struct clk *clk;
94735585 610 int ret, size;
6a0712f6
VK
611
612 if (unlikely(!target_freq)) {
613 dev_err(dev, "%s: Invalid target frequency %lu\n", __func__,
614 target_freq);
615 return -EINVAL;
616 }
617
052c6f19
VK
618 opp_table = _find_opp_table(dev);
619 if (IS_ERR(opp_table)) {
620 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
621 return PTR_ERR(opp_table);
622 }
623
624 clk = opp_table->clk;
625 if (IS_ERR(clk)) {
626 dev_err(dev, "%s: No clock available for the device\n",
627 __func__);
628 ret = PTR_ERR(clk);
629 goto put_opp_table;
630 }
6a0712f6
VK
631
632 freq = clk_round_rate(clk, target_freq);
633 if ((long)freq <= 0)
634 freq = target_freq;
635
636 old_freq = clk_get_rate(clk);
637
638 /* Return early if nothing to do */
639 if (old_freq == freq) {
640 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
641 __func__, freq);
052c6f19
VK
642 ret = 0;
643 goto put_opp_table;
6a0712f6
VK
644 }
645
067b7ce0 646 old_opp = _find_freq_ceil(opp_table, &old_freq);
4df27c91 647 if (IS_ERR(old_opp)) {
6a0712f6
VK
648 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
649 __func__, old_freq, PTR_ERR(old_opp));
650 }
651
067b7ce0 652 opp = _find_freq_ceil(opp_table, &freq);
6a0712f6
VK
653 if (IS_ERR(opp)) {
654 ret = PTR_ERR(opp);
655 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
656 __func__, freq, ret);
052c6f19 657 goto put_old_opp;
6a0712f6
VK
658 }
659
94735585
VK
660 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
661 old_freq, freq);
dfbe4678 662
94735585
VK
663 regulators = opp_table->regulators;
664
665 /* Only frequency scaling */
666 if (!regulators) {
052c6f19
VK
667 ret = _generic_set_opp_clk_only(dev, clk, old_freq, freq);
668 goto put_opps;
dfbe4678
VK
669 }
670
4dab160e
VK
671 if (opp_table->set_opp)
672 set_opp = opp_table->set_opp;
673 else
674 set_opp = _generic_set_opp;
675
94735585
VK
676 data = opp_table->set_opp_data;
677 data->regulators = regulators;
678 data->regulator_count = opp_table->regulator_count;
679 data->clk = clk;
680 data->dev = dev;
681
682 data->old_opp.rate = old_freq;
683 size = sizeof(*opp->supplies) * opp_table->regulator_count;
ce31781a 684 if (IS_ERR(old_opp))
94735585 685 memset(data->old_opp.supplies, 0, size);
ce31781a 686 else
94735585 687 memcpy(data->old_opp.supplies, old_opp->supplies, size);
6a0712f6 688
94735585
VK
689 data->new_opp.rate = freq;
690 memcpy(data->new_opp.supplies, opp->supplies, size);
6a0712f6 691
052c6f19
VK
692 ret = set_opp(data);
693
694put_opps:
8a31d9d9 695 dev_pm_opp_put(opp);
052c6f19 696put_old_opp:
8a31d9d9
VK
697 if (!IS_ERR(old_opp))
698 dev_pm_opp_put(old_opp);
052c6f19 699put_opp_table:
5b650b38 700 dev_pm_opp_put_opp_table(opp_table);
052c6f19 701 return ret;
6a0712f6
VK
702}
703EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
704
2c2709dc 705/* OPP-dev Helpers */
2c2709dc
VK
706static void _remove_opp_dev(struct opp_device *opp_dev,
707 struct opp_table *opp_table)
06441658 708{
2c2709dc
VK
709 opp_debug_unregister(opp_dev, opp_table);
710 list_del(&opp_dev->node);
052c6f19 711 kfree(opp_dev);
06441658
VK
712}
713
2c2709dc
VK
714struct opp_device *_add_opp_dev(const struct device *dev,
715 struct opp_table *opp_table)
06441658 716{
2c2709dc 717 struct opp_device *opp_dev;
deaa5146 718 int ret;
06441658 719
2c2709dc
VK
720 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
721 if (!opp_dev)
06441658
VK
722 return NULL;
723
2c2709dc
VK
724 /* Initialize opp-dev */
725 opp_dev->dev = dev;
052c6f19 726 list_add(&opp_dev->node, &opp_table->dev_list);
06441658 727
2c2709dc
VK
728 /* Create debugfs entries for the opp_table */
729 ret = opp_debug_register(opp_dev, opp_table);
deaa5146
VK
730 if (ret)
731 dev_err(dev, "%s: Failed to register opp debugfs (%d)\n",
732 __func__, ret);
733
2c2709dc 734 return opp_dev;
06441658
VK
735}
736
b6160e26 737static struct opp_table *_allocate_opp_table(struct device *dev)
07cce74a 738{
2c2709dc
VK
739 struct opp_table *opp_table;
740 struct opp_device *opp_dev;
d54974c2 741 int ret;
07cce74a
VK
742
743 /*
2c2709dc 744 * Allocate a new OPP table. In the infrequent case where a new
07cce74a
VK
745 * device is needed to be added, we pay this penalty.
746 */
2c2709dc
VK
747 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
748 if (!opp_table)
07cce74a
VK
749 return NULL;
750
2c2709dc 751 INIT_LIST_HEAD(&opp_table->dev_list);
06441658 752
2c2709dc
VK
753 opp_dev = _add_opp_dev(dev, opp_table);
754 if (!opp_dev) {
755 kfree(opp_table);
06441658
VK
756 return NULL;
757 }
758
f47b72a1 759 _of_init_opp_table(opp_table, dev);
50f8cfbd 760
d54974c2 761 /* Find clk for the device */
2c2709dc
VK
762 opp_table->clk = clk_get(dev, NULL);
763 if (IS_ERR(opp_table->clk)) {
764 ret = PTR_ERR(opp_table->clk);
d54974c2
VK
765 if (ret != -EPROBE_DEFER)
766 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
767 ret);
768 }
769
052c6f19 770 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
2c2709dc 771 INIT_LIST_HEAD(&opp_table->opp_list);
37a73ec0 772 mutex_init(&opp_table->lock);
f067a982 773 kref_init(&opp_table->kref);
07cce74a 774
2c2709dc 775 /* Secure the device table modification */
052c6f19 776 list_add(&opp_table->node, &opp_tables);
2c2709dc 777 return opp_table;
07cce74a
VK
778}
779
f067a982 780void _get_opp_table_kref(struct opp_table *opp_table)
b6160e26 781{
f067a982
VK
782 kref_get(&opp_table->kref);
783}
784
785struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
786{
787 struct opp_table *opp_table;
788
789 /* Hold our table modification lock here */
790 mutex_lock(&opp_table_lock);
791
5b650b38
VK
792 opp_table = _find_opp_table_unlocked(dev);
793 if (!IS_ERR(opp_table))
f067a982 794 goto unlock;
f067a982
VK
795
796 opp_table = _allocate_opp_table(dev);
797
798unlock:
799 mutex_unlock(&opp_table_lock);
800
801 return opp_table;
802}
803EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
804
b83c1899 805static void _opp_table_kref_release(struct kref *kref)
f067a982
VK
806{
807 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
b6160e26
VK
808 struct opp_device *opp_dev;
809
810 /* Release clk */
811 if (!IS_ERR(opp_table->clk))
812 clk_put(opp_table->clk);
813
814 opp_dev = list_first_entry(&opp_table->dev_list, struct opp_device,
815 node);
816
817 _remove_opp_dev(opp_dev, opp_table);
818
819 /* dev_list must be empty now */
820 WARN_ON(!list_empty(&opp_table->dev_list));
821
37a73ec0 822 mutex_destroy(&opp_table->lock);
052c6f19
VK
823 list_del(&opp_table->node);
824 kfree(opp_table);
b6160e26 825
f067a982
VK
826 mutex_unlock(&opp_table_lock);
827}
828
829void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
830{
831 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
832 &opp_table_lock);
833}
834EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
835
8cd2f6e8 836void _opp_free(struct dev_pm_opp *opp)
969fceb3
VK
837{
838 kfree(opp);
969fceb3
VK
839}
840
7034764a 841static void _opp_kref_release(struct kref *kref)
129eec55 842{
7034764a
VK
843 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
844 struct opp_table *opp_table = opp->opp_table;
37a73ec0 845
129eec55
VK
846 /*
847 * Notify the changes in the availability of the operable
848 * frequency/voltage list.
849 */
052c6f19 850 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
deaa5146 851 opp_debug_remove_one(opp);
052c6f19
VK
852 list_del(&opp->node);
853 kfree(opp);
129eec55 854
37a73ec0 855 mutex_unlock(&opp_table->lock);
31641cda 856 dev_pm_opp_put_opp_table(opp_table);
129eec55
VK
857}
858
8a31d9d9
VK
859static void dev_pm_opp_get(struct dev_pm_opp *opp)
860{
861 kref_get(&opp->kref);
862}
863
7034764a
VK
864void dev_pm_opp_put(struct dev_pm_opp *opp)
865{
866 kref_put_mutex(&opp->kref, _opp_kref_release, &opp->opp_table->lock);
867}
868EXPORT_SYMBOL_GPL(dev_pm_opp_put);
869
129eec55 870/**
2c2709dc 871 * dev_pm_opp_remove() - Remove an OPP from OPP table
129eec55
VK
872 * @dev: device for which we do this operation
873 * @freq: OPP to remove with matching 'freq'
874 *
2c2709dc 875 * This function removes an opp from the opp table.
129eec55
VK
876 */
877void dev_pm_opp_remove(struct device *dev, unsigned long freq)
878{
879 struct dev_pm_opp *opp;
2c2709dc 880 struct opp_table *opp_table;
129eec55
VK
881 bool found = false;
882
2c2709dc
VK
883 opp_table = _find_opp_table(dev);
884 if (IS_ERR(opp_table))
5b650b38 885 return;
129eec55 886
37a73ec0
VK
887 mutex_lock(&opp_table->lock);
888
2c2709dc 889 list_for_each_entry(opp, &opp_table->opp_list, node) {
129eec55
VK
890 if (opp->rate == freq) {
891 found = true;
892 break;
893 }
894 }
895
37a73ec0
VK
896 mutex_unlock(&opp_table->lock);
897
5b650b38
VK
898 if (found) {
899 dev_pm_opp_put(opp);
900 } else {
129eec55
VK
901 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
902 __func__, freq);
129eec55
VK
903 }
904
5b650b38 905 dev_pm_opp_put_opp_table(opp_table);
129eec55
VK
906}
907EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
908
8cd2f6e8 909struct dev_pm_opp *_opp_allocate(struct opp_table *table)
e1f60b29 910{
23dacf6d 911 struct dev_pm_opp *opp;
dfbe4678 912 int count, supply_size;
e1f60b29 913
dfbe4678
VK
914 /* Allocate space for at least one supply */
915 count = table->regulator_count ? table->regulator_count : 1;
916 supply_size = sizeof(*opp->supplies) * count;
e1f60b29 917
dfbe4678
VK
918 /* allocate new OPP node and supplies structures */
919 opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
8cd2f6e8 920 if (!opp)
23dacf6d 921 return NULL;
23dacf6d 922
dfbe4678
VK
923 /* Put the supplies at the end of the OPP structure as an empty array */
924 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
925 INIT_LIST_HEAD(&opp->node);
926
23dacf6d
VK
927 return opp;
928}
929
7d34d56e 930static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
2c2709dc 931 struct opp_table *opp_table)
7d34d56e 932{
dfbe4678
VK
933 struct regulator *reg;
934 int i;
935
936 for (i = 0; i < opp_table->regulator_count; i++) {
937 reg = opp_table->regulators[i];
938
939 if (!regulator_is_supported_voltage(reg,
940 opp->supplies[i].u_volt_min,
941 opp->supplies[i].u_volt_max)) {
942 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
943 __func__, opp->supplies[i].u_volt_min,
944 opp->supplies[i].u_volt_max);
945 return false;
946 }
7d34d56e
VK
947 }
948
949 return true;
950}
951
7f8538eb
VK
952/*
953 * Returns:
954 * 0: On success. And appropriate error message for duplicate OPPs.
955 * -EBUSY: For OPP with same freq/volt and is available. The callers of
956 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
957 * sure we don't print error messages unnecessarily if different parts of
958 * kernel try to initialize the OPP table.
959 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
960 * should be considered an error by the callers of _opp_add().
961 */
f47b72a1
VK
962int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
963 struct opp_table *opp_table)
23dacf6d
VK
964{
965 struct dev_pm_opp *opp;
37a73ec0 966 struct list_head *head;
deaa5146 967 int ret;
23dacf6d
VK
968
969 /*
970 * Insert new OPP in order of increasing frequency and discard if
971 * already present.
972 *
2c2709dc 973 * Need to use &opp_table->opp_list in the condition part of the 'for'
23dacf6d
VK
974 * loop, don't replace it with head otherwise it will become an infinite
975 * loop.
976 */
37a73ec0
VK
977 mutex_lock(&opp_table->lock);
978 head = &opp_table->opp_list;
979
052c6f19 980 list_for_each_entry(opp, &opp_table->opp_list, node) {
23dacf6d
VK
981 if (new_opp->rate > opp->rate) {
982 head = &opp->node;
983 continue;
984 }
985
986 if (new_opp->rate < opp->rate)
987 break;
988
989 /* Duplicate OPPs */
06441658 990 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
dfbe4678
VK
991 __func__, opp->rate, opp->supplies[0].u_volt,
992 opp->available, new_opp->rate,
993 new_opp->supplies[0].u_volt, new_opp->available);
23dacf6d 994
dfbe4678 995 /* Should we compare voltages for all regulators here ? */
37a73ec0
VK
996 ret = opp->available &&
997 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
998
999 mutex_unlock(&opp_table->lock);
1000 return ret;
23dacf6d
VK
1001 }
1002
052c6f19 1003 list_add(&new_opp->node, head);
37a73ec0
VK
1004 mutex_unlock(&opp_table->lock);
1005
1006 new_opp->opp_table = opp_table;
7034764a 1007 kref_init(&new_opp->kref);
23dacf6d 1008
31641cda
VK
1009 /* Get a reference to the OPP table */
1010 _get_opp_table_kref(opp_table);
1011
2c2709dc 1012 ret = opp_debug_create_one(new_opp, opp_table);
deaa5146
VK
1013 if (ret)
1014 dev_err(dev, "%s: Failed to register opp to debugfs (%d)\n",
1015 __func__, ret);
1016
2c2709dc 1017 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
7d34d56e
VK
1018 new_opp->available = false;
1019 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1020 __func__, new_opp->rate);
1021 }
1022
23dacf6d
VK
1023 return 0;
1024}
1025
984f16c8 1026/**
b64b9c3f 1027 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
8cd2f6e8 1028 * @opp_table: OPP table
984f16c8
NM
1029 * @dev: device for which we do this operation
1030 * @freq: Frequency in Hz for this OPP
1031 * @u_volt: Voltage in uVolts for this OPP
1032 * @dynamic: Dynamically added OPPs.
1033 *
2c2709dc 1034 * This function adds an opp definition to the opp table and returns status.
984f16c8
NM
1035 * The opp is made available by default and it can be controlled using
1036 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1037 *
8f8d37b2
VK
1038 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1039 * and freed by dev_pm_opp_of_remove_table.
984f16c8 1040 *
984f16c8
NM
1041 * Return:
1042 * 0 On success OR
1043 * Duplicate OPPs (both freq and volt are same) and opp->available
1044 * -EEXIST Freq are same and volt are different OR
1045 * Duplicate OPPs (both freq and volt are same) and !opp->available
1046 * -ENOMEM Memory allocation failure
1047 */
8cd2f6e8
VK
1048int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1049 unsigned long freq, long u_volt, bool dynamic)
e1f60b29 1050{
23dacf6d 1051 struct dev_pm_opp *new_opp;
50f8cfbd 1052 unsigned long tol;
6ce4184d 1053 int ret;
e1f60b29 1054
8cd2f6e8
VK
1055 new_opp = _opp_allocate(opp_table);
1056 if (!new_opp)
1057 return -ENOMEM;
23dacf6d 1058
a7470db6 1059 /* populate the opp table */
a7470db6 1060 new_opp->rate = freq;
2c2709dc 1061 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
dfbe4678
VK
1062 new_opp->supplies[0].u_volt = u_volt;
1063 new_opp->supplies[0].u_volt_min = u_volt - tol;
1064 new_opp->supplies[0].u_volt_max = u_volt + tol;
a7470db6 1065 new_opp->available = true;
23dacf6d 1066 new_opp->dynamic = dynamic;
a7470db6 1067
2c2709dc 1068 ret = _opp_add(dev, new_opp, opp_table);
7f8538eb
VK
1069 if (ret) {
1070 /* Don't return error for duplicate OPPs */
1071 if (ret == -EBUSY)
1072 ret = 0;
6ce4184d 1073 goto free_opp;
7f8538eb 1074 }
64ce8545 1075
03ca370f
MH
1076 /*
1077 * Notify the changes in the availability of the operable
1078 * frequency/voltage list.
1079 */
052c6f19 1080 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
e1f60b29 1081 return 0;
6ce4184d
VK
1082
1083free_opp:
8cd2f6e8
VK
1084 _opp_free(new_opp);
1085
6ce4184d 1086 return ret;
e1f60b29 1087}
38393409 1088
7de36b0a
VK
1089/**
1090 * dev_pm_opp_set_supported_hw() - Set supported platforms
1091 * @dev: Device for which supported-hw has to be set.
1092 * @versions: Array of hierarchy of versions to match.
1093 * @count: Number of elements in the array.
1094 *
1095 * This is required only for the V2 bindings, and it enables a platform to
1096 * specify the hierarchy of versions it supports. OPP layer will then enable
1097 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1098 * property.
7de36b0a 1099 */
fa30184d
VK
1100struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1101 const u32 *versions, unsigned int count)
7de36b0a 1102{
2c2709dc 1103 struct opp_table *opp_table;
fa30184d 1104 int ret;
7de36b0a 1105
fa30184d
VK
1106 opp_table = dev_pm_opp_get_opp_table(dev);
1107 if (!opp_table)
1108 return ERR_PTR(-ENOMEM);
7de36b0a 1109
2c2709dc
VK
1110 /* Make sure there are no concurrent readers while updating opp_table */
1111 WARN_ON(!list_empty(&opp_table->opp_list));
7de36b0a 1112
2c2709dc
VK
1113 /* Do we already have a version hierarchy associated with opp_table? */
1114 if (opp_table->supported_hw) {
7de36b0a
VK
1115 dev_err(dev, "%s: Already have supported hardware list\n",
1116 __func__);
1117 ret = -EBUSY;
1118 goto err;
1119 }
1120
2c2709dc 1121 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
7de36b0a 1122 GFP_KERNEL);
2c2709dc 1123 if (!opp_table->supported_hw) {
7de36b0a
VK
1124 ret = -ENOMEM;
1125 goto err;
1126 }
1127
2c2709dc 1128 opp_table->supported_hw_count = count;
fa30184d
VK
1129
1130 return opp_table;
7de36b0a
VK
1131
1132err:
fa30184d 1133 dev_pm_opp_put_opp_table(opp_table);
7de36b0a 1134
fa30184d 1135 return ERR_PTR(ret);
7de36b0a
VK
1136}
1137EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1138
1139/**
1140 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
fa30184d 1141 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
7de36b0a
VK
1142 *
1143 * This is required only for the V2 bindings, and is called for a matching
2c2709dc 1144 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
7de36b0a 1145 * will not be freed.
7de36b0a 1146 */
fa30184d 1147void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
7de36b0a 1148{
2c2709dc
VK
1149 /* Make sure there are no concurrent readers while updating opp_table */
1150 WARN_ON(!list_empty(&opp_table->opp_list));
7de36b0a 1151
2c2709dc 1152 if (!opp_table->supported_hw) {
fa30184d
VK
1153 pr_err("%s: Doesn't have supported hardware list\n",
1154 __func__);
1155 return;
7de36b0a
VK
1156 }
1157
2c2709dc
VK
1158 kfree(opp_table->supported_hw);
1159 opp_table->supported_hw = NULL;
1160 opp_table->supported_hw_count = 0;
7de36b0a 1161
fa30184d 1162 dev_pm_opp_put_opp_table(opp_table);
7de36b0a
VK
1163}
1164EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1165
01fb4d3c
VK
1166/**
1167 * dev_pm_opp_set_prop_name() - Set prop-extn name
a5da6447 1168 * @dev: Device for which the prop-name has to be set.
01fb4d3c
VK
1169 * @name: name to postfix to properties.
1170 *
1171 * This is required only for the V2 bindings, and it enables a platform to
1172 * specify the extn to be used for certain property names. The properties to
1173 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1174 * should postfix the property name with -<name> while looking for them.
01fb4d3c 1175 */
fa30184d 1176struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
01fb4d3c 1177{
2c2709dc 1178 struct opp_table *opp_table;
fa30184d 1179 int ret;
01fb4d3c 1180
fa30184d
VK
1181 opp_table = dev_pm_opp_get_opp_table(dev);
1182 if (!opp_table)
1183 return ERR_PTR(-ENOMEM);
01fb4d3c 1184
2c2709dc
VK
1185 /* Make sure there are no concurrent readers while updating opp_table */
1186 WARN_ON(!list_empty(&opp_table->opp_list));
01fb4d3c 1187
2c2709dc
VK
1188 /* Do we already have a prop-name associated with opp_table? */
1189 if (opp_table->prop_name) {
01fb4d3c 1190 dev_err(dev, "%s: Already have prop-name %s\n", __func__,
2c2709dc 1191 opp_table->prop_name);
01fb4d3c
VK
1192 ret = -EBUSY;
1193 goto err;
1194 }
1195
2c2709dc
VK
1196 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1197 if (!opp_table->prop_name) {
01fb4d3c
VK
1198 ret = -ENOMEM;
1199 goto err;
1200 }
1201
fa30184d 1202 return opp_table;
01fb4d3c
VK
1203
1204err:
fa30184d 1205 dev_pm_opp_put_opp_table(opp_table);
01fb4d3c 1206
fa30184d 1207 return ERR_PTR(ret);
01fb4d3c
VK
1208}
1209EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1210
1211/**
1212 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
fa30184d 1213 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
01fb4d3c
VK
1214 *
1215 * This is required only for the V2 bindings, and is called for a matching
2c2709dc 1216 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
01fb4d3c 1217 * will not be freed.
01fb4d3c 1218 */
fa30184d 1219void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
01fb4d3c 1220{
2c2709dc
VK
1221 /* Make sure there are no concurrent readers while updating opp_table */
1222 WARN_ON(!list_empty(&opp_table->opp_list));
01fb4d3c 1223
2c2709dc 1224 if (!opp_table->prop_name) {
fa30184d
VK
1225 pr_err("%s: Doesn't have a prop-name\n", __func__);
1226 return;
01fb4d3c
VK
1227 }
1228
2c2709dc
VK
1229 kfree(opp_table->prop_name);
1230 opp_table->prop_name = NULL;
01fb4d3c 1231
fa30184d 1232 dev_pm_opp_put_opp_table(opp_table);
01fb4d3c
VK
1233}
1234EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1235
94735585
VK
1236static int _allocate_set_opp_data(struct opp_table *opp_table)
1237{
1238 struct dev_pm_set_opp_data *data;
1239 int len, count = opp_table->regulator_count;
1240
1241 if (WARN_ON(!count))
1242 return -EINVAL;
1243
1244 /* space for set_opp_data */
1245 len = sizeof(*data);
1246
1247 /* space for old_opp.supplies and new_opp.supplies */
1248 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1249
1250 data = kzalloc(len, GFP_KERNEL);
1251 if (!data)
1252 return -ENOMEM;
1253
1254 data->old_opp.supplies = (void *)(data + 1);
1255 data->new_opp.supplies = data->old_opp.supplies + count;
1256
1257 opp_table->set_opp_data = data;
1258
1259 return 0;
1260}
1261
1262static void _free_set_opp_data(struct opp_table *opp_table)
1263{
1264 kfree(opp_table->set_opp_data);
1265 opp_table->set_opp_data = NULL;
1266}
1267
9f8ea969 1268/**
dfbe4678 1269 * dev_pm_opp_set_regulators() - Set regulator names for the device
9f8ea969 1270 * @dev: Device for which regulator name is being set.
dfbe4678
VK
1271 * @names: Array of pointers to the names of the regulator.
1272 * @count: Number of regulators.
9f8ea969
VK
1273 *
1274 * In order to support OPP switching, OPP layer needs to know the name of the
dfbe4678
VK
1275 * device's regulators, as the core would be required to switch voltages as
1276 * well.
9f8ea969
VK
1277 *
1278 * This must be called before any OPPs are initialized for the device.
9f8ea969 1279 */
dfbe4678
VK
1280struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1281 const char * const names[],
1282 unsigned int count)
9f8ea969 1283{
2c2709dc 1284 struct opp_table *opp_table;
9f8ea969 1285 struct regulator *reg;
dfbe4678 1286 int ret, i;
9f8ea969 1287
fa30184d
VK
1288 opp_table = dev_pm_opp_get_opp_table(dev);
1289 if (!opp_table)
1290 return ERR_PTR(-ENOMEM);
9f8ea969
VK
1291
1292 /* This should be called before OPPs are initialized */
2c2709dc 1293 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
9f8ea969
VK
1294 ret = -EBUSY;
1295 goto err;
1296 }
1297
dfbe4678 1298 /* Already have regulators set */
e231f8d7 1299 if (opp_table->regulators) {
9f8ea969
VK
1300 ret = -EBUSY;
1301 goto err;
1302 }
dfbe4678
VK
1303
1304 opp_table->regulators = kmalloc_array(count,
1305 sizeof(*opp_table->regulators),
1306 GFP_KERNEL);
1307 if (!opp_table->regulators) {
1308 ret = -ENOMEM;
9f8ea969
VK
1309 goto err;
1310 }
1311
dfbe4678
VK
1312 for (i = 0; i < count; i++) {
1313 reg = regulator_get_optional(dev, names[i]);
1314 if (IS_ERR(reg)) {
1315 ret = PTR_ERR(reg);
1316 if (ret != -EPROBE_DEFER)
1317 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1318 __func__, names[i], ret);
1319 goto free_regulators;
1320 }
1321
1322 opp_table->regulators[i] = reg;
1323 }
1324
1325 opp_table->regulator_count = count;
9f8ea969 1326
94735585
VK
1327 /* Allocate block only once to pass to set_opp() routines */
1328 ret = _allocate_set_opp_data(opp_table);
1329 if (ret)
1330 goto free_regulators;
1331
91291d9a 1332 return opp_table;
9f8ea969 1333
dfbe4678
VK
1334free_regulators:
1335 while (i != 0)
1336 regulator_put(opp_table->regulators[--i]);
1337
1338 kfree(opp_table->regulators);
1339 opp_table->regulators = NULL;
94735585 1340 opp_table->regulator_count = 0;
9f8ea969 1341err:
fa30184d 1342 dev_pm_opp_put_opp_table(opp_table);
9f8ea969 1343
91291d9a 1344 return ERR_PTR(ret);
9f8ea969 1345}
dfbe4678 1346EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
9f8ea969
VK
1347
1348/**
dfbe4678
VK
1349 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1350 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
9f8ea969 1351 */
dfbe4678 1352void dev_pm_opp_put_regulators(struct opp_table *opp_table)
9f8ea969 1353{
dfbe4678
VK
1354 int i;
1355
dfbe4678
VK
1356 if (!opp_table->regulators) {
1357 pr_err("%s: Doesn't have regulators set\n", __func__);
fa30184d 1358 return;
9f8ea969
VK
1359 }
1360
2c2709dc
VK
1361 /* Make sure there are no concurrent readers while updating opp_table */
1362 WARN_ON(!list_empty(&opp_table->opp_list));
9f8ea969 1363
dfbe4678
VK
1364 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1365 regulator_put(opp_table->regulators[i]);
1366
94735585
VK
1367 _free_set_opp_data(opp_table);
1368
dfbe4678
VK
1369 kfree(opp_table->regulators);
1370 opp_table->regulators = NULL;
1371 opp_table->regulator_count = 0;
9f8ea969 1372
fa30184d 1373 dev_pm_opp_put_opp_table(opp_table);
9f8ea969 1374}
dfbe4678 1375EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
9f8ea969 1376
4dab160e
VK
1377/**
1378 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1379 * @dev: Device for which the helper is getting registered.
1380 * @set_opp: Custom set OPP helper.
1381 *
1382 * This is useful to support complex platforms (like platforms with multiple
1383 * regulators per device), instead of the generic OPP set rate helper.
1384 *
1385 * This must be called before any OPPs are initialized for the device.
4dab160e 1386 */
fa30184d 1387struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
4dab160e
VK
1388 int (*set_opp)(struct dev_pm_set_opp_data *data))
1389{
1390 struct opp_table *opp_table;
1391 int ret;
1392
1393 if (!set_opp)
fa30184d 1394 return ERR_PTR(-EINVAL);
4dab160e 1395
fa30184d
VK
1396 opp_table = dev_pm_opp_get_opp_table(dev);
1397 if (!opp_table)
1398 return ERR_PTR(-ENOMEM);
4dab160e
VK
1399
1400 /* This should be called before OPPs are initialized */
1401 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1402 ret = -EBUSY;
1403 goto err;
1404 }
1405
1406 /* Already have custom set_opp helper */
1407 if (WARN_ON(opp_table->set_opp)) {
1408 ret = -EBUSY;
1409 goto err;
1410 }
1411
1412 opp_table->set_opp = set_opp;
1413
fa30184d 1414 return opp_table;
4dab160e
VK
1415
1416err:
fa30184d 1417 dev_pm_opp_put_opp_table(opp_table);
4dab160e 1418
fa30184d 1419 return ERR_PTR(ret);
4dab160e
VK
1420}
1421EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1422
1423/**
1424 * dev_pm_opp_register_put_opp_helper() - Releases resources blocked for
1425 * set_opp helper
fa30184d 1426 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
4dab160e 1427 *
fa30184d 1428 * Release resources blocked for platform specific set_opp helper.
4dab160e 1429 */
fa30184d 1430void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table)
4dab160e 1431{
4dab160e 1432 if (!opp_table->set_opp) {
fa30184d
VK
1433 pr_err("%s: Doesn't have custom set_opp helper set\n",
1434 __func__);
1435 return;
4dab160e
VK
1436 }
1437
1438 /* Make sure there are no concurrent readers while updating opp_table */
1439 WARN_ON(!list_empty(&opp_table->opp_list));
1440
1441 opp_table->set_opp = NULL;
1442
fa30184d 1443 dev_pm_opp_put_opp_table(opp_table);
4dab160e
VK
1444}
1445EXPORT_SYMBOL_GPL(dev_pm_opp_register_put_opp_helper);
1446
38393409
VK
1447/**
1448 * dev_pm_opp_add() - Add an OPP table from a table definitions
1449 * @dev: device for which we do this operation
1450 * @freq: Frequency in Hz for this OPP
1451 * @u_volt: Voltage in uVolts for this OPP
1452 *
2c2709dc 1453 * This function adds an opp definition to the opp table and returns status.
38393409
VK
1454 * The opp is made available by default and it can be controlled using
1455 * dev_pm_opp_enable/disable functions.
1456 *
38393409 1457 * Return:
984f16c8 1458 * 0 On success OR
38393409 1459 * Duplicate OPPs (both freq and volt are same) and opp->available
984f16c8 1460 * -EEXIST Freq are same and volt are different OR
38393409 1461 * Duplicate OPPs (both freq and volt are same) and !opp->available
984f16c8 1462 * -ENOMEM Memory allocation failure
38393409
VK
1463 */
1464int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
1465{
8cd2f6e8
VK
1466 struct opp_table *opp_table;
1467 int ret;
1468
b83c1899
VK
1469 opp_table = dev_pm_opp_get_opp_table(dev);
1470 if (!opp_table)
1471 return -ENOMEM;
8cd2f6e8
VK
1472
1473 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
8cd2f6e8 1474
b83c1899 1475 dev_pm_opp_put_opp_table(opp_table);
8cd2f6e8 1476 return ret;
38393409 1477}
5d4879cd 1478EXPORT_SYMBOL_GPL(dev_pm_opp_add);
e1f60b29
NM
1479
1480/**
327854c8 1481 * _opp_set_availability() - helper to set the availability of an opp
e1f60b29
NM
1482 * @dev: device for which we do this operation
1483 * @freq: OPP frequency to modify availability
1484 * @availability_req: availability status requested for this opp
1485 *
052c6f19
VK
1486 * Set the availability of an OPP, opp_{enable,disable} share a common logic
1487 * which is isolated here.
e1f60b29 1488 *
984f16c8 1489 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
e1a2d49c 1490 * copy operation, returns 0 if no modification was done OR modification was
e1f60b29 1491 * successful.
e1f60b29 1492 */
327854c8
NM
1493static int _opp_set_availability(struct device *dev, unsigned long freq,
1494 bool availability_req)
e1f60b29 1495{
2c2709dc 1496 struct opp_table *opp_table;
a7f3987e 1497 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
e1f60b29
NM
1498 int r = 0;
1499
2c2709dc
VK
1500 /* Find the opp_table */
1501 opp_table = _find_opp_table(dev);
1502 if (IS_ERR(opp_table)) {
1503 r = PTR_ERR(opp_table);
e1f60b29 1504 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
a7f3987e 1505 return r;
e1f60b29
NM
1506 }
1507
37a73ec0
VK
1508 mutex_lock(&opp_table->lock);
1509
e1f60b29 1510 /* Do we have the frequency? */
2c2709dc 1511 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
e1f60b29
NM
1512 if (tmp_opp->rate == freq) {
1513 opp = tmp_opp;
1514 break;
1515 }
1516 }
37a73ec0 1517
e1f60b29
NM
1518 if (IS_ERR(opp)) {
1519 r = PTR_ERR(opp);
1520 goto unlock;
1521 }
1522
1523 /* Is update really needed? */
1524 if (opp->available == availability_req)
1525 goto unlock;
e1f60b29 1526
a7f3987e 1527 opp->available = availability_req;
e1f60b29 1528
03ca370f
MH
1529 /* Notify the change of the OPP availability */
1530 if (availability_req)
052c6f19 1531 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
a7f3987e 1532 opp);
03ca370f 1533 else
052c6f19 1534 blocking_notifier_call_chain(&opp_table->head,
a7f3987e 1535 OPP_EVENT_DISABLE, opp);
e1f60b29
NM
1536
1537unlock:
5b650b38
VK
1538 mutex_unlock(&opp_table->lock);
1539 dev_pm_opp_put_opp_table(opp_table);
e1f60b29
NM
1540 return r;
1541}
1542
1543/**
5d4879cd 1544 * dev_pm_opp_enable() - Enable a specific OPP
e1f60b29
NM
1545 * @dev: device for which we do this operation
1546 * @freq: OPP frequency to enable
1547 *
1548 * Enables a provided opp. If the operation is valid, this returns 0, else the
1549 * corresponding error value. It is meant to be used for users an OPP available
5d4879cd 1550 * after being temporarily made unavailable with dev_pm_opp_disable.
e1f60b29 1551 *
984f16c8 1552 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
e1a2d49c 1553 * copy operation, returns 0 if no modification was done OR modification was
984f16c8 1554 * successful.
e1f60b29 1555 */
5d4879cd 1556int dev_pm_opp_enable(struct device *dev, unsigned long freq)
e1f60b29 1557{
327854c8 1558 return _opp_set_availability(dev, freq, true);
e1f60b29 1559}
5d4879cd 1560EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
e1f60b29
NM
1561
1562/**
5d4879cd 1563 * dev_pm_opp_disable() - Disable a specific OPP
e1f60b29
NM
1564 * @dev: device for which we do this operation
1565 * @freq: OPP frequency to disable
1566 *
1567 * Disables a provided opp. If the operation is valid, this returns
1568 * 0, else the corresponding error value. It is meant to be a temporary
1569 * control by users to make this OPP not available until the circumstances are
5d4879cd 1570 * right to make it available again (with a call to dev_pm_opp_enable).
e1f60b29 1571 *
984f16c8 1572 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
e1a2d49c 1573 * copy operation, returns 0 if no modification was done OR modification was
984f16c8 1574 * successful.
e1f60b29 1575 */
5d4879cd 1576int dev_pm_opp_disable(struct device *dev, unsigned long freq)
e1f60b29 1577{
327854c8 1578 return _opp_set_availability(dev, freq, false);
e1f60b29 1579}
5d4879cd 1580EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
e1f60b29 1581
03ca370f 1582/**
dc2c9ad5
VK
1583 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
1584 * @dev: Device for which notifier needs to be registered
1585 * @nb: Notifier block to be registered
984f16c8 1586 *
dc2c9ad5
VK
1587 * Return: 0 on success or a negative error value.
1588 */
1589int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
1590{
1591 struct opp_table *opp_table;
1592 int ret;
1593
dc2c9ad5 1594 opp_table = _find_opp_table(dev);
5b650b38
VK
1595 if (IS_ERR(opp_table))
1596 return PTR_ERR(opp_table);
1597
052c6f19 1598 ret = blocking_notifier_chain_register(&opp_table->head, nb);
dc2c9ad5 1599
5b650b38 1600 dev_pm_opp_put_opp_table(opp_table);
dc2c9ad5
VK
1601
1602 return ret;
1603}
1604EXPORT_SYMBOL(dev_pm_opp_register_notifier);
1605
1606/**
1607 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
1608 * @dev: Device for which notifier needs to be unregistered
1609 * @nb: Notifier block to be unregistered
984f16c8 1610 *
dc2c9ad5 1611 * Return: 0 on success or a negative error value.
03ca370f 1612 */
dc2c9ad5
VK
1613int dev_pm_opp_unregister_notifier(struct device *dev,
1614 struct notifier_block *nb)
03ca370f 1615{
dc2c9ad5
VK
1616 struct opp_table *opp_table;
1617 int ret;
03ca370f 1618
dc2c9ad5 1619 opp_table = _find_opp_table(dev);
5b650b38
VK
1620 if (IS_ERR(opp_table))
1621 return PTR_ERR(opp_table);
dc2c9ad5 1622
052c6f19 1623 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
03ca370f 1624
5b650b38 1625 dev_pm_opp_put_opp_table(opp_table);
dc2c9ad5
VK
1626
1627 return ret;
03ca370f 1628}
dc2c9ad5 1629EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
b496dfbc 1630
411466c5
SH
1631/*
1632 * Free OPPs either created using static entries present in DT or even the
1633 * dynamically added entries based on remove_all param.
b496dfbc 1634 */
8cd2f6e8
VK
1635void _dev_pm_opp_remove_table(struct opp_table *opp_table, struct device *dev,
1636 bool remove_all)
737002b5 1637{
737002b5
VK
1638 struct dev_pm_opp *opp, *tmp;
1639
9274c892
VK
1640 /* Find if opp_table manages a single device */
1641 if (list_is_singular(&opp_table->dev_list)) {
1642 /* Free static OPPs */
1643 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1644 if (remove_all || !opp->dynamic)
7034764a 1645 dev_pm_opp_put(opp);
9274c892
VK
1646 }
1647 } else {
1648 _remove_opp_dev(_find_opp_dev(dev, opp_table), opp_table);
1649 }
1650}
1651
1652void _dev_pm_opp_find_and_remove_table(struct device *dev, bool remove_all)
1653{
1654 struct opp_table *opp_table;
1655
2c2709dc
VK
1656 /* Check for existing table for 'dev' */
1657 opp_table = _find_opp_table(dev);
1658 if (IS_ERR(opp_table)) {
1659 int error = PTR_ERR(opp_table);
737002b5
VK
1660
1661 if (error != -ENODEV)
2c2709dc 1662 WARN(1, "%s: opp_table: %d\n",
737002b5
VK
1663 IS_ERR_OR_NULL(dev) ?
1664 "Invalid device" : dev_name(dev),
1665 error);
5b650b38 1666 return;
737002b5
VK
1667 }
1668
9274c892 1669 _dev_pm_opp_remove_table(opp_table, dev, remove_all);
737002b5 1670
5b650b38 1671 dev_pm_opp_put_opp_table(opp_table);
737002b5 1672}
129eec55
VK
1673
1674/**
411466c5 1675 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2c2709dc 1676 * @dev: device pointer used to lookup OPP table.
129eec55 1677 *
411466c5
SH
1678 * Free both OPPs created using static entries present in DT and the
1679 * dynamically added entries.
129eec55 1680 */
411466c5 1681void dev_pm_opp_remove_table(struct device *dev)
129eec55 1682{
9274c892 1683 _dev_pm_opp_find_and_remove_table(dev, true);
8d4d4e98 1684}
411466c5 1685EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);