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);
405 * dev_pm_opp_find_level_exact() - search for an exact level
406 * @dev: device for which we do this operation
407 * @level: level to search for
409 * Return: Searches for exact match in the opp table and returns pointer to the
410 * matching opp if found, else returns ERR_PTR in case of error and should
411 * be handled using IS_ERR. Error return values can be:
412 * EINVAL: for bad pointer
413 * ERANGE: no match found for search
414 * ENODEV: if device not found in list of registered devices
416 * The callers are required to call dev_pm_opp_put() for the returned OPP after
419 struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
422 struct opp_table *opp_table;
423 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
425 opp_table = _find_opp_table(dev);
426 if (IS_ERR(opp_table)) {
427 int r = PTR_ERR(opp_table);
429 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
433 mutex_lock(&opp_table->lock);
435 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
436 if (temp_opp->level == level) {
439 /* Increment the reference count of OPP */
445 mutex_unlock(&opp_table->lock);
446 dev_pm_opp_put_opp_table(opp_table);
450 EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_exact);
452 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
455 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
457 mutex_lock(&opp_table->lock);
459 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
460 if (temp_opp->available && temp_opp->rate >= *freq) {
464 /* Increment the reference count of OPP */
470 mutex_unlock(&opp_table->lock);
476 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
477 * @dev: device for which we do this operation
478 * @freq: Start frequency
480 * Search for the matching ceil *available* OPP from a starting freq
483 * Return: matching *opp and refreshes *freq accordingly, else returns
484 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
486 * EINVAL: for bad pointer
487 * ERANGE: no match found for search
488 * ENODEV: if device not found in list of registered devices
490 * The callers are required to call dev_pm_opp_put() for the returned OPP after
493 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
496 struct opp_table *opp_table;
497 struct dev_pm_opp *opp;
500 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
501 return ERR_PTR(-EINVAL);
504 opp_table = _find_opp_table(dev);
505 if (IS_ERR(opp_table))
506 return ERR_CAST(opp_table);
508 opp = _find_freq_ceil(opp_table, freq);
510 dev_pm_opp_put_opp_table(opp_table);
514 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
517 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
518 * @dev: device for which we do this operation
519 * @freq: Start frequency
521 * Search for the matching floor *available* OPP from a starting freq
524 * Return: matching *opp and refreshes *freq accordingly, else returns
525 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
527 * EINVAL: for bad pointer
528 * ERANGE: no match found for search
529 * ENODEV: if device not found in list of registered devices
531 * The callers are required to call dev_pm_opp_put() for the returned OPP after
534 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
537 struct opp_table *opp_table;
538 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
541 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
542 return ERR_PTR(-EINVAL);
545 opp_table = _find_opp_table(dev);
546 if (IS_ERR(opp_table))
547 return ERR_CAST(opp_table);
549 mutex_lock(&opp_table->lock);
551 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
552 if (temp_opp->available) {
553 /* go to the next node, before choosing prev */
554 if (temp_opp->rate > *freq)
561 /* Increment the reference count of OPP */
564 mutex_unlock(&opp_table->lock);
565 dev_pm_opp_put_opp_table(opp_table);
572 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
575 * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
577 * @dev: Device for which we do this operation.
578 * @u_volt: Target voltage.
580 * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
582 * Return: matching *opp, else returns ERR_PTR in case of error which should be
583 * handled using IS_ERR.
585 * Error return values can be:
586 * EINVAL: bad parameters
588 * The callers are required to call dev_pm_opp_put() for the returned OPP after
591 struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
592 unsigned long u_volt)
594 struct opp_table *opp_table;
595 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
597 if (!dev || !u_volt) {
598 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
600 return ERR_PTR(-EINVAL);
603 opp_table = _find_opp_table(dev);
604 if (IS_ERR(opp_table))
605 return ERR_CAST(opp_table);
607 mutex_lock(&opp_table->lock);
609 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
610 if (temp_opp->available) {
611 if (temp_opp->supplies[0].u_volt > u_volt)
617 /* Increment the reference count of OPP */
621 mutex_unlock(&opp_table->lock);
622 dev_pm_opp_put_opp_table(opp_table);
626 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
628 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
629 struct dev_pm_opp_supply *supply)
633 /* Regulator not available for device */
635 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
640 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
641 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
643 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
644 supply->u_volt, supply->u_volt_max);
646 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
647 __func__, supply->u_volt_min, supply->u_volt,
648 supply->u_volt_max, ret);
653 static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
658 ret = clk_set_rate(clk, freq);
660 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
667 static int _generic_set_opp_regulator(const struct opp_table *opp_table,
669 unsigned long old_freq,
671 struct dev_pm_opp_supply *old_supply,
672 struct dev_pm_opp_supply *new_supply)
674 struct regulator *reg = opp_table->regulators[0];
677 /* This function only supports single regulator per device */
678 if (WARN_ON(opp_table->regulator_count > 1)) {
679 dev_err(dev, "multiple regulators are not supported\n");
683 /* Scaling up? Scale voltage before frequency */
684 if (freq >= old_freq) {
685 ret = _set_opp_voltage(dev, reg, new_supply);
687 goto restore_voltage;
690 /* Change frequency */
691 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
693 goto restore_voltage;
695 /* Scaling down? Scale voltage after frequency */
696 if (freq < old_freq) {
697 ret = _set_opp_voltage(dev, reg, new_supply);
705 if (_generic_set_opp_clk_only(dev, opp_table->clk, old_freq))
706 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
709 /* This shouldn't harm even if the voltages weren't updated earlier */
711 _set_opp_voltage(dev, reg, old_supply);
716 static int _set_opp_custom(const struct opp_table *opp_table,
717 struct device *dev, unsigned long old_freq,
719 struct dev_pm_opp_supply *old_supply,
720 struct dev_pm_opp_supply *new_supply)
722 struct dev_pm_set_opp_data *data;
725 data = opp_table->set_opp_data;
726 data->regulators = opp_table->regulators;
727 data->regulator_count = opp_table->regulator_count;
728 data->clk = opp_table->clk;
731 data->old_opp.rate = old_freq;
732 size = sizeof(*old_supply) * opp_table->regulator_count;
734 memset(data->old_opp.supplies, 0, size);
736 memcpy(data->old_opp.supplies, old_supply, size);
738 data->new_opp.rate = freq;
739 memcpy(data->new_opp.supplies, new_supply, size);
741 return opp_table->set_opp(data);
744 /* This is only called for PM domain for now */
745 static int _set_required_opps(struct device *dev,
746 struct opp_table *opp_table,
747 struct dev_pm_opp *opp)
749 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
750 struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
754 if (!required_opp_tables)
757 /* Single genpd case */
758 if (!genpd_virt_devs) {
759 pstate = likely(opp) ? opp->required_opps[0]->pstate : 0;
760 ret = dev_pm_genpd_set_performance_state(dev, pstate);
762 dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
763 dev_name(dev), pstate, ret);
768 /* Multiple genpd case */
771 * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
772 * after it is freed from another thread.
774 mutex_lock(&opp_table->genpd_virt_dev_lock);
776 for (i = 0; i < opp_table->required_opp_count; i++) {
777 pstate = likely(opp) ? opp->required_opps[i]->pstate : 0;
779 if (!genpd_virt_devs[i])
782 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
784 dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
785 dev_name(genpd_virt_devs[i]), pstate, ret);
789 mutex_unlock(&opp_table->genpd_virt_dev_lock);
795 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
796 * @dev: device for which we do this operation
797 * @target_freq: frequency to achieve
799 * This configures the power-supplies to the levels specified by the OPP
800 * corresponding to the target_freq, and programs the clock to a value <=
801 * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
802 * provided by the opp, should have already rounded to the target OPP's
805 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
807 struct opp_table *opp_table;
808 unsigned long freq, old_freq, temp_freq;
809 struct dev_pm_opp *old_opp, *opp;
813 opp_table = _find_opp_table(dev);
814 if (IS_ERR(opp_table)) {
815 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
816 return PTR_ERR(opp_table);
819 if (unlikely(!target_freq)) {
820 if (opp_table->required_opp_tables) {
821 ret = _set_required_opps(dev, opp_table, NULL);
823 dev_err(dev, "target frequency can't be 0\n");
830 clk = opp_table->clk;
832 dev_err(dev, "%s: No clock available for the device\n",
838 freq = clk_round_rate(clk, target_freq);
842 old_freq = clk_get_rate(clk);
844 /* Return early if nothing to do */
845 if (old_freq == freq) {
846 if (!opp_table->required_opp_tables && !opp_table->regulators) {
847 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
854 temp_freq = old_freq;
855 old_opp = _find_freq_ceil(opp_table, &temp_freq);
856 if (IS_ERR(old_opp)) {
857 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
858 __func__, old_freq, PTR_ERR(old_opp));
862 opp = _find_freq_ceil(opp_table, &temp_freq);
865 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
866 __func__, freq, ret);
870 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
873 /* Scaling up? Configure required OPPs before frequency */
874 if (freq >= old_freq) {
875 ret = _set_required_opps(dev, opp_table, opp);
880 if (opp_table->set_opp) {
881 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
882 IS_ERR(old_opp) ? NULL : old_opp->supplies,
884 } else if (opp_table->regulators) {
885 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
886 IS_ERR(old_opp) ? NULL : old_opp->supplies,
889 /* Only frequency scaling */
890 ret = _generic_set_opp_clk_only(dev, clk, freq);
893 /* Scaling down? Configure required OPPs after frequency */
894 if (!ret && freq < old_freq) {
895 ret = _set_required_opps(dev, opp_table, opp);
897 dev_err(dev, "Failed to set required opps: %d\n", ret);
903 if (!IS_ERR(old_opp))
904 dev_pm_opp_put(old_opp);
906 dev_pm_opp_put_opp_table(opp_table);
909 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
911 /* OPP-dev Helpers */
912 static void _remove_opp_dev(struct opp_device *opp_dev,
913 struct opp_table *opp_table)
915 opp_debug_unregister(opp_dev, opp_table);
916 list_del(&opp_dev->node);
920 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
921 struct opp_table *opp_table)
923 struct opp_device *opp_dev;
925 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
929 /* Initialize opp-dev */
932 list_add(&opp_dev->node, &opp_table->dev_list);
934 /* Create debugfs entries for the opp_table */
935 opp_debug_register(opp_dev, opp_table);
940 struct opp_device *_add_opp_dev(const struct device *dev,
941 struct opp_table *opp_table)
943 struct opp_device *opp_dev;
945 mutex_lock(&opp_table->lock);
946 opp_dev = _add_opp_dev_unlocked(dev, opp_table);
947 mutex_unlock(&opp_table->lock);
952 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
954 struct opp_table *opp_table;
955 struct opp_device *opp_dev;
959 * Allocate a new OPP table. In the infrequent case where a new
960 * device is needed to be added, we pay this penalty.
962 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
966 mutex_init(&opp_table->lock);
967 mutex_init(&opp_table->genpd_virt_dev_lock);
968 INIT_LIST_HEAD(&opp_table->dev_list);
970 /* Mark regulator count uninitialized */
971 opp_table->regulator_count = -1;
973 opp_dev = _add_opp_dev(dev, opp_table);
979 _of_init_opp_table(opp_table, dev, index);
981 /* Find clk for the device */
982 opp_table->clk = clk_get(dev, NULL);
983 if (IS_ERR(opp_table->clk)) {
984 ret = PTR_ERR(opp_table->clk);
985 if (ret != -EPROBE_DEFER)
986 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
990 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
991 INIT_LIST_HEAD(&opp_table->opp_list);
992 kref_init(&opp_table->kref);
994 /* Secure the device table modification */
995 list_add(&opp_table->node, &opp_tables);
999 void _get_opp_table_kref(struct opp_table *opp_table)
1001 kref_get(&opp_table->kref);
1004 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
1006 struct opp_table *opp_table;
1008 /* Hold our table modification lock here */
1009 mutex_lock(&opp_table_lock);
1011 opp_table = _find_opp_table_unlocked(dev);
1012 if (!IS_ERR(opp_table))
1015 opp_table = _managed_opp(dev, index);
1017 if (!_add_opp_dev_unlocked(dev, opp_table)) {
1018 dev_pm_opp_put_opp_table(opp_table);
1024 opp_table = _allocate_opp_table(dev, index);
1027 mutex_unlock(&opp_table_lock);
1032 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1034 return _opp_get_opp_table(dev, 0);
1036 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1038 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
1041 return _opp_get_opp_table(dev, index);
1044 static void _opp_table_kref_release(struct kref *kref)
1046 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1047 struct opp_device *opp_dev, *temp;
1049 /* Drop the lock as soon as we can */
1050 list_del(&opp_table->node);
1051 mutex_unlock(&opp_table_lock);
1053 _of_clear_opp_table(opp_table);
1056 if (!IS_ERR(opp_table->clk))
1057 clk_put(opp_table->clk);
1059 WARN_ON(!list_empty(&opp_table->opp_list));
1061 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1063 * The OPP table is getting removed, drop the performance state
1066 if (opp_table->genpd_performance_state)
1067 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1069 _remove_opp_dev(opp_dev, opp_table);
1072 mutex_destroy(&opp_table->genpd_virt_dev_lock);
1073 mutex_destroy(&opp_table->lock);
1077 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1079 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1082 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1084 void _opp_free(struct dev_pm_opp *opp)
1089 static void _opp_kref_release(struct dev_pm_opp *opp,
1090 struct opp_table *opp_table)
1093 * Notify the changes in the availability of the operable
1094 * frequency/voltage list.
1096 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1097 _of_opp_free_required_opps(opp_table, opp);
1098 opp_debug_remove_one(opp);
1099 list_del(&opp->node);
1103 static void _opp_kref_release_unlocked(struct kref *kref)
1105 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1106 struct opp_table *opp_table = opp->opp_table;
1108 _opp_kref_release(opp, opp_table);
1111 static void _opp_kref_release_locked(struct kref *kref)
1113 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1114 struct opp_table *opp_table = opp->opp_table;
1116 _opp_kref_release(opp, opp_table);
1117 mutex_unlock(&opp_table->lock);
1120 void dev_pm_opp_get(struct dev_pm_opp *opp)
1122 kref_get(&opp->kref);
1125 void dev_pm_opp_put(struct dev_pm_opp *opp)
1127 kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1128 &opp->opp_table->lock);
1130 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1132 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1134 kref_put(&opp->kref, _opp_kref_release_unlocked);
1138 * dev_pm_opp_remove() - Remove an OPP from OPP table
1139 * @dev: device for which we do this operation
1140 * @freq: OPP to remove with matching 'freq'
1142 * This function removes an opp from the opp table.
1144 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1146 struct dev_pm_opp *opp;
1147 struct opp_table *opp_table;
1150 opp_table = _find_opp_table(dev);
1151 if (IS_ERR(opp_table))
1154 mutex_lock(&opp_table->lock);
1156 list_for_each_entry(opp, &opp_table->opp_list, node) {
1157 if (opp->rate == freq) {
1163 mutex_unlock(&opp_table->lock);
1166 dev_pm_opp_put(opp);
1168 /* Drop the reference taken by dev_pm_opp_add() */
1169 dev_pm_opp_put_opp_table(opp_table);
1171 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
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);
1180 void _opp_remove_all_static(struct opp_table *opp_table)
1182 struct dev_pm_opp *opp, *tmp;
1184 mutex_lock(&opp_table->lock);
1186 if (!opp_table->parsed_static_opps || --opp_table->parsed_static_opps)
1189 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1191 dev_pm_opp_put_unlocked(opp);
1195 mutex_unlock(&opp_table->lock);
1199 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1200 * @dev: device for which we do this operation
1202 * This function removes all dynamically created OPPs from the opp table.
1204 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1206 struct opp_table *opp_table;
1207 struct dev_pm_opp *opp, *temp;
1210 opp_table = _find_opp_table(dev);
1211 if (IS_ERR(opp_table))
1214 mutex_lock(&opp_table->lock);
1215 list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1217 dev_pm_opp_put_unlocked(opp);
1221 mutex_unlock(&opp_table->lock);
1223 /* Drop the references taken by dev_pm_opp_add() */
1225 dev_pm_opp_put_opp_table(opp_table);
1227 /* Drop the reference taken by _find_opp_table() */
1228 dev_pm_opp_put_opp_table(opp_table);
1230 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1232 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1234 struct dev_pm_opp *opp;
1235 int count, supply_size;
1237 /* Allocate space for at least one supply */
1238 count = table->regulator_count > 0 ? table->regulator_count : 1;
1239 supply_size = sizeof(*opp->supplies) * count;
1241 /* allocate new OPP node and supplies structures */
1242 opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
1246 /* Put the supplies at the end of the OPP structure as an empty array */
1247 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1248 INIT_LIST_HEAD(&opp->node);
1253 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1254 struct opp_table *opp_table)
1256 struct regulator *reg;
1259 if (!opp_table->regulators)
1262 for (i = 0; i < opp_table->regulator_count; i++) {
1263 reg = opp_table->regulators[i];
1265 if (!regulator_is_supported_voltage(reg,
1266 opp->supplies[i].u_volt_min,
1267 opp->supplies[i].u_volt_max)) {
1268 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1269 __func__, opp->supplies[i].u_volt_min,
1270 opp->supplies[i].u_volt_max);
1278 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1279 struct opp_table *opp_table,
1280 struct list_head **head)
1282 struct dev_pm_opp *opp;
1285 * Insert new OPP in order of increasing frequency and discard if
1288 * Need to use &opp_table->opp_list in the condition part of the 'for'
1289 * loop, don't replace it with head otherwise it will become an infinite
1292 list_for_each_entry(opp, &opp_table->opp_list, node) {
1293 if (new_opp->rate > opp->rate) {
1298 if (new_opp->rate < opp->rate)
1301 /* Duplicate OPPs */
1302 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1303 __func__, opp->rate, opp->supplies[0].u_volt,
1304 opp->available, new_opp->rate,
1305 new_opp->supplies[0].u_volt, new_opp->available);
1307 /* Should we compare voltages for all regulators here ? */
1308 return opp->available &&
1309 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1317 * 0: On success. And appropriate error message for duplicate OPPs.
1318 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1319 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1320 * sure we don't print error messages unnecessarily if different parts of
1321 * kernel try to initialize the OPP table.
1322 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1323 * should be considered an error by the callers of _opp_add().
1325 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1326 struct opp_table *opp_table, bool rate_not_available)
1328 struct list_head *head;
1331 mutex_lock(&opp_table->lock);
1332 head = &opp_table->opp_list;
1334 if (likely(!rate_not_available)) {
1335 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1337 mutex_unlock(&opp_table->lock);
1342 list_add(&new_opp->node, head);
1343 mutex_unlock(&opp_table->lock);
1345 new_opp->opp_table = opp_table;
1346 kref_init(&new_opp->kref);
1348 opp_debug_create_one(new_opp, opp_table);
1350 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1351 new_opp->available = false;
1352 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1353 __func__, new_opp->rate);
1360 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1361 * @opp_table: OPP table
1362 * @dev: device for which we do this operation
1363 * @freq: Frequency in Hz for this OPP
1364 * @u_volt: Voltage in uVolts for this OPP
1365 * @dynamic: Dynamically added OPPs.
1367 * This function adds an opp definition to the opp table and returns status.
1368 * The opp is made available by default and it can be controlled using
1369 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1371 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1372 * and freed by dev_pm_opp_of_remove_table.
1376 * Duplicate OPPs (both freq and volt are same) and opp->available
1377 * -EEXIST Freq are same and volt are different OR
1378 * Duplicate OPPs (both freq and volt are same) and !opp->available
1379 * -ENOMEM Memory allocation failure
1381 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1382 unsigned long freq, long u_volt, bool dynamic)
1384 struct dev_pm_opp *new_opp;
1388 new_opp = _opp_allocate(opp_table);
1392 /* populate the opp table */
1393 new_opp->rate = freq;
1394 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1395 new_opp->supplies[0].u_volt = u_volt;
1396 new_opp->supplies[0].u_volt_min = u_volt - tol;
1397 new_opp->supplies[0].u_volt_max = u_volt + tol;
1398 new_opp->available = true;
1399 new_opp->dynamic = dynamic;
1401 ret = _opp_add(dev, new_opp, opp_table, false);
1403 /* Don't return error for duplicate OPPs */
1410 * Notify the changes in the availability of the operable
1411 * frequency/voltage list.
1413 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1423 * dev_pm_opp_set_supported_hw() - Set supported platforms
1424 * @dev: Device for which supported-hw has to be set.
1425 * @versions: Array of hierarchy of versions to match.
1426 * @count: Number of elements in the array.
1428 * This is required only for the V2 bindings, and it enables a platform to
1429 * specify the hierarchy of versions it supports. OPP layer will then enable
1430 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1433 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1434 const u32 *versions, unsigned int count)
1436 struct opp_table *opp_table;
1438 opp_table = dev_pm_opp_get_opp_table(dev);
1440 return ERR_PTR(-ENOMEM);
1442 /* Make sure there are no concurrent readers while updating opp_table */
1443 WARN_ON(!list_empty(&opp_table->opp_list));
1445 /* Another CPU that shares the OPP table has set the property ? */
1446 if (opp_table->supported_hw)
1449 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1451 if (!opp_table->supported_hw) {
1452 dev_pm_opp_put_opp_table(opp_table);
1453 return ERR_PTR(-ENOMEM);
1456 opp_table->supported_hw_count = count;
1460 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1463 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1464 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1466 * This is required only for the V2 bindings, and is called for a matching
1467 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1468 * will not be freed.
1470 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1472 /* Make sure there are no concurrent readers while updating opp_table */
1473 WARN_ON(!list_empty(&opp_table->opp_list));
1475 kfree(opp_table->supported_hw);
1476 opp_table->supported_hw = NULL;
1477 opp_table->supported_hw_count = 0;
1479 dev_pm_opp_put_opp_table(opp_table);
1481 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1484 * dev_pm_opp_set_prop_name() - Set prop-extn name
1485 * @dev: Device for which the prop-name has to be set.
1486 * @name: name to postfix to properties.
1488 * This is required only for the V2 bindings, and it enables a platform to
1489 * specify the extn to be used for certain property names. The properties to
1490 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1491 * should postfix the property name with -<name> while looking for them.
1493 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1495 struct opp_table *opp_table;
1497 opp_table = dev_pm_opp_get_opp_table(dev);
1499 return ERR_PTR(-ENOMEM);
1501 /* Make sure there are no concurrent readers while updating opp_table */
1502 WARN_ON(!list_empty(&opp_table->opp_list));
1504 /* Another CPU that shares the OPP table has set the property ? */
1505 if (opp_table->prop_name)
1508 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1509 if (!opp_table->prop_name) {
1510 dev_pm_opp_put_opp_table(opp_table);
1511 return ERR_PTR(-ENOMEM);
1516 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1519 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1520 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1522 * This is required only for the V2 bindings, and is called for a matching
1523 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1524 * will not be freed.
1526 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1528 /* Make sure there are no concurrent readers while updating opp_table */
1529 WARN_ON(!list_empty(&opp_table->opp_list));
1531 kfree(opp_table->prop_name);
1532 opp_table->prop_name = NULL;
1534 dev_pm_opp_put_opp_table(opp_table);
1536 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1538 static int _allocate_set_opp_data(struct opp_table *opp_table)
1540 struct dev_pm_set_opp_data *data;
1541 int len, count = opp_table->regulator_count;
1543 if (WARN_ON(!opp_table->regulators))
1546 /* space for set_opp_data */
1547 len = sizeof(*data);
1549 /* space for old_opp.supplies and new_opp.supplies */
1550 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1552 data = kzalloc(len, GFP_KERNEL);
1556 data->old_opp.supplies = (void *)(data + 1);
1557 data->new_opp.supplies = data->old_opp.supplies + count;
1559 opp_table->set_opp_data = data;
1564 static void _free_set_opp_data(struct opp_table *opp_table)
1566 kfree(opp_table->set_opp_data);
1567 opp_table->set_opp_data = NULL;
1571 * dev_pm_opp_set_regulators() - Set regulator names for the device
1572 * @dev: Device for which regulator name is being set.
1573 * @names: Array of pointers to the names of the regulator.
1574 * @count: Number of regulators.
1576 * In order to support OPP switching, OPP layer needs to know the name of the
1577 * device's regulators, as the core would be required to switch voltages as
1580 * This must be called before any OPPs are initialized for the device.
1582 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1583 const char * const names[],
1586 struct opp_table *opp_table;
1587 struct regulator *reg;
1590 opp_table = dev_pm_opp_get_opp_table(dev);
1592 return ERR_PTR(-ENOMEM);
1594 /* This should be called before OPPs are initialized */
1595 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1600 /* Another CPU that shares the OPP table has set the regulators ? */
1601 if (opp_table->regulators)
1604 opp_table->regulators = kmalloc_array(count,
1605 sizeof(*opp_table->regulators),
1607 if (!opp_table->regulators) {
1612 for (i = 0; i < count; i++) {
1613 reg = regulator_get_optional(dev, names[i]);
1616 if (ret != -EPROBE_DEFER)
1617 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1618 __func__, names[i], ret);
1619 goto free_regulators;
1622 opp_table->regulators[i] = reg;
1625 opp_table->regulator_count = count;
1627 /* Allocate block only once to pass to set_opp() routines */
1628 ret = _allocate_set_opp_data(opp_table);
1630 goto free_regulators;
1636 regulator_put(opp_table->regulators[--i]);
1638 kfree(opp_table->regulators);
1639 opp_table->regulators = NULL;
1640 opp_table->regulator_count = -1;
1642 dev_pm_opp_put_opp_table(opp_table);
1644 return ERR_PTR(ret);
1646 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1649 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1650 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1652 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1656 if (!opp_table->regulators)
1659 /* Make sure there are no concurrent readers while updating opp_table */
1660 WARN_ON(!list_empty(&opp_table->opp_list));
1662 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1663 regulator_put(opp_table->regulators[i]);
1665 _free_set_opp_data(opp_table);
1667 kfree(opp_table->regulators);
1668 opp_table->regulators = NULL;
1669 opp_table->regulator_count = -1;
1672 dev_pm_opp_put_opp_table(opp_table);
1674 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1677 * dev_pm_opp_set_clkname() - Set clk name for the device
1678 * @dev: Device for which clk name is being set.
1681 * In order to support OPP switching, OPP layer needs to get pointer to the
1682 * clock for the device. Simple cases work fine without using this routine (i.e.
1683 * by passing connection-id as NULL), but for a device with multiple clocks
1684 * available, the OPP core needs to know the exact name of the clk to use.
1686 * This must be called before any OPPs are initialized for the device.
1688 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1690 struct opp_table *opp_table;
1693 opp_table = dev_pm_opp_get_opp_table(dev);
1695 return ERR_PTR(-ENOMEM);
1697 /* This should be called before OPPs are initialized */
1698 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1703 /* Already have default clk set, free it */
1704 if (!IS_ERR(opp_table->clk))
1705 clk_put(opp_table->clk);
1707 /* Find clk for the device */
1708 opp_table->clk = clk_get(dev, name);
1709 if (IS_ERR(opp_table->clk)) {
1710 ret = PTR_ERR(opp_table->clk);
1711 if (ret != -EPROBE_DEFER) {
1712 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1721 dev_pm_opp_put_opp_table(opp_table);
1723 return ERR_PTR(ret);
1725 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1728 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1729 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1731 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1733 /* Make sure there are no concurrent readers while updating opp_table */
1734 WARN_ON(!list_empty(&opp_table->opp_list));
1736 clk_put(opp_table->clk);
1737 opp_table->clk = ERR_PTR(-EINVAL);
1739 dev_pm_opp_put_opp_table(opp_table);
1741 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1744 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1745 * @dev: Device for which the helper is getting registered.
1746 * @set_opp: Custom set OPP helper.
1748 * This is useful to support complex platforms (like platforms with multiple
1749 * regulators per device), instead of the generic OPP set rate helper.
1751 * This must be called before any OPPs are initialized for the device.
1753 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1754 int (*set_opp)(struct dev_pm_set_opp_data *data))
1756 struct opp_table *opp_table;
1759 return ERR_PTR(-EINVAL);
1761 opp_table = dev_pm_opp_get_opp_table(dev);
1763 return ERR_PTR(-ENOMEM);
1765 /* This should be called before OPPs are initialized */
1766 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1767 dev_pm_opp_put_opp_table(opp_table);
1768 return ERR_PTR(-EBUSY);
1771 /* Another CPU that shares the OPP table has set the helper ? */
1772 if (!opp_table->set_opp)
1773 opp_table->set_opp = set_opp;
1777 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1780 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1782 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1784 * Release resources blocked for platform specific set_opp helper.
1786 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1788 /* Make sure there are no concurrent readers while updating opp_table */
1789 WARN_ON(!list_empty(&opp_table->opp_list));
1791 opp_table->set_opp = NULL;
1792 dev_pm_opp_put_opp_table(opp_table);
1794 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1796 static void _opp_detach_genpd(struct opp_table *opp_table)
1800 if (!opp_table->genpd_virt_devs)
1803 for (index = 0; index < opp_table->required_opp_count; index++) {
1804 if (!opp_table->genpd_virt_devs[index])
1807 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1808 opp_table->genpd_virt_devs[index] = NULL;
1811 kfree(opp_table->genpd_virt_devs);
1812 opp_table->genpd_virt_devs = NULL;
1816 * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1817 * @dev: Consumer device for which the genpd is getting attached.
1818 * @names: Null terminated array of pointers containing names of genpd to attach.
1819 * @virt_devs: Pointer to return the array of virtual devices.
1821 * Multiple generic power domains for a device are supported with the help of
1822 * virtual genpd devices, which are created for each consumer device - genpd
1823 * pair. These are the device structures which are attached to the power domain
1824 * and are required by the OPP core to set the performance state of the genpd.
1825 * The same API also works for the case where single genpd is available and so
1826 * we don't need to support that separately.
1828 * This helper will normally be called by the consumer driver of the device
1829 * "dev", as only that has details of the genpd names.
1831 * This helper needs to be called once with a list of all genpd to attach.
1832 * Otherwise the original device structure will be used instead by the OPP core.
1834 * The order of entries in the names array must match the order in which
1835 * "required-opps" are added in DT.
1837 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
1838 const char **names, struct device ***virt_devs)
1840 struct opp_table *opp_table;
1841 struct device *virt_dev;
1842 int index = 0, ret = -EINVAL;
1843 const char **name = names;
1845 opp_table = dev_pm_opp_get_opp_table(dev);
1847 return ERR_PTR(-ENOMEM);
1849 if (opp_table->genpd_virt_devs)
1853 * If the genpd's OPP table isn't already initialized, parsing of the
1854 * required-opps fail for dev. We should retry this after genpd's OPP
1857 if (!opp_table->required_opp_count) {
1858 ret = -EPROBE_DEFER;
1862 mutex_lock(&opp_table->genpd_virt_dev_lock);
1864 opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
1865 sizeof(*opp_table->genpd_virt_devs),
1867 if (!opp_table->genpd_virt_devs)
1871 if (index >= opp_table->required_opp_count) {
1872 dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
1873 *name, opp_table->required_opp_count, index);
1877 if (opp_table->genpd_virt_devs[index]) {
1878 dev_err(dev, "Genpd virtual device already set %s\n",
1883 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
1884 if (IS_ERR(virt_dev)) {
1885 ret = PTR_ERR(virt_dev);
1886 dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
1890 opp_table->genpd_virt_devs[index] = virt_dev;
1896 *virt_devs = opp_table->genpd_virt_devs;
1897 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1902 _opp_detach_genpd(opp_table);
1904 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1907 dev_pm_opp_put_opp_table(opp_table);
1909 return ERR_PTR(ret);
1911 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
1914 * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
1915 * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
1917 * This detaches the genpd(s), resets the virtual device pointers, and puts the
1920 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
1923 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
1926 mutex_lock(&opp_table->genpd_virt_dev_lock);
1927 _opp_detach_genpd(opp_table);
1928 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1930 dev_pm_opp_put_opp_table(opp_table);
1932 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
1935 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
1936 * @src_table: OPP table which has dst_table as one of its required OPP table.
1937 * @dst_table: Required OPP table of the src_table.
1938 * @pstate: Current performance state of the src_table.
1940 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
1941 * "required-opps" property of the OPP (present in @src_table) which has
1942 * performance state set to @pstate.
1944 * Return: Zero or positive performance state on success, otherwise negative
1947 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
1948 struct opp_table *dst_table,
1949 unsigned int pstate)
1951 struct dev_pm_opp *opp;
1952 int dest_pstate = -EINVAL;
1959 * Normally the src_table will have the "required_opps" property set to
1960 * point to one of the OPPs in the dst_table, but in some cases the
1961 * genpd and its master have one to one mapping of performance states
1962 * and so none of them have the "required-opps" property set. Return the
1963 * pstate of the src_table as it is in such cases.
1965 if (!src_table->required_opp_count)
1968 for (i = 0; i < src_table->required_opp_count; i++) {
1969 if (src_table->required_opp_tables[i]->np == dst_table->np)
1973 if (unlikely(i == src_table->required_opp_count)) {
1974 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
1975 __func__, src_table, dst_table);
1979 mutex_lock(&src_table->lock);
1981 list_for_each_entry(opp, &src_table->opp_list, node) {
1982 if (opp->pstate == pstate) {
1983 dest_pstate = opp->required_opps[i]->pstate;
1988 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
1992 mutex_unlock(&src_table->lock);
1998 * dev_pm_opp_add() - Add an OPP table from a table definitions
1999 * @dev: device for which we do this operation
2000 * @freq: Frequency in Hz for this OPP
2001 * @u_volt: Voltage in uVolts for this OPP
2003 * This function adds an opp definition to the opp table and returns status.
2004 * The opp is made available by default and it can be controlled using
2005 * dev_pm_opp_enable/disable functions.
2009 * Duplicate OPPs (both freq and volt are same) and opp->available
2010 * -EEXIST Freq are same and volt are different OR
2011 * Duplicate OPPs (both freq and volt are same) and !opp->available
2012 * -ENOMEM Memory allocation failure
2014 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2016 struct opp_table *opp_table;
2019 opp_table = dev_pm_opp_get_opp_table(dev);
2023 /* Fix regulator count for dynamic OPPs */
2024 opp_table->regulator_count = 1;
2026 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2028 dev_pm_opp_put_opp_table(opp_table);
2032 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2035 * _opp_set_availability() - helper to set the availability of an opp
2036 * @dev: device for which we do this operation
2037 * @freq: OPP frequency to modify availability
2038 * @availability_req: availability status requested for this opp
2040 * Set the availability of an OPP, opp_{enable,disable} share a common logic
2041 * which is isolated here.
2043 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2044 * copy operation, returns 0 if no modification was done OR modification was
2047 static int _opp_set_availability(struct device *dev, unsigned long freq,
2048 bool availability_req)
2050 struct opp_table *opp_table;
2051 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2054 /* Find the opp_table */
2055 opp_table = _find_opp_table(dev);
2056 if (IS_ERR(opp_table)) {
2057 r = PTR_ERR(opp_table);
2058 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2062 mutex_lock(&opp_table->lock);
2064 /* Do we have the frequency? */
2065 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2066 if (tmp_opp->rate == freq) {
2077 /* Is update really needed? */
2078 if (opp->available == availability_req)
2081 opp->available = availability_req;
2083 dev_pm_opp_get(opp);
2084 mutex_unlock(&opp_table->lock);
2086 /* Notify the change of the OPP availability */
2087 if (availability_req)
2088 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2091 blocking_notifier_call_chain(&opp_table->head,
2092 OPP_EVENT_DISABLE, opp);
2094 dev_pm_opp_put(opp);
2098 mutex_unlock(&opp_table->lock);
2100 dev_pm_opp_put_opp_table(opp_table);
2105 * dev_pm_opp_enable() - Enable a specific OPP
2106 * @dev: device for which we do this operation
2107 * @freq: OPP frequency to enable
2109 * Enables a provided opp. If the operation is valid, this returns 0, else the
2110 * corresponding error value. It is meant to be used for users an OPP available
2111 * after being temporarily made unavailable with dev_pm_opp_disable.
2113 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2114 * copy operation, returns 0 if no modification was done OR modification was
2117 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2119 return _opp_set_availability(dev, freq, true);
2121 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2124 * dev_pm_opp_disable() - Disable a specific OPP
2125 * @dev: device for which we do this operation
2126 * @freq: OPP frequency to disable
2128 * Disables a provided opp. If the operation is valid, this returns
2129 * 0, else the corresponding error value. It is meant to be a temporary
2130 * control by users to make this OPP not available until the circumstances are
2131 * right to make it available again (with a call to dev_pm_opp_enable).
2133 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2134 * copy operation, returns 0 if no modification was done OR modification was
2137 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2139 return _opp_set_availability(dev, freq, false);
2141 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2144 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2145 * @dev: Device for which notifier needs to be registered
2146 * @nb: Notifier block to be registered
2148 * Return: 0 on success or a negative error value.
2150 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2152 struct opp_table *opp_table;
2155 opp_table = _find_opp_table(dev);
2156 if (IS_ERR(opp_table))
2157 return PTR_ERR(opp_table);
2159 ret = blocking_notifier_chain_register(&opp_table->head, nb);
2161 dev_pm_opp_put_opp_table(opp_table);
2165 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2168 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2169 * @dev: Device for which notifier needs to be unregistered
2170 * @nb: Notifier block to be unregistered
2172 * Return: 0 on success or a negative error value.
2174 int dev_pm_opp_unregister_notifier(struct device *dev,
2175 struct notifier_block *nb)
2177 struct opp_table *opp_table;
2180 opp_table = _find_opp_table(dev);
2181 if (IS_ERR(opp_table))
2182 return PTR_ERR(opp_table);
2184 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2186 dev_pm_opp_put_opp_table(opp_table);
2190 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2192 void _dev_pm_opp_find_and_remove_table(struct device *dev)
2194 struct opp_table *opp_table;
2196 /* Check for existing table for 'dev' */
2197 opp_table = _find_opp_table(dev);
2198 if (IS_ERR(opp_table)) {
2199 int error = PTR_ERR(opp_table);
2201 if (error != -ENODEV)
2202 WARN(1, "%s: opp_table: %d\n",
2203 IS_ERR_OR_NULL(dev) ?
2204 "Invalid device" : dev_name(dev),
2209 _opp_remove_all_static(opp_table);
2211 /* Drop reference taken by _find_opp_table() */
2212 dev_pm_opp_put_opp_table(opp_table);
2214 /* Drop reference taken while the OPP table was added */
2215 dev_pm_opp_put_opp_table(opp_table);
2219 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2220 * @dev: device pointer used to lookup OPP table.
2222 * Free both OPPs created using static entries present in DT and the
2223 * dynamically added entries.
2225 void dev_pm_opp_remove_table(struct device *dev)
2227 _dev_pm_opp_find_and_remove_table(dev);
2229 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);