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);
31 /* OPP tables with uninitialized required OPPs */
32 LIST_HEAD(lazy_opp_tables);
34 /* Lock to allow exclusive modification to the device and opp lists */
35 DEFINE_MUTEX(opp_table_lock);
36 /* Flag indicating that opp_tables list is being updated at the moment */
37 static bool opp_tables_busy;
39 static bool _find_opp_dev(const struct device *dev, struct opp_table *opp_table)
41 struct opp_device *opp_dev;
44 mutex_lock(&opp_table->lock);
45 list_for_each_entry(opp_dev, &opp_table->dev_list, node)
46 if (opp_dev->dev == dev) {
51 mutex_unlock(&opp_table->lock);
55 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
57 struct opp_table *opp_table;
59 list_for_each_entry(opp_table, &opp_tables, node) {
60 if (_find_opp_dev(dev, opp_table)) {
61 _get_opp_table_kref(opp_table);
66 return ERR_PTR(-ENODEV);
70 * _find_opp_table() - find opp_table struct using device pointer
71 * @dev: device pointer used to lookup OPP table
73 * Search OPP table for one containing matching device.
75 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
76 * -EINVAL based on type of error.
78 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
80 struct opp_table *_find_opp_table(struct device *dev)
82 struct opp_table *opp_table;
84 if (IS_ERR_OR_NULL(dev)) {
85 pr_err("%s: Invalid parameters\n", __func__);
86 return ERR_PTR(-EINVAL);
89 mutex_lock(&opp_table_lock);
90 opp_table = _find_opp_table_unlocked(dev);
91 mutex_unlock(&opp_table_lock);
97 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
98 * @opp: opp for which voltage has to be returned for
100 * Return: voltage in micro volt corresponding to the opp, else
103 * This is useful only for devices with single power supply.
105 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
107 if (IS_ERR_OR_NULL(opp)) {
108 pr_err("%s: Invalid parameters\n", __func__);
112 return opp->supplies[0].u_volt;
114 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
117 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
118 * @opp: opp for which frequency has to be returned for
120 * Return: frequency in hertz corresponding to the opp, else
123 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
125 if (IS_ERR_OR_NULL(opp)) {
126 pr_err("%s: Invalid parameters\n", __func__);
132 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
135 * dev_pm_opp_get_level() - Gets the level corresponding to an available opp
136 * @opp: opp for which level value has to be returned for
138 * Return: level read from device tree corresponding to the opp, else
141 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
143 if (IS_ERR_OR_NULL(opp) || !opp->available) {
144 pr_err("%s: Invalid parameters\n", __func__);
150 EXPORT_SYMBOL_GPL(dev_pm_opp_get_level);
153 * dev_pm_opp_get_required_pstate() - Gets the required performance state
154 * corresponding to an available opp
155 * @opp: opp for which performance state has to be returned for
156 * @index: index of the required opp
158 * Return: performance state read from device tree corresponding to the
159 * required opp, else return 0.
161 unsigned int dev_pm_opp_get_required_pstate(struct dev_pm_opp *opp,
164 if (IS_ERR_OR_NULL(opp) || !opp->available ||
165 index >= opp->opp_table->required_opp_count) {
166 pr_err("%s: Invalid parameters\n", __func__);
170 /* required-opps not fully initialized yet */
171 if (lazy_linking_pending(opp->opp_table))
174 return opp->required_opps[index]->pstate;
176 EXPORT_SYMBOL_GPL(dev_pm_opp_get_required_pstate);
179 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
180 * @opp: opp for which turbo mode is being verified
182 * Turbo OPPs are not for normal use, and can be enabled (under certain
183 * conditions) for short duration of times to finish high throughput work
184 * quickly. Running on them for longer times may overheat the chip.
186 * Return: true if opp is turbo opp, else false.
188 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
190 if (IS_ERR_OR_NULL(opp) || !opp->available) {
191 pr_err("%s: Invalid parameters\n", __func__);
197 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
200 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
201 * @dev: device for which we do this operation
203 * Return: This function returns the max clock latency in nanoseconds.
205 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
207 struct opp_table *opp_table;
208 unsigned long clock_latency_ns;
210 opp_table = _find_opp_table(dev);
211 if (IS_ERR(opp_table))
214 clock_latency_ns = opp_table->clock_latency_ns_max;
216 dev_pm_opp_put_opp_table(opp_table);
218 return clock_latency_ns;
220 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
223 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
224 * @dev: device for which we do this operation
226 * Return: This function returns the max voltage latency in nanoseconds.
228 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
230 struct opp_table *opp_table;
231 struct dev_pm_opp *opp;
232 struct regulator *reg;
233 unsigned long latency_ns = 0;
240 opp_table = _find_opp_table(dev);
241 if (IS_ERR(opp_table))
244 /* Regulator may not be required for the device */
245 if (!opp_table->regulators)
248 count = opp_table->regulator_count;
250 uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
254 mutex_lock(&opp_table->lock);
256 for (i = 0; i < count; i++) {
260 list_for_each_entry(opp, &opp_table->opp_list, node) {
264 if (opp->supplies[i].u_volt_min < uV[i].min)
265 uV[i].min = opp->supplies[i].u_volt_min;
266 if (opp->supplies[i].u_volt_max > uV[i].max)
267 uV[i].max = opp->supplies[i].u_volt_max;
271 mutex_unlock(&opp_table->lock);
274 * The caller needs to ensure that opp_table (and hence the regulator)
275 * isn't freed, while we are executing this routine.
277 for (i = 0; i < count; i++) {
278 reg = opp_table->regulators[i];
279 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
281 latency_ns += ret * 1000;
286 dev_pm_opp_put_opp_table(opp_table);
290 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
293 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
295 * @dev: device for which we do this operation
297 * Return: This function returns the max transition latency, in nanoseconds, to
298 * switch from one OPP to other.
300 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
302 return dev_pm_opp_get_max_volt_latency(dev) +
303 dev_pm_opp_get_max_clock_latency(dev);
305 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
308 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
309 * @dev: device for which we do this operation
311 * Return: This function returns the frequency of the OPP marked as suspend_opp
312 * if one is available, else returns 0;
314 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
316 struct opp_table *opp_table;
317 unsigned long freq = 0;
319 opp_table = _find_opp_table(dev);
320 if (IS_ERR(opp_table))
323 if (opp_table->suspend_opp && opp_table->suspend_opp->available)
324 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
326 dev_pm_opp_put_opp_table(opp_table);
330 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
332 int _get_opp_count(struct opp_table *opp_table)
334 struct dev_pm_opp *opp;
337 mutex_lock(&opp_table->lock);
339 list_for_each_entry(opp, &opp_table->opp_list, node) {
344 mutex_unlock(&opp_table->lock);
350 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
351 * @dev: device for which we do this operation
353 * Return: This function returns the number of available opps if there are any,
354 * else returns 0 if none or the corresponding error value.
356 int dev_pm_opp_get_opp_count(struct device *dev)
358 struct opp_table *opp_table;
361 opp_table = _find_opp_table(dev);
362 if (IS_ERR(opp_table)) {
363 count = PTR_ERR(opp_table);
364 dev_dbg(dev, "%s: OPP table not found (%d)\n",
369 count = _get_opp_count(opp_table);
370 dev_pm_opp_put_opp_table(opp_table);
374 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
377 * dev_pm_opp_find_freq_exact() - search for an exact frequency
378 * @dev: device for which we do this operation
379 * @freq: frequency to search for
380 * @available: true/false - match for available opp
382 * Return: Searches for exact match in the opp table and returns pointer to the
383 * matching opp if found, else returns ERR_PTR in case of error and should
384 * be handled using IS_ERR. Error return values can be:
385 * EINVAL: for bad pointer
386 * ERANGE: no match found for search
387 * ENODEV: if device not found in list of registered devices
389 * Note: available is a modifier for the search. if available=true, then the
390 * match is for exact matching frequency and is available in the stored OPP
391 * table. if false, the match is for exact frequency which is not available.
393 * This provides a mechanism to enable an opp which is not available currently
394 * or the opposite as well.
396 * The callers are required to call dev_pm_opp_put() for the returned OPP after
399 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
403 struct opp_table *opp_table;
404 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
406 opp_table = _find_opp_table(dev);
407 if (IS_ERR(opp_table)) {
408 int r = PTR_ERR(opp_table);
410 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
414 mutex_lock(&opp_table->lock);
416 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
417 if (temp_opp->available == available &&
418 temp_opp->rate == freq) {
421 /* Increment the reference count of OPP */
427 mutex_unlock(&opp_table->lock);
428 dev_pm_opp_put_opp_table(opp_table);
432 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
435 * dev_pm_opp_find_level_exact() - search for an exact level
436 * @dev: device for which we do this operation
437 * @level: level to search for
439 * Return: Searches for exact match in the opp table and returns pointer to the
440 * matching opp if found, else returns ERR_PTR in case of error and should
441 * be handled using IS_ERR. Error return values can be:
442 * EINVAL: for bad pointer
443 * ERANGE: no match found for search
444 * ENODEV: if device not found in list of registered devices
446 * The callers are required to call dev_pm_opp_put() for the returned OPP after
449 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
452 struct opp_table *opp_table;
453 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
455 opp_table = _find_opp_table(dev);
456 if (IS_ERR(opp_table)) {
457 int r = PTR_ERR(opp_table);
459 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
463 mutex_lock(&opp_table->lock);
465 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
466 if (temp_opp->level == level) {
469 /* Increment the reference count of OPP */
475 mutex_unlock(&opp_table->lock);
476 dev_pm_opp_put_opp_table(opp_table);
480 EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_exact);
483 * dev_pm_opp_find_level_ceil() - search for an rounded up level
484 * @dev: device for which we do this operation
485 * @level: level to search for
487 * Return: Searches for rounded up match in the opp table and returns pointer
488 * to the matching opp if found, else returns ERR_PTR in case of error and
489 * should be handled using IS_ERR. Error return values can be:
490 * EINVAL: for bad pointer
491 * ERANGE: no match found for search
492 * ENODEV: if device not found in list of registered devices
494 * The callers are required to call dev_pm_opp_put() for the returned OPP after
497 struct dev_pm_opp *dev_pm_opp_find_level_ceil(struct device *dev,
500 struct opp_table *opp_table;
501 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
503 opp_table = _find_opp_table(dev);
504 if (IS_ERR(opp_table)) {
505 int r = PTR_ERR(opp_table);
507 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
511 mutex_lock(&opp_table->lock);
513 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
514 if (temp_opp->available && temp_opp->level >= *level) {
518 /* Increment the reference count of OPP */
524 mutex_unlock(&opp_table->lock);
525 dev_pm_opp_put_opp_table(opp_table);
529 EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_ceil);
531 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
534 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
536 mutex_lock(&opp_table->lock);
538 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
539 if (temp_opp->available && temp_opp->rate >= *freq) {
543 /* Increment the reference count of OPP */
549 mutex_unlock(&opp_table->lock);
555 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
556 * @dev: device for which we do this operation
557 * @freq: Start frequency
559 * Search for the matching ceil *available* OPP from a starting freq
562 * Return: matching *opp and refreshes *freq accordingly, else returns
563 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
565 * EINVAL: for bad pointer
566 * ERANGE: no match found for search
567 * ENODEV: if device not found in list of registered devices
569 * The callers are required to call dev_pm_opp_put() for the returned OPP after
572 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
575 struct opp_table *opp_table;
576 struct dev_pm_opp *opp;
579 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
580 return ERR_PTR(-EINVAL);
583 opp_table = _find_opp_table(dev);
584 if (IS_ERR(opp_table))
585 return ERR_CAST(opp_table);
587 opp = _find_freq_ceil(opp_table, freq);
589 dev_pm_opp_put_opp_table(opp_table);
593 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
596 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
597 * @dev: device for which we do this operation
598 * @freq: Start frequency
600 * Search for the matching floor *available* OPP from a starting freq
603 * Return: matching *opp and refreshes *freq accordingly, else returns
604 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
606 * EINVAL: for bad pointer
607 * ERANGE: no match found for search
608 * ENODEV: if device not found in list of registered devices
610 * The callers are required to call dev_pm_opp_put() for the returned OPP after
613 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
616 struct opp_table *opp_table;
617 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
620 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
621 return ERR_PTR(-EINVAL);
624 opp_table = _find_opp_table(dev);
625 if (IS_ERR(opp_table))
626 return ERR_CAST(opp_table);
628 mutex_lock(&opp_table->lock);
630 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
631 if (temp_opp->available) {
632 /* go to the next node, before choosing prev */
633 if (temp_opp->rate > *freq)
640 /* Increment the reference count of OPP */
643 mutex_unlock(&opp_table->lock);
644 dev_pm_opp_put_opp_table(opp_table);
651 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
654 * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
656 * @dev: Device for which we do this operation.
657 * @u_volt: Target voltage.
659 * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
661 * Return: matching *opp, else returns ERR_PTR in case of error which should be
662 * handled using IS_ERR.
664 * Error return values can be:
665 * EINVAL: bad parameters
667 * The callers are required to call dev_pm_opp_put() for the returned OPP after
670 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
671 unsigned long u_volt)
673 struct opp_table *opp_table;
674 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
676 if (!dev || !u_volt) {
677 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
679 return ERR_PTR(-EINVAL);
682 opp_table = _find_opp_table(dev);
683 if (IS_ERR(opp_table))
684 return ERR_CAST(opp_table);
686 mutex_lock(&opp_table->lock);
688 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
689 if (temp_opp->available) {
690 if (temp_opp->supplies[0].u_volt > u_volt)
696 /* Increment the reference count of OPP */
700 mutex_unlock(&opp_table->lock);
701 dev_pm_opp_put_opp_table(opp_table);
705 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
707 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
708 struct dev_pm_opp_supply *supply)
712 /* Regulator not available for device */
714 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
719 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
720 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
722 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
723 supply->u_volt, supply->u_volt_max);
725 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
726 __func__, supply->u_volt_min, supply->u_volt,
727 supply->u_volt_max, ret);
732 static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
737 /* We may reach here for devices which don't change frequency */
741 ret = clk_set_rate(clk, freq);
743 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
750 static int _generic_set_opp_regulator(struct opp_table *opp_table,
752 struct dev_pm_opp *opp,
756 struct regulator *reg = opp_table->regulators[0];
757 struct dev_pm_opp *old_opp = opp_table->current_opp;
760 /* This function only supports single regulator per device */
761 if (WARN_ON(opp_table->regulator_count > 1)) {
762 dev_err(dev, "multiple regulators are not supported\n");
766 /* Scaling up? Scale voltage before frequency */
768 ret = _set_opp_voltage(dev, reg, opp->supplies);
770 goto restore_voltage;
773 /* Change frequency */
774 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
776 goto restore_voltage;
778 /* Scaling down? Scale voltage after frequency */
780 ret = _set_opp_voltage(dev, reg, opp->supplies);
786 * Enable the regulator after setting its voltages, otherwise it breaks
787 * some boot-enabled regulators.
789 if (unlikely(!opp_table->enabled)) {
790 ret = regulator_enable(reg);
792 dev_warn(dev, "Failed to enable regulator: %d", ret);
798 if (_generic_set_opp_clk_only(dev, opp_table->clk, old_opp->rate))
799 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
800 __func__, old_opp->rate);
802 /* This shouldn't harm even if the voltages weren't updated earlier */
803 _set_opp_voltage(dev, reg, old_opp->supplies);
808 static int _set_opp_bw(const struct opp_table *opp_table,
809 struct dev_pm_opp *opp, struct device *dev)
814 if (!opp_table->paths)
817 for (i = 0; i < opp_table->path_count; i++) {
822 avg = opp->bandwidth[i].avg;
823 peak = opp->bandwidth[i].peak;
825 ret = icc_set_bw(opp_table->paths[i], avg, peak);
827 dev_err(dev, "Failed to %s bandwidth[%d]: %d\n",
828 opp ? "set" : "remove", i, ret);
836 static int _set_opp_custom(const struct opp_table *opp_table,
837 struct device *dev, struct dev_pm_opp *opp,
840 struct dev_pm_set_opp_data *data = opp_table->set_opp_data;
841 struct dev_pm_opp *old_opp = opp_table->current_opp;
845 * We support this only if dev_pm_opp_set_regulators() was called
848 if (opp_table->sod_supplies) {
849 size = sizeof(*old_opp->supplies) * opp_table->regulator_count;
850 memcpy(data->old_opp.supplies, old_opp->supplies, size);
851 memcpy(data->new_opp.supplies, opp->supplies, size);
852 data->regulator_count = opp_table->regulator_count;
854 data->regulator_count = 0;
857 data->regulators = opp_table->regulators;
858 data->clk = opp_table->clk;
860 data->old_opp.rate = old_opp->rate;
861 data->new_opp.rate = freq;
863 return opp_table->set_opp(data);
866 static int _set_required_opp(struct device *dev, struct device *pd_dev,
867 struct dev_pm_opp *opp, int i)
869 unsigned int pstate = likely(opp) ? opp->required_opps[i]->pstate : 0;
875 ret = dev_pm_genpd_set_performance_state(pd_dev, pstate);
877 dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
878 dev_name(pd_dev), pstate, ret);
884 /* This is only called for PM domain for now */
885 static int _set_required_opps(struct device *dev,
886 struct opp_table *opp_table,
887 struct dev_pm_opp *opp, bool up)
889 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
890 struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
893 if (!required_opp_tables)
897 * We only support genpd's OPPs in the "required-opps" for now, as we
898 * don't know much about other use cases. Error out if the required OPP
899 * doesn't belong to a genpd.
901 if (unlikely(!required_opp_tables[0]->is_genpd)) {
902 dev_err(dev, "required-opps don't belong to a genpd\n");
906 /* required-opps not fully initialized yet */
907 if (lazy_linking_pending(opp_table))
910 /* Single genpd case */
911 if (!genpd_virt_devs)
912 return _set_required_opp(dev, dev, opp, 0);
914 /* Multiple genpd case */
917 * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
918 * after it is freed from another thread.
920 mutex_lock(&opp_table->genpd_virt_dev_lock);
922 /* Scaling up? Set required OPPs in normal order, else reverse */
924 for (i = 0; i < opp_table->required_opp_count; i++) {
925 ret = _set_required_opp(dev, genpd_virt_devs[i], opp, i);
930 for (i = opp_table->required_opp_count - 1; i >= 0; i--) {
931 ret = _set_required_opp(dev, genpd_virt_devs[i], opp, i);
937 mutex_unlock(&opp_table->genpd_virt_dev_lock);
942 static void _find_current_opp(struct device *dev, struct opp_table *opp_table)
944 struct dev_pm_opp *opp = ERR_PTR(-ENODEV);
947 if (!IS_ERR(opp_table->clk)) {
948 freq = clk_get_rate(opp_table->clk);
949 opp = _find_freq_ceil(opp_table, &freq);
953 * Unable to find the current OPP ? Pick the first from the list since
954 * it is in ascending order, otherwise rest of the code will need to
955 * make special checks to validate current_opp.
958 mutex_lock(&opp_table->lock);
959 opp = list_first_entry(&opp_table->opp_list, struct dev_pm_opp, node);
961 mutex_unlock(&opp_table->lock);
964 opp_table->current_opp = opp;
967 static int _disable_opp_table(struct device *dev, struct opp_table *opp_table)
971 if (!opp_table->enabled)
975 * Some drivers need to support cases where some platforms may
976 * have OPP table for the device, while others don't and
977 * opp_set_rate() just needs to behave like clk_set_rate().
979 if (!_get_opp_count(opp_table))
982 ret = _set_opp_bw(opp_table, NULL, dev);
986 if (opp_table->regulators)
987 regulator_disable(opp_table->regulators[0]);
989 ret = _set_required_opps(dev, opp_table, NULL, false);
991 opp_table->enabled = false;
995 static int _set_opp(struct device *dev, struct opp_table *opp_table,
996 struct dev_pm_opp *opp, unsigned long freq)
998 struct dev_pm_opp *old_opp;
999 int scaling_down, ret;
1002 return _disable_opp_table(dev, opp_table);
1004 /* Find the currently set OPP if we don't know already */
1005 if (unlikely(!opp_table->current_opp))
1006 _find_current_opp(dev, opp_table);
1008 old_opp = opp_table->current_opp;
1010 /* Return early if nothing to do */
1011 if (old_opp == opp && opp_table->current_rate == freq &&
1012 opp_table->enabled) {
1013 dev_dbg(dev, "%s: OPPs are same, nothing to do\n", __func__);
1017 dev_dbg(dev, "%s: switching OPP: Freq %lu -> %lu Hz, Level %u -> %u, Bw %u -> %u\n",
1018 __func__, opp_table->current_rate, freq, old_opp->level,
1019 opp->level, old_opp->bandwidth ? old_opp->bandwidth[0].peak : 0,
1020 opp->bandwidth ? opp->bandwidth[0].peak : 0);
1022 scaling_down = _opp_compare_key(old_opp, opp);
1023 if (scaling_down == -1)
1026 /* Scaling up? Configure required OPPs before frequency */
1027 if (!scaling_down) {
1028 ret = _set_required_opps(dev, opp_table, opp, true);
1030 dev_err(dev, "Failed to set required opps: %d\n", ret);
1034 ret = _set_opp_bw(opp_table, opp, dev);
1036 dev_err(dev, "Failed to set bw: %d\n", ret);
1041 if (opp_table->set_opp) {
1042 ret = _set_opp_custom(opp_table, dev, opp, freq);
1043 } else if (opp_table->regulators) {
1044 ret = _generic_set_opp_regulator(opp_table, dev, opp, freq,
1047 /* Only frequency scaling */
1048 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
1054 /* Scaling down? Configure required OPPs after frequency */
1056 ret = _set_opp_bw(opp_table, opp, dev);
1058 dev_err(dev, "Failed to set bw: %d\n", ret);
1062 ret = _set_required_opps(dev, opp_table, opp, false);
1064 dev_err(dev, "Failed to set required opps: %d\n", ret);
1069 opp_table->enabled = true;
1070 dev_pm_opp_put(old_opp);
1072 /* Make sure current_opp doesn't get freed */
1073 dev_pm_opp_get(opp);
1074 opp_table->current_opp = opp;
1075 opp_table->current_rate = freq;
1081 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
1082 * @dev: device for which we do this operation
1083 * @target_freq: frequency to achieve
1085 * This configures the power-supplies to the levels specified by the OPP
1086 * corresponding to the target_freq, and programs the clock to a value <=
1087 * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
1088 * provided by the opp, should have already rounded to the target OPP's
1091 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
1093 struct opp_table *opp_table;
1094 unsigned long freq = 0, temp_freq;
1095 struct dev_pm_opp *opp = NULL;
1098 opp_table = _find_opp_table(dev);
1099 if (IS_ERR(opp_table)) {
1100 dev_err(dev, "%s: device's opp table doesn't exist\n", __func__);
1101 return PTR_ERR(opp_table);
1106 * For IO devices which require an OPP on some platforms/SoCs
1107 * while just needing to scale the clock on some others
1108 * we look for empty OPP tables with just a clock handle and
1109 * scale only the clk. This makes dev_pm_opp_set_rate()
1110 * equivalent to a clk_set_rate()
1112 if (!_get_opp_count(opp_table)) {
1113 ret = _generic_set_opp_clk_only(dev, opp_table->clk, target_freq);
1117 freq = clk_round_rate(opp_table->clk, target_freq);
1118 if ((long)freq <= 0)
1122 * The clock driver may support finer resolution of the
1123 * frequencies than the OPP table, don't update the frequency we
1124 * pass to clk_set_rate() here.
1127 opp = _find_freq_ceil(opp_table, &temp_freq);
1130 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
1131 __func__, freq, ret);
1136 ret = _set_opp(dev, opp_table, opp, freq);
1139 dev_pm_opp_put(opp);
1141 dev_pm_opp_put_opp_table(opp_table);
1144 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
1147 * dev_pm_opp_set_opp() - Configure device for OPP
1148 * @dev: device for which we do this operation
1149 * @opp: OPP to set to
1151 * This configures the device based on the properties of the OPP passed to this
1154 * Return: 0 on success, a negative error number otherwise.
1156 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
1158 struct opp_table *opp_table;
1161 opp_table = _find_opp_table(dev);
1162 if (IS_ERR(opp_table)) {
1163 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
1164 return PTR_ERR(opp_table);
1167 ret = _set_opp(dev, opp_table, opp, opp ? opp->rate : 0);
1168 dev_pm_opp_put_opp_table(opp_table);
1172 EXPORT_SYMBOL_GPL(dev_pm_opp_set_opp);
1174 /* OPP-dev Helpers */
1175 static void _remove_opp_dev(struct opp_device *opp_dev,
1176 struct opp_table *opp_table)
1178 opp_debug_unregister(opp_dev, opp_table);
1179 list_del(&opp_dev->node);
1183 struct opp_device *_add_opp_dev(const struct device *dev,
1184 struct opp_table *opp_table)
1186 struct opp_device *opp_dev;
1188 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
1192 /* Initialize opp-dev */
1195 mutex_lock(&opp_table->lock);
1196 list_add(&opp_dev->node, &opp_table->dev_list);
1197 mutex_unlock(&opp_table->lock);
1199 /* Create debugfs entries for the opp_table */
1200 opp_debug_register(opp_dev, opp_table);
1205 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
1207 struct opp_table *opp_table;
1208 struct opp_device *opp_dev;
1212 * Allocate a new OPP table. In the infrequent case where a new
1213 * device is needed to be added, we pay this penalty.
1215 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
1217 return ERR_PTR(-ENOMEM);
1219 mutex_init(&opp_table->lock);
1220 mutex_init(&opp_table->genpd_virt_dev_lock);
1221 INIT_LIST_HEAD(&opp_table->dev_list);
1222 INIT_LIST_HEAD(&opp_table->lazy);
1224 /* Mark regulator count uninitialized */
1225 opp_table->regulator_count = -1;
1227 opp_dev = _add_opp_dev(dev, opp_table);
1233 _of_init_opp_table(opp_table, dev, index);
1235 /* Find interconnect path(s) for the device */
1236 ret = dev_pm_opp_of_find_icc_paths(dev, opp_table);
1238 if (ret == -EPROBE_DEFER)
1239 goto remove_opp_dev;
1241 dev_warn(dev, "%s: Error finding interconnect paths: %d\n",
1245 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
1246 INIT_LIST_HEAD(&opp_table->opp_list);
1247 kref_init(&opp_table->kref);
1252 _remove_opp_dev(opp_dev, opp_table);
1255 return ERR_PTR(ret);
1258 void _get_opp_table_kref(struct opp_table *opp_table)
1260 kref_get(&opp_table->kref);
1263 static struct opp_table *_update_opp_table_clk(struct device *dev,
1264 struct opp_table *opp_table,
1270 * Return early if we don't need to get clk or we have already tried it
1273 if (!getclk || IS_ERR(opp_table) || opp_table->clk)
1276 /* Find clk for the device */
1277 opp_table->clk = clk_get(dev, NULL);
1279 ret = PTR_ERR_OR_ZERO(opp_table->clk);
1283 if (ret == -ENOENT) {
1284 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__, ret);
1288 dev_pm_opp_put_opp_table(opp_table);
1289 dev_err_probe(dev, ret, "Couldn't find clock\n");
1291 return ERR_PTR(ret);
1295 * We need to make sure that the OPP table for a device doesn't get added twice,
1296 * if this routine gets called in parallel with the same device pointer.
1298 * The simplest way to enforce that is to perform everything (find existing
1299 * table and if not found, create a new one) under the opp_table_lock, so only
1300 * one creator gets access to the same. But that expands the critical section
1301 * under the lock and may end up causing circular dependencies with frameworks
1302 * like debugfs, interconnect or clock framework as they may be direct or
1303 * indirect users of OPP core.
1305 * And for that reason we have to go for a bit tricky implementation here, which
1306 * uses the opp_tables_busy flag to indicate if another creator is in the middle
1307 * of adding an OPP table and others should wait for it to finish.
1309 struct opp_table *_add_opp_table_indexed(struct device *dev, int index,
1312 struct opp_table *opp_table;
1315 mutex_lock(&opp_table_lock);
1317 opp_table = _find_opp_table_unlocked(dev);
1318 if (!IS_ERR(opp_table))
1322 * The opp_tables list or an OPP table's dev_list is getting updated by
1323 * another user, wait for it to finish.
1325 if (unlikely(opp_tables_busy)) {
1326 mutex_unlock(&opp_table_lock);
1331 opp_tables_busy = true;
1332 opp_table = _managed_opp(dev, index);
1334 /* Drop the lock to reduce the size of critical section */
1335 mutex_unlock(&opp_table_lock);
1338 if (!_add_opp_dev(dev, opp_table)) {
1339 dev_pm_opp_put_opp_table(opp_table);
1340 opp_table = ERR_PTR(-ENOMEM);
1343 mutex_lock(&opp_table_lock);
1345 opp_table = _allocate_opp_table(dev, index);
1347 mutex_lock(&opp_table_lock);
1348 if (!IS_ERR(opp_table))
1349 list_add(&opp_table->node, &opp_tables);
1352 opp_tables_busy = false;
1355 mutex_unlock(&opp_table_lock);
1357 return _update_opp_table_clk(dev, opp_table, getclk);
1360 static struct opp_table *_add_opp_table(struct device *dev, bool getclk)
1362 return _add_opp_table_indexed(dev, 0, getclk);
1365 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1367 return _find_opp_table(dev);
1369 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1371 static void _opp_table_kref_release(struct kref *kref)
1373 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1374 struct opp_device *opp_dev, *temp;
1377 /* Drop the lock as soon as we can */
1378 list_del(&opp_table->node);
1379 mutex_unlock(&opp_table_lock);
1381 if (opp_table->current_opp)
1382 dev_pm_opp_put(opp_table->current_opp);
1384 _of_clear_opp_table(opp_table);
1387 if (!IS_ERR(opp_table->clk))
1388 clk_put(opp_table->clk);
1390 if (opp_table->paths) {
1391 for (i = 0; i < opp_table->path_count; i++)
1392 icc_put(opp_table->paths[i]);
1393 kfree(opp_table->paths);
1396 WARN_ON(!list_empty(&opp_table->opp_list));
1398 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1400 * The OPP table is getting removed, drop the performance state
1403 if (opp_table->genpd_performance_state)
1404 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1406 _remove_opp_dev(opp_dev, opp_table);
1409 mutex_destroy(&opp_table->genpd_virt_dev_lock);
1410 mutex_destroy(&opp_table->lock);
1414 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1416 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1419 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1421 void _opp_free(struct dev_pm_opp *opp)
1426 static void _opp_kref_release(struct kref *kref)
1428 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1429 struct opp_table *opp_table = opp->opp_table;
1431 list_del(&opp->node);
1432 mutex_unlock(&opp_table->lock);
1435 * Notify the changes in the availability of the operable
1436 * frequency/voltage list.
1438 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1439 _of_opp_free_required_opps(opp_table, opp);
1440 opp_debug_remove_one(opp);
1444 void dev_pm_opp_get(struct dev_pm_opp *opp)
1446 kref_get(&opp->kref);
1449 void dev_pm_opp_put(struct dev_pm_opp *opp)
1451 kref_put_mutex(&opp->kref, _opp_kref_release, &opp->opp_table->lock);
1453 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1456 * dev_pm_opp_remove() - Remove an OPP from OPP table
1457 * @dev: device for which we do this operation
1458 * @freq: OPP to remove with matching 'freq'
1460 * This function removes an opp from the opp table.
1462 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1464 struct dev_pm_opp *opp;
1465 struct opp_table *opp_table;
1468 opp_table = _find_opp_table(dev);
1469 if (IS_ERR(opp_table))
1472 mutex_lock(&opp_table->lock);
1474 list_for_each_entry(opp, &opp_table->opp_list, node) {
1475 if (opp->rate == freq) {
1481 mutex_unlock(&opp_table->lock);
1484 dev_pm_opp_put(opp);
1486 /* Drop the reference taken by dev_pm_opp_add() */
1487 dev_pm_opp_put_opp_table(opp_table);
1489 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1493 /* Drop the reference taken by _find_opp_table() */
1494 dev_pm_opp_put_opp_table(opp_table);
1496 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1498 static struct dev_pm_opp *_opp_get_next(struct opp_table *opp_table,
1501 struct dev_pm_opp *opp = NULL, *temp;
1503 mutex_lock(&opp_table->lock);
1504 list_for_each_entry(temp, &opp_table->opp_list, node) {
1506 * Refcount must be dropped only once for each OPP by OPP core,
1507 * do that with help of "removed" flag.
1509 if (!temp->removed && dynamic == temp->dynamic) {
1515 mutex_unlock(&opp_table->lock);
1520 * Can't call dev_pm_opp_put() from under the lock as debugfs removal needs to
1521 * happen lock less to avoid circular dependency issues. This routine must be
1522 * called without the opp_table->lock held.
1524 static void _opp_remove_all(struct opp_table *opp_table, bool dynamic)
1526 struct dev_pm_opp *opp;
1528 while ((opp = _opp_get_next(opp_table, dynamic))) {
1529 opp->removed = true;
1530 dev_pm_opp_put(opp);
1532 /* Drop the references taken by dev_pm_opp_add() */
1534 dev_pm_opp_put_opp_table(opp_table);
1538 bool _opp_remove_all_static(struct opp_table *opp_table)
1540 mutex_lock(&opp_table->lock);
1542 if (!opp_table->parsed_static_opps) {
1543 mutex_unlock(&opp_table->lock);
1547 if (--opp_table->parsed_static_opps) {
1548 mutex_unlock(&opp_table->lock);
1552 mutex_unlock(&opp_table->lock);
1554 _opp_remove_all(opp_table, false);
1559 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1560 * @dev: device for which we do this operation
1562 * This function removes all dynamically created OPPs from the opp table.
1564 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1566 struct opp_table *opp_table;
1568 opp_table = _find_opp_table(dev);
1569 if (IS_ERR(opp_table))
1572 _opp_remove_all(opp_table, true);
1574 /* Drop the reference taken by _find_opp_table() */
1575 dev_pm_opp_put_opp_table(opp_table);
1577 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1579 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1581 struct dev_pm_opp *opp;
1582 int supply_count, supply_size, icc_size;
1584 /* Allocate space for at least one supply */
1585 supply_count = table->regulator_count > 0 ? table->regulator_count : 1;
1586 supply_size = sizeof(*opp->supplies) * supply_count;
1587 icc_size = sizeof(*opp->bandwidth) * table->path_count;
1589 /* allocate new OPP node and supplies structures */
1590 opp = kzalloc(sizeof(*opp) + supply_size + icc_size, GFP_KERNEL);
1595 /* Put the supplies at the end of the OPP structure as an empty array */
1596 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1598 opp->bandwidth = (struct dev_pm_opp_icc_bw *)(opp->supplies + supply_count);
1599 INIT_LIST_HEAD(&opp->node);
1604 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1605 struct opp_table *opp_table)
1607 struct regulator *reg;
1610 if (!opp_table->regulators)
1613 for (i = 0; i < opp_table->regulator_count; i++) {
1614 reg = opp_table->regulators[i];
1616 if (!regulator_is_supported_voltage(reg,
1617 opp->supplies[i].u_volt_min,
1618 opp->supplies[i].u_volt_max)) {
1619 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1620 __func__, opp->supplies[i].u_volt_min,
1621 opp->supplies[i].u_volt_max);
1629 int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2)
1631 if (opp1->rate != opp2->rate)
1632 return opp1->rate < opp2->rate ? -1 : 1;
1633 if (opp1->bandwidth && opp2->bandwidth &&
1634 opp1->bandwidth[0].peak != opp2->bandwidth[0].peak)
1635 return opp1->bandwidth[0].peak < opp2->bandwidth[0].peak ? -1 : 1;
1636 if (opp1->level != opp2->level)
1637 return opp1->level < opp2->level ? -1 : 1;
1641 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1642 struct opp_table *opp_table,
1643 struct list_head **head)
1645 struct dev_pm_opp *opp;
1649 * Insert new OPP in order of increasing frequency and discard if
1652 * Need to use &opp_table->opp_list in the condition part of the 'for'
1653 * loop, don't replace it with head otherwise it will become an infinite
1656 list_for_each_entry(opp, &opp_table->opp_list, node) {
1657 opp_cmp = _opp_compare_key(new_opp, opp);
1666 /* Duplicate OPPs */
1667 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1668 __func__, opp->rate, opp->supplies[0].u_volt,
1669 opp->available, new_opp->rate,
1670 new_opp->supplies[0].u_volt, new_opp->available);
1672 /* Should we compare voltages for all regulators here ? */
1673 return opp->available &&
1674 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1680 void _required_opps_available(struct dev_pm_opp *opp, int count)
1684 for (i = 0; i < count; i++) {
1685 if (opp->required_opps[i]->available)
1688 opp->available = false;
1689 pr_warn("%s: OPP not supported by required OPP %pOF (%lu)\n",
1690 __func__, opp->required_opps[i]->np, opp->rate);
1697 * 0: On success. And appropriate error message for duplicate OPPs.
1698 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1699 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1700 * sure we don't print error messages unnecessarily if different parts of
1701 * kernel try to initialize the OPP table.
1702 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1703 * should be considered an error by the callers of _opp_add().
1705 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1706 struct opp_table *opp_table, bool rate_not_available)
1708 struct list_head *head;
1711 mutex_lock(&opp_table->lock);
1712 head = &opp_table->opp_list;
1714 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1716 mutex_unlock(&opp_table->lock);
1720 list_add(&new_opp->node, head);
1721 mutex_unlock(&opp_table->lock);
1723 new_opp->opp_table = opp_table;
1724 kref_init(&new_opp->kref);
1726 opp_debug_create_one(new_opp, opp_table);
1728 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1729 new_opp->available = false;
1730 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1731 __func__, new_opp->rate);
1734 /* required-opps not fully initialized yet */
1735 if (lazy_linking_pending(opp_table))
1738 _required_opps_available(new_opp, opp_table->required_opp_count);
1744 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1745 * @opp_table: OPP table
1746 * @dev: device for which we do this operation
1747 * @freq: Frequency in Hz for this OPP
1748 * @u_volt: Voltage in uVolts for this OPP
1749 * @dynamic: Dynamically added OPPs.
1751 * This function adds an opp definition to the opp table and returns status.
1752 * The opp is made available by default and it can be controlled using
1753 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1755 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1756 * and freed by dev_pm_opp_of_remove_table.
1760 * Duplicate OPPs (both freq and volt are same) and opp->available
1761 * -EEXIST Freq are same and volt are different OR
1762 * Duplicate OPPs (both freq and volt are same) and !opp->available
1763 * -ENOMEM Memory allocation failure
1765 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1766 unsigned long freq, long u_volt, bool dynamic)
1768 struct dev_pm_opp *new_opp;
1772 new_opp = _opp_allocate(opp_table);
1776 /* populate the opp table */
1777 new_opp->rate = freq;
1778 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1779 new_opp->supplies[0].u_volt = u_volt;
1780 new_opp->supplies[0].u_volt_min = u_volt - tol;
1781 new_opp->supplies[0].u_volt_max = u_volt + tol;
1782 new_opp->available = true;
1783 new_opp->dynamic = dynamic;
1785 ret = _opp_add(dev, new_opp, opp_table, false);
1787 /* Don't return error for duplicate OPPs */
1794 * Notify the changes in the availability of the operable
1795 * frequency/voltage list.
1797 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1807 * dev_pm_opp_set_supported_hw() - Set supported platforms
1808 * @dev: Device for which supported-hw has to be set.
1809 * @versions: Array of hierarchy of versions to match.
1810 * @count: Number of elements in the array.
1812 * This is required only for the V2 bindings, and it enables a platform to
1813 * specify the hierarchy of versions it supports. OPP layer will then enable
1814 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1817 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1818 const u32 *versions, unsigned int count)
1820 struct opp_table *opp_table;
1822 opp_table = _add_opp_table(dev, false);
1823 if (IS_ERR(opp_table))
1826 /* Make sure there are no concurrent readers while updating opp_table */
1827 WARN_ON(!list_empty(&opp_table->opp_list));
1829 /* Another CPU that shares the OPP table has set the property ? */
1830 if (opp_table->supported_hw)
1833 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1835 if (!opp_table->supported_hw) {
1836 dev_pm_opp_put_opp_table(opp_table);
1837 return ERR_PTR(-ENOMEM);
1840 opp_table->supported_hw_count = count;
1844 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1847 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1848 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1850 * This is required only for the V2 bindings, and is called for a matching
1851 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1852 * will not be freed.
1854 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1856 if (unlikely(!opp_table))
1859 /* Make sure there are no concurrent readers while updating opp_table */
1860 WARN_ON(!list_empty(&opp_table->opp_list));
1862 kfree(opp_table->supported_hw);
1863 opp_table->supported_hw = NULL;
1864 opp_table->supported_hw_count = 0;
1866 dev_pm_opp_put_opp_table(opp_table);
1868 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1870 static void devm_pm_opp_supported_hw_release(void *data)
1872 dev_pm_opp_put_supported_hw(data);
1876 * devm_pm_opp_set_supported_hw() - Set supported platforms
1877 * @dev: Device for which supported-hw has to be set.
1878 * @versions: Array of hierarchy of versions to match.
1879 * @count: Number of elements in the array.
1881 * This is a resource-managed variant of dev_pm_opp_set_supported_hw().
1883 * Return: 0 on success and errorno otherwise.
1885 int devm_pm_opp_set_supported_hw(struct device *dev, const u32 *versions,
1888 struct opp_table *opp_table;
1890 opp_table = dev_pm_opp_set_supported_hw(dev, versions, count);
1891 if (IS_ERR(opp_table))
1892 return PTR_ERR(opp_table);
1894 return devm_add_action_or_reset(dev, devm_pm_opp_supported_hw_release,
1897 EXPORT_SYMBOL_GPL(devm_pm_opp_set_supported_hw);
1900 * dev_pm_opp_set_prop_name() - Set prop-extn name
1901 * @dev: Device for which the prop-name has to be set.
1902 * @name: name to postfix to properties.
1904 * This is required only for the V2 bindings, and it enables a platform to
1905 * specify the extn to be used for certain property names. The properties to
1906 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1907 * should postfix the property name with -<name> while looking for them.
1909 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1911 struct opp_table *opp_table;
1913 opp_table = _add_opp_table(dev, false);
1914 if (IS_ERR(opp_table))
1917 /* Make sure there are no concurrent readers while updating opp_table */
1918 WARN_ON(!list_empty(&opp_table->opp_list));
1920 /* Another CPU that shares the OPP table has set the property ? */
1921 if (opp_table->prop_name)
1924 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1925 if (!opp_table->prop_name) {
1926 dev_pm_opp_put_opp_table(opp_table);
1927 return ERR_PTR(-ENOMEM);
1932 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1935 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1936 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1938 * This is required only for the V2 bindings, and is called for a matching
1939 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1940 * will not be freed.
1942 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1944 if (unlikely(!opp_table))
1947 /* Make sure there are no concurrent readers while updating opp_table */
1948 WARN_ON(!list_empty(&opp_table->opp_list));
1950 kfree(opp_table->prop_name);
1951 opp_table->prop_name = NULL;
1953 dev_pm_opp_put_opp_table(opp_table);
1955 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1958 * dev_pm_opp_set_regulators() - Set regulator names for the device
1959 * @dev: Device for which regulator name is being set.
1960 * @names: Array of pointers to the names of the regulator.
1961 * @count: Number of regulators.
1963 * In order to support OPP switching, OPP layer needs to know the name of the
1964 * device's regulators, as the core would be required to switch voltages as
1967 * This must be called before any OPPs are initialized for the device.
1969 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1970 const char * const names[],
1973 struct dev_pm_opp_supply *supplies;
1974 struct opp_table *opp_table;
1975 struct regulator *reg;
1978 opp_table = _add_opp_table(dev, false);
1979 if (IS_ERR(opp_table))
1982 /* This should be called before OPPs are initialized */
1983 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1988 /* Another CPU that shares the OPP table has set the regulators ? */
1989 if (opp_table->regulators)
1992 opp_table->regulators = kmalloc_array(count,
1993 sizeof(*opp_table->regulators),
1995 if (!opp_table->regulators) {
2000 for (i = 0; i < count; i++) {
2001 reg = regulator_get_optional(dev, names[i]);
2004 if (ret != -EPROBE_DEFER)
2005 dev_err(dev, "%s: no regulator (%s) found: %d\n",
2006 __func__, names[i], ret);
2007 goto free_regulators;
2010 opp_table->regulators[i] = reg;
2013 opp_table->regulator_count = count;
2015 supplies = kmalloc_array(count * 2, sizeof(*supplies), GFP_KERNEL);
2018 goto free_regulators;
2021 mutex_lock(&opp_table->lock);
2022 opp_table->sod_supplies = supplies;
2023 if (opp_table->set_opp_data) {
2024 opp_table->set_opp_data->old_opp.supplies = supplies;
2025 opp_table->set_opp_data->new_opp.supplies = supplies + count;
2027 mutex_unlock(&opp_table->lock);
2033 regulator_put(opp_table->regulators[--i]);
2035 kfree(opp_table->regulators);
2036 opp_table->regulators = NULL;
2037 opp_table->regulator_count = -1;
2039 dev_pm_opp_put_opp_table(opp_table);
2041 return ERR_PTR(ret);
2043 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
2046 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
2047 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
2049 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
2053 if (unlikely(!opp_table))
2056 if (!opp_table->regulators)
2059 /* Make sure there are no concurrent readers while updating opp_table */
2060 WARN_ON(!list_empty(&opp_table->opp_list));
2062 if (opp_table->enabled) {
2063 for (i = opp_table->regulator_count - 1; i >= 0; i--)
2064 regulator_disable(opp_table->regulators[i]);
2067 for (i = opp_table->regulator_count - 1; i >= 0; i--)
2068 regulator_put(opp_table->regulators[i]);
2070 mutex_lock(&opp_table->lock);
2071 if (opp_table->set_opp_data) {
2072 opp_table->set_opp_data->old_opp.supplies = NULL;
2073 opp_table->set_opp_data->new_opp.supplies = NULL;
2076 kfree(opp_table->sod_supplies);
2077 opp_table->sod_supplies = NULL;
2078 mutex_unlock(&opp_table->lock);
2080 kfree(opp_table->regulators);
2081 opp_table->regulators = NULL;
2082 opp_table->regulator_count = -1;
2085 dev_pm_opp_put_opp_table(opp_table);
2087 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
2089 static void devm_pm_opp_regulators_release(void *data)
2091 dev_pm_opp_put_regulators(data);
2095 * devm_pm_opp_set_regulators() - Set regulator names for the device
2096 * @dev: Device for which regulator name is being set.
2097 * @names: Array of pointers to the names of the regulator.
2098 * @count: Number of regulators.
2100 * This is a resource-managed variant of dev_pm_opp_set_regulators().
2102 * Return: 0 on success and errorno otherwise.
2104 int devm_pm_opp_set_regulators(struct device *dev,
2105 const char * const names[],
2108 struct opp_table *opp_table;
2110 opp_table = dev_pm_opp_set_regulators(dev, names, count);
2111 if (IS_ERR(opp_table))
2112 return PTR_ERR(opp_table);
2114 return devm_add_action_or_reset(dev, devm_pm_opp_regulators_release,
2117 EXPORT_SYMBOL_GPL(devm_pm_opp_set_regulators);
2120 * dev_pm_opp_set_clkname() - Set clk name for the device
2121 * @dev: Device for which clk name is being set.
2124 * In order to support OPP switching, OPP layer needs to get pointer to the
2125 * clock for the device. Simple cases work fine without using this routine (i.e.
2126 * by passing connection-id as NULL), but for a device with multiple clocks
2127 * available, the OPP core needs to know the exact name of the clk to use.
2129 * This must be called before any OPPs are initialized for the device.
2131 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
2133 struct opp_table *opp_table;
2136 opp_table = _add_opp_table(dev, false);
2137 if (IS_ERR(opp_table))
2140 /* This should be called before OPPs are initialized */
2141 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
2146 /* clk shouldn't be initialized at this point */
2147 if (WARN_ON(opp_table->clk)) {
2152 /* Find clk for the device */
2153 opp_table->clk = clk_get(dev, name);
2154 if (IS_ERR(opp_table->clk)) {
2155 ret = PTR_ERR(opp_table->clk);
2156 if (ret != -EPROBE_DEFER) {
2157 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
2166 dev_pm_opp_put_opp_table(opp_table);
2168 return ERR_PTR(ret);
2170 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
2173 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
2174 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
2176 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
2178 if (unlikely(!opp_table))
2181 /* Make sure there are no concurrent readers while updating opp_table */
2182 WARN_ON(!list_empty(&opp_table->opp_list));
2184 clk_put(opp_table->clk);
2185 opp_table->clk = ERR_PTR(-EINVAL);
2187 dev_pm_opp_put_opp_table(opp_table);
2189 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
2191 static void devm_pm_opp_clkname_release(void *data)
2193 dev_pm_opp_put_clkname(data);
2197 * devm_pm_opp_set_clkname() - Set clk name for the device
2198 * @dev: Device for which clk name is being set.
2201 * This is a resource-managed variant of dev_pm_opp_set_clkname().
2203 * Return: 0 on success and errorno otherwise.
2205 int devm_pm_opp_set_clkname(struct device *dev, const char *name)
2207 struct opp_table *opp_table;
2209 opp_table = dev_pm_opp_set_clkname(dev, name);
2210 if (IS_ERR(opp_table))
2211 return PTR_ERR(opp_table);
2213 return devm_add_action_or_reset(dev, devm_pm_opp_clkname_release,
2216 EXPORT_SYMBOL_GPL(devm_pm_opp_set_clkname);
2219 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
2220 * @dev: Device for which the helper is getting registered.
2221 * @set_opp: Custom set OPP helper.
2223 * This is useful to support complex platforms (like platforms with multiple
2224 * regulators per device), instead of the generic OPP set rate helper.
2226 * This must be called before any OPPs are initialized for the device.
2228 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
2229 int (*set_opp)(struct dev_pm_set_opp_data *data))
2231 struct dev_pm_set_opp_data *data;
2232 struct opp_table *opp_table;
2235 return ERR_PTR(-EINVAL);
2237 opp_table = _add_opp_table(dev, false);
2238 if (IS_ERR(opp_table))
2241 /* This should be called before OPPs are initialized */
2242 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
2243 dev_pm_opp_put_opp_table(opp_table);
2244 return ERR_PTR(-EBUSY);
2247 /* Another CPU that shares the OPP table has set the helper ? */
2248 if (opp_table->set_opp)
2251 data = kzalloc(sizeof(*data), GFP_KERNEL);
2253 return ERR_PTR(-ENOMEM);
2255 mutex_lock(&opp_table->lock);
2256 opp_table->set_opp_data = data;
2257 if (opp_table->sod_supplies) {
2258 data->old_opp.supplies = opp_table->sod_supplies;
2259 data->new_opp.supplies = opp_table->sod_supplies +
2260 opp_table->regulator_count;
2262 mutex_unlock(&opp_table->lock);
2264 opp_table->set_opp = set_opp;
2268 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
2271 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
2273 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
2275 * Release resources blocked for platform specific set_opp helper.
2277 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
2279 if (unlikely(!opp_table))
2282 /* Make sure there are no concurrent readers while updating opp_table */
2283 WARN_ON(!list_empty(&opp_table->opp_list));
2285 opp_table->set_opp = NULL;
2287 mutex_lock(&opp_table->lock);
2288 kfree(opp_table->set_opp_data);
2289 opp_table->set_opp_data = NULL;
2290 mutex_unlock(&opp_table->lock);
2292 dev_pm_opp_put_opp_table(opp_table);
2294 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
2296 static void devm_pm_opp_unregister_set_opp_helper(void *data)
2298 dev_pm_opp_unregister_set_opp_helper(data);
2302 * devm_pm_opp_register_set_opp_helper() - Register custom set OPP helper
2303 * @dev: Device for which the helper is getting registered.
2304 * @set_opp: Custom set OPP helper.
2306 * This is a resource-managed version of dev_pm_opp_register_set_opp_helper().
2308 * Return: 0 on success and errorno otherwise.
2310 int devm_pm_opp_register_set_opp_helper(struct device *dev,
2311 int (*set_opp)(struct dev_pm_set_opp_data *data))
2313 struct opp_table *opp_table;
2315 opp_table = dev_pm_opp_register_set_opp_helper(dev, set_opp);
2316 if (IS_ERR(opp_table))
2317 return PTR_ERR(opp_table);
2319 return devm_add_action_or_reset(dev, devm_pm_opp_unregister_set_opp_helper,
2322 EXPORT_SYMBOL_GPL(devm_pm_opp_register_set_opp_helper);
2324 static void _opp_detach_genpd(struct opp_table *opp_table)
2328 if (!opp_table->genpd_virt_devs)
2331 for (index = 0; index < opp_table->required_opp_count; index++) {
2332 if (!opp_table->genpd_virt_devs[index])
2335 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
2336 opp_table->genpd_virt_devs[index] = NULL;
2339 kfree(opp_table->genpd_virt_devs);
2340 opp_table->genpd_virt_devs = NULL;
2344 * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
2345 * @dev: Consumer device for which the genpd is getting attached.
2346 * @names: Null terminated array of pointers containing names of genpd to attach.
2347 * @virt_devs: Pointer to return the array of virtual devices.
2349 * Multiple generic power domains for a device are supported with the help of
2350 * virtual genpd devices, which are created for each consumer device - genpd
2351 * pair. These are the device structures which are attached to the power domain
2352 * and are required by the OPP core to set the performance state of the genpd.
2353 * The same API also works for the case where single genpd is available and so
2354 * we don't need to support that separately.
2356 * This helper will normally be called by the consumer driver of the device
2357 * "dev", as only that has details of the genpd names.
2359 * This helper needs to be called once with a list of all genpd to attach.
2360 * Otherwise the original device structure will be used instead by the OPP core.
2362 * The order of entries in the names array must match the order in which
2363 * "required-opps" are added in DT.
2365 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
2366 const char **names, struct device ***virt_devs)
2368 struct opp_table *opp_table;
2369 struct device *virt_dev;
2370 int index = 0, ret = -EINVAL;
2371 const char **name = names;
2373 opp_table = _add_opp_table(dev, false);
2374 if (IS_ERR(opp_table))
2377 if (opp_table->genpd_virt_devs)
2381 * If the genpd's OPP table isn't already initialized, parsing of the
2382 * required-opps fail for dev. We should retry this after genpd's OPP
2385 if (!opp_table->required_opp_count) {
2386 ret = -EPROBE_DEFER;
2390 mutex_lock(&opp_table->genpd_virt_dev_lock);
2392 opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
2393 sizeof(*opp_table->genpd_virt_devs),
2395 if (!opp_table->genpd_virt_devs)
2399 if (index >= opp_table->required_opp_count) {
2400 dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
2401 *name, opp_table->required_opp_count, index);
2405 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
2406 if (IS_ERR(virt_dev)) {
2407 ret = PTR_ERR(virt_dev);
2408 dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
2412 opp_table->genpd_virt_devs[index] = virt_dev;
2418 *virt_devs = opp_table->genpd_virt_devs;
2419 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2424 _opp_detach_genpd(opp_table);
2426 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2429 dev_pm_opp_put_opp_table(opp_table);
2431 return ERR_PTR(ret);
2433 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
2436 * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
2437 * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
2439 * This detaches the genpd(s), resets the virtual device pointers, and puts the
2442 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
2444 if (unlikely(!opp_table))
2448 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
2451 mutex_lock(&opp_table->genpd_virt_dev_lock);
2452 _opp_detach_genpd(opp_table);
2453 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2455 dev_pm_opp_put_opp_table(opp_table);
2457 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
2459 static void devm_pm_opp_detach_genpd(void *data)
2461 dev_pm_opp_detach_genpd(data);
2465 * devm_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual
2467 * @dev: Consumer device for which the genpd is getting attached.
2468 * @names: Null terminated array of pointers containing names of genpd to attach.
2469 * @virt_devs: Pointer to return the array of virtual devices.
2471 * This is a resource-managed version of dev_pm_opp_attach_genpd().
2473 * Return: 0 on success and errorno otherwise.
2475 int devm_pm_opp_attach_genpd(struct device *dev, const char **names,
2476 struct device ***virt_devs)
2478 struct opp_table *opp_table;
2480 opp_table = dev_pm_opp_attach_genpd(dev, names, virt_devs);
2481 if (IS_ERR(opp_table))
2482 return PTR_ERR(opp_table);
2484 return devm_add_action_or_reset(dev, devm_pm_opp_detach_genpd,
2487 EXPORT_SYMBOL_GPL(devm_pm_opp_attach_genpd);
2490 * dev_pm_opp_xlate_required_opp() - Find required OPP for @src_table OPP.
2491 * @src_table: OPP table which has @dst_table as one of its required OPP table.
2492 * @dst_table: Required OPP table of the @src_table.
2493 * @src_opp: OPP from the @src_table.
2495 * This function returns the OPP (present in @dst_table) pointed out by the
2496 * "required-opps" property of the @src_opp (present in @src_table).
2498 * The callers are required to call dev_pm_opp_put() for the returned OPP after
2501 * Return: pointer to 'struct dev_pm_opp' on success and errorno otherwise.
2503 struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
2504 struct opp_table *dst_table,
2505 struct dev_pm_opp *src_opp)
2507 struct dev_pm_opp *opp, *dest_opp = ERR_PTR(-ENODEV);
2510 if (!src_table || !dst_table || !src_opp ||
2511 !src_table->required_opp_tables)
2512 return ERR_PTR(-EINVAL);
2514 /* required-opps not fully initialized yet */
2515 if (lazy_linking_pending(src_table))
2516 return ERR_PTR(-EBUSY);
2518 for (i = 0; i < src_table->required_opp_count; i++) {
2519 if (src_table->required_opp_tables[i] == dst_table) {
2520 mutex_lock(&src_table->lock);
2522 list_for_each_entry(opp, &src_table->opp_list, node) {
2523 if (opp == src_opp) {
2524 dest_opp = opp->required_opps[i];
2525 dev_pm_opp_get(dest_opp);
2530 mutex_unlock(&src_table->lock);
2535 if (IS_ERR(dest_opp)) {
2536 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__,
2537 src_table, dst_table);
2542 EXPORT_SYMBOL_GPL(dev_pm_opp_xlate_required_opp);
2545 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
2546 * @src_table: OPP table which has dst_table as one of its required OPP table.
2547 * @dst_table: Required OPP table of the src_table.
2548 * @pstate: Current performance state of the src_table.
2550 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
2551 * "required-opps" property of the OPP (present in @src_table) which has
2552 * performance state set to @pstate.
2554 * Return: Zero or positive performance state on success, otherwise negative
2557 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
2558 struct opp_table *dst_table,
2559 unsigned int pstate)
2561 struct dev_pm_opp *opp;
2562 int dest_pstate = -EINVAL;
2566 * Normally the src_table will have the "required_opps" property set to
2567 * point to one of the OPPs in the dst_table, but in some cases the
2568 * genpd and its master have one to one mapping of performance states
2569 * and so none of them have the "required-opps" property set. Return the
2570 * pstate of the src_table as it is in such cases.
2572 if (!src_table || !src_table->required_opp_count)
2575 /* required-opps not fully initialized yet */
2576 if (lazy_linking_pending(src_table))
2579 for (i = 0; i < src_table->required_opp_count; i++) {
2580 if (src_table->required_opp_tables[i]->np == dst_table->np)
2584 if (unlikely(i == src_table->required_opp_count)) {
2585 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
2586 __func__, src_table, dst_table);
2590 mutex_lock(&src_table->lock);
2592 list_for_each_entry(opp, &src_table->opp_list, node) {
2593 if (opp->pstate == pstate) {
2594 dest_pstate = opp->required_opps[i]->pstate;
2599 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
2603 mutex_unlock(&src_table->lock);
2609 * dev_pm_opp_add() - Add an OPP table from a table definitions
2610 * @dev: device for which we do this operation
2611 * @freq: Frequency in Hz for this OPP
2612 * @u_volt: Voltage in uVolts for this OPP
2614 * This function adds an opp definition to the opp table and returns status.
2615 * The opp is made available by default and it can be controlled using
2616 * dev_pm_opp_enable/disable functions.
2620 * Duplicate OPPs (both freq and volt are same) and opp->available
2621 * -EEXIST Freq are same and volt are different OR
2622 * Duplicate OPPs (both freq and volt are same) and !opp->available
2623 * -ENOMEM Memory allocation failure
2625 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2627 struct opp_table *opp_table;
2630 opp_table = _add_opp_table(dev, true);
2631 if (IS_ERR(opp_table))
2632 return PTR_ERR(opp_table);
2634 /* Fix regulator count for dynamic OPPs */
2635 opp_table->regulator_count = 1;
2637 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2639 dev_pm_opp_put_opp_table(opp_table);
2643 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2646 * _opp_set_availability() - helper to set the availability of an opp
2647 * @dev: device for which we do this operation
2648 * @freq: OPP frequency to modify availability
2649 * @availability_req: availability status requested for this opp
2651 * Set the availability of an OPP, opp_{enable,disable} share a common logic
2652 * which is isolated here.
2654 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2655 * copy operation, returns 0 if no modification was done OR modification was
2658 static int _opp_set_availability(struct device *dev, unsigned long freq,
2659 bool availability_req)
2661 struct opp_table *opp_table;
2662 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2665 /* Find the opp_table */
2666 opp_table = _find_opp_table(dev);
2667 if (IS_ERR(opp_table)) {
2668 r = PTR_ERR(opp_table);
2669 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2673 mutex_lock(&opp_table->lock);
2675 /* Do we have the frequency? */
2676 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2677 if (tmp_opp->rate == freq) {
2688 /* Is update really needed? */
2689 if (opp->available == availability_req)
2692 opp->available = availability_req;
2694 dev_pm_opp_get(opp);
2695 mutex_unlock(&opp_table->lock);
2697 /* Notify the change of the OPP availability */
2698 if (availability_req)
2699 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2702 blocking_notifier_call_chain(&opp_table->head,
2703 OPP_EVENT_DISABLE, opp);
2705 dev_pm_opp_put(opp);
2709 mutex_unlock(&opp_table->lock);
2711 dev_pm_opp_put_opp_table(opp_table);
2716 * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2717 * @dev: device for which we do this operation
2718 * @freq: OPP frequency to adjust voltage of
2719 * @u_volt: new OPP target voltage
2720 * @u_volt_min: new OPP min voltage
2721 * @u_volt_max: new OPP max voltage
2723 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2724 * copy operation, returns 0 if no modifcation was done OR modification was
2727 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2728 unsigned long u_volt, unsigned long u_volt_min,
2729 unsigned long u_volt_max)
2732 struct opp_table *opp_table;
2733 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2736 /* Find the opp_table */
2737 opp_table = _find_opp_table(dev);
2738 if (IS_ERR(opp_table)) {
2739 r = PTR_ERR(opp_table);
2740 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2744 mutex_lock(&opp_table->lock);
2746 /* Do we have the frequency? */
2747 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2748 if (tmp_opp->rate == freq) {
2759 /* Is update really needed? */
2760 if (opp->supplies->u_volt == u_volt)
2763 opp->supplies->u_volt = u_volt;
2764 opp->supplies->u_volt_min = u_volt_min;
2765 opp->supplies->u_volt_max = u_volt_max;
2767 dev_pm_opp_get(opp);
2768 mutex_unlock(&opp_table->lock);
2770 /* Notify the voltage change of the OPP */
2771 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2774 dev_pm_opp_put(opp);
2775 goto adjust_put_table;
2778 mutex_unlock(&opp_table->lock);
2780 dev_pm_opp_put_opp_table(opp_table);
2783 EXPORT_SYMBOL_GPL(dev_pm_opp_adjust_voltage);
2786 * dev_pm_opp_enable() - Enable a specific OPP
2787 * @dev: device for which we do this operation
2788 * @freq: OPP frequency to enable
2790 * Enables a provided opp. If the operation is valid, this returns 0, else the
2791 * corresponding error value. It is meant to be used for users an OPP available
2792 * after being temporarily made unavailable with dev_pm_opp_disable.
2794 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2795 * copy operation, returns 0 if no modification was done OR modification was
2798 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2800 return _opp_set_availability(dev, freq, true);
2802 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2805 * dev_pm_opp_disable() - Disable a specific OPP
2806 * @dev: device for which we do this operation
2807 * @freq: OPP frequency to disable
2809 * Disables a provided opp. If the operation is valid, this returns
2810 * 0, else the corresponding error value. It is meant to be a temporary
2811 * control by users to make this OPP not available until the circumstances are
2812 * right to make it available again (with a call to dev_pm_opp_enable).
2814 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2815 * copy operation, returns 0 if no modification was done OR modification was
2818 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2820 return _opp_set_availability(dev, freq, false);
2822 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2825 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2826 * @dev: Device for which notifier needs to be registered
2827 * @nb: Notifier block to be registered
2829 * Return: 0 on success or a negative error value.
2831 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2833 struct opp_table *opp_table;
2836 opp_table = _find_opp_table(dev);
2837 if (IS_ERR(opp_table))
2838 return PTR_ERR(opp_table);
2840 ret = blocking_notifier_chain_register(&opp_table->head, nb);
2842 dev_pm_opp_put_opp_table(opp_table);
2846 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2849 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2850 * @dev: Device for which notifier needs to be unregistered
2851 * @nb: Notifier block to be unregistered
2853 * Return: 0 on success or a negative error value.
2855 int dev_pm_opp_unregister_notifier(struct device *dev,
2856 struct notifier_block *nb)
2858 struct opp_table *opp_table;
2861 opp_table = _find_opp_table(dev);
2862 if (IS_ERR(opp_table))
2863 return PTR_ERR(opp_table);
2865 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2867 dev_pm_opp_put_opp_table(opp_table);
2871 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2874 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2875 * @dev: device pointer used to lookup OPP table.
2877 * Free both OPPs created using static entries present in DT and the
2878 * dynamically added entries.
2880 void dev_pm_opp_remove_table(struct device *dev)
2882 struct opp_table *opp_table;
2884 /* Check for existing table for 'dev' */
2885 opp_table = _find_opp_table(dev);
2886 if (IS_ERR(opp_table)) {
2887 int error = PTR_ERR(opp_table);
2889 if (error != -ENODEV)
2890 WARN(1, "%s: opp_table: %d\n",
2891 IS_ERR_OR_NULL(dev) ?
2892 "Invalid device" : dev_name(dev),
2898 * Drop the extra reference only if the OPP table was successfully added
2899 * with dev_pm_opp_of_add_table() earlier.
2901 if (_opp_remove_all_static(opp_table))
2902 dev_pm_opp_put_opp_table(opp_table);
2904 /* Drop reference taken by _find_opp_table() */
2905 dev_pm_opp_put_opp_table(opp_table);
2907 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);
2910 * dev_pm_opp_sync_regulators() - Sync state of voltage regulators
2911 * @dev: device for which we do this operation
2913 * Sync voltage state of the OPP table regulators.
2915 * Return: 0 on success or a negative error value.
2917 int dev_pm_opp_sync_regulators(struct device *dev)
2919 struct opp_table *opp_table;
2920 struct regulator *reg;
2923 /* Device may not have OPP table */
2924 opp_table = _find_opp_table(dev);
2925 if (IS_ERR(opp_table))
2928 /* Regulator may not be required for the device */
2929 if (unlikely(!opp_table->regulators))
2932 /* Nothing to sync if voltage wasn't changed */
2933 if (!opp_table->enabled)
2936 for (i = 0; i < opp_table->regulator_count; i++) {
2937 reg = opp_table->regulators[i];
2938 ret = regulator_sync_voltage(reg);
2943 /* Drop reference taken by _find_opp_table() */
2944 dev_pm_opp_put_opp_table(opp_table);
2948 EXPORT_SYMBOL_GPL(dev_pm_opp_sync_regulators);