2 * Generic OPP Interface
4 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/clk.h>
17 #include <linux/errno.h>
18 #include <linux/err.h>
19 #include <linux/slab.h>
20 #include <linux/device.h>
21 #include <linux/export.h>
22 #include <linux/regulator/consumer.h>
27 * The root of the list of all opp-tables. All opp_table structures branch off
28 * from here, with each opp_table containing the list of opps it supports in
29 * various states of availability.
31 LIST_HEAD(opp_tables);
32 /* Lock to allow exclusive modification to the device and opp lists */
33 DEFINE_MUTEX(opp_table_lock);
35 static void dev_pm_opp_get(struct dev_pm_opp *opp);
37 static struct opp_device *_find_opp_dev(const struct device *dev,
38 struct opp_table *opp_table)
40 struct opp_device *opp_dev;
42 list_for_each_entry(opp_dev, &opp_table->dev_list, node)
43 if (opp_dev->dev == dev)
49 static struct opp_table *_find_opp_table_unlocked(struct device *dev)
51 struct opp_table *opp_table;
53 list_for_each_entry(opp_table, &opp_tables, node) {
54 if (_find_opp_dev(dev, opp_table)) {
55 _get_opp_table_kref(opp_table);
61 return ERR_PTR(-ENODEV);
65 * _find_opp_table() - find opp_table struct using device pointer
66 * @dev: device pointer used to lookup OPP table
68 * Search OPP table for one containing matching device.
70 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
71 * -EINVAL based on type of error.
73 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
75 struct opp_table *_find_opp_table(struct device *dev)
77 struct opp_table *opp_table;
79 if (IS_ERR_OR_NULL(dev)) {
80 pr_err("%s: Invalid parameters\n", __func__);
81 return ERR_PTR(-EINVAL);
84 mutex_lock(&opp_table_lock);
85 opp_table = _find_opp_table_unlocked(dev);
86 mutex_unlock(&opp_table_lock);
92 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
93 * @opp: opp for which voltage has to be returned for
95 * Return: voltage in micro volt corresponding to the opp, else
98 * This is useful only for devices with single power supply.
100 unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
102 if (IS_ERR_OR_NULL(opp)) {
103 pr_err("%s: Invalid parameters\n", __func__);
107 return opp->supplies[0].u_volt;
109 EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
112 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
113 * @opp: opp for which frequency has to be returned for
115 * Return: frequency in hertz corresponding to the opp, else
118 unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
120 if (IS_ERR_OR_NULL(opp) || !opp->available) {
121 pr_err("%s: Invalid parameters\n", __func__);
127 EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
130 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
131 * @opp: opp for which turbo mode is being verified
133 * Turbo OPPs are not for normal use, and can be enabled (under certain
134 * conditions) for short duration of times to finish high throughput work
135 * quickly. Running on them for longer times may overheat the chip.
137 * Return: true if opp is turbo opp, else false.
139 bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
141 if (IS_ERR_OR_NULL(opp) || !opp->available) {
142 pr_err("%s: Invalid parameters\n", __func__);
148 EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
151 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
152 * @dev: device for which we do this operation
154 * Return: This function returns the max clock latency in nanoseconds.
156 unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
158 struct opp_table *opp_table;
159 unsigned long clock_latency_ns;
161 opp_table = _find_opp_table(dev);
162 if (IS_ERR(opp_table))
165 clock_latency_ns = opp_table->clock_latency_ns_max;
167 dev_pm_opp_put_opp_table(opp_table);
169 return clock_latency_ns;
171 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
174 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
175 * @dev: device for which we do this operation
177 * Return: This function returns the max voltage latency in nanoseconds.
179 unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
181 struct opp_table *opp_table;
182 struct dev_pm_opp *opp;
183 struct regulator *reg;
184 unsigned long latency_ns = 0;
191 opp_table = _find_opp_table(dev);
192 if (IS_ERR(opp_table))
195 /* Regulator may not be required for the device */
196 if (!opp_table->regulators)
199 count = opp_table->regulator_count;
201 uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
205 mutex_lock(&opp_table->lock);
207 for (i = 0; i < count; i++) {
211 list_for_each_entry(opp, &opp_table->opp_list, node) {
215 if (opp->supplies[i].u_volt_min < uV[i].min)
216 uV[i].min = opp->supplies[i].u_volt_min;
217 if (opp->supplies[i].u_volt_max > uV[i].max)
218 uV[i].max = opp->supplies[i].u_volt_max;
222 mutex_unlock(&opp_table->lock);
225 * The caller needs to ensure that opp_table (and hence the regulator)
226 * isn't freed, while we are executing this routine.
228 for (i = 0; i < count; i++) {
229 reg = opp_table->regulators[i];
230 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
232 latency_ns += ret * 1000;
237 dev_pm_opp_put_opp_table(opp_table);
241 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
244 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
246 * @dev: device for which we do this operation
248 * Return: This function returns the max transition latency, in nanoseconds, to
249 * switch from one OPP to other.
251 unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
253 return dev_pm_opp_get_max_volt_latency(dev) +
254 dev_pm_opp_get_max_clock_latency(dev);
256 EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
259 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
260 * @dev: device for which we do this operation
262 * Return: This function returns the frequency of the OPP marked as suspend_opp
263 * if one is available, else returns 0;
265 unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
267 struct opp_table *opp_table;
268 unsigned long freq = 0;
270 opp_table = _find_opp_table(dev);
271 if (IS_ERR(opp_table))
274 if (opp_table->suspend_opp && opp_table->suspend_opp->available)
275 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
277 dev_pm_opp_put_opp_table(opp_table);
281 EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
284 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
285 * @dev: device for which we do this operation
287 * Return: This function returns the number of available opps if there are any,
288 * else returns 0 if none or the corresponding error value.
290 int dev_pm_opp_get_opp_count(struct device *dev)
292 struct opp_table *opp_table;
293 struct dev_pm_opp *temp_opp;
296 opp_table = _find_opp_table(dev);
297 if (IS_ERR(opp_table)) {
298 count = PTR_ERR(opp_table);
299 dev_dbg(dev, "%s: OPP table not found (%d)\n",
304 mutex_lock(&opp_table->lock);
306 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
307 if (temp_opp->available)
311 mutex_unlock(&opp_table->lock);
312 dev_pm_opp_put_opp_table(opp_table);
316 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
319 * dev_pm_opp_find_freq_exact() - search for an exact frequency
320 * @dev: device for which we do this operation
321 * @freq: frequency to search for
322 * @available: true/false - match for available opp
324 * Return: Searches for exact match in the opp table and returns pointer to the
325 * matching opp if found, else returns ERR_PTR in case of error and should
326 * be handled using IS_ERR. Error return values can be:
327 * EINVAL: for bad pointer
328 * ERANGE: no match found for search
329 * ENODEV: if device not found in list of registered devices
331 * Note: available is a modifier for the search. if available=true, then the
332 * match is for exact matching frequency and is available in the stored OPP
333 * table. if false, the match is for exact frequency which is not available.
335 * This provides a mechanism to enable an opp which is not available currently
336 * or the opposite as well.
338 * The callers are required to call dev_pm_opp_put() for the returned OPP after
341 struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
345 struct opp_table *opp_table;
346 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
348 opp_table = _find_opp_table(dev);
349 if (IS_ERR(opp_table)) {
350 int r = PTR_ERR(opp_table);
352 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
356 mutex_lock(&opp_table->lock);
358 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
359 if (temp_opp->available == available &&
360 temp_opp->rate == freq) {
363 /* Increment the reference count of OPP */
369 mutex_unlock(&opp_table->lock);
370 dev_pm_opp_put_opp_table(opp_table);
374 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
376 static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
379 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
381 mutex_lock(&opp_table->lock);
383 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
384 if (temp_opp->available && temp_opp->rate >= *freq) {
388 /* Increment the reference count of OPP */
394 mutex_unlock(&opp_table->lock);
400 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
401 * @dev: device for which we do this operation
402 * @freq: Start frequency
404 * Search for the matching ceil *available* OPP from a starting freq
407 * Return: matching *opp and refreshes *freq accordingly, else returns
408 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
410 * EINVAL: for bad pointer
411 * ERANGE: no match found for search
412 * ENODEV: if device not found in list of registered devices
414 * The callers are required to call dev_pm_opp_put() for the returned OPP after
417 struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
420 struct opp_table *opp_table;
421 struct dev_pm_opp *opp;
424 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
425 return ERR_PTR(-EINVAL);
428 opp_table = _find_opp_table(dev);
429 if (IS_ERR(opp_table))
430 return ERR_CAST(opp_table);
432 opp = _find_freq_ceil(opp_table, freq);
434 dev_pm_opp_put_opp_table(opp_table);
438 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
441 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
442 * @dev: device for which we do this operation
443 * @freq: Start frequency
445 * Search for the matching floor *available* OPP from a starting freq
448 * Return: matching *opp and refreshes *freq accordingly, else returns
449 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
451 * EINVAL: for bad pointer
452 * ERANGE: no match found for search
453 * ENODEV: if device not found in list of registered devices
455 * The callers are required to call dev_pm_opp_put() for the returned OPP after
458 struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
461 struct opp_table *opp_table;
462 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
465 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
466 return ERR_PTR(-EINVAL);
469 opp_table = _find_opp_table(dev);
470 if (IS_ERR(opp_table))
471 return ERR_CAST(opp_table);
473 mutex_lock(&opp_table->lock);
475 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
476 if (temp_opp->available) {
477 /* go to the next node, before choosing prev */
478 if (temp_opp->rate > *freq)
485 /* Increment the reference count of OPP */
488 mutex_unlock(&opp_table->lock);
489 dev_pm_opp_put_opp_table(opp_table);
496 EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
498 static int _set_opp_voltage(struct device *dev, struct regulator *reg,
499 struct dev_pm_opp_supply *supply)
503 /* Regulator not available for device */
505 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
510 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
511 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
513 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
514 supply->u_volt, supply->u_volt_max);
516 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
517 __func__, supply->u_volt_min, supply->u_volt,
518 supply->u_volt_max, ret);
524 _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
525 unsigned long old_freq, unsigned long freq)
529 ret = clk_set_rate(clk, freq);
531 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
538 static int _generic_set_opp_regulator(const struct opp_table *opp_table,
540 unsigned long old_freq,
542 struct dev_pm_opp_supply *old_supply,
543 struct dev_pm_opp_supply *new_supply)
545 struct regulator *reg = opp_table->regulators[0];
548 /* This function only supports single regulator per device */
549 if (WARN_ON(opp_table->regulator_count > 1)) {
550 dev_err(dev, "multiple regulators are not supported\n");
554 /* Scaling up? Scale voltage before frequency */
555 if (freq >= old_freq) {
556 ret = _set_opp_voltage(dev, reg, new_supply);
558 goto restore_voltage;
561 /* Change frequency */
562 ret = _generic_set_opp_clk_only(dev, opp_table->clk, old_freq, freq);
564 goto restore_voltage;
566 /* Scaling down? Scale voltage after frequency */
567 if (freq < old_freq) {
568 ret = _set_opp_voltage(dev, reg, new_supply);
576 if (_generic_set_opp_clk_only(dev, opp_table->clk, freq, old_freq))
577 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
580 /* This shouldn't harm even if the voltages weren't updated earlier */
582 _set_opp_voltage(dev, reg, old_supply);
588 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
589 * @dev: device for which we do this operation
590 * @target_freq: frequency to achieve
592 * This configures the power-supplies and clock source to the levels specified
593 * by the OPP corresponding to the target_freq.
595 int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
597 struct opp_table *opp_table;
598 unsigned long freq, old_freq;
599 struct dev_pm_opp *old_opp, *opp;
603 if (unlikely(!target_freq)) {
604 dev_err(dev, "%s: Invalid target frequency %lu\n", __func__,
609 opp_table = _find_opp_table(dev);
610 if (IS_ERR(opp_table)) {
611 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
612 return PTR_ERR(opp_table);
615 clk = opp_table->clk;
617 dev_err(dev, "%s: No clock available for the device\n",
623 freq = clk_round_rate(clk, target_freq);
627 old_freq = clk_get_rate(clk);
629 /* Return early if nothing to do */
630 if (old_freq == freq) {
631 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
637 old_opp = _find_freq_ceil(opp_table, &old_freq);
638 if (IS_ERR(old_opp)) {
639 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
640 __func__, old_freq, PTR_ERR(old_opp));
643 opp = _find_freq_ceil(opp_table, &freq);
646 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
647 __func__, freq, ret);
651 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
654 /* Only frequency scaling */
655 if (!opp_table->regulators) {
656 ret = _generic_set_opp_clk_only(dev, clk, old_freq, freq);
657 } else if (!opp_table->set_opp) {
658 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
659 IS_ERR(old_opp) ? NULL : old_opp->supplies,
662 struct dev_pm_set_opp_data *data;
664 data = opp_table->set_opp_data;
665 data->regulators = opp_table->regulators;
666 data->regulator_count = opp_table->regulator_count;
670 data->old_opp.rate = old_freq;
671 size = sizeof(*opp->supplies) * opp_table->regulator_count;
673 memset(data->old_opp.supplies, 0, size);
675 memcpy(data->old_opp.supplies, old_opp->supplies, size);
677 data->new_opp.rate = freq;
678 memcpy(data->new_opp.supplies, opp->supplies, size);
680 ret = opp_table->set_opp(data);
685 if (!IS_ERR(old_opp))
686 dev_pm_opp_put(old_opp);
688 dev_pm_opp_put_opp_table(opp_table);
691 EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
693 /* OPP-dev Helpers */
694 static void _remove_opp_dev(struct opp_device *opp_dev,
695 struct opp_table *opp_table)
697 opp_debug_unregister(opp_dev, opp_table);
698 list_del(&opp_dev->node);
702 struct opp_device *_add_opp_dev(const struct device *dev,
703 struct opp_table *opp_table)
705 struct opp_device *opp_dev;
708 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
712 /* Initialize opp-dev */
714 list_add(&opp_dev->node, &opp_table->dev_list);
716 /* Create debugfs entries for the opp_table */
717 ret = opp_debug_register(opp_dev, opp_table);
719 dev_err(dev, "%s: Failed to register opp debugfs (%d)\n",
725 static struct opp_table *_allocate_opp_table(struct device *dev)
727 struct opp_table *opp_table;
728 struct opp_device *opp_dev;
732 * Allocate a new OPP table. In the infrequent case where a new
733 * device is needed to be added, we pay this penalty.
735 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
739 INIT_LIST_HEAD(&opp_table->dev_list);
741 opp_dev = _add_opp_dev(dev, opp_table);
747 _of_init_opp_table(opp_table, dev);
749 /* Find clk for the device */
750 opp_table->clk = clk_get(dev, NULL);
751 if (IS_ERR(opp_table->clk)) {
752 ret = PTR_ERR(opp_table->clk);
753 if (ret != -EPROBE_DEFER)
754 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
758 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
759 INIT_LIST_HEAD(&opp_table->opp_list);
760 mutex_init(&opp_table->lock);
761 kref_init(&opp_table->kref);
763 /* Secure the device table modification */
764 list_add(&opp_table->node, &opp_tables);
768 void _get_opp_table_kref(struct opp_table *opp_table)
770 kref_get(&opp_table->kref);
773 struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
775 struct opp_table *opp_table;
777 /* Hold our table modification lock here */
778 mutex_lock(&opp_table_lock);
780 opp_table = _find_opp_table_unlocked(dev);
781 if (!IS_ERR(opp_table))
784 opp_table = _allocate_opp_table(dev);
787 mutex_unlock(&opp_table_lock);
791 EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
793 static void _opp_table_kref_release(struct kref *kref)
795 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
796 struct opp_device *opp_dev;
799 if (!IS_ERR(opp_table->clk))
800 clk_put(opp_table->clk);
802 opp_dev = list_first_entry(&opp_table->dev_list, struct opp_device,
805 _remove_opp_dev(opp_dev, opp_table);
807 /* dev_list must be empty now */
808 WARN_ON(!list_empty(&opp_table->dev_list));
810 mutex_destroy(&opp_table->lock);
811 list_del(&opp_table->node);
814 mutex_unlock(&opp_table_lock);
817 void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
819 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
822 EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
824 void _opp_free(struct dev_pm_opp *opp)
829 static void _opp_kref_release(struct kref *kref)
831 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
832 struct opp_table *opp_table = opp->opp_table;
835 * Notify the changes in the availability of the operable
836 * frequency/voltage list.
838 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
839 opp_debug_remove_one(opp);
840 list_del(&opp->node);
843 mutex_unlock(&opp_table->lock);
844 dev_pm_opp_put_opp_table(opp_table);
847 static void dev_pm_opp_get(struct dev_pm_opp *opp)
849 kref_get(&opp->kref);
852 void dev_pm_opp_put(struct dev_pm_opp *opp)
854 kref_put_mutex(&opp->kref, _opp_kref_release, &opp->opp_table->lock);
856 EXPORT_SYMBOL_GPL(dev_pm_opp_put);
859 * dev_pm_opp_remove() - Remove an OPP from OPP table
860 * @dev: device for which we do this operation
861 * @freq: OPP to remove with matching 'freq'
863 * This function removes an opp from the opp table.
865 void dev_pm_opp_remove(struct device *dev, unsigned long freq)
867 struct dev_pm_opp *opp;
868 struct opp_table *opp_table;
871 opp_table = _find_opp_table(dev);
872 if (IS_ERR(opp_table))
875 mutex_lock(&opp_table->lock);
877 list_for_each_entry(opp, &opp_table->opp_list, node) {
878 if (opp->rate == freq) {
884 mutex_unlock(&opp_table->lock);
889 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
893 dev_pm_opp_put_opp_table(opp_table);
895 EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
897 struct dev_pm_opp *_opp_allocate(struct opp_table *table)
899 struct dev_pm_opp *opp;
900 int count, supply_size;
902 /* Allocate space for at least one supply */
903 count = table->regulator_count ? table->regulator_count : 1;
904 supply_size = sizeof(*opp->supplies) * count;
906 /* allocate new OPP node and supplies structures */
907 opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
911 /* Put the supplies at the end of the OPP structure as an empty array */
912 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
913 INIT_LIST_HEAD(&opp->node);
918 static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
919 struct opp_table *opp_table)
921 struct regulator *reg;
924 if (!opp_table->regulators)
927 for (i = 0; i < opp_table->regulator_count; i++) {
928 reg = opp_table->regulators[i];
930 if (!regulator_is_supported_voltage(reg,
931 opp->supplies[i].u_volt_min,
932 opp->supplies[i].u_volt_max)) {
933 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
934 __func__, opp->supplies[i].u_volt_min,
935 opp->supplies[i].u_volt_max);
945 * 0: On success. And appropriate error message for duplicate OPPs.
946 * -EBUSY: For OPP with same freq/volt and is available. The callers of
947 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
948 * sure we don't print error messages unnecessarily if different parts of
949 * kernel try to initialize the OPP table.
950 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
951 * should be considered an error by the callers of _opp_add().
953 int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
954 struct opp_table *opp_table)
956 struct dev_pm_opp *opp;
957 struct list_head *head;
961 * Insert new OPP in order of increasing frequency and discard if
964 * Need to use &opp_table->opp_list in the condition part of the 'for'
965 * loop, don't replace it with head otherwise it will become an infinite
968 mutex_lock(&opp_table->lock);
969 head = &opp_table->opp_list;
971 list_for_each_entry(opp, &opp_table->opp_list, node) {
972 if (new_opp->rate > opp->rate) {
977 if (new_opp->rate < opp->rate)
981 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
982 __func__, opp->rate, opp->supplies[0].u_volt,
983 opp->available, new_opp->rate,
984 new_opp->supplies[0].u_volt, new_opp->available);
986 /* Should we compare voltages for all regulators here ? */
987 ret = opp->available &&
988 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
990 mutex_unlock(&opp_table->lock);
994 list_add(&new_opp->node, head);
995 mutex_unlock(&opp_table->lock);
997 new_opp->opp_table = opp_table;
998 kref_init(&new_opp->kref);
1000 /* Get a reference to the OPP table */
1001 _get_opp_table_kref(opp_table);
1003 ret = opp_debug_create_one(new_opp, opp_table);
1005 dev_err(dev, "%s: Failed to register opp to debugfs (%d)\n",
1008 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1009 new_opp->available = false;
1010 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1011 __func__, new_opp->rate);
1018 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1019 * @opp_table: OPP table
1020 * @dev: device for which we do this operation
1021 * @freq: Frequency in Hz for this OPP
1022 * @u_volt: Voltage in uVolts for this OPP
1023 * @dynamic: Dynamically added OPPs.
1025 * This function adds an opp definition to the opp table and returns status.
1026 * The opp is made available by default and it can be controlled using
1027 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1029 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1030 * and freed by dev_pm_opp_of_remove_table.
1034 * Duplicate OPPs (both freq and volt are same) and opp->available
1035 * -EEXIST Freq are same and volt are different OR
1036 * Duplicate OPPs (both freq and volt are same) and !opp->available
1037 * -ENOMEM Memory allocation failure
1039 int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1040 unsigned long freq, long u_volt, bool dynamic)
1042 struct dev_pm_opp *new_opp;
1046 new_opp = _opp_allocate(opp_table);
1050 /* populate the opp table */
1051 new_opp->rate = freq;
1052 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1053 new_opp->supplies[0].u_volt = u_volt;
1054 new_opp->supplies[0].u_volt_min = u_volt - tol;
1055 new_opp->supplies[0].u_volt_max = u_volt + tol;
1056 new_opp->available = true;
1057 new_opp->dynamic = dynamic;
1059 ret = _opp_add(dev, new_opp, opp_table);
1061 /* Don't return error for duplicate OPPs */
1068 * Notify the changes in the availability of the operable
1069 * frequency/voltage list.
1071 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1081 * dev_pm_opp_set_supported_hw() - Set supported platforms
1082 * @dev: Device for which supported-hw has to be set.
1083 * @versions: Array of hierarchy of versions to match.
1084 * @count: Number of elements in the array.
1086 * This is required only for the V2 bindings, and it enables a platform to
1087 * specify the hierarchy of versions it supports. OPP layer will then enable
1088 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1091 struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1092 const u32 *versions, unsigned int count)
1094 struct opp_table *opp_table;
1097 opp_table = dev_pm_opp_get_opp_table(dev);
1099 return ERR_PTR(-ENOMEM);
1101 /* Make sure there are no concurrent readers while updating opp_table */
1102 WARN_ON(!list_empty(&opp_table->opp_list));
1104 /* Do we already have a version hierarchy associated with opp_table? */
1105 if (opp_table->supported_hw) {
1106 dev_err(dev, "%s: Already have supported hardware list\n",
1112 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1114 if (!opp_table->supported_hw) {
1119 opp_table->supported_hw_count = count;
1124 dev_pm_opp_put_opp_table(opp_table);
1126 return ERR_PTR(ret);
1128 EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1131 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1132 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1134 * This is required only for the V2 bindings, and is called for a matching
1135 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1136 * will not be freed.
1138 void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1140 /* Make sure there are no concurrent readers while updating opp_table */
1141 WARN_ON(!list_empty(&opp_table->opp_list));
1143 if (!opp_table->supported_hw) {
1144 pr_err("%s: Doesn't have supported hardware list\n",
1149 kfree(opp_table->supported_hw);
1150 opp_table->supported_hw = NULL;
1151 opp_table->supported_hw_count = 0;
1153 dev_pm_opp_put_opp_table(opp_table);
1155 EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1158 * dev_pm_opp_set_prop_name() - Set prop-extn name
1159 * @dev: Device for which the prop-name has to be set.
1160 * @name: name to postfix to properties.
1162 * This is required only for the V2 bindings, and it enables a platform to
1163 * specify the extn to be used for certain property names. The properties to
1164 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1165 * should postfix the property name with -<name> while looking for them.
1167 struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1169 struct opp_table *opp_table;
1172 opp_table = dev_pm_opp_get_opp_table(dev);
1174 return ERR_PTR(-ENOMEM);
1176 /* Make sure there are no concurrent readers while updating opp_table */
1177 WARN_ON(!list_empty(&opp_table->opp_list));
1179 /* Do we already have a prop-name associated with opp_table? */
1180 if (opp_table->prop_name) {
1181 dev_err(dev, "%s: Already have prop-name %s\n", __func__,
1182 opp_table->prop_name);
1187 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1188 if (!opp_table->prop_name) {
1196 dev_pm_opp_put_opp_table(opp_table);
1198 return ERR_PTR(ret);
1200 EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1203 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1204 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1206 * This is required only for the V2 bindings, and is called for a matching
1207 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1208 * will not be freed.
1210 void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1212 /* Make sure there are no concurrent readers while updating opp_table */
1213 WARN_ON(!list_empty(&opp_table->opp_list));
1215 if (!opp_table->prop_name) {
1216 pr_err("%s: Doesn't have a prop-name\n", __func__);
1220 kfree(opp_table->prop_name);
1221 opp_table->prop_name = NULL;
1223 dev_pm_opp_put_opp_table(opp_table);
1225 EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1227 static int _allocate_set_opp_data(struct opp_table *opp_table)
1229 struct dev_pm_set_opp_data *data;
1230 int len, count = opp_table->regulator_count;
1232 if (WARN_ON(!opp_table->regulators))
1235 /* space for set_opp_data */
1236 len = sizeof(*data);
1238 /* space for old_opp.supplies and new_opp.supplies */
1239 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1241 data = kzalloc(len, GFP_KERNEL);
1245 data->old_opp.supplies = (void *)(data + 1);
1246 data->new_opp.supplies = data->old_opp.supplies + count;
1248 opp_table->set_opp_data = data;
1253 static void _free_set_opp_data(struct opp_table *opp_table)
1255 kfree(opp_table->set_opp_data);
1256 opp_table->set_opp_data = NULL;
1260 * dev_pm_opp_set_regulators() - Set regulator names for the device
1261 * @dev: Device for which regulator name is being set.
1262 * @names: Array of pointers to the names of the regulator.
1263 * @count: Number of regulators.
1265 * In order to support OPP switching, OPP layer needs to know the name of the
1266 * device's regulators, as the core would be required to switch voltages as
1269 * This must be called before any OPPs are initialized for the device.
1271 struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1272 const char * const names[],
1275 struct opp_table *opp_table;
1276 struct regulator *reg;
1279 opp_table = dev_pm_opp_get_opp_table(dev);
1281 return ERR_PTR(-ENOMEM);
1283 /* This should be called before OPPs are initialized */
1284 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1289 /* Already have regulators set */
1290 if (opp_table->regulators) {
1295 opp_table->regulators = kmalloc_array(count,
1296 sizeof(*opp_table->regulators),
1298 if (!opp_table->regulators) {
1303 for (i = 0; i < count; i++) {
1304 reg = regulator_get_optional(dev, names[i]);
1307 if (ret != -EPROBE_DEFER)
1308 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1309 __func__, names[i], ret);
1310 goto free_regulators;
1313 opp_table->regulators[i] = reg;
1316 opp_table->regulator_count = count;
1318 /* Allocate block only once to pass to set_opp() routines */
1319 ret = _allocate_set_opp_data(opp_table);
1321 goto free_regulators;
1327 regulator_put(opp_table->regulators[--i]);
1329 kfree(opp_table->regulators);
1330 opp_table->regulators = NULL;
1331 opp_table->regulator_count = 0;
1333 dev_pm_opp_put_opp_table(opp_table);
1335 return ERR_PTR(ret);
1337 EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1340 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1341 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1343 void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1347 if (!opp_table->regulators) {
1348 pr_err("%s: Doesn't have regulators set\n", __func__);
1352 /* Make sure there are no concurrent readers while updating opp_table */
1353 WARN_ON(!list_empty(&opp_table->opp_list));
1355 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1356 regulator_put(opp_table->regulators[i]);
1358 _free_set_opp_data(opp_table);
1360 kfree(opp_table->regulators);
1361 opp_table->regulators = NULL;
1362 opp_table->regulator_count = 0;
1364 dev_pm_opp_put_opp_table(opp_table);
1366 EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1369 * dev_pm_opp_set_clkname() - Set clk name for the device
1370 * @dev: Device for which clk name is being set.
1373 * In order to support OPP switching, OPP layer needs to get pointer to the
1374 * clock for the device. Simple cases work fine without using this routine (i.e.
1375 * by passing connection-id as NULL), but for a device with multiple clocks
1376 * available, the OPP core needs to know the exact name of the clk to use.
1378 * This must be called before any OPPs are initialized for the device.
1380 struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1382 struct opp_table *opp_table;
1385 opp_table = dev_pm_opp_get_opp_table(dev);
1387 return ERR_PTR(-ENOMEM);
1389 /* This should be called before OPPs are initialized */
1390 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1395 /* Already have default clk set, free it */
1396 if (!IS_ERR(opp_table->clk))
1397 clk_put(opp_table->clk);
1399 /* Find clk for the device */
1400 opp_table->clk = clk_get(dev, name);
1401 if (IS_ERR(opp_table->clk)) {
1402 ret = PTR_ERR(opp_table->clk);
1403 if (ret != -EPROBE_DEFER) {
1404 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1413 dev_pm_opp_put_opp_table(opp_table);
1415 return ERR_PTR(ret);
1417 EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1420 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1421 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1423 void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1425 /* Make sure there are no concurrent readers while updating opp_table */
1426 WARN_ON(!list_empty(&opp_table->opp_list));
1428 clk_put(opp_table->clk);
1429 opp_table->clk = ERR_PTR(-EINVAL);
1431 dev_pm_opp_put_opp_table(opp_table);
1433 EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1436 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1437 * @dev: Device for which the helper is getting registered.
1438 * @set_opp: Custom set OPP helper.
1440 * This is useful to support complex platforms (like platforms with multiple
1441 * regulators per device), instead of the generic OPP set rate helper.
1443 * This must be called before any OPPs are initialized for the device.
1445 struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1446 int (*set_opp)(struct dev_pm_set_opp_data *data))
1448 struct opp_table *opp_table;
1452 return ERR_PTR(-EINVAL);
1454 opp_table = dev_pm_opp_get_opp_table(dev);
1456 return ERR_PTR(-ENOMEM);
1458 /* This should be called before OPPs are initialized */
1459 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1464 /* Already have custom set_opp helper */
1465 if (WARN_ON(opp_table->set_opp)) {
1470 opp_table->set_opp = set_opp;
1475 dev_pm_opp_put_opp_table(opp_table);
1477 return ERR_PTR(ret);
1479 EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1482 * dev_pm_opp_register_put_opp_helper() - Releases resources blocked for
1484 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1486 * Release resources blocked for platform specific set_opp helper.
1488 void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table)
1490 if (!opp_table->set_opp) {
1491 pr_err("%s: Doesn't have custom set_opp helper set\n",
1496 /* Make sure there are no concurrent readers while updating opp_table */
1497 WARN_ON(!list_empty(&opp_table->opp_list));
1499 opp_table->set_opp = NULL;
1501 dev_pm_opp_put_opp_table(opp_table);
1503 EXPORT_SYMBOL_GPL(dev_pm_opp_register_put_opp_helper);
1506 * dev_pm_opp_add() - Add an OPP table from a table definitions
1507 * @dev: device for which we do this operation
1508 * @freq: Frequency in Hz for this OPP
1509 * @u_volt: Voltage in uVolts for this OPP
1511 * This function adds an opp definition to the opp table and returns status.
1512 * The opp is made available by default and it can be controlled using
1513 * dev_pm_opp_enable/disable functions.
1517 * Duplicate OPPs (both freq and volt are same) and opp->available
1518 * -EEXIST Freq are same and volt are different OR
1519 * Duplicate OPPs (both freq and volt are same) and !opp->available
1520 * -ENOMEM Memory allocation failure
1522 int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
1524 struct opp_table *opp_table;
1527 opp_table = dev_pm_opp_get_opp_table(dev);
1531 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
1533 dev_pm_opp_put_opp_table(opp_table);
1536 EXPORT_SYMBOL_GPL(dev_pm_opp_add);
1539 * _opp_set_availability() - helper to set the availability of an opp
1540 * @dev: device for which we do this operation
1541 * @freq: OPP frequency to modify availability
1542 * @availability_req: availability status requested for this opp
1544 * Set the availability of an OPP, opp_{enable,disable} share a common logic
1545 * which is isolated here.
1547 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1548 * copy operation, returns 0 if no modification was done OR modification was
1551 static int _opp_set_availability(struct device *dev, unsigned long freq,
1552 bool availability_req)
1554 struct opp_table *opp_table;
1555 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
1558 /* Find the opp_table */
1559 opp_table = _find_opp_table(dev);
1560 if (IS_ERR(opp_table)) {
1561 r = PTR_ERR(opp_table);
1562 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
1566 mutex_lock(&opp_table->lock);
1568 /* Do we have the frequency? */
1569 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
1570 if (tmp_opp->rate == freq) {
1581 /* Is update really needed? */
1582 if (opp->available == availability_req)
1585 opp->available = availability_req;
1587 dev_pm_opp_get(opp);
1588 mutex_unlock(&opp_table->lock);
1590 /* Notify the change of the OPP availability */
1591 if (availability_req)
1592 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
1595 blocking_notifier_call_chain(&opp_table->head,
1596 OPP_EVENT_DISABLE, opp);
1598 dev_pm_opp_put(opp);
1602 mutex_unlock(&opp_table->lock);
1604 dev_pm_opp_put_opp_table(opp_table);
1609 * dev_pm_opp_enable() - Enable a specific OPP
1610 * @dev: device for which we do this operation
1611 * @freq: OPP frequency to enable
1613 * Enables a provided opp. If the operation is valid, this returns 0, else the
1614 * corresponding error value. It is meant to be used for users an OPP available
1615 * after being temporarily made unavailable with dev_pm_opp_disable.
1617 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1618 * copy operation, returns 0 if no modification was done OR modification was
1621 int dev_pm_opp_enable(struct device *dev, unsigned long freq)
1623 return _opp_set_availability(dev, freq, true);
1625 EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
1628 * dev_pm_opp_disable() - Disable a specific OPP
1629 * @dev: device for which we do this operation
1630 * @freq: OPP frequency to disable
1632 * Disables a provided opp. If the operation is valid, this returns
1633 * 0, else the corresponding error value. It is meant to be a temporary
1634 * control by users to make this OPP not available until the circumstances are
1635 * right to make it available again (with a call to dev_pm_opp_enable).
1637 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1638 * copy operation, returns 0 if no modification was done OR modification was
1641 int dev_pm_opp_disable(struct device *dev, unsigned long freq)
1643 return _opp_set_availability(dev, freq, false);
1645 EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
1648 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
1649 * @dev: Device for which notifier needs to be registered
1650 * @nb: Notifier block to be registered
1652 * Return: 0 on success or a negative error value.
1654 int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
1656 struct opp_table *opp_table;
1659 opp_table = _find_opp_table(dev);
1660 if (IS_ERR(opp_table))
1661 return PTR_ERR(opp_table);
1663 ret = blocking_notifier_chain_register(&opp_table->head, nb);
1665 dev_pm_opp_put_opp_table(opp_table);
1669 EXPORT_SYMBOL(dev_pm_opp_register_notifier);
1672 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
1673 * @dev: Device for which notifier needs to be unregistered
1674 * @nb: Notifier block to be unregistered
1676 * Return: 0 on success or a negative error value.
1678 int dev_pm_opp_unregister_notifier(struct device *dev,
1679 struct notifier_block *nb)
1681 struct opp_table *opp_table;
1684 opp_table = _find_opp_table(dev);
1685 if (IS_ERR(opp_table))
1686 return PTR_ERR(opp_table);
1688 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
1690 dev_pm_opp_put_opp_table(opp_table);
1694 EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
1697 * Free OPPs either created using static entries present in DT or even the
1698 * dynamically added entries based on remove_all param.
1700 void _dev_pm_opp_remove_table(struct opp_table *opp_table, struct device *dev,
1703 struct dev_pm_opp *opp, *tmp;
1705 /* Find if opp_table manages a single device */
1706 if (list_is_singular(&opp_table->dev_list)) {
1707 /* Free static OPPs */
1708 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1709 if (remove_all || !opp->dynamic)
1710 dev_pm_opp_put(opp);
1713 _remove_opp_dev(_find_opp_dev(dev, opp_table), opp_table);
1717 void _dev_pm_opp_find_and_remove_table(struct device *dev, bool remove_all)
1719 struct opp_table *opp_table;
1721 /* Check for existing table for 'dev' */
1722 opp_table = _find_opp_table(dev);
1723 if (IS_ERR(opp_table)) {
1724 int error = PTR_ERR(opp_table);
1726 if (error != -ENODEV)
1727 WARN(1, "%s: opp_table: %d\n",
1728 IS_ERR_OR_NULL(dev) ?
1729 "Invalid device" : dev_name(dev),
1734 _dev_pm_opp_remove_table(opp_table, dev, remove_all);
1736 dev_pm_opp_put_opp_table(opp_table);
1740 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
1741 * @dev: device pointer used to lookup OPP table.
1743 * Free both OPPs created using static entries present in DT and the
1744 * dynamically added entries.
1746 void dev_pm_opp_remove_table(struct device *dev)
1748 _dev_pm_opp_find_and_remove_table(dev, true);
1750 EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);