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 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
852 temp_freq = old_freq;
853 old_opp = _find_freq_ceil(opp_table, &temp_freq);
854 if (IS_ERR(old_opp)) {
855 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
856 __func__, old_freq, PTR_ERR(old_opp));
860 opp = _find_freq_ceil(opp_table, &temp_freq);
863 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
864 __func__, freq, ret);
868 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
871 /* Scaling up? Configure required OPPs before frequency */
872 if (freq >= old_freq) {
873 ret = _set_required_opps(dev, opp_table, opp);
878 if (opp_table->set_opp) {
879 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
880 IS_ERR(old_opp) ? NULL : old_opp->supplies,
882 } else if (opp_table->regulators) {
883 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
884 IS_ERR(old_opp) ? NULL : old_opp->supplies,
887 /* Only frequency scaling */
888 ret = _generic_set_opp_clk_only(dev, clk, freq);
891 /* Scaling down? Configure required OPPs after frequency */
892 if (!ret && freq < old_freq) {
893 ret = _set_required_opps(dev, opp_table, opp);
895 dev_err(dev, "Failed to set required opps: %d\n", ret);
901 if (!IS_ERR(old_opp))
902 dev_pm_opp_put(old_opp);
904 dev_pm_opp_put_opp_table(opp_table);
907 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
909 /* OPP-dev Helpers */
910 static void _remove_opp_dev(struct opp_device *opp_dev,
911 struct opp_table *opp_table)
913 opp_debug_unregister(opp_dev, opp_table);
914 list_del(&opp_dev->node);
918 static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
919 struct opp_table *opp_table)
921 struct opp_device *opp_dev;
923 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
927 /* Initialize opp-dev */
930 list_add(&opp_dev->node, &opp_table->dev_list);
932 /* Create debugfs entries for the opp_table */
933 opp_debug_register(opp_dev, opp_table);
938 struct opp_device *_add_opp_dev(const struct device *dev,
939 struct opp_table *opp_table)
941 struct opp_device *opp_dev;
943 mutex_lock(&opp_table->lock);
944 opp_dev = _add_opp_dev_unlocked(dev, opp_table);
945 mutex_unlock(&opp_table->lock);
950 static struct opp_table *_allocate_opp_table(struct device *dev, int index)
952 struct opp_table *opp_table;
953 struct opp_device *opp_dev;
957 * Allocate a new OPP table. In the infrequent case where a new
958 * device is needed to be added, we pay this penalty.
960 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
964 mutex_init(&opp_table->lock);
965 mutex_init(&opp_table->genpd_virt_dev_lock);
966 INIT_LIST_HEAD(&opp_table->dev_list);
968 /* Mark regulator count uninitialized */
969 opp_table->regulator_count = -1;
971 opp_dev = _add_opp_dev(dev, opp_table);
977 _of_init_opp_table(opp_table, dev, index);
979 /* Find clk for the device */
980 opp_table->clk = clk_get(dev, NULL);
981 if (IS_ERR(opp_table->clk)) {
982 ret = PTR_ERR(opp_table->clk);
983 if (ret != -EPROBE_DEFER)
984 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
988 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
989 INIT_LIST_HEAD(&opp_table->opp_list);
990 kref_init(&opp_table->kref);
991 kref_init(&opp_table->list_kref);
993 /* Secure the device table modification */
994 list_add(&opp_table->node, &opp_tables);
998 void _get_opp_table_kref(struct opp_table *opp_table)
1000 kref_get(&opp_table->kref);
1003 static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
1005 struct opp_table *opp_table;
1007 /* Hold our table modification lock here */
1008 mutex_lock(&opp_table_lock);
1010 opp_table = _find_opp_table_unlocked(dev);
1011 if (!IS_ERR(opp_table))
1014 opp_table = _managed_opp(dev, index);
1016 if (!_add_opp_dev_unlocked(dev, opp_table)) {
1017 dev_pm_opp_put_opp_table(opp_table);
1023 opp_table = _allocate_opp_table(dev, index);
1026 mutex_unlock(&opp_table_lock);
1031 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1033 return _opp_get_opp_table(dev, 0);
1035 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1037 struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
1040 return _opp_get_opp_table(dev, index);
1043 static void _opp_table_kref_release(struct kref *kref)
1045 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
1046 struct opp_device *opp_dev, *temp;
1048 _of_clear_opp_table(opp_table);
1051 if (!IS_ERR(opp_table->clk))
1052 clk_put(opp_table->clk);
1054 WARN_ON(!list_empty(&opp_table->opp_list));
1056 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1058 * The OPP table is getting removed, drop the performance state
1061 if (opp_table->genpd_performance_state)
1062 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
1064 _remove_opp_dev(opp_dev, opp_table);
1067 mutex_destroy(&opp_table->genpd_virt_dev_lock);
1068 mutex_destroy(&opp_table->lock);
1069 list_del(&opp_table->node);
1072 mutex_unlock(&opp_table_lock);
1075 void _opp_remove_all_static(struct opp_table *opp_table)
1077 struct dev_pm_opp *opp, *tmp;
1079 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1081 dev_pm_opp_put(opp);
1084 opp_table->parsed_static_opps = false;
1087 static void _opp_table_list_kref_release(struct kref *kref)
1089 struct opp_table *opp_table = container_of(kref, struct opp_table,
1092 _opp_remove_all_static(opp_table);
1093 mutex_unlock(&opp_table_lock);
1096 void _put_opp_list_kref(struct opp_table *opp_table)
1098 kref_put_mutex(&opp_table->list_kref, _opp_table_list_kref_release,
1102 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1104 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1107 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1109 void _opp_free(struct dev_pm_opp *opp)
1114 static void _opp_kref_release(struct dev_pm_opp *opp,
1115 struct opp_table *opp_table)
1118 * Notify the changes in the availability of the operable
1119 * frequency/voltage list.
1121 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
1122 _of_opp_free_required_opps(opp_table, opp);
1123 opp_debug_remove_one(opp);
1124 list_del(&opp->node);
1128 static void _opp_kref_release_unlocked(struct kref *kref)
1130 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1131 struct opp_table *opp_table = opp->opp_table;
1133 _opp_kref_release(opp, opp_table);
1136 static void _opp_kref_release_locked(struct kref *kref)
1138 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1139 struct opp_table *opp_table = opp->opp_table;
1141 _opp_kref_release(opp, opp_table);
1142 mutex_unlock(&opp_table->lock);
1145 void dev_pm_opp_get(struct dev_pm_opp *opp)
1147 kref_get(&opp->kref);
1150 void dev_pm_opp_put(struct dev_pm_opp *opp)
1152 kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1153 &opp->opp_table->lock);
1155 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1157 static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1159 kref_put(&opp->kref, _opp_kref_release_unlocked);
1163 * dev_pm_opp_remove() - Remove an OPP from OPP table
1164 * @dev: device for which we do this operation
1165 * @freq: OPP to remove with matching 'freq'
1167 * This function removes an opp from the opp table.
1169 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1171 struct dev_pm_opp *opp;
1172 struct opp_table *opp_table;
1175 opp_table = _find_opp_table(dev);
1176 if (IS_ERR(opp_table))
1179 mutex_lock(&opp_table->lock);
1181 list_for_each_entry(opp, &opp_table->opp_list, node) {
1182 if (opp->rate == freq) {
1188 mutex_unlock(&opp_table->lock);
1191 dev_pm_opp_put(opp);
1193 /* Drop the reference taken by dev_pm_opp_add() */
1194 dev_pm_opp_put_opp_table(opp_table);
1196 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1200 /* Drop the reference taken by _find_opp_table() */
1201 dev_pm_opp_put_opp_table(opp_table);
1203 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1206 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1207 * @dev: device for which we do this operation
1209 * This function removes all dynamically created OPPs from the opp table.
1211 void dev_pm_opp_remove_all_dynamic(struct device *dev)
1213 struct opp_table *opp_table;
1214 struct dev_pm_opp *opp, *temp;
1217 opp_table = _find_opp_table(dev);
1218 if (IS_ERR(opp_table))
1221 mutex_lock(&opp_table->lock);
1222 list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1224 dev_pm_opp_put_unlocked(opp);
1228 mutex_unlock(&opp_table->lock);
1230 /* Drop the references taken by dev_pm_opp_add() */
1232 dev_pm_opp_put_opp_table(opp_table);
1234 /* Drop the reference taken by _find_opp_table() */
1235 dev_pm_opp_put_opp_table(opp_table);
1237 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1239 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
1241 struct dev_pm_opp *opp;
1242 int count, supply_size;
1244 /* Allocate space for at least one supply */
1245 count = table->regulator_count > 0 ? table->regulator_count : 1;
1246 supply_size = sizeof(*opp->supplies) * count;
1248 /* allocate new OPP node and supplies structures */
1249 opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
1253 /* Put the supplies at the end of the OPP structure as an empty array */
1254 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
1255 INIT_LIST_HEAD(&opp->node);
1260 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
1261 struct opp_table *opp_table)
1263 struct regulator *reg;
1266 if (!opp_table->regulators)
1269 for (i = 0; i < opp_table->regulator_count; i++) {
1270 reg = opp_table->regulators[i];
1272 if (!regulator_is_supported_voltage(reg,
1273 opp->supplies[i].u_volt_min,
1274 opp->supplies[i].u_volt_max)) {
1275 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1276 __func__, opp->supplies[i].u_volt_min,
1277 opp->supplies[i].u_volt_max);
1285 static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1286 struct opp_table *opp_table,
1287 struct list_head **head)
1289 struct dev_pm_opp *opp;
1292 * Insert new OPP in order of increasing frequency and discard if
1295 * Need to use &opp_table->opp_list in the condition part of the 'for'
1296 * loop, don't replace it with head otherwise it will become an infinite
1299 list_for_each_entry(opp, &opp_table->opp_list, node) {
1300 if (new_opp->rate > opp->rate) {
1305 if (new_opp->rate < opp->rate)
1308 /* Duplicate OPPs */
1309 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1310 __func__, opp->rate, opp->supplies[0].u_volt,
1311 opp->available, new_opp->rate,
1312 new_opp->supplies[0].u_volt, new_opp->available);
1314 /* Should we compare voltages for all regulators here ? */
1315 return opp->available &&
1316 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1324 * 0: On success. And appropriate error message for duplicate OPPs.
1325 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1326 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1327 * sure we don't print error messages unnecessarily if different parts of
1328 * kernel try to initialize the OPP table.
1329 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1330 * should be considered an error by the callers of _opp_add().
1332 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
1333 struct opp_table *opp_table, bool rate_not_available)
1335 struct list_head *head;
1338 mutex_lock(&opp_table->lock);
1339 head = &opp_table->opp_list;
1341 if (likely(!rate_not_available)) {
1342 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1344 mutex_unlock(&opp_table->lock);
1349 list_add(&new_opp->node, head);
1350 mutex_unlock(&opp_table->lock);
1352 new_opp->opp_table = opp_table;
1353 kref_init(&new_opp->kref);
1355 opp_debug_create_one(new_opp, opp_table);
1357 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1358 new_opp->available = false;
1359 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1360 __func__, new_opp->rate);
1367 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1368 * @opp_table: OPP table
1369 * @dev: device for which we do this operation
1370 * @freq: Frequency in Hz for this OPP
1371 * @u_volt: Voltage in uVolts for this OPP
1372 * @dynamic: Dynamically added OPPs.
1374 * This function adds an opp definition to the opp table and returns status.
1375 * The opp is made available by default and it can be controlled using
1376 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1378 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1379 * and freed by dev_pm_opp_of_remove_table.
1383 * Duplicate OPPs (both freq and volt are same) and opp->available
1384 * -EEXIST Freq are same and volt are different OR
1385 * Duplicate OPPs (both freq and volt are same) and !opp->available
1386 * -ENOMEM Memory allocation failure
1388 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1389 unsigned long freq, long u_volt, bool dynamic)
1391 struct dev_pm_opp *new_opp;
1395 new_opp = _opp_allocate(opp_table);
1399 /* populate the opp table */
1400 new_opp->rate = freq;
1401 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1402 new_opp->supplies[0].u_volt = u_volt;
1403 new_opp->supplies[0].u_volt_min = u_volt - tol;
1404 new_opp->supplies[0].u_volt_max = u_volt + tol;
1405 new_opp->available = true;
1406 new_opp->dynamic = dynamic;
1408 ret = _opp_add(dev, new_opp, opp_table, false);
1410 /* Don't return error for duplicate OPPs */
1417 * Notify the changes in the availability of the operable
1418 * frequency/voltage list.
1420 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1430 * dev_pm_opp_set_supported_hw() - Set supported platforms
1431 * @dev: Device for which supported-hw has to be set.
1432 * @versions: Array of hierarchy of versions to match.
1433 * @count: Number of elements in the array.
1435 * This is required only for the V2 bindings, and it enables a platform to
1436 * specify the hierarchy of versions it supports. OPP layer will then enable
1437 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1440 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1441 const u32 *versions, unsigned int count)
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->supported_hw)
1456 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1458 if (!opp_table->supported_hw) {
1459 dev_pm_opp_put_opp_table(opp_table);
1460 return ERR_PTR(-ENOMEM);
1463 opp_table->supported_hw_count = count;
1467 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1470 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1471 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1473 * This is required only for the V2 bindings, and is called for a matching
1474 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1475 * will not be freed.
1477 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1479 /* Make sure there are no concurrent readers while updating opp_table */
1480 WARN_ON(!list_empty(&opp_table->opp_list));
1482 kfree(opp_table->supported_hw);
1483 opp_table->supported_hw = NULL;
1484 opp_table->supported_hw_count = 0;
1486 dev_pm_opp_put_opp_table(opp_table);
1488 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1491 * dev_pm_opp_set_prop_name() - Set prop-extn name
1492 * @dev: Device for which the prop-name has to be set.
1493 * @name: name to postfix to properties.
1495 * This is required only for the V2 bindings, and it enables a platform to
1496 * specify the extn to be used for certain property names. The properties to
1497 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1498 * should postfix the property name with -<name> while looking for them.
1500 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1502 struct opp_table *opp_table;
1504 opp_table = dev_pm_opp_get_opp_table(dev);
1506 return ERR_PTR(-ENOMEM);
1508 /* Make sure there are no concurrent readers while updating opp_table */
1509 WARN_ON(!list_empty(&opp_table->opp_list));
1511 /* Another CPU that shares the OPP table has set the property ? */
1512 if (opp_table->prop_name)
1515 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1516 if (!opp_table->prop_name) {
1517 dev_pm_opp_put_opp_table(opp_table);
1518 return ERR_PTR(-ENOMEM);
1523 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1526 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1527 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1529 * This is required only for the V2 bindings, and is called for a matching
1530 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1531 * will not be freed.
1533 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1535 /* Make sure there are no concurrent readers while updating opp_table */
1536 WARN_ON(!list_empty(&opp_table->opp_list));
1538 kfree(opp_table->prop_name);
1539 opp_table->prop_name = NULL;
1541 dev_pm_opp_put_opp_table(opp_table);
1543 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1545 static int _allocate_set_opp_data(struct opp_table *opp_table)
1547 struct dev_pm_set_opp_data *data;
1548 int len, count = opp_table->regulator_count;
1550 if (WARN_ON(!opp_table->regulators))
1553 /* space for set_opp_data */
1554 len = sizeof(*data);
1556 /* space for old_opp.supplies and new_opp.supplies */
1557 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1559 data = kzalloc(len, GFP_KERNEL);
1563 data->old_opp.supplies = (void *)(data + 1);
1564 data->new_opp.supplies = data->old_opp.supplies + count;
1566 opp_table->set_opp_data = data;
1571 static void _free_set_opp_data(struct opp_table *opp_table)
1573 kfree(opp_table->set_opp_data);
1574 opp_table->set_opp_data = NULL;
1578 * dev_pm_opp_set_regulators() - Set regulator names for the device
1579 * @dev: Device for which regulator name is being set.
1580 * @names: Array of pointers to the names of the regulator.
1581 * @count: Number of regulators.
1583 * In order to support OPP switching, OPP layer needs to know the name of the
1584 * device's regulators, as the core would be required to switch voltages as
1587 * This must be called before any OPPs are initialized for the device.
1589 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1590 const char * const names[],
1593 struct opp_table *opp_table;
1594 struct regulator *reg;
1597 opp_table = dev_pm_opp_get_opp_table(dev);
1599 return ERR_PTR(-ENOMEM);
1601 /* This should be called before OPPs are initialized */
1602 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1607 /* Another CPU that shares the OPP table has set the regulators ? */
1608 if (opp_table->regulators)
1611 opp_table->regulators = kmalloc_array(count,
1612 sizeof(*opp_table->regulators),
1614 if (!opp_table->regulators) {
1619 for (i = 0; i < count; i++) {
1620 reg = regulator_get_optional(dev, names[i]);
1623 if (ret != -EPROBE_DEFER)
1624 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1625 __func__, names[i], ret);
1626 goto free_regulators;
1629 opp_table->regulators[i] = reg;
1632 opp_table->regulator_count = count;
1634 /* Allocate block only once to pass to set_opp() routines */
1635 ret = _allocate_set_opp_data(opp_table);
1637 goto free_regulators;
1643 regulator_put(opp_table->regulators[--i]);
1645 kfree(opp_table->regulators);
1646 opp_table->regulators = NULL;
1647 opp_table->regulator_count = -1;
1649 dev_pm_opp_put_opp_table(opp_table);
1651 return ERR_PTR(ret);
1653 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1656 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1657 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1659 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1663 if (!opp_table->regulators)
1666 /* Make sure there are no concurrent readers while updating opp_table */
1667 WARN_ON(!list_empty(&opp_table->opp_list));
1669 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1670 regulator_put(opp_table->regulators[i]);
1672 _free_set_opp_data(opp_table);
1674 kfree(opp_table->regulators);
1675 opp_table->regulators = NULL;
1676 opp_table->regulator_count = -1;
1679 dev_pm_opp_put_opp_table(opp_table);
1681 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1684 * dev_pm_opp_set_clkname() - Set clk name for the device
1685 * @dev: Device for which clk name is being set.
1688 * In order to support OPP switching, OPP layer needs to get pointer to the
1689 * clock for the device. Simple cases work fine without using this routine (i.e.
1690 * by passing connection-id as NULL), but for a device with multiple clocks
1691 * available, the OPP core needs to know the exact name of the clk to use.
1693 * This must be called before any OPPs are initialized for the device.
1695 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1697 struct opp_table *opp_table;
1700 opp_table = dev_pm_opp_get_opp_table(dev);
1702 return ERR_PTR(-ENOMEM);
1704 /* This should be called before OPPs are initialized */
1705 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1710 /* Already have default clk set, free it */
1711 if (!IS_ERR(opp_table->clk))
1712 clk_put(opp_table->clk);
1714 /* Find clk for the device */
1715 opp_table->clk = clk_get(dev, name);
1716 if (IS_ERR(opp_table->clk)) {
1717 ret = PTR_ERR(opp_table->clk);
1718 if (ret != -EPROBE_DEFER) {
1719 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1728 dev_pm_opp_put_opp_table(opp_table);
1730 return ERR_PTR(ret);
1732 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1735 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1736 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1738 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1740 /* Make sure there are no concurrent readers while updating opp_table */
1741 WARN_ON(!list_empty(&opp_table->opp_list));
1743 clk_put(opp_table->clk);
1744 opp_table->clk = ERR_PTR(-EINVAL);
1746 dev_pm_opp_put_opp_table(opp_table);
1748 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1751 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1752 * @dev: Device for which the helper is getting registered.
1753 * @set_opp: Custom set OPP helper.
1755 * This is useful to support complex platforms (like platforms with multiple
1756 * regulators per device), instead of the generic OPP set rate helper.
1758 * This must be called before any OPPs are initialized for the device.
1760 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1761 int (*set_opp)(struct dev_pm_set_opp_data *data))
1763 struct opp_table *opp_table;
1766 return ERR_PTR(-EINVAL);
1768 opp_table = dev_pm_opp_get_opp_table(dev);
1770 return ERR_PTR(-ENOMEM);
1772 /* This should be called before OPPs are initialized */
1773 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1774 dev_pm_opp_put_opp_table(opp_table);
1775 return ERR_PTR(-EBUSY);
1778 /* Another CPU that shares the OPP table has set the helper ? */
1779 if (!opp_table->set_opp)
1780 opp_table->set_opp = set_opp;
1784 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1787 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
1789 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1791 * Release resources blocked for platform specific set_opp helper.
1793 void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
1795 /* Make sure there are no concurrent readers while updating opp_table */
1796 WARN_ON(!list_empty(&opp_table->opp_list));
1798 opp_table->set_opp = NULL;
1799 dev_pm_opp_put_opp_table(opp_table);
1801 EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
1803 static void _opp_detach_genpd(struct opp_table *opp_table)
1807 for (index = 0; index < opp_table->required_opp_count; index++) {
1808 if (!opp_table->genpd_virt_devs[index])
1811 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1812 opp_table->genpd_virt_devs[index] = NULL;
1815 kfree(opp_table->genpd_virt_devs);
1816 opp_table->genpd_virt_devs = NULL;
1820 * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1821 * @dev: Consumer device for which the genpd is getting attached.
1822 * @names: Null terminated array of pointers containing names of genpd to attach.
1823 * @virt_devs: Pointer to return the array of virtual devices.
1825 * Multiple generic power domains for a device are supported with the help of
1826 * virtual genpd devices, which are created for each consumer device - genpd
1827 * pair. These are the device structures which are attached to the power domain
1828 * and are required by the OPP core to set the performance state of the genpd.
1829 * The same API also works for the case where single genpd is available and so
1830 * we don't need to support that separately.
1832 * This helper will normally be called by the consumer driver of the device
1833 * "dev", as only that has details of the genpd names.
1835 * This helper needs to be called once with a list of all genpd to attach.
1836 * Otherwise the original device structure will be used instead by the OPP core.
1838 * The order of entries in the names array must match the order in which
1839 * "required-opps" are added in DT.
1841 struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
1842 const char **names, struct device ***virt_devs)
1844 struct opp_table *opp_table;
1845 struct device *virt_dev;
1846 int index = 0, ret = -EINVAL;
1847 const char **name = names;
1849 opp_table = dev_pm_opp_get_opp_table(dev);
1851 return ERR_PTR(-ENOMEM);
1854 * If the genpd's OPP table isn't already initialized, parsing of the
1855 * required-opps fail for dev. We should retry this after genpd's OPP
1858 if (!opp_table->required_opp_count) {
1859 ret = -EPROBE_DEFER;
1863 mutex_lock(&opp_table->genpd_virt_dev_lock);
1865 opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
1866 sizeof(*opp_table->genpd_virt_devs),
1868 if (!opp_table->genpd_virt_devs)
1872 if (index >= opp_table->required_opp_count) {
1873 dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
1874 *name, opp_table->required_opp_count, index);
1878 if (opp_table->genpd_virt_devs[index]) {
1879 dev_err(dev, "Genpd virtual device already set %s\n",
1884 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
1885 if (IS_ERR(virt_dev)) {
1886 ret = PTR_ERR(virt_dev);
1887 dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
1891 opp_table->genpd_virt_devs[index] = virt_dev;
1897 *virt_devs = opp_table->genpd_virt_devs;
1898 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1903 _opp_detach_genpd(opp_table);
1905 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1908 dev_pm_opp_put_opp_table(opp_table);
1910 return ERR_PTR(ret);
1912 EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
1915 * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
1916 * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
1918 * This detaches the genpd(s), resets the virtual device pointers, and puts the
1921 void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
1924 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
1927 mutex_lock(&opp_table->genpd_virt_dev_lock);
1928 _opp_detach_genpd(opp_table);
1929 mutex_unlock(&opp_table->genpd_virt_dev_lock);
1931 dev_pm_opp_put_opp_table(opp_table);
1933 EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
1936 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
1937 * @src_table: OPP table which has dst_table as one of its required OPP table.
1938 * @dst_table: Required OPP table of the src_table.
1939 * @pstate: Current performance state of the src_table.
1941 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
1942 * "required-opps" property of the OPP (present in @src_table) which has
1943 * performance state set to @pstate.
1945 * Return: Zero or positive performance state on success, otherwise negative
1948 int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
1949 struct opp_table *dst_table,
1950 unsigned int pstate)
1952 struct dev_pm_opp *opp;
1953 int dest_pstate = -EINVAL;
1960 * Normally the src_table will have the "required_opps" property set to
1961 * point to one of the OPPs in the dst_table, but in some cases the
1962 * genpd and its master have one to one mapping of performance states
1963 * and so none of them have the "required-opps" property set. Return the
1964 * pstate of the src_table as it is in such cases.
1966 if (!src_table->required_opp_count)
1969 for (i = 0; i < src_table->required_opp_count; i++) {
1970 if (src_table->required_opp_tables[i]->np == dst_table->np)
1974 if (unlikely(i == src_table->required_opp_count)) {
1975 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
1976 __func__, src_table, dst_table);
1980 mutex_lock(&src_table->lock);
1982 list_for_each_entry(opp, &src_table->opp_list, node) {
1983 if (opp->pstate == pstate) {
1984 dest_pstate = opp->required_opps[i]->pstate;
1989 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
1993 mutex_unlock(&src_table->lock);
1999 * dev_pm_opp_add() - Add an OPP table from a table definitions
2000 * @dev: device for which we do this operation
2001 * @freq: Frequency in Hz for this OPP
2002 * @u_volt: Voltage in uVolts for this OPP
2004 * This function adds an opp definition to the opp table and returns status.
2005 * The opp is made available by default and it can be controlled using
2006 * dev_pm_opp_enable/disable functions.
2010 * Duplicate OPPs (both freq and volt are same) and opp->available
2011 * -EEXIST Freq are same and volt are different OR
2012 * Duplicate OPPs (both freq and volt are same) and !opp->available
2013 * -ENOMEM Memory allocation failure
2015 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2017 struct opp_table *opp_table;
2020 opp_table = dev_pm_opp_get_opp_table(dev);
2024 /* Fix regulator count for dynamic OPPs */
2025 opp_table->regulator_count = 1;
2027 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
2029 dev_pm_opp_put_opp_table(opp_table);
2033 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2036 * _opp_set_availability() - helper to set the availability of an opp
2037 * @dev: device for which we do this operation
2038 * @freq: OPP frequency to modify availability
2039 * @availability_req: availability status requested for this opp
2041 * Set the availability of an OPP, opp_{enable,disable} share a common logic
2042 * which is isolated here.
2044 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2045 * copy operation, returns 0 if no modification was done OR modification was
2048 static int _opp_set_availability(struct device *dev, unsigned long freq,
2049 bool availability_req)
2051 struct opp_table *opp_table;
2052 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2055 /* Find the opp_table */
2056 opp_table = _find_opp_table(dev);
2057 if (IS_ERR(opp_table)) {
2058 r = PTR_ERR(opp_table);
2059 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2063 mutex_lock(&opp_table->lock);
2065 /* Do we have the frequency? */
2066 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2067 if (tmp_opp->rate == freq) {
2078 /* Is update really needed? */
2079 if (opp->available == availability_req)
2082 opp->available = availability_req;
2084 dev_pm_opp_get(opp);
2085 mutex_unlock(&opp_table->lock);
2087 /* Notify the change of the OPP availability */
2088 if (availability_req)
2089 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
2092 blocking_notifier_call_chain(&opp_table->head,
2093 OPP_EVENT_DISABLE, opp);
2095 dev_pm_opp_put(opp);
2099 mutex_unlock(&opp_table->lock);
2101 dev_pm_opp_put_opp_table(opp_table);
2106 * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2107 * @dev: device for which we do this operation
2108 * @freq: OPP frequency to adjust voltage of
2109 * @u_volt: new OPP target voltage
2110 * @u_volt_min: new OPP min voltage
2111 * @u_volt_max: new OPP max voltage
2113 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2114 * copy operation, returns 0 if no modifcation was done OR modification was
2117 int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2118 unsigned long u_volt, unsigned long u_volt_min,
2119 unsigned long u_volt_max)
2122 struct opp_table *opp_table;
2123 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2126 /* Find the opp_table */
2127 opp_table = _find_opp_table(dev);
2128 if (IS_ERR(opp_table)) {
2129 r = PTR_ERR(opp_table);
2130 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2134 mutex_lock(&opp_table->lock);
2136 /* Do we have the frequency? */
2137 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2138 if (tmp_opp->rate == freq) {
2149 /* Is update really needed? */
2150 if (opp->supplies->u_volt == u_volt)
2153 opp->supplies->u_volt = u_volt;
2154 opp->supplies->u_volt_min = u_volt_min;
2155 opp->supplies->u_volt_max = u_volt_max;
2157 dev_pm_opp_get(opp);
2158 mutex_unlock(&opp_table->lock);
2160 /* Notify the voltage change of the OPP */
2161 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2164 dev_pm_opp_put(opp);
2165 goto adjust_put_table;
2168 mutex_unlock(&opp_table->lock);
2170 dev_pm_opp_put_opp_table(opp_table);
2175 * dev_pm_opp_enable() - Enable a specific OPP
2176 * @dev: device for which we do this operation
2177 * @freq: OPP frequency to enable
2179 * Enables a provided opp. If the operation is valid, this returns 0, else the
2180 * corresponding error value. It is meant to be used for users an OPP available
2181 * after being temporarily made unavailable with dev_pm_opp_disable.
2183 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2184 * copy operation, returns 0 if no modification was done OR modification was
2187 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
2189 return _opp_set_availability(dev, freq, true);
2191 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
2194 * dev_pm_opp_disable() - Disable a specific OPP
2195 * @dev: device for which we do this operation
2196 * @freq: OPP frequency to disable
2198 * Disables a provided opp. If the operation is valid, this returns
2199 * 0, else the corresponding error value. It is meant to be a temporary
2200 * control by users to make this OPP not available until the circumstances are
2201 * right to make it available again (with a call to dev_pm_opp_enable).
2203 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2204 * copy operation, returns 0 if no modification was done OR modification was
2207 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
2209 return _opp_set_availability(dev, freq, false);
2211 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
2214 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2215 * @dev: Device for which notifier needs to be registered
2216 * @nb: Notifier block to be registered
2218 * Return: 0 on success or a negative error value.
2220 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
2222 struct opp_table *opp_table;
2225 opp_table = _find_opp_table(dev);
2226 if (IS_ERR(opp_table))
2227 return PTR_ERR(opp_table);
2229 ret = blocking_notifier_chain_register(&opp_table->head, nb);
2231 dev_pm_opp_put_opp_table(opp_table);
2235 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2238 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2239 * @dev: Device for which notifier needs to be unregistered
2240 * @nb: Notifier block to be unregistered
2242 * Return: 0 on success or a negative error value.
2244 int dev_pm_opp_unregister_notifier(struct device *dev,
2245 struct notifier_block *nb)
2247 struct opp_table *opp_table;
2250 opp_table = _find_opp_table(dev);
2251 if (IS_ERR(opp_table))
2252 return PTR_ERR(opp_table);
2254 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
2256 dev_pm_opp_put_opp_table(opp_table);
2260 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
2262 void _dev_pm_opp_find_and_remove_table(struct device *dev)
2264 struct opp_table *opp_table;
2266 /* Check for existing table for 'dev' */
2267 opp_table = _find_opp_table(dev);
2268 if (IS_ERR(opp_table)) {
2269 int error = PTR_ERR(opp_table);
2271 if (error != -ENODEV)
2272 WARN(1, "%s: opp_table: %d\n",
2273 IS_ERR_OR_NULL(dev) ?
2274 "Invalid device" : dev_name(dev),
2279 _put_opp_list_kref(opp_table);
2281 /* Drop reference taken by _find_opp_table() */
2282 dev_pm_opp_put_opp_table(opp_table);
2284 /* Drop reference taken while the OPP table was added */
2285 dev_pm_opp_put_opp_table(opp_table);
2289 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
2290 * @dev: device pointer used to lookup OPP table.
2292 * Free both OPPs created using static entries present in DT and the
2293 * dynamically added entries.
2295 void dev_pm_opp_remove_table(struct device *dev)
2297 _dev_pm_opp_find_and_remove_table(dev);
2299 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);