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)
896 /* required-opps not fully initialized yet */
897 if (lazy_linking_pending(opp_table))
900 /* Single genpd case */
901 if (!genpd_virt_devs)
902 return _set_required_opp(dev, dev, opp, 0);
904 /* Multiple genpd case */
907 * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
908 * after it is freed from another thread.
910 mutex_lock(&opp_table->genpd_virt_dev_lock);
912 /* Scaling up? Set required OPPs in normal order, else reverse */
914 for (i = 0; i < opp_table->required_opp_count; i++) {
915 ret = _set_required_opp(dev, genpd_virt_devs[i], opp, i);
920 for (i = opp_table->required_opp_count - 1; i >= 0; i--) {
921 ret = _set_required_opp(dev, genpd_virt_devs[i], opp, i);
927 mutex_unlock(&opp_table->genpd_virt_dev_lock);
932 static void _find_current_opp(struct device *dev, struct opp_table *opp_table)
934 struct dev_pm_opp *opp = ERR_PTR(-ENODEV);
937 if (!IS_ERR(opp_table->clk)) {
938 freq = clk_get_rate(opp_table->clk);
939 opp = _find_freq_ceil(opp_table, &freq);
943 * Unable to find the current OPP ? Pick the first from the list since
944 * it is in ascending order, otherwise rest of the code will need to
945 * make special checks to validate current_opp.
948 mutex_lock(&opp_table->lock);
949 opp = list_first_entry(&opp_table->opp_list, struct dev_pm_opp, node);
951 mutex_unlock(&opp_table->lock);
954 opp_table->current_opp = opp;
957 static int _disable_opp_table(struct device *dev, struct opp_table *opp_table)
961 if (!opp_table->enabled)
965 * Some drivers need to support cases where some platforms may
966 * have OPP table for the device, while others don't and
967 * opp_set_rate() just needs to behave like clk_set_rate().
969 if (!_get_opp_count(opp_table))
972 ret = _set_opp_bw(opp_table, NULL, dev);
976 if (opp_table->regulators)
977 regulator_disable(opp_table->regulators[0]);
979 ret = _set_required_opps(dev, opp_table, NULL, false);
981 opp_table->enabled = false;
985 static int _set_opp(struct device *dev, struct opp_table *opp_table,
986 struct dev_pm_opp *opp, unsigned long freq)
988 struct dev_pm_opp *old_opp;
989 int scaling_down, ret;
992 return _disable_opp_table(dev, opp_table);
994 /* Find the currently set OPP if we don't know already */
995 if (unlikely(!opp_table->current_opp))
996 _find_current_opp(dev, opp_table);
998 old_opp = opp_table->current_opp;
1000 /* Return early if nothing to do */
1001 if (old_opp == opp && opp_table->current_rate == freq &&
1002 opp_table->enabled) {
1003 dev_dbg(dev, "%s: OPPs are same, nothing to do\n", __func__);
1007 dev_dbg(dev, "%s: switching OPP: Freq %lu -> %lu Hz, Level %u -> %u, Bw %u -> %u\n",
1008 __func__, opp_table->current_rate, freq, old_opp->level,
1009 opp->level, old_opp->bandwidth ? old_opp->bandwidth[0].peak : 0,
1010 opp->bandwidth ? opp->bandwidth[0].peak : 0);
1012 scaling_down = _opp_compare_key(old_opp, opp);
1013 if (scaling_down == -1)
1016 /* Scaling up? Configure required OPPs before frequency */
1017 if (!scaling_down) {
1018 ret = _set_required_opps(dev, opp_table, opp, true);
1020 dev_err(dev, "Failed to set required opps: %d\n", ret);
1024 ret = _set_opp_bw(opp_table, opp, dev);
1026 dev_err(dev, "Failed to set bw: %d\n", ret);
1031 if (opp_table->set_opp) {
1032 ret = _set_opp_custom(opp_table, dev, opp, freq);
1033 } else if (opp_table->regulators) {
1034 ret = _generic_set_opp_regulator(opp_table, dev, opp, freq,
1037 /* Only frequency scaling */
1038 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
1044 /* Scaling down? Configure required OPPs after frequency */
1046 ret = _set_opp_bw(opp_table, opp, dev);
1048 dev_err(dev, "Failed to set bw: %d\n", ret);
1052 ret = _set_required_opps(dev, opp_table, opp, false);
1054 dev_err(dev, "Failed to set required opps: %d\n", ret);
1059 opp_table->enabled = true;
1060 dev_pm_opp_put(old_opp);
1062 /* Make sure current_opp doesn't get freed */
1063 dev_pm_opp_get(opp);
1064 opp_table->current_opp = opp;
1065 opp_table->current_rate = freq;
1071 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
1072 * @dev: device for which we do this operation
1073 * @target_freq: frequency to achieve
1075 * This configures the power-supplies to the levels specified by the OPP
1076 * corresponding to the target_freq, and programs the clock to a value <=
1077 * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
1078 * provided by the opp, should have already rounded to the target OPP's
1081 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
1083 struct opp_table *opp_table;
1084 unsigned long freq = 0, temp_freq;
1085 struct dev_pm_opp *opp = NULL;
1088 opp_table = _find_opp_table(dev);
1089 if (IS_ERR(opp_table)) {
1090 dev_err(dev, "%s: device's opp table doesn't exist\n", __func__);
1091 return PTR_ERR(opp_table);
1096 * For IO devices which require an OPP on some platforms/SoCs
1097 * while just needing to scale the clock on some others
1098 * we look for empty OPP tables with just a clock handle and
1099 * scale only the clk. This makes dev_pm_opp_set_rate()
1100 * equivalent to a clk_set_rate()
1102 if (!_get_opp_count(opp_table)) {
1103 ret = _generic_set_opp_clk_only(dev, opp_table->clk, target_freq);
1107 freq = clk_round_rate(opp_table->clk, target_freq);
1108 if ((long)freq <= 0)
1112 * The clock driver may support finer resolution of the
1113 * frequencies than the OPP table, don't update the frequency we
1114 * pass to clk_set_rate() here.
1117 opp = _find_freq_ceil(opp_table, &temp_freq);
1120 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
1121 __func__, freq, ret);
1126 ret = _set_opp(dev, opp_table, opp, freq);
1129 dev_pm_opp_put(opp);
1131 dev_pm_opp_put_opp_table(opp_table);
1134 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
1137 * dev_pm_opp_set_opp() - Configure device for OPP
1138 * @dev: device for which we do this operation
1139 * @opp: OPP to set to
1141 * This configures the device based on the properties of the OPP passed to this
1144 * Return: 0 on success, a negative error number otherwise.
1146 int dev_pm_opp_set_opp(struct device *dev, struct dev_pm_opp *opp)
1148 struct opp_table *opp_table;
1151 opp_table = _find_opp_table(dev);
1152 if (IS_ERR(opp_table)) {
1153 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
1154 return PTR_ERR(opp_table);
1157 ret = _set_opp(dev, opp_table, opp, opp ? opp->rate : 0);
1158 dev_pm_opp_put_opp_table(opp_table);
1162 EXPORT_SYMBOL_GPL(dev_pm_opp_set_opp);
1164 /* OPP-dev Helpers */
1165 static void _remove_opp_dev(struct opp_device *opp_dev,
1166 struct opp_table *opp_table)
1168 opp_debug_unregister(opp_dev, opp_table);
1169 list_del(&opp_dev->node);
1173 struct opp_device *_add_opp_dev(const struct device *dev,
1174 struct opp_table *opp_table)
1176 struct opp_device *opp_dev;
1178 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
1182 /* Initialize opp-dev */
1185 mutex_lock(&opp_table->lock);
1186 list_add(&opp_dev->node, &opp_table->dev_list);
1187 mutex_unlock(&opp_table->lock);
1189 /* Create debugfs entries for the opp_table */
1190 opp_debug_register(opp_dev, opp_table);
1195 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
1197 struct opp_table *opp_table;
1198 struct opp_device *opp_dev;
1202 * Allocate a new OPP table. In the infrequent case where a new
1203 * device is needed to be added, we pay this penalty.
1205 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
1207 return ERR_PTR(-ENOMEM);
1209 mutex_init(&opp_table->lock);
1210 mutex_init(&opp_table->genpd_virt_dev_lock);
1211 INIT_LIST_HEAD(&opp_table->dev_list);
1212 INIT_LIST_HEAD(&opp_table->lazy);
1214 /* Mark regulator count uninitialized */
1215 opp_table->regulator_count = -1;
1217 opp_dev = _add_opp_dev(dev, opp_table);
1223 _of_init_opp_table(opp_table, dev, index);
1225 /* Find interconnect path(s) for the device */
1226 ret = dev_pm_opp_of_find_icc_paths(dev, opp_table);
1228 if (ret == -EPROBE_DEFER)
1229 goto remove_opp_dev;
1231 dev_warn(dev, "%s: Error finding interconnect paths: %d\n",
1235 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
1236 INIT_LIST_HEAD(&opp_table->opp_list);
1237 kref_init(&opp_table->kref);
1242 _remove_opp_dev(opp_dev, opp_table);
1245 return ERR_PTR(ret);
1248 void _get_opp_table_kref(struct opp_table *opp_table)
1250 kref_get(&opp_table->kref);
1253 static struct opp_table *_update_opp_table_clk(struct device *dev,
1254 struct opp_table *opp_table,
1260 * Return early if we don't need to get clk or we have already tried it
1263 if (!getclk || IS_ERR(opp_table) || opp_table->clk)
1266 /* Find clk for the device */
1267 opp_table->clk = clk_get(dev, NULL);
1269 ret = PTR_ERR_OR_ZERO(opp_table->clk);
1273 if (ret == -ENOENT) {
1274 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__, ret);
1278 dev_pm_opp_put_opp_table(opp_table);
1279 dev_err_probe(dev, ret, "Couldn't find clock\n");
1281 return ERR_PTR(ret);
1285 * We need to make sure that the OPP table for a device doesn't get added twice,
1286 * if this routine gets called in parallel with the same device pointer.
1288 * The simplest way to enforce that is to perform everything (find existing
1289 * table and if not found, create a new one) under the opp_table_lock, so only
1290 * one creator gets access to the same. But that expands the critical section
1291 * under the lock and may end up causing circular dependencies with frameworks
1292 * like debugfs, interconnect or clock framework as they may be direct or
1293 * indirect users of OPP core.
1295 * And for that reason we have to go for a bit tricky implementation here, which
1296 * uses the opp_tables_busy flag to indicate if another creator is in the middle
1297 * of adding an OPP table and others should wait for it to finish.
1299 struct opp_table *_add_opp_table_indexed(struct device *dev, int index,
1302 struct opp_table *opp_table;
1305 mutex_lock(&opp_table_lock);
1307 opp_table = _find_opp_table_unlocked(dev);
1308 if (!IS_ERR(opp_table))
1312 * The opp_tables list or an OPP table's dev_list is getting updated by
1313 * another user, wait for it to finish.
1315 if (unlikely(opp_tables_busy)) {
1316 mutex_unlock(&opp_table_lock);
1321 opp_tables_busy = true;
1322 opp_table = _managed_opp(dev, index);
1324 /* Drop the lock to reduce the size of critical section */
1325 mutex_unlock(&opp_table_lock);
1328 if (!_add_opp_dev(dev, opp_table)) {
1329 dev_pm_opp_put_opp_table(opp_table);
1330 opp_table = ERR_PTR(-ENOMEM);
1333 mutex_lock(&opp_table_lock);
1335 opp_table = _allocate_opp_table(dev, index);
1337 mutex_lock(&opp_table_lock);
1338 if (!IS_ERR(opp_table))
1339 list_add(&opp_table->node, &opp_tables);
1342 opp_tables_busy = false;
1345 mutex_unlock(&opp_table_lock);
1347 return _update_opp_table_clk(dev, opp_table, getclk);
1350 static struct opp_table *_add_opp_table(struct device *dev, bool getclk)
1352 return _add_opp_table_indexed(dev, 0, getclk);
1355 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1357 return _find_opp_table(dev);
1359 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1361 static void _opp_table_kref_release(struct kref *kref)
1363 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1364 struct opp_device *opp_dev, *temp;
1367 /* Drop the lock as soon as we can */
1368 list_del(&opp_table->node);
1369 mutex_unlock(&opp_table_lock);
1371 if (opp_table->current_opp)
1372 dev_pm_opp_put(opp_table->current_opp);
1374 _of_clear_opp_table(opp_table);
1377 if (!IS_ERR(opp_table->clk))
1378 clk_put(opp_table->clk);
1380 if (opp_table->paths) {
1381 for (i = 0; i < opp_table->path_count; i++)
1382 icc_put(opp_table->paths[i]);
1383 kfree(opp_table->paths);
1386 WARN_ON(!list_empty(&opp_table->opp_list));
1388 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1390 * The OPP table is getting removed, drop the performance state
1393 if (opp_table->genpd_performance_state)
1394 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1396 _remove_opp_dev(opp_dev, opp_table);
1399 mutex_destroy(&opp_table->genpd_virt_dev_lock);
1400 mutex_destroy(&opp_table->lock);
1404 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1406 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1409 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1411 void _opp_free(struct dev_pm_opp *opp)
1416 static void _opp_kref_release(struct kref *kref)
1418 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1419 struct opp_table *opp_table = opp->opp_table;
1421 list_del(&opp->node);
1422 mutex_unlock(&opp_table->lock);
1425 * Notify the changes in the availability of the operable
1426 * frequency/voltage list.
1428 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1429 _of_opp_free_required_opps(opp_table, opp);
1430 opp_debug_remove_one(opp);
1434 void dev_pm_opp_get(struct dev_pm_opp *opp)
1436 kref_get(&opp->kref);
1439 void dev_pm_opp_put(struct dev_pm_opp *opp)
1441 kref_put_mutex(&opp->kref, _opp_kref_release, &opp->opp_table->lock);
1443 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1446 * dev_pm_opp_remove() - Remove an OPP from OPP table
1447 * @dev: device for which we do this operation
1448 * @freq: OPP to remove with matching 'freq'
1450 * This function removes an opp from the opp table.
1452 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1454 struct dev_pm_opp *opp;
1455 struct opp_table *opp_table;
1458 opp_table = _find_opp_table(dev);
1459 if (IS_ERR(opp_table))
1462 mutex_lock(&opp_table->lock);
1464 list_for_each_entry(opp, &opp_table->opp_list, node) {
1465 if (opp->rate == freq) {
1471 mutex_unlock(&opp_table->lock);
1474 dev_pm_opp_put(opp);
1476 /* Drop the reference taken by dev_pm_opp_add() */
1477 dev_pm_opp_put_opp_table(opp_table);
1479 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1483 /* Drop the reference taken by _find_opp_table() */
1484 dev_pm_opp_put_opp_table(opp_table);
1486 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1488 static struct dev_pm_opp *_opp_get_next(struct opp_table *opp_table,
1491 struct dev_pm_opp *opp = NULL, *temp;
1493 mutex_lock(&opp_table->lock);
1494 list_for_each_entry(temp, &opp_table->opp_list, node) {
1496 * Refcount must be dropped only once for each OPP by OPP core,
1497 * do that with help of "removed" flag.
1499 if (!temp->removed && dynamic == temp->dynamic) {
1505 mutex_unlock(&opp_table->lock);
1510 * Can't call dev_pm_opp_put() from under the lock as debugfs removal needs to
1511 * happen lock less to avoid circular dependency issues. This routine must be
1512 * called without the opp_table->lock held.
1514 static void _opp_remove_all(struct opp_table *opp_table, bool dynamic)
1516 struct dev_pm_opp *opp;
1518 while ((opp = _opp_get_next(opp_table, dynamic))) {
1519 opp->removed = true;
1520 dev_pm_opp_put(opp);
1522 /* Drop the references taken by dev_pm_opp_add() */
1524 dev_pm_opp_put_opp_table(opp_table);
1528 bool _opp_remove_all_static(struct opp_table *opp_table)
1530 mutex_lock(&opp_table->lock);
1532 if (!opp_table->parsed_static_opps) {
1533 mutex_unlock(&opp_table->lock);
1537 if (--opp_table->parsed_static_opps) {
1538 mutex_unlock(&opp_table->lock);
1542 mutex_unlock(&opp_table->lock);
1544 _opp_remove_all(opp_table, false);
1549 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1550 * @dev: device for which we do this operation
1552 * This function removes all dynamically created OPPs from the opp table.
1554 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1556 struct opp_table *opp_table;
1558 opp_table = _find_opp_table(dev);
1559 if (IS_ERR(opp_table))
1562 _opp_remove_all(opp_table, true);
1564 /* Drop the reference taken by _find_opp_table() */
1565 dev_pm_opp_put_opp_table(opp_table);
1567 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1569 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1571 struct dev_pm_opp *opp;
1572 int supply_count, supply_size, icc_size;
1574 /* Allocate space for at least one supply */
1575 supply_count = table->regulator_count > 0 ? table->regulator_count : 1;
1576 supply_size = sizeof(*opp->supplies) * supply_count;
1577 icc_size = sizeof(*opp->bandwidth) * table->path_count;
1579 /* allocate new OPP node and supplies structures */
1580 opp = kzalloc(sizeof(*opp) + supply_size + icc_size, GFP_KERNEL);
1585 /* Put the supplies at the end of the OPP structure as an empty array */
1586 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1588 opp->bandwidth = (struct dev_pm_opp_icc_bw *)(opp->supplies + supply_count);
1589 INIT_LIST_HEAD(&opp->node);
1594 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1595 struct opp_table *opp_table)
1597 struct regulator *reg;
1600 if (!opp_table->regulators)
1603 for (i = 0; i < opp_table->regulator_count; i++) {
1604 reg = opp_table->regulators[i];
1606 if (!regulator_is_supported_voltage(reg,
1607 opp->supplies[i].u_volt_min,
1608 opp->supplies[i].u_volt_max)) {
1609 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1610 __func__, opp->supplies[i].u_volt_min,
1611 opp->supplies[i].u_volt_max);
1619 int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2)
1621 if (opp1->rate != opp2->rate)
1622 return opp1->rate < opp2->rate ? -1 : 1;
1623 if (opp1->bandwidth && opp2->bandwidth &&
1624 opp1->bandwidth[0].peak != opp2->bandwidth[0].peak)
1625 return opp1->bandwidth[0].peak < opp2->bandwidth[0].peak ? -1 : 1;
1626 if (opp1->level != opp2->level)
1627 return opp1->level < opp2->level ? -1 : 1;
1631 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1632 struct opp_table *opp_table,
1633 struct list_head **head)
1635 struct dev_pm_opp *opp;
1639 * Insert new OPP in order of increasing frequency and discard if
1642 * Need to use &opp_table->opp_list in the condition part of the 'for'
1643 * loop, don't replace it with head otherwise it will become an infinite
1646 list_for_each_entry(opp, &opp_table->opp_list, node) {
1647 opp_cmp = _opp_compare_key(new_opp, opp);
1656 /* Duplicate OPPs */
1657 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1658 __func__, opp->rate, opp->supplies[0].u_volt,
1659 opp->available, new_opp->rate,
1660 new_opp->supplies[0].u_volt, new_opp->available);
1662 /* Should we compare voltages for all regulators here ? */
1663 return opp->available &&
1664 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1670 void _required_opps_available(struct dev_pm_opp *opp, int count)
1674 for (i = 0; i < count; i++) {
1675 if (opp->required_opps[i]->available)
1678 opp->available = false;
1679 pr_warn("%s: OPP not supported by required OPP %pOF (%lu)\n",
1680 __func__, opp->required_opps[i]->np, opp->rate);
1687 * 0: On success. And appropriate error message for duplicate OPPs.
1688 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1689 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1690 * sure we don't print error messages unnecessarily if different parts of
1691 * kernel try to initialize the OPP table.
1692 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1693 * should be considered an error by the callers of _opp_add().
1695 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1696 struct opp_table *opp_table, bool rate_not_available)
1698 struct list_head *head;
1701 mutex_lock(&opp_table->lock);
1702 head = &opp_table->opp_list;
1704 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1706 mutex_unlock(&opp_table->lock);
1710 list_add(&new_opp->node, head);
1711 mutex_unlock(&opp_table->lock);
1713 new_opp->opp_table = opp_table;
1714 kref_init(&new_opp->kref);
1716 opp_debug_create_one(new_opp, opp_table);
1718 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1719 new_opp->available = false;
1720 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1721 __func__, new_opp->rate);
1724 /* required-opps not fully initialized yet */
1725 if (lazy_linking_pending(opp_table))
1728 _required_opps_available(new_opp, opp_table->required_opp_count);
1734 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1735 * @opp_table: OPP table
1736 * @dev: device for which we do this operation
1737 * @freq: Frequency in Hz for this OPP
1738 * @u_volt: Voltage in uVolts for this OPP
1739 * @dynamic: Dynamically added OPPs.
1741 * This function adds an opp definition to the opp table and returns status.
1742 * The opp is made available by default and it can be controlled using
1743 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1745 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1746 * and freed by dev_pm_opp_of_remove_table.
1750 * Duplicate OPPs (both freq and volt are same) and opp->available
1751 * -EEXIST Freq are same and volt are different OR
1752 * Duplicate OPPs (both freq and volt are same) and !opp->available
1753 * -ENOMEM Memory allocation failure
1755 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1756 unsigned long freq, long u_volt, bool dynamic)
1758 struct dev_pm_opp *new_opp;
1762 new_opp = _opp_allocate(opp_table);
1766 /* populate the opp table */
1767 new_opp->rate = freq;
1768 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1769 new_opp->supplies[0].u_volt = u_volt;
1770 new_opp->supplies[0].u_volt_min = u_volt - tol;
1771 new_opp->supplies[0].u_volt_max = u_volt + tol;
1772 new_opp->available = true;
1773 new_opp->dynamic = dynamic;
1775 ret = _opp_add(dev, new_opp, opp_table, false);
1777 /* Don't return error for duplicate OPPs */
1784 * Notify the changes in the availability of the operable
1785 * frequency/voltage list.
1787 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1797 * dev_pm_opp_set_supported_hw() - Set supported platforms
1798 * @dev: Device for which supported-hw has to be set.
1799 * @versions: Array of hierarchy of versions to match.
1800 * @count: Number of elements in the array.
1802 * This is required only for the V2 bindings, and it enables a platform to
1803 * specify the hierarchy of versions it supports. OPP layer will then enable
1804 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1807 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1808 const u32 *versions, unsigned int count)
1810 struct opp_table *opp_table;
1812 opp_table = _add_opp_table(dev, false);
1813 if (IS_ERR(opp_table))
1816 /* Make sure there are no concurrent readers while updating opp_table */
1817 WARN_ON(!list_empty(&opp_table->opp_list));
1819 /* Another CPU that shares the OPP table has set the property ? */
1820 if (opp_table->supported_hw)
1823 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1825 if (!opp_table->supported_hw) {
1826 dev_pm_opp_put_opp_table(opp_table);
1827 return ERR_PTR(-ENOMEM);
1830 opp_table->supported_hw_count = count;
1834 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1837 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1838 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1840 * This is required only for the V2 bindings, and is called for a matching
1841 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1842 * will not be freed.
1844 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1846 if (unlikely(!opp_table))
1849 /* Make sure there are no concurrent readers while updating opp_table */
1850 WARN_ON(!list_empty(&opp_table->opp_list));
1852 kfree(opp_table->supported_hw);
1853 opp_table->supported_hw = NULL;
1854 opp_table->supported_hw_count = 0;
1856 dev_pm_opp_put_opp_table(opp_table);
1858 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1861 * dev_pm_opp_set_prop_name() - Set prop-extn name
1862 * @dev: Device for which the prop-name has to be set.
1863 * @name: name to postfix to properties.
1865 * This is required only for the V2 bindings, and it enables a platform to
1866 * specify the extn to be used for certain property names. The properties to
1867 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1868 * should postfix the property name with -<name> while looking for them.
1870 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1872 struct opp_table *opp_table;
1874 opp_table = _add_opp_table(dev, false);
1875 if (IS_ERR(opp_table))
1878 /* Make sure there are no concurrent readers while updating opp_table */
1879 WARN_ON(!list_empty(&opp_table->opp_list));
1881 /* Another CPU that shares the OPP table has set the property ? */
1882 if (opp_table->prop_name)
1885 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1886 if (!opp_table->prop_name) {
1887 dev_pm_opp_put_opp_table(opp_table);
1888 return ERR_PTR(-ENOMEM);
1893 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1896 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1897 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1899 * This is required only for the V2 bindings, and is called for a matching
1900 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1901 * will not be freed.
1903 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1905 if (unlikely(!opp_table))
1908 /* Make sure there are no concurrent readers while updating opp_table */
1909 WARN_ON(!list_empty(&opp_table->opp_list));
1911 kfree(opp_table->prop_name);
1912 opp_table->prop_name = NULL;
1914 dev_pm_opp_put_opp_table(opp_table);
1916 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1919 * dev_pm_opp_set_regulators() - Set regulator names for the device
1920 * @dev: Device for which regulator name is being set.
1921 * @names: Array of pointers to the names of the regulator.
1922 * @count: Number of regulators.
1924 * In order to support OPP switching, OPP layer needs to know the name of the
1925 * device's regulators, as the core would be required to switch voltages as
1928 * This must be called before any OPPs are initialized for the device.
1930 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1931 const char * const names[],
1934 struct dev_pm_opp_supply *supplies;
1935 struct opp_table *opp_table;
1936 struct regulator *reg;
1939 opp_table = _add_opp_table(dev, false);
1940 if (IS_ERR(opp_table))
1943 /* This should be called before OPPs are initialized */
1944 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1949 /* Another CPU that shares the OPP table has set the regulators ? */
1950 if (opp_table->regulators)
1953 opp_table->regulators = kmalloc_array(count,
1954 sizeof(*opp_table->regulators),
1956 if (!opp_table->regulators) {
1961 for (i = 0; i < count; i++) {
1962 reg = regulator_get_optional(dev, names[i]);
1965 if (ret != -EPROBE_DEFER)
1966 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1967 __func__, names[i], ret);
1968 goto free_regulators;
1971 opp_table->regulators[i] = reg;
1974 opp_table->regulator_count = count;
1976 supplies = kmalloc_array(count * 2, sizeof(*supplies), GFP_KERNEL);
1979 goto free_regulators;
1982 mutex_lock(&opp_table->lock);
1983 opp_table->sod_supplies = supplies;
1984 if (opp_table->set_opp_data) {
1985 opp_table->set_opp_data->old_opp.supplies = supplies;
1986 opp_table->set_opp_data->new_opp.supplies = supplies + count;
1988 mutex_unlock(&opp_table->lock);
1994 regulator_put(opp_table->regulators[--i]);
1996 kfree(opp_table->regulators);
1997 opp_table->regulators = NULL;
1998 opp_table->regulator_count = -1;
2000 dev_pm_opp_put_opp_table(opp_table);
2002 return ERR_PTR(ret);
2004 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
2007 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
2008 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
2010 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
2014 if (unlikely(!opp_table))
2017 if (!opp_table->regulators)
2020 /* Make sure there are no concurrent readers while updating opp_table */
2021 WARN_ON(!list_empty(&opp_table->opp_list));
2023 if (opp_table->enabled) {
2024 for (i = opp_table->regulator_count - 1; i >= 0; i--)
2025 regulator_disable(opp_table->regulators[i]);
2028 for (i = opp_table->regulator_count - 1; i >= 0; i--)
2029 regulator_put(opp_table->regulators[i]);
2031 mutex_lock(&opp_table->lock);
2032 if (opp_table->set_opp_data) {
2033 opp_table->set_opp_data->old_opp.supplies = NULL;
2034 opp_table->set_opp_data->new_opp.supplies = NULL;
2037 kfree(opp_table->sod_supplies);
2038 opp_table->sod_supplies = NULL;
2039 mutex_unlock(&opp_table->lock);
2041 kfree(opp_table->regulators);
2042 opp_table->regulators = NULL;
2043 opp_table->regulator_count = -1;
2046 dev_pm_opp_put_opp_table(opp_table);
2048 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
2051 * dev_pm_opp_set_clkname() - Set clk name for the device
2052 * @dev: Device for which clk name is being set.
2055 * In order to support OPP switching, OPP layer needs to get pointer to the
2056 * clock for the device. Simple cases work fine without using this routine (i.e.
2057 * by passing connection-id as NULL), but for a device with multiple clocks
2058 * available, the OPP core needs to know the exact name of the clk to use.
2060 * This must be called before any OPPs are initialized for the device.
2062 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
2064 struct opp_table *opp_table;
2067 opp_table = _add_opp_table(dev, false);
2068 if (IS_ERR(opp_table))
2071 /* This should be called before OPPs are initialized */
2072 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
2077 /* clk shouldn't be initialized at this point */
2078 if (WARN_ON(opp_table->clk)) {
2083 /* Find clk for the device */
2084 opp_table->clk = clk_get(dev, name);
2085 if (IS_ERR(opp_table->clk)) {
2086 ret = PTR_ERR(opp_table->clk);
2087 if (ret != -EPROBE_DEFER) {
2088 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
2097 dev_pm_opp_put_opp_table(opp_table);
2099 return ERR_PTR(ret);
2101 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
2104 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
2105 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
2107 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
2109 if (unlikely(!opp_table))
2112 /* Make sure there are no concurrent readers while updating opp_table */
2113 WARN_ON(!list_empty(&opp_table->opp_list));
2115 clk_put(opp_table->clk);
2116 opp_table->clk = ERR_PTR(-EINVAL);
2118 dev_pm_opp_put_opp_table(opp_table);
2120 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
2123 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
2124 * @dev: Device for which the helper is getting registered.
2125 * @set_opp: Custom set OPP helper.
2127 * This is useful to support complex platforms (like platforms with multiple
2128 * regulators per device), instead of the generic OPP set rate helper.
2130 * This must be called before any OPPs are initialized for the device.
2132 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
2133 int (*set_opp)(struct dev_pm_set_opp_data *data))
2135 struct dev_pm_set_opp_data *data;
2136 struct opp_table *opp_table;
2139 return ERR_PTR(-EINVAL);
2141 opp_table = _add_opp_table(dev, false);
2142 if (IS_ERR(opp_table))
2145 /* This should be called before OPPs are initialized */
2146 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
2147 dev_pm_opp_put_opp_table(opp_table);
2148 return ERR_PTR(-EBUSY);
2151 /* Another CPU that shares the OPP table has set the helper ? */
2152 if (opp_table->set_opp)
2155 data = kzalloc(sizeof(*data), GFP_KERNEL);
2157 return ERR_PTR(-ENOMEM);
2159 mutex_lock(&opp_table->lock);
2160 opp_table->set_opp_data = data;
2161 if (opp_table->sod_supplies) {
2162 data->old_opp.supplies = opp_table->sod_supplies;
2163 data->new_opp.supplies = opp_table->sod_supplies +
2164 opp_table->regulator_count;
2166 mutex_unlock(&opp_table->lock);
2168 opp_table->set_opp = set_opp;
2172 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
2175 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
2177 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
2179 * Release resources blocked for platform specific set_opp helper.
2181 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
2183 if (unlikely(!opp_table))
2186 /* Make sure there are no concurrent readers while updating opp_table */
2187 WARN_ON(!list_empty(&opp_table->opp_list));
2189 opp_table->set_opp = NULL;
2191 mutex_lock(&opp_table->lock);
2192 kfree(opp_table->set_opp_data);
2193 opp_table->set_opp_data = NULL;
2194 mutex_unlock(&opp_table->lock);
2196 dev_pm_opp_put_opp_table(opp_table);
2198 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
2200 static void devm_pm_opp_unregister_set_opp_helper(void *data)
2202 dev_pm_opp_unregister_set_opp_helper(data);
2206 * devm_pm_opp_register_set_opp_helper() - Register custom set OPP helper
2207 * @dev: Device for which the helper is getting registered.
2208 * @set_opp: Custom set OPP helper.
2210 * This is a resource-managed version of dev_pm_opp_register_set_opp_helper().
2212 * Return: pointer to 'struct opp_table' on success and errorno otherwise.
2215 devm_pm_opp_register_set_opp_helper(struct device *dev,
2216 int (*set_opp)(struct dev_pm_set_opp_data *data))
2218 struct opp_table *opp_table;
2221 opp_table = dev_pm_opp_register_set_opp_helper(dev, set_opp);
2222 if (IS_ERR(opp_table))
2225 err = devm_add_action_or_reset(dev, devm_pm_opp_unregister_set_opp_helper,
2228 return ERR_PTR(err);
2232 EXPORT_SYMBOL_GPL(devm_pm_opp_register_set_opp_helper);
2234 static void _opp_detach_genpd(struct opp_table *opp_table)
2238 if (!opp_table->genpd_virt_devs)
2241 for (index = 0; index < opp_table->required_opp_count; index++) {
2242 if (!opp_table->genpd_virt_devs[index])
2245 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
2246 opp_table->genpd_virt_devs[index] = NULL;
2249 kfree(opp_table->genpd_virt_devs);
2250 opp_table->genpd_virt_devs = NULL;
2254 * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
2255 * @dev: Consumer device for which the genpd is getting attached.
2256 * @names: Null terminated array of pointers containing names of genpd to attach.
2257 * @virt_devs: Pointer to return the array of virtual devices.
2259 * Multiple generic power domains for a device are supported with the help of
2260 * virtual genpd devices, which are created for each consumer device - genpd
2261 * pair. These are the device structures which are attached to the power domain
2262 * and are required by the OPP core to set the performance state of the genpd.
2263 * The same API also works for the case where single genpd is available and so
2264 * we don't need to support that separately.
2266 * This helper will normally be called by the consumer driver of the device
2267 * "dev", as only that has details of the genpd names.
2269 * This helper needs to be called once with a list of all genpd to attach.
2270 * Otherwise the original device structure will be used instead by the OPP core.
2272 * The order of entries in the names array must match the order in which
2273 * "required-opps" are added in DT.
2275 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
2276 const char **names, struct device ***virt_devs)
2278 struct opp_table *opp_table;
2279 struct device *virt_dev;
2280 int index = 0, ret = -EINVAL;
2281 const char **name = names;
2283 opp_table = _add_opp_table(dev, false);
2284 if (IS_ERR(opp_table))
2287 if (opp_table->genpd_virt_devs)
2291 * If the genpd's OPP table isn't already initialized, parsing of the
2292 * required-opps fail for dev. We should retry this after genpd's OPP
2295 if (!opp_table->required_opp_count) {
2296 ret = -EPROBE_DEFER;
2300 mutex_lock(&opp_table->genpd_virt_dev_lock);
2302 opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
2303 sizeof(*opp_table->genpd_virt_devs),
2305 if (!opp_table->genpd_virt_devs)
2309 if (index >= opp_table->required_opp_count) {
2310 dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
2311 *name, opp_table->required_opp_count, index);
2315 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
2316 if (IS_ERR(virt_dev)) {
2317 ret = PTR_ERR(virt_dev);
2318 dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
2322 opp_table->genpd_virt_devs[index] = virt_dev;
2328 *virt_devs = opp_table->genpd_virt_devs;
2329 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2334 _opp_detach_genpd(opp_table);
2336 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2339 dev_pm_opp_put_opp_table(opp_table);
2341 return ERR_PTR(ret);
2343 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
2346 * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
2347 * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
2349 * This detaches the genpd(s), resets the virtual device pointers, and puts the
2352 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
2354 if (unlikely(!opp_table))
2358 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
2361 mutex_lock(&opp_table->genpd_virt_dev_lock);
2362 _opp_detach_genpd(opp_table);
2363 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2365 dev_pm_opp_put_opp_table(opp_table);
2367 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
2369 static void devm_pm_opp_detach_genpd(void *data)
2371 dev_pm_opp_detach_genpd(data);
2375 * devm_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual
2377 * @dev: Consumer device for which the genpd is getting attached.
2378 * @names: Null terminated array of pointers containing names of genpd to attach.
2379 * @virt_devs: Pointer to return the array of virtual devices.
2381 * This is a resource-managed version of dev_pm_opp_attach_genpd().
2383 * Return: pointer to 'struct opp_table' on success and errorno otherwise.
2386 devm_pm_opp_attach_genpd(struct device *dev, const char **names,
2387 struct device ***virt_devs)
2389 struct opp_table *opp_table;
2392 opp_table = dev_pm_opp_attach_genpd(dev, names, virt_devs);
2393 if (IS_ERR(opp_table))
2396 err = devm_add_action_or_reset(dev, devm_pm_opp_detach_genpd,
2399 return ERR_PTR(err);
2403 EXPORT_SYMBOL_GPL(devm_pm_opp_attach_genpd);
2406 * dev_pm_opp_xlate_required_opp() - Find required OPP for @src_table OPP.
2407 * @src_table: OPP table which has @dst_table as one of its required OPP table.
2408 * @dst_table: Required OPP table of the @src_table.
2409 * @src_opp: OPP from the @src_table.
2411 * This function returns the OPP (present in @dst_table) pointed out by the
2412 * "required-opps" property of the @src_opp (present in @src_table).
2414 * The callers are required to call dev_pm_opp_put() for the returned OPP after
2417 * Return: pointer to 'struct dev_pm_opp' on success and errorno otherwise.
2419 struct dev_pm_opp *dev_pm_opp_xlate_required_opp(struct opp_table *src_table,
2420 struct opp_table *dst_table,
2421 struct dev_pm_opp *src_opp)
2423 struct dev_pm_opp *opp, *dest_opp = ERR_PTR(-ENODEV);
2426 if (!src_table || !dst_table || !src_opp ||
2427 !src_table->required_opp_tables)
2428 return ERR_PTR(-EINVAL);
2430 /* required-opps not fully initialized yet */
2431 if (lazy_linking_pending(src_table))
2432 return ERR_PTR(-EBUSY);
2434 for (i = 0; i < src_table->required_opp_count; i++) {
2435 if (src_table->required_opp_tables[i] == dst_table) {
2436 mutex_lock(&src_table->lock);
2438 list_for_each_entry(opp, &src_table->opp_list, node) {
2439 if (opp == src_opp) {
2440 dest_opp = opp->required_opps[i];
2441 dev_pm_opp_get(dest_opp);
2446 mutex_unlock(&src_table->lock);
2451 if (IS_ERR(dest_opp)) {
2452 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__,
2453 src_table, dst_table);
2458 EXPORT_SYMBOL_GPL(dev_pm_opp_xlate_required_opp);
2461 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
2462 * @src_table: OPP table which has dst_table as one of its required OPP table.
2463 * @dst_table: Required OPP table of the src_table.
2464 * @pstate: Current performance state of the src_table.
2466 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
2467 * "required-opps" property of the OPP (present in @src_table) which has
2468 * performance state set to @pstate.
2470 * Return: Zero or positive performance state on success, otherwise negative
2473 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
2474 struct opp_table *dst_table,
2475 unsigned int pstate)
2477 struct dev_pm_opp *opp;
2478 int dest_pstate = -EINVAL;
2482 * Normally the src_table will have the "required_opps" property set to
2483 * point to one of the OPPs in the dst_table, but in some cases the
2484 * genpd and its master have one to one mapping of performance states
2485 * and so none of them have the "required-opps" property set. Return the
2486 * pstate of the src_table as it is in such cases.
2488 if (!src_table || !src_table->required_opp_count)
2491 /* required-opps not fully initialized yet */
2492 if (lazy_linking_pending(src_table))
2495 for (i = 0; i < src_table->required_opp_count; i++) {
2496 if (src_table->required_opp_tables[i]->np == dst_table->np)
2500 if (unlikely(i == src_table->required_opp_count)) {
2501 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
2502 __func__, src_table, dst_table);
2506 mutex_lock(&src_table->lock);
2508 list_for_each_entry(opp, &src_table->opp_list, node) {
2509 if (opp->pstate == pstate) {
2510 dest_pstate = opp->required_opps[i]->pstate;
2515 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
2519 mutex_unlock(&src_table->lock);
2525 * dev_pm_opp_add() - Add an OPP table from a table definitions
2526 * @dev: device for which we do this operation
2527 * @freq: Frequency in Hz for this OPP
2528 * @u_volt: Voltage in uVolts for this OPP
2530 * This function adds an opp definition to the opp table and returns status.
2531 * The opp is made available by default and it can be controlled using
2532 * dev_pm_opp_enable/disable functions.
2536 * Duplicate OPPs (both freq and volt are same) and opp->available
2537 * -EEXIST Freq are same and volt are different OR
2538 * Duplicate OPPs (both freq and volt are same) and !opp->available
2539 * -ENOMEM Memory allocation failure
2541 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2543 struct opp_table *opp_table;
2546 opp_table = _add_opp_table(dev, true);
2547 if (IS_ERR(opp_table))
2548 return PTR_ERR(opp_table);
2550 /* Fix regulator count for dynamic OPPs */
2551 opp_table->regulator_count = 1;
2553 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2555 dev_pm_opp_put_opp_table(opp_table);
2559 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2562 * _opp_set_availability() - helper to set the availability of an opp
2563 * @dev: device for which we do this operation
2564 * @freq: OPP frequency to modify availability
2565 * @availability_req: availability status requested for this opp
2567 * Set the availability of an OPP, opp_{enable,disable} share a common logic
2568 * which is isolated here.
2570 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2571 * copy operation, returns 0 if no modification was done OR modification was
2574 static int _opp_set_availability(struct device *dev, unsigned long freq,
2575 bool availability_req)
2577 struct opp_table *opp_table;
2578 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2581 /* Find the opp_table */
2582 opp_table = _find_opp_table(dev);
2583 if (IS_ERR(opp_table)) {
2584 r = PTR_ERR(opp_table);
2585 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2589 mutex_lock(&opp_table->lock);
2591 /* Do we have the frequency? */
2592 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2593 if (tmp_opp->rate == freq) {
2604 /* Is update really needed? */
2605 if (opp->available == availability_req)
2608 opp->available = availability_req;
2610 dev_pm_opp_get(opp);
2611 mutex_unlock(&opp_table->lock);
2613 /* Notify the change of the OPP availability */
2614 if (availability_req)
2615 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2618 blocking_notifier_call_chain(&opp_table->head,
2619 OPP_EVENT_DISABLE, opp);
2621 dev_pm_opp_put(opp);
2625 mutex_unlock(&opp_table->lock);
2627 dev_pm_opp_put_opp_table(opp_table);
2632 * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2633 * @dev: device for which we do this operation
2634 * @freq: OPP frequency to adjust voltage of
2635 * @u_volt: new OPP target voltage
2636 * @u_volt_min: new OPP min voltage
2637 * @u_volt_max: new OPP max voltage
2639 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2640 * copy operation, returns 0 if no modifcation was done OR modification was
2643 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2644 unsigned long u_volt, unsigned long u_volt_min,
2645 unsigned long u_volt_max)
2648 struct opp_table *opp_table;
2649 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2652 /* Find the opp_table */
2653 opp_table = _find_opp_table(dev);
2654 if (IS_ERR(opp_table)) {
2655 r = PTR_ERR(opp_table);
2656 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2660 mutex_lock(&opp_table->lock);
2662 /* Do we have the frequency? */
2663 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2664 if (tmp_opp->rate == freq) {
2675 /* Is update really needed? */
2676 if (opp->supplies->u_volt == u_volt)
2679 opp->supplies->u_volt = u_volt;
2680 opp->supplies->u_volt_min = u_volt_min;
2681 opp->supplies->u_volt_max = u_volt_max;
2683 dev_pm_opp_get(opp);
2684 mutex_unlock(&opp_table->lock);
2686 /* Notify the voltage change of the OPP */
2687 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2690 dev_pm_opp_put(opp);
2691 goto adjust_put_table;
2694 mutex_unlock(&opp_table->lock);
2696 dev_pm_opp_put_opp_table(opp_table);
2699 EXPORT_SYMBOL_GPL(dev_pm_opp_adjust_voltage);
2702 * dev_pm_opp_enable() - Enable a specific OPP
2703 * @dev: device for which we do this operation
2704 * @freq: OPP frequency to enable
2706 * Enables a provided opp. If the operation is valid, this returns 0, else the
2707 * corresponding error value. It is meant to be used for users an OPP available
2708 * after being temporarily made unavailable with dev_pm_opp_disable.
2710 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2711 * copy operation, returns 0 if no modification was done OR modification was
2714 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2716 return _opp_set_availability(dev, freq, true);
2718 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2721 * dev_pm_opp_disable() - Disable a specific OPP
2722 * @dev: device for which we do this operation
2723 * @freq: OPP frequency to disable
2725 * Disables a provided opp. If the operation is valid, this returns
2726 * 0, else the corresponding error value. It is meant to be a temporary
2727 * control by users to make this OPP not available until the circumstances are
2728 * right to make it available again (with a call to dev_pm_opp_enable).
2730 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2731 * copy operation, returns 0 if no modification was done OR modification was
2734 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2736 return _opp_set_availability(dev, freq, false);
2738 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2741 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2742 * @dev: Device for which notifier needs to be registered
2743 * @nb: Notifier block to be registered
2745 * Return: 0 on success or a negative error value.
2747 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2749 struct opp_table *opp_table;
2752 opp_table = _find_opp_table(dev);
2753 if (IS_ERR(opp_table))
2754 return PTR_ERR(opp_table);
2756 ret = blocking_notifier_chain_register(&opp_table->head, nb);
2758 dev_pm_opp_put_opp_table(opp_table);
2762 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2765 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2766 * @dev: Device for which notifier needs to be unregistered
2767 * @nb: Notifier block to be unregistered
2769 * Return: 0 on success or a negative error value.
2771 int dev_pm_opp_unregister_notifier(struct device *dev,
2772 struct notifier_block *nb)
2774 struct opp_table *opp_table;
2777 opp_table = _find_opp_table(dev);
2778 if (IS_ERR(opp_table))
2779 return PTR_ERR(opp_table);
2781 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2783 dev_pm_opp_put_opp_table(opp_table);
2787 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2790 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2791 * @dev: device pointer used to lookup OPP table.
2793 * Free both OPPs created using static entries present in DT and the
2794 * dynamically added entries.
2796 void dev_pm_opp_remove_table(struct device *dev)
2798 struct opp_table *opp_table;
2800 /* Check for existing table for 'dev' */
2801 opp_table = _find_opp_table(dev);
2802 if (IS_ERR(opp_table)) {
2803 int error = PTR_ERR(opp_table);
2805 if (error != -ENODEV)
2806 WARN(1, "%s: opp_table: %d\n",
2807 IS_ERR_OR_NULL(dev) ?
2808 "Invalid device" : dev_name(dev),
2814 * Drop the extra reference only if the OPP table was successfully added
2815 * with dev_pm_opp_of_add_table() earlier.
2817 if (_opp_remove_all_static(opp_table))
2818 dev_pm_opp_put_opp_table(opp_table);
2820 /* Drop reference taken by _find_opp_table() */
2821 dev_pm_opp_put_opp_table(opp_table);
2823 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);
2826 * dev_pm_opp_sync_regulators() - Sync state of voltage regulators
2827 * @dev: device for which we do this operation
2829 * Sync voltage state of the OPP table regulators.
2831 * Return: 0 on success or a negative error value.
2833 int dev_pm_opp_sync_regulators(struct device *dev)
2835 struct opp_table *opp_table;
2836 struct regulator *reg;
2839 /* Device may not have OPP table */
2840 opp_table = _find_opp_table(dev);
2841 if (IS_ERR(opp_table))
2844 /* Regulator may not be required for the device */
2845 if (unlikely(!opp_table->regulators))
2848 /* Nothing to sync if voltage wasn't changed */
2849 if (!opp_table->enabled)
2852 for (i = 0; i < opp_table->regulator_count; i++) {
2853 reg = opp_table->regulators[i];
2854 ret = regulator_sync_voltage(reg);
2859 /* Drop reference taken by _find_opp_table() */
2860 dev_pm_opp_put_opp_table(opp_table);
2864 EXPORT_SYMBOL_GPL(dev_pm_opp_sync_regulators);