blob: 6937bf45f497f031f9dddd3f2e2a74579fefad88 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Nishanth Menone1f60b22010-10-13 00:13:10 +02002/*
3 * Generic OPP Interface
4 *
5 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
6 * Nishanth Menon
7 * Romit Dasgupta
8 * Kevin Hilman
Nishanth Menone1f60b22010-10-13 00:13:10 +02009 */
10
Viresh Kumard6d2a522015-10-17 09:45:18 +053011#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12
Viresh Kumard54974c2016-02-09 10:30:38 +053013#include <linux/clk.h>
Nishanth Menone1f60b22010-10-13 00:13:10 +020014#include <linux/errno.h>
15#include <linux/err.h>
Nishanth Menone1f60b22010-10-13 00:13:10 +020016#include <linux/slab.h>
Paul Gortmaker51990e82012-01-22 11:23:42 -050017#include <linux/device.h>
Liam Girdwood80126ce2012-10-23 01:27:44 +020018#include <linux/export.h>
Viresh Kumar009acd12017-10-11 12:54:14 +053019#include <linux/pm_domain.h>
Viresh Kumar9f8ea962016-02-09 10:30:33 +053020#include <linux/regulator/consumer.h>
Nishanth Menone1f60b22010-10-13 00:13:10 +020021
Viresh Kumarf59d3ee2015-09-04 13:47:26 +053022#include "opp.h"
Nishanth Menone1f60b22010-10-13 00:13:10 +020023
24/*
Viresh Kumar2c2709d2016-02-16 14:17:53 +053025 * 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
Nishanth Menone1f60b22010-10-13 00:13:10 +020027 * various states of availability.
28 */
Viresh Kumarf47b72a2016-05-05 16:20:33 +053029LIST_HEAD(opp_tables);
Nishanth Menone1f60b22010-10-13 00:13:10 +020030/* Lock to allow exclusive modification to the device and opp lists */
Viresh Kumar2c2709d2016-02-16 14:17:53 +053031DEFINE_MUTEX(opp_table_lock);
Nishanth Menone1f60b22010-10-13 00:13:10 +020032
Viresh Kumar2c2709d2016-02-16 14:17:53 +053033static struct opp_device *_find_opp_dev(const struct device *dev,
34 struct opp_table *opp_table)
Viresh Kumar06441652015-07-29 16:23:04 +053035{
Viresh Kumar2c2709d2016-02-16 14:17:53 +053036 struct opp_device *opp_dev;
Viresh Kumar06441652015-07-29 16:23:04 +053037
Viresh Kumar2c2709d2016-02-16 14:17:53 +053038 list_for_each_entry(opp_dev, &opp_table->dev_list, node)
39 if (opp_dev->dev == dev)
40 return opp_dev;
Viresh Kumar06441652015-07-29 16:23:04 +053041
42 return NULL;
43}
44
Wei Yongjun6ac42392017-02-06 14:29:55 +000045static struct opp_table *_find_opp_table_unlocked(struct device *dev)
Viresh Kumar5b650b32017-01-23 10:11:48 +053046{
47 struct opp_table *opp_table;
Viresh Kumar3d255692018-08-03 07:05:21 +053048 bool found;
Viresh Kumar5b650b32017-01-23 10:11:48 +053049
50 list_for_each_entry(opp_table, &opp_tables, node) {
Viresh Kumar3d255692018-08-03 07:05:21 +053051 mutex_lock(&opp_table->lock);
52 found = !!_find_opp_dev(dev, opp_table);
53 mutex_unlock(&opp_table->lock);
54
55 if (found) {
Viresh Kumar5b650b32017-01-23 10:11:48 +053056 _get_opp_table_kref(opp_table);
57
58 return opp_table;
59 }
60 }
61
62 return ERR_PTR(-ENODEV);
63}
64
Nishanth Menone1f60b22010-10-13 00:13:10 +020065/**
Viresh Kumar2c2709d2016-02-16 14:17:53 +053066 * _find_opp_table() - find opp_table struct using device pointer
67 * @dev: device pointer used to lookup OPP table
Nishanth Menone1f60b22010-10-13 00:13:10 +020068 *
Viresh Kumar052c6f12017-01-23 10:11:49 +053069 * Search OPP table for one containing matching device.
Nishanth Menone1f60b22010-10-13 00:13:10 +020070 *
Viresh Kumar2c2709d2016-02-16 14:17:53 +053071 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
Nishanth Menone1f60b22010-10-13 00:13:10 +020072 * -EINVAL based on type of error.
73 *
Viresh Kumar5b650b32017-01-23 10:11:48 +053074 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
Nishanth Menone1f60b22010-10-13 00:13:10 +020075 */
Viresh Kumar2c2709d2016-02-16 14:17:53 +053076struct opp_table *_find_opp_table(struct device *dev)
Nishanth Menone1f60b22010-10-13 00:13:10 +020077{
Viresh Kumar2c2709d2016-02-16 14:17:53 +053078 struct opp_table *opp_table;
Nishanth Menone1f60b22010-10-13 00:13:10 +020079
Viresh Kumar50a3cb02015-08-12 15:59:39 +053080 if (IS_ERR_OR_NULL(dev)) {
Nishanth Menone1f60b22010-10-13 00:13:10 +020081 pr_err("%s: Invalid parameters\n", __func__);
82 return ERR_PTR(-EINVAL);
83 }
84
Viresh Kumar5b650b32017-01-23 10:11:48 +053085 mutex_lock(&opp_table_lock);
86 opp_table = _find_opp_table_unlocked(dev);
87 mutex_unlock(&opp_table_lock);
Nishanth Menone1f60b22010-10-13 00:13:10 +020088
Viresh Kumar5b650b32017-01-23 10:11:48 +053089 return opp_table;
Nishanth Menone1f60b22010-10-13 00:13:10 +020090}
91
92/**
Linus Torvaldsbaf51c42015-11-11 09:03:01 -080093 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
Nishanth Menone1f60b22010-10-13 00:13:10 +020094 * @opp: opp for which voltage has to be returned for
95 *
Nishanth Menon984f16c2014-12-24 11:22:57 -060096 * Return: voltage in micro volt corresponding to the opp, else
Nishanth Menone1f60b22010-10-13 00:13:10 +020097 * return 0
98 *
Viresh Kumardfbe4672016-12-01 16:28:19 +053099 * This is useful only for devices with single power supply.
Nishanth Menone1f60b22010-10-13 00:13:10 +0200100 */
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500101unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
Nishanth Menone1f60b22010-10-13 00:13:10 +0200102{
Viresh Kumar052c6f12017-01-23 10:11:49 +0530103 if (IS_ERR_OR_NULL(opp)) {
Nishanth Menone1f60b22010-10-13 00:13:10 +0200104 pr_err("%s: Invalid parameters\n", __func__);
Viresh Kumar052c6f12017-01-23 10:11:49 +0530105 return 0;
106 }
Nishanth Menone1f60b22010-10-13 00:13:10 +0200107
Viresh Kumar052c6f12017-01-23 10:11:49 +0530108 return opp->supplies[0].u_volt;
Nishanth Menone1f60b22010-10-13 00:13:10 +0200109}
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500110EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200111
112/**
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500113 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
Nishanth Menone1f60b22010-10-13 00:13:10 +0200114 * @opp: opp for which frequency has to be returned for
115 *
Nishanth Menon984f16c2014-12-24 11:22:57 -0600116 * Return: frequency in hertz corresponding to the opp, else
Nishanth Menone1f60b22010-10-13 00:13:10 +0200117 * return 0
Nishanth Menone1f60b22010-10-13 00:13:10 +0200118 */
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500119unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
Nishanth Menone1f60b22010-10-13 00:13:10 +0200120{
Viresh Kumar052c6f12017-01-23 10:11:49 +0530121 if (IS_ERR_OR_NULL(opp) || !opp->available) {
Nishanth Menone1f60b22010-10-13 00:13:10 +0200122 pr_err("%s: Invalid parameters\n", __func__);
Viresh Kumar052c6f12017-01-23 10:11:49 +0530123 return 0;
124 }
Nishanth Menone1f60b22010-10-13 00:13:10 +0200125
Viresh Kumar052c6f12017-01-23 10:11:49 +0530126 return opp->rate;
Nishanth Menone1f60b22010-10-13 00:13:10 +0200127}
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500128EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200129
130/**
Rajendra Nayak5b93ac52019-01-10 09:32:02 +0530131 * 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
133 *
134 * Return: level read from device tree corresponding to the opp, else
135 * return 0.
136 */
137unsigned int dev_pm_opp_get_level(struct dev_pm_opp *opp)
138{
139 if (IS_ERR_OR_NULL(opp) || !opp->available) {
140 pr_err("%s: Invalid parameters\n", __func__);
141 return 0;
142 }
143
144 return opp->level;
145}
146EXPORT_SYMBOL_GPL(dev_pm_opp_get_level);
147
148/**
Bartlomiej Zolnierkiewicz19445b22015-07-09 17:43:35 +0200149 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
150 * @opp: opp for which turbo mode is being verified
151 *
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.
155 *
156 * Return: true if opp is turbo opp, else false.
Bartlomiej Zolnierkiewicz19445b22015-07-09 17:43:35 +0200157 */
158bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
159{
Viresh Kumar052c6f12017-01-23 10:11:49 +0530160 if (IS_ERR_OR_NULL(opp) || !opp->available) {
Bartlomiej Zolnierkiewicz19445b22015-07-09 17:43:35 +0200161 pr_err("%s: Invalid parameters\n", __func__);
162 return false;
163 }
164
Viresh Kumar052c6f12017-01-23 10:11:49 +0530165 return opp->turbo;
Bartlomiej Zolnierkiewicz19445b22015-07-09 17:43:35 +0200166}
167EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);
168
169/**
Viresh Kumar3ca9bb32015-07-29 16:23:03 +0530170 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
171 * @dev: device for which we do this operation
172 *
173 * Return: This function returns the max clock latency in nanoseconds.
Viresh Kumar3ca9bb32015-07-29 16:23:03 +0530174 */
175unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
176{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530177 struct opp_table *opp_table;
Viresh Kumar3ca9bb32015-07-29 16:23:03 +0530178 unsigned long clock_latency_ns;
179
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530180 opp_table = _find_opp_table(dev);
181 if (IS_ERR(opp_table))
Viresh Kumar5b650b32017-01-23 10:11:48 +0530182 return 0;
Viresh Kumar3ca9bb32015-07-29 16:23:03 +0530183
Viresh Kumar5b650b32017-01-23 10:11:48 +0530184 clock_latency_ns = opp_table->clock_latency_ns_max;
185
186 dev_pm_opp_put_opp_table(opp_table);
187
Viresh Kumar3ca9bb32015-07-29 16:23:03 +0530188 return clock_latency_ns;
189}
190EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);
191
192/**
Viresh Kumar655c9df2016-02-09 10:30:35 +0530193 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
194 * @dev: device for which we do this operation
195 *
196 * Return: This function returns the max voltage latency in nanoseconds.
Viresh Kumar655c9df2016-02-09 10:30:35 +0530197 */
198unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
199{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530200 struct opp_table *opp_table;
Viresh Kumar655c9df2016-02-09 10:30:35 +0530201 struct dev_pm_opp *opp;
Viresh Kumar478256b2017-05-23 09:32:11 +0530202 struct regulator *reg;
Viresh Kumar655c9df2016-02-09 10:30:35 +0530203 unsigned long latency_ns = 0;
Viresh Kumardfbe4672016-12-01 16:28:19 +0530204 int ret, i, count;
205 struct {
206 unsigned long min;
207 unsigned long max;
208 } *uV;
209
Viresh Kumarcdd3e612017-01-23 10:11:51 +0530210 opp_table = _find_opp_table(dev);
211 if (IS_ERR(opp_table))
212 return 0;
213
Viresh Kumardfbe4672016-12-01 16:28:19 +0530214 /* Regulator may not be required for the device */
Viresh Kumar90e35772018-12-11 16:32:47 +0530215 if (!opp_table->regulators)
Viresh Kumarcdd3e612017-01-23 10:11:51 +0530216 goto put_opp_table;
Viresh Kumardfbe4672016-12-01 16:28:19 +0530217
Viresh Kumar90e35772018-12-11 16:32:47 +0530218 count = opp_table->regulator_count;
219
Viresh Kumardfbe4672016-12-01 16:28:19 +0530220 uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
221 if (!uV)
Viresh Kumar478256b2017-05-23 09:32:11 +0530222 goto put_opp_table;
Viresh Kumar655c9df2016-02-09 10:30:35 +0530223
Viresh Kumar052c6f12017-01-23 10:11:49 +0530224 mutex_lock(&opp_table->lock);
225
Viresh Kumardfbe4672016-12-01 16:28:19 +0530226 for (i = 0; i < count; i++) {
227 uV[i].min = ~0;
228 uV[i].max = 0;
Viresh Kumar655c9df2016-02-09 10:30:35 +0530229
Viresh Kumar052c6f12017-01-23 10:11:49 +0530230 list_for_each_entry(opp, &opp_table->opp_list, node) {
Viresh Kumardfbe4672016-12-01 16:28:19 +0530231 if (!opp->available)
232 continue;
233
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;
238 }
Viresh Kumar655c9df2016-02-09 10:30:35 +0530239 }
240
Viresh Kumar052c6f12017-01-23 10:11:49 +0530241 mutex_unlock(&opp_table->lock);
Viresh Kumar655c9df2016-02-09 10:30:35 +0530242
243 /*
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530244 * The caller needs to ensure that opp_table (and hence the regulator)
Viresh Kumar655c9df2016-02-09 10:30:35 +0530245 * isn't freed, while we are executing this routine.
246 */
Andrzej Hajda8cc31112017-02-20 19:57:57 +0100247 for (i = 0; i < count; i++) {
Viresh Kumar478256b2017-05-23 09:32:11 +0530248 reg = opp_table->regulators[i];
Viresh Kumardfbe4672016-12-01 16:28:19 +0530249 ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
250 if (ret > 0)
251 latency_ns += ret * 1000;
252 }
253
Viresh Kumardfbe4672016-12-01 16:28:19 +0530254 kfree(uV);
Viresh Kumarcdd3e612017-01-23 10:11:51 +0530255put_opp_table:
256 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar655c9df2016-02-09 10:30:35 +0530257
258 return latency_ns;
259}
260EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);
261
262/**
Viresh Kumar21743442016-02-09 10:30:36 +0530263 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
264 * nanoseconds
265 * @dev: device for which we do this operation
266 *
267 * Return: This function returns the max transition latency, in nanoseconds, to
268 * switch from one OPP to other.
Viresh Kumar21743442016-02-09 10:30:36 +0530269 */
270unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
271{
272 return dev_pm_opp_get_max_volt_latency(dev) +
273 dev_pm_opp_get_max_clock_latency(dev);
274}
275EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);
276
277/**
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530278 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200279 * @dev: device for which we do this operation
280 *
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530281 * Return: This function returns the frequency of the OPP marked as suspend_opp
282 * if one is available, else returns 0;
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200283 */
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530284unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200285{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530286 struct opp_table *opp_table;
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530287 unsigned long freq = 0;
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200288
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530289 opp_table = _find_opp_table(dev);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530290 if (IS_ERR(opp_table))
291 return 0;
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200292
Viresh Kumar5b650b32017-01-23 10:11:48 +0530293 if (opp_table->suspend_opp && opp_table->suspend_opp->available)
294 freq = dev_pm_opp_get_freq(opp_table->suspend_opp);
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530295
Viresh Kumar5b650b32017-01-23 10:11:48 +0530296 dev_pm_opp_put_opp_table(opp_table);
297
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530298 return freq;
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200299}
Viresh Kumar3aa26a32017-01-02 14:41:02 +0530300EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200301
Viresh Kumara1e8c132018-04-06 14:35:45 +0530302int _get_opp_count(struct opp_table *opp_table)
303{
304 struct dev_pm_opp *opp;
305 int count = 0;
306
307 mutex_lock(&opp_table->lock);
308
309 list_for_each_entry(opp, &opp_table->opp_list, node) {
310 if (opp->available)
311 count++;
312 }
313
314 mutex_unlock(&opp_table->lock);
315
316 return count;
317}
318
Bartlomiej Zolnierkiewicz4eafbd12015-09-08 18:41:01 +0200319/**
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530320 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
Nishanth Menone1f60b22010-10-13 00:13:10 +0200321 * @dev: device for which we do this operation
322 *
Nishanth Menon984f16c2014-12-24 11:22:57 -0600323 * Return: This function returns the number of available opps if there are any,
Nishanth Menone1f60b22010-10-13 00:13:10 +0200324 * else returns 0 if none or the corresponding error value.
Nishanth Menone1f60b22010-10-13 00:13:10 +0200325 */
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500326int dev_pm_opp_get_opp_count(struct device *dev)
Nishanth Menone1f60b22010-10-13 00:13:10 +0200327{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530328 struct opp_table *opp_table;
Viresh Kumara1e8c132018-04-06 14:35:45 +0530329 int count;
Nishanth Menone1f60b22010-10-13 00:13:10 +0200330
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530331 opp_table = _find_opp_table(dev);
332 if (IS_ERR(opp_table)) {
333 count = PTR_ERR(opp_table);
Fabio Estevam035ed072017-09-29 14:39:49 -0300334 dev_dbg(dev, "%s: OPP table not found (%d)\n",
Dmitry Torokhovb4718c02014-12-16 15:09:38 -0800335 __func__, count);
Viresh Kumar09f662f2018-10-03 15:22:03 +0530336 return count;
Nishanth Menone1f60b22010-10-13 00:13:10 +0200337 }
338
Viresh Kumara1e8c132018-04-06 14:35:45 +0530339 count = _get_opp_count(opp_table);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530340 dev_pm_opp_put_opp_table(opp_table);
341
Nishanth Menone1f60b22010-10-13 00:13:10 +0200342 return count;
343}
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500344EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200345
346/**
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500347 * dev_pm_opp_find_freq_exact() - search for an exact frequency
Nishanth Menone1f60b22010-10-13 00:13:10 +0200348 * @dev: device for which we do this operation
349 * @freq: frequency to search for
Nishanth Menon7ae49612011-02-25 23:46:18 +0100350 * @available: true/false - match for available opp
Nishanth Menone1f60b22010-10-13 00:13:10 +0200351 *
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530352 * Return: Searches for exact match in the opp table and returns pointer to the
Nishanth Menon984f16c2014-12-24 11:22:57 -0600353 * 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:
Nishanth Menon07797262012-10-24 22:00:12 +0200355 * EINVAL: for bad pointer
356 * ERANGE: no match found for search
357 * ENODEV: if device not found in list of registered devices
Nishanth Menone1f60b22010-10-13 00:13:10 +0200358 *
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.
362 *
363 * This provides a mechanism to enable an opp which is not available currently
364 * or the opposite as well.
365 *
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530366 * The callers are required to call dev_pm_opp_put() for the returned OPP after
367 * use.
Nishanth Menone1f60b22010-10-13 00:13:10 +0200368 */
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500369struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
370 unsigned long freq,
371 bool available)
Nishanth Menone1f60b22010-10-13 00:13:10 +0200372{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530373 struct opp_table *opp_table;
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500374 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200375
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530376 opp_table = _find_opp_table(dev);
377 if (IS_ERR(opp_table)) {
378 int r = PTR_ERR(opp_table);
379
380 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200381 return ERR_PTR(r);
382 }
383
Viresh Kumar052c6f12017-01-23 10:11:49 +0530384 mutex_lock(&opp_table->lock);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530385
Viresh Kumar052c6f12017-01-23 10:11:49 +0530386 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
Nishanth Menone1f60b22010-10-13 00:13:10 +0200387 if (temp_opp->available == available &&
388 temp_opp->rate == freq) {
389 opp = temp_opp;
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530390
391 /* Increment the reference count of OPP */
392 dev_pm_opp_get(opp);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200393 break;
394 }
395 }
396
Viresh Kumar052c6f12017-01-23 10:11:49 +0530397 mutex_unlock(&opp_table->lock);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530398 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530399
Nishanth Menone1f60b22010-10-13 00:13:10 +0200400 return opp;
401}
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500402EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200403
Niklas Cassel71419d82019-07-25 12:41:29 +0200404/**
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
408 *
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
415 *
416 * The callers are required to call dev_pm_opp_put() for the returned OPP after
417 * use.
418 */
419struct dev_pm_opp *dev_pm_opp_find_level_exact(struct device *dev,
420 unsigned int level)
421{
422 struct opp_table *opp_table;
423 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
424
425 opp_table = _find_opp_table(dev);
426 if (IS_ERR(opp_table)) {
427 int r = PTR_ERR(opp_table);
428
429 dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
430 return ERR_PTR(r);
431 }
432
433 mutex_lock(&opp_table->lock);
434
435 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
436 if (temp_opp->level == level) {
437 opp = temp_opp;
438
439 /* Increment the reference count of OPP */
440 dev_pm_opp_get(opp);
441 break;
442 }
443 }
444
445 mutex_unlock(&opp_table->lock);
446 dev_pm_opp_put_opp_table(opp_table);
447
448 return opp;
449}
450EXPORT_SYMBOL_GPL(dev_pm_opp_find_level_exact);
451
Jisheng Zhang067b7ce2016-07-25 14:11:16 +0800452static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
453 unsigned long *freq)
454{
455 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
456
Viresh Kumar052c6f12017-01-23 10:11:49 +0530457 mutex_lock(&opp_table->lock);
458
459 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
Jisheng Zhang067b7ce2016-07-25 14:11:16 +0800460 if (temp_opp->available && temp_opp->rate >= *freq) {
461 opp = temp_opp;
462 *freq = opp->rate;
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530463
464 /* Increment the reference count of OPP */
465 dev_pm_opp_get(opp);
Jisheng Zhang067b7ce2016-07-25 14:11:16 +0800466 break;
467 }
468 }
469
Viresh Kumar052c6f12017-01-23 10:11:49 +0530470 mutex_unlock(&opp_table->lock);
471
Jisheng Zhang067b7ce2016-07-25 14:11:16 +0800472 return opp;
473}
474
Nishanth Menone1f60b22010-10-13 00:13:10 +0200475/**
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500476 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
Nishanth Menone1f60b22010-10-13 00:13:10 +0200477 * @dev: device for which we do this operation
478 * @freq: Start frequency
479 *
480 * Search for the matching ceil *available* OPP from a starting freq
481 * for a device.
482 *
Nishanth Menon984f16c2014-12-24 11:22:57 -0600483 * Return: matching *opp and refreshes *freq accordingly, else returns
Nishanth Menon07797262012-10-24 22:00:12 +0200484 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
485 * values can be:
486 * EINVAL: for bad pointer
487 * ERANGE: no match found for search
488 * ENODEV: if device not found in list of registered devices
Nishanth Menone1f60b22010-10-13 00:13:10 +0200489 *
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530490 * The callers are required to call dev_pm_opp_put() for the returned OPP after
491 * use.
Nishanth Menone1f60b22010-10-13 00:13:10 +0200492 */
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500493struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
494 unsigned long *freq)
Nishanth Menone1f60b22010-10-13 00:13:10 +0200495{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530496 struct opp_table *opp_table;
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530497 struct dev_pm_opp *opp;
Dmitry Torokhovb02ded22014-12-16 15:09:36 -0800498
Nishanth Menone1f60b22010-10-13 00:13:10 +0200499 if (!dev || !freq) {
500 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
501 return ERR_PTR(-EINVAL);
502 }
503
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530504 opp_table = _find_opp_table(dev);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530505 if (IS_ERR(opp_table))
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530506 return ERR_CAST(opp_table);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530507
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530508 opp = _find_freq_ceil(opp_table, freq);
509
Viresh Kumar5b650b32017-01-23 10:11:48 +0530510 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530511
512 return opp;
Nishanth Menone1f60b22010-10-13 00:13:10 +0200513}
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500514EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200515
516/**
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500517 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
Nishanth Menone1f60b22010-10-13 00:13:10 +0200518 * @dev: device for which we do this operation
519 * @freq: Start frequency
520 *
521 * Search for the matching floor *available* OPP from a starting freq
522 * for a device.
523 *
Nishanth Menon984f16c2014-12-24 11:22:57 -0600524 * Return: matching *opp and refreshes *freq accordingly, else returns
Nishanth Menon07797262012-10-24 22:00:12 +0200525 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
526 * values can be:
527 * EINVAL: for bad pointer
528 * ERANGE: no match found for search
529 * ENODEV: if device not found in list of registered devices
Nishanth Menone1f60b22010-10-13 00:13:10 +0200530 *
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530531 * The callers are required to call dev_pm_opp_put() for the returned OPP after
532 * use.
Nishanth Menone1f60b22010-10-13 00:13:10 +0200533 */
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500534struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
535 unsigned long *freq)
Nishanth Menone1f60b22010-10-13 00:13:10 +0200536{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530537 struct opp_table *opp_table;
Nishanth Menon47d43ba2013-09-19 16:03:51 -0500538 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200539
540 if (!dev || !freq) {
541 dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
542 return ERR_PTR(-EINVAL);
543 }
544
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530545 opp_table = _find_opp_table(dev);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530546 if (IS_ERR(opp_table))
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530547 return ERR_CAST(opp_table);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530548
Viresh Kumar052c6f12017-01-23 10:11:49 +0530549 mutex_lock(&opp_table->lock);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200550
Viresh Kumar052c6f12017-01-23 10:11:49 +0530551 list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
Nishanth Menone1f60b22010-10-13 00:13:10 +0200552 if (temp_opp->available) {
553 /* go to the next node, before choosing prev */
554 if (temp_opp->rate > *freq)
555 break;
556 else
557 opp = temp_opp;
558 }
559 }
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530560
561 /* Increment the reference count of OPP */
562 if (!IS_ERR(opp))
563 dev_pm_opp_get(opp);
Viresh Kumar052c6f12017-01-23 10:11:49 +0530564 mutex_unlock(&opp_table->lock);
Viresh Kumar5b650b32017-01-23 10:11:48 +0530565 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar8a31d9d92017-01-23 10:11:47 +0530566
Nishanth Menone1f60b22010-10-13 00:13:10 +0200567 if (!IS_ERR(opp))
568 *freq = opp->rate;
569
570 return opp;
571}
Nishanth Menon5d4879c2013-09-19 16:03:50 -0500572EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
Nishanth Menone1f60b22010-10-13 00:13:10 +0200573
Andrew-sh.Cheng2f36bde2019-03-29 14:46:10 +0800574/**
575 * dev_pm_opp_find_freq_ceil_by_volt() - Find OPP with highest frequency for
576 * target voltage.
577 * @dev: Device for which we do this operation.
578 * @u_volt: Target voltage.
579 *
580 * Search for OPP with highest (ceil) frequency and has voltage <= u_volt.
581 *
582 * Return: matching *opp, else returns ERR_PTR in case of error which should be
583 * handled using IS_ERR.
584 *
585 * Error return values can be:
586 * EINVAL: bad parameters
587 *
588 * The callers are required to call dev_pm_opp_put() for the returned OPP after
589 * use.
590 */
591struct dev_pm_opp *dev_pm_opp_find_freq_ceil_by_volt(struct device *dev,
592 unsigned long u_volt)
593{
594 struct opp_table *opp_table;
595 struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
596
597 if (!dev || !u_volt) {
598 dev_err(dev, "%s: Invalid argument volt=%lu\n", __func__,
599 u_volt);
600 return ERR_PTR(-EINVAL);
601 }
602
603 opp_table = _find_opp_table(dev);
604 if (IS_ERR(opp_table))
605 return ERR_CAST(opp_table);
606
607 mutex_lock(&opp_table->lock);
608
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)
612 break;
613 opp = temp_opp;
614 }
615 }
616
617 /* Increment the reference count of OPP */
618 if (!IS_ERR(opp))
619 dev_pm_opp_get(opp);
620
621 mutex_unlock(&opp_table->lock);
622 dev_pm_opp_put_opp_table(opp_table);
623
624 return opp;
625}
626EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil_by_volt);
627
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530628static int _set_opp_voltage(struct device *dev, struct regulator *reg,
Viresh Kumarce317812016-12-01 16:28:18 +0530629 struct dev_pm_opp_supply *supply)
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530630{
631 int ret;
632
633 /* Regulator not available for device */
634 if (IS_ERR(reg)) {
635 dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
636 PTR_ERR(reg));
637 return 0;
638 }
639
Viresh Kumarce317812016-12-01 16:28:18 +0530640 dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
641 supply->u_volt_min, supply->u_volt, supply->u_volt_max);
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530642
Viresh Kumarce317812016-12-01 16:28:18 +0530643 ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
644 supply->u_volt, supply->u_volt_max);
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530645 if (ret)
646 dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
Viresh Kumarce317812016-12-01 16:28:18 +0530647 __func__, supply->u_volt_min, supply->u_volt,
648 supply->u_volt_max, ret);
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530649
650 return ret;
651}
652
Viresh Kumar285881b2019-01-31 13:53:25 +0530653static inline int _generic_set_opp_clk_only(struct device *dev, struct clk *clk,
654 unsigned long freq)
Viresh Kumar94735582016-12-01 16:28:20 +0530655{
656 int ret;
657
658 ret = clk_set_rate(clk, freq);
659 if (ret) {
660 dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
661 ret);
662 }
663
664 return ret;
665}
666
Kamil Konieczny8d457192019-07-19 17:05:32 +0200667static int _generic_set_opp_regulator(struct opp_table *opp_table,
Viresh Kumarc74b32f2017-05-23 09:32:10 +0530668 struct device *dev,
669 unsigned long old_freq,
670 unsigned long freq,
671 struct dev_pm_opp_supply *old_supply,
672 struct dev_pm_opp_supply *new_supply)
Viresh Kumar94735582016-12-01 16:28:20 +0530673{
Viresh Kumarc74b32f2017-05-23 09:32:10 +0530674 struct regulator *reg = opp_table->regulators[0];
Viresh Kumar94735582016-12-01 16:28:20 +0530675 int ret;
676
677 /* This function only supports single regulator per device */
Viresh Kumarc74b32f2017-05-23 09:32:10 +0530678 if (WARN_ON(opp_table->regulator_count > 1)) {
Viresh Kumar94735582016-12-01 16:28:20 +0530679 dev_err(dev, "multiple regulators are not supported\n");
680 return -EINVAL;
681 }
682
683 /* Scaling up? Scale voltage before frequency */
Waldemar Rymarkiewiczc5c2a972018-06-14 15:56:08 +0200684 if (freq >= old_freq) {
Viresh Kumar94735582016-12-01 16:28:20 +0530685 ret = _set_opp_voltage(dev, reg, new_supply);
686 if (ret)
687 goto restore_voltage;
688 }
689
690 /* Change frequency */
Viresh Kumar285881b2019-01-31 13:53:25 +0530691 ret = _generic_set_opp_clk_only(dev, opp_table->clk, freq);
Viresh Kumar94735582016-12-01 16:28:20 +0530692 if (ret)
693 goto restore_voltage;
694
695 /* Scaling down? Scale voltage after frequency */
696 if (freq < old_freq) {
697 ret = _set_opp_voltage(dev, reg, new_supply);
698 if (ret)
699 goto restore_freq;
700 }
701
Kamil Konieczny8d457192019-07-19 17:05:32 +0200702 /*
703 * Enable the regulator after setting its voltages, otherwise it breaks
704 * some boot-enabled regulators.
705 */
706 if (unlikely(!opp_table->regulator_enabled)) {
707 ret = regulator_enable(reg);
708 if (ret < 0)
709 dev_warn(dev, "Failed to enable regulator: %d", ret);
710 else
711 opp_table->regulator_enabled = true;
712 }
713
Viresh Kumar94735582016-12-01 16:28:20 +0530714 return 0;
715
716restore_freq:
Viresh Kumar285881b2019-01-31 13:53:25 +0530717 if (_generic_set_opp_clk_only(dev, opp_table->clk, old_freq))
Viresh Kumar94735582016-12-01 16:28:20 +0530718 dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
719 __func__, old_freq);
720restore_voltage:
721 /* This shouldn't harm even if the voltages weren't updated earlier */
Viresh Kumarc74b32f2017-05-23 09:32:10 +0530722 if (old_supply)
Viresh Kumar94735582016-12-01 16:28:20 +0530723 _set_opp_voltage(dev, reg, old_supply);
724
725 return ret;
726}
727
Viresh Kumarb00e6672020-05-27 09:33:44 +0530728static int _set_opp_bw(const struct opp_table *opp_table,
729 struct dev_pm_opp *opp, struct device *dev, bool remove)
730{
731 u32 avg, peak;
732 int i, ret;
733
734 if (!opp_table->paths)
735 return 0;
736
737 for (i = 0; i < opp_table->path_count; i++) {
738 if (remove) {
739 avg = 0;
740 peak = 0;
741 } else {
742 avg = opp->bandwidth[i].avg;
743 peak = opp->bandwidth[i].peak;
744 }
745 ret = icc_set_bw(opp_table->paths[i], avg, peak);
746 if (ret) {
747 dev_err(dev, "Failed to %s bandwidth[%d]: %d\n",
748 remove ? "remove" : "set", i, ret);
749 return ret;
750 }
751 }
752
753 return 0;
754}
755
Viresh Kumar7e5359932018-06-12 14:47:03 +0530756static int _set_opp_custom(const struct opp_table *opp_table,
757 struct device *dev, unsigned long old_freq,
758 unsigned long freq,
759 struct dev_pm_opp_supply *old_supply,
760 struct dev_pm_opp_supply *new_supply)
761{
762 struct dev_pm_set_opp_data *data;
763 int size;
764
765 data = opp_table->set_opp_data;
766 data->regulators = opp_table->regulators;
767 data->regulator_count = opp_table->regulator_count;
768 data->clk = opp_table->clk;
769 data->dev = dev;
770
771 data->old_opp.rate = old_freq;
772 size = sizeof(*old_supply) * opp_table->regulator_count;
Dmitry Osipenko560d1bc2019-06-23 20:50:53 +0300773 if (!old_supply)
Viresh Kumar7e5359932018-06-12 14:47:03 +0530774 memset(data->old_opp.supplies, 0, size);
775 else
776 memcpy(data->old_opp.supplies, old_supply, size);
777
778 data->new_opp.rate = freq;
779 memcpy(data->new_opp.supplies, new_supply, size);
780
781 return opp_table->set_opp(data);
782}
783
Viresh Kumarca1b5d72018-06-14 10:03:26 +0530784/* This is only called for PM domain for now */
785static int _set_required_opps(struct device *dev,
786 struct opp_table *opp_table,
787 struct dev_pm_opp *opp)
788{
789 struct opp_table **required_opp_tables = opp_table->required_opp_tables;
790 struct device **genpd_virt_devs = opp_table->genpd_virt_devs;
791 unsigned int pstate;
792 int i, ret = 0;
793
794 if (!required_opp_tables)
795 return 0;
796
797 /* Single genpd case */
798 if (!genpd_virt_devs) {
Rajendra Nayakcd7ea582019-03-20 15:19:09 +0530799 pstate = likely(opp) ? opp->required_opps[0]->pstate : 0;
Viresh Kumarca1b5d72018-06-14 10:03:26 +0530800 ret = dev_pm_genpd_set_performance_state(dev, pstate);
801 if (ret) {
802 dev_err(dev, "Failed to set performance state of %s: %d (%d)\n",
803 dev_name(dev), pstate, ret);
804 }
805 return ret;
806 }
807
808 /* Multiple genpd case */
809
810 /*
811 * Acquire genpd_virt_dev_lock to make sure we don't use a genpd_dev
812 * after it is freed from another thread.
813 */
814 mutex_lock(&opp_table->genpd_virt_dev_lock);
815
816 for (i = 0; i < opp_table->required_opp_count; i++) {
Rajendra Nayakcd7ea582019-03-20 15:19:09 +0530817 pstate = likely(opp) ? opp->required_opps[i]->pstate : 0;
Viresh Kumarca1b5d72018-06-14 10:03:26 +0530818
819 if (!genpd_virt_devs[i])
820 continue;
821
822 ret = dev_pm_genpd_set_performance_state(genpd_virt_devs[i], pstate);
823 if (ret) {
824 dev_err(dev, "Failed to set performance rate of %s: %d (%d)\n",
825 dev_name(genpd_virt_devs[i]), pstate, ret);
826 break;
827 }
828 }
829 mutex_unlock(&opp_table->genpd_virt_dev_lock);
830
831 return ret;
832}
833
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530834/**
Sibi Sankar3ae1f392020-06-06 03:03:30 +0530835 * dev_pm_opp_set_bw() - sets bandwidth levels corresponding to an opp
836 * @dev: device for which we do this operation
837 * @opp: opp based on which the bandwidth levels are to be configured
838 *
839 * This configures the bandwidth to the levels specified by the OPP. However
840 * if the OPP specified is NULL the bandwidth levels are cleared out.
841 *
842 * Return: 0 on success or a negative error value.
843 */
844int dev_pm_opp_set_bw(struct device *dev, struct dev_pm_opp *opp)
845{
846 struct opp_table *opp_table;
847 int ret;
848
849 opp_table = _find_opp_table(dev);
850 if (IS_ERR(opp_table)) {
851 dev_err(dev, "%s: device opp table doesn't exist\n", __func__);
852 return PTR_ERR(opp_table);
853 }
854
855 if (opp)
856 ret = _set_opp_bw(opp_table, opp, dev, false);
857 else
858 ret = _set_opp_bw(opp_table, NULL, dev, true);
859
860 dev_pm_opp_put_opp_table(opp_table);
861 return ret;
862}
863EXPORT_SYMBOL_GPL(dev_pm_opp_set_bw);
864
865/**
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530866 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
867 * @dev: device for which we do this operation
868 * @target_freq: frequency to achieve
869 *
Stephen Boydb3e37592019-03-20 15:19:08 +0530870 * This configures the power-supplies to the levels specified by the OPP
871 * corresponding to the target_freq, and programs the clock to a value <=
872 * target_freq, as rounded by clk_round_rate(). Device wanting to run at fmax
873 * provided by the opp, should have already rounded to the target OPP's
874 * frequency.
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530875 */
876int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
877{
Viresh Kumar2c2709d2016-02-16 14:17:53 +0530878 struct opp_table *opp_table;
Stephen Boydb3e37592019-03-20 15:19:08 +0530879 unsigned long freq, old_freq, temp_freq;
Viresh Kumar94735582016-12-01 16:28:20 +0530880 struct dev_pm_opp *old_opp, *opp;
Viresh Kumar94735582016-12-01 16:28:20 +0530881 struct clk *clk;
Viresh Kumarb00e6672020-05-27 09:33:44 +0530882 int ret;
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530883
Viresh Kumar052c6f12017-01-23 10:11:49 +0530884 opp_table = _find_opp_table(dev);
885 if (IS_ERR(opp_table)) {
886 dev_err(dev, "%s: device opp doesn't exist\n", __func__);
887 return PTR_ERR(opp_table);
888 }
889
Rajendra Nayakcd7ea582019-03-20 15:19:09 +0530890 if (unlikely(!target_freq)) {
Viresh Kumarb23dfa32020-05-15 12:37:24 +0530891 /*
892 * Some drivers need to support cases where some platforms may
893 * have OPP table for the device, while others don't and
894 * opp_set_rate() just needs to behave like clk_set_rate().
895 */
896 if (!_get_opp_count(opp_table))
Rajendra Nayakaca48b62020-04-08 19:16:27 +0530897 return 0;
Viresh Kumarb23dfa32020-05-15 12:37:24 +0530898
Viresh Kumarb00e6672020-05-27 09:33:44 +0530899 if (!opp_table->required_opp_tables && !opp_table->regulators &&
900 !opp_table->paths) {
Rajendra Nayakcd7ea582019-03-20 15:19:09 +0530901 dev_err(dev, "target frequency can't be 0\n");
902 ret = -EINVAL;
Viresh Kumarb23dfa32020-05-15 12:37:24 +0530903 goto put_opp_table;
Rajendra Nayakcd7ea582019-03-20 15:19:09 +0530904 }
905
Viresh Kumarb00e6672020-05-27 09:33:44 +0530906 ret = _set_opp_bw(opp_table, NULL, dev, true);
907 if (ret)
908 return ret;
909
Kamil Konieczny8d457192019-07-19 17:05:32 +0200910 if (opp_table->regulator_enabled) {
911 regulator_disable(opp_table->regulators[0]);
912 opp_table->regulator_enabled = false;
913 }
914
Viresh Kumarb23dfa32020-05-15 12:37:24 +0530915 ret = _set_required_opps(dev, opp_table, NULL);
Rajendra Nayakcd7ea582019-03-20 15:19:09 +0530916 goto put_opp_table;
917 }
918
Viresh Kumar052c6f12017-01-23 10:11:49 +0530919 clk = opp_table->clk;
920 if (IS_ERR(clk)) {
921 dev_err(dev, "%s: No clock available for the device\n",
922 __func__);
923 ret = PTR_ERR(clk);
924 goto put_opp_table;
925 }
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530926
927 freq = clk_round_rate(clk, target_freq);
928 if ((long)freq <= 0)
929 freq = target_freq;
930
931 old_freq = clk_get_rate(clk);
932
933 /* Return early if nothing to do */
934 if (old_freq == freq) {
935 dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
936 __func__, freq);
Viresh Kumar052c6f12017-01-23 10:11:49 +0530937 ret = 0;
938 goto put_opp_table;
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530939 }
940
Rajendra Nayakaca48b62020-04-08 19:16:27 +0530941 /*
942 * For IO devices which require an OPP on some platforms/SoCs
943 * while just needing to scale the clock on some others
944 * we look for empty OPP tables with just a clock handle and
945 * scale only the clk. This makes dev_pm_opp_set_rate()
946 * equivalent to a clk_set_rate()
947 */
948 if (!_get_opp_count(opp_table)) {
949 ret = _generic_set_opp_clk_only(dev, clk, freq);
950 goto put_opp_table;
951 }
952
Stephen Boydb3e37592019-03-20 15:19:08 +0530953 temp_freq = old_freq;
954 old_opp = _find_freq_ceil(opp_table, &temp_freq);
Arnd Bergmann4df27c92016-09-15 17:38:38 +0200955 if (IS_ERR(old_opp)) {
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530956 dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
957 __func__, old_freq, PTR_ERR(old_opp));
958 }
959
Stephen Boydb3e37592019-03-20 15:19:08 +0530960 temp_freq = freq;
961 opp = _find_freq_ceil(opp_table, &temp_freq);
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530962 if (IS_ERR(opp)) {
963 ret = PTR_ERR(opp);
964 dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
965 __func__, freq, ret);
Viresh Kumar052c6f12017-01-23 10:11:49 +0530966 goto put_old_opp;
Viresh Kumar6a0712f2016-02-09 10:30:39 +0530967 }
968
Viresh Kumar94735582016-12-01 16:28:20 +0530969 dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
970 old_freq, freq);
Viresh Kumardfbe4672016-12-01 16:28:19 +0530971
Viresh Kumarca1b5d72018-06-14 10:03:26 +0530972 /* Scaling up? Configure required OPPs before frequency */
Viresh Kumarfaef0802019-03-12 10:27:18 +0530973 if (freq >= old_freq) {
Viresh Kumarca1b5d72018-06-14 10:03:26 +0530974 ret = _set_required_opps(dev, opp_table, opp);
975 if (ret)
976 goto put_opp;
977 }
978
Viresh Kumar7e5359932018-06-12 14:47:03 +0530979 if (opp_table->set_opp) {
980 ret = _set_opp_custom(opp_table, dev, old_freq, freq,
981 IS_ERR(old_opp) ? NULL : old_opp->supplies,
982 opp->supplies);
983 } else if (opp_table->regulators) {
Viresh Kumarc74b32f2017-05-23 09:32:10 +0530984 ret = _generic_set_opp_regulator(opp_table, dev, old_freq, freq,
985 IS_ERR(old_opp) ? NULL : old_opp->supplies,
986 opp->supplies);
987 } else {
Viresh Kumar7e5359932018-06-12 14:47:03 +0530988 /* Only frequency scaling */
Viresh Kumar285881b2019-01-31 13:53:25 +0530989 ret = _generic_set_opp_clk_only(dev, clk, freq);
Viresh Kumardfbe4672016-12-01 16:28:19 +0530990 }
991
Viresh Kumarca1b5d72018-06-14 10:03:26 +0530992 /* Scaling down? Configure required OPPs after frequency */
993 if (!ret && freq < old_freq) {
994 ret = _set_required_opps(dev, opp_table, opp);
995 if (ret)
996 dev_err(dev, "Failed to set required opps: %d\n", ret);
997 }
998
Viresh Kumarb00e6672020-05-27 09:33:44 +0530999 if (!ret)
1000 ret = _set_opp_bw(opp_table, opp, dev, false);
Georgi Djakovfe2af402020-05-12 15:53:23 +03001001
Viresh Kumarca1b5d72018-06-14 10:03:26 +05301002put_opp:
Viresh Kumar8a31d9d92017-01-23 10:11:47 +05301003 dev_pm_opp_put(opp);
Viresh Kumar052c6f12017-01-23 10:11:49 +05301004put_old_opp:
Viresh Kumar8a31d9d92017-01-23 10:11:47 +05301005 if (!IS_ERR(old_opp))
1006 dev_pm_opp_put(old_opp);
Viresh Kumar052c6f12017-01-23 10:11:49 +05301007put_opp_table:
Viresh Kumar5b650b32017-01-23 10:11:48 +05301008 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar052c6f12017-01-23 10:11:49 +05301009 return ret;
Viresh Kumar6a0712f2016-02-09 10:30:39 +05301010}
1011EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);
1012
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301013/* OPP-dev Helpers */
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301014static void _remove_opp_dev(struct opp_device *opp_dev,
1015 struct opp_table *opp_table)
Viresh Kumar06441652015-07-29 16:23:04 +05301016{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301017 opp_debug_unregister(opp_dev, opp_table);
1018 list_del(&opp_dev->node);
Viresh Kumar052c6f12017-01-23 10:11:49 +05301019 kfree(opp_dev);
Viresh Kumar06441652015-07-29 16:23:04 +05301020}
1021
Viresh Kumar283d55e2018-09-07 09:01:54 +05301022static struct opp_device *_add_opp_dev_unlocked(const struct device *dev,
1023 struct opp_table *opp_table)
Viresh Kumar06441652015-07-29 16:23:04 +05301024{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301025 struct opp_device *opp_dev;
Viresh Kumar06441652015-07-29 16:23:04 +05301026
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301027 opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
1028 if (!opp_dev)
Viresh Kumar06441652015-07-29 16:23:04 +05301029 return NULL;
1030
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301031 /* Initialize opp-dev */
1032 opp_dev->dev = dev;
Viresh Kumar3d255692018-08-03 07:05:21 +05301033
Viresh Kumar052c6f12017-01-23 10:11:49 +05301034 list_add(&opp_dev->node, &opp_table->dev_list);
Viresh Kumar06441652015-07-29 16:23:04 +05301035
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301036 /* Create debugfs entries for the opp_table */
Greg Kroah-Hartmana2dea4c2019-01-22 16:21:17 +01001037 opp_debug_register(opp_dev, opp_table);
Viresh Kumar283d55e2018-09-07 09:01:54 +05301038
1039 return opp_dev;
1040}
1041
1042struct opp_device *_add_opp_dev(const struct device *dev,
1043 struct opp_table *opp_table)
1044{
1045 struct opp_device *opp_dev;
1046
1047 mutex_lock(&opp_table->lock);
1048 opp_dev = _add_opp_dev_unlocked(dev, opp_table);
Viresh Kumar3d255692018-08-03 07:05:21 +05301049 mutex_unlock(&opp_table->lock);
Viresh Kumardeaa5142015-11-11 07:59:01 +05301050
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301051 return opp_dev;
Viresh Kumar06441652015-07-29 16:23:04 +05301052}
1053
Viresh Kumareb7c87432018-09-05 16:17:14 +05301054static struct opp_table *_allocate_opp_table(struct device *dev, int index)
Viresh Kumar07cce742014-12-10 09:45:34 +05301055{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301056 struct opp_table *opp_table;
1057 struct opp_device *opp_dev;
Viresh Kumard54974c2016-02-09 10:30:38 +05301058 int ret;
Viresh Kumar07cce742014-12-10 09:45:34 +05301059
1060 /*
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301061 * Allocate a new OPP table. In the infrequent case where a new
Viresh Kumar07cce742014-12-10 09:45:34 +05301062 * device is needed to be added, we pay this penalty.
1063 */
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301064 opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
1065 if (!opp_table)
Viresh Kumar07cce742014-12-10 09:45:34 +05301066 return NULL;
1067
Viresh Kumar3d255692018-08-03 07:05:21 +05301068 mutex_init(&opp_table->lock);
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301069 mutex_init(&opp_table->genpd_virt_dev_lock);
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301070 INIT_LIST_HEAD(&opp_table->dev_list);
Viresh Kumar06441652015-07-29 16:23:04 +05301071
Viresh Kumar46f48ac2018-12-11 16:39:36 +05301072 /* Mark regulator count uninitialized */
1073 opp_table->regulator_count = -1;
1074
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301075 opp_dev = _add_opp_dev(dev, opp_table);
1076 if (!opp_dev) {
1077 kfree(opp_table);
Viresh Kumar06441652015-07-29 16:23:04 +05301078 return NULL;
1079 }
1080
Viresh Kumareb7c87432018-09-05 16:17:14 +05301081 _of_init_opp_table(opp_table, dev, index);
Viresh Kumar50f8cfb2016-02-09 10:30:37 +05301082
Viresh Kumard54974c2016-02-09 10:30:38 +05301083 /* Find clk for the device */
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301084 opp_table->clk = clk_get(dev, NULL);
1085 if (IS_ERR(opp_table->clk)) {
1086 ret = PTR_ERR(opp_table->clk);
Viresh Kumard54974c2016-02-09 10:30:38 +05301087 if (ret != -EPROBE_DEFER)
1088 dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
1089 ret);
1090 }
1091
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001092 /* Find interconnect path(s) for the device */
1093 ret = dev_pm_opp_of_find_icc_paths(dev, opp_table);
1094 if (ret)
1095 dev_warn(dev, "%s: Error finding interconnect paths: %d\n",
1096 __func__, ret);
1097
Viresh Kumar052c6f12017-01-23 10:11:49 +05301098 BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301099 INIT_LIST_HEAD(&opp_table->opp_list);
Viresh Kumarf067a982017-01-23 10:11:42 +05301100 kref_init(&opp_table->kref);
Viresh Kumar07cce742014-12-10 09:45:34 +05301101
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301102 /* Secure the device table modification */
Viresh Kumar052c6f12017-01-23 10:11:49 +05301103 list_add(&opp_table->node, &opp_tables);
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301104 return opp_table;
Viresh Kumar07cce742014-12-10 09:45:34 +05301105}
1106
Viresh Kumarf067a982017-01-23 10:11:42 +05301107void _get_opp_table_kref(struct opp_table *opp_table)
Viresh Kumar3bac42c2015-07-29 16:22:59 +05301108{
Viresh Kumarf067a982017-01-23 10:11:42 +05301109 kref_get(&opp_table->kref);
1110}
1111
Viresh Kumareb7c87432018-09-05 16:17:14 +05301112static struct opp_table *_opp_get_opp_table(struct device *dev, int index)
Viresh Kumarf067a982017-01-23 10:11:42 +05301113{
1114 struct opp_table *opp_table;
1115
1116 /* Hold our table modification lock here */
1117 mutex_lock(&opp_table_lock);
1118
Viresh Kumar5b650b32017-01-23 10:11:48 +05301119 opp_table = _find_opp_table_unlocked(dev);
1120 if (!IS_ERR(opp_table))
Viresh Kumarf067a982017-01-23 10:11:42 +05301121 goto unlock;
Viresh Kumarf067a982017-01-23 10:11:42 +05301122
Viresh Kumar283d55e2018-09-07 09:01:54 +05301123 opp_table = _managed_opp(dev, index);
1124 if (opp_table) {
1125 if (!_add_opp_dev_unlocked(dev, opp_table)) {
1126 dev_pm_opp_put_opp_table(opp_table);
1127 opp_table = NULL;
1128 }
1129 goto unlock;
1130 }
1131
Viresh Kumareb7c87432018-09-05 16:17:14 +05301132 opp_table = _allocate_opp_table(dev, index);
Viresh Kumarf067a982017-01-23 10:11:42 +05301133
1134unlock:
1135 mutex_unlock(&opp_table_lock);
1136
1137 return opp_table;
1138}
Viresh Kumareb7c87432018-09-05 16:17:14 +05301139
1140struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
1141{
1142 return _opp_get_opp_table(dev, 0);
1143}
Viresh Kumarf067a982017-01-23 10:11:42 +05301144EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);
1145
Viresh Kumareb7c87432018-09-05 16:17:14 +05301146struct opp_table *dev_pm_opp_get_opp_table_indexed(struct device *dev,
1147 int index)
1148{
1149 return _opp_get_opp_table(dev, index);
1150}
1151
Viresh Kumarb83c1892017-01-23 10:11:45 +05301152static void _opp_table_kref_release(struct kref *kref)
Viresh Kumarf067a982017-01-23 10:11:42 +05301153{
1154 struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
Viresh Kumarcdd6ed92018-09-12 12:35:19 +05301155 struct opp_device *opp_dev, *temp;
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001156 int i;
Viresh Kumar06441652015-07-29 16:23:04 +05301157
Viresh Kumar5d6d1062018-06-07 14:50:43 +05301158 _of_clear_opp_table(opp_table);
1159
Viresh Kumard54974c2016-02-09 10:30:38 +05301160 /* Release clk */
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301161 if (!IS_ERR(opp_table->clk))
1162 clk_put(opp_table->clk);
Viresh Kumard54974c2016-02-09 10:30:38 +05301163
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001164 if (opp_table->paths) {
1165 for (i = 0; i < opp_table->path_count; i++)
1166 icc_put(opp_table->paths[i]);
1167 kfree(opp_table->paths);
1168 }
1169
Viresh Kumarcdd6ed92018-09-12 12:35:19 +05301170 WARN_ON(!list_empty(&opp_table->opp_list));
Viresh Kumar06441652015-07-29 16:23:04 +05301171
Viresh Kumarcdd6ed92018-09-12 12:35:19 +05301172 list_for_each_entry_safe(opp_dev, temp, &opp_table->dev_list, node) {
1173 /*
1174 * The OPP table is getting removed, drop the performance state
1175 * constraints.
1176 */
1177 if (opp_table->genpd_performance_state)
1178 dev_pm_genpd_set_performance_state((struct device *)(opp_dev->dev), 0);
Viresh Kumar06441652015-07-29 16:23:04 +05301179
Viresh Kumarcdd6ed92018-09-12 12:35:19 +05301180 _remove_opp_dev(opp_dev, opp_table);
1181 }
Viresh Kumar06441652015-07-29 16:23:04 +05301182
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301183 mutex_destroy(&opp_table->genpd_virt_dev_lock);
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301184 mutex_destroy(&opp_table->lock);
Viresh Kumar052c6f12017-01-23 10:11:49 +05301185 list_del(&opp_table->node);
1186 kfree(opp_table);
Viresh Kumar3bac42c2015-07-29 16:22:59 +05301187
Viresh Kumarf067a982017-01-23 10:11:42 +05301188 mutex_unlock(&opp_table_lock);
1189}
1190
1191void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
1192{
1193 kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
1194 &opp_table_lock);
1195}
1196EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);
1197
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301198void _opp_free(struct dev_pm_opp *opp)
Viresh Kumar969fceb2017-01-02 14:40:59 +05301199{
1200 kfree(opp);
Viresh Kumar969fceb2017-01-02 14:40:59 +05301201}
1202
Viresh Kumar1690d8b2019-01-04 15:14:33 +05301203static void _opp_kref_release(struct dev_pm_opp *opp,
1204 struct opp_table *opp_table)
Viresh Kumar129eec52014-11-27 08:54:06 +05301205{
1206 /*
1207 * Notify the changes in the availability of the operable
1208 * frequency/voltage list.
1209 */
Viresh Kumar052c6f12017-01-23 10:11:49 +05301210 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
Viresh Kumarda544b62018-06-07 14:50:43 +05301211 _of_opp_free_required_opps(opp_table, opp);
Viresh Kumardeaa5142015-11-11 07:59:01 +05301212 opp_debug_remove_one(opp);
Viresh Kumar052c6f12017-01-23 10:11:49 +05301213 list_del(&opp->node);
1214 kfree(opp);
Viresh Kumar1690d8b2019-01-04 15:14:33 +05301215}
Viresh Kumar129eec52014-11-27 08:54:06 +05301216
Viresh Kumar1690d8b2019-01-04 15:14:33 +05301217static void _opp_kref_release_unlocked(struct kref *kref)
1218{
1219 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1220 struct opp_table *opp_table = opp->opp_table;
1221
1222 _opp_kref_release(opp, opp_table);
1223}
1224
1225static void _opp_kref_release_locked(struct kref *kref)
1226{
1227 struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
1228 struct opp_table *opp_table = opp->opp_table;
1229
1230 _opp_kref_release(opp, opp_table);
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301231 mutex_unlock(&opp_table->lock);
Viresh Kumar129eec52014-11-27 08:54:06 +05301232}
1233
Viresh Kumara88bd2a2017-11-29 15:18:36 +05301234void dev_pm_opp_get(struct dev_pm_opp *opp)
Viresh Kumar8a31d9d92017-01-23 10:11:47 +05301235{
1236 kref_get(&opp->kref);
1237}
1238
Viresh Kumar70347642017-01-23 10:11:46 +05301239void dev_pm_opp_put(struct dev_pm_opp *opp)
1240{
Viresh Kumar1690d8b2019-01-04 15:14:33 +05301241 kref_put_mutex(&opp->kref, _opp_kref_release_locked,
1242 &opp->opp_table->lock);
Viresh Kumar70347642017-01-23 10:11:46 +05301243}
1244EXPORT_SYMBOL_GPL(dev_pm_opp_put);
1245
Viresh Kumar1690d8b2019-01-04 15:14:33 +05301246static void dev_pm_opp_put_unlocked(struct dev_pm_opp *opp)
1247{
1248 kref_put(&opp->kref, _opp_kref_release_unlocked);
1249}
1250
Viresh Kumar129eec52014-11-27 08:54:06 +05301251/**
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301252 * dev_pm_opp_remove() - Remove an OPP from OPP table
Viresh Kumar129eec52014-11-27 08:54:06 +05301253 * @dev: device for which we do this operation
1254 * @freq: OPP to remove with matching 'freq'
1255 *
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301256 * This function removes an opp from the opp table.
Viresh Kumar129eec52014-11-27 08:54:06 +05301257 */
1258void dev_pm_opp_remove(struct device *dev, unsigned long freq)
1259{
1260 struct dev_pm_opp *opp;
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301261 struct opp_table *opp_table;
Viresh Kumar129eec52014-11-27 08:54:06 +05301262 bool found = false;
1263
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301264 opp_table = _find_opp_table(dev);
1265 if (IS_ERR(opp_table))
Viresh Kumar5b650b32017-01-23 10:11:48 +05301266 return;
Viresh Kumar129eec52014-11-27 08:54:06 +05301267
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301268 mutex_lock(&opp_table->lock);
1269
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301270 list_for_each_entry(opp, &opp_table->opp_list, node) {
Viresh Kumar129eec52014-11-27 08:54:06 +05301271 if (opp->rate == freq) {
1272 found = true;
1273 break;
1274 }
1275 }
1276
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301277 mutex_unlock(&opp_table->lock);
1278
Viresh Kumar5b650b32017-01-23 10:11:48 +05301279 if (found) {
1280 dev_pm_opp_put(opp);
Viresh Kumar0ad8c622018-08-02 14:23:09 +05301281
1282 /* Drop the reference taken by dev_pm_opp_add() */
1283 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar5b650b32017-01-23 10:11:48 +05301284 } else {
Viresh Kumar129eec52014-11-27 08:54:06 +05301285 dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
1286 __func__, freq);
Viresh Kumar129eec52014-11-27 08:54:06 +05301287 }
1288
Viresh Kumar0ad8c622018-08-02 14:23:09 +05301289 /* Drop the reference taken by _find_opp_table() */
Viresh Kumar5b650b32017-01-23 10:11:48 +05301290 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar129eec52014-11-27 08:54:06 +05301291}
1292EXPORT_SYMBOL_GPL(dev_pm_opp_remove);
1293
Viresh Kumar03758d62019-11-11 16:35:03 +05301294void _opp_remove_all_static(struct opp_table *opp_table)
1295{
1296 struct dev_pm_opp *opp, *tmp;
1297
1298 mutex_lock(&opp_table->lock);
1299
1300 if (!opp_table->parsed_static_opps || --opp_table->parsed_static_opps)
1301 goto unlock;
1302
1303 list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
1304 if (!opp->dynamic)
1305 dev_pm_opp_put_unlocked(opp);
1306 }
1307
1308unlock:
1309 mutex_unlock(&opp_table->lock);
1310}
1311
Viresh Kumar1690d8b2019-01-04 15:14:33 +05301312/**
1313 * dev_pm_opp_remove_all_dynamic() - Remove all dynamically created OPPs
1314 * @dev: device for which we do this operation
1315 *
1316 * This function removes all dynamically created OPPs from the opp table.
1317 */
1318void dev_pm_opp_remove_all_dynamic(struct device *dev)
1319{
1320 struct opp_table *opp_table;
1321 struct dev_pm_opp *opp, *temp;
1322 int count = 0;
1323
1324 opp_table = _find_opp_table(dev);
1325 if (IS_ERR(opp_table))
1326 return;
1327
1328 mutex_lock(&opp_table->lock);
1329 list_for_each_entry_safe(opp, temp, &opp_table->opp_list, node) {
1330 if (opp->dynamic) {
1331 dev_pm_opp_put_unlocked(opp);
1332 count++;
1333 }
1334 }
1335 mutex_unlock(&opp_table->lock);
1336
1337 /* Drop the references taken by dev_pm_opp_add() */
1338 while (count--)
1339 dev_pm_opp_put_opp_table(opp_table);
1340
1341 /* Drop the reference taken by _find_opp_table() */
1342 dev_pm_opp_put_opp_table(opp_table);
1343}
1344EXPORT_SYMBOL_GPL(dev_pm_opp_remove_all_dynamic);
1345
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301346struct dev_pm_opp *_opp_allocate(struct opp_table *table)
Viresh Kumar23dacf62015-07-29 16:23:01 +05301347{
1348 struct dev_pm_opp *opp;
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001349 int supply_count, supply_size, icc_size;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301350
Viresh Kumardfbe4672016-12-01 16:28:19 +05301351 /* Allocate space for at least one supply */
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001352 supply_count = table->regulator_count > 0 ? table->regulator_count : 1;
1353 supply_size = sizeof(*opp->supplies) * supply_count;
1354 icc_size = sizeof(*opp->bandwidth) * table->path_count;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301355
Viresh Kumardfbe4672016-12-01 16:28:19 +05301356 /* allocate new OPP node and supplies structures */
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001357 opp = kzalloc(sizeof(*opp) + supply_size + icc_size, GFP_KERNEL);
1358
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301359 if (!opp)
Viresh Kumar23dacf62015-07-29 16:23:01 +05301360 return NULL;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301361
Viresh Kumardfbe4672016-12-01 16:28:19 +05301362 /* Put the supplies at the end of the OPP structure as an empty array */
1363 opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001364 if (icc_size)
1365 opp->bandwidth = (struct dev_pm_opp_icc_bw *)(opp->supplies + supply_count);
Viresh Kumardfbe4672016-12-01 16:28:19 +05301366 INIT_LIST_HEAD(&opp->node);
1367
Viresh Kumar23dacf62015-07-29 16:23:01 +05301368 return opp;
1369}
1370
Viresh Kumar7d34d562016-02-09 10:30:34 +05301371static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301372 struct opp_table *opp_table)
Viresh Kumar7d34d562016-02-09 10:30:34 +05301373{
Viresh Kumardfbe4672016-12-01 16:28:19 +05301374 struct regulator *reg;
1375 int i;
Viresh Kumar7d34d562016-02-09 10:30:34 +05301376
Viresh Kumar90e35772018-12-11 16:32:47 +05301377 if (!opp_table->regulators)
1378 return true;
1379
Viresh Kumardfbe4672016-12-01 16:28:19 +05301380 for (i = 0; i < opp_table->regulator_count; i++) {
1381 reg = opp_table->regulators[i];
1382
1383 if (!regulator_is_supported_voltage(reg,
1384 opp->supplies[i].u_volt_min,
1385 opp->supplies[i].u_volt_max)) {
1386 pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
1387 __func__, opp->supplies[i].u_volt_min,
1388 opp->supplies[i].u_volt_max);
1389 return false;
1390 }
Viresh Kumar7d34d562016-02-09 10:30:34 +05301391 }
1392
1393 return true;
1394}
1395
Saravana Kannan6c591ee2020-05-12 15:53:19 +03001396int _opp_compare_key(struct dev_pm_opp *opp1, struct dev_pm_opp *opp2)
1397{
1398 if (opp1->rate != opp2->rate)
1399 return opp1->rate < opp2->rate ? -1 : 1;
Georgi Djakov6d3f9222020-05-12 15:53:21 +03001400 if (opp1->bandwidth && opp2->bandwidth &&
1401 opp1->bandwidth[0].peak != opp2->bandwidth[0].peak)
1402 return opp1->bandwidth[0].peak < opp2->bandwidth[0].peak ? -1 : 1;
Saravana Kannan6c591ee2020-05-12 15:53:19 +03001403 if (opp1->level != opp2->level)
1404 return opp1->level < opp2->level ? -1 : 1;
1405 return 0;
1406}
1407
Viresh Kumara1e8c132018-04-06 14:35:45 +05301408static int _opp_is_duplicate(struct device *dev, struct dev_pm_opp *new_opp,
1409 struct opp_table *opp_table,
1410 struct list_head **head)
1411{
1412 struct dev_pm_opp *opp;
Saravana Kannan6c591ee2020-05-12 15:53:19 +03001413 int opp_cmp;
Viresh Kumara1e8c132018-04-06 14:35:45 +05301414
1415 /*
1416 * Insert new OPP in order of increasing frequency and discard if
1417 * already present.
1418 *
1419 * Need to use &opp_table->opp_list in the condition part of the 'for'
1420 * loop, don't replace it with head otherwise it will become an infinite
1421 * loop.
1422 */
1423 list_for_each_entry(opp, &opp_table->opp_list, node) {
Saravana Kannan6c591ee2020-05-12 15:53:19 +03001424 opp_cmp = _opp_compare_key(new_opp, opp);
1425 if (opp_cmp > 0) {
Viresh Kumara1e8c132018-04-06 14:35:45 +05301426 *head = &opp->node;
1427 continue;
1428 }
1429
Saravana Kannan6c591ee2020-05-12 15:53:19 +03001430 if (opp_cmp < 0)
Viresh Kumara1e8c132018-04-06 14:35:45 +05301431 return 0;
1432
1433 /* Duplicate OPPs */
1434 dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
1435 __func__, opp->rate, opp->supplies[0].u_volt,
1436 opp->available, new_opp->rate,
1437 new_opp->supplies[0].u_volt, new_opp->available);
1438
1439 /* Should we compare voltages for all regulators here ? */
1440 return opp->available &&
1441 new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;
1442 }
1443
1444 return 0;
1445}
1446
Viresh Kumar7f8538e2017-01-02 14:40:55 +05301447/*
1448 * Returns:
1449 * 0: On success. And appropriate error message for duplicate OPPs.
1450 * -EBUSY: For OPP with same freq/volt and is available. The callers of
1451 * _opp_add() must return 0 if they receive -EBUSY from it. This is to make
1452 * sure we don't print error messages unnecessarily if different parts of
1453 * kernel try to initialize the OPP table.
1454 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
1455 * should be considered an error by the callers of _opp_add().
1456 */
Viresh Kumarf47b72a2016-05-05 16:20:33 +05301457int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
Viresh Kumara1e8c132018-04-06 14:35:45 +05301458 struct opp_table *opp_table, bool rate_not_available)
Viresh Kumar23dacf62015-07-29 16:23:01 +05301459{
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301460 struct list_head *head;
Viresh Kumardeaa5142015-11-11 07:59:01 +05301461 int ret;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301462
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301463 mutex_lock(&opp_table->lock);
1464 head = &opp_table->opp_list;
1465
Viresh Kumara1e8c132018-04-06 14:35:45 +05301466 if (likely(!rate_not_available)) {
1467 ret = _opp_is_duplicate(dev, new_opp, opp_table, &head);
1468 if (ret) {
1469 mutex_unlock(&opp_table->lock);
1470 return ret;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301471 }
Viresh Kumar23dacf62015-07-29 16:23:01 +05301472 }
1473
Viresh Kumar052c6f12017-01-23 10:11:49 +05301474 list_add(&new_opp->node, head);
Viresh Kumar37a73ec2017-01-23 10:11:41 +05301475 mutex_unlock(&opp_table->lock);
1476
1477 new_opp->opp_table = opp_table;
Viresh Kumar70347642017-01-23 10:11:46 +05301478 kref_init(&new_opp->kref);
Viresh Kumar23dacf62015-07-29 16:23:01 +05301479
Greg Kroah-Hartmana2dea4c2019-01-22 16:21:17 +01001480 opp_debug_create_one(new_opp, opp_table);
Viresh Kumardeaa5142015-11-11 07:59:01 +05301481
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301482 if (!_opp_supported_by_regulators(new_opp, opp_table)) {
Viresh Kumar7d34d562016-02-09 10:30:34 +05301483 new_opp->available = false;
1484 dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
1485 __func__, new_opp->rate);
1486 }
1487
Viresh Kumar23dacf62015-07-29 16:23:01 +05301488 return 0;
1489}
1490
Viresh Kumar737002b2015-07-29 16:22:58 +05301491/**
Viresh Kumarb64b9c3f2015-10-15 21:42:44 +05301492 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301493 * @opp_table: OPP table
Nishanth Menone1f60b22010-10-13 00:13:10 +02001494 * @dev: device for which we do this operation
1495 * @freq: Frequency in Hz for this OPP
1496 * @u_volt: Voltage in uVolts for this OPP
1497 * @dynamic: Dynamically added OPPs.
1498 *
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301499 * This function adds an opp definition to the opp table and returns status.
Nishanth Menone1f60b22010-10-13 00:13:10 +02001500 * The opp is made available by default and it can be controlled using
1501 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
1502 *
Viresh Kumar8f8d37b2015-09-04 13:47:24 +05301503 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
1504 * and freed by dev_pm_opp_of_remove_table.
Nishanth Menone1f60b22010-10-13 00:13:10 +02001505 *
Nishanth Menone1f60b22010-10-13 00:13:10 +02001506 * Return:
1507 * 0 On success OR
1508 * Duplicate OPPs (both freq and volt are same) and opp->available
1509 * -EEXIST Freq are same and volt are different OR
1510 * Duplicate OPPs (both freq and volt are same) and !opp->available
1511 * -ENOMEM Memory allocation failure
1512 */
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301513int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
1514 unsigned long freq, long u_volt, bool dynamic)
Nishanth Menone1f60b22010-10-13 00:13:10 +02001515{
Viresh Kumar23dacf62015-07-29 16:23:01 +05301516 struct dev_pm_opp *new_opp;
Viresh Kumar50f8cfb2016-02-09 10:30:37 +05301517 unsigned long tol;
Nishanth Menone1f60b22010-10-13 00:13:10 +02001518 int ret;
1519
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301520 new_opp = _opp_allocate(opp_table);
1521 if (!new_opp)
1522 return -ENOMEM;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301523
Nishanth Menone1f60b22010-10-13 00:13:10 +02001524 /* populate the opp table */
1525 new_opp->rate = freq;
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301526 tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
Viresh Kumardfbe4672016-12-01 16:28:19 +05301527 new_opp->supplies[0].u_volt = u_volt;
1528 new_opp->supplies[0].u_volt_min = u_volt - tol;
1529 new_opp->supplies[0].u_volt_max = u_volt + tol;
Nishanth Menone1f60b22010-10-13 00:13:10 +02001530 new_opp->available = true;
Viresh Kumaraa5f2f82015-07-29 16:23:00 +05301531 new_opp->dynamic = dynamic;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301532
Viresh Kumara1e8c132018-04-06 14:35:45 +05301533 ret = _opp_add(dev, new_opp, opp_table, false);
Viresh Kumar7f8538e2017-01-02 14:40:55 +05301534 if (ret) {
1535 /* Don't return error for duplicate OPPs */
1536 if (ret == -EBUSY)
1537 ret = 0;
Viresh Kumar23dacf62015-07-29 16:23:01 +05301538 goto free_opp;
Viresh Kumar7f8538e2017-01-02 14:40:55 +05301539 }
Viresh Kumar23dacf62015-07-29 16:23:01 +05301540
Nishanth Menone1f60b22010-10-13 00:13:10 +02001541 /*
1542 * Notify the changes in the availability of the operable
1543 * frequency/voltage list.
1544 */
Viresh Kumar052c6f12017-01-23 10:11:49 +05301545 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
Nishanth Menone1f60b22010-10-13 00:13:10 +02001546 return 0;
1547
1548free_opp:
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05301549 _opp_free(new_opp);
1550
Nishanth Menone1f60b22010-10-13 00:13:10 +02001551 return ret;
1552}
Viresh Kumar383934092014-11-25 16:04:18 +05301553
Viresh Kumar27465902015-07-29 16:23:02 +05301554/**
Viresh Kumar7de36b02015-12-09 08:01:46 +05301555 * dev_pm_opp_set_supported_hw() - Set supported platforms
1556 * @dev: Device for which supported-hw has to be set.
1557 * @versions: Array of hierarchy of versions to match.
1558 * @count: Number of elements in the array.
1559 *
1560 * This is required only for the V2 bindings, and it enables a platform to
1561 * specify the hierarchy of versions it supports. OPP layer will then enable
1562 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
1563 * property.
Viresh Kumar7de36b02015-12-09 08:01:46 +05301564 */
Viresh Kumarfa301842017-01-23 10:11:43 +05301565struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
1566 const u32 *versions, unsigned int count)
Viresh Kumar7de36b02015-12-09 08:01:46 +05301567{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301568 struct opp_table *opp_table;
Viresh Kumar7de36b02015-12-09 08:01:46 +05301569
Viresh Kumarfa301842017-01-23 10:11:43 +05301570 opp_table = dev_pm_opp_get_opp_table(dev);
1571 if (!opp_table)
1572 return ERR_PTR(-ENOMEM);
Viresh Kumar7de36b02015-12-09 08:01:46 +05301573
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301574 /* Make sure there are no concurrent readers while updating opp_table */
1575 WARN_ON(!list_empty(&opp_table->opp_list));
Viresh Kumar7de36b02015-12-09 08:01:46 +05301576
Viresh Kumar25419de2018-05-22 16:38:08 +05301577 /* Another CPU that shares the OPP table has set the property ? */
1578 if (opp_table->supported_hw)
1579 return opp_table;
Viresh Kumar7de36b02015-12-09 08:01:46 +05301580
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301581 opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
Viresh Kumar7de36b02015-12-09 08:01:46 +05301582 GFP_KERNEL);
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301583 if (!opp_table->supported_hw) {
Viresh Kumar25419de2018-05-22 16:38:08 +05301584 dev_pm_opp_put_opp_table(opp_table);
1585 return ERR_PTR(-ENOMEM);
Viresh Kumar7de36b02015-12-09 08:01:46 +05301586 }
1587
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301588 opp_table->supported_hw_count = count;
Viresh Kumarfa301842017-01-23 10:11:43 +05301589
1590 return opp_table;
Viresh Kumar7de36b02015-12-09 08:01:46 +05301591}
1592EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);
1593
1594/**
1595 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
Viresh Kumarfa301842017-01-23 10:11:43 +05301596 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
Viresh Kumar7de36b02015-12-09 08:01:46 +05301597 *
1598 * This is required only for the V2 bindings, and is called for a matching
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301599 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
Viresh Kumar7de36b02015-12-09 08:01:46 +05301600 * will not be freed.
Viresh Kumar7de36b02015-12-09 08:01:46 +05301601 */
Viresh Kumarfa301842017-01-23 10:11:43 +05301602void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
Viresh Kumar7de36b02015-12-09 08:01:46 +05301603{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301604 /* Make sure there are no concurrent readers while updating opp_table */
1605 WARN_ON(!list_empty(&opp_table->opp_list));
Viresh Kumar7de36b02015-12-09 08:01:46 +05301606
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301607 kfree(opp_table->supported_hw);
1608 opp_table->supported_hw = NULL;
1609 opp_table->supported_hw_count = 0;
Viresh Kumar7de36b02015-12-09 08:01:46 +05301610
Viresh Kumarfa301842017-01-23 10:11:43 +05301611 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar7de36b02015-12-09 08:01:46 +05301612}
1613EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);
1614
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301615/**
1616 * dev_pm_opp_set_prop_name() - Set prop-extn name
Viresh Kumara5da6442016-02-16 14:17:52 +05301617 * @dev: Device for which the prop-name has to be set.
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301618 * @name: name to postfix to properties.
1619 *
1620 * This is required only for the V2 bindings, and it enables a platform to
1621 * specify the extn to be used for certain property names. The properties to
1622 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
1623 * should postfix the property name with -<name> while looking for them.
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301624 */
Viresh Kumarfa301842017-01-23 10:11:43 +05301625struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301626{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301627 struct opp_table *opp_table;
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301628
Viresh Kumarfa301842017-01-23 10:11:43 +05301629 opp_table = dev_pm_opp_get_opp_table(dev);
1630 if (!opp_table)
1631 return ERR_PTR(-ENOMEM);
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301632
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301633 /* Make sure there are no concurrent readers while updating opp_table */
1634 WARN_ON(!list_empty(&opp_table->opp_list));
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301635
Viresh Kumar878ec1a2018-05-22 16:38:08 +05301636 /* Another CPU that shares the OPP table has set the property ? */
1637 if (opp_table->prop_name)
1638 return opp_table;
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301639
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301640 opp_table->prop_name = kstrdup(name, GFP_KERNEL);
1641 if (!opp_table->prop_name) {
Viresh Kumar878ec1a2018-05-22 16:38:08 +05301642 dev_pm_opp_put_opp_table(opp_table);
1643 return ERR_PTR(-ENOMEM);
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301644 }
1645
Viresh Kumarfa301842017-01-23 10:11:43 +05301646 return opp_table;
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301647}
1648EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);
1649
1650/**
1651 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
Viresh Kumarfa301842017-01-23 10:11:43 +05301652 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301653 *
1654 * This is required only for the V2 bindings, and is called for a matching
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301655 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301656 * will not be freed.
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301657 */
Viresh Kumarfa301842017-01-23 10:11:43 +05301658void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301659{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301660 /* Make sure there are no concurrent readers while updating opp_table */
1661 WARN_ON(!list_empty(&opp_table->opp_list));
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301662
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301663 kfree(opp_table->prop_name);
1664 opp_table->prop_name = NULL;
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301665
Viresh Kumarfa301842017-01-23 10:11:43 +05301666 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar01fb4d32015-12-09 08:01:47 +05301667}
1668EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);
1669
Viresh Kumar94735582016-12-01 16:28:20 +05301670static int _allocate_set_opp_data(struct opp_table *opp_table)
1671{
1672 struct dev_pm_set_opp_data *data;
1673 int len, count = opp_table->regulator_count;
1674
Viresh Kumar90e35772018-12-11 16:32:47 +05301675 if (WARN_ON(!opp_table->regulators))
Viresh Kumar94735582016-12-01 16:28:20 +05301676 return -EINVAL;
1677
1678 /* space for set_opp_data */
1679 len = sizeof(*data);
1680
1681 /* space for old_opp.supplies and new_opp.supplies */
1682 len += 2 * sizeof(struct dev_pm_opp_supply) * count;
1683
1684 data = kzalloc(len, GFP_KERNEL);
1685 if (!data)
1686 return -ENOMEM;
1687
1688 data->old_opp.supplies = (void *)(data + 1);
1689 data->new_opp.supplies = data->old_opp.supplies + count;
1690
1691 opp_table->set_opp_data = data;
1692
1693 return 0;
1694}
1695
1696static void _free_set_opp_data(struct opp_table *opp_table)
1697{
1698 kfree(opp_table->set_opp_data);
1699 opp_table->set_opp_data = NULL;
1700}
1701
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301702/**
Viresh Kumardfbe4672016-12-01 16:28:19 +05301703 * dev_pm_opp_set_regulators() - Set regulator names for the device
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301704 * @dev: Device for which regulator name is being set.
Viresh Kumardfbe4672016-12-01 16:28:19 +05301705 * @names: Array of pointers to the names of the regulator.
1706 * @count: Number of regulators.
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301707 *
1708 * In order to support OPP switching, OPP layer needs to know the name of the
Viresh Kumardfbe4672016-12-01 16:28:19 +05301709 * device's regulators, as the core would be required to switch voltages as
1710 * well.
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301711 *
1712 * This must be called before any OPPs are initialized for the device.
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301713 */
Viresh Kumardfbe4672016-12-01 16:28:19 +05301714struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
1715 const char * const names[],
1716 unsigned int count)
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301717{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301718 struct opp_table *opp_table;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301719 struct regulator *reg;
Viresh Kumardfbe4672016-12-01 16:28:19 +05301720 int ret, i;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301721
Viresh Kumarfa301842017-01-23 10:11:43 +05301722 opp_table = dev_pm_opp_get_opp_table(dev);
1723 if (!opp_table)
1724 return ERR_PTR(-ENOMEM);
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301725
1726 /* This should be called before OPPs are initialized */
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301727 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301728 ret = -EBUSY;
1729 goto err;
1730 }
1731
Viresh Kumar779b7832018-05-22 16:38:08 +05301732 /* Another CPU that shares the OPP table has set the regulators ? */
1733 if (opp_table->regulators)
1734 return opp_table;
Viresh Kumardfbe4672016-12-01 16:28:19 +05301735
1736 opp_table->regulators = kmalloc_array(count,
1737 sizeof(*opp_table->regulators),
1738 GFP_KERNEL);
1739 if (!opp_table->regulators) {
1740 ret = -ENOMEM;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301741 goto err;
1742 }
1743
Viresh Kumardfbe4672016-12-01 16:28:19 +05301744 for (i = 0; i < count; i++) {
1745 reg = regulator_get_optional(dev, names[i]);
1746 if (IS_ERR(reg)) {
1747 ret = PTR_ERR(reg);
1748 if (ret != -EPROBE_DEFER)
1749 dev_err(dev, "%s: no regulator (%s) found: %d\n",
1750 __func__, names[i], ret);
1751 goto free_regulators;
1752 }
1753
1754 opp_table->regulators[i] = reg;
1755 }
1756
1757 opp_table->regulator_count = count;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301758
Viresh Kumar94735582016-12-01 16:28:20 +05301759 /* Allocate block only once to pass to set_opp() routines */
1760 ret = _allocate_set_opp_data(opp_table);
1761 if (ret)
1762 goto free_regulators;
1763
Stephen Boyd91291d92016-11-30 16:21:25 +05301764 return opp_table;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301765
Viresh Kumardfbe4672016-12-01 16:28:19 +05301766free_regulators:
Marek Szyprowski24957db2019-10-17 12:27:58 +02001767 while (i != 0)
1768 regulator_put(opp_table->regulators[--i]);
Viresh Kumardfbe4672016-12-01 16:28:19 +05301769
1770 kfree(opp_table->regulators);
1771 opp_table->regulators = NULL;
Viresh Kumar46f48ac2018-12-11 16:39:36 +05301772 opp_table->regulator_count = -1;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301773err:
Viresh Kumarfa301842017-01-23 10:11:43 +05301774 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301775
Stephen Boyd91291d92016-11-30 16:21:25 +05301776 return ERR_PTR(ret);
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301777}
Viresh Kumardfbe4672016-12-01 16:28:19 +05301778EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301779
1780/**
Viresh Kumardfbe4672016-12-01 16:28:19 +05301781 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
1782 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301783 */
Viresh Kumardfbe4672016-12-01 16:28:19 +05301784void dev_pm_opp_put_regulators(struct opp_table *opp_table)
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301785{
Viresh Kumardfbe4672016-12-01 16:28:19 +05301786 int i;
1787
Viresh Kumar779b7832018-05-22 16:38:08 +05301788 if (!opp_table->regulators)
1789 goto put_opp_table;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301790
Viresh Kumar2c2709d2016-02-16 14:17:53 +05301791 /* Make sure there are no concurrent readers while updating opp_table */
1792 WARN_ON(!list_empty(&opp_table->opp_list));
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301793
Kamil Konieczny8d457192019-07-19 17:05:32 +02001794 if (opp_table->regulator_enabled) {
1795 for (i = opp_table->regulator_count - 1; i >= 0; i--)
1796 regulator_disable(opp_table->regulators[i]);
1797
1798 opp_table->regulator_enabled = false;
1799 }
1800
Marek Szyprowski24957db2019-10-17 12:27:58 +02001801 for (i = opp_table->regulator_count - 1; i >= 0; i--)
Viresh Kumardfbe4672016-12-01 16:28:19 +05301802 regulator_put(opp_table->regulators[i]);
1803
Viresh Kumar94735582016-12-01 16:28:20 +05301804 _free_set_opp_data(opp_table);
1805
Viresh Kumardfbe4672016-12-01 16:28:19 +05301806 kfree(opp_table->regulators);
1807 opp_table->regulators = NULL;
Viresh Kumar46f48ac2018-12-11 16:39:36 +05301808 opp_table->regulator_count = -1;
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301809
Viresh Kumar779b7832018-05-22 16:38:08 +05301810put_opp_table:
Viresh Kumarfa301842017-01-23 10:11:43 +05301811 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301812}
Viresh Kumardfbe4672016-12-01 16:28:19 +05301813EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
Viresh Kumar9f8ea962016-02-09 10:30:33 +05301814
Viresh Kumar383934092014-11-25 16:04:18 +05301815/**
Viresh Kumar829a4e82017-06-21 10:29:13 +05301816 * dev_pm_opp_set_clkname() - Set clk name for the device
1817 * @dev: Device for which clk name is being set.
1818 * @name: Clk name.
1819 *
1820 * In order to support OPP switching, OPP layer needs to get pointer to the
1821 * clock for the device. Simple cases work fine without using this routine (i.e.
1822 * by passing connection-id as NULL), but for a device with multiple clocks
1823 * available, the OPP core needs to know the exact name of the clk to use.
1824 *
1825 * This must be called before any OPPs are initialized for the device.
1826 */
1827struct opp_table *dev_pm_opp_set_clkname(struct device *dev, const char *name)
1828{
1829 struct opp_table *opp_table;
1830 int ret;
1831
1832 opp_table = dev_pm_opp_get_opp_table(dev);
1833 if (!opp_table)
1834 return ERR_PTR(-ENOMEM);
1835
1836 /* This should be called before OPPs are initialized */
1837 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1838 ret = -EBUSY;
1839 goto err;
1840 }
1841
1842 /* Already have default clk set, free it */
1843 if (!IS_ERR(opp_table->clk))
1844 clk_put(opp_table->clk);
1845
1846 /* Find clk for the device */
1847 opp_table->clk = clk_get(dev, name);
1848 if (IS_ERR(opp_table->clk)) {
1849 ret = PTR_ERR(opp_table->clk);
1850 if (ret != -EPROBE_DEFER) {
1851 dev_err(dev, "%s: Couldn't find clock: %d\n", __func__,
1852 ret);
1853 }
1854 goto err;
1855 }
1856
1857 return opp_table;
1858
1859err:
1860 dev_pm_opp_put_opp_table(opp_table);
1861
1862 return ERR_PTR(ret);
1863}
1864EXPORT_SYMBOL_GPL(dev_pm_opp_set_clkname);
1865
1866/**
1867 * dev_pm_opp_put_clkname() - Releases resources blocked for clk.
1868 * @opp_table: OPP table returned from dev_pm_opp_set_clkname().
1869 */
1870void dev_pm_opp_put_clkname(struct opp_table *opp_table)
1871{
1872 /* Make sure there are no concurrent readers while updating opp_table */
1873 WARN_ON(!list_empty(&opp_table->opp_list));
1874
1875 clk_put(opp_table->clk);
1876 opp_table->clk = ERR_PTR(-EINVAL);
1877
1878 dev_pm_opp_put_opp_table(opp_table);
1879}
1880EXPORT_SYMBOL_GPL(dev_pm_opp_put_clkname);
1881
1882/**
Viresh Kumar4dab1602016-12-01 16:28:21 +05301883 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
1884 * @dev: Device for which the helper is getting registered.
1885 * @set_opp: Custom set OPP helper.
1886 *
1887 * This is useful to support complex platforms (like platforms with multiple
1888 * regulators per device), instead of the generic OPP set rate helper.
1889 *
1890 * This must be called before any OPPs are initialized for the device.
Viresh Kumar4dab1602016-12-01 16:28:21 +05301891 */
Viresh Kumarfa301842017-01-23 10:11:43 +05301892struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
Viresh Kumar4dab1602016-12-01 16:28:21 +05301893 int (*set_opp)(struct dev_pm_set_opp_data *data))
1894{
1895 struct opp_table *opp_table;
Viresh Kumar4dab1602016-12-01 16:28:21 +05301896
1897 if (!set_opp)
Viresh Kumarfa301842017-01-23 10:11:43 +05301898 return ERR_PTR(-EINVAL);
Viresh Kumar4dab1602016-12-01 16:28:21 +05301899
Viresh Kumarfa301842017-01-23 10:11:43 +05301900 opp_table = dev_pm_opp_get_opp_table(dev);
1901 if (!opp_table)
1902 return ERR_PTR(-ENOMEM);
Viresh Kumar4dab1602016-12-01 16:28:21 +05301903
1904 /* This should be called before OPPs are initialized */
1905 if (WARN_ON(!list_empty(&opp_table->opp_list))) {
Viresh Kumar5019acc2018-05-22 16:38:08 +05301906 dev_pm_opp_put_opp_table(opp_table);
1907 return ERR_PTR(-EBUSY);
Viresh Kumar4dab1602016-12-01 16:28:21 +05301908 }
1909
Viresh Kumar5019acc2018-05-22 16:38:08 +05301910 /* Another CPU that shares the OPP table has set the helper ? */
1911 if (!opp_table->set_opp)
1912 opp_table->set_opp = set_opp;
Viresh Kumar4dab1602016-12-01 16:28:21 +05301913
Viresh Kumarfa301842017-01-23 10:11:43 +05301914 return opp_table;
Viresh Kumar4dab1602016-12-01 16:28:21 +05301915}
1916EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);
1917
1918/**
Viresh Kumar604a7ae2017-10-05 17:26:21 +05301919 * dev_pm_opp_unregister_set_opp_helper() - Releases resources blocked for
Viresh Kumar4dab1602016-12-01 16:28:21 +05301920 * set_opp helper
Viresh Kumarfa301842017-01-23 10:11:43 +05301921 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
Viresh Kumar4dab1602016-12-01 16:28:21 +05301922 *
Viresh Kumarfa301842017-01-23 10:11:43 +05301923 * Release resources blocked for platform specific set_opp helper.
Viresh Kumar4dab1602016-12-01 16:28:21 +05301924 */
Viresh Kumar604a7ae2017-10-05 17:26:21 +05301925void dev_pm_opp_unregister_set_opp_helper(struct opp_table *opp_table)
Viresh Kumar4dab1602016-12-01 16:28:21 +05301926{
Viresh Kumar4dab1602016-12-01 16:28:21 +05301927 /* Make sure there are no concurrent readers while updating opp_table */
1928 WARN_ON(!list_empty(&opp_table->opp_list));
1929
1930 opp_table->set_opp = NULL;
Viresh Kumarfa301842017-01-23 10:11:43 +05301931 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar4dab1602016-12-01 16:28:21 +05301932}
Viresh Kumar604a7ae2017-10-05 17:26:21 +05301933EXPORT_SYMBOL_GPL(dev_pm_opp_unregister_set_opp_helper);
Viresh Kumar4dab1602016-12-01 16:28:21 +05301934
Viresh Kumar6319aee2019-05-08 15:19:13 +05301935static void _opp_detach_genpd(struct opp_table *opp_table)
1936{
1937 int index;
1938
1939 for (index = 0; index < opp_table->required_opp_count; index++) {
1940 if (!opp_table->genpd_virt_devs[index])
1941 continue;
1942
1943 dev_pm_domain_detach(opp_table->genpd_virt_devs[index], false);
1944 opp_table->genpd_virt_devs[index] = NULL;
1945 }
Viresh Kumarc0ab9e02019-05-08 15:43:36 +05301946
1947 kfree(opp_table->genpd_virt_devs);
1948 opp_table->genpd_virt_devs = NULL;
Viresh Kumar6319aee2019-05-08 15:19:13 +05301949}
1950
Viresh Kumar4dab1602016-12-01 16:28:21 +05301951/**
Viresh Kumar6319aee2019-05-08 15:19:13 +05301952 * dev_pm_opp_attach_genpd - Attach genpd(s) for the device and save virtual device pointer
1953 * @dev: Consumer device for which the genpd is getting attached.
1954 * @names: Null terminated array of pointers containing names of genpd to attach.
Viresh Kumar17a8f862019-07-08 11:24:56 +05301955 * @virt_devs: Pointer to return the array of virtual devices.
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301956 *
1957 * Multiple generic power domains for a device are supported with the help of
1958 * virtual genpd devices, which are created for each consumer device - genpd
1959 * pair. These are the device structures which are attached to the power domain
1960 * and are required by the OPP core to set the performance state of the genpd.
Viresh Kumar6319aee2019-05-08 15:19:13 +05301961 * The same API also works for the case where single genpd is available and so
1962 * we don't need to support that separately.
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301963 *
1964 * This helper will normally be called by the consumer driver of the device
Viresh Kumar6319aee2019-05-08 15:19:13 +05301965 * "dev", as only that has details of the genpd names.
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301966 *
Viresh Kumar6319aee2019-05-08 15:19:13 +05301967 * This helper needs to be called once with a list of all genpd to attach.
1968 * Otherwise the original device structure will be used instead by the OPP core.
Viresh Kumarbaea35e2019-07-17 11:20:17 +05301969 *
1970 * The order of entries in the names array must match the order in which
1971 * "required-opps" are added in DT.
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301972 */
Viresh Kumar17a8f862019-07-08 11:24:56 +05301973struct opp_table *dev_pm_opp_attach_genpd(struct device *dev,
1974 const char **names, struct device ***virt_devs)
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301975{
1976 struct opp_table *opp_table;
Viresh Kumar6319aee2019-05-08 15:19:13 +05301977 struct device *virt_dev;
Viresh Kumarbaea35e2019-07-17 11:20:17 +05301978 int index = 0, ret = -EINVAL;
Viresh Kumar6319aee2019-05-08 15:19:13 +05301979 const char **name = names;
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301980
1981 opp_table = dev_pm_opp_get_opp_table(dev);
1982 if (!opp_table)
1983 return ERR_PTR(-ENOMEM);
1984
Viresh Kumar6319aee2019-05-08 15:19:13 +05301985 /*
1986 * If the genpd's OPP table isn't already initialized, parsing of the
1987 * required-opps fail for dev. We should retry this after genpd's OPP
1988 * table is added.
1989 */
1990 if (!opp_table->required_opp_count) {
1991 ret = -EPROBE_DEFER;
1992 goto put_table;
Viresh Kumar4f018bc2018-06-26 16:29:34 +05301993 }
1994
Viresh Kumar6319aee2019-05-08 15:19:13 +05301995 mutex_lock(&opp_table->genpd_virt_dev_lock);
1996
Viresh Kumarc0ab9e02019-05-08 15:43:36 +05301997 opp_table->genpd_virt_devs = kcalloc(opp_table->required_opp_count,
1998 sizeof(*opp_table->genpd_virt_devs),
1999 GFP_KERNEL);
2000 if (!opp_table->genpd_virt_devs)
2001 goto unlock;
2002
Viresh Kumar6319aee2019-05-08 15:19:13 +05302003 while (*name) {
Viresh Kumar6319aee2019-05-08 15:19:13 +05302004 if (index >= opp_table->required_opp_count) {
2005 dev_err(dev, "Index can't be greater than required-opp-count - 1, %s (%d : %d)\n",
2006 *name, opp_table->required_opp_count, index);
2007 goto err;
2008 }
2009
2010 if (opp_table->genpd_virt_devs[index]) {
2011 dev_err(dev, "Genpd virtual device already set %s\n",
2012 *name);
2013 goto err;
2014 }
2015
2016 virt_dev = dev_pm_domain_attach_by_name(dev, *name);
2017 if (IS_ERR(virt_dev)) {
2018 ret = PTR_ERR(virt_dev);
2019 dev_err(dev, "Couldn't attach to pm_domain: %d\n", ret);
2020 goto err;
2021 }
2022
2023 opp_table->genpd_virt_devs[index] = virt_dev;
Viresh Kumarbaea35e2019-07-17 11:20:17 +05302024 index++;
Viresh Kumar6319aee2019-05-08 15:19:13 +05302025 name++;
2026 }
2027
Viresh Kumar17a8f862019-07-08 11:24:56 +05302028 if (virt_devs)
2029 *virt_devs = opp_table->genpd_virt_devs;
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302030 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2031
2032 return opp_table;
Viresh Kumar6319aee2019-05-08 15:19:13 +05302033
2034err:
2035 _opp_detach_genpd(opp_table);
Viresh Kumarc0ab9e02019-05-08 15:43:36 +05302036unlock:
Viresh Kumar6319aee2019-05-08 15:19:13 +05302037 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2038
2039put_table:
2040 dev_pm_opp_put_opp_table(opp_table);
2041
2042 return ERR_PTR(ret);
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302043}
Viresh Kumar6319aee2019-05-08 15:19:13 +05302044EXPORT_SYMBOL_GPL(dev_pm_opp_attach_genpd);
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302045
2046/**
Viresh Kumar6319aee2019-05-08 15:19:13 +05302047 * dev_pm_opp_detach_genpd() - Detach genpd(s) from the device.
2048 * @opp_table: OPP table returned by dev_pm_opp_attach_genpd().
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302049 *
Viresh Kumar6319aee2019-05-08 15:19:13 +05302050 * This detaches the genpd(s), resets the virtual device pointers, and puts the
2051 * OPP table.
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302052 */
Viresh Kumar6319aee2019-05-08 15:19:13 +05302053void dev_pm_opp_detach_genpd(struct opp_table *opp_table)
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302054{
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302055 /*
2056 * Acquire genpd_virt_dev_lock to make sure virt_dev isn't getting
2057 * used in parallel.
2058 */
2059 mutex_lock(&opp_table->genpd_virt_dev_lock);
Viresh Kumar6319aee2019-05-08 15:19:13 +05302060 _opp_detach_genpd(opp_table);
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302061 mutex_unlock(&opp_table->genpd_virt_dev_lock);
2062
Viresh Kumar6319aee2019-05-08 15:19:13 +05302063 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302064}
Viresh Kumar6319aee2019-05-08 15:19:13 +05302065EXPORT_SYMBOL_GPL(dev_pm_opp_detach_genpd);
Viresh Kumar4f018bc2018-06-26 16:29:34 +05302066
2067/**
Viresh Kumarc8a59102018-11-02 14:36:42 +05302068 * dev_pm_opp_xlate_performance_state() - Find required OPP's pstate for src_table.
2069 * @src_table: OPP table which has dst_table as one of its required OPP table.
2070 * @dst_table: Required OPP table of the src_table.
2071 * @pstate: Current performance state of the src_table.
2072 *
2073 * This Returns pstate of the OPP (present in @dst_table) pointed out by the
2074 * "required-opps" property of the OPP (present in @src_table) which has
2075 * performance state set to @pstate.
2076 *
2077 * Return: Zero or positive performance state on success, otherwise negative
2078 * value on errors.
2079 */
2080int dev_pm_opp_xlate_performance_state(struct opp_table *src_table,
2081 struct opp_table *dst_table,
2082 unsigned int pstate)
2083{
2084 struct dev_pm_opp *opp;
2085 int dest_pstate = -EINVAL;
2086 int i;
2087
2088 if (!pstate)
2089 return 0;
2090
2091 /*
2092 * Normally the src_table will have the "required_opps" property set to
2093 * point to one of the OPPs in the dst_table, but in some cases the
2094 * genpd and its master have one to one mapping of performance states
2095 * and so none of them have the "required-opps" property set. Return the
2096 * pstate of the src_table as it is in such cases.
2097 */
2098 if (!src_table->required_opp_count)
2099 return pstate;
2100
2101 for (i = 0; i < src_table->required_opp_count; i++) {
2102 if (src_table->required_opp_tables[i]->np == dst_table->np)
2103 break;
2104 }
2105
2106 if (unlikely(i == src_table->required_opp_count)) {
2107 pr_err("%s: Couldn't find matching OPP table (%p: %p)\n",
2108 __func__, src_table, dst_table);
2109 return -EINVAL;
2110 }
2111
2112 mutex_lock(&src_table->lock);
2113
2114 list_for_each_entry(opp, &src_table->opp_list, node) {
2115 if (opp->pstate == pstate) {
2116 dest_pstate = opp->required_opps[i]->pstate;
2117 goto unlock;
2118 }
2119 }
2120
2121 pr_err("%s: Couldn't find matching OPP (%p: %p)\n", __func__, src_table,
2122 dst_table);
2123
2124unlock:
2125 mutex_unlock(&src_table->lock);
2126
2127 return dest_pstate;
2128}
2129
2130/**
Nishanth Menone1f60b22010-10-13 00:13:10 +02002131 * dev_pm_opp_add() - Add an OPP table from a table definitions
2132 * @dev: device for which we do this operation
Nishanth Menon47d43ba2013-09-19 16:03:51 -05002133 * @freq: Frequency in Hz for this OPP
Nishanth Menone1f60b22010-10-13 00:13:10 +02002134 * @u_volt: Voltage in uVolts for this OPP
2135 *
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302136 * This function adds an opp definition to the opp table and returns status.
Nishanth Menon47d43ba2013-09-19 16:03:51 -05002137 * The opp is made available by default and it can be controlled using
Nishanth Menone1f60b22010-10-13 00:13:10 +02002138 * dev_pm_opp_enable/disable functions.
2139 *
Viresh Kumara7470db2014-11-25 16:04:17 +05302140 * Return:
2141 * 0 On success OR
2142 * Duplicate OPPs (both freq and volt are same) and opp->available
2143 * -EEXIST Freq are same and volt are different OR
2144 * Duplicate OPPs (both freq and volt are same) and !opp->available
Viresh Kumar383934092014-11-25 16:04:18 +05302145 * -ENOMEM Memory allocation failure
Viresh Kumara7470db2014-11-25 16:04:17 +05302146 */
Nishanth Menone1f60b22010-10-13 00:13:10 +02002147int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
2148{
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05302149 struct opp_table *opp_table;
2150 int ret;
2151
Viresh Kumarb83c1892017-01-23 10:11:45 +05302152 opp_table = dev_pm_opp_get_opp_table(dev);
2153 if (!opp_table)
2154 return -ENOMEM;
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05302155
Viresh Kumar46f48ac2018-12-11 16:39:36 +05302156 /* Fix regulator count for dynamic OPPs */
2157 opp_table->regulator_count = 1;
2158
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05302159 ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);
Viresh Kumar0ad8c622018-08-02 14:23:09 +05302160 if (ret)
2161 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05302162
Viresh Kumar8cd2f6e2017-01-02 14:41:01 +05302163 return ret;
Nishanth Menone1f60b22010-10-13 00:13:10 +02002164}
2165EXPORT_SYMBOL_GPL(dev_pm_opp_add);
2166
Nishanth Menone1f60b22010-10-13 00:13:10 +02002167/**
Nishanth Menon327854c2014-12-24 11:22:56 -06002168 * _opp_set_availability() - helper to set the availability of an opp
Nishanth Menone1f60b22010-10-13 00:13:10 +02002169 * @dev: device for which we do this operation
2170 * @freq: OPP frequency to modify availability
2171 * @availability_req: availability status requested for this opp
2172 *
Viresh Kumar052c6f12017-01-23 10:11:49 +05302173 * Set the availability of an OPP, opp_{enable,disable} share a common logic
2174 * which is isolated here.
Nishanth Menone1f60b22010-10-13 00:13:10 +02002175 *
Nishanth Menon984f16c2014-12-24 11:22:57 -06002176 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
Stephen Boyde1a2d492015-09-24 12:28:44 -07002177 * copy operation, returns 0 if no modification was done OR modification was
Nishanth Menone1f60b22010-10-13 00:13:10 +02002178 * successful.
Nishanth Menone1f60b22010-10-13 00:13:10 +02002179 */
Nishanth Menon327854c2014-12-24 11:22:56 -06002180static int _opp_set_availability(struct device *dev, unsigned long freq,
2181 bool availability_req)
Nishanth Menone1f60b22010-10-13 00:13:10 +02002182{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302183 struct opp_table *opp_table;
Viresh Kumara7f39872017-01-23 10:11:50 +05302184 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002185 int r = 0;
2186
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302187 /* Find the opp_table */
2188 opp_table = _find_opp_table(dev);
2189 if (IS_ERR(opp_table)) {
2190 r = PTR_ERR(opp_table);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002191 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
Viresh Kumara7f39872017-01-23 10:11:50 +05302192 return r;
Nishanth Menone1f60b22010-10-13 00:13:10 +02002193 }
2194
Viresh Kumar37a73ec2017-01-23 10:11:41 +05302195 mutex_lock(&opp_table->lock);
2196
Nishanth Menone1f60b22010-10-13 00:13:10 +02002197 /* Do we have the frequency? */
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302198 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
Nishanth Menone1f60b22010-10-13 00:13:10 +02002199 if (tmp_opp->rate == freq) {
2200 opp = tmp_opp;
2201 break;
2202 }
2203 }
Viresh Kumar37a73ec2017-01-23 10:11:41 +05302204
Nishanth Menone1f60b22010-10-13 00:13:10 +02002205 if (IS_ERR(opp)) {
2206 r = PTR_ERR(opp);
2207 goto unlock;
2208 }
2209
2210 /* Is update really needed? */
2211 if (opp->available == availability_req)
2212 goto unlock;
Nishanth Menone1f60b22010-10-13 00:13:10 +02002213
Viresh Kumara7f39872017-01-23 10:11:50 +05302214 opp->available = availability_req;
Nishanth Menone1f60b22010-10-13 00:13:10 +02002215
Viresh Kumare4d8ae02017-09-21 10:44:36 -07002216 dev_pm_opp_get(opp);
2217 mutex_unlock(&opp_table->lock);
2218
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002219 /* Notify the change of the OPP availability */
2220 if (availability_req)
Viresh Kumar052c6f12017-01-23 10:11:49 +05302221 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
Viresh Kumara7f39872017-01-23 10:11:50 +05302222 opp);
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002223 else
Viresh Kumar052c6f12017-01-23 10:11:49 +05302224 blocking_notifier_call_chain(&opp_table->head,
Viresh Kumara7f39872017-01-23 10:11:50 +05302225 OPP_EVENT_DISABLE, opp);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002226
Viresh Kumare4d8ae02017-09-21 10:44:36 -07002227 dev_pm_opp_put(opp);
2228 goto put_table;
2229
Nishanth Menone1f60b22010-10-13 00:13:10 +02002230unlock:
Viresh Kumar5b650b32017-01-23 10:11:48 +05302231 mutex_unlock(&opp_table->lock);
Viresh Kumare4d8ae02017-09-21 10:44:36 -07002232put_table:
Viresh Kumar5b650b32017-01-23 10:11:48 +05302233 dev_pm_opp_put_opp_table(opp_table);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002234 return r;
2235}
2236
2237/**
Stephen Boyd25cb20a2019-10-16 16:57:53 +02002238 * dev_pm_opp_adjust_voltage() - helper to change the voltage of an OPP
2239 * @dev: device for which we do this operation
2240 * @freq: OPP frequency to adjust voltage of
2241 * @u_volt: new OPP target voltage
2242 * @u_volt_min: new OPP min voltage
2243 * @u_volt_max: new OPP max voltage
2244 *
2245 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
2246 * copy operation, returns 0 if no modifcation was done OR modification was
2247 * successful.
2248 */
2249int dev_pm_opp_adjust_voltage(struct device *dev, unsigned long freq,
2250 unsigned long u_volt, unsigned long u_volt_min,
2251 unsigned long u_volt_max)
2252
2253{
2254 struct opp_table *opp_table;
2255 struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
2256 int r = 0;
2257
2258 /* Find the opp_table */
2259 opp_table = _find_opp_table(dev);
2260 if (IS_ERR(opp_table)) {
2261 r = PTR_ERR(opp_table);
2262 dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
2263 return r;
2264 }
2265
2266 mutex_lock(&opp_table->lock);
2267
2268 /* Do we have the frequency? */
2269 list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
2270 if (tmp_opp->rate == freq) {
2271 opp = tmp_opp;
2272 break;
2273 }
2274 }
2275
2276 if (IS_ERR(opp)) {
2277 r = PTR_ERR(opp);
2278 goto adjust_unlock;
2279 }
2280
2281 /* Is update really needed? */
2282 if (opp->supplies->u_volt == u_volt)
2283 goto adjust_unlock;
2284
2285 opp->supplies->u_volt = u_volt;
2286 opp->supplies->u_volt_min = u_volt_min;
2287 opp->supplies->u_volt_max = u_volt_max;
2288
2289 dev_pm_opp_get(opp);
2290 mutex_unlock(&opp_table->lock);
2291
2292 /* Notify the voltage change of the OPP */
2293 blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADJUST_VOLTAGE,
2294 opp);
2295
2296 dev_pm_opp_put(opp);
2297 goto adjust_put_table;
2298
2299adjust_unlock:
2300 mutex_unlock(&opp_table->lock);
2301adjust_put_table:
2302 dev_pm_opp_put_opp_table(opp_table);
2303 return r;
2304}
2305
2306/**
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002307 * dev_pm_opp_enable() - Enable a specific OPP
Nishanth Menone1f60b22010-10-13 00:13:10 +02002308 * @dev: device for which we do this operation
2309 * @freq: OPP frequency to enable
2310 *
2311 * Enables a provided opp. If the operation is valid, this returns 0, else the
2312 * corresponding error value. It is meant to be used for users an OPP available
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002313 * after being temporarily made unavailable with dev_pm_opp_disable.
Nishanth Menone1f60b22010-10-13 00:13:10 +02002314 *
Nishanth Menon984f16c2014-12-24 11:22:57 -06002315 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
Stephen Boyde1a2d492015-09-24 12:28:44 -07002316 * copy operation, returns 0 if no modification was done OR modification was
Nishanth Menon984f16c2014-12-24 11:22:57 -06002317 * successful.
Nishanth Menone1f60b22010-10-13 00:13:10 +02002318 */
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002319int dev_pm_opp_enable(struct device *dev, unsigned long freq)
Nishanth Menone1f60b22010-10-13 00:13:10 +02002320{
Nishanth Menon327854c2014-12-24 11:22:56 -06002321 return _opp_set_availability(dev, freq, true);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002322}
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002323EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002324
2325/**
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002326 * dev_pm_opp_disable() - Disable a specific OPP
Nishanth Menone1f60b22010-10-13 00:13:10 +02002327 * @dev: device for which we do this operation
2328 * @freq: OPP frequency to disable
2329 *
2330 * Disables a provided opp. If the operation is valid, this returns
2331 * 0, else the corresponding error value. It is meant to be a temporary
2332 * control by users to make this OPP not available until the circumstances are
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002333 * right to make it available again (with a call to dev_pm_opp_enable).
Nishanth Menone1f60b22010-10-13 00:13:10 +02002334 *
Nishanth Menon984f16c2014-12-24 11:22:57 -06002335 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
Stephen Boyde1a2d492015-09-24 12:28:44 -07002336 * copy operation, returns 0 if no modification was done OR modification was
Nishanth Menon984f16c2014-12-24 11:22:57 -06002337 * successful.
Nishanth Menone1f60b22010-10-13 00:13:10 +02002338 */
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002339int dev_pm_opp_disable(struct device *dev, unsigned long freq)
Nishanth Menone1f60b22010-10-13 00:13:10 +02002340{
Nishanth Menon327854c2014-12-24 11:22:56 -06002341 return _opp_set_availability(dev, freq, false);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002342}
Nishanth Menon5d4879c2013-09-19 16:03:50 -05002343EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
Nishanth Menone1f60b22010-10-13 00:13:10 +02002344
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002345/**
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302346 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
2347 * @dev: Device for which notifier needs to be registered
2348 * @nb: Notifier block to be registered
Nishanth Menon984f16c2014-12-24 11:22:57 -06002349 *
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302350 * Return: 0 on success or a negative error value.
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002351 */
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302352int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002353{
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302354 struct opp_table *opp_table;
2355 int ret;
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002356
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302357 opp_table = _find_opp_table(dev);
Viresh Kumar5b650b32017-01-23 10:11:48 +05302358 if (IS_ERR(opp_table))
2359 return PTR_ERR(opp_table);
2360
Viresh Kumar052c6f12017-01-23 10:11:49 +05302361 ret = blocking_notifier_chain_register(&opp_table->head, nb);
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302362
Viresh Kumar5b650b32017-01-23 10:11:48 +05302363 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302364
2365 return ret;
MyungJoo Ham03ca3702011-09-30 22:35:12 +02002366}
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302367EXPORT_SYMBOL(dev_pm_opp_register_notifier);
2368
2369/**
2370 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
2371 * @dev: Device for which notifier needs to be unregistered
2372 * @nb: Notifier block to be unregistered
2373 *
2374 * Return: 0 on success or a negative error value.
2375 */
2376int dev_pm_opp_unregister_notifier(struct device *dev,
2377 struct notifier_block *nb)
2378{
2379 struct opp_table *opp_table;
2380 int ret;
2381
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302382 opp_table = _find_opp_table(dev);
Viresh Kumar5b650b32017-01-23 10:11:48 +05302383 if (IS_ERR(opp_table))
2384 return PTR_ERR(opp_table);
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302385
Viresh Kumar052c6f12017-01-23 10:11:49 +05302386 ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302387
Viresh Kumar5b650b32017-01-23 10:11:48 +05302388 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumardc2c9ad2017-01-02 14:41:03 +05302389
2390 return ret;
2391}
2392EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
Shawn Guob496dfb2012-09-05 01:09:12 +02002393
Viresh Kumar2a4eb732018-09-13 13:14:36 +05302394void _dev_pm_opp_find_and_remove_table(struct device *dev)
Viresh Kumar737002b2015-07-29 16:22:58 +05302395{
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302396 struct opp_table *opp_table;
Viresh Kumar737002b2015-07-29 16:22:58 +05302397
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302398 /* Check for existing table for 'dev' */
2399 opp_table = _find_opp_table(dev);
2400 if (IS_ERR(opp_table)) {
2401 int error = PTR_ERR(opp_table);
Viresh Kumar737002b2015-07-29 16:22:58 +05302402
2403 if (error != -ENODEV)
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302404 WARN(1, "%s: opp_table: %d\n",
Viresh Kumar737002b2015-07-29 16:22:58 +05302405 IS_ERR_OR_NULL(dev) ?
2406 "Invalid device" : dev_name(dev),
2407 error);
Viresh Kumar5b650b32017-01-23 10:11:48 +05302408 return;
Viresh Kumar737002b2015-07-29 16:22:58 +05302409 }
2410
Viresh Kumar03758d62019-11-11 16:35:03 +05302411 _opp_remove_all_static(opp_table);
Viresh Kumar737002b2015-07-29 16:22:58 +05302412
Viresh Kumarcdd6ed92018-09-12 12:35:19 +05302413 /* Drop reference taken by _find_opp_table() */
2414 dev_pm_opp_put_opp_table(opp_table);
2415
2416 /* Drop reference taken while the OPP table was added */
Viresh Kumar5b650b32017-01-23 10:11:48 +05302417 dev_pm_opp_put_opp_table(opp_table);
Viresh Kumar737002b2015-07-29 16:22:58 +05302418}
Viresh Kumar129eec52014-11-27 08:54:06 +05302419
2420/**
Sudeep Holla411466c2016-05-03 15:05:04 +01002421 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
Viresh Kumar2c2709d2016-02-16 14:17:53 +05302422 * @dev: device pointer used to lookup OPP table.
Viresh Kumar129eec52014-11-27 08:54:06 +05302423 *
Sudeep Holla411466c2016-05-03 15:05:04 +01002424 * Free both OPPs created using static entries present in DT and the
2425 * dynamically added entries.
Viresh Kumar129eec52014-11-27 08:54:06 +05302426 */
Sudeep Holla411466c2016-05-03 15:05:04 +01002427void dev_pm_opp_remove_table(struct device *dev)
Viresh Kumar129eec52014-11-27 08:54:06 +05302428{
Viresh Kumar2a4eb732018-09-13 13:14:36 +05302429 _dev_pm_opp_find_and_remove_table(dev);
Viresh Kumar8d4d4e92015-06-12 17:10:38 +05302430}
Sudeep Holla411466c2016-05-03 15:05:04 +01002431EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);