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