opp: Allow dev_pm_opp_get_opp_table() to return -EPROBE_DEFER
[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->regulator_enabled)) {
707                 ret = regulator_enable(reg);
708                 if (ret < 0)
709                         dev_warn(dev, "Failed to enable regulator: %d", ret);
710                 else
711                         opp_table->regulator_enabled = true;
712         }
713
714         return 0;
715
716 restore_freq:
717         if (_generic_set_opp_clk_only(dev, opp_table->clk, old_freq))
718                 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
719                         __func__, old_freq);
720 restore_voltage:
721         /* This shouldn't harm even if the voltages weren't updated earlier */
722         if (old_supply)
723                 _set_opp_voltage(dev, reg, old_supply);
724
725         return ret;
726 }
727
728 static int _set_opp_bw(const struct opp_table *opp_table,
729                        struct dev_pm_opp *opp, struct device *dev, bool remove)
730 {
731         u32 avg, peak;
732         int i, ret;
733
734         if (!opp_table->paths)
735                 return 0;
736
737         for (i = 0; i < opp_table->path_count; i++) {
738                 if (remove) {
739                         avg = 0;
740                         peak = 0;
741                 } else {
742                         avg = opp->bandwidth[i].avg;
743                         peak = opp->bandwidth[i].peak;
744                 }
745                 ret = icc_set_bw(opp_table->paths[i], avg, peak);
746                 if (ret) {
747                         dev_err(dev, "Failed to %s bandwidth[%d]: %d\n",
748                                 remove ? "remove" : "set", i, ret);
749                         return ret;
750                 }
751         }
752
753         return 0;
754 }
755
756 static int _set_opp_custom(const struct opp_table *opp_table,
757                            struct device *dev, unsigned long old_freq,
758                            unsigned long freq,
759                            struct dev_pm_opp_supply *old_supply,
760                            struct dev_pm_opp_supply *new_supply)
761 {
762         struct dev_pm_set_opp_data *data;
763         int size;
764
765         data = opp_table->set_opp_data;
766         data->regulators = opp_table->regulators;
767         data->regulator_count = opp_table->regulator_count;
768         data->clk = opp_table->clk;
769         data->dev = dev;
770
771         data->old_opp.rate = old_freq;
772         size = sizeof(*old_supply) * opp_table->regulator_count;
773         if (!old_supply)
774                 memset(data->old_opp.supplies, 0, size);
775         else
776                 memcpy(data->old_opp.supplies, old_supply, size);
777
778         data->new_opp.rate = freq;
779         memcpy(data->new_opp.supplies, new_supply, size);
780
781         return opp_table->set_opp(data);
782 }
783
784 /* This is only called for PM domain for now */
785 static int _set_required_opps(struct device *dev,
786                               struct opp_table *opp_table,
787                               struct dev_pm_opp *opp)
788 {
789         struct opp_table **required_opp_tables = opp_table->required_opp_tables;
790         struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
791         unsigned int pstate;
792         int i, ret = 0;
793
794         if (!required_opp_tables)
795                 return 0;
796
797         /* Single genpd case */
798         if (!genpd_virt_devs) {
799                 pstate = likely(opp) ? opp->required_opps[0]->pstate : 0;
800                 ret = dev_pm_genpd_set_performance_state(dev, pstate);
801                 if (ret) {
802                         dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
803                                 dev_name(dev), pstate, ret);
804                 }
805                 return ret;
806         }
807
808         /* Multiple genpd case */
809
810         /*
811          * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
812          * after it is freed from another thread.
813          */
814         mutex_lock(&opp_table->genpd_virt_dev_lock);
815
816         for (i = 0; i < opp_table->required_opp_count; i++) {
817                 pstate = likely(opp) ? opp->required_opps[i]->pstate : 0;
818
819                 if (!genpd_virt_devs[i])
820                         continue;
821
822                 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
823                 if (ret) {
824                         dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
825                                 dev_name(genpd_virt_devs[i]), pstate, ret);
826                         break;
827                 }
828         }
829         mutex_unlock(&opp_table->genpd_virt_dev_lock);
830
831         return ret;
832 }
833
834 /**
835  * dev_pm_opp_set_bw() - sets bandwidth levels corresponding to an opp
836  * @dev:        device for which we do this operation
837  * @opp:        opp based on which the bandwidth levels are to be configured
838  *
839  * This configures the bandwidth to the levels specified by the OPP. However
840  * if the OPP specified is NULL the bandwidth levels are cleared out.
841  *
842  * Return: 0 on success or a negative error value.
843  */
844 int dev_pm_opp_set_bw(struct device *dev, struct dev_pm_opp *opp)
845 {
846         struct opp_table *opp_table;
847         int ret;
848
849         opp_table = _find_opp_table(dev);
850         if (IS_ERR(opp_table)) {
851                 dev_err(dev, "%s: device opp table doesn't exist\n", __func__);
852                 return PTR_ERR(opp_table);
853         }
854
855         if (opp)
856                 ret = _set_opp_bw(opp_table, opp, dev, false);
857         else
858                 ret = _set_opp_bw(opp_table, NULL, dev, true);
859
860         dev_pm_opp_put_opp_table(opp_table);
861         return ret;
862 }
863 EXPORT_SYMBOL_GPL(dev_pm_opp_set_bw);
864
865 /**
866  * dev_pm_opp_set_rate() - Configure new OPP based on frequency
867  * @dev:         device for which we do this operation
868  * @target_freq: frequency to achieve
869  *
870  * This configures the power-supplies to the levels specified by the OPP
871  * corresponding to the target_freq, and programs the clock to a value <=
872  * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
873  * provided by the opp, should have already rounded to the target OPP's
874  * frequency.
875  */
876 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
877 {
878         struct opp_table *opp_table;
879         unsigned long freq, old_freq, temp_freq;
880         struct dev_pm_opp *old_opp, *opp;
881         struct clk *clk;
882         int ret;
883
884         opp_table = _find_opp_table(dev);
885         if (IS_ERR(opp_table)) {
886                 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
887                 return PTR_ERR(opp_table);
888         }
889
890         if (unlikely(!target_freq)) {
891                 /*
892                  * Some drivers need to support cases where some platforms may
893                  * have OPP table for the device, while others don't and
894                  * opp_set_rate() just needs to behave like clk_set_rate().
895                  */
896                 if (!_get_opp_count(opp_table))
897                         return 0;
898
899                 if (!opp_table->required_opp_tables && !opp_table->regulators &&
900                     !opp_table->paths) {
901                         dev_err(dev, "target frequency can't be 0\n");
902                         ret = -EINVAL;
903                         goto put_opp_table;
904                 }
905
906                 ret = _set_opp_bw(opp_table, NULL, dev, true);
907                 if (ret)
908                         return ret;
909
910                 if (opp_table->regulator_enabled) {
911                         regulator_disable(opp_table->regulators[0]);
912                         opp_table->regulator_enabled = false;
913                 }
914
915                 ret = _set_required_opps(dev, opp_table, NULL);
916                 goto put_opp_table;
917         }
918
919         clk = opp_table->clk;
920         if (IS_ERR(clk)) {
921                 dev_err(dev, "%s: No clock available for the device\n",
922                         __func__);
923                 ret = PTR_ERR(clk);
924                 goto put_opp_table;
925         }
926
927         freq = clk_round_rate(clk, target_freq);
928         if ((long)freq <= 0)
929                 freq = target_freq;
930
931         old_freq = clk_get_rate(clk);
932
933         /* Return early if nothing to do */
934         if (old_freq == freq) {
935                 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
936                         __func__, freq);
937                 ret = 0;
938                 goto put_opp_table;
939         }
940
941         /*
942          * For IO devices which require an OPP on some platforms/SoCs
943          * while just needing to scale the clock on some others
944          * we look for empty OPP tables with just a clock handle and
945          * scale only the clk. This makes dev_pm_opp_set_rate()
946          * equivalent to a clk_set_rate()
947          */
948         if (!_get_opp_count(opp_table)) {
949                 ret = _generic_set_opp_clk_only(dev, clk, freq);
950                 goto put_opp_table;
951         }
952
953         temp_freq = old_freq;
954         old_opp = _find_freq_ceil(opp_table, &temp_freq);
955         if (IS_ERR(old_opp)) {
956                 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
957                         __func__, old_freq, PTR_ERR(old_opp));
958         }
959
960         temp_freq = freq;
961         opp = _find_freq_ceil(opp_table, &temp_freq);
962         if (IS_ERR(opp)) {
963                 ret = PTR_ERR(opp);
964                 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
965                         __func__, freq, ret);
966                 goto put_old_opp;
967         }
968
969         dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
970                 old_freq, freq);
971
972         /* Scaling up? Configure required OPPs before frequency */
973         if (freq >= old_freq) {
974                 ret = _set_required_opps(dev, opp_table, opp);
975                 if (ret)
976                         goto put_opp;
977         }
978
979         if (opp_table->set_opp) {
980                 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
981                                       IS_ERR(old_opp) ? NULL : old_opp->supplies,
982                                       opp->supplies);
983         } else if (opp_table->regulators) {
984                 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
985                                                  IS_ERR(old_opp) ? NULL : old_opp->supplies,
986                                                  opp->supplies);
987         } else {
988                 /* Only frequency scaling */
989                 ret = _generic_set_opp_clk_only(dev, clk, freq);
990         }
991
992         /* Scaling down? Configure required OPPs after frequency */
993         if (!ret && freq < old_freq) {
994                 ret = _set_required_opps(dev, opp_table, opp);
995                 if (ret)
996                         dev_err(dev, "Failed to set required opps: %d\n", ret);
997         }
998
999         if (!ret)
1000                 ret = _set_opp_bw(opp_table, opp, dev, false);
1001
1002 put_opp:
1003         dev_pm_opp_put(opp);
1004 put_old_opp:
1005         if (!IS_ERR(old_opp))
1006                 dev_pm_opp_put(old_opp);
1007 put_opp_table:
1008         dev_pm_opp_put_opp_table(opp_table);
1009         return ret;
1010 }
1011 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
1012
1013 /* OPP-dev Helpers */
1014 static void _remove_opp_dev(struct opp_device *opp_dev,
1015                             struct opp_table *opp_table)
1016 {
1017         opp_debug_unregister(opp_dev, opp_table);
1018         list_del(&opp_dev->node);
1019         kfree(opp_dev);
1020 }
1021
1022 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
1023                                                 struct opp_table *opp_table)
1024 {
1025         struct opp_device *opp_dev;
1026
1027         opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
1028         if (!opp_dev)
1029                 return NULL;
1030
1031         /* Initialize opp-dev */
1032         opp_dev->dev = dev;
1033
1034         list_add(&opp_dev->node, &opp_table->dev_list);
1035
1036         /* Create debugfs entries for the opp_table */
1037         opp_debug_register(opp_dev, opp_table);
1038
1039         return opp_dev;
1040 }
1041
1042 struct opp_device *_add_opp_dev(const struct device *dev,
1043                                 struct opp_table *opp_table)
1044 {
1045         struct opp_device *opp_dev;
1046
1047         mutex_lock(&opp_table->lock);
1048         opp_dev = _add_opp_dev_unlocked(dev, opp_table);
1049         mutex_unlock(&opp_table->lock);
1050
1051         return opp_dev;
1052 }
1053
1054 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
1055 {
1056         struct opp_table *opp_table;
1057         struct opp_device *opp_dev;
1058         int ret;
1059
1060         /*
1061          * Allocate a new OPP table. In the infrequent case where a new
1062          * device is needed to be added, we pay this penalty.
1063          */
1064         opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
1065         if (!opp_table)
1066                 return ERR_PTR(-ENOMEM);
1067
1068         mutex_init(&opp_table->lock);
1069         mutex_init(&opp_table->genpd_virt_dev_lock);
1070         INIT_LIST_HEAD(&opp_table->dev_list);
1071
1072         /* Mark regulator count uninitialized */
1073         opp_table->regulator_count = -1;
1074
1075         opp_dev = _add_opp_dev(dev, opp_table);
1076         if (!opp_dev) {
1077                 ret = -ENOMEM;
1078                 goto err;
1079         }
1080
1081         _of_init_opp_table(opp_table, dev, index);
1082
1083         /* Find clk for the device */
1084         opp_table->clk = clk_get(dev, NULL);
1085         if (IS_ERR(opp_table->clk)) {
1086                 ret = PTR_ERR(opp_table->clk);
1087                 if (ret == -EPROBE_DEFER)
1088                         goto err;
1089
1090                 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__, ret);
1091         }
1092
1093         /* Find interconnect path(s) for the device */
1094         ret = dev_pm_opp_of_find_icc_paths(dev, opp_table);
1095         if (ret) {
1096                 if (ret == -EPROBE_DEFER)
1097                         goto err;
1098
1099                 dev_warn(dev, "%s: Error finding interconnect paths: %d\n",
1100                          __func__, ret);
1101         }
1102
1103         BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
1104         INIT_LIST_HEAD(&opp_table->opp_list);
1105         kref_init(&opp_table->kref);
1106
1107         /* Secure the device table modification */
1108         list_add(&opp_table->node, &opp_tables);
1109         return opp_table;
1110
1111 err:
1112         kfree(opp_table);
1113         return ERR_PTR(ret);
1114 }
1115
1116 void _get_opp_table_kref(struct opp_table *opp_table)
1117 {
1118         kref_get(&opp_table->kref);
1119 }
1120
1121 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
1122 {
1123         struct opp_table *opp_table;
1124
1125         /* Hold our table modification lock here */
1126         mutex_lock(&opp_table_lock);
1127
1128         opp_table = _find_opp_table_unlocked(dev);
1129         if (!IS_ERR(opp_table))
1130                 goto unlock;
1131
1132         opp_table = _managed_opp(dev, index);
1133         if (opp_table) {
1134                 if (!_add_opp_dev_unlocked(dev, opp_table)) {
1135                         dev_pm_opp_put_opp_table(opp_table);
1136                         opp_table = ERR_PTR(-ENOMEM);
1137                 }
1138                 goto unlock;
1139         }
1140
1141         opp_table = _allocate_opp_table(dev, index);
1142
1143 unlock:
1144         mutex_unlock(&opp_table_lock);
1145
1146         return opp_table;
1147 }
1148
1149 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1150 {
1151         return _opp_get_opp_table(dev, 0);
1152 }
1153 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1154
1155 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
1156                                                    int index)
1157 {
1158         return _opp_get_opp_table(dev, index);
1159 }
1160
1161 static void _opp_table_kref_release(struct kref *kref)
1162 {
1163         struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1164         struct opp_device *opp_dev, *temp;
1165         int i;
1166
1167         _of_clear_opp_table(opp_table);
1168
1169         /* Release clk */
1170         if (!IS_ERR(opp_table->clk))
1171                 clk_put(opp_table->clk);
1172
1173         if (opp_table->paths) {
1174                 for (i = 0; i < opp_table->path_count; i++)
1175                         icc_put(opp_table->paths[i]);
1176                 kfree(opp_table->paths);
1177         }
1178
1179         WARN_ON(!list_empty(&opp_table->opp_list));
1180
1181         list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1182                 /*
1183                  * The OPP table is getting removed, drop the performance state
1184                  * constraints.
1185                  */
1186                 if (opp_table->genpd_performance_state)
1187                         dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1188
1189                 _remove_opp_dev(opp_dev, opp_table);
1190         }
1191
1192         mutex_destroy(&opp_table->genpd_virt_dev_lock);
1193         mutex_destroy(&opp_table->lock);
1194         list_del(&opp_table->node);
1195         kfree(opp_table);
1196
1197         mutex_unlock(&opp_table_lock);
1198 }
1199
1200 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1201 {
1202         kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1203                        &opp_table_lock);
1204 }
1205 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1206
1207 void _opp_free(struct dev_pm_opp *opp)
1208 {
1209         kfree(opp);
1210 }
1211
1212 static void _opp_kref_release(struct dev_pm_opp *opp,
1213                               struct opp_table *opp_table)
1214 {
1215         /*
1216          * Notify the changes in the availability of the operable
1217          * frequency/voltage list.
1218          */
1219         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1220         _of_opp_free_required_opps(opp_table, opp);
1221         opp_debug_remove_one(opp);
1222         list_del(&opp->node);
1223         kfree(opp);
1224 }
1225
1226 static void _opp_kref_release_unlocked(struct kref *kref)
1227 {
1228         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1229         struct opp_table *opp_table = opp->opp_table;
1230
1231         _opp_kref_release(opp, opp_table);
1232 }
1233
1234 static void _opp_kref_release_locked(struct kref *kref)
1235 {
1236         struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1237         struct opp_table *opp_table = opp->opp_table;
1238
1239         _opp_kref_release(opp, opp_table);
1240         mutex_unlock(&opp_table->lock);
1241 }
1242
1243 void dev_pm_opp_get(struct dev_pm_opp *opp)
1244 {
1245         kref_get(&opp->kref);
1246 }
1247
1248 void dev_pm_opp_put(struct dev_pm_opp *opp)
1249 {
1250         kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1251                        &opp->opp_table->lock);
1252 }
1253 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1254
1255 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1256 {
1257         kref_put(&opp->kref, _opp_kref_release_unlocked);
1258 }
1259
1260 /**
1261  * dev_pm_opp_remove()  - Remove an OPP from OPP table
1262  * @dev:        device for which we do this operation
1263  * @freq:       OPP to remove with matching 'freq'
1264  *
1265  * This function removes an opp from the opp table.
1266  */
1267 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1268 {
1269         struct dev_pm_opp *opp;
1270         struct opp_table *opp_table;
1271         bool found = false;
1272
1273         opp_table = _find_opp_table(dev);
1274         if (IS_ERR(opp_table))
1275                 return;
1276
1277         mutex_lock(&opp_table->lock);
1278
1279         list_for_each_entry(opp, &opp_table->opp_list, node) {
1280                 if (opp->rate == freq) {
1281                         found = true;
1282                         break;
1283                 }
1284         }
1285
1286         mutex_unlock(&opp_table->lock);
1287
1288         if (found) {
1289                 dev_pm_opp_put(opp);
1290
1291                 /* Drop the reference taken by dev_pm_opp_add() */
1292                 dev_pm_opp_put_opp_table(opp_table);
1293         } else {
1294                 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1295                          __func__, freq);
1296         }
1297
1298         /* Drop the reference taken by _find_opp_table() */
1299         dev_pm_opp_put_opp_table(opp_table);
1300 }
1301 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1302
1303 void _opp_remove_all_static(struct opp_table *opp_table)
1304 {
1305         struct dev_pm_opp *opp, *tmp;
1306
1307         mutex_lock(&opp_table->lock);
1308
1309         if (!opp_table->parsed_static_opps || --opp_table->parsed_static_opps)
1310                 goto unlock;
1311
1312         list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1313                 if (!opp->dynamic)
1314                         dev_pm_opp_put_unlocked(opp);
1315         }
1316
1317 unlock:
1318         mutex_unlock(&opp_table->lock);
1319 }
1320
1321 /**
1322  * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1323  * @dev:        device for which we do this operation
1324  *
1325  * This function removes all dynamically created OPPs from the opp table.
1326  */
1327 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1328 {
1329         struct opp_table *opp_table;
1330         struct dev_pm_opp *opp, *temp;
1331         int count = 0;
1332
1333         opp_table = _find_opp_table(dev);
1334         if (IS_ERR(opp_table))
1335                 return;
1336
1337         mutex_lock(&opp_table->lock);
1338         list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1339                 if (opp->dynamic) {
1340                         dev_pm_opp_put_unlocked(opp);
1341                         count++;
1342                 }
1343         }
1344         mutex_unlock(&opp_table->lock);
1345
1346         /* Drop the references taken by dev_pm_opp_add() */
1347         while (count--)
1348                 dev_pm_opp_put_opp_table(opp_table);
1349
1350         /* Drop the reference taken by _find_opp_table() */
1351         dev_pm_opp_put_opp_table(opp_table);
1352 }
1353 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1354
1355 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1356 {
1357         struct dev_pm_opp *opp;
1358         int supply_count, supply_size, icc_size;
1359
1360         /* Allocate space for at least one supply */
1361         supply_count = table->regulator_count > 0 ? table->regulator_count : 1;
1362         supply_size = sizeof(*opp->supplies) * supply_count;
1363         icc_size = sizeof(*opp->bandwidth) * table->path_count;
1364
1365         /* allocate new OPP node and supplies structures */
1366         opp = kzalloc(sizeof(*opp) + supply_size + icc_size, GFP_KERNEL);
1367
1368         if (!opp)
1369                 return NULL;
1370
1371         /* Put the supplies at the end of the OPP structure as an empty array */
1372         opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1373         if (icc_size)
1374                 opp->bandwidth = (struct dev_pm_opp_icc_bw *)(opp->supplies + supply_count);
1375         INIT_LIST_HEAD(&opp->node);
1376
1377         return opp;
1378 }
1379
1380 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1381                                          struct opp_table *opp_table)
1382 {
1383         struct regulator *reg;
1384         int i;
1385
1386         if (!opp_table->regulators)
1387                 return true;
1388
1389         for (i = 0; i < opp_table->regulator_count; i++) {
1390                 reg = opp_table->regulators[i];
1391
1392                 if (!regulator_is_supported_voltage(reg,
1393                                         opp->supplies[i].u_volt_min,
1394                                         opp->supplies[i].u_volt_max)) {
1395                         pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1396                                 __func__, opp->supplies[i].u_volt_min,
1397                                 opp->supplies[i].u_volt_max);
1398                         return false;
1399                 }
1400         }
1401
1402         return true;
1403 }
1404
1405 int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2)
1406 {
1407         if (opp1->rate != opp2->rate)
1408                 return opp1->rate < opp2->rate ? -1 : 1;
1409         if (opp1->bandwidth && opp2->bandwidth &&
1410             opp1->bandwidth[0].peak != opp2->bandwidth[0].peak)
1411                 return opp1->bandwidth[0].peak < opp2->bandwidth[0].peak ? -1 : 1;
1412         if (opp1->level != opp2->level)
1413                 return opp1->level < opp2->level ? -1 : 1;
1414         return 0;
1415 }
1416
1417 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1418                              struct opp_table *opp_table,
1419                              struct list_head **head)
1420 {
1421         struct dev_pm_opp *opp;
1422         int opp_cmp;
1423
1424         /*
1425          * Insert new OPP in order of increasing frequency and discard if
1426          * already present.
1427          *
1428          * Need to use &opp_table->opp_list in the condition part of the 'for'
1429          * loop, don't replace it with head otherwise it will become an infinite
1430          * loop.
1431          */
1432         list_for_each_entry(opp, &opp_table->opp_list, node) {
1433                 opp_cmp = _opp_compare_key(new_opp, opp);
1434                 if (opp_cmp > 0) {
1435                         *head = &opp->node;
1436                         continue;
1437                 }
1438
1439                 if (opp_cmp < 0)
1440                         return 0;
1441
1442                 /* Duplicate OPPs */
1443                 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1444                          __func__, opp->rate, opp->supplies[0].u_volt,
1445                          opp->available, new_opp->rate,
1446                          new_opp->supplies[0].u_volt, new_opp->available);
1447
1448                 /* Should we compare voltages for all regulators here ? */
1449                 return opp->available &&
1450                        new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1451         }
1452
1453         return 0;
1454 }
1455
1456 /*
1457  * Returns:
1458  * 0: On success. And appropriate error message for duplicate OPPs.
1459  * -EBUSY: For OPP with same freq/volt and is available. The callers of
1460  *  _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1461  *  sure we don't print error messages unnecessarily if different parts of
1462  *  kernel try to initialize the OPP table.
1463  * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1464  *  should be considered an error by the callers of _opp_add().
1465  */
1466 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1467              struct opp_table *opp_table, bool rate_not_available)
1468 {
1469         struct list_head *head;
1470         int ret;
1471
1472         mutex_lock(&opp_table->lock);
1473         head = &opp_table->opp_list;
1474
1475         if (likely(!rate_not_available)) {
1476                 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1477                 if (ret) {
1478                         mutex_unlock(&opp_table->lock);
1479                         return ret;
1480                 }
1481         }
1482
1483         list_add(&new_opp->node, head);
1484         mutex_unlock(&opp_table->lock);
1485
1486         new_opp->opp_table = opp_table;
1487         kref_init(&new_opp->kref);
1488
1489         opp_debug_create_one(new_opp, opp_table);
1490
1491         if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1492                 new_opp->available = false;
1493                 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1494                          __func__, new_opp->rate);
1495         }
1496
1497         return 0;
1498 }
1499
1500 /**
1501  * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1502  * @opp_table:  OPP table
1503  * @dev:        device for which we do this operation
1504  * @freq:       Frequency in Hz for this OPP
1505  * @u_volt:     Voltage in uVolts for this OPP
1506  * @dynamic:    Dynamically added OPPs.
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 and may be removed by dev_pm_opp_remove.
1511  *
1512  * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1513  * and freed by dev_pm_opp_of_remove_table.
1514  *
1515  * Return:
1516  * 0            On success OR
1517  *              Duplicate OPPs (both freq and volt are same) and opp->available
1518  * -EEXIST      Freq are same and volt are different OR
1519  *              Duplicate OPPs (both freq and volt are same) and !opp->available
1520  * -ENOMEM      Memory allocation failure
1521  */
1522 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1523                 unsigned long freq, long u_volt, bool dynamic)
1524 {
1525         struct dev_pm_opp *new_opp;
1526         unsigned long tol;
1527         int ret;
1528
1529         new_opp = _opp_allocate(opp_table);
1530         if (!new_opp)
1531                 return -ENOMEM;
1532
1533         /* populate the opp table */
1534         new_opp->rate = freq;
1535         tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1536         new_opp->supplies[0].u_volt = u_volt;
1537         new_opp->supplies[0].u_volt_min = u_volt - tol;
1538         new_opp->supplies[0].u_volt_max = u_volt + tol;
1539         new_opp->available = true;
1540         new_opp->dynamic = dynamic;
1541
1542         ret = _opp_add(dev, new_opp, opp_table, false);
1543         if (ret) {
1544                 /* Don't return error for duplicate OPPs */
1545                 if (ret == -EBUSY)
1546                         ret = 0;
1547                 goto free_opp;
1548         }
1549
1550         /*
1551          * Notify the changes in the availability of the operable
1552          * frequency/voltage list.
1553          */
1554         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1555         return 0;
1556
1557 free_opp:
1558         _opp_free(new_opp);
1559
1560         return ret;
1561 }
1562
1563 /**
1564  * dev_pm_opp_set_supported_hw() - Set supported platforms
1565  * @dev: Device for which supported-hw has to be set.
1566  * @versions: Array of hierarchy of versions to match.
1567  * @count: Number of elements in the array.
1568  *
1569  * This is required only for the V2 bindings, and it enables a platform to
1570  * specify the hierarchy of versions it supports. OPP layer will then enable
1571  * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1572  * property.
1573  */
1574 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1575                         const u32 *versions, unsigned int count)
1576 {
1577         struct opp_table *opp_table;
1578
1579         opp_table = dev_pm_opp_get_opp_table(dev);
1580         if (IS_ERR(opp_table))
1581                 return opp_table;
1582
1583         /* Make sure there are no concurrent readers while updating opp_table */
1584         WARN_ON(!list_empty(&opp_table->opp_list));
1585
1586         /* Another CPU that shares the OPP table has set the property ? */
1587         if (opp_table->supported_hw)
1588                 return opp_table;
1589
1590         opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1591                                         GFP_KERNEL);
1592         if (!opp_table->supported_hw) {
1593                 dev_pm_opp_put_opp_table(opp_table);
1594                 return ERR_PTR(-ENOMEM);
1595         }
1596
1597         opp_table->supported_hw_count = count;
1598
1599         return opp_table;
1600 }
1601 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1602
1603 /**
1604  * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1605  * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1606  *
1607  * This is required only for the V2 bindings, and is called for a matching
1608  * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1609  * will not be freed.
1610  */
1611 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1612 {
1613         /* Make sure there are no concurrent readers while updating opp_table */
1614         WARN_ON(!list_empty(&opp_table->opp_list));
1615
1616         kfree(opp_table->supported_hw);
1617         opp_table->supported_hw = NULL;
1618         opp_table->supported_hw_count = 0;
1619
1620         dev_pm_opp_put_opp_table(opp_table);
1621 }
1622 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1623
1624 /**
1625  * dev_pm_opp_set_prop_name() - Set prop-extn name
1626  * @dev: Device for which the prop-name has to be set.
1627  * @name: name to postfix to properties.
1628  *
1629  * This is required only for the V2 bindings, and it enables a platform to
1630  * specify the extn to be used for certain property names. The properties to
1631  * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1632  * should postfix the property name with -<name> while looking for them.
1633  */
1634 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1635 {
1636         struct opp_table *opp_table;
1637
1638         opp_table = dev_pm_opp_get_opp_table(dev);
1639         if (IS_ERR(opp_table))
1640                 return opp_table;
1641
1642         /* Make sure there are no concurrent readers while updating opp_table */
1643         WARN_ON(!list_empty(&opp_table->opp_list));
1644
1645         /* Another CPU that shares the OPP table has set the property ? */
1646         if (opp_table->prop_name)
1647                 return opp_table;
1648
1649         opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1650         if (!opp_table->prop_name) {
1651                 dev_pm_opp_put_opp_table(opp_table);
1652                 return ERR_PTR(-ENOMEM);
1653         }
1654
1655         return opp_table;
1656 }
1657 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1658
1659 /**
1660  * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1661  * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1662  *
1663  * This is required only for the V2 bindings, and is called for a matching
1664  * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1665  * will not be freed.
1666  */
1667 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1668 {
1669         /* Make sure there are no concurrent readers while updating opp_table */
1670         WARN_ON(!list_empty(&opp_table->opp_list));
1671
1672         kfree(opp_table->prop_name);
1673         opp_table->prop_name = NULL;
1674
1675         dev_pm_opp_put_opp_table(opp_table);
1676 }
1677 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1678
1679 static int _allocate_set_opp_data(struct opp_table *opp_table)
1680 {
1681         struct dev_pm_set_opp_data *data;
1682         int len, count = opp_table->regulator_count;
1683
1684         if (WARN_ON(!opp_table->regulators))
1685                 return -EINVAL;
1686
1687         /* space for set_opp_data */
1688         len = sizeof(*data);
1689
1690         /* space for old_opp.supplies and new_opp.supplies */
1691         len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1692
1693         data = kzalloc(len, GFP_KERNEL);
1694         if (!data)
1695                 return -ENOMEM;
1696
1697         data->old_opp.supplies = (void *)(data + 1);
1698         data->new_opp.supplies = data->old_opp.supplies + count;
1699
1700         opp_table->set_opp_data = data;
1701
1702         return 0;
1703 }
1704
1705 static void _free_set_opp_data(struct opp_table *opp_table)
1706 {
1707         kfree(opp_table->set_opp_data);
1708         opp_table->set_opp_data = NULL;
1709 }
1710
1711 /**
1712  * dev_pm_opp_set_regulators() - Set regulator names for the device
1713  * @dev: Device for which regulator name is being set.
1714  * @names: Array of pointers to the names of the regulator.
1715  * @count: Number of regulators.
1716  *
1717  * In order to support OPP switching, OPP layer needs to know the name of the
1718  * device's regulators, as the core would be required to switch voltages as
1719  * well.
1720  *
1721  * This must be called before any OPPs are initialized for the device.
1722  */
1723 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1724                                             const char * const names[],
1725                                             unsigned int count)
1726 {
1727         struct opp_table *opp_table;
1728         struct regulator *reg;
1729         int ret, i;
1730
1731         opp_table = dev_pm_opp_get_opp_table(dev);
1732         if (IS_ERR(opp_table))
1733                 return opp_table;
1734
1735         /* This should be called before OPPs are initialized */
1736         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1737                 ret = -EBUSY;
1738                 goto err;
1739         }
1740
1741         /* Another CPU that shares the OPP table has set the regulators ? */
1742         if (opp_table->regulators)
1743                 return opp_table;
1744
1745         opp_table->regulators = kmalloc_array(count,
1746                                               sizeof(*opp_table->regulators),
1747                                               GFP_KERNEL);
1748         if (!opp_table->regulators) {
1749                 ret = -ENOMEM;
1750                 goto err;
1751         }
1752
1753         for (i = 0; i < count; i++) {
1754                 reg = regulator_get_optional(dev, names[i]);
1755                 if (IS_ERR(reg)) {
1756                         ret = PTR_ERR(reg);
1757                         if (ret != -EPROBE_DEFER)
1758                                 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1759                                         __func__, names[i], ret);
1760                         goto free_regulators;
1761                 }
1762
1763                 opp_table->regulators[i] = reg;
1764         }
1765
1766         opp_table->regulator_count = count;
1767
1768         /* Allocate block only once to pass to set_opp() routines */
1769         ret = _allocate_set_opp_data(opp_table);
1770         if (ret)
1771                 goto free_regulators;
1772
1773         return opp_table;
1774
1775 free_regulators:
1776         while (i != 0)
1777                 regulator_put(opp_table->regulators[--i]);
1778
1779         kfree(opp_table->regulators);
1780         opp_table->regulators = NULL;
1781         opp_table->regulator_count = -1;
1782 err:
1783         dev_pm_opp_put_opp_table(opp_table);
1784
1785         return ERR_PTR(ret);
1786 }
1787 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1788
1789 /**
1790  * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1791  * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1792  */
1793 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1794 {
1795         int i;
1796
1797         if (!opp_table->regulators)
1798                 goto put_opp_table;
1799
1800         /* Make sure there are no concurrent readers while updating opp_table */
1801         WARN_ON(!list_empty(&opp_table->opp_list));
1802
1803         if (opp_table->regulator_enabled) {
1804                 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1805                         regulator_disable(opp_table->regulators[i]);
1806
1807                 opp_table->regulator_enabled = false;
1808         }
1809
1810         for (i = opp_table->regulator_count - 1; i >= 0; i--)
1811                 regulator_put(opp_table->regulators[i]);
1812
1813         _free_set_opp_data(opp_table);
1814
1815         kfree(opp_table->regulators);
1816         opp_table->regulators = NULL;
1817         opp_table->regulator_count = -1;
1818
1819 put_opp_table:
1820         dev_pm_opp_put_opp_table(opp_table);
1821 }
1822 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1823
1824 /**
1825  * dev_pm_opp_set_clkname() - Set clk name for the device
1826  * @dev: Device for which clk name is being set.
1827  * @name: Clk name.
1828  *
1829  * In order to support OPP switching, OPP layer needs to get pointer to the
1830  * clock for the device. Simple cases work fine without using this routine (i.e.
1831  * by passing connection-id as NULL), but for a device with multiple clocks
1832  * available, the OPP core needs to know the exact name of the clk to use.
1833  *
1834  * This must be called before any OPPs are initialized for the device.
1835  */
1836 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1837 {
1838         struct opp_table *opp_table;
1839         int ret;
1840
1841         opp_table = dev_pm_opp_get_opp_table(dev);
1842         if (IS_ERR(opp_table))
1843                 return opp_table;
1844
1845         /* This should be called before OPPs are initialized */
1846         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1847                 ret = -EBUSY;
1848                 goto err;
1849         }
1850
1851         /* Already have default clk set, free it */
1852         if (!IS_ERR(opp_table->clk))
1853                 clk_put(opp_table->clk);
1854
1855         /* Find clk for the device */
1856         opp_table->clk = clk_get(dev, name);
1857         if (IS_ERR(opp_table->clk)) {
1858                 ret = PTR_ERR(opp_table->clk);
1859                 if (ret != -EPROBE_DEFER) {
1860                         dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1861                                 ret);
1862                 }
1863                 goto err;
1864         }
1865
1866         return opp_table;
1867
1868 err:
1869         dev_pm_opp_put_opp_table(opp_table);
1870
1871         return ERR_PTR(ret);
1872 }
1873 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1874
1875 /**
1876  * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1877  * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1878  */
1879 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1880 {
1881         /* Make sure there are no concurrent readers while updating opp_table */
1882         WARN_ON(!list_empty(&opp_table->opp_list));
1883
1884         clk_put(opp_table->clk);
1885         opp_table->clk = ERR_PTR(-EINVAL);
1886
1887         dev_pm_opp_put_opp_table(opp_table);
1888 }
1889 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1890
1891 /**
1892  * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1893  * @dev: Device for which the helper is getting registered.
1894  * @set_opp: Custom set OPP helper.
1895  *
1896  * This is useful to support complex platforms (like platforms with multiple
1897  * regulators per device), instead of the generic OPP set rate helper.
1898  *
1899  * This must be called before any OPPs are initialized for the device.
1900  */
1901 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1902                         int (*set_opp)(struct dev_pm_set_opp_data *data))
1903 {
1904         struct opp_table *opp_table;
1905
1906         if (!set_opp)
1907                 return ERR_PTR(-EINVAL);
1908
1909         opp_table = dev_pm_opp_get_opp_table(dev);
1910         if (!IS_ERR(opp_table))
1911                 return opp_table;
1912
1913         /* This should be called before OPPs are initialized */
1914         if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1915                 dev_pm_opp_put_opp_table(opp_table);
1916                 return ERR_PTR(-EBUSY);
1917         }
1918
1919         /* Another CPU that shares the OPP table has set the helper ? */
1920         if (!opp_table->set_opp)
1921                 opp_table->set_opp = set_opp;
1922
1923         return opp_table;
1924 }
1925 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1926
1927 /**
1928  * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1929  *                                         set_opp helper
1930  * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1931  *
1932  * Release resources blocked for platform specific set_opp helper.
1933  */
1934 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1935 {
1936         /* Make sure there are no concurrent readers while updating opp_table */
1937         WARN_ON(!list_empty(&opp_table->opp_list));
1938
1939         opp_table->set_opp = NULL;
1940         dev_pm_opp_put_opp_table(opp_table);
1941 }
1942 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1943
1944 static void _opp_detach_genpd(struct opp_table *opp_table)
1945 {
1946         int index;
1947
1948         for (index = 0; index < opp_table->required_opp_count; index++) {
1949                 if (!opp_table->genpd_virt_devs[index])
1950                         continue;
1951
1952                 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1953                 opp_table->genpd_virt_devs[index] = NULL;
1954         }
1955
1956         kfree(opp_table->genpd_virt_devs);
1957         opp_table->genpd_virt_devs = NULL;
1958 }
1959
1960 /**
1961  * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1962  * @dev: Consumer device for which the genpd is getting attached.
1963  * @names: Null terminated array of pointers containing names of genpd to attach.
1964  * @virt_devs: Pointer to return the array of virtual devices.
1965  *
1966  * Multiple generic power domains for a device are supported with the help of
1967  * virtual genpd devices, which are created for each consumer device - genpd
1968  * pair. These are the device structures which are attached to the power domain
1969  * and are required by the OPP core to set the performance state of the genpd.
1970  * The same API also works for the case where single genpd is available and so
1971  * we don't need to support that separately.
1972  *
1973  * This helper will normally be called by the consumer driver of the device
1974  * "dev", as only that has details of the genpd names.
1975  *
1976  * This helper needs to be called once with a list of all genpd to attach.
1977  * Otherwise the original device structure will be used instead by the OPP core.
1978  *
1979  * The order of entries in the names array must match the order in which
1980  * "required-opps" are added in DT.
1981  */
1982 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
1983                 const char **names, struct device ***virt_devs)
1984 {
1985         struct opp_table *opp_table;
1986         struct device *virt_dev;
1987         int index = 0, ret = -EINVAL;
1988         const char **name = names;
1989
1990         opp_table = dev_pm_opp_get_opp_table(dev);
1991         if (IS_ERR(opp_table))
1992                 return opp_table;
1993
1994         /*
1995          * If the genpd's OPP table isn't already initialized, parsing of the
1996          * required-opps fail for dev. We should retry this after genpd's OPP
1997          * table is added.
1998          */
1999         if (!opp_table->required_opp_count) {
2000                 ret = -EPROBE_DEFER;
2001                 goto put_table;
2002         }
2003
2004         mutex_lock(&opp_table->genpd_virt_dev_lock);
2005
2006         opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
2007                                              sizeof(*opp_table->genpd_virt_devs),
2008                                              GFP_KERNEL);
2009         if (!opp_table->genpd_virt_devs)
2010                 goto unlock;
2011
2012         while (*name) {
2013                 if (index >= opp_table->required_opp_count) {
2014                         dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
2015                                 *name, opp_table->required_opp_count, index);
2016                         goto err;
2017                 }
2018
2019                 if (opp_table->genpd_virt_devs[index]) {
2020                         dev_err(dev, "Genpd virtual device already set %s\n",
2021                                 *name);
2022                         goto err;
2023                 }
2024
2025                 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
2026                 if (IS_ERR(virt_dev)) {
2027                         ret = PTR_ERR(virt_dev);
2028                         dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
2029                         goto err;
2030                 }
2031
2032                 opp_table->genpd_virt_devs[index] = virt_dev;
2033                 index++;
2034                 name++;
2035         }
2036
2037         if (virt_devs)
2038                 *virt_devs = opp_table->genpd_virt_devs;
2039         mutex_unlock(&opp_table->genpd_virt_dev_lock);
2040
2041         return opp_table;
2042
2043 err:
2044         _opp_detach_genpd(opp_table);
2045 unlock:
2046         mutex_unlock(&opp_table->genpd_virt_dev_lock);
2047
2048 put_table:
2049         dev_pm_opp_put_opp_table(opp_table);
2050
2051         return ERR_PTR(ret);
2052 }
2053 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
2054
2055 /**
2056  * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
2057  * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
2058  *
2059  * This detaches the genpd(s), resets the virtual device pointers, and puts the
2060  * OPP table.
2061  */
2062 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
2063 {
2064         /*
2065          * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
2066          * used in parallel.
2067          */
2068         mutex_lock(&opp_table->genpd_virt_dev_lock);
2069         _opp_detach_genpd(opp_table);
2070         mutex_unlock(&opp_table->genpd_virt_dev_lock);
2071
2072         dev_pm_opp_put_opp_table(opp_table);
2073 }
2074 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
2075
2076 /**
2077  * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
2078  * @src_table: OPP table which has dst_table as one of its required OPP table.
2079  * @dst_table: Required OPP table of the src_table.
2080  * @pstate: Current performance state of the src_table.
2081  *
2082  * This Returns pstate of the OPP (present in @dst_table) pointed out by the
2083  * "required-opps" property of the OPP (present in @src_table) which has
2084  * performance state set to @pstate.
2085  *
2086  * Return: Zero or positive performance state on success, otherwise negative
2087  * value on errors.
2088  */
2089 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
2090                                        struct opp_table *dst_table,
2091                                        unsigned int pstate)
2092 {
2093         struct dev_pm_opp *opp;
2094         int dest_pstate = -EINVAL;
2095         int i;
2096
2097         if (!pstate)
2098                 return 0;
2099
2100         /*
2101          * Normally the src_table will have the "required_opps" property set to
2102          * point to one of the OPPs in the dst_table, but in some cases the
2103          * genpd and its master have one to one mapping of performance states
2104          * and so none of them have the "required-opps" property set. Return the
2105          * pstate of the src_table as it is in such cases.
2106          */
2107         if (!src_table->required_opp_count)
2108                 return pstate;
2109
2110         for (i = 0; i < src_table->required_opp_count; i++) {
2111                 if (src_table->required_opp_tables[i]->np == dst_table->np)
2112                         break;
2113         }
2114
2115         if (unlikely(i == src_table->required_opp_count)) {
2116                 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
2117                        __func__, src_table, dst_table);
2118                 return -EINVAL;
2119         }
2120
2121         mutex_lock(&src_table->lock);
2122
2123         list_for_each_entry(opp, &src_table->opp_list, node) {
2124                 if (opp->pstate == pstate) {
2125                         dest_pstate = opp->required_opps[i]->pstate;
2126                         goto unlock;
2127                 }
2128         }
2129
2130         pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
2131                dst_table);
2132
2133 unlock:
2134         mutex_unlock(&src_table->lock);
2135
2136         return dest_pstate;
2137 }
2138
2139 /**
2140  * dev_pm_opp_add()  - Add an OPP table from a table definitions
2141  * @dev:        device for which we do this operation
2142  * @freq:       Frequency in Hz for this OPP
2143  * @u_volt:     Voltage in uVolts for this OPP
2144  *
2145  * This function adds an opp definition to the opp table and returns status.
2146  * The opp is made available by default and it can be controlled using
2147  * dev_pm_opp_enable/disable functions.
2148  *
2149  * Return:
2150  * 0            On success OR
2151  *              Duplicate OPPs (both freq and volt are same) and opp->available
2152  * -EEXIST      Freq are same and volt are different OR
2153  *              Duplicate OPPs (both freq and volt are same) and !opp->available
2154  * -ENOMEM      Memory allocation failure
2155  */
2156 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2157 {
2158         struct opp_table *opp_table;
2159         int ret;
2160
2161         opp_table = dev_pm_opp_get_opp_table(dev);
2162         if (IS_ERR(opp_table))
2163                 return PTR_ERR(opp_table);
2164
2165         /* Fix regulator count for dynamic OPPs */
2166         opp_table->regulator_count = 1;
2167
2168         ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2169         if (ret)
2170                 dev_pm_opp_put_opp_table(opp_table);
2171
2172         return ret;
2173 }
2174 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2175
2176 /**
2177  * _opp_set_availability() - helper to set the availability of an opp
2178  * @dev:                device for which we do this operation
2179  * @freq:               OPP frequency to modify availability
2180  * @availability_req:   availability status requested for this opp
2181  *
2182  * Set the availability of an OPP, opp_{enable,disable} share a common logic
2183  * which is isolated here.
2184  *
2185  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2186  * copy operation, returns 0 if no modification was done OR modification was
2187  * successful.
2188  */
2189 static int _opp_set_availability(struct device *dev, unsigned long freq,
2190                                  bool availability_req)
2191 {
2192         struct opp_table *opp_table;
2193         struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2194         int r = 0;
2195
2196         /* Find the opp_table */
2197         opp_table = _find_opp_table(dev);
2198         if (IS_ERR(opp_table)) {
2199                 r = PTR_ERR(opp_table);
2200                 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2201                 return r;
2202         }
2203
2204         mutex_lock(&opp_table->lock);
2205
2206         /* Do we have the frequency? */
2207         list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2208                 if (tmp_opp->rate == freq) {
2209                         opp = tmp_opp;
2210                         break;
2211                 }
2212         }
2213
2214         if (IS_ERR(opp)) {
2215                 r = PTR_ERR(opp);
2216                 goto unlock;
2217         }
2218
2219         /* Is update really needed? */
2220         if (opp->available == availability_req)
2221                 goto unlock;
2222
2223         opp->available = availability_req;
2224
2225         dev_pm_opp_get(opp);
2226         mutex_unlock(&opp_table->lock);
2227
2228         /* Notify the change of the OPP availability */
2229         if (availability_req)
2230                 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2231                                              opp);
2232         else
2233                 blocking_notifier_call_chain(&opp_table->head,
2234                                              OPP_EVENT_DISABLE, opp);
2235
2236         dev_pm_opp_put(opp);
2237         goto put_table;
2238
2239 unlock:
2240         mutex_unlock(&opp_table->lock);
2241 put_table:
2242         dev_pm_opp_put_opp_table(opp_table);
2243         return r;
2244 }
2245
2246 /**
2247  * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2248  * @dev:                device for which we do this operation
2249  * @freq:               OPP frequency to adjust voltage of
2250  * @u_volt:             new OPP target voltage
2251  * @u_volt_min:         new OPP min voltage
2252  * @u_volt_max:         new OPP max voltage
2253  *
2254  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2255  * copy operation, returns 0 if no modifcation was done OR modification was
2256  * successful.
2257  */
2258 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2259                               unsigned long u_volt, unsigned long u_volt_min,
2260                               unsigned long u_volt_max)
2261
2262 {
2263         struct opp_table *opp_table;
2264         struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2265         int r = 0;
2266
2267         /* Find the opp_table */
2268         opp_table = _find_opp_table(dev);
2269         if (IS_ERR(opp_table)) {
2270                 r = PTR_ERR(opp_table);
2271                 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2272                 return r;
2273         }
2274
2275         mutex_lock(&opp_table->lock);
2276
2277         /* Do we have the frequency? */
2278         list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2279                 if (tmp_opp->rate == freq) {
2280                         opp = tmp_opp;
2281                         break;
2282                 }
2283         }
2284
2285         if (IS_ERR(opp)) {
2286                 r = PTR_ERR(opp);
2287                 goto adjust_unlock;
2288         }
2289
2290         /* Is update really needed? */
2291         if (opp->supplies->u_volt == u_volt)
2292                 goto adjust_unlock;
2293
2294         opp->supplies->u_volt = u_volt;
2295         opp->supplies->u_volt_min = u_volt_min;
2296         opp->supplies->u_volt_max = u_volt_max;
2297
2298         dev_pm_opp_get(opp);
2299         mutex_unlock(&opp_table->lock);
2300
2301         /* Notify the voltage change of the OPP */
2302         blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2303                                      opp);
2304
2305         dev_pm_opp_put(opp);
2306         goto adjust_put_table;
2307
2308 adjust_unlock:
2309         mutex_unlock(&opp_table->lock);
2310 adjust_put_table:
2311         dev_pm_opp_put_opp_table(opp_table);
2312         return r;
2313 }
2314 EXPORT_SYMBOL_GPL(dev_pm_opp_adjust_voltage);
2315
2316 /**
2317  * dev_pm_opp_enable() - Enable a specific OPP
2318  * @dev:        device for which we do this operation
2319  * @freq:       OPP frequency to enable
2320  *
2321  * Enables a provided opp. If the operation is valid, this returns 0, else the
2322  * corresponding error value. It is meant to be used for users an OPP available
2323  * after being temporarily made unavailable with dev_pm_opp_disable.
2324  *
2325  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2326  * copy operation, returns 0 if no modification was done OR modification was
2327  * successful.
2328  */
2329 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2330 {
2331         return _opp_set_availability(dev, freq, true);
2332 }
2333 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2334
2335 /**
2336  * dev_pm_opp_disable() - Disable a specific OPP
2337  * @dev:        device for which we do this operation
2338  * @freq:       OPP frequency to disable
2339  *
2340  * Disables a provided opp. If the operation is valid, this returns
2341  * 0, else the corresponding error value. It is meant to be a temporary
2342  * control by users to make this OPP not available until the circumstances are
2343  * right to make it available again (with a call to dev_pm_opp_enable).
2344  *
2345  * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2346  * copy operation, returns 0 if no modification was done OR modification was
2347  * successful.
2348  */
2349 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2350 {
2351         return _opp_set_availability(dev, freq, false);
2352 }
2353 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2354
2355 /**
2356  * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2357  * @dev:        Device for which notifier needs to be registered
2358  * @nb:         Notifier block to be registered
2359  *
2360  * Return: 0 on success or a negative error value.
2361  */
2362 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2363 {
2364         struct opp_table *opp_table;
2365         int ret;
2366
2367         opp_table = _find_opp_table(dev);
2368         if (IS_ERR(opp_table))
2369                 return PTR_ERR(opp_table);
2370
2371         ret = blocking_notifier_chain_register(&opp_table->head, nb);
2372
2373         dev_pm_opp_put_opp_table(opp_table);
2374
2375         return ret;
2376 }
2377 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2378
2379 /**
2380  * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2381  * @dev:        Device for which notifier needs to be unregistered
2382  * @nb:         Notifier block to be unregistered
2383  *
2384  * Return: 0 on success or a negative error value.
2385  */
2386 int dev_pm_opp_unregister_notifier(struct device *dev,
2387                                    struct notifier_block *nb)
2388 {
2389         struct opp_table *opp_table;
2390         int ret;
2391
2392         opp_table = _find_opp_table(dev);
2393         if (IS_ERR(opp_table))
2394                 return PTR_ERR(opp_table);
2395
2396         ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2397
2398         dev_pm_opp_put_opp_table(opp_table);
2399
2400         return ret;
2401 }
2402 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2403
2404 void _dev_pm_opp_find_and_remove_table(struct device *dev)
2405 {
2406         struct opp_table *opp_table;
2407
2408         /* Check for existing table for 'dev' */
2409         opp_table = _find_opp_table(dev);
2410         if (IS_ERR(opp_table)) {
2411                 int error = PTR_ERR(opp_table);
2412
2413                 if (error != -ENODEV)
2414                         WARN(1, "%s: opp_table: %d\n",
2415                              IS_ERR_OR_NULL(dev) ?
2416                                         "Invalid device" : dev_name(dev),
2417                              error);
2418                 return;
2419         }
2420
2421         _opp_remove_all_static(opp_table);
2422
2423         /* Drop reference taken by _find_opp_table() */
2424         dev_pm_opp_put_opp_table(opp_table);
2425
2426         /* Drop reference taken while the OPP table was added */
2427         dev_pm_opp_put_opp_table(opp_table);
2428 }
2429
2430 /**
2431  * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2432  * @dev:        device pointer used to lookup OPP table.
2433  *
2434  * Free both OPPs created using static entries present in DT and the
2435  * dynamically added entries.
2436  */
2437 void dev_pm_opp_remove_table(struct device *dev)
2438 {
2439         _dev_pm_opp_find_and_remove_table(dev);
2440 }
2441 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);