fa97a875eb47815a6040fa91fcb15ef14479e00c
[linux-2.6-microblaze.git] / drivers / opp / core.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Generic OPP Interface
4  *
5  * Copyright (C) 2009-2010 Texas Instruments Incorporated.
6  *      Nishanth Menon
7  *      Romit Dasgupta
8  *      Kevin Hilman
9  */
10
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12
13 #include <linux/clk.h>
14 #include <linux/errno.h>
15 #include <linux/err.h>
16 #include <linux/slab.h>
17 #include <linux/device.h>
18 #include <linux/export.h>
19 #include <linux/pm_domain.h>
20 #include <linux/regulator/consumer.h>
21
22 #include "opp.h"
23
24 /*
25  * The root of the list of all opp-tables. All opp_table structures branch off
26  * from here, with each opp_table containing the list of opps it supports in
27  * various states of availability.
28  */
29 LIST_HEAD(opp_tables);
30 /* Lock to allow exclusive modification to the device and opp lists */
31 DEFINE_MUTEX(opp_table_lock);
32
33 static struct opp_device *_find_opp_dev(const struct device *dev,
34                                         struct opp_table *opp_table)
35 {
36         struct opp_device *opp_dev;
37
38         list_for_each_entry(opp_dev, &opp_table->dev_list, node)
39                 if (opp_dev->dev == dev)
40                         return opp_dev;
41
42         return NULL;
43 }
44
45 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
46 {
47         struct opp_table *opp_table;
48         bool found;
49
50         list_for_each_entry(opp_table, &opp_tables, node) {
51                 mutex_lock(&opp_table->lock);
52                 found = !!_find_opp_dev(dev, opp_table);
53                 mutex_unlock(&opp_table->lock);
54
55                 if (found) {
56                         _get_opp_table_kref(opp_table);
57
58                         return opp_table;
59                 }
60         }
61
62         return ERR_PTR(-ENODEV);
63 }
64
65 /**
66  * _find_opp_table() - find opp_table struct using device pointer
67  * @dev:        device pointer used to lookup OPP table
68  *
69  * Search OPP table for one containing matching device.
70  *
71  * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
72  * -EINVAL based on type of error.
73  *
74  * The callers must call dev_pm_opp_put_opp_table() after the table is used.
75  */
76 struct opp_table *_find_opp_table(struct device *dev)
77 {
78         struct opp_table *opp_table;
79
80         if (IS_ERR_OR_NULL(dev)) {
81                 pr_err("%s: Invalid parameters\n", __func__);
82                 return ERR_PTR(-EINVAL);
83         }
84
85         mutex_lock(&opp_table_lock);
86         opp_table = _find_opp_table_unlocked(dev);
87         mutex_unlock(&opp_table_lock);
88
89         return opp_table;
90 }
91
92 /**
93  * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
94  * @opp:        opp for which voltage has to be returned for
95  *
96  * Return: voltage in micro volt corresponding to the opp, else
97  * return 0
98  *
99  * This is useful only for devices with single power supply.
100  */
101 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
102 {
103         if (IS_ERR_OR_NULL(opp)) {
104                 pr_err("%s: Invalid parameters\n", __func__);
105                 return 0;
106         }
107
108         return opp->supplies[0].u_volt;
109 }
110 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
111
112 /**
113  * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
114  * @opp:        opp for which frequency has to be returned for
115  *
116  * Return: frequency in hertz corresponding to the opp, else
117  * return 0
118  */
119 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
120 {
121         if (IS_ERR_OR_NULL(opp)) {
122                 pr_err("%s: Invalid parameters\n", __func__);
123                 return 0;
124         }
125
126         return opp->rate;
127 }
128 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
129
130 /**
131  * dev_pm_opp_get_level() - Gets the level corresponding to an available opp
132  * @opp:        opp for which level value has to be returned for
133  *
134  * Return: level read from device tree corresponding to the opp, else
135  * return 0.
136  */
137 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
138 {
139         if (IS_ERR_OR_NULL(opp) || !opp->available) {
140                 pr_err("%s: Invalid parameters\n", __func__);
141                 return 0;
142         }
143
144         return opp->level;
145 }
146 EXPORT_SYMBOL_GPL(dev_pm_opp_get_level);
147
148 /**
149  * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
150  * @opp: opp for which turbo mode is being verified
151  *
152  * Turbo OPPs are not for normal use, and can be enabled (under certain
153  * conditions) for short duration of times to finish high throughput work
154  * quickly. Running on them for longer times may overheat the chip.
155  *
156  * Return: true if opp is turbo opp, else false.
157  */
158 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
159 {
160         if (IS_ERR_OR_NULL(opp) || !opp->available) {
161                 pr_err("%s: Invalid parameters\n", __func__);
162                 return false;
163         }
164
165         return opp->turbo;
166 }
167 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
168
169 /**
170  * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
171  * @dev:        device for which we do this operation
172  *
173  * Return: This function returns the max clock latency in nanoseconds.
174  */
175 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
176 {
177         struct opp_table *opp_table;
178         unsigned long clock_latency_ns;
179
180         opp_table = _find_opp_table(dev);
181         if (IS_ERR(opp_table))
182                 return 0;
183
184         clock_latency_ns = opp_table->clock_latency_ns_max;
185
186         dev_pm_opp_put_opp_table(opp_table);
187
188         return clock_latency_ns;
189 }
190 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
191
192 /**
193  * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
194  * @dev: device for which we do this operation
195  *
196  * Return: This function returns the max voltage latency in nanoseconds.
197  */
198 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
199 {
200         struct opp_table *opp_table;
201         struct dev_pm_opp *opp;
202         struct regulator *reg;
203         unsigned long latency_ns = 0;
204         int ret, i, count;
205         struct {
206                 unsigned long min;
207                 unsigned long max;
208         } *uV;
209
210         opp_table = _find_opp_table(dev);
211         if (IS_ERR(opp_table))
212                 return 0;
213
214         /* Regulator may not be required for the device */
215         if (!opp_table->regulators)
216                 goto put_opp_table;
217
218         count = opp_table->regulator_count;
219
220         uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
221         if (!uV)
222                 goto put_opp_table;
223
224         mutex_lock(&opp_table->lock);
225
226         for (i = 0; i < count; i++) {
227                 uV[i].min = ~0;
228                 uV[i].max = 0;
229
230                 list_for_each_entry(opp, &opp_table->opp_list, node) {
231                         if (!opp->available)
232                                 continue;
233
234                         if (opp->supplies[i].u_volt_min < uV[i].min)
235                                 uV[i].min = opp->supplies[i].u_volt_min;
236                         if (opp->supplies[i].u_volt_max > uV[i].max)
237                                 uV[i].max = opp->supplies[i].u_volt_max;
238                 }
239         }
240
241         mutex_unlock(&opp_table->lock);
242
243         /*
244          * The caller needs to ensure that opp_table (and hence the regulator)
245          * isn't freed, while we are executing this routine.
246          */
247         for (i = 0; i < count; i++) {
248                 reg = opp_table->regulators[i];
249                 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
250                 if (ret > 0)
251                         latency_ns += ret * 1000;
252         }
253
254         kfree(uV);
255 put_opp_table:
256         dev_pm_opp_put_opp_table(opp_table);
257
258         return latency_ns;
259 }
260 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
261
262 /**
263  * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
264  *                                           nanoseconds
265  * @dev: device for which we do this operation
266  *
267  * Return: This function returns the max transition latency, in nanoseconds, to
268  * switch from one OPP to other.
269  */
270 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
271 {
272         return dev_pm_opp_get_max_volt_latency(dev) +
273                 dev_pm_opp_get_max_clock_latency(dev);
274 }
275 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
276
277 /**
278  * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
279  * @dev:        device for which we do this operation
280  *
281  * Return: This function returns the frequency of the OPP marked as suspend_opp
282  * if one is available, else returns 0;
283  */
284 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
285 {
286         struct opp_table *opp_table;
287         unsigned long freq = 0;
288
289         opp_table = _find_opp_table(dev);
290         if (IS_ERR(opp_table))
291                 return 0;
292
293         if (opp_table->suspend_opp && opp_table->suspend_opp->available)
294                 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
295
296         dev_pm_opp_put_opp_table(opp_table);
297
298         return freq;
299 }
300 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
301
302 int _get_opp_count(struct opp_table *opp_table)
303 {
304         struct dev_pm_opp *opp;
305         int count = 0;
306
307         mutex_lock(&opp_table->lock);
308
309         list_for_each_entry(opp, &opp_table->opp_list, node) {
310                 if (opp->available)
311                         count++;
312         }
313
314         mutex_unlock(&opp_table->lock);
315
316         return count;
317 }
318
319 /**
320  * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
321  * @dev:        device for which we do this operation
322  *
323  * Return: This function returns the number of available opps if there are any,
324  * else returns 0 if none or the corresponding error value.
325  */
326 int dev_pm_opp_get_opp_count(struct device *dev)
327 {
328         struct opp_table *opp_table;
329         int count;
330
331         opp_table = _find_opp_table(dev);
332         if (IS_ERR(opp_table)) {
333                 count = PTR_ERR(opp_table);
334                 dev_dbg(dev, "%s: OPP table not found (%d)\n",
335                         __func__, count);
336                 return count;
337         }
338
339         count = _get_opp_count(opp_table);
340         dev_pm_opp_put_opp_table(opp_table);
341
342         return count;
343 }
344 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
345
346 /**
347  * dev_pm_opp_find_freq_exact() - search for an exact frequency
348  * @dev:                device for which we do this operation
349  * @freq:               frequency to search for
350  * @available:          true/false - match for available opp
351  *
352  * Return: Searches for exact match in the opp table and returns pointer to the
353  * matching opp if found, else returns ERR_PTR in case of error and should
354  * be handled using IS_ERR. Error return values can be:
355  * EINVAL:      for bad pointer
356  * ERANGE:      no match found for search
357  * ENODEV:      if device not found in list of registered devices
358  *
359  * Note: available is a modifier for the search. if available=true, then the
360  * match is for exact matching frequency and is available in the stored OPP
361  * table. if false, the match is for exact frequency which is not available.
362  *
363  * This provides a mechanism to enable an opp which is not available currently
364  * or the opposite as well.
365  *
366  * The callers are required to call dev_pm_opp_put() for the returned OPP after
367  * use.
368  */
369 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
370                                               unsigned long freq,
371                                               bool available)
372 {
373         struct opp_table *opp_table;
374         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
375
376         opp_table = _find_opp_table(dev);
377         if (IS_ERR(opp_table)) {
378                 int r = PTR_ERR(opp_table);
379
380                 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
381                 return ERR_PTR(r);
382         }
383
384         mutex_lock(&opp_table->lock);
385
386         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
387                 if (temp_opp->available == available &&
388                                 temp_opp->rate == freq) {
389                         opp = temp_opp;
390
391                         /* Increment the reference count of OPP */
392                         dev_pm_opp_get(opp);
393                         break;
394                 }
395         }
396
397         mutex_unlock(&opp_table->lock);
398         dev_pm_opp_put_opp_table(opp_table);
399
400         return opp;
401 }
402 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
403
404 /**
405  * dev_pm_opp_find_level_exact() - search for an exact level
406  * @dev:                device for which we do this operation
407  * @level:              level to search for
408  *
409  * Return: Searches for exact match in the opp table and returns pointer to the
410  * matching opp if found, else returns ERR_PTR in case of error and should
411  * be handled using IS_ERR. Error return values can be:
412  * EINVAL:      for bad pointer
413  * ERANGE:      no match found for search
414  * ENODEV:      if device not found in list of registered devices
415  *
416  * The callers are required to call dev_pm_opp_put() for the returned OPP after
417  * use.
418  */
419 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
420                                                unsigned int level)
421 {
422         struct opp_table *opp_table;
423         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
424
425         opp_table = _find_opp_table(dev);
426         if (IS_ERR(opp_table)) {
427                 int r = PTR_ERR(opp_table);
428
429                 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
430                 return ERR_PTR(r);
431         }
432
433         mutex_lock(&opp_table->lock);
434
435         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
436                 if (temp_opp->level == level) {
437                         opp = temp_opp;
438
439                         /* Increment the reference count of OPP */
440                         dev_pm_opp_get(opp);
441                         break;
442                 }
443         }
444
445         mutex_unlock(&opp_table->lock);
446         dev_pm_opp_put_opp_table(opp_table);
447
448         return opp;
449 }
450 EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_exact);
451
452 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
453                                                    unsigned long *freq)
454 {
455         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
456
457         mutex_lock(&opp_table->lock);
458
459         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
460                 if (temp_opp->available && temp_opp->rate >= *freq) {
461                         opp = temp_opp;
462                         *freq = opp->rate;
463
464                         /* Increment the reference count of OPP */
465                         dev_pm_opp_get(opp);
466                         break;
467                 }
468         }
469
470         mutex_unlock(&opp_table->lock);
471
472         return opp;
473 }
474
475 /**
476  * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
477  * @dev:        device for which we do this operation
478  * @freq:       Start frequency
479  *
480  * Search for the matching ceil *available* OPP from a starting freq
481  * for a device.
482  *
483  * Return: matching *opp and refreshes *freq accordingly, else returns
484  * ERR_PTR in case of error and should be handled using IS_ERR. Error return
485  * values can be:
486  * EINVAL:      for bad pointer
487  * ERANGE:      no match found for search
488  * ENODEV:      if device not found in list of registered devices
489  *
490  * The callers are required to call dev_pm_opp_put() for the returned OPP after
491  * use.
492  */
493 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
494                                              unsigned long *freq)
495 {
496         struct opp_table *opp_table;
497         struct dev_pm_opp *opp;
498
499         if (!dev || !freq) {
500                 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
501                 return ERR_PTR(-EINVAL);
502         }
503
504         opp_table = _find_opp_table(dev);
505         if (IS_ERR(opp_table))
506                 return ERR_CAST(opp_table);
507
508         opp = _find_freq_ceil(opp_table, freq);
509
510         dev_pm_opp_put_opp_table(opp_table);
511
512         return opp;
513 }
514 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
515
516 /**
517  * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
518  * @dev:        device for which we do this operation
519  * @freq:       Start frequency
520  *
521  * Search for the matching floor *available* OPP from a starting freq
522  * for a device.
523  *
524  * Return: matching *opp and refreshes *freq accordingly, else returns
525  * ERR_PTR in case of error and should be handled using IS_ERR. Error return
526  * values can be:
527  * EINVAL:      for bad pointer
528  * ERANGE:      no match found for search
529  * ENODEV:      if device not found in list of registered devices
530  *
531  * The callers are required to call dev_pm_opp_put() for the returned OPP after
532  * use.
533  */
534 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
535                                               unsigned long *freq)
536 {
537         struct opp_table *opp_table;
538         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
539
540         if (!dev || !freq) {
541                 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
542                 return ERR_PTR(-EINVAL);
543         }
544
545         opp_table = _find_opp_table(dev);
546         if (IS_ERR(opp_table))
547                 return ERR_CAST(opp_table);
548
549         mutex_lock(&opp_table->lock);
550
551         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
552                 if (temp_opp->available) {
553                         /* go to the next node, before choosing prev */
554                         if (temp_opp->rate > *freq)
555                                 break;
556                         else
557                                 opp = temp_opp;
558                 }
559         }
560
561         /* Increment the reference count of OPP */
562         if (!IS_ERR(opp))
563                 dev_pm_opp_get(opp);
564         mutex_unlock(&opp_table->lock);
565         dev_pm_opp_put_opp_table(opp_table);
566
567         if (!IS_ERR(opp))
568                 *freq = opp->rate;
569
570         return opp;
571 }
572 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
573
574 /**
575  * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
576  *                                       target voltage.
577  * @dev:        Device for which we do this operation.
578  * @u_volt:     Target voltage.
579  *
580  * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
581  *
582  * Return: matching *opp, else returns ERR_PTR in case of error which should be
583  * handled using IS_ERR.
584  *
585  * Error return values can be:
586  * EINVAL:      bad parameters
587  *
588  * The callers are required to call dev_pm_opp_put() for the returned OPP after
589  * use.
590  */
591 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
592                                                      unsigned long u_volt)
593 {
594         struct opp_table *opp_table;
595         struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
596
597         if (!dev || !u_volt) {
598                 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
599                         u_volt);
600                 return ERR_PTR(-EINVAL);
601         }
602
603         opp_table = _find_opp_table(dev);
604         if (IS_ERR(opp_table))
605                 return ERR_CAST(opp_table);
606
607         mutex_lock(&opp_table->lock);
608
609         list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
610                 if (temp_opp->available) {
611                         if (temp_opp->supplies[0].u_volt > u_volt)
612                                 break;
613                         opp = temp_opp;
614                 }
615         }
616
617         /* Increment the reference count of OPP */
618         if (!IS_ERR(opp))
619                 dev_pm_opp_get(opp);
620
621         mutex_unlock(&opp_table->lock);
622         dev_pm_opp_put_opp_table(opp_table);
623
624         return opp;
625 }
626 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
627
628 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
629                             struct dev_pm_opp_supply *supply)
630 {
631         int ret;
632
633         /* Regulator not available for device */
634         if (IS_ERR(reg)) {
635                 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
636                         PTR_ERR(reg));
637                 return 0;
638         }
639
640         dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
641                 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
642
643         ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
644                                             supply->u_volt, supply->u_volt_max);
645         if (ret)
646                 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
647                         __func__, supply->u_volt_min, supply->u_volt,
648                         supply->u_volt_max, ret);
649
650         return ret;
651 }
652
653 static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
654                                             unsigned long freq)
655 {
656         int ret;
657
658         ret = clk_set_rate(clk, freq);
659         if (ret) {
660                 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
661                         ret);
662         }
663
664         return ret;
665 }
666
667 static int _generic_set_opp_regulator(struct opp_table *opp_table,
668                                       struct device *dev,
669                                       unsigned long old_freq,
670                                       unsigned long freq,
671                                       struct dev_pm_opp_supply *old_supply,
672                                       struct dev_pm_opp_supply *new_supply)
673 {
674         struct regulator *reg = opp_table->regulators[0];
675         int ret;
676
677         /* This function only supports single regulator per device */
678         if (WARN_ON(opp_table->regulator_count > 1)) {
679                 dev_err(dev, "multiple regulators are not supported\n");
680                 return -EINVAL;
681         }
682
683         /* Scaling up? Scale voltage before frequency */
684         if (freq >= old_freq) {
685                 ret = _set_opp_voltage(dev, reg, new_supply);
686                 if (ret)
687                         goto restore_voltage;
688         }
689
690         /* Change frequency */
691         ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
692         if (ret)
693                 goto restore_voltage;
694
695         /* Scaling down? Scale voltage after frequency */
696         if (freq < old_freq) {
697                 ret = _set_opp_voltage(dev, reg, new_supply);
698                 if (ret)
699                         goto restore_freq;
700         }
701
702         /*
703          * Enable the regulator after setting its voltages, otherwise it breaks
704          * some boot-enabled regulators.
705          */
706         if (unlikely(!opp_table->enabled)) {
707                 ret = regulator_enable(reg);
708                 if (ret < 0)
709                         dev_warn(dev, "Failed to enable regulator: %d", ret);
710         }
711
712         return 0;
713
714 restore_freq:
715         if (_generic_set_opp_clk_only(dev, opp_table->clk, old_freq))
716                 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
717                         __func__, old_freq);
718 restore_voltage:
719         /* This shouldn't harm even if the voltages weren't updated earlier */
720         if (old_supply)
721                 _set_opp_voltage(dev, reg, old_supply);
722
723         return ret;
724 }
725
726 static int _set_opp_bw(const struct opp_table *opp_table,
727                        struct dev_pm_opp *opp, struct device *dev, bool remove)
728 {
729         u32 avg, peak;
730         int i, ret;
731
732         if (!opp_table->paths)
733                 return 0;
734
735         for (i = 0; i < opp_table->path_count; i++) {
736                 if (remove) {
737                         avg = 0;
738                         peak = 0;
739                 } else {
740                         avg = opp->bandwidth[i].avg;
741                         peak = opp->bandwidth[i].peak;
742                 }
743                 ret = icc_set_bw(opp_table->paths[i], avg, peak);
744                 if (ret) {
745                         dev_err(dev, "Failed to %s bandwidth[%d]: %d\n",
746                                 remove ? "remove" : "set", i, ret);
747                         return ret;
748                 }
749         }
750
751         return 0;
752 }
753
754 static int _set_opp_custom(const struct opp_table *opp_table,
755                            struct device *dev, unsigned long old_freq,
756                            unsigned long freq,
757                            struct dev_pm_opp_supply *old_supply,
758                            struct dev_pm_opp_supply *new_supply)
759 {
760         struct dev_pm_set_opp_data *data;
761         int size;
762
763         data = opp_table->set_opp_data;
764         data->regulators = opp_table->regulators;
765         data->regulator_count = opp_table->regulator_count;
766         data->clk = opp_table->clk;
767         data->dev = dev;
768
769         data->old_opp.rate = old_freq;
770         size = sizeof(*old_supply) * opp_table->regulator_count;
771         if (!old_supply)
772                 memset(data->old_opp.supplies, 0, size);
773         else
774                 memcpy(data->old_opp.supplies, old_supply, size);
775
776         data->new_opp.rate = freq;
777         memcpy(data->new_opp.supplies, new_supply, size);
778
779         return opp_table->set_opp(data);
780 }
781
782 /* This is only called for PM domain for now */
783 static int _set_required_opps(struct device *dev,
784                               struct opp_table *opp_table,
785                               struct dev_pm_opp *opp)
786 {
787         struct opp_table **required_opp_tables = opp_table->required_opp_tables;
788         struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
789         unsigned int pstate;
790         int i, ret = 0;
791
792         if (!required_opp_tables)
793                 return 0;
794
795         /* Single genpd case */
796         if (!genpd_virt_devs) {
797                 pstate = likely(opp) ? opp->required_opps[0]->pstate : 0;
798                 ret = dev_pm_genpd_set_performance_state(dev, pstate);
799                 if (ret) {
800                         dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
801                                 dev_name(dev), pstate, ret);
802                 }
803                 return ret;
804         }
805
806         /* Multiple genpd case */
807
808         /*
809          * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
810          * after it is freed from another thread.
811          */
812         mutex_lock(&opp_table->genpd_virt_dev_lock);
813
814         for (i = 0; i < opp_table->required_opp_count; i++) {
815                 pstate = likely(opp) ? opp->required_opps[i]->pstate : 0;
816
817                 if (!genpd_virt_devs[i])
818                         continue;
819
820                 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
821                 if (ret) {
822                         dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
823                                 dev_name(genpd_virt_devs[i]), pstate, ret);
824                         break;
825                 }
826         }
827         mutex_unlock(&opp_table->genpd_virt_dev_lock);
828
829         return ret;
830 }
831
832 /**
833  * dev_pm_opp_set_bw() - sets bandwidth levels corresponding to an opp
834  * @dev:        device for which we do this operation
835  * @opp:        opp based on which the bandwidth levels are to be configured
836  *
837  * This configures the bandwidth to the levels specified by the OPP. However
838  * if the OPP specified is NULL the bandwidth levels are cleared out.
839  *
840  * Return: 0 on success or a negative error value.
841  */
842 int dev_pm_opp_set_bw(struct device *dev, struct dev_pm_opp *opp)
843 {
844         struct opp_table *opp_table;
845         int ret;
846
847         opp_table = _find_opp_table(dev);
848         if (IS_ERR(opp_table)) {
849                 dev_err(dev, "%s: device opp table doesn't exist\n", __func__);
850                 return PTR_ERR(opp_table);
851         }
852
853         if (opp)
854                 ret = _set_opp_bw(opp_table, opp, dev, false);
855         else
856                 ret = _set_opp_bw(opp_table, NULL, dev, true);
857
858         dev_pm_opp_put_opp_table(opp_table);
859         return ret;
860 }
861 EXPORT_SYMBOL_GPL(dev_pm_opp_set_bw);
862
863 static int _opp_set_rate_zero(struct device *dev, struct opp_table *opp_table)
864 {
865         int ret;
866
867         if (!opp_table->enabled)
868                 return 0;
869
870         /*
871          * Some drivers need to support cases where some platforms may
872          * have OPP table for the device, while others don't and
873          * opp_set_rate() just needs to behave like clk_set_rate().
874          */
875         if (!_get_opp_count(opp_table))
876                 return 0;
877
878         ret = _set_opp_bw(opp_table, NULL, dev, true);
879         if (ret)
880                 return ret;
881
882         if (opp_table->regulators)
883                 regulator_disable(opp_table->regulators[0]);
884
885         ret = _set_required_opps(dev, opp_table, NULL);
886
887         opp_table->enabled = false;
888         return ret;
889 }
890
891 /**
892  * dev_pm_opp_set_rate() - Configure new OPP based on frequency
893  * @dev:         device for which we do this operation
894  * @target_freq: frequency to achieve
895  *
896  * This configures the power-supplies to the levels specified by the OPP
897  * corresponding to the target_freq, and programs the clock to a value <=
898  * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
899  * provided by the opp, should have already rounded to the target OPP's
900  * frequency.
901  */
902 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
903 {
904         struct opp_table *opp_table;
905         unsigned long freq, old_freq, temp_freq;
906         struct dev_pm_opp *old_opp, *opp;
907         struct clk *clk;
908         int ret;
909
910         opp_table = _find_opp_table(dev);
911         if (IS_ERR(opp_table)) {
912                 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
913                 return PTR_ERR(opp_table);
914         }
915
916         if (unlikely(!target_freq)) {
917                 ret = _opp_set_rate_zero(dev, opp_table);
918                 goto put_opp_table;
919         }
920
921         clk = opp_table->clk;
922         if (IS_ERR(clk)) {
923                 dev_err(dev, "%s: No clock available for the device\n",
924                         __func__);
925                 ret = PTR_ERR(clk);
926                 goto put_opp_table;
927         }
928
929         freq = clk_round_rate(clk, target_freq);
930         if ((long)freq <= 0)
931                 freq = target_freq;
932
933         old_freq = clk_get_rate(clk);
934
935         /* Return early if nothing to do */
936         if (opp_table->enabled && old_freq == freq) {
937                 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
938                         __func__, freq);
939                 ret = 0;
940                 goto put_opp_table;
941         }
942
943         /*
944          * For IO devices which require an OPP on some platforms/SoCs
945          * while just needing to scale the clock on some others
946          * we look for empty OPP tables with just a clock handle and
947          * scale only the clk. This makes dev_pm_opp_set_rate()
948          * equivalent to a clk_set_rate()
949          */
950         if (!_get_opp_count(opp_table)) {
951                 ret = _generic_set_opp_clk_only(dev, clk, freq);
952                 goto put_opp_table;
953         }
954
955         temp_freq = old_freq;
956         old_opp = _find_freq_ceil(opp_table, &temp_freq);
957         if (IS_ERR(old_opp)) {
958                 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
959                         __func__, old_freq, PTR_ERR(old_opp));
960         }
961
962         temp_freq = freq;
963         opp = _find_freq_ceil(opp_table, &temp_freq);
964         if (IS_ERR(opp)) {
965                 ret = PTR_ERR(opp);
966                 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
967                         __func__, freq, ret);
968                 goto put_old_opp;
969         }
970
971         dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
972                 old_freq, freq);
973
974         /* Scaling up? Configure required OPPs before frequency */
975         if (freq >= old_freq) {
976                 ret = _set_required_opps(dev, opp_table, opp);
977                 if (ret)
978                         goto put_opp;
979         }
980
981         if (opp_table->set_opp) {
982                 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
983                                       IS_ERR(old_opp) ? NULL : old_opp->supplies,
984                                       opp->supplies);
985         } else if (opp_table->regulators) {
986                 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
987                                                  IS_ERR(old_opp) ? NULL : old_opp->supplies,
988                                                  opp->supplies);
989         } else {
990                 /* Only frequency scaling */
991                 ret = _generic_set_opp_clk_only(dev, clk, freq);
992         }
993
994         /* Scaling down? Configure required OPPs after frequency */
995         if (!ret && freq < old_freq) {
996                 ret = _set_required_opps(dev, opp_table, opp);
997                 if (ret)
998                         dev_err(dev, "Failed to set required opps: %d\n", ret);
999         }
1000
1001         if (!ret) {
1002                 ret = _set_opp_bw(opp_table, opp, dev, false);
1003                 if (!ret)
1004                         opp_table->enabled = true;
1005         }
1006
1007 put_opp:
1008         dev_pm_opp_put(opp);
1009 put_old_opp:
1010         if (!IS_ERR(old_opp))
1011                 dev_pm_opp_put(old_opp);
1012 put_opp_table:
1013         dev_pm_opp_put_opp_table(opp_table);
1014         return ret;
1015 }
1016 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
1017
1018 /* OPP-dev Helpers */
1019 static void _remove_opp_dev(struct opp_device *opp_dev,
1020                             struct opp_table *opp_table)
1021 {
1022         opp_debug_unregister(opp_dev, opp_table);
1023         list_del(&opp_dev->node);
1024         kfree(opp_dev);
1025 }
1026
1027 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
1028                                                 struct opp_table *opp_table)
1029 {
1030         struct opp_device *opp_dev;
1031
1032         opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
1033         if (!opp_dev)
1034                 return NULL;
1035
1036         /* Initialize opp-dev */
1037         opp_dev->dev = dev;
1038
1039         list_add(&opp_dev->node, &opp_table->dev_list);
1040
1041         /* Create debugfs entries for the opp_table */
1042         opp_debug_register(opp_dev, opp_table);
1043
1044         return opp_dev;
1045 }
1046
1047 struct opp_device *_add_opp_dev(const struct device *dev,
1048                                 struct opp_table *opp_table)
1049 {
1050         struct opp_device *opp_dev;
1051
1052         mutex_lock(&opp_table->lock);
1053         opp_dev = _add_opp_dev_unlocked(dev, opp_table);
1054         mutex_unlock(&opp_table->lock);
1055
1056         return opp_dev;
1057 }
1058
1059 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
1060 {
1061         struct opp_table *opp_table;
1062         struct opp_device *opp_dev;
1063         int ret;
1064
1065         /*
1066          * Allocate a new OPP table. In the infrequent case where a new
1067          * device is needed to be added, we pay this penalty.
1068          */
1069         opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
1070         if (!opp_table)
1071                 return ERR_PTR(-ENOMEM);
1072
1073         mutex_init(&opp_table->lock);
1074         mutex_init(&opp_table->genpd_virt_dev_lock);
1075         INIT_LIST_HEAD(&opp_table->dev_list);
1076
1077         /* Mark regulator count uninitialized */
1078         opp_table->regulator_count = -1;
1079
1080         opp_dev = _add_opp_dev(dev, opp_table);
1081         if (!opp_dev) {
1082                 ret = -ENOMEM;
1083                 goto err;
1084         }
1085
1086         _of_init_opp_table(opp_table, dev, index);
1087
1088         /* Find clk for the device */
1089         opp_table->clk = clk_get(dev, NULL);
1090         if (IS_ERR(opp_table->clk)) {
1091                 ret = PTR_ERR(opp_table->clk);
1092                 if (ret == -EPROBE_DEFER)
1093                         goto err;
1094
1095                 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__, ret);
1096         }
1097
1098         /* Find interconnect path(s) for the device */
1099         ret = dev_pm_opp_of_find_icc_paths(dev, opp_table);
1100         if (ret) {
1101                 if (ret == -EPROBE_DEFER)
1102                         goto err;
1103
1104                 dev_warn(dev, "%s: Error finding interconnect paths: %d\n",
1105                          __func__, ret);
1106         }
1107
1108         BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
1109         INIT_LIST_HEAD(&opp_table->opp_list);
1110         kref_init(&opp_table->kref);
1111
1112         /* Secure the device table modification */
1113         list_add(&opp_table->node, &opp_tables);
1114         return opp_table;
1115
1116 err:
1117         kfree(opp_table);
1118         return ERR_PTR(ret);
1119 }
1120
1121 void _get_opp_table_kref(struct opp_table *opp_table)
1122 {
1123         kref_get(&opp_table->kref);
1124 }
1125
1126 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
1127 {
1128         struct opp_table *opp_table;
1129
1130         /* Hold our table modification lock here */
1131         mutex_lock(&opp_table_lock);
1132
1133         opp_table = _find_opp_table_unlocked(dev);
1134         if (!IS_ERR(opp_table))
1135                 goto unlock;
1136
1137         opp_table = _managed_opp(dev, index);
1138         if (opp_table) {
1139                 if (!_add_opp_dev_unlocked(dev, opp_table)) {
1140                         dev_pm_opp_put_opp_table(opp_table);
1141                         opp_table = ERR_PTR(-ENOMEM);
1142                 }
1143                 goto unlock;
1144         }
1145
1146         opp_table = _allocate_opp_table(dev, index);
1147
1148 unlock:
1149         mutex_unlock(&opp_table_lock);
1150
1151         return opp_table;
1152 }
1153
1154 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1155 {
1156         return _opp_get_opp_table(dev, 0);
1157 }
1158 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1159
1160 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
1161                                                    int index)
1162 {
1163         return _opp_get_opp_table(dev, index);
1164 }
1165
1166 static void _opp_table_kref_release(struct kref *kref)
1167 {
1168         struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1169         struct opp_device *opp_dev, *temp;
1170         int i;
1171
1172         _of_clear_opp_table(opp_table);
1173
1174         /* Release clk */
1175         if (!IS_ERR(opp_table->clk))
1176                 clk_put(opp_table->clk);
1177
1178         if (opp_table->paths) {
1179                 for (i = 0; i < opp_table->path_count; i++)
1180                         icc_put(opp_table->paths[i]);
1181                 kfree(opp_table->paths);
1182         }
1183
1184         WARN_ON(!list_empty(&opp_table->opp_list));
1185
1186         list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1187                 /*
1188                  * The OPP table is getting removed, drop the performance state
1189                  * constraints.
1190                  */
1191                 if (opp_table->genpd_performance_state)
1192                         dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1193
1194                 _remove_opp_dev(opp_dev, opp_table);
1195         }
1196
1197         mutex_destroy(&opp_table->genpd_virt_dev_lock);
1198         mutex_destroy(&opp_table->lock);
1199         list_del(&opp_table->node);
1200         kfree(opp_table);
1201
1202         mutex_unlock(&opp_table_lock);
1203 }
1204
1205 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1206 {
1207         kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1208                        &opp_table_lock);
1209 }
1210 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1211
1212 void _opp_free(struct dev_pm_opp *opp)
1213 {
1214         kfree(opp);
1215 }
1216
1217 static void _opp_kref_release(struct dev_pm_opp *opp,
1218                               struct opp_table *opp_table)
1219 {
1220         /*
1221          * Notify the changes in the availability of the operable
1222          * frequency/voltage list.
1223          */
1224         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1225         _of_opp_free_required_opps(opp_table, opp);
1226         opp_debug_remove_one(opp);
1227         list_del(&opp->node);
1228         kfree(opp);
1229 }
1230
1231 static void _opp_kref_release_unlocked(struct kref *kref)
1232 {
1233         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1234         struct opp_table *opp_table = opp->opp_table;
1235
1236         _opp_kref_release(opp, opp_table);
1237 }
1238
1239 static void _opp_kref_release_locked(struct kref *kref)
1240 {
1241         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1242         struct opp_table *opp_table = opp->opp_table;
1243
1244         _opp_kref_release(opp, opp_table);
1245         mutex_unlock(&opp_table->lock);
1246 }
1247
1248 void dev_pm_opp_get(struct dev_pm_opp *opp)
1249 {
1250         kref_get(&opp->kref);
1251 }
1252
1253 void dev_pm_opp_put(struct dev_pm_opp *opp)
1254 {
1255         kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1256                        &opp->opp_table->lock);
1257 }
1258 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1259
1260 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1261 {
1262         kref_put(&opp->kref, _opp_kref_release_unlocked);
1263 }
1264
1265 /**
1266  * dev_pm_opp_remove()  - Remove an OPP from OPP table
1267  * @dev:        device for which we do this operation
1268  * @freq:       OPP to remove with matching 'freq'
1269  *
1270  * This function removes an opp from the opp table.
1271  */
1272 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1273 {
1274         struct dev_pm_opp *opp;
1275         struct opp_table *opp_table;
1276         bool found = false;
1277
1278         opp_table = _find_opp_table(dev);
1279         if (IS_ERR(opp_table))
1280                 return;
1281
1282         mutex_lock(&opp_table->lock);
1283
1284         list_for_each_entry(opp, &opp_table->opp_list, node) {
1285                 if (opp->rate == freq) {
1286                         found = true;
1287                         break;
1288                 }
1289         }
1290
1291         mutex_unlock(&opp_table->lock);
1292
1293         if (found) {
1294                 dev_pm_opp_put(opp);
1295
1296                 /* Drop the reference taken by dev_pm_opp_add() */
1297                 dev_pm_opp_put_opp_table(opp_table);
1298         } else {
1299                 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1300                          __func__, freq);
1301         }
1302
1303         /* Drop the reference taken by _find_opp_table() */
1304         dev_pm_opp_put_opp_table(opp_table);
1305 }
1306 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1307
1308 void _opp_remove_all_static(struct opp_table *opp_table)
1309 {
1310         struct dev_pm_opp *opp, *tmp;
1311
1312         mutex_lock(&opp_table->lock);
1313
1314         if (!opp_table->parsed_static_opps || --opp_table->parsed_static_opps)
1315                 goto unlock;
1316
1317         list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1318                 if (!opp->dynamic)
1319                         dev_pm_opp_put_unlocked(opp);
1320         }
1321
1322 unlock:
1323         mutex_unlock(&opp_table->lock);
1324 }
1325
1326 /**
1327  * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1328  * @dev:        device for which we do this operation
1329  *
1330  * This function removes all dynamically created OPPs from the opp table.
1331  */
1332 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1333 {
1334         struct opp_table *opp_table;
1335         struct dev_pm_opp *opp, *temp;
1336         int count = 0;
1337
1338         opp_table = _find_opp_table(dev);
1339         if (IS_ERR(opp_table))
1340                 return;
1341
1342         mutex_lock(&opp_table->lock);
1343         list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1344                 if (opp->dynamic) {
1345                         dev_pm_opp_put_unlocked(opp);
1346                         count++;
1347                 }
1348         }
1349         mutex_unlock(&opp_table->lock);
1350
1351         /* Drop the references taken by dev_pm_opp_add() */
1352         while (count--)
1353                 dev_pm_opp_put_opp_table(opp_table);
1354
1355         /* Drop the reference taken by _find_opp_table() */
1356         dev_pm_opp_put_opp_table(opp_table);
1357 }
1358 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1359
1360 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1361 {
1362         struct dev_pm_opp *opp;
1363         int supply_count, supply_size, icc_size;
1364
1365         /* Allocate space for at least one supply */
1366         supply_count = table->regulator_count > 0 ? table->regulator_count : 1;
1367         supply_size = sizeof(*opp->supplies) * supply_count;
1368         icc_size = sizeof(*opp->bandwidth) * table->path_count;
1369
1370         /* allocate new OPP node and supplies structures */
1371         opp = kzalloc(sizeof(*opp) + supply_size + icc_size, GFP_KERNEL);
1372
1373         if (!opp)
1374                 return NULL;
1375
1376         /* Put the supplies at the end of the OPP structure as an empty array */
1377         opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1378         if (icc_size)
1379                 opp->bandwidth = (struct dev_pm_opp_icc_bw *)(opp->supplies + supply_count);
1380         INIT_LIST_HEAD(&opp->node);
1381
1382         return opp;
1383 }
1384
1385 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1386                                          struct opp_table *opp_table)
1387 {
1388         struct regulator *reg;
1389         int i;
1390
1391         if (!opp_table->regulators)
1392                 return true;
1393
1394         for (i = 0; i < opp_table->regulator_count; i++) {
1395                 reg = opp_table->regulators[i];
1396
1397                 if (!regulator_is_supported_voltage(reg,
1398                                         opp->supplies[i].u_volt_min,
1399                                         opp->supplies[i].u_volt_max)) {
1400                         pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1401                                 __func__, opp->supplies[i].u_volt_min,
1402                                 opp->supplies[i].u_volt_max);
1403                         return false;
1404                 }
1405         }
1406
1407         return true;
1408 }
1409
1410 int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2)
1411 {
1412         if (opp1->rate != opp2->rate)
1413                 return opp1->rate < opp2->rate ? -1 : 1;
1414         if (opp1->bandwidth && opp2->bandwidth &&
1415             opp1->bandwidth[0].peak != opp2->bandwidth[0].peak)
1416                 return opp1->bandwidth[0].peak < opp2->bandwidth[0].peak ? -1 : 1;
1417         if (opp1->level != opp2->level)
1418                 return opp1->level < opp2->level ? -1 : 1;
1419         return 0;
1420 }
1421
1422 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1423                              struct opp_table *opp_table,
1424                              struct list_head **head)
1425 {
1426         struct dev_pm_opp *opp;
1427         int opp_cmp;
1428
1429         /*
1430          * Insert new OPP in order of increasing frequency and discard if
1431          * already present.
1432          *
1433          * Need to use &opp_table->opp_list in the condition part of the 'for'
1434          * loop, don't replace it with head otherwise it will become an infinite
1435          * loop.
1436          */
1437         list_for_each_entry(opp, &opp_table->opp_list, node) {
1438                 opp_cmp = _opp_compare_key(new_opp, opp);
1439                 if (opp_cmp > 0) {
1440                         *head = &opp->node;
1441                         continue;
1442                 }
1443
1444                 if (opp_cmp < 0)
1445                         return 0;
1446
1447                 /* Duplicate OPPs */
1448                 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1449                          __func__, opp->rate, opp->supplies[0].u_volt,
1450                          opp->available, new_opp->rate,
1451                          new_opp->supplies[0].u_volt, new_opp->available);
1452
1453                 /* Should we compare voltages for all regulators here ? */
1454                 return opp->available &&
1455                        new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1456         }
1457
1458         return 0;
1459 }
1460
1461 /*
1462  * Returns:
1463  * 0: On success. And appropriate error message for duplicate OPPs.
1464  * -EBUSY: For OPP with same freq/volt and is available. The callers of
1465  *  _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1466  *  sure we don't print error messages unnecessarily if different parts of
1467  *  kernel try to initialize the OPP table.
1468  * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1469  *  should be considered an error by the callers of _opp_add().
1470  */
1471 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1472              struct opp_table *opp_table, bool rate_not_available)
1473 {
1474         struct list_head *head;
1475         int ret;
1476
1477         mutex_lock(&opp_table->lock);
1478         head = &opp_table->opp_list;
1479
1480         if (likely(!rate_not_available)) {
1481                 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1482                 if (ret) {
1483                         mutex_unlock(&opp_table->lock);
1484                         return ret;
1485                 }
1486         }
1487
1488         list_add(&new_opp->node, head);
1489         mutex_unlock(&opp_table->lock);
1490
1491         new_opp->opp_table = opp_table;
1492         kref_init(&new_opp->kref);
1493
1494         opp_debug_create_one(new_opp, opp_table);
1495
1496         if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1497                 new_opp->available = false;
1498                 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1499                          __func__, new_opp->rate);
1500         }
1501
1502         return 0;
1503 }
1504
1505 /**
1506  * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1507  * @opp_table:  OPP table
1508  * @dev:        device for which we do this operation
1509  * @freq:       Frequency in Hz for this OPP
1510  * @u_volt:     Voltage in uVolts for this OPP
1511  * @dynamic:    Dynamically added OPPs.
1512  *
1513  * This function adds an opp definition to the opp table and returns status.
1514  * The opp is made available by default and it can be controlled using
1515  * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1516  *
1517  * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1518  * and freed by dev_pm_opp_of_remove_table.
1519  *
1520  * Return:
1521  * 0            On success OR
1522  *              Duplicate OPPs (both freq and volt are same) and opp->available
1523  * -EEXIST      Freq are same and volt are different OR
1524  *              Duplicate OPPs (both freq and volt are same) and !opp->available
1525  * -ENOMEM      Memory allocation failure
1526  */
1527 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1528                 unsigned long freq, long u_volt, bool dynamic)
1529 {
1530         struct dev_pm_opp *new_opp;
1531         unsigned long tol;
1532         int ret;
1533
1534         new_opp = _opp_allocate(opp_table);
1535         if (!new_opp)
1536                 return -ENOMEM;
1537
1538         /* populate the opp table */
1539         new_opp->rate = freq;
1540         tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1541         new_opp->supplies[0].u_volt = u_volt;
1542         new_opp->supplies[0].u_volt_min = u_volt - tol;
1543         new_opp->supplies[0].u_volt_max = u_volt + tol;
1544         new_opp->available = true;
1545         new_opp->dynamic = dynamic;
1546
1547         ret = _opp_add(dev, new_opp, opp_table, false);
1548         if (ret) {
1549                 /* Don't return error for duplicate OPPs */
1550                 if (ret == -EBUSY)
1551                         ret = 0;
1552                 goto free_opp;
1553         }
1554
1555         /*
1556          * Notify the changes in the availability of the operable
1557          * frequency/voltage list.
1558          */
1559         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1560         return 0;
1561
1562 free_opp:
1563         _opp_free(new_opp);
1564
1565         return ret;
1566 }
1567
1568 /**
1569  * dev_pm_opp_set_supported_hw() - Set supported platforms
1570  * @dev: Device for which supported-hw has to be set.
1571  * @versions: Array of hierarchy of versions to match.
1572  * @count: Number of elements in the array.
1573  *
1574  * This is required only for the V2 bindings, and it enables a platform to
1575  * specify the hierarchy of versions it supports. OPP layer will then enable
1576  * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1577  * property.
1578  */
1579 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1580                         const u32 *versions, unsigned int count)
1581 {
1582         struct opp_table *opp_table;
1583
1584         opp_table = dev_pm_opp_get_opp_table(dev);
1585         if (IS_ERR(opp_table))
1586                 return opp_table;
1587
1588         /* Make sure there are no concurrent readers while updating opp_table */
1589         WARN_ON(!list_empty(&opp_table->opp_list));
1590
1591         /* Another CPU that shares the OPP table has set the property ? */
1592         if (opp_table->supported_hw)
1593                 return opp_table;
1594
1595         opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1596                                         GFP_KERNEL);
1597         if (!opp_table->supported_hw) {
1598                 dev_pm_opp_put_opp_table(opp_table);
1599                 return ERR_PTR(-ENOMEM);
1600         }
1601
1602         opp_table->supported_hw_count = count;
1603
1604         return opp_table;
1605 }
1606 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1607
1608 /**
1609  * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1610  * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1611  *
1612  * This is required only for the V2 bindings, and is called for a matching
1613  * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1614  * will not be freed.
1615  */
1616 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1617 {
1618         /* Make sure there are no concurrent readers while updating opp_table */
1619         WARN_ON(!list_empty(&opp_table->opp_list));
1620
1621         kfree(opp_table->supported_hw);
1622         opp_table->supported_hw = NULL;
1623         opp_table->supported_hw_count = 0;
1624
1625         dev_pm_opp_put_opp_table(opp_table);
1626 }
1627 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1628
1629 /**
1630  * dev_pm_opp_set_prop_name() - Set prop-extn name
1631  * @dev: Device for which the prop-name has to be set.
1632  * @name: name to postfix to properties.
1633  *
1634  * This is required only for the V2 bindings, and it enables a platform to
1635  * specify the extn to be used for certain property names. The properties to
1636  * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1637  * should postfix the property name with -<name> while looking for them.
1638  */
1639 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1640 {
1641         struct opp_table *opp_table;
1642
1643         opp_table = dev_pm_opp_get_opp_table(dev);
1644         if (IS_ERR(opp_table))
1645                 return opp_table;
1646
1647         /* Make sure there are no concurrent readers while updating opp_table */
1648         WARN_ON(!list_empty(&opp_table->opp_list));
1649
1650         /* Another CPU that shares the OPP table has set the property ? */
1651         if (opp_table->prop_name)
1652                 return opp_table;
1653
1654         opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1655         if (!opp_table->prop_name) {
1656                 dev_pm_opp_put_opp_table(opp_table);
1657                 return ERR_PTR(-ENOMEM);
1658         }
1659
1660         return opp_table;
1661 }
1662 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1663
1664 /**
1665  * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1666  * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1667  *
1668  * This is required only for the V2 bindings, and is called for a matching
1669  * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1670  * will not be freed.
1671  */
1672 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1673 {
1674         /* Make sure there are no concurrent readers while updating opp_table */
1675         WARN_ON(!list_empty(&opp_table->opp_list));
1676
1677         kfree(opp_table->prop_name);
1678         opp_table->prop_name = NULL;
1679
1680         dev_pm_opp_put_opp_table(opp_table);
1681 }
1682 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1683
1684 static int _allocate_set_opp_data(struct opp_table *opp_table)
1685 {
1686         struct dev_pm_set_opp_data *data;
1687         int len, count = opp_table->regulator_count;
1688
1689         if (WARN_ON(!opp_table->regulators))
1690                 return -EINVAL;
1691
1692         /* space for set_opp_data */
1693         len = sizeof(*data);
1694
1695         /* space for old_opp.supplies and new_opp.supplies */
1696         len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1697
1698         data = kzalloc(len, GFP_KERNEL);
1699         if (!data)
1700                 return -ENOMEM;
1701
1702         data->old_opp.supplies = (void *)(data + 1);
1703         data->new_opp.supplies = data->old_opp.supplies + count;
1704
1705         opp_table->set_opp_data = data;
1706
1707         return 0;
1708 }
1709
1710 static void _free_set_opp_data(struct opp_table *opp_table)
1711 {
1712         kfree(opp_table->set_opp_data);
1713         opp_table->set_opp_data = NULL;
1714 }
1715
1716 /**
1717  * dev_pm_opp_set_regulators() - Set regulator names for the device
1718  * @dev: Device for which regulator name is being set.
1719  * @names: Array of pointers to the names of the regulator.
1720  * @count: Number of regulators.
1721  *
1722  * In order to support OPP switching, OPP layer needs to know the name of the
1723  * device's regulators, as the core would be required to switch voltages as
1724  * well.
1725  *
1726  * This must be called before any OPPs are initialized for the device.
1727  */
1728 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1729                                             const char * const names[],
1730                                             unsigned int count)
1731 {
1732         struct opp_table *opp_table;
1733         struct regulator *reg;
1734         int ret, i;
1735
1736         opp_table = dev_pm_opp_get_opp_table(dev);
1737         if (IS_ERR(opp_table))
1738                 return opp_table;
1739
1740         /* This should be called before OPPs are initialized */
1741         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1742                 ret = -EBUSY;
1743                 goto err;
1744         }
1745
1746         /* Another CPU that shares the OPP table has set the regulators ? */
1747         if (opp_table->regulators)
1748                 return opp_table;
1749
1750         opp_table->regulators = kmalloc_array(count,
1751                                               sizeof(*opp_table->regulators),
1752                                               GFP_KERNEL);
1753         if (!opp_table->regulators) {
1754                 ret = -ENOMEM;
1755                 goto err;
1756         }
1757
1758         for (i = 0; i < count; i++) {
1759                 reg = regulator_get_optional(dev, names[i]);
1760                 if (IS_ERR(reg)) {
1761                         ret = PTR_ERR(reg);
1762                         if (ret != -EPROBE_DEFER)
1763                                 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1764                                         __func__, names[i], ret);
1765                         goto free_regulators;
1766                 }
1767
1768                 opp_table->regulators[i] = reg;
1769         }
1770
1771         opp_table->regulator_count = count;
1772
1773         /* Allocate block only once to pass to set_opp() routines */
1774         ret = _allocate_set_opp_data(opp_table);
1775         if (ret)
1776                 goto free_regulators;
1777
1778         return opp_table;
1779
1780 free_regulators:
1781         while (i != 0)
1782                 regulator_put(opp_table->regulators[--i]);
1783
1784         kfree(opp_table->regulators);
1785         opp_table->regulators = NULL;
1786         opp_table->regulator_count = -1;
1787 err:
1788         dev_pm_opp_put_opp_table(opp_table);
1789
1790         return ERR_PTR(ret);
1791 }
1792 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1793
1794 /**
1795  * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1796  * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1797  */
1798 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1799 {
1800         int i;
1801
1802         if (!opp_table->regulators)
1803                 goto put_opp_table;
1804
1805         /* Make sure there are no concurrent readers while updating opp_table */
1806         WARN_ON(!list_empty(&opp_table->opp_list));
1807
1808         if (opp_table->enabled) {
1809                 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1810                         regulator_disable(opp_table->regulators[i]);
1811         }
1812
1813         for (i = opp_table->regulator_count - 1; i >= 0; i--)
1814                 regulator_put(opp_table->regulators[i]);
1815
1816         _free_set_opp_data(opp_table);
1817
1818         kfree(opp_table->regulators);
1819         opp_table->regulators = NULL;
1820         opp_table->regulator_count = -1;
1821
1822 put_opp_table:
1823         dev_pm_opp_put_opp_table(opp_table);
1824 }
1825 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1826
1827 /**
1828  * dev_pm_opp_set_clkname() - Set clk name for the device
1829  * @dev: Device for which clk name is being set.
1830  * @name: Clk name.
1831  *
1832  * In order to support OPP switching, OPP layer needs to get pointer to the
1833  * clock for the device. Simple cases work fine without using this routine (i.e.
1834  * by passing connection-id as NULL), but for a device with multiple clocks
1835  * available, the OPP core needs to know the exact name of the clk to use.
1836  *
1837  * This must be called before any OPPs are initialized for the device.
1838  */
1839 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1840 {
1841         struct opp_table *opp_table;
1842         int ret;
1843
1844         opp_table = dev_pm_opp_get_opp_table(dev);
1845         if (IS_ERR(opp_table))
1846                 return opp_table;
1847
1848         /* This should be called before OPPs are initialized */
1849         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1850                 ret = -EBUSY;
1851                 goto err;
1852         }
1853
1854         /* Already have default clk set, free it */
1855         if (!IS_ERR(opp_table->clk))
1856                 clk_put(opp_table->clk);
1857
1858         /* Find clk for the device */
1859         opp_table->clk = clk_get(dev, name);
1860         if (IS_ERR(opp_table->clk)) {
1861                 ret = PTR_ERR(opp_table->clk);
1862                 if (ret != -EPROBE_DEFER) {
1863                         dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1864                                 ret);
1865                 }
1866                 goto err;
1867         }
1868
1869         return opp_table;
1870
1871 err:
1872         dev_pm_opp_put_opp_table(opp_table);
1873
1874         return ERR_PTR(ret);
1875 }
1876 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1877
1878 /**
1879  * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1880  * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1881  */
1882 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1883 {
1884         /* Make sure there are no concurrent readers while updating opp_table */
1885         WARN_ON(!list_empty(&opp_table->opp_list));
1886
1887         clk_put(opp_table->clk);
1888         opp_table->clk = ERR_PTR(-EINVAL);
1889
1890         dev_pm_opp_put_opp_table(opp_table);
1891 }
1892 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1893
1894 /**
1895  * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1896  * @dev: Device for which the helper is getting registered.
1897  * @set_opp: Custom set OPP helper.
1898  *
1899  * This is useful to support complex platforms (like platforms with multiple
1900  * regulators per device), instead of the generic OPP set rate helper.
1901  *
1902  * This must be called before any OPPs are initialized for the device.
1903  */
1904 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1905                         int (*set_opp)(struct dev_pm_set_opp_data *data))
1906 {
1907         struct opp_table *opp_table;
1908
1909         if (!set_opp)
1910                 return ERR_PTR(-EINVAL);
1911
1912         opp_table = dev_pm_opp_get_opp_table(dev);
1913         if (!IS_ERR(opp_table))
1914                 return opp_table;
1915
1916         /* This should be called before OPPs are initialized */
1917         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1918                 dev_pm_opp_put_opp_table(opp_table);
1919                 return ERR_PTR(-EBUSY);
1920         }
1921
1922         /* Another CPU that shares the OPP table has set the helper ? */
1923         if (!opp_table->set_opp)
1924                 opp_table->set_opp = set_opp;
1925
1926         return opp_table;
1927 }
1928 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1929
1930 /**
1931  * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1932  *                                         set_opp helper
1933  * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1934  *
1935  * Release resources blocked for platform specific set_opp helper.
1936  */
1937 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1938 {
1939         /* Make sure there are no concurrent readers while updating opp_table */
1940         WARN_ON(!list_empty(&opp_table->opp_list));
1941
1942         opp_table->set_opp = NULL;
1943         dev_pm_opp_put_opp_table(opp_table);
1944 }
1945 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1946
1947 static void _opp_detach_genpd(struct opp_table *opp_table)
1948 {
1949         int index;
1950
1951         for (index = 0; index < opp_table->required_opp_count; index++) {
1952                 if (!opp_table->genpd_virt_devs[index])
1953                         continue;
1954
1955                 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1956                 opp_table->genpd_virt_devs[index] = NULL;
1957         }
1958
1959         kfree(opp_table->genpd_virt_devs);
1960         opp_table->genpd_virt_devs = NULL;
1961 }
1962
1963 /**
1964  * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1965  * @dev: Consumer device for which the genpd is getting attached.
1966  * @names: Null terminated array of pointers containing names of genpd to attach.
1967  * @virt_devs: Pointer to return the array of virtual devices.
1968  *
1969  * Multiple generic power domains for a device are supported with the help of
1970  * virtual genpd devices, which are created for each consumer device - genpd
1971  * pair. These are the device structures which are attached to the power domain
1972  * and are required by the OPP core to set the performance state of the genpd.
1973  * The same API also works for the case where single genpd is available and so
1974  * we don't need to support that separately.
1975  *
1976  * This helper will normally be called by the consumer driver of the device
1977  * "dev", as only that has details of the genpd names.
1978  *
1979  * This helper needs to be called once with a list of all genpd to attach.
1980  * Otherwise the original device structure will be used instead by the OPP core.
1981  *
1982  * The order of entries in the names array must match the order in which
1983  * "required-opps" are added in DT.
1984  */
1985 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
1986                 const char **names, struct device ***virt_devs)
1987 {
1988         struct opp_table *opp_table;
1989         struct device *virt_dev;
1990         int index = 0, ret = -EINVAL;
1991         const char **name = names;
1992
1993         opp_table = dev_pm_opp_get_opp_table(dev);
1994         if (IS_ERR(opp_table))
1995                 return opp_table;
1996
1997         /*
1998          * If the genpd's OPP table isn't already initialized, parsing of the
1999          * required-opps fail for dev. We should retry this after genpd's OPP
2000          * table is added.
2001          */
2002         if (!opp_table->required_opp_count) {
2003                 ret = -EPROBE_DEFER;
2004                 goto put_table;
2005         }
2006
2007         mutex_lock(&opp_table->genpd_virt_dev_lock);
2008
2009         opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
2010                                              sizeof(*opp_table->genpd_virt_devs),
2011                                              GFP_KERNEL);
2012         if (!opp_table->genpd_virt_devs)
2013                 goto unlock;
2014
2015         while (*name) {
2016                 if (index >= opp_table->required_opp_count) {
2017                         dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
2018                                 *name, opp_table->required_opp_count, index);
2019                         goto err;
2020                 }
2021
2022                 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
2023                 if (IS_ERR(virt_dev)) {
2024                         ret = PTR_ERR(virt_dev);
2025                         dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
2026                         goto err;
2027                 }
2028
2029                 opp_table->genpd_virt_devs[index] = virt_dev;
2030                 index++;
2031                 name++;
2032         }
2033
2034         if (virt_devs)
2035                 *virt_devs = opp_table->genpd_virt_devs;
2036         mutex_unlock(&opp_table->genpd_virt_dev_lock);
2037
2038         return opp_table;
2039
2040 err:
2041         _opp_detach_genpd(opp_table);
2042 unlock:
2043         mutex_unlock(&opp_table->genpd_virt_dev_lock);
2044
2045 put_table:
2046         dev_pm_opp_put_opp_table(opp_table);
2047
2048         return ERR_PTR(ret);
2049 }
2050 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
2051
2052 /**
2053  * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
2054  * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
2055  *
2056  * This detaches the genpd(s), resets the virtual device pointers, and puts the
2057  * OPP table.
2058  */
2059 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
2060 {
2061         /*
2062          * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
2063          * used in parallel.
2064          */
2065         mutex_lock(&opp_table->genpd_virt_dev_lock);
2066         _opp_detach_genpd(opp_table);
2067         mutex_unlock(&opp_table->genpd_virt_dev_lock);
2068
2069         dev_pm_opp_put_opp_table(opp_table);
2070 }
2071 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
2072
2073 /**
2074  * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
2075  * @src_table: OPP table which has dst_table as one of its required OPP table.
2076  * @dst_table: Required OPP table of the src_table.
2077  * @pstate: Current performance state of the src_table.
2078  *
2079  * This Returns pstate of the OPP (present in @dst_table) pointed out by the
2080  * "required-opps" property of the OPP (present in @src_table) which has
2081  * performance state set to @pstate.
2082  *
2083  * Return: Zero or positive performance state on success, otherwise negative
2084  * value on errors.
2085  */
2086 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
2087                                        struct opp_table *dst_table,
2088                                        unsigned int pstate)
2089 {
2090         struct dev_pm_opp *opp;
2091         int dest_pstate = -EINVAL;
2092         int i;
2093
2094         if (!pstate)
2095                 return 0;
2096
2097         /*
2098          * Normally the src_table will have the "required_opps" property set to
2099          * point to one of the OPPs in the dst_table, but in some cases the
2100          * genpd and its master have one to one mapping of performance states
2101          * and so none of them have the "required-opps" property set. Return the
2102          * pstate of the src_table as it is in such cases.
2103          */
2104         if (!src_table->required_opp_count)
2105                 return pstate;
2106
2107         for (i = 0; i < src_table->required_opp_count; i++) {
2108                 if (src_table->required_opp_tables[i]->np == dst_table->np)
2109                         break;
2110         }
2111
2112         if (unlikely(i == src_table->required_opp_count)) {
2113                 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
2114                        __func__, src_table, dst_table);
2115                 return -EINVAL;
2116         }
2117
2118         mutex_lock(&src_table->lock);
2119
2120         list_for_each_entry(opp, &src_table->opp_list, node) {
2121                 if (opp->pstate == pstate) {
2122                         dest_pstate = opp->required_opps[i]->pstate;
2123                         goto unlock;
2124                 }
2125         }
2126
2127         pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
2128                dst_table);
2129
2130 unlock:
2131         mutex_unlock(&src_table->lock);
2132
2133         return dest_pstate;
2134 }
2135
2136 /**
2137  * dev_pm_opp_add()  - Add an OPP table from a table definitions
2138  * @dev:        device for which we do this operation
2139  * @freq:       Frequency in Hz for this OPP
2140  * @u_volt:     Voltage in uVolts for this OPP
2141  *
2142  * This function adds an opp definition to the opp table and returns status.
2143  * The opp is made available by default and it can be controlled using
2144  * dev_pm_opp_enable/disable functions.
2145  *
2146  * Return:
2147  * 0            On success OR
2148  *              Duplicate OPPs (both freq and volt are same) and opp->available
2149  * -EEXIST      Freq are same and volt are different OR
2150  *              Duplicate OPPs (both freq and volt are same) and !opp->available
2151  * -ENOMEM      Memory allocation failure
2152  */
2153 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2154 {
2155         struct opp_table *opp_table;
2156         int ret;
2157
2158         opp_table = dev_pm_opp_get_opp_table(dev);
2159         if (IS_ERR(opp_table))
2160                 return PTR_ERR(opp_table);
2161
2162         /* Fix regulator count for dynamic OPPs */
2163         opp_table->regulator_count = 1;
2164
2165         ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2166         if (ret)
2167                 dev_pm_opp_put_opp_table(opp_table);
2168
2169         return ret;
2170 }
2171 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2172
2173 /**
2174  * _opp_set_availability() - helper to set the availability of an opp
2175  * @dev:                device for which we do this operation
2176  * @freq:               OPP frequency to modify availability
2177  * @availability_req:   availability status requested for this opp
2178  *
2179  * Set the availability of an OPP, opp_{enable,disable} share a common logic
2180  * which is isolated here.
2181  *
2182  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2183  * copy operation, returns 0 if no modification was done OR modification was
2184  * successful.
2185  */
2186 static int _opp_set_availability(struct device *dev, unsigned long freq,
2187                                  bool availability_req)
2188 {
2189         struct opp_table *opp_table;
2190         struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2191         int r = 0;
2192
2193         /* Find the opp_table */
2194         opp_table = _find_opp_table(dev);
2195         if (IS_ERR(opp_table)) {
2196                 r = PTR_ERR(opp_table);
2197                 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2198                 return r;
2199         }
2200
2201         mutex_lock(&opp_table->lock);
2202
2203         /* Do we have the frequency? */
2204         list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2205                 if (tmp_opp->rate == freq) {
2206                         opp = tmp_opp;
2207                         break;
2208                 }
2209         }
2210
2211         if (IS_ERR(opp)) {
2212                 r = PTR_ERR(opp);
2213                 goto unlock;
2214         }
2215
2216         /* Is update really needed? */
2217         if (opp->available == availability_req)
2218                 goto unlock;
2219
2220         opp->available = availability_req;
2221
2222         dev_pm_opp_get(opp);
2223         mutex_unlock(&opp_table->lock);
2224
2225         /* Notify the change of the OPP availability */
2226         if (availability_req)
2227                 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2228                                              opp);
2229         else
2230                 blocking_notifier_call_chain(&opp_table->head,
2231                                              OPP_EVENT_DISABLE, opp);
2232
2233         dev_pm_opp_put(opp);
2234         goto put_table;
2235
2236 unlock:
2237         mutex_unlock(&opp_table->lock);
2238 put_table:
2239         dev_pm_opp_put_opp_table(opp_table);
2240         return r;
2241 }
2242
2243 /**
2244  * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2245  * @dev:                device for which we do this operation
2246  * @freq:               OPP frequency to adjust voltage of
2247  * @u_volt:             new OPP target voltage
2248  * @u_volt_min:         new OPP min voltage
2249  * @u_volt_max:         new OPP max voltage
2250  *
2251  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2252  * copy operation, returns 0 if no modifcation was done OR modification was
2253  * successful.
2254  */
2255 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2256                               unsigned long u_volt, unsigned long u_volt_min,
2257                               unsigned long u_volt_max)
2258
2259 {
2260         struct opp_table *opp_table;
2261         struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2262         int r = 0;
2263
2264         /* Find the opp_table */
2265         opp_table = _find_opp_table(dev);
2266         if (IS_ERR(opp_table)) {
2267                 r = PTR_ERR(opp_table);
2268                 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2269                 return r;
2270         }
2271
2272         mutex_lock(&opp_table->lock);
2273
2274         /* Do we have the frequency? */
2275         list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2276                 if (tmp_opp->rate == freq) {
2277                         opp = tmp_opp;
2278                         break;
2279                 }
2280         }
2281
2282         if (IS_ERR(opp)) {
2283                 r = PTR_ERR(opp);
2284                 goto adjust_unlock;
2285         }
2286
2287         /* Is update really needed? */
2288         if (opp->supplies->u_volt == u_volt)
2289                 goto adjust_unlock;
2290
2291         opp->supplies->u_volt = u_volt;
2292         opp->supplies->u_volt_min = u_volt_min;
2293         opp->supplies->u_volt_max = u_volt_max;
2294
2295         dev_pm_opp_get(opp);
2296         mutex_unlock(&opp_table->lock);
2297
2298         /* Notify the voltage change of the OPP */
2299         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2300                                      opp);
2301
2302         dev_pm_opp_put(opp);
2303         goto adjust_put_table;
2304
2305 adjust_unlock:
2306         mutex_unlock(&opp_table->lock);
2307 adjust_put_table:
2308         dev_pm_opp_put_opp_table(opp_table);
2309         return r;
2310 }
2311 EXPORT_SYMBOL_GPL(dev_pm_opp_adjust_voltage);
2312
2313 /**
2314  * dev_pm_opp_enable() - Enable a specific OPP
2315  * @dev:        device for which we do this operation
2316  * @freq:       OPP frequency to enable
2317  *
2318  * Enables a provided opp. If the operation is valid, this returns 0, else the
2319  * corresponding error value. It is meant to be used for users an OPP available
2320  * after being temporarily made unavailable with dev_pm_opp_disable.
2321  *
2322  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2323  * copy operation, returns 0 if no modification was done OR modification was
2324  * successful.
2325  */
2326 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2327 {
2328         return _opp_set_availability(dev, freq, true);
2329 }
2330 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2331
2332 /**
2333  * dev_pm_opp_disable() - Disable a specific OPP
2334  * @dev:        device for which we do this operation
2335  * @freq:       OPP frequency to disable
2336  *
2337  * Disables a provided opp. If the operation is valid, this returns
2338  * 0, else the corresponding error value. It is meant to be a temporary
2339  * control by users to make this OPP not available until the circumstances are
2340  * right to make it available again (with a call to dev_pm_opp_enable).
2341  *
2342  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2343  * copy operation, returns 0 if no modification was done OR modification was
2344  * successful.
2345  */
2346 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2347 {
2348         return _opp_set_availability(dev, freq, false);
2349 }
2350 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2351
2352 /**
2353  * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2354  * @dev:        Device for which notifier needs to be registered
2355  * @nb:         Notifier block to be registered
2356  *
2357  * Return: 0 on success or a negative error value.
2358  */
2359 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2360 {
2361         struct opp_table *opp_table;
2362         int ret;
2363
2364         opp_table = _find_opp_table(dev);
2365         if (IS_ERR(opp_table))
2366                 return PTR_ERR(opp_table);
2367
2368         ret = blocking_notifier_chain_register(&opp_table->head, nb);
2369
2370         dev_pm_opp_put_opp_table(opp_table);
2371
2372         return ret;
2373 }
2374 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2375
2376 /**
2377  * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2378  * @dev:        Device for which notifier needs to be unregistered
2379  * @nb:         Notifier block to be unregistered
2380  *
2381  * Return: 0 on success or a negative error value.
2382  */
2383 int dev_pm_opp_unregister_notifier(struct device *dev,
2384                                    struct notifier_block *nb)
2385 {
2386         struct opp_table *opp_table;
2387         int ret;
2388
2389         opp_table = _find_opp_table(dev);
2390         if (IS_ERR(opp_table))
2391                 return PTR_ERR(opp_table);
2392
2393         ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2394
2395         dev_pm_opp_put_opp_table(opp_table);
2396
2397         return ret;
2398 }
2399 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2400
2401 /**
2402  * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2403  * @dev:        device pointer used to lookup OPP table.
2404  *
2405  * Free both OPPs created using static entries present in DT and the
2406  * dynamically added entries.
2407  */
2408 void dev_pm_opp_remove_table(struct device *dev)
2409 {
2410         struct opp_table *opp_table;
2411
2412         /* Check for existing table for 'dev' */
2413         opp_table = _find_opp_table(dev);
2414         if (IS_ERR(opp_table)) {
2415                 int error = PTR_ERR(opp_table);
2416
2417                 if (error != -ENODEV)
2418                         WARN(1, "%s: opp_table: %d\n",
2419                              IS_ERR_OR_NULL(dev) ?
2420                                         "Invalid device" : dev_name(dev),
2421                              error);
2422                 return;
2423         }
2424
2425         _opp_remove_all_static(opp_table);
2426
2427         /* Drop reference taken by _find_opp_table() */
2428         dev_pm_opp_put_opp_table(opp_table);
2429
2430         /* Drop reference taken while the OPP table was added */
2431         dev_pm_opp_put_opp_table(opp_table);
2432 }
2433 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);