1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic OPP Interface
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
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.
29 LIST_HEAD(opp_tables);
30 /* Lock to allow exclusive modification to the device and opp lists */
31 DEFINE_MUTEX(opp_table_lock);
33 static struct opp_device *_find_opp_dev(const struct device *dev,
34 struct opp_table *opp_table)
36 struct opp_device *opp_dev;
38 list_for_each_entry(opp_dev, &opp_table->dev_list, node)
39 if (opp_dev->dev == dev)
45 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
47 struct opp_table *opp_table;
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);
56 _get_opp_table_kref(opp_table);
62 return ERR_PTR(-ENODEV);
66 * _find_opp_table() - find opp_table struct using device pointer
67 * @dev: device pointer used to lookup OPP table
69 * Search OPP table for one containing matching device.
71 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
72 * -EINVAL based on type of error.
74 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
76 struct opp_table *_find_opp_table(struct device *dev)
78 struct opp_table *opp_table;
80 if (IS_ERR_OR_NULL(dev)) {
81 pr_err("%s: Invalid parameters\n", __func__);
82 return ERR_PTR(-EINVAL);
85 mutex_lock(&opp_table_lock);
86 opp_table = _find_opp_table_unlocked(dev);
87 mutex_unlock(&opp_table_lock);
93 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
94 * @opp: opp for which voltage has to be returned for
96 * Return: voltage in micro volt corresponding to the opp, else
99 * This is useful only for devices with single power supply.
101 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
103 if (IS_ERR_OR_NULL(opp)) {
104 pr_err("%s: Invalid parameters\n", __func__);
108 return opp->supplies[0].u_volt;
110 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
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
116 * Return: frequency in hertz corresponding to the opp, else
119 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
121 if (IS_ERR_OR_NULL(opp)) {
122 pr_err("%s: Invalid parameters\n", __func__);
128 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
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
134 * Return: level read from device tree corresponding to the opp, else
137 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
139 if (IS_ERR_OR_NULL(opp) || !opp->available) {
140 pr_err("%s: Invalid parameters\n", __func__);
146 EXPORT_SYMBOL_GPL(dev_pm_opp_get_level);
149 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
150 * @opp: opp for which turbo mode is being verified
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.
156 * Return: true if opp is turbo opp, else false.
158 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
160 if (IS_ERR_OR_NULL(opp) || !opp->available) {
161 pr_err("%s: Invalid parameters\n", __func__);
167 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
170 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
171 * @dev: device for which we do this operation
173 * Return: This function returns the max clock latency in nanoseconds.
175 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
177 struct opp_table *opp_table;
178 unsigned long clock_latency_ns;
180 opp_table = _find_opp_table(dev);
181 if (IS_ERR(opp_table))
184 clock_latency_ns = opp_table->clock_latency_ns_max;
186 dev_pm_opp_put_opp_table(opp_table);
188 return clock_latency_ns;
190 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
193 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
194 * @dev: device for which we do this operation
196 * Return: This function returns the max voltage latency in nanoseconds.
198 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
200 struct opp_table *opp_table;
201 struct dev_pm_opp *opp;
202 struct regulator *reg;
203 unsigned long latency_ns = 0;
210 opp_table = _find_opp_table(dev);
211 if (IS_ERR(opp_table))
214 /* Regulator may not be required for the device */
215 if (!opp_table->regulators)
218 count = opp_table->regulator_count;
220 uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
224 mutex_lock(&opp_table->lock);
226 for (i = 0; i < count; i++) {
230 list_for_each_entry(opp, &opp_table->opp_list, node) {
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;
241 mutex_unlock(&opp_table->lock);
244 * The caller needs to ensure that opp_table (and hence the regulator)
245 * isn't freed, while we are executing this routine.
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);
251 latency_ns += ret * 1000;
256 dev_pm_opp_put_opp_table(opp_table);
260 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
263 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
265 * @dev: device for which we do this operation
267 * Return: This function returns the max transition latency, in nanoseconds, to
268 * switch from one OPP to other.
270 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
272 return dev_pm_opp_get_max_volt_latency(dev) +
273 dev_pm_opp_get_max_clock_latency(dev);
275 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
278 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
279 * @dev: device for which we do this operation
281 * Return: This function returns the frequency of the OPP marked as suspend_opp
282 * if one is available, else returns 0;
284 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
286 struct opp_table *opp_table;
287 unsigned long freq = 0;
289 opp_table = _find_opp_table(dev);
290 if (IS_ERR(opp_table))
293 if (opp_table->suspend_opp && opp_table->suspend_opp->available)
294 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
296 dev_pm_opp_put_opp_table(opp_table);
300 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
302 int _get_opp_count(struct opp_table *opp_table)
304 struct dev_pm_opp *opp;
307 mutex_lock(&opp_table->lock);
309 list_for_each_entry(opp, &opp_table->opp_list, node) {
314 mutex_unlock(&opp_table->lock);
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
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.
326 int dev_pm_opp_get_opp_count(struct device *dev)
328 struct opp_table *opp_table;
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",
339 count = _get_opp_count(opp_table);
340 dev_pm_opp_put_opp_table(opp_table);
344 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
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
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
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.
363 * This provides a mechanism to enable an opp which is not available currently
364 * or the opposite as well.
366 * The callers are required to call dev_pm_opp_put() for the returned OPP after
369 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
373 struct opp_table *opp_table;
374 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
376 opp_table = _find_opp_table(dev);
377 if (IS_ERR(opp_table)) {
378 int r = PTR_ERR(opp_table);
380 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
384 mutex_lock(&opp_table->lock);
386 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
387 if (temp_opp->available == available &&
388 temp_opp->rate == freq) {
391 /* Increment the reference count of OPP */
397 mutex_unlock(&opp_table->lock);
398 dev_pm_opp_put_opp_table(opp_table);
402 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
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
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
416 * The callers are required to call dev_pm_opp_put() for the returned OPP after
419 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
422 struct opp_table *opp_table;
423 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
425 opp_table = _find_opp_table(dev);
426 if (IS_ERR(opp_table)) {
427 int r = PTR_ERR(opp_table);
429 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
433 mutex_lock(&opp_table->lock);
435 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
436 if (temp_opp->level == level) {
439 /* Increment the reference count of OPP */
445 mutex_unlock(&opp_table->lock);
446 dev_pm_opp_put_opp_table(opp_table);
450 EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_exact);
452 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
455 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
457 mutex_lock(&opp_table->lock);
459 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
460 if (temp_opp->available && temp_opp->rate >= *freq) {
464 /* Increment the reference count of OPP */
470 mutex_unlock(&opp_table->lock);
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
480 * Search for the matching ceil *available* OPP from a starting freq
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
486 * EINVAL: for bad pointer
487 * ERANGE: no match found for search
488 * ENODEV: if device not found in list of registered devices
490 * The callers are required to call dev_pm_opp_put() for the returned OPP after
493 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
496 struct opp_table *opp_table;
497 struct dev_pm_opp *opp;
500 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
501 return ERR_PTR(-EINVAL);
504 opp_table = _find_opp_table(dev);
505 if (IS_ERR(opp_table))
506 return ERR_CAST(opp_table);
508 opp = _find_freq_ceil(opp_table, freq);
510 dev_pm_opp_put_opp_table(opp_table);
514 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
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
521 * Search for the matching floor *available* OPP from a starting freq
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
527 * EINVAL: for bad pointer
528 * ERANGE: no match found for search
529 * ENODEV: if device not found in list of registered devices
531 * The callers are required to call dev_pm_opp_put() for the returned OPP after
534 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
537 struct opp_table *opp_table;
538 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
541 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
542 return ERR_PTR(-EINVAL);
545 opp_table = _find_opp_table(dev);
546 if (IS_ERR(opp_table))
547 return ERR_CAST(opp_table);
549 mutex_lock(&opp_table->lock);
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)
561 /* Increment the reference count of OPP */
564 mutex_unlock(&opp_table->lock);
565 dev_pm_opp_put_opp_table(opp_table);
572 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
575 * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
577 * @dev: Device for which we do this operation.
578 * @u_volt: Target voltage.
580 * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
582 * Return: matching *opp, else returns ERR_PTR in case of error which should be
583 * handled using IS_ERR.
585 * Error return values can be:
586 * EINVAL: bad parameters
588 * The callers are required to call dev_pm_opp_put() for the returned OPP after
591 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
592 unsigned long u_volt)
594 struct opp_table *opp_table;
595 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
597 if (!dev || !u_volt) {
598 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
600 return ERR_PTR(-EINVAL);
603 opp_table = _find_opp_table(dev);
604 if (IS_ERR(opp_table))
605 return ERR_CAST(opp_table);
607 mutex_lock(&opp_table->lock);
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)
617 /* Increment the reference count of OPP */
621 mutex_unlock(&opp_table->lock);
622 dev_pm_opp_put_opp_table(opp_table);
626 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
628 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
629 struct dev_pm_opp_supply *supply)
633 /* Regulator not available for device */
635 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
640 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
641 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
643 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
644 supply->u_volt, supply->u_volt_max);
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);
653 static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
658 ret = clk_set_rate(clk, freq);
660 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
667 static int _generic_set_opp_regulator(struct opp_table *opp_table,
669 unsigned long old_freq,
671 struct dev_pm_opp_supply *old_supply,
672 struct dev_pm_opp_supply *new_supply)
674 struct regulator *reg = opp_table->regulators[0];
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");
683 /* Scaling up? Scale voltage before frequency */
684 if (freq >= old_freq) {
685 ret = _set_opp_voltage(dev, reg, new_supply);
687 goto restore_voltage;
690 /* Change frequency */
691 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
693 goto restore_voltage;
695 /* Scaling down? Scale voltage after frequency */
696 if (freq < old_freq) {
697 ret = _set_opp_voltage(dev, reg, new_supply);
703 * Enable the regulator after setting its voltages, otherwise it breaks
704 * some boot-enabled regulators.
706 if (unlikely(!opp_table->regulator_enabled)) {
707 ret = regulator_enable(reg);
709 dev_warn(dev, "Failed to enable regulator: %d", ret);
711 opp_table->regulator_enabled = true;
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",
721 /* This shouldn't harm even if the voltages weren't updated earlier */
723 _set_opp_voltage(dev, reg, old_supply);
728 static int _set_opp_bw(const struct opp_table *opp_table,
729 struct dev_pm_opp *opp, struct device *dev, bool remove)
734 if (!opp_table->paths)
737 for (i = 0; i < opp_table->path_count; i++) {
742 avg = opp->bandwidth[i].avg;
743 peak = opp->bandwidth[i].peak;
745 ret = icc_set_bw(opp_table->paths[i], avg, peak);
747 dev_err(dev, "Failed to %s bandwidth[%d]: %d\n",
748 remove ? "remove" : "set", i, ret);
756 static int _set_opp_custom(const struct opp_table *opp_table,
757 struct device *dev, unsigned long old_freq,
759 struct dev_pm_opp_supply *old_supply,
760 struct dev_pm_opp_supply *new_supply)
762 struct dev_pm_set_opp_data *data;
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;
771 data->old_opp.rate = old_freq;
772 size = sizeof(*old_supply) * opp_table->regulator_count;
774 memset(data->old_opp.supplies, 0, size);
776 memcpy(data->old_opp.supplies, old_supply, size);
778 data->new_opp.rate = freq;
779 memcpy(data->new_opp.supplies, new_supply, size);
781 return opp_table->set_opp(data);
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)
789 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
790 struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
794 if (!required_opp_tables)
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);
802 dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
803 dev_name(dev), pstate, ret);
808 /* Multiple genpd case */
811 * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
812 * after it is freed from another thread.
814 mutex_lock(&opp_table->genpd_virt_dev_lock);
816 for (i = 0; i < opp_table->required_opp_count; i++) {
817 pstate = likely(opp) ? opp->required_opps[i]->pstate : 0;
819 if (!genpd_virt_devs[i])
822 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
824 dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
825 dev_name(genpd_virt_devs[i]), pstate, ret);
829 mutex_unlock(&opp_table->genpd_virt_dev_lock);
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
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.
842 * Return: 0 on success or a negative error value.
844 int dev_pm_opp_set_bw(struct device *dev, struct dev_pm_opp *opp)
846 struct opp_table *opp_table;
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);
856 ret = _set_opp_bw(opp_table, opp, dev, false);
858 ret = _set_opp_bw(opp_table, NULL, dev, true);
860 dev_pm_opp_put_opp_table(opp_table);
863 EXPORT_SYMBOL_GPL(dev_pm_opp_set_bw);
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
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
876 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
878 struct opp_table *opp_table;
879 unsigned long freq, old_freq, temp_freq;
880 struct dev_pm_opp *old_opp, *opp;
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);
890 if (unlikely(!target_freq)) {
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().
896 if (!_get_opp_count(opp_table))
899 if (!opp_table->required_opp_tables && !opp_table->regulators &&
901 dev_err(dev, "target frequency can't be 0\n");
906 ret = _set_opp_bw(opp_table, NULL, dev, true);
910 if (opp_table->regulator_enabled) {
911 regulator_disable(opp_table->regulators[0]);
912 opp_table->regulator_enabled = false;
915 ret = _set_required_opps(dev, opp_table, NULL);
919 clk = opp_table->clk;
921 dev_err(dev, "%s: No clock available for the device\n",
927 freq = clk_round_rate(clk, target_freq);
931 old_freq = clk_get_rate(clk);
933 /* Return early if nothing to do */
934 if (old_freq == freq) {
935 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
942 * For IO devices which require an OPP on some platforms/SoCs
943 * while just needing to scale the clock on some others
944 * we look for empty OPP tables with just a clock handle and
945 * scale only the clk. This makes dev_pm_opp_set_rate()
946 * equivalent to a clk_set_rate()
948 if (!_get_opp_count(opp_table)) {
949 ret = _generic_set_opp_clk_only(dev, clk, freq);
953 temp_freq = old_freq;
954 old_opp = _find_freq_ceil(opp_table, &temp_freq);
955 if (IS_ERR(old_opp)) {
956 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
957 __func__, old_freq, PTR_ERR(old_opp));
961 opp = _find_freq_ceil(opp_table, &temp_freq);
964 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
965 __func__, freq, ret);
969 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
972 /* Scaling up? Configure required OPPs before frequency */
973 if (freq >= old_freq) {
974 ret = _set_required_opps(dev, opp_table, opp);
979 if (opp_table->set_opp) {
980 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
981 IS_ERR(old_opp) ? NULL : old_opp->supplies,
983 } else if (opp_table->regulators) {
984 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
985 IS_ERR(old_opp) ? NULL : old_opp->supplies,
988 /* Only frequency scaling */
989 ret = _generic_set_opp_clk_only(dev, clk, freq);
992 /* Scaling down? Configure required OPPs after frequency */
993 if (!ret && freq < old_freq) {
994 ret = _set_required_opps(dev, opp_table, opp);
996 dev_err(dev, "Failed to set required opps: %d\n", ret);
1000 ret = _set_opp_bw(opp_table, opp, dev, false);
1003 dev_pm_opp_put(opp);
1005 if (!IS_ERR(old_opp))
1006 dev_pm_opp_put(old_opp);
1008 dev_pm_opp_put_opp_table(opp_table);
1011 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
1013 /* OPP-dev Helpers */
1014 static void _remove_opp_dev(struct opp_device *opp_dev,
1015 struct opp_table *opp_table)
1017 opp_debug_unregister(opp_dev, opp_table);
1018 list_del(&opp_dev->node);
1022 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
1023 struct opp_table *opp_table)
1025 struct opp_device *opp_dev;
1027 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
1031 /* Initialize opp-dev */
1034 list_add(&opp_dev->node, &opp_table->dev_list);
1036 /* Create debugfs entries for the opp_table */
1037 opp_debug_register(opp_dev, opp_table);
1042 struct opp_device *_add_opp_dev(const struct device *dev,
1043 struct opp_table *opp_table)
1045 struct opp_device *opp_dev;
1047 mutex_lock(&opp_table->lock);
1048 opp_dev = _add_opp_dev_unlocked(dev, opp_table);
1049 mutex_unlock(&opp_table->lock);
1054 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
1056 struct opp_table *opp_table;
1057 struct opp_device *opp_dev;
1061 * Allocate a new OPP table. In the infrequent case where a new
1062 * device is needed to be added, we pay this penalty.
1064 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
1066 return ERR_PTR(-ENOMEM);
1068 mutex_init(&opp_table->lock);
1069 mutex_init(&opp_table->genpd_virt_dev_lock);
1070 INIT_LIST_HEAD(&opp_table->dev_list);
1072 /* Mark regulator count uninitialized */
1073 opp_table->regulator_count = -1;
1075 opp_dev = _add_opp_dev(dev, opp_table);
1081 _of_init_opp_table(opp_table, dev, index);
1083 /* Find clk for the device */
1084 opp_table->clk = clk_get(dev, NULL);
1085 if (IS_ERR(opp_table->clk)) {
1086 ret = PTR_ERR(opp_table->clk);
1087 if (ret == -EPROBE_DEFER)
1090 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__, ret);
1093 /* Find interconnect path(s) for the device */
1094 ret = dev_pm_opp_of_find_icc_paths(dev, opp_table);
1096 if (ret == -EPROBE_DEFER)
1099 dev_warn(dev, "%s: Error finding interconnect paths: %d\n",
1103 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
1104 INIT_LIST_HEAD(&opp_table->opp_list);
1105 kref_init(&opp_table->kref);
1107 /* Secure the device table modification */
1108 list_add(&opp_table->node, &opp_tables);
1113 return ERR_PTR(ret);
1116 void _get_opp_table_kref(struct opp_table *opp_table)
1118 kref_get(&opp_table->kref);
1121 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
1123 struct opp_table *opp_table;
1125 /* Hold our table modification lock here */
1126 mutex_lock(&opp_table_lock);
1128 opp_table = _find_opp_table_unlocked(dev);
1129 if (!IS_ERR(opp_table))
1132 opp_table = _managed_opp(dev, index);
1134 if (!_add_opp_dev_unlocked(dev, opp_table)) {
1135 dev_pm_opp_put_opp_table(opp_table);
1136 opp_table = ERR_PTR(-ENOMEM);
1141 opp_table = _allocate_opp_table(dev, index);
1144 mutex_unlock(&opp_table_lock);
1149 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1151 return _opp_get_opp_table(dev, 0);
1153 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1155 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
1158 return _opp_get_opp_table(dev, index);
1161 static void _opp_table_kref_release(struct kref *kref)
1163 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1164 struct opp_device *opp_dev, *temp;
1167 _of_clear_opp_table(opp_table);
1170 if (!IS_ERR(opp_table->clk))
1171 clk_put(opp_table->clk);
1173 if (opp_table->paths) {
1174 for (i = 0; i < opp_table->path_count; i++)
1175 icc_put(opp_table->paths[i]);
1176 kfree(opp_table->paths);
1179 WARN_ON(!list_empty(&opp_table->opp_list));
1181 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1183 * The OPP table is getting removed, drop the performance state
1186 if (opp_table->genpd_performance_state)
1187 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1189 _remove_opp_dev(opp_dev, opp_table);
1192 mutex_destroy(&opp_table->genpd_virt_dev_lock);
1193 mutex_destroy(&opp_table->lock);
1194 list_del(&opp_table->node);
1197 mutex_unlock(&opp_table_lock);
1200 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1202 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1205 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1207 void _opp_free(struct dev_pm_opp *opp)
1212 static void _opp_kref_release(struct dev_pm_opp *opp,
1213 struct opp_table *opp_table)
1216 * Notify the changes in the availability of the operable
1217 * frequency/voltage list.
1219 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1220 _of_opp_free_required_opps(opp_table, opp);
1221 opp_debug_remove_one(opp);
1222 list_del(&opp->node);
1226 static void _opp_kref_release_unlocked(struct kref *kref)
1228 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1229 struct opp_table *opp_table = opp->opp_table;
1231 _opp_kref_release(opp, opp_table);
1234 static void _opp_kref_release_locked(struct kref *kref)
1236 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1237 struct opp_table *opp_table = opp->opp_table;
1239 _opp_kref_release(opp, opp_table);
1240 mutex_unlock(&opp_table->lock);
1243 void dev_pm_opp_get(struct dev_pm_opp *opp)
1245 kref_get(&opp->kref);
1248 void dev_pm_opp_put(struct dev_pm_opp *opp)
1250 kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1251 &opp->opp_table->lock);
1253 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1255 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1257 kref_put(&opp->kref, _opp_kref_release_unlocked);
1261 * dev_pm_opp_remove() - Remove an OPP from OPP table
1262 * @dev: device for which we do this operation
1263 * @freq: OPP to remove with matching 'freq'
1265 * This function removes an opp from the opp table.
1267 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1269 struct dev_pm_opp *opp;
1270 struct opp_table *opp_table;
1273 opp_table = _find_opp_table(dev);
1274 if (IS_ERR(opp_table))
1277 mutex_lock(&opp_table->lock);
1279 list_for_each_entry(opp, &opp_table->opp_list, node) {
1280 if (opp->rate == freq) {
1286 mutex_unlock(&opp_table->lock);
1289 dev_pm_opp_put(opp);
1291 /* Drop the reference taken by dev_pm_opp_add() */
1292 dev_pm_opp_put_opp_table(opp_table);
1294 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1298 /* Drop the reference taken by _find_opp_table() */
1299 dev_pm_opp_put_opp_table(opp_table);
1301 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1303 void _opp_remove_all_static(struct opp_table *opp_table)
1305 struct dev_pm_opp *opp, *tmp;
1307 mutex_lock(&opp_table->lock);
1309 if (!opp_table->parsed_static_opps || --opp_table->parsed_static_opps)
1312 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1314 dev_pm_opp_put_unlocked(opp);
1318 mutex_unlock(&opp_table->lock);
1322 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1323 * @dev: device for which we do this operation
1325 * This function removes all dynamically created OPPs from the opp table.
1327 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1329 struct opp_table *opp_table;
1330 struct dev_pm_opp *opp, *temp;
1333 opp_table = _find_opp_table(dev);
1334 if (IS_ERR(opp_table))
1337 mutex_lock(&opp_table->lock);
1338 list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1340 dev_pm_opp_put_unlocked(opp);
1344 mutex_unlock(&opp_table->lock);
1346 /* Drop the references taken by dev_pm_opp_add() */
1348 dev_pm_opp_put_opp_table(opp_table);
1350 /* Drop the reference taken by _find_opp_table() */
1351 dev_pm_opp_put_opp_table(opp_table);
1353 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1355 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1357 struct dev_pm_opp *opp;
1358 int supply_count, supply_size, icc_size;
1360 /* Allocate space for at least one supply */
1361 supply_count = table->regulator_count > 0 ? table->regulator_count : 1;
1362 supply_size = sizeof(*opp->supplies) * supply_count;
1363 icc_size = sizeof(*opp->bandwidth) * table->path_count;
1365 /* allocate new OPP node and supplies structures */
1366 opp = kzalloc(sizeof(*opp) + supply_size + icc_size, GFP_KERNEL);
1371 /* Put the supplies at the end of the OPP structure as an empty array */
1372 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1374 opp->bandwidth = (struct dev_pm_opp_icc_bw *)(opp->supplies + supply_count);
1375 INIT_LIST_HEAD(&opp->node);
1380 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1381 struct opp_table *opp_table)
1383 struct regulator *reg;
1386 if (!opp_table->regulators)
1389 for (i = 0; i < opp_table->regulator_count; i++) {
1390 reg = opp_table->regulators[i];
1392 if (!regulator_is_supported_voltage(reg,
1393 opp->supplies[i].u_volt_min,
1394 opp->supplies[i].u_volt_max)) {
1395 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1396 __func__, opp->supplies[i].u_volt_min,
1397 opp->supplies[i].u_volt_max);
1405 int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2)
1407 if (opp1->rate != opp2->rate)
1408 return opp1->rate < opp2->rate ? -1 : 1;
1409 if (opp1->bandwidth && opp2->bandwidth &&
1410 opp1->bandwidth[0].peak != opp2->bandwidth[0].peak)
1411 return opp1->bandwidth[0].peak < opp2->bandwidth[0].peak ? -1 : 1;
1412 if (opp1->level != opp2->level)
1413 return opp1->level < opp2->level ? -1 : 1;
1417 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1418 struct opp_table *opp_table,
1419 struct list_head **head)
1421 struct dev_pm_opp *opp;
1425 * Insert new OPP in order of increasing frequency and discard if
1428 * Need to use &opp_table->opp_list in the condition part of the 'for'
1429 * loop, don't replace it with head otherwise it will become an infinite
1432 list_for_each_entry(opp, &opp_table->opp_list, node) {
1433 opp_cmp = _opp_compare_key(new_opp, opp);
1442 /* Duplicate OPPs */
1443 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1444 __func__, opp->rate, opp->supplies[0].u_volt,
1445 opp->available, new_opp->rate,
1446 new_opp->supplies[0].u_volt, new_opp->available);
1448 /* Should we compare voltages for all regulators here ? */
1449 return opp->available &&
1450 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1458 * 0: On success. And appropriate error message for duplicate OPPs.
1459 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1460 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1461 * sure we don't print error messages unnecessarily if different parts of
1462 * kernel try to initialize the OPP table.
1463 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1464 * should be considered an error by the callers of _opp_add().
1466 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1467 struct opp_table *opp_table, bool rate_not_available)
1469 struct list_head *head;
1472 mutex_lock(&opp_table->lock);
1473 head = &opp_table->opp_list;
1475 if (likely(!rate_not_available)) {
1476 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1478 mutex_unlock(&opp_table->lock);
1483 list_add(&new_opp->node, head);
1484 mutex_unlock(&opp_table->lock);
1486 new_opp->opp_table = opp_table;
1487 kref_init(&new_opp->kref);
1489 opp_debug_create_one(new_opp, opp_table);
1491 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1492 new_opp->available = false;
1493 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1494 __func__, new_opp->rate);
1501 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1502 * @opp_table: OPP table
1503 * @dev: device for which we do this operation
1504 * @freq: Frequency in Hz for this OPP
1505 * @u_volt: Voltage in uVolts for this OPP
1506 * @dynamic: Dynamically added OPPs.
1508 * This function adds an opp definition to the opp table and returns status.
1509 * The opp is made available by default and it can be controlled using
1510 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1512 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1513 * and freed by dev_pm_opp_of_remove_table.
1517 * Duplicate OPPs (both freq and volt are same) and opp->available
1518 * -EEXIST Freq are same and volt are different OR
1519 * Duplicate OPPs (both freq and volt are same) and !opp->available
1520 * -ENOMEM Memory allocation failure
1522 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1523 unsigned long freq, long u_volt, bool dynamic)
1525 struct dev_pm_opp *new_opp;
1529 new_opp = _opp_allocate(opp_table);
1533 /* populate the opp table */
1534 new_opp->rate = freq;
1535 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1536 new_opp->supplies[0].u_volt = u_volt;
1537 new_opp->supplies[0].u_volt_min = u_volt - tol;
1538 new_opp->supplies[0].u_volt_max = u_volt + tol;
1539 new_opp->available = true;
1540 new_opp->dynamic = dynamic;
1542 ret = _opp_add(dev, new_opp, opp_table, false);
1544 /* Don't return error for duplicate OPPs */
1551 * Notify the changes in the availability of the operable
1552 * frequency/voltage list.
1554 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1564 * dev_pm_opp_set_supported_hw() - Set supported platforms
1565 * @dev: Device for which supported-hw has to be set.
1566 * @versions: Array of hierarchy of versions to match.
1567 * @count: Number of elements in the array.
1569 * This is required only for the V2 bindings, and it enables a platform to
1570 * specify the hierarchy of versions it supports. OPP layer will then enable
1571 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1574 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1575 const u32 *versions, unsigned int count)
1577 struct opp_table *opp_table;
1579 opp_table = dev_pm_opp_get_opp_table(dev);
1580 if (IS_ERR(opp_table))
1583 /* Make sure there are no concurrent readers while updating opp_table */
1584 WARN_ON(!list_empty(&opp_table->opp_list));
1586 /* Another CPU that shares the OPP table has set the property ? */
1587 if (opp_table->supported_hw)
1590 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1592 if (!opp_table->supported_hw) {
1593 dev_pm_opp_put_opp_table(opp_table);
1594 return ERR_PTR(-ENOMEM);
1597 opp_table->supported_hw_count = count;
1601 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1604 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1605 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1607 * This is required only for the V2 bindings, and is called for a matching
1608 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1609 * will not be freed.
1611 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1613 /* Make sure there are no concurrent readers while updating opp_table */
1614 WARN_ON(!list_empty(&opp_table->opp_list));
1616 kfree(opp_table->supported_hw);
1617 opp_table->supported_hw = NULL;
1618 opp_table->supported_hw_count = 0;
1620 dev_pm_opp_put_opp_table(opp_table);
1622 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1625 * dev_pm_opp_set_prop_name() - Set prop-extn name
1626 * @dev: Device for which the prop-name has to be set.
1627 * @name: name to postfix to properties.
1629 * This is required only for the V2 bindings, and it enables a platform to
1630 * specify the extn to be used for certain property names. The properties to
1631 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1632 * should postfix the property name with -<name> while looking for them.
1634 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1636 struct opp_table *opp_table;
1638 opp_table = dev_pm_opp_get_opp_table(dev);
1639 if (IS_ERR(opp_table))
1642 /* Make sure there are no concurrent readers while updating opp_table */
1643 WARN_ON(!list_empty(&opp_table->opp_list));
1645 /* Another CPU that shares the OPP table has set the property ? */
1646 if (opp_table->prop_name)
1649 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1650 if (!opp_table->prop_name) {
1651 dev_pm_opp_put_opp_table(opp_table);
1652 return ERR_PTR(-ENOMEM);
1657 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1660 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1661 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1663 * This is required only for the V2 bindings, and is called for a matching
1664 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1665 * will not be freed.
1667 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1669 /* Make sure there are no concurrent readers while updating opp_table */
1670 WARN_ON(!list_empty(&opp_table->opp_list));
1672 kfree(opp_table->prop_name);
1673 opp_table->prop_name = NULL;
1675 dev_pm_opp_put_opp_table(opp_table);
1677 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1679 static int _allocate_set_opp_data(struct opp_table *opp_table)
1681 struct dev_pm_set_opp_data *data;
1682 int len, count = opp_table->regulator_count;
1684 if (WARN_ON(!opp_table->regulators))
1687 /* space for set_opp_data */
1688 len = sizeof(*data);
1690 /* space for old_opp.supplies and new_opp.supplies */
1691 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1693 data = kzalloc(len, GFP_KERNEL);
1697 data->old_opp.supplies = (void *)(data + 1);
1698 data->new_opp.supplies = data->old_opp.supplies + count;
1700 opp_table->set_opp_data = data;
1705 static void _free_set_opp_data(struct opp_table *opp_table)
1707 kfree(opp_table->set_opp_data);
1708 opp_table->set_opp_data = NULL;
1712 * dev_pm_opp_set_regulators() - Set regulator names for the device
1713 * @dev: Device for which regulator name is being set.
1714 * @names: Array of pointers to the names of the regulator.
1715 * @count: Number of regulators.
1717 * In order to support OPP switching, OPP layer needs to know the name of the
1718 * device's regulators, as the core would be required to switch voltages as
1721 * This must be called before any OPPs are initialized for the device.
1723 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1724 const char * const names[],
1727 struct opp_table *opp_table;
1728 struct regulator *reg;
1731 opp_table = dev_pm_opp_get_opp_table(dev);
1732 if (IS_ERR(opp_table))
1735 /* This should be called before OPPs are initialized */
1736 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1741 /* Another CPU that shares the OPP table has set the regulators ? */
1742 if (opp_table->regulators)
1745 opp_table->regulators = kmalloc_array(count,
1746 sizeof(*opp_table->regulators),
1748 if (!opp_table->regulators) {
1753 for (i = 0; i < count; i++) {
1754 reg = regulator_get_optional(dev, names[i]);
1757 if (ret != -EPROBE_DEFER)
1758 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1759 __func__, names[i], ret);
1760 goto free_regulators;
1763 opp_table->regulators[i] = reg;
1766 opp_table->regulator_count = count;
1768 /* Allocate block only once to pass to set_opp() routines */
1769 ret = _allocate_set_opp_data(opp_table);
1771 goto free_regulators;
1777 regulator_put(opp_table->regulators[--i]);
1779 kfree(opp_table->regulators);
1780 opp_table->regulators = NULL;
1781 opp_table->regulator_count = -1;
1783 dev_pm_opp_put_opp_table(opp_table);
1785 return ERR_PTR(ret);
1787 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1790 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1791 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1793 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1797 if (!opp_table->regulators)
1800 /* Make sure there are no concurrent readers while updating opp_table */
1801 WARN_ON(!list_empty(&opp_table->opp_list));
1803 if (opp_table->regulator_enabled) {
1804 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1805 regulator_disable(opp_table->regulators[i]);
1807 opp_table->regulator_enabled = false;
1810 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1811 regulator_put(opp_table->regulators[i]);
1813 _free_set_opp_data(opp_table);
1815 kfree(opp_table->regulators);
1816 opp_table->regulators = NULL;
1817 opp_table->regulator_count = -1;
1820 dev_pm_opp_put_opp_table(opp_table);
1822 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1825 * dev_pm_opp_set_clkname() - Set clk name for the device
1826 * @dev: Device for which clk name is being set.
1829 * In order to support OPP switching, OPP layer needs to get pointer to the
1830 * clock for the device. Simple cases work fine without using this routine (i.e.
1831 * by passing connection-id as NULL), but for a device with multiple clocks
1832 * available, the OPP core needs to know the exact name of the clk to use.
1834 * This must be called before any OPPs are initialized for the device.
1836 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1838 struct opp_table *opp_table;
1841 opp_table = dev_pm_opp_get_opp_table(dev);
1842 if (IS_ERR(opp_table))
1845 /* This should be called before OPPs are initialized */
1846 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1851 /* Already have default clk set, free it */
1852 if (!IS_ERR(opp_table->clk))
1853 clk_put(opp_table->clk);
1855 /* Find clk for the device */
1856 opp_table->clk = clk_get(dev, name);
1857 if (IS_ERR(opp_table->clk)) {
1858 ret = PTR_ERR(opp_table->clk);
1859 if (ret != -EPROBE_DEFER) {
1860 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1869 dev_pm_opp_put_opp_table(opp_table);
1871 return ERR_PTR(ret);
1873 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1876 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1877 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1879 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1881 /* Make sure there are no concurrent readers while updating opp_table */
1882 WARN_ON(!list_empty(&opp_table->opp_list));
1884 clk_put(opp_table->clk);
1885 opp_table->clk = ERR_PTR(-EINVAL);
1887 dev_pm_opp_put_opp_table(opp_table);
1889 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1892 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1893 * @dev: Device for which the helper is getting registered.
1894 * @set_opp: Custom set OPP helper.
1896 * This is useful to support complex platforms (like platforms with multiple
1897 * regulators per device), instead of the generic OPP set rate helper.
1899 * This must be called before any OPPs are initialized for the device.
1901 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1902 int (*set_opp)(struct dev_pm_set_opp_data *data))
1904 struct opp_table *opp_table;
1907 return ERR_PTR(-EINVAL);
1909 opp_table = dev_pm_opp_get_opp_table(dev);
1910 if (!IS_ERR(opp_table))
1913 /* This should be called before OPPs are initialized */
1914 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1915 dev_pm_opp_put_opp_table(opp_table);
1916 return ERR_PTR(-EBUSY);
1919 /* Another CPU that shares the OPP table has set the helper ? */
1920 if (!opp_table->set_opp)
1921 opp_table->set_opp = set_opp;
1925 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1928 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1930 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1932 * Release resources blocked for platform specific set_opp helper.
1934 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1936 /* Make sure there are no concurrent readers while updating opp_table */
1937 WARN_ON(!list_empty(&opp_table->opp_list));
1939 opp_table->set_opp = NULL;
1940 dev_pm_opp_put_opp_table(opp_table);
1942 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1944 static void _opp_detach_genpd(struct opp_table *opp_table)
1948 for (index = 0; index < opp_table->required_opp_count; index++) {
1949 if (!opp_table->genpd_virt_devs[index])
1952 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1953 opp_table->genpd_virt_devs[index] = NULL;
1956 kfree(opp_table->genpd_virt_devs);
1957 opp_table->genpd_virt_devs = NULL;
1961 * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1962 * @dev: Consumer device for which the genpd is getting attached.
1963 * @names: Null terminated array of pointers containing names of genpd to attach.
1964 * @virt_devs: Pointer to return the array of virtual devices.
1966 * Multiple generic power domains for a device are supported with the help of
1967 * virtual genpd devices, which are created for each consumer device - genpd
1968 * pair. These are the device structures which are attached to the power domain
1969 * and are required by the OPP core to set the performance state of the genpd.
1970 * The same API also works for the case where single genpd is available and so
1971 * we don't need to support that separately.
1973 * This helper will normally be called by the consumer driver of the device
1974 * "dev", as only that has details of the genpd names.
1976 * This helper needs to be called once with a list of all genpd to attach.
1977 * Otherwise the original device structure will be used instead by the OPP core.
1979 * The order of entries in the names array must match the order in which
1980 * "required-opps" are added in DT.
1982 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
1983 const char **names, struct device ***virt_devs)
1985 struct opp_table *opp_table;
1986 struct device *virt_dev;
1987 int index = 0, ret = -EINVAL;
1988 const char **name = names;
1990 opp_table = dev_pm_opp_get_opp_table(dev);
1991 if (IS_ERR(opp_table))
1995 * If the genpd's OPP table isn't already initialized, parsing of the
1996 * required-opps fail for dev. We should retry this after genpd's OPP
1999 if (!opp_table->required_opp_count) {
2000 ret = -EPROBE_DEFER;
2004 mutex_lock(&opp_table->genpd_virt_dev_lock);
2006 opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
2007 sizeof(*opp_table->genpd_virt_devs),
2009 if (!opp_table->genpd_virt_devs)
2013 if (index >= opp_table->required_opp_count) {
2014 dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
2015 *name, opp_table->required_opp_count, index);
2019 if (opp_table->genpd_virt_devs[index]) {
2020 dev_err(dev, "Genpd virtual device already set %s\n",
2025 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
2026 if (IS_ERR(virt_dev)) {
2027 ret = PTR_ERR(virt_dev);
2028 dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
2032 opp_table->genpd_virt_devs[index] = virt_dev;
2038 *virt_devs = opp_table->genpd_virt_devs;
2039 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2044 _opp_detach_genpd(opp_table);
2046 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2049 dev_pm_opp_put_opp_table(opp_table);
2051 return ERR_PTR(ret);
2053 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
2056 * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
2057 * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
2059 * This detaches the genpd(s), resets the virtual device pointers, and puts the
2062 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
2065 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
2068 mutex_lock(&opp_table->genpd_virt_dev_lock);
2069 _opp_detach_genpd(opp_table);
2070 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2072 dev_pm_opp_put_opp_table(opp_table);
2074 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
2077 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
2078 * @src_table: OPP table which has dst_table as one of its required OPP table.
2079 * @dst_table: Required OPP table of the src_table.
2080 * @pstate: Current performance state of the src_table.
2082 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
2083 * "required-opps" property of the OPP (present in @src_table) which has
2084 * performance state set to @pstate.
2086 * Return: Zero or positive performance state on success, otherwise negative
2089 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
2090 struct opp_table *dst_table,
2091 unsigned int pstate)
2093 struct dev_pm_opp *opp;
2094 int dest_pstate = -EINVAL;
2101 * Normally the src_table will have the "required_opps" property set to
2102 * point to one of the OPPs in the dst_table, but in some cases the
2103 * genpd and its master have one to one mapping of performance states
2104 * and so none of them have the "required-opps" property set. Return the
2105 * pstate of the src_table as it is in such cases.
2107 if (!src_table->required_opp_count)
2110 for (i = 0; i < src_table->required_opp_count; i++) {
2111 if (src_table->required_opp_tables[i]->np == dst_table->np)
2115 if (unlikely(i == src_table->required_opp_count)) {
2116 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
2117 __func__, src_table, dst_table);
2121 mutex_lock(&src_table->lock);
2123 list_for_each_entry(opp, &src_table->opp_list, node) {
2124 if (opp->pstate == pstate) {
2125 dest_pstate = opp->required_opps[i]->pstate;
2130 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
2134 mutex_unlock(&src_table->lock);
2140 * dev_pm_opp_add() - Add an OPP table from a table definitions
2141 * @dev: device for which we do this operation
2142 * @freq: Frequency in Hz for this OPP
2143 * @u_volt: Voltage in uVolts for this OPP
2145 * This function adds an opp definition to the opp table and returns status.
2146 * The opp is made available by default and it can be controlled using
2147 * dev_pm_opp_enable/disable functions.
2151 * Duplicate OPPs (both freq and volt are same) and opp->available
2152 * -EEXIST Freq are same and volt are different OR
2153 * Duplicate OPPs (both freq and volt are same) and !opp->available
2154 * -ENOMEM Memory allocation failure
2156 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2158 struct opp_table *opp_table;
2161 opp_table = dev_pm_opp_get_opp_table(dev);
2162 if (IS_ERR(opp_table))
2163 return PTR_ERR(opp_table);
2165 /* Fix regulator count for dynamic OPPs */
2166 opp_table->regulator_count = 1;
2168 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2170 dev_pm_opp_put_opp_table(opp_table);
2174 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2177 * _opp_set_availability() - helper to set the availability of an opp
2178 * @dev: device for which we do this operation
2179 * @freq: OPP frequency to modify availability
2180 * @availability_req: availability status requested for this opp
2182 * Set the availability of an OPP, opp_{enable,disable} share a common logic
2183 * which is isolated here.
2185 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2186 * copy operation, returns 0 if no modification was done OR modification was
2189 static int _opp_set_availability(struct device *dev, unsigned long freq,
2190 bool availability_req)
2192 struct opp_table *opp_table;
2193 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2196 /* Find the opp_table */
2197 opp_table = _find_opp_table(dev);
2198 if (IS_ERR(opp_table)) {
2199 r = PTR_ERR(opp_table);
2200 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2204 mutex_lock(&opp_table->lock);
2206 /* Do we have the frequency? */
2207 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2208 if (tmp_opp->rate == freq) {
2219 /* Is update really needed? */
2220 if (opp->available == availability_req)
2223 opp->available = availability_req;
2225 dev_pm_opp_get(opp);
2226 mutex_unlock(&opp_table->lock);
2228 /* Notify the change of the OPP availability */
2229 if (availability_req)
2230 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2233 blocking_notifier_call_chain(&opp_table->head,
2234 OPP_EVENT_DISABLE, opp);
2236 dev_pm_opp_put(opp);
2240 mutex_unlock(&opp_table->lock);
2242 dev_pm_opp_put_opp_table(opp_table);
2247 * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2248 * @dev: device for which we do this operation
2249 * @freq: OPP frequency to adjust voltage of
2250 * @u_volt: new OPP target voltage
2251 * @u_volt_min: new OPP min voltage
2252 * @u_volt_max: new OPP max voltage
2254 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2255 * copy operation, returns 0 if no modifcation was done OR modification was
2258 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2259 unsigned long u_volt, unsigned long u_volt_min,
2260 unsigned long u_volt_max)
2263 struct opp_table *opp_table;
2264 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2267 /* Find the opp_table */
2268 opp_table = _find_opp_table(dev);
2269 if (IS_ERR(opp_table)) {
2270 r = PTR_ERR(opp_table);
2271 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2275 mutex_lock(&opp_table->lock);
2277 /* Do we have the frequency? */
2278 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2279 if (tmp_opp->rate == freq) {
2290 /* Is update really needed? */
2291 if (opp->supplies->u_volt == u_volt)
2294 opp->supplies->u_volt = u_volt;
2295 opp->supplies->u_volt_min = u_volt_min;
2296 opp->supplies->u_volt_max = u_volt_max;
2298 dev_pm_opp_get(opp);
2299 mutex_unlock(&opp_table->lock);
2301 /* Notify the voltage change of the OPP */
2302 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2305 dev_pm_opp_put(opp);
2306 goto adjust_put_table;
2309 mutex_unlock(&opp_table->lock);
2311 dev_pm_opp_put_opp_table(opp_table);
2314 EXPORT_SYMBOL_GPL(dev_pm_opp_adjust_voltage);
2317 * dev_pm_opp_enable() - Enable a specific OPP
2318 * @dev: device for which we do this operation
2319 * @freq: OPP frequency to enable
2321 * Enables a provided opp. If the operation is valid, this returns 0, else the
2322 * corresponding error value. It is meant to be used for users an OPP available
2323 * after being temporarily made unavailable with dev_pm_opp_disable.
2325 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2326 * copy operation, returns 0 if no modification was done OR modification was
2329 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2331 return _opp_set_availability(dev, freq, true);
2333 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2336 * dev_pm_opp_disable() - Disable a specific OPP
2337 * @dev: device for which we do this operation
2338 * @freq: OPP frequency to disable
2340 * Disables a provided opp. If the operation is valid, this returns
2341 * 0, else the corresponding error value. It is meant to be a temporary
2342 * control by users to make this OPP not available until the circumstances are
2343 * right to make it available again (with a call to dev_pm_opp_enable).
2345 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2346 * copy operation, returns 0 if no modification was done OR modification was
2349 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2351 return _opp_set_availability(dev, freq, false);
2353 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2356 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2357 * @dev: Device for which notifier needs to be registered
2358 * @nb: Notifier block to be registered
2360 * Return: 0 on success or a negative error value.
2362 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2364 struct opp_table *opp_table;
2367 opp_table = _find_opp_table(dev);
2368 if (IS_ERR(opp_table))
2369 return PTR_ERR(opp_table);
2371 ret = blocking_notifier_chain_register(&opp_table->head, nb);
2373 dev_pm_opp_put_opp_table(opp_table);
2377 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2380 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2381 * @dev: Device for which notifier needs to be unregistered
2382 * @nb: Notifier block to be unregistered
2384 * Return: 0 on success or a negative error value.
2386 int dev_pm_opp_unregister_notifier(struct device *dev,
2387 struct notifier_block *nb)
2389 struct opp_table *opp_table;
2392 opp_table = _find_opp_table(dev);
2393 if (IS_ERR(opp_table))
2394 return PTR_ERR(opp_table);
2396 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2398 dev_pm_opp_put_opp_table(opp_table);
2402 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2404 void _dev_pm_opp_find_and_remove_table(struct device *dev)
2406 struct opp_table *opp_table;
2408 /* Check for existing table for 'dev' */
2409 opp_table = _find_opp_table(dev);
2410 if (IS_ERR(opp_table)) {
2411 int error = PTR_ERR(opp_table);
2413 if (error != -ENODEV)
2414 WARN(1, "%s: opp_table: %d\n",
2415 IS_ERR_OR_NULL(dev) ?
2416 "Invalid device" : dev_name(dev),
2421 _opp_remove_all_static(opp_table);
2423 /* Drop reference taken by _find_opp_table() */
2424 dev_pm_opp_put_opp_table(opp_table);
2426 /* Drop reference taken while the OPP table was added */
2427 dev_pm_opp_put_opp_table(opp_table);
2431 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2432 * @dev: device pointer used to lookup OPP table.
2434 * Free both OPPs created using static entries present in DT and the
2435 * dynamically added entries.
2437 void dev_pm_opp_remove_table(struct device *dev)
2439 _dev_pm_opp_find_and_remove_table(dev);
2441 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);