1 // SPDX-License-Identifier: GPL-2.0-only
3 * Generic OPP Interface
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
11 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
13 #include <linux/clk.h>
14 #include <linux/errno.h>
15 #include <linux/err.h>
16 #include <linux/slab.h>
17 #include <linux/device.h>
18 #include <linux/export.h>
19 #include <linux/pm_domain.h>
20 #include <linux/regulator/consumer.h>
25 * The root of the list of all opp-tables. All opp_table structures branch off
26 * from here, with each opp_table containing the list of opps it supports in
27 * various states of availability.
29 LIST_HEAD(opp_tables);
30 /* Lock to allow exclusive modification to the device and opp lists */
31 DEFINE_MUTEX(opp_table_lock);
33 static struct opp_device *_find_opp_dev(const struct device *dev,
34 struct opp_table *opp_table)
36 struct opp_device *opp_dev;
38 list_for_each_entry(opp_dev, &opp_table->dev_list, node)
39 if (opp_dev->dev == dev)
45 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
47 struct opp_table *opp_table;
50 list_for_each_entry(opp_table, &opp_tables, node) {
51 mutex_lock(&opp_table->lock);
52 found = !!_find_opp_dev(dev, opp_table);
53 mutex_unlock(&opp_table->lock);
56 _get_opp_table_kref(opp_table);
62 return ERR_PTR(-ENODEV);
66 * _find_opp_table() - find opp_table struct using device pointer
67 * @dev: device pointer used to lookup OPP table
69 * Search OPP table for one containing matching device.
71 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
72 * -EINVAL based on type of error.
74 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
76 struct opp_table *_find_opp_table(struct device *dev)
78 struct opp_table *opp_table;
80 if (IS_ERR_OR_NULL(dev)) {
81 pr_err("%s: Invalid parameters\n", __func__);
82 return ERR_PTR(-EINVAL);
85 mutex_lock(&opp_table_lock);
86 opp_table = _find_opp_table_unlocked(dev);
87 mutex_unlock(&opp_table_lock);
93 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
94 * @opp: opp for which voltage has to be returned for
96 * Return: voltage in micro volt corresponding to the opp, else
99 * This is useful only for devices with single power supply.
101 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
103 if (IS_ERR_OR_NULL(opp)) {
104 pr_err("%s: Invalid parameters\n", __func__);
108 return opp->supplies[0].u_volt;
110 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
113 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
114 * @opp: opp for which frequency has to be returned for
116 * Return: frequency in hertz corresponding to the opp, else
119 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
121 if (IS_ERR_OR_NULL(opp) || !opp->available) {
122 pr_err("%s: Invalid parameters\n", __func__);
128 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
131 * dev_pm_opp_get_level() - Gets the level corresponding to an available opp
132 * @opp: opp for which level value has to be returned for
134 * Return: level read from device tree corresponding to the opp, else
137 unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
139 if (IS_ERR_OR_NULL(opp) || !opp->available) {
140 pr_err("%s: Invalid parameters\n", __func__);
146 EXPORT_SYMBOL_GPL(dev_pm_opp_get_level);
149 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
150 * @opp: opp for which turbo mode is being verified
152 * Turbo OPPs are not for normal use, and can be enabled (under certain
153 * conditions) for short duration of times to finish high throughput work
154 * quickly. Running on them for longer times may overheat the chip.
156 * Return: true if opp is turbo opp, else false.
158 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
160 if (IS_ERR_OR_NULL(opp) || !opp->available) {
161 pr_err("%s: Invalid parameters\n", __func__);
167 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
170 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
171 * @dev: device for which we do this operation
173 * Return: This function returns the max clock latency in nanoseconds.
175 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
177 struct opp_table *opp_table;
178 unsigned long clock_latency_ns;
180 opp_table = _find_opp_table(dev);
181 if (IS_ERR(opp_table))
184 clock_latency_ns = opp_table->clock_latency_ns_max;
186 dev_pm_opp_put_opp_table(opp_table);
188 return clock_latency_ns;
190 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
193 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
194 * @dev: device for which we do this operation
196 * Return: This function returns the max voltage latency in nanoseconds.
198 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
200 struct opp_table *opp_table;
201 struct dev_pm_opp *opp;
202 struct regulator *reg;
203 unsigned long latency_ns = 0;
210 opp_table = _find_opp_table(dev);
211 if (IS_ERR(opp_table))
214 /* Regulator may not be required for the device */
215 if (!opp_table->regulators)
218 count = opp_table->regulator_count;
220 uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
224 mutex_lock(&opp_table->lock);
226 for (i = 0; i < count; i++) {
230 list_for_each_entry(opp, &opp_table->opp_list, node) {
234 if (opp->supplies[i].u_volt_min < uV[i].min)
235 uV[i].min = opp->supplies[i].u_volt_min;
236 if (opp->supplies[i].u_volt_max > uV[i].max)
237 uV[i].max = opp->supplies[i].u_volt_max;
241 mutex_unlock(&opp_table->lock);
244 * The caller needs to ensure that opp_table (and hence the regulator)
245 * isn't freed, while we are executing this routine.
247 for (i = 0; i < count; i++) {
248 reg = opp_table->regulators[i];
249 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
251 latency_ns += ret * 1000;
256 dev_pm_opp_put_opp_table(opp_table);
260 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
263 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
265 * @dev: device for which we do this operation
267 * Return: This function returns the max transition latency, in nanoseconds, to
268 * switch from one OPP to other.
270 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
272 return dev_pm_opp_get_max_volt_latency(dev) +
273 dev_pm_opp_get_max_clock_latency(dev);
275 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
278 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
279 * @dev: device for which we do this operation
281 * Return: This function returns the frequency of the OPP marked as suspend_opp
282 * if one is available, else returns 0;
284 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
286 struct opp_table *opp_table;
287 unsigned long freq = 0;
289 opp_table = _find_opp_table(dev);
290 if (IS_ERR(opp_table))
293 if (opp_table->suspend_opp && opp_table->suspend_opp->available)
294 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
296 dev_pm_opp_put_opp_table(opp_table);
300 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
302 int _get_opp_count(struct opp_table *opp_table)
304 struct dev_pm_opp *opp;
307 mutex_lock(&opp_table->lock);
309 list_for_each_entry(opp, &opp_table->opp_list, node) {
314 mutex_unlock(&opp_table->lock);
320 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
321 * @dev: device for which we do this operation
323 * Return: This function returns the number of available opps if there are any,
324 * else returns 0 if none or the corresponding error value.
326 int dev_pm_opp_get_opp_count(struct device *dev)
328 struct opp_table *opp_table;
331 opp_table = _find_opp_table(dev);
332 if (IS_ERR(opp_table)) {
333 count = PTR_ERR(opp_table);
334 dev_dbg(dev, "%s: OPP table not found (%d)\n",
339 count = _get_opp_count(opp_table);
340 dev_pm_opp_put_opp_table(opp_table);
344 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
347 * dev_pm_opp_find_freq_exact() - search for an exact frequency
348 * @dev: device for which we do this operation
349 * @freq: frequency to search for
350 * @available: true/false - match for available opp
352 * Return: Searches for exact match in the opp table and returns pointer to the
353 * matching opp if found, else returns ERR_PTR in case of error and should
354 * be handled using IS_ERR. Error return values can be:
355 * EINVAL: for bad pointer
356 * ERANGE: no match found for search
357 * ENODEV: if device not found in list of registered devices
359 * Note: available is a modifier for the search. if available=true, then the
360 * match is for exact matching frequency and is available in the stored OPP
361 * table. if false, the match is for exact frequency which is not available.
363 * This provides a mechanism to enable an opp which is not available currently
364 * or the opposite as well.
366 * The callers are required to call dev_pm_opp_put() for the returned OPP after
369 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
373 struct opp_table *opp_table;
374 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
376 opp_table = _find_opp_table(dev);
377 if (IS_ERR(opp_table)) {
378 int r = PTR_ERR(opp_table);
380 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
384 mutex_lock(&opp_table->lock);
386 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
387 if (temp_opp->available == available &&
388 temp_opp->rate == freq) {
391 /* Increment the reference count of OPP */
397 mutex_unlock(&opp_table->lock);
398 dev_pm_opp_put_opp_table(opp_table);
402 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
404 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
407 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
409 mutex_lock(&opp_table->lock);
411 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
412 if (temp_opp->available && temp_opp->rate >= *freq) {
416 /* Increment the reference count of OPP */
422 mutex_unlock(&opp_table->lock);
428 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
429 * @dev: device for which we do this operation
430 * @freq: Start frequency
432 * Search for the matching ceil *available* OPP from a starting freq
435 * Return: matching *opp and refreshes *freq accordingly, else returns
436 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
438 * EINVAL: for bad pointer
439 * ERANGE: no match found for search
440 * ENODEV: if device not found in list of registered devices
442 * The callers are required to call dev_pm_opp_put() for the returned OPP after
445 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
448 struct opp_table *opp_table;
449 struct dev_pm_opp *opp;
452 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
453 return ERR_PTR(-EINVAL);
456 opp_table = _find_opp_table(dev);
457 if (IS_ERR(opp_table))
458 return ERR_CAST(opp_table);
460 opp = _find_freq_ceil(opp_table, freq);
462 dev_pm_opp_put_opp_table(opp_table);
466 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
469 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
470 * @dev: device for which we do this operation
471 * @freq: Start frequency
473 * Search for the matching floor *available* OPP from a starting freq
476 * Return: matching *opp and refreshes *freq accordingly, else returns
477 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
479 * EINVAL: for bad pointer
480 * ERANGE: no match found for search
481 * ENODEV: if device not found in list of registered devices
483 * The callers are required to call dev_pm_opp_put() for the returned OPP after
486 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
489 struct opp_table *opp_table;
490 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
493 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
494 return ERR_PTR(-EINVAL);
497 opp_table = _find_opp_table(dev);
498 if (IS_ERR(opp_table))
499 return ERR_CAST(opp_table);
501 mutex_lock(&opp_table->lock);
503 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
504 if (temp_opp->available) {
505 /* go to the next node, before choosing prev */
506 if (temp_opp->rate > *freq)
513 /* Increment the reference count of OPP */
516 mutex_unlock(&opp_table->lock);
517 dev_pm_opp_put_opp_table(opp_table);
524 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
527 * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
529 * @dev: Device for which we do this operation.
530 * @u_volt: Target voltage.
532 * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
534 * Return: matching *opp, else returns ERR_PTR in case of error which should be
535 * handled using IS_ERR.
537 * Error return values can be:
538 * EINVAL: bad parameters
540 * The callers are required to call dev_pm_opp_put() for the returned OPP after
543 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
544 unsigned long u_volt)
546 struct opp_table *opp_table;
547 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
549 if (!dev || !u_volt) {
550 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
552 return ERR_PTR(-EINVAL);
555 opp_table = _find_opp_table(dev);
556 if (IS_ERR(opp_table))
557 return ERR_CAST(opp_table);
559 mutex_lock(&opp_table->lock);
561 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
562 if (temp_opp->available) {
563 if (temp_opp->supplies[0].u_volt > u_volt)
569 /* Increment the reference count of OPP */
573 mutex_unlock(&opp_table->lock);
574 dev_pm_opp_put_opp_table(opp_table);
578 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
580 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
581 struct dev_pm_opp_supply *supply)
585 /* Regulator not available for device */
587 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
592 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
593 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
595 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
596 supply->u_volt, supply->u_volt_max);
598 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
599 __func__, supply->u_volt_min, supply->u_volt,
600 supply->u_volt_max, ret);
605 static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
610 ret = clk_set_rate(clk, freq);
612 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
619 static int _generic_set_opp_regulator(const struct opp_table *opp_table,
621 unsigned long old_freq,
623 struct dev_pm_opp_supply *old_supply,
624 struct dev_pm_opp_supply *new_supply)
626 struct regulator *reg = opp_table->regulators[0];
629 /* This function only supports single regulator per device */
630 if (WARN_ON(opp_table->regulator_count > 1)) {
631 dev_err(dev, "multiple regulators are not supported\n");
635 /* Scaling up? Scale voltage before frequency */
636 if (freq >= old_freq) {
637 ret = _set_opp_voltage(dev, reg, new_supply);
639 goto restore_voltage;
642 /* Change frequency */
643 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
645 goto restore_voltage;
647 /* Scaling down? Scale voltage after frequency */
648 if (freq < old_freq) {
649 ret = _set_opp_voltage(dev, reg, new_supply);
657 if (_generic_set_opp_clk_only(dev, opp_table->clk, old_freq))
658 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
661 /* This shouldn't harm even if the voltages weren't updated earlier */
663 _set_opp_voltage(dev, reg, old_supply);
668 static int _set_opp_custom(const struct opp_table *opp_table,
669 struct device *dev, unsigned long old_freq,
671 struct dev_pm_opp_supply *old_supply,
672 struct dev_pm_opp_supply *new_supply)
674 struct dev_pm_set_opp_data *data;
677 data = opp_table->set_opp_data;
678 data->regulators = opp_table->regulators;
679 data->regulator_count = opp_table->regulator_count;
680 data->clk = opp_table->clk;
683 data->old_opp.rate = old_freq;
684 size = sizeof(*old_supply) * opp_table->regulator_count;
685 if (IS_ERR(old_supply))
686 memset(data->old_opp.supplies, 0, size);
688 memcpy(data->old_opp.supplies, old_supply, size);
690 data->new_opp.rate = freq;
691 memcpy(data->new_opp.supplies, new_supply, size);
693 return opp_table->set_opp(data);
696 /* This is only called for PM domain for now */
697 static int _set_required_opps(struct device *dev,
698 struct opp_table *opp_table,
699 struct dev_pm_opp *opp)
701 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
702 struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
706 if (!required_opp_tables)
709 /* Single genpd case */
710 if (!genpd_virt_devs) {
711 pstate = opp->required_opps[0]->pstate;
712 ret = dev_pm_genpd_set_performance_state(dev, pstate);
714 dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
715 dev_name(dev), pstate, ret);
720 /* Multiple genpd case */
723 * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
724 * after it is freed from another thread.
726 mutex_lock(&opp_table->genpd_virt_dev_lock);
728 for (i = 0; i < opp_table->required_opp_count; i++) {
729 pstate = opp->required_opps[i]->pstate;
731 if (!genpd_virt_devs[i])
734 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
736 dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
737 dev_name(genpd_virt_devs[i]), pstate, ret);
741 mutex_unlock(&opp_table->genpd_virt_dev_lock);
747 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
748 * @dev: device for which we do this operation
749 * @target_freq: frequency to achieve
751 * This configures the power-supplies and clock source to the levels specified
752 * by the OPP corresponding to the target_freq.
754 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
756 struct opp_table *opp_table;
757 unsigned long freq, old_freq;
758 struct dev_pm_opp *old_opp, *opp;
762 if (unlikely(!target_freq)) {
763 dev_err(dev, "%s: Invalid target frequency %lu\n", __func__,
768 opp_table = _find_opp_table(dev);
769 if (IS_ERR(opp_table)) {
770 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
771 return PTR_ERR(opp_table);
774 clk = opp_table->clk;
776 dev_err(dev, "%s: No clock available for the device\n",
782 freq = clk_round_rate(clk, target_freq);
786 old_freq = clk_get_rate(clk);
788 /* Return early if nothing to do */
789 if (old_freq == freq) {
790 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
796 old_opp = _find_freq_ceil(opp_table, &old_freq);
797 if (IS_ERR(old_opp)) {
798 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
799 __func__, old_freq, PTR_ERR(old_opp));
802 opp = _find_freq_ceil(opp_table, &freq);
805 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
806 __func__, freq, ret);
810 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
813 /* Scaling up? Configure required OPPs before frequency */
814 if (freq >= old_freq) {
815 ret = _set_required_opps(dev, opp_table, opp);
820 if (opp_table->set_opp) {
821 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
822 IS_ERR(old_opp) ? NULL : old_opp->supplies,
824 } else if (opp_table->regulators) {
825 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
826 IS_ERR(old_opp) ? NULL : old_opp->supplies,
829 /* Only frequency scaling */
830 ret = _generic_set_opp_clk_only(dev, clk, freq);
833 /* Scaling down? Configure required OPPs after frequency */
834 if (!ret && freq < old_freq) {
835 ret = _set_required_opps(dev, opp_table, opp);
837 dev_err(dev, "Failed to set required opps: %d\n", ret);
843 if (!IS_ERR(old_opp))
844 dev_pm_opp_put(old_opp);
846 dev_pm_opp_put_opp_table(opp_table);
849 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
851 /* OPP-dev Helpers */
852 static void _remove_opp_dev(struct opp_device *opp_dev,
853 struct opp_table *opp_table)
855 opp_debug_unregister(opp_dev, opp_table);
856 list_del(&opp_dev->node);
860 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
861 struct opp_table *opp_table)
863 struct opp_device *opp_dev;
865 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
869 /* Initialize opp-dev */
872 list_add(&opp_dev->node, &opp_table->dev_list);
874 /* Create debugfs entries for the opp_table */
875 opp_debug_register(opp_dev, opp_table);
880 struct opp_device *_add_opp_dev(const struct device *dev,
881 struct opp_table *opp_table)
883 struct opp_device *opp_dev;
885 mutex_lock(&opp_table->lock);
886 opp_dev = _add_opp_dev_unlocked(dev, opp_table);
887 mutex_unlock(&opp_table->lock);
892 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
894 struct opp_table *opp_table;
895 struct opp_device *opp_dev;
899 * Allocate a new OPP table. In the infrequent case where a new
900 * device is needed to be added, we pay this penalty.
902 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
906 mutex_init(&opp_table->lock);
907 mutex_init(&opp_table->genpd_virt_dev_lock);
908 INIT_LIST_HEAD(&opp_table->dev_list);
910 /* Mark regulator count uninitialized */
911 opp_table->regulator_count = -1;
913 opp_dev = _add_opp_dev(dev, opp_table);
919 _of_init_opp_table(opp_table, dev, index);
921 /* Find clk for the device */
922 opp_table->clk = clk_get(dev, NULL);
923 if (IS_ERR(opp_table->clk)) {
924 ret = PTR_ERR(opp_table->clk);
925 if (ret != -EPROBE_DEFER)
926 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
930 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
931 INIT_LIST_HEAD(&opp_table->opp_list);
932 kref_init(&opp_table->kref);
934 /* Secure the device table modification */
935 list_add(&opp_table->node, &opp_tables);
939 void _get_opp_table_kref(struct opp_table *opp_table)
941 kref_get(&opp_table->kref);
944 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
946 struct opp_table *opp_table;
948 /* Hold our table modification lock here */
949 mutex_lock(&opp_table_lock);
951 opp_table = _find_opp_table_unlocked(dev);
952 if (!IS_ERR(opp_table))
955 opp_table = _managed_opp(dev, index);
957 if (!_add_opp_dev_unlocked(dev, opp_table)) {
958 dev_pm_opp_put_opp_table(opp_table);
964 opp_table = _allocate_opp_table(dev, index);
967 mutex_unlock(&opp_table_lock);
972 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
974 return _opp_get_opp_table(dev, 0);
976 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
978 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
981 return _opp_get_opp_table(dev, index);
984 static void _opp_table_kref_release(struct kref *kref)
986 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
987 struct opp_device *opp_dev, *temp;
989 _of_clear_opp_table(opp_table);
992 if (!IS_ERR(opp_table->clk))
993 clk_put(opp_table->clk);
995 WARN_ON(!list_empty(&opp_table->opp_list));
997 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
999 * The OPP table is getting removed, drop the performance state
1002 if (opp_table->genpd_performance_state)
1003 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1005 _remove_opp_dev(opp_dev, opp_table);
1008 mutex_destroy(&opp_table->genpd_virt_dev_lock);
1009 mutex_destroy(&opp_table->lock);
1010 list_del(&opp_table->node);
1013 mutex_unlock(&opp_table_lock);
1016 void _opp_remove_all_static(struct opp_table *opp_table)
1018 struct dev_pm_opp *opp, *tmp;
1020 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1022 dev_pm_opp_put(opp);
1025 opp_table->parsed_static_opps = false;
1028 static void _opp_table_list_kref_release(struct kref *kref)
1030 struct opp_table *opp_table = container_of(kref, struct opp_table,
1033 _opp_remove_all_static(opp_table);
1034 mutex_unlock(&opp_table_lock);
1037 void _put_opp_list_kref(struct opp_table *opp_table)
1039 kref_put_mutex(&opp_table->list_kref, _opp_table_list_kref_release,
1043 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1045 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1048 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1050 void _opp_free(struct dev_pm_opp *opp)
1055 static void _opp_kref_release(struct dev_pm_opp *opp,
1056 struct opp_table *opp_table)
1059 * Notify the changes in the availability of the operable
1060 * frequency/voltage list.
1062 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1063 _of_opp_free_required_opps(opp_table, opp);
1064 opp_debug_remove_one(opp);
1065 list_del(&opp->node);
1069 static void _opp_kref_release_unlocked(struct kref *kref)
1071 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1072 struct opp_table *opp_table = opp->opp_table;
1074 _opp_kref_release(opp, opp_table);
1077 static void _opp_kref_release_locked(struct kref *kref)
1079 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1080 struct opp_table *opp_table = opp->opp_table;
1082 _opp_kref_release(opp, opp_table);
1083 mutex_unlock(&opp_table->lock);
1086 void dev_pm_opp_get(struct dev_pm_opp *opp)
1088 kref_get(&opp->kref);
1091 void dev_pm_opp_put(struct dev_pm_opp *opp)
1093 kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1094 &opp->opp_table->lock);
1096 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1098 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1100 kref_put(&opp->kref, _opp_kref_release_unlocked);
1104 * dev_pm_opp_remove() - Remove an OPP from OPP table
1105 * @dev: device for which we do this operation
1106 * @freq: OPP to remove with matching 'freq'
1108 * This function removes an opp from the opp table.
1110 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1112 struct dev_pm_opp *opp;
1113 struct opp_table *opp_table;
1116 opp_table = _find_opp_table(dev);
1117 if (IS_ERR(opp_table))
1120 mutex_lock(&opp_table->lock);
1122 list_for_each_entry(opp, &opp_table->opp_list, node) {
1123 if (opp->rate == freq) {
1129 mutex_unlock(&opp_table->lock);
1132 dev_pm_opp_put(opp);
1134 /* Drop the reference taken by dev_pm_opp_add() */
1135 dev_pm_opp_put_opp_table(opp_table);
1137 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1141 /* Drop the reference taken by _find_opp_table() */
1142 dev_pm_opp_put_opp_table(opp_table);
1144 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1147 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1148 * @dev: device for which we do this operation
1150 * This function removes all dynamically created OPPs from the opp table.
1152 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1154 struct opp_table *opp_table;
1155 struct dev_pm_opp *opp, *temp;
1158 opp_table = _find_opp_table(dev);
1159 if (IS_ERR(opp_table))
1162 mutex_lock(&opp_table->lock);
1163 list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1165 dev_pm_opp_put_unlocked(opp);
1169 mutex_unlock(&opp_table->lock);
1171 /* Drop the references taken by dev_pm_opp_add() */
1173 dev_pm_opp_put_opp_table(opp_table);
1175 /* Drop the reference taken by _find_opp_table() */
1176 dev_pm_opp_put_opp_table(opp_table);
1178 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1180 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1182 struct dev_pm_opp *opp;
1183 int count, supply_size;
1185 /* Allocate space for at least one supply */
1186 count = table->regulator_count > 0 ? table->regulator_count : 1;
1187 supply_size = sizeof(*opp->supplies) * count;
1189 /* allocate new OPP node and supplies structures */
1190 opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
1194 /* Put the supplies at the end of the OPP structure as an empty array */
1195 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1196 INIT_LIST_HEAD(&opp->node);
1201 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1202 struct opp_table *opp_table)
1204 struct regulator *reg;
1207 if (!opp_table->regulators)
1210 for (i = 0; i < opp_table->regulator_count; i++) {
1211 reg = opp_table->regulators[i];
1213 if (!regulator_is_supported_voltage(reg,
1214 opp->supplies[i].u_volt_min,
1215 opp->supplies[i].u_volt_max)) {
1216 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1217 __func__, opp->supplies[i].u_volt_min,
1218 opp->supplies[i].u_volt_max);
1226 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1227 struct opp_table *opp_table,
1228 struct list_head **head)
1230 struct dev_pm_opp *opp;
1233 * Insert new OPP in order of increasing frequency and discard if
1236 * Need to use &opp_table->opp_list in the condition part of the 'for'
1237 * loop, don't replace it with head otherwise it will become an infinite
1240 list_for_each_entry(opp, &opp_table->opp_list, node) {
1241 if (new_opp->rate > opp->rate) {
1246 if (new_opp->rate < opp->rate)
1249 /* Duplicate OPPs */
1250 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1251 __func__, opp->rate, opp->supplies[0].u_volt,
1252 opp->available, new_opp->rate,
1253 new_opp->supplies[0].u_volt, new_opp->available);
1255 /* Should we compare voltages for all regulators here ? */
1256 return opp->available &&
1257 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1265 * 0: On success. And appropriate error message for duplicate OPPs.
1266 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1267 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1268 * sure we don't print error messages unnecessarily if different parts of
1269 * kernel try to initialize the OPP table.
1270 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1271 * should be considered an error by the callers of _opp_add().
1273 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1274 struct opp_table *opp_table, bool rate_not_available)
1276 struct list_head *head;
1279 mutex_lock(&opp_table->lock);
1280 head = &opp_table->opp_list;
1282 if (likely(!rate_not_available)) {
1283 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1285 mutex_unlock(&opp_table->lock);
1290 list_add(&new_opp->node, head);
1291 mutex_unlock(&opp_table->lock);
1293 new_opp->opp_table = opp_table;
1294 kref_init(&new_opp->kref);
1296 opp_debug_create_one(new_opp, opp_table);
1298 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1299 new_opp->available = false;
1300 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1301 __func__, new_opp->rate);
1308 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1309 * @opp_table: OPP table
1310 * @dev: device for which we do this operation
1311 * @freq: Frequency in Hz for this OPP
1312 * @u_volt: Voltage in uVolts for this OPP
1313 * @dynamic: Dynamically added OPPs.
1315 * This function adds an opp definition to the opp table and returns status.
1316 * The opp is made available by default and it can be controlled using
1317 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1319 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1320 * and freed by dev_pm_opp_of_remove_table.
1324 * Duplicate OPPs (both freq and volt are same) and opp->available
1325 * -EEXIST Freq are same and volt are different OR
1326 * Duplicate OPPs (both freq and volt are same) and !opp->available
1327 * -ENOMEM Memory allocation failure
1329 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1330 unsigned long freq, long u_volt, bool dynamic)
1332 struct dev_pm_opp *new_opp;
1336 new_opp = _opp_allocate(opp_table);
1340 /* populate the opp table */
1341 new_opp->rate = freq;
1342 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1343 new_opp->supplies[0].u_volt = u_volt;
1344 new_opp->supplies[0].u_volt_min = u_volt - tol;
1345 new_opp->supplies[0].u_volt_max = u_volt + tol;
1346 new_opp->available = true;
1347 new_opp->dynamic = dynamic;
1349 ret = _opp_add(dev, new_opp, opp_table, false);
1351 /* Don't return error for duplicate OPPs */
1358 * Notify the changes in the availability of the operable
1359 * frequency/voltage list.
1361 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1371 * dev_pm_opp_set_supported_hw() - Set supported platforms
1372 * @dev: Device for which supported-hw has to be set.
1373 * @versions: Array of hierarchy of versions to match.
1374 * @count: Number of elements in the array.
1376 * This is required only for the V2 bindings, and it enables a platform to
1377 * specify the hierarchy of versions it supports. OPP layer will then enable
1378 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1381 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1382 const u32 *versions, unsigned int count)
1384 struct opp_table *opp_table;
1386 opp_table = dev_pm_opp_get_opp_table(dev);
1388 return ERR_PTR(-ENOMEM);
1390 /* Make sure there are no concurrent readers while updating opp_table */
1391 WARN_ON(!list_empty(&opp_table->opp_list));
1393 /* Another CPU that shares the OPP table has set the property ? */
1394 if (opp_table->supported_hw)
1397 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1399 if (!opp_table->supported_hw) {
1400 dev_pm_opp_put_opp_table(opp_table);
1401 return ERR_PTR(-ENOMEM);
1404 opp_table->supported_hw_count = count;
1408 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1411 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1412 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1414 * This is required only for the V2 bindings, and is called for a matching
1415 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1416 * will not be freed.
1418 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1420 /* Make sure there are no concurrent readers while updating opp_table */
1421 WARN_ON(!list_empty(&opp_table->opp_list));
1423 kfree(opp_table->supported_hw);
1424 opp_table->supported_hw = NULL;
1425 opp_table->supported_hw_count = 0;
1427 dev_pm_opp_put_opp_table(opp_table);
1429 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1432 * dev_pm_opp_set_prop_name() - Set prop-extn name
1433 * @dev: Device for which the prop-name has to be set.
1434 * @name: name to postfix to properties.
1436 * This is required only for the V2 bindings, and it enables a platform to
1437 * specify the extn to be used for certain property names. The properties to
1438 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1439 * should postfix the property name with -<name> while looking for them.
1441 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1443 struct opp_table *opp_table;
1445 opp_table = dev_pm_opp_get_opp_table(dev);
1447 return ERR_PTR(-ENOMEM);
1449 /* Make sure there are no concurrent readers while updating opp_table */
1450 WARN_ON(!list_empty(&opp_table->opp_list));
1452 /* Another CPU that shares the OPP table has set the property ? */
1453 if (opp_table->prop_name)
1456 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1457 if (!opp_table->prop_name) {
1458 dev_pm_opp_put_opp_table(opp_table);
1459 return ERR_PTR(-ENOMEM);
1464 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1467 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1468 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1470 * This is required only for the V2 bindings, and is called for a matching
1471 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1472 * will not be freed.
1474 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1476 /* Make sure there are no concurrent readers while updating opp_table */
1477 WARN_ON(!list_empty(&opp_table->opp_list));
1479 kfree(opp_table->prop_name);
1480 opp_table->prop_name = NULL;
1482 dev_pm_opp_put_opp_table(opp_table);
1484 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1486 static int _allocate_set_opp_data(struct opp_table *opp_table)
1488 struct dev_pm_set_opp_data *data;
1489 int len, count = opp_table->regulator_count;
1491 if (WARN_ON(!opp_table->regulators))
1494 /* space for set_opp_data */
1495 len = sizeof(*data);
1497 /* space for old_opp.supplies and new_opp.supplies */
1498 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1500 data = kzalloc(len, GFP_KERNEL);
1504 data->old_opp.supplies = (void *)(data + 1);
1505 data->new_opp.supplies = data->old_opp.supplies + count;
1507 opp_table->set_opp_data = data;
1512 static void _free_set_opp_data(struct opp_table *opp_table)
1514 kfree(opp_table->set_opp_data);
1515 opp_table->set_opp_data = NULL;
1519 * dev_pm_opp_set_regulators() - Set regulator names for the device
1520 * @dev: Device for which regulator name is being set.
1521 * @names: Array of pointers to the names of the regulator.
1522 * @count: Number of regulators.
1524 * In order to support OPP switching, OPP layer needs to know the name of the
1525 * device's regulators, as the core would be required to switch voltages as
1528 * This must be called before any OPPs are initialized for the device.
1530 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1531 const char * const names[],
1534 struct opp_table *opp_table;
1535 struct regulator *reg;
1538 opp_table = dev_pm_opp_get_opp_table(dev);
1540 return ERR_PTR(-ENOMEM);
1542 /* This should be called before OPPs are initialized */
1543 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1548 /* Another CPU that shares the OPP table has set the regulators ? */
1549 if (opp_table->regulators)
1552 opp_table->regulators = kmalloc_array(count,
1553 sizeof(*opp_table->regulators),
1555 if (!opp_table->regulators) {
1560 for (i = 0; i < count; i++) {
1561 reg = regulator_get_optional(dev, names[i]);
1564 if (ret != -EPROBE_DEFER)
1565 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1566 __func__, names[i], ret);
1567 goto free_regulators;
1570 opp_table->regulators[i] = reg;
1573 opp_table->regulator_count = count;
1575 /* Allocate block only once to pass to set_opp() routines */
1576 ret = _allocate_set_opp_data(opp_table);
1578 goto free_regulators;
1584 regulator_put(opp_table->regulators[--i]);
1586 kfree(opp_table->regulators);
1587 opp_table->regulators = NULL;
1588 opp_table->regulator_count = -1;
1590 dev_pm_opp_put_opp_table(opp_table);
1592 return ERR_PTR(ret);
1594 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1597 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1598 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1600 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1604 if (!opp_table->regulators)
1607 /* Make sure there are no concurrent readers while updating opp_table */
1608 WARN_ON(!list_empty(&opp_table->opp_list));
1610 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1611 regulator_put(opp_table->regulators[i]);
1613 _free_set_opp_data(opp_table);
1615 kfree(opp_table->regulators);
1616 opp_table->regulators = NULL;
1617 opp_table->regulator_count = -1;
1620 dev_pm_opp_put_opp_table(opp_table);
1622 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1625 * dev_pm_opp_set_clkname() - Set clk name for the device
1626 * @dev: Device for which clk name is being set.
1629 * In order to support OPP switching, OPP layer needs to get pointer to the
1630 * clock for the device. Simple cases work fine without using this routine (i.e.
1631 * by passing connection-id as NULL), but for a device with multiple clocks
1632 * available, the OPP core needs to know the exact name of the clk to use.
1634 * This must be called before any OPPs are initialized for the device.
1636 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1638 struct opp_table *opp_table;
1641 opp_table = dev_pm_opp_get_opp_table(dev);
1643 return ERR_PTR(-ENOMEM);
1645 /* This should be called before OPPs are initialized */
1646 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1651 /* Already have default clk set, free it */
1652 if (!IS_ERR(opp_table->clk))
1653 clk_put(opp_table->clk);
1655 /* Find clk for the device */
1656 opp_table->clk = clk_get(dev, name);
1657 if (IS_ERR(opp_table->clk)) {
1658 ret = PTR_ERR(opp_table->clk);
1659 if (ret != -EPROBE_DEFER) {
1660 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1669 dev_pm_opp_put_opp_table(opp_table);
1671 return ERR_PTR(ret);
1673 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1676 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1677 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1679 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1681 /* Make sure there are no concurrent readers while updating opp_table */
1682 WARN_ON(!list_empty(&opp_table->opp_list));
1684 clk_put(opp_table->clk);
1685 opp_table->clk = ERR_PTR(-EINVAL);
1687 dev_pm_opp_put_opp_table(opp_table);
1689 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1692 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1693 * @dev: Device for which the helper is getting registered.
1694 * @set_opp: Custom set OPP helper.
1696 * This is useful to support complex platforms (like platforms with multiple
1697 * regulators per device), instead of the generic OPP set rate helper.
1699 * This must be called before any OPPs are initialized for the device.
1701 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1702 int (*set_opp)(struct dev_pm_set_opp_data *data))
1704 struct opp_table *opp_table;
1707 return ERR_PTR(-EINVAL);
1709 opp_table = dev_pm_opp_get_opp_table(dev);
1711 return ERR_PTR(-ENOMEM);
1713 /* This should be called before OPPs are initialized */
1714 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1715 dev_pm_opp_put_opp_table(opp_table);
1716 return ERR_PTR(-EBUSY);
1719 /* Another CPU that shares the OPP table has set the helper ? */
1720 if (!opp_table->set_opp)
1721 opp_table->set_opp = set_opp;
1725 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1728 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1730 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1732 * Release resources blocked for platform specific set_opp helper.
1734 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1736 /* Make sure there are no concurrent readers while updating opp_table */
1737 WARN_ON(!list_empty(&opp_table->opp_list));
1739 opp_table->set_opp = NULL;
1740 dev_pm_opp_put_opp_table(opp_table);
1742 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1745 * dev_pm_opp_set_genpd_virt_dev - Set virtual genpd device for an index
1746 * @dev: Consumer device for which the genpd device is getting set.
1747 * @virt_dev: virtual genpd device.
1750 * Multiple generic power domains for a device are supported with the help of
1751 * virtual genpd devices, which are created for each consumer device - genpd
1752 * pair. These are the device structures which are attached to the power domain
1753 * and are required by the OPP core to set the performance state of the genpd.
1755 * This helper will normally be called by the consumer driver of the device
1756 * "dev", as only that has details of the genpd devices.
1758 * This helper needs to be called once for each of those virtual devices, but
1759 * only if multiple domains are available for a device. Otherwise the original
1760 * device structure will be used instead by the OPP core.
1762 struct opp_table *dev_pm_opp_set_genpd_virt_dev(struct device *dev,
1763 struct device *virt_dev,
1766 struct opp_table *opp_table;
1768 opp_table = dev_pm_opp_get_opp_table(dev);
1770 return ERR_PTR(-ENOMEM);
1772 mutex_lock(&opp_table->genpd_virt_dev_lock);
1774 if (unlikely(!opp_table->genpd_virt_devs ||
1775 index >= opp_table->required_opp_count ||
1776 opp_table->genpd_virt_devs[index])) {
1778 dev_err(dev, "Invalid request to set required device\n");
1779 dev_pm_opp_put_opp_table(opp_table);
1780 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1782 return ERR_PTR(-EINVAL);
1785 opp_table->genpd_virt_devs[index] = virt_dev;
1786 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1792 * dev_pm_opp_put_genpd_virt_dev() - Releases resources blocked for genpd device.
1793 * @opp_table: OPP table returned by dev_pm_opp_set_genpd_virt_dev().
1794 * @virt_dev: virtual genpd device.
1796 * This releases the resource previously acquired with a call to
1797 * dev_pm_opp_set_genpd_virt_dev(). The consumer driver shall call this helper
1798 * if it doesn't want OPP core to update performance state of a power domain
1801 void dev_pm_opp_put_genpd_virt_dev(struct opp_table *opp_table,
1802 struct device *virt_dev)
1807 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
1810 mutex_lock(&opp_table->genpd_virt_dev_lock);
1812 for (i = 0; i < opp_table->required_opp_count; i++) {
1813 if (opp_table->genpd_virt_devs[i] != virt_dev)
1816 opp_table->genpd_virt_devs[i] = NULL;
1817 dev_pm_opp_put_opp_table(opp_table);
1820 dev_pm_genpd_set_performance_state(virt_dev, 0);
1824 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1826 if (unlikely(i == opp_table->required_opp_count))
1827 dev_err(virt_dev, "Failed to find required device entry\n");
1831 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
1832 * @src_table: OPP table which has dst_table as one of its required OPP table.
1833 * @dst_table: Required OPP table of the src_table.
1834 * @pstate: Current performance state of the src_table.
1836 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
1837 * "required-opps" property of the OPP (present in @src_table) which has
1838 * performance state set to @pstate.
1840 * Return: Zero or positive performance state on success, otherwise negative
1843 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
1844 struct opp_table *dst_table,
1845 unsigned int pstate)
1847 struct dev_pm_opp *opp;
1848 int dest_pstate = -EINVAL;
1855 * Normally the src_table will have the "required_opps" property set to
1856 * point to one of the OPPs in the dst_table, but in some cases the
1857 * genpd and its master have one to one mapping of performance states
1858 * and so none of them have the "required-opps" property set. Return the
1859 * pstate of the src_table as it is in such cases.
1861 if (!src_table->required_opp_count)
1864 for (i = 0; i < src_table->required_opp_count; i++) {
1865 if (src_table->required_opp_tables[i]->np == dst_table->np)
1869 if (unlikely(i == src_table->required_opp_count)) {
1870 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
1871 __func__, src_table, dst_table);
1875 mutex_lock(&src_table->lock);
1877 list_for_each_entry(opp, &src_table->opp_list, node) {
1878 if (opp->pstate == pstate) {
1879 dest_pstate = opp->required_opps[i]->pstate;
1884 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
1888 mutex_unlock(&src_table->lock);
1894 * dev_pm_opp_add() - Add an OPP table from a table definitions
1895 * @dev: device for which we do this operation
1896 * @freq: Frequency in Hz for this OPP
1897 * @u_volt: Voltage in uVolts for this OPP
1899 * This function adds an opp definition to the opp table and returns status.
1900 * The opp is made available by default and it can be controlled using
1901 * dev_pm_opp_enable/disable functions.
1905 * Duplicate OPPs (both freq and volt are same) and opp->available
1906 * -EEXIST Freq are same and volt are different OR
1907 * Duplicate OPPs (both freq and volt are same) and !opp->available
1908 * -ENOMEM Memory allocation failure
1910 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
1912 struct opp_table *opp_table;
1915 opp_table = dev_pm_opp_get_opp_table(dev);
1919 /* Fix regulator count for dynamic OPPs */
1920 opp_table->regulator_count = 1;
1922 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
1924 dev_pm_opp_put_opp_table(opp_table);
1928 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
1931 * _opp_set_availability() - helper to set the availability of an opp
1932 * @dev: device for which we do this operation
1933 * @freq: OPP frequency to modify availability
1934 * @availability_req: availability status requested for this opp
1936 * Set the availability of an OPP, opp_{enable,disable} share a common logic
1937 * which is isolated here.
1939 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1940 * copy operation, returns 0 if no modification was done OR modification was
1943 static int _opp_set_availability(struct device *dev, unsigned long freq,
1944 bool availability_req)
1946 struct opp_table *opp_table;
1947 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
1950 /* Find the opp_table */
1951 opp_table = _find_opp_table(dev);
1952 if (IS_ERR(opp_table)) {
1953 r = PTR_ERR(opp_table);
1954 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
1958 mutex_lock(&opp_table->lock);
1960 /* Do we have the frequency? */
1961 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
1962 if (tmp_opp->rate == freq) {
1973 /* Is update really needed? */
1974 if (opp->available == availability_req)
1977 opp->available = availability_req;
1979 dev_pm_opp_get(opp);
1980 mutex_unlock(&opp_table->lock);
1982 /* Notify the change of the OPP availability */
1983 if (availability_req)
1984 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
1987 blocking_notifier_call_chain(&opp_table->head,
1988 OPP_EVENT_DISABLE, opp);
1990 dev_pm_opp_put(opp);
1994 mutex_unlock(&opp_table->lock);
1996 dev_pm_opp_put_opp_table(opp_table);
2001 * dev_pm_opp_enable() - Enable a specific OPP
2002 * @dev: device for which we do this operation
2003 * @freq: OPP frequency to enable
2005 * Enables a provided opp. If the operation is valid, this returns 0, else the
2006 * corresponding error value. It is meant to be used for users an OPP available
2007 * after being temporarily made unavailable with dev_pm_opp_disable.
2009 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2010 * copy operation, returns 0 if no modification was done OR modification was
2013 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2015 return _opp_set_availability(dev, freq, true);
2017 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2020 * dev_pm_opp_disable() - Disable a specific OPP
2021 * @dev: device for which we do this operation
2022 * @freq: OPP frequency to disable
2024 * Disables a provided opp. If the operation is valid, this returns
2025 * 0, else the corresponding error value. It is meant to be a temporary
2026 * control by users to make this OPP not available until the circumstances are
2027 * right to make it available again (with a call to dev_pm_opp_enable).
2029 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2030 * copy operation, returns 0 if no modification was done OR modification was
2033 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2035 return _opp_set_availability(dev, freq, false);
2037 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2040 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2041 * @dev: Device for which notifier needs to be registered
2042 * @nb: Notifier block to be registered
2044 * Return: 0 on success or a negative error value.
2046 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2048 struct opp_table *opp_table;
2051 opp_table = _find_opp_table(dev);
2052 if (IS_ERR(opp_table))
2053 return PTR_ERR(opp_table);
2055 ret = blocking_notifier_chain_register(&opp_table->head, nb);
2057 dev_pm_opp_put_opp_table(opp_table);
2061 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2064 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2065 * @dev: Device for which notifier needs to be unregistered
2066 * @nb: Notifier block to be unregistered
2068 * Return: 0 on success or a negative error value.
2070 int dev_pm_opp_unregister_notifier(struct device *dev,
2071 struct notifier_block *nb)
2073 struct opp_table *opp_table;
2076 opp_table = _find_opp_table(dev);
2077 if (IS_ERR(opp_table))
2078 return PTR_ERR(opp_table);
2080 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2082 dev_pm_opp_put_opp_table(opp_table);
2086 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2088 void _dev_pm_opp_find_and_remove_table(struct device *dev)
2090 struct opp_table *opp_table;
2092 /* Check for existing table for 'dev' */
2093 opp_table = _find_opp_table(dev);
2094 if (IS_ERR(opp_table)) {
2095 int error = PTR_ERR(opp_table);
2097 if (error != -ENODEV)
2098 WARN(1, "%s: opp_table: %d\n",
2099 IS_ERR_OR_NULL(dev) ?
2100 "Invalid device" : dev_name(dev),
2105 _put_opp_list_kref(opp_table);
2107 /* Drop reference taken by _find_opp_table() */
2108 dev_pm_opp_put_opp_table(opp_table);
2110 /* Drop reference taken while the OPP table was added */
2111 dev_pm_opp_put_opp_table(opp_table);
2115 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2116 * @dev: device pointer used to lookup OPP table.
2118 * Free both OPPs created using static entries present in DT and the
2119 * dynamically added entries.
2121 void dev_pm_opp_remove_table(struct device *dev)
2123 _dev_pm_opp_find_and_remove_table(dev);
2125 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);