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