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