core.c 43.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * Generic OPP Interface
 *
 * Copyright (C) 2009-2010 Texas Instruments Incorporated.
 *	Nishanth Menon
 *	Romit Dasgupta
 *	Kevin Hilman
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

14 15
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

V
Viresh Kumar 已提交
16
#include <linux/clk.h>
17 18 19
#include <linux/errno.h>
#include <linux/err.h>
#include <linux/slab.h>
20
#include <linux/device.h>
21
#include <linux/export.h>
22
#include <linux/regulator/consumer.h>
23

24
#include "opp.h"
25 26

/*
27 28
 * The root of the list of all opp-tables. All opp_table structures branch off
 * from here, with each opp_table containing the list of opps it supports in
29 30
 * various states of availability.
 */
31
LIST_HEAD(opp_tables);
32
/* Lock to allow exclusive modification to the device and opp lists */
33
DEFINE_MUTEX(opp_table_lock);
34

35 36
static void dev_pm_opp_get(struct dev_pm_opp *opp);

37 38
static struct opp_device *_find_opp_dev(const struct device *dev,
					struct opp_table *opp_table)
39
{
40
	struct opp_device *opp_dev;
41

42 43 44
	list_for_each_entry(opp_dev, &opp_table->dev_list, node)
		if (opp_dev->dev == dev)
			return opp_dev;
45 46 47 48

	return NULL;
}

49
static struct opp_table *_find_opp_table_unlocked(struct device *dev)
50 51 52 53 54 55 56 57 58 59 60 61 62 63
{
	struct opp_table *opp_table;

	list_for_each_entry(opp_table, &opp_tables, node) {
		if (_find_opp_dev(dev, opp_table)) {
			_get_opp_table_kref(opp_table);

			return opp_table;
		}
	}

	return ERR_PTR(-ENODEV);
}

64
/**
65 66
 * _find_opp_table() - find opp_table struct using device pointer
 * @dev:	device pointer used to lookup OPP table
67
 *
68
 * Search OPP table for one containing matching device.
69
 *
70
 * Return: pointer to 'struct opp_table' if found, otherwise -ENODEV or
71 72
 * -EINVAL based on type of error.
 *
73
 * The callers must call dev_pm_opp_put_opp_table() after the table is used.
74
 */
75
struct opp_table *_find_opp_table(struct device *dev)
76
{
77
	struct opp_table *opp_table;
78

79
	if (IS_ERR_OR_NULL(dev)) {
80 81 82 83
		pr_err("%s: Invalid parameters\n", __func__);
		return ERR_PTR(-EINVAL);
	}

84 85 86
	mutex_lock(&opp_table_lock);
	opp_table = _find_opp_table_unlocked(dev);
	mutex_unlock(&opp_table_lock);
87

88
	return opp_table;
89 90 91
}

/**
92
 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an opp
93 94
 * @opp:	opp for which voltage has to be returned for
 *
95
 * Return: voltage in micro volt corresponding to the opp, else
96 97
 * return 0
 *
98
 * This is useful only for devices with single power supply.
99
 */
100
unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
101
{
102
	if (IS_ERR_OR_NULL(opp)) {
103
		pr_err("%s: Invalid parameters\n", __func__);
104 105
		return 0;
	}
106

107
	return opp->supplies[0].u_volt;
108
}
109
EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
110 111

/**
112
 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
113 114
 * @opp:	opp for which frequency has to be returned for
 *
115
 * Return: frequency in hertz corresponding to the opp, else
116 117
 * return 0
 */
118
unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
119
{
120
	if (IS_ERR_OR_NULL(opp) || !opp->available) {
121
		pr_err("%s: Invalid parameters\n", __func__);
122 123
		return 0;
	}
124

125
	return opp->rate;
126
}
127
EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
128

129 130 131 132 133 134 135 136 137 138 139 140
/**
 * dev_pm_opp_is_turbo() - Returns if opp is turbo OPP or not
 * @opp: opp for which turbo mode is being verified
 *
 * Turbo OPPs are not for normal use, and can be enabled (under certain
 * conditions) for short duration of times to finish high throughput work
 * quickly. Running on them for longer times may overheat the chip.
 *
 * Return: true if opp is turbo opp, else false.
 */
bool dev_pm_opp_is_turbo(struct dev_pm_opp *opp)
{
141
	if (IS_ERR_OR_NULL(opp) || !opp->available) {
142 143 144 145
		pr_err("%s: Invalid parameters\n", __func__);
		return false;
	}

146
	return opp->turbo;
147 148 149
}
EXPORT_SYMBOL_GPL(dev_pm_opp_is_turbo);

150 151 152 153 154 155 156 157
/**
 * dev_pm_opp_get_max_clock_latency() - Get max clock latency in nanoseconds
 * @dev:	device for which we do this operation
 *
 * Return: This function returns the max clock latency in nanoseconds.
 */
unsigned long dev_pm_opp_get_max_clock_latency(struct device *dev)
{
158
	struct opp_table *opp_table;
159 160
	unsigned long clock_latency_ns;

161 162
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table))
163 164 165 166 167
		return 0;

	clock_latency_ns = opp_table->clock_latency_ns_max;

	dev_pm_opp_put_opp_table(opp_table);
168 169 170 171 172

	return clock_latency_ns;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_clock_latency);

173 174 175 176 177 178 179 180
/**
 * dev_pm_opp_get_max_volt_latency() - Get max voltage latency in nanoseconds
 * @dev: device for which we do this operation
 *
 * Return: This function returns the max voltage latency in nanoseconds.
 */
unsigned long dev_pm_opp_get_max_volt_latency(struct device *dev)
{
181
	struct opp_table *opp_table;
182
	struct dev_pm_opp *opp;
183
	struct regulator *reg, **regulators;
184
	unsigned long latency_ns = 0;
185 186 187 188 189 190
	int ret, i, count;
	struct {
		unsigned long min;
		unsigned long max;
	} *uV;

191 192 193 194 195
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table))
		return 0;

	count = opp_table->regulator_count;
196 197 198

	/* Regulator may not be required for the device */
	if (!count)
199
		goto put_opp_table;
200 201 202

	regulators = kmalloc_array(count, sizeof(*regulators), GFP_KERNEL);
	if (!regulators)
203
		goto put_opp_table;
204 205 206 207

	uV = kmalloc_array(count, sizeof(*uV), GFP_KERNEL);
	if (!uV)
		goto free_regulators;
208

209
	memcpy(regulators, opp_table->regulators, count * sizeof(*regulators));
210

211 212
	mutex_lock(&opp_table->lock);

213 214 215
	for (i = 0; i < count; i++) {
		uV[i].min = ~0;
		uV[i].max = 0;
216

217
		list_for_each_entry(opp, &opp_table->opp_list, node) {
218 219 220 221 222 223 224 225
			if (!opp->available)
				continue;

			if (opp->supplies[i].u_volt_min < uV[i].min)
				uV[i].min = opp->supplies[i].u_volt_min;
			if (opp->supplies[i].u_volt_max > uV[i].max)
				uV[i].max = opp->supplies[i].u_volt_max;
		}
226 227
	}

228
	mutex_unlock(&opp_table->lock);
229 230

	/*
231
	 * The caller needs to ensure that opp_table (and hence the regulator)
232 233
	 * isn't freed, while we are executing this routine.
	 */
234 235 236 237 238 239 240 241 242
	for (i = 0; reg = regulators[i], i < count; i++) {
		ret = regulator_set_voltage_time(reg, uV[i].min, uV[i].max);
		if (ret > 0)
			latency_ns += ret * 1000;
	}

	kfree(uV);
free_regulators:
	kfree(regulators);
243 244
put_opp_table:
	dev_pm_opp_put_opp_table(opp_table);
245 246 247 248 249

	return latency_ns;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_volt_latency);

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/**
 * dev_pm_opp_get_max_transition_latency() - Get max transition latency in
 *					     nanoseconds
 * @dev: device for which we do this operation
 *
 * Return: This function returns the max transition latency, in nanoseconds, to
 * switch from one OPP to other.
 */
unsigned long dev_pm_opp_get_max_transition_latency(struct device *dev)
{
	return dev_pm_opp_get_max_volt_latency(dev) +
		dev_pm_opp_get_max_clock_latency(dev);
}
EXPORT_SYMBOL_GPL(dev_pm_opp_get_max_transition_latency);

265
/**
266
 * dev_pm_opp_get_suspend_opp_freq() - Get frequency of suspend opp in Hz
267 268
 * @dev:	device for which we do this operation
 *
269 270
 * Return: This function returns the frequency of the OPP marked as suspend_opp
 * if one is available, else returns 0;
271
 */
272
unsigned long dev_pm_opp_get_suspend_opp_freq(struct device *dev)
273
{
274
	struct opp_table *opp_table;
275
	unsigned long freq = 0;
276

277
	opp_table = _find_opp_table(dev);
278 279
	if (IS_ERR(opp_table))
		return 0;
280

281 282 283 284
	if (opp_table->suspend_opp && opp_table->suspend_opp->available)
		freq = dev_pm_opp_get_freq(opp_table->suspend_opp);

	dev_pm_opp_put_opp_table(opp_table);
285

286
	return freq;
287
}
288
EXPORT_SYMBOL_GPL(dev_pm_opp_get_suspend_opp_freq);
289

290
/**
291
 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp table
292 293
 * @dev:	device for which we do this operation
 *
294
 * Return: This function returns the number of available opps if there are any,
295 296
 * else returns 0 if none or the corresponding error value.
 */
297
int dev_pm_opp_get_opp_count(struct device *dev)
298
{
299
	struct opp_table *opp_table;
300
	struct dev_pm_opp *temp_opp;
301 302
	int count = 0;

303 304 305 306
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table)) {
		count = PTR_ERR(opp_table);
		dev_err(dev, "%s: OPP table not found (%d)\n",
307
			__func__, count);
308
		return count;
309 310
	}

311
	mutex_lock(&opp_table->lock);
312

313
	list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
314 315 316 317
		if (temp_opp->available)
			count++;
	}

318
	mutex_unlock(&opp_table->lock);
319 320
	dev_pm_opp_put_opp_table(opp_table);

321 322
	return count;
}
323
EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
324 325

/**
326
 * dev_pm_opp_find_freq_exact() - search for an exact frequency
327 328
 * @dev:		device for which we do this operation
 * @freq:		frequency to search for
329
 * @available:		true/false - match for available opp
330
 *
331
 * Return: Searches for exact match in the opp table and returns pointer to the
332 333
 * matching opp if found, else returns ERR_PTR in case of error and should
 * be handled using IS_ERR. Error return values can be:
334 335 336
 * EINVAL:	for bad pointer
 * ERANGE:	no match found for search
 * ENODEV:	if device not found in list of registered devices
337 338 339 340 341 342 343 344
 *
 * Note: available is a modifier for the search. if available=true, then the
 * match is for exact matching frequency and is available in the stored OPP
 * table. if false, the match is for exact frequency which is not available.
 *
 * This provides a mechanism to enable an opp which is not available currently
 * or the opposite as well.
 *
345 346
 * The callers are required to call dev_pm_opp_put() for the returned OPP after
 * use.
347
 */
348 349 350
struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
					      unsigned long freq,
					      bool available)
351
{
352
	struct opp_table *opp_table;
353
	struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
354

355 356 357 358 359
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table)) {
		int r = PTR_ERR(opp_table);

		dev_err(dev, "%s: OPP table not found (%d)\n", __func__, r);
360 361 362
		return ERR_PTR(r);
	}

363
	mutex_lock(&opp_table->lock);
364

365
	list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
366 367 368
		if (temp_opp->available == available &&
				temp_opp->rate == freq) {
			opp = temp_opp;
369 370 371

			/* Increment the reference count of OPP */
			dev_pm_opp_get(opp);
372 373 374 375
			break;
		}
	}

376
	mutex_unlock(&opp_table->lock);
377
	dev_pm_opp_put_opp_table(opp_table);
378

379 380
	return opp;
}
381
EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
382

383 384 385 386 387
static noinline struct dev_pm_opp *_find_freq_ceil(struct opp_table *opp_table,
						   unsigned long *freq)
{
	struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);

388 389 390
	mutex_lock(&opp_table->lock);

	list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
391 392 393
		if (temp_opp->available && temp_opp->rate >= *freq) {
			opp = temp_opp;
			*freq = opp->rate;
394 395 396

			/* Increment the reference count of OPP */
			dev_pm_opp_get(opp);
397 398 399 400
			break;
		}
	}

401 402
	mutex_unlock(&opp_table->lock);

403 404 405
	return opp;
}

406
/**
407
 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
408 409 410 411 412 413
 * @dev:	device for which we do this operation
 * @freq:	Start frequency
 *
 * Search for the matching ceil *available* OPP from a starting freq
 * for a device.
 *
414
 * Return: matching *opp and refreshes *freq accordingly, else returns
415 416 417 418 419
 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
 * values can be:
 * EINVAL:	for bad pointer
 * ERANGE:	no match found for search
 * ENODEV:	if device not found in list of registered devices
420
 *
421 422
 * The callers are required to call dev_pm_opp_put() for the returned OPP after
 * use.
423
 */
424 425
struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
					     unsigned long *freq)
426
{
427
	struct opp_table *opp_table;
428
	struct dev_pm_opp *opp;
429

430 431 432 433 434
	if (!dev || !freq) {
		dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
		return ERR_PTR(-EINVAL);
	}

435
	opp_table = _find_opp_table(dev);
436
	if (IS_ERR(opp_table))
437
		return ERR_CAST(opp_table);
438

439
	opp = _find_freq_ceil(opp_table, freq);
440

441
	dev_pm_opp_put_opp_table(opp_table);
442 443

	return opp;
444
}
445
EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
446 447

/**
448
 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
449 450 451 452 453 454
 * @dev:	device for which we do this operation
 * @freq:	Start frequency
 *
 * Search for the matching floor *available* OPP from a starting freq
 * for a device.
 *
455
 * Return: matching *opp and refreshes *freq accordingly, else returns
456 457 458 459 460
 * ERR_PTR in case of error and should be handled using IS_ERR. Error return
 * values can be:
 * EINVAL:	for bad pointer
 * ERANGE:	no match found for search
 * ENODEV:	if device not found in list of registered devices
461
 *
462 463
 * The callers are required to call dev_pm_opp_put() for the returned OPP after
 * use.
464
 */
465 466
struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
					      unsigned long *freq)
467
{
468
	struct opp_table *opp_table;
469
	struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
470 471 472 473 474 475

	if (!dev || !freq) {
		dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
		return ERR_PTR(-EINVAL);
	}

476
	opp_table = _find_opp_table(dev);
477
	if (IS_ERR(opp_table))
478
		return ERR_CAST(opp_table);
479

480
	mutex_lock(&opp_table->lock);
481

482
	list_for_each_entry(temp_opp, &opp_table->opp_list, node) {
483 484 485 486 487 488 489 490
		if (temp_opp->available) {
			/* go to the next node, before choosing prev */
			if (temp_opp->rate > *freq)
				break;
			else
				opp = temp_opp;
		}
	}
491 492 493 494

	/* Increment the reference count of OPP */
	if (!IS_ERR(opp))
		dev_pm_opp_get(opp);
495
	mutex_unlock(&opp_table->lock);
496
	dev_pm_opp_put_opp_table(opp_table);
497

498 499 500 501 502
	if (!IS_ERR(opp))
		*freq = opp->rate;

	return opp;
}
503
EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
504

505
static int _set_opp_voltage(struct device *dev, struct regulator *reg,
506
			    struct dev_pm_opp_supply *supply)
507 508 509 510 511 512 513 514 515 516
{
	int ret;

	/* Regulator not available for device */
	if (IS_ERR(reg)) {
		dev_dbg(dev, "%s: regulator not available: %ld\n", __func__,
			PTR_ERR(reg));
		return 0;
	}

517 518
	dev_dbg(dev, "%s: voltages (mV): %lu %lu %lu\n", __func__,
		supply->u_volt_min, supply->u_volt, supply->u_volt_max);
519

520 521
	ret = regulator_set_voltage_triplet(reg, supply->u_volt_min,
					    supply->u_volt, supply->u_volt_max);
522 523
	if (ret)
		dev_err(dev, "%s: failed to set voltage (%lu %lu %lu mV): %d\n",
524 525
			__func__, supply->u_volt_min, supply->u_volt,
			supply->u_volt_max, ret);
526 527 528 529

	return ret;
}

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
static inline int
_generic_set_opp_clk_only(struct device *dev, struct clk *clk,
			  unsigned long old_freq, unsigned long freq)
{
	int ret;

	ret = clk_set_rate(clk, freq);
	if (ret) {
		dev_err(dev, "%s: failed to set clock rate: %d\n", __func__,
			ret);
	}

	return ret;
}

static int _generic_set_opp(struct dev_pm_set_opp_data *data)
{
	struct dev_pm_opp_supply *old_supply = data->old_opp.supplies;
	struct dev_pm_opp_supply *new_supply = data->new_opp.supplies;
	unsigned long old_freq = data->old_opp.rate, freq = data->new_opp.rate;
	struct regulator *reg = data->regulators[0];
	struct device *dev= data->dev;
	int ret;

	/* This function only supports single regulator per device */
	if (WARN_ON(data->regulator_count > 1)) {
		dev_err(dev, "multiple regulators are not supported\n");
		return -EINVAL;
	}

	/* Scaling up? Scale voltage before frequency */
	if (freq > old_freq) {
		ret = _set_opp_voltage(dev, reg, new_supply);
		if (ret)
			goto restore_voltage;
	}

	/* Change frequency */
	ret = _generic_set_opp_clk_only(dev, data->clk, old_freq, freq);
	if (ret)
		goto restore_voltage;

	/* Scaling down? Scale voltage after frequency */
	if (freq < old_freq) {
		ret = _set_opp_voltage(dev, reg, new_supply);
		if (ret)
			goto restore_freq;
	}

	return 0;

restore_freq:
	if (_generic_set_opp_clk_only(dev, data->clk, freq, old_freq))
		dev_err(dev, "%s: failed to restore old-freq (%lu Hz)\n",
			__func__, old_freq);
restore_voltage:
	/* This shouldn't harm even if the voltages weren't updated earlier */
	if (old_supply->u_volt)
		_set_opp_voltage(dev, reg, old_supply);

	return ret;
}

593 594 595 596 597 598 599 600 601 602
/**
 * dev_pm_opp_set_rate() - Configure new OPP based on frequency
 * @dev:	 device for which we do this operation
 * @target_freq: frequency to achieve
 *
 * This configures the power-supplies and clock source to the levels specified
 * by the OPP corresponding to the target_freq.
 */
int dev_pm_opp_set_rate(struct device *dev, unsigned long target_freq)
{
603
	struct opp_table *opp_table;
604
	unsigned long freq, old_freq;
605
	int (*set_opp)(struct dev_pm_set_opp_data *data);
606
	struct dev_pm_opp *old_opp, *opp;
607 608
	struct regulator **regulators;
	struct dev_pm_set_opp_data *data;
609
	struct clk *clk;
610
	int ret, size;
611 612 613 614 615 616 617

	if (unlikely(!target_freq)) {
		dev_err(dev, "%s: Invalid target frequency %lu\n", __func__,
			target_freq);
		return -EINVAL;
	}

618 619 620 621 622 623 624 625 626 627 628 629 630
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table)) {
		dev_err(dev, "%s: device opp doesn't exist\n", __func__);
		return PTR_ERR(opp_table);
	}

	clk = opp_table->clk;
	if (IS_ERR(clk)) {
		dev_err(dev, "%s: No clock available for the device\n",
			__func__);
		ret = PTR_ERR(clk);
		goto put_opp_table;
	}
631 632 633 634 635 636 637 638 639 640 641

	freq = clk_round_rate(clk, target_freq);
	if ((long)freq <= 0)
		freq = target_freq;

	old_freq = clk_get_rate(clk);

	/* Return early if nothing to do */
	if (old_freq == freq) {
		dev_dbg(dev, "%s: old/new frequencies (%lu Hz) are same, nothing to do\n",
			__func__, freq);
642 643
		ret = 0;
		goto put_opp_table;
644 645
	}

646
	old_opp = _find_freq_ceil(opp_table, &old_freq);
647
	if (IS_ERR(old_opp)) {
648 649 650 651
		dev_err(dev, "%s: failed to find current OPP for freq %lu (%ld)\n",
			__func__, old_freq, PTR_ERR(old_opp));
	}

652
	opp = _find_freq_ceil(opp_table, &freq);
653 654 655 656
	if (IS_ERR(opp)) {
		ret = PTR_ERR(opp);
		dev_err(dev, "%s: failed to find OPP for freq %lu (%d)\n",
			__func__, freq, ret);
657
		goto put_old_opp;
658 659
	}

660 661
	dev_dbg(dev, "%s: switching OPP: %lu Hz --> %lu Hz\n", __func__,
		old_freq, freq);
662

663 664 665 666
	regulators = opp_table->regulators;

	/* Only frequency scaling */
	if (!regulators) {
667 668
		ret = _generic_set_opp_clk_only(dev, clk, old_freq, freq);
		goto put_opps;
669 670
	}

671 672 673 674 675
	if (opp_table->set_opp)
		set_opp = opp_table->set_opp;
	else
		set_opp = _generic_set_opp;

676 677 678 679 680 681 682 683
	data = opp_table->set_opp_data;
	data->regulators = regulators;
	data->regulator_count = opp_table->regulator_count;
	data->clk = clk;
	data->dev = dev;

	data->old_opp.rate = old_freq;
	size = sizeof(*opp->supplies) * opp_table->regulator_count;
684
	if (IS_ERR(old_opp))
685
		memset(data->old_opp.supplies, 0, size);
686
	else
687
		memcpy(data->old_opp.supplies, old_opp->supplies, size);
688

689 690
	data->new_opp.rate = freq;
	memcpy(data->new_opp.supplies, opp->supplies, size);
691

692 693 694
	ret = set_opp(data);

put_opps:
695
	dev_pm_opp_put(opp);
696
put_old_opp:
697 698
	if (!IS_ERR(old_opp))
		dev_pm_opp_put(old_opp);
699
put_opp_table:
700
	dev_pm_opp_put_opp_table(opp_table);
701
	return ret;
702 703 704
}
EXPORT_SYMBOL_GPL(dev_pm_opp_set_rate);

705 706 707
/* OPP-dev Helpers */
static void _remove_opp_dev(struct opp_device *opp_dev,
			    struct opp_table *opp_table)
708
{
709 710
	opp_debug_unregister(opp_dev, opp_table);
	list_del(&opp_dev->node);
711
	kfree(opp_dev);
712 713
}

714 715
struct opp_device *_add_opp_dev(const struct device *dev,
				struct opp_table *opp_table)
716
{
717
	struct opp_device *opp_dev;
V
Viresh Kumar 已提交
718
	int ret;
719

720 721
	opp_dev = kzalloc(sizeof(*opp_dev), GFP_KERNEL);
	if (!opp_dev)
722 723
		return NULL;

724 725
	/* Initialize opp-dev */
	opp_dev->dev = dev;
726
	list_add(&opp_dev->node, &opp_table->dev_list);
727

728 729
	/* Create debugfs entries for the opp_table */
	ret = opp_debug_register(opp_dev, opp_table);
V
Viresh Kumar 已提交
730 731 732 733
	if (ret)
		dev_err(dev, "%s: Failed to register opp debugfs (%d)\n",
			__func__, ret);

734
	return opp_dev;
735 736
}

737
static struct opp_table *_allocate_opp_table(struct device *dev)
738
{
739 740
	struct opp_table *opp_table;
	struct opp_device *opp_dev;
V
Viresh Kumar 已提交
741
	int ret;
742 743

	/*
744
	 * Allocate a new OPP table. In the infrequent case where a new
745 746
	 * device is needed to be added, we pay this penalty.
	 */
747 748
	opp_table = kzalloc(sizeof(*opp_table), GFP_KERNEL);
	if (!opp_table)
749 750
		return NULL;

751
	INIT_LIST_HEAD(&opp_table->dev_list);
752

753 754 755
	opp_dev = _add_opp_dev(dev, opp_table);
	if (!opp_dev) {
		kfree(opp_table);
756 757 758
		return NULL;
	}

759
	_of_init_opp_table(opp_table, dev);
760

V
Viresh Kumar 已提交
761
	/* Find clk for the device */
762 763 764
	opp_table->clk = clk_get(dev, NULL);
	if (IS_ERR(opp_table->clk)) {
		ret = PTR_ERR(opp_table->clk);
V
Viresh Kumar 已提交
765 766 767 768 769
		if (ret != -EPROBE_DEFER)
			dev_dbg(dev, "%s: Couldn't find clock: %d\n", __func__,
				ret);
	}

770
	BLOCKING_INIT_NOTIFIER_HEAD(&opp_table->head);
771
	INIT_LIST_HEAD(&opp_table->opp_list);
V
Viresh Kumar 已提交
772
	mutex_init(&opp_table->lock);
773
	kref_init(&opp_table->kref);
774

775
	/* Secure the device table modification */
776
	list_add(&opp_table->node, &opp_tables);
777
	return opp_table;
778 779
}

780
void _get_opp_table_kref(struct opp_table *opp_table)
781
{
782 783 784 785 786 787 788 789 790 791
	kref_get(&opp_table->kref);
}

struct opp_table *dev_pm_opp_get_opp_table(struct device *dev)
{
	struct opp_table *opp_table;

	/* Hold our table modification lock here */
	mutex_lock(&opp_table_lock);

792 793
	opp_table = _find_opp_table_unlocked(dev);
	if (!IS_ERR(opp_table))
794 795 796 797 798 799 800 801 802 803 804
		goto unlock;

	opp_table = _allocate_opp_table(dev);

unlock:
	mutex_unlock(&opp_table_lock);

	return opp_table;
}
EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_table);

805
static void _opp_table_kref_release(struct kref *kref)
806 807
{
	struct opp_table *opp_table = container_of(kref, struct opp_table, kref);
808 809 810 811 812 813 814 815 816 817 818 819 820 821
	struct opp_device *opp_dev;

	/* Release clk */
	if (!IS_ERR(opp_table->clk))
		clk_put(opp_table->clk);

	opp_dev = list_first_entry(&opp_table->dev_list, struct opp_device,
				   node);

	_remove_opp_dev(opp_dev, opp_table);

	/* dev_list must be empty now */
	WARN_ON(!list_empty(&opp_table->dev_list));

V
Viresh Kumar 已提交
822
	mutex_destroy(&opp_table->lock);
823 824
	list_del(&opp_table->node);
	kfree(opp_table);
825

826 827 828 829 830 831 832 833 834 835
	mutex_unlock(&opp_table_lock);
}

void dev_pm_opp_put_opp_table(struct opp_table *opp_table)
{
	kref_put_mutex(&opp_table->kref, _opp_table_kref_release,
		       &opp_table_lock);
}
EXPORT_SYMBOL_GPL(dev_pm_opp_put_opp_table);

836
void _opp_free(struct dev_pm_opp *opp)
837 838 839 840
{
	kfree(opp);
}

841
static void _opp_kref_release(struct kref *kref)
842
{
843 844
	struct dev_pm_opp *opp = container_of(kref, struct dev_pm_opp, kref);
	struct opp_table *opp_table = opp->opp_table;
V
Viresh Kumar 已提交
845

846 847 848 849
	/*
	 * Notify the changes in the availability of the operable
	 * frequency/voltage list.
	 */
850
	blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_REMOVE, opp);
V
Viresh Kumar 已提交
851
	opp_debug_remove_one(opp);
852 853
	list_del(&opp->node);
	kfree(opp);
854

V
Viresh Kumar 已提交
855
	mutex_unlock(&opp_table->lock);
856
	dev_pm_opp_put_opp_table(opp_table);
857 858
}

859 860 861 862 863
static void dev_pm_opp_get(struct dev_pm_opp *opp)
{
	kref_get(&opp->kref);
}

864 865 866 867 868 869
void dev_pm_opp_put(struct dev_pm_opp *opp)
{
	kref_put_mutex(&opp->kref, _opp_kref_release, &opp->opp_table->lock);
}
EXPORT_SYMBOL_GPL(dev_pm_opp_put);

870
/**
871
 * dev_pm_opp_remove()  - Remove an OPP from OPP table
872 873 874
 * @dev:	device for which we do this operation
 * @freq:	OPP to remove with matching 'freq'
 *
875
 * This function removes an opp from the opp table.
876 877 878 879
 */
void dev_pm_opp_remove(struct device *dev, unsigned long freq)
{
	struct dev_pm_opp *opp;
880
	struct opp_table *opp_table;
881 882
	bool found = false;

883 884
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table))
885
		return;
886

V
Viresh Kumar 已提交
887 888
	mutex_lock(&opp_table->lock);

889
	list_for_each_entry(opp, &opp_table->opp_list, node) {
890 891 892 893 894 895
		if (opp->rate == freq) {
			found = true;
			break;
		}
	}

V
Viresh Kumar 已提交
896 897
	mutex_unlock(&opp_table->lock);

898 899 900
	if (found) {
		dev_pm_opp_put(opp);
	} else {
901 902 903 904
		dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
			 __func__, freq);
	}

905
	dev_pm_opp_put_opp_table(opp_table);
906 907 908
}
EXPORT_SYMBOL_GPL(dev_pm_opp_remove);

909
struct dev_pm_opp *_opp_allocate(struct opp_table *table)
910
{
911
	struct dev_pm_opp *opp;
912
	int count, supply_size;
913

914 915 916
	/* Allocate space for at least one supply */
	count = table->regulator_count ? table->regulator_count : 1;
	supply_size = sizeof(*opp->supplies) * count;
917

918 919
	/* allocate new OPP node and supplies structures */
	opp = kzalloc(sizeof(*opp) + supply_size, GFP_KERNEL);
920
	if (!opp)
921 922
		return NULL;

923 924 925 926
	/* Put the supplies at the end of the OPP structure as an empty array */
	opp->supplies = (struct dev_pm_opp_supply *)(opp + 1);
	INIT_LIST_HEAD(&opp->node);

927 928 929
	return opp;
}

930
static bool _opp_supported_by_regulators(struct dev_pm_opp *opp,
931
					 struct opp_table *opp_table)
932
{
933 934 935 936 937 938 939 940 941 942 943 944 945 946
	struct regulator *reg;
	int i;

	for (i = 0; i < opp_table->regulator_count; i++) {
		reg = opp_table->regulators[i];

		if (!regulator_is_supported_voltage(reg,
					opp->supplies[i].u_volt_min,
					opp->supplies[i].u_volt_max)) {
			pr_warn("%s: OPP minuV: %lu maxuV: %lu, not supported by regulator\n",
				__func__, opp->supplies[i].u_volt_min,
				opp->supplies[i].u_volt_max);
			return false;
		}
947 948 949 950 951
	}

	return true;
}

952 953 954 955 956 957 958 959 960 961
/*
 * Returns:
 * 0: On success. And appropriate error message for duplicate OPPs.
 * -EBUSY: For OPP with same freq/volt and is available. The callers of
 *  _opp_add() must return 0 if they receive -EBUSY from it. This is to make
 *  sure we don't print error messages unnecessarily if different parts of
 *  kernel try to initialize the OPP table.
 * -EEXIST: For OPP with same freq but different volt or is unavailable. This
 *  should be considered an error by the callers of _opp_add().
 */
962 963
int _opp_add(struct device *dev, struct dev_pm_opp *new_opp,
	     struct opp_table *opp_table)
964 965
{
	struct dev_pm_opp *opp;
V
Viresh Kumar 已提交
966
	struct list_head *head;
V
Viresh Kumar 已提交
967
	int ret;
968 969 970 971 972

	/*
	 * Insert new OPP in order of increasing frequency and discard if
	 * already present.
	 *
973
	 * Need to use &opp_table->opp_list in the condition part of the 'for'
974 975 976
	 * loop, don't replace it with head otherwise it will become an infinite
	 * loop.
	 */
V
Viresh Kumar 已提交
977 978 979
	mutex_lock(&opp_table->lock);
	head = &opp_table->opp_list;

980
	list_for_each_entry(opp, &opp_table->opp_list, node) {
981 982 983 984 985 986 987 988 989
		if (new_opp->rate > opp->rate) {
			head = &opp->node;
			continue;
		}

		if (new_opp->rate < opp->rate)
			break;

		/* Duplicate OPPs */
990
		dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
991 992 993
			 __func__, opp->rate, opp->supplies[0].u_volt,
			 opp->available, new_opp->rate,
			 new_opp->supplies[0].u_volt, new_opp->available);
994

995
		/* Should we compare voltages for all regulators here ? */
V
Viresh Kumar 已提交
996 997 998 999 1000
		ret = opp->available &&
		      new_opp->supplies[0].u_volt == opp->supplies[0].u_volt ? -EBUSY : -EEXIST;

		mutex_unlock(&opp_table->lock);
		return ret;
1001 1002
	}

1003
	list_add(&new_opp->node, head);
V
Viresh Kumar 已提交
1004 1005 1006
	mutex_unlock(&opp_table->lock);

	new_opp->opp_table = opp_table;
1007
	kref_init(&new_opp->kref);
1008

1009 1010 1011
	/* Get a reference to the OPP table */
	_get_opp_table_kref(opp_table);

1012
	ret = opp_debug_create_one(new_opp, opp_table);
V
Viresh Kumar 已提交
1013 1014 1015 1016
	if (ret)
		dev_err(dev, "%s: Failed to register opp to debugfs (%d)\n",
			__func__, ret);

1017
	if (!_opp_supported_by_regulators(new_opp, opp_table)) {
1018 1019 1020 1021 1022
		new_opp->available = false;
		dev_warn(dev, "%s: OPP not supported by regulators (%lu)\n",
			 __func__, new_opp->rate);
	}

1023 1024 1025
	return 0;
}

1026
/**
1027
 * _opp_add_v1() - Allocate a OPP based on v1 bindings.
1028
 * @opp_table:	OPP table
1029 1030 1031 1032 1033
 * @dev:	device for which we do this operation
 * @freq:	Frequency in Hz for this OPP
 * @u_volt:	Voltage in uVolts for this OPP
 * @dynamic:	Dynamically added OPPs.
 *
1034
 * This function adds an opp definition to the opp table and returns status.
1035 1036 1037
 * The opp is made available by default and it can be controlled using
 * dev_pm_opp_enable/disable functions and may be removed by dev_pm_opp_remove.
 *
1038 1039
 * NOTE: "dynamic" parameter impacts OPPs added by the dev_pm_opp_of_add_table
 * and freed by dev_pm_opp_of_remove_table.
1040 1041 1042 1043 1044 1045 1046 1047
 *
 * Return:
 * 0		On success OR
 *		Duplicate OPPs (both freq and volt are same) and opp->available
 * -EEXIST	Freq are same and volt are different OR
 *		Duplicate OPPs (both freq and volt are same) and !opp->available
 * -ENOMEM	Memory allocation failure
 */
1048 1049
int _opp_add_v1(struct opp_table *opp_table, struct device *dev,
		unsigned long freq, long u_volt, bool dynamic)
1050
{
1051
	struct dev_pm_opp *new_opp;
1052
	unsigned long tol;
1053
	int ret;
1054

1055 1056 1057
	new_opp = _opp_allocate(opp_table);
	if (!new_opp)
		return -ENOMEM;
1058

1059 1060
	/* populate the opp table */
	new_opp->rate = freq;
1061
	tol = u_volt * opp_table->voltage_tolerance_v1 / 100;
1062 1063 1064
	new_opp->supplies[0].u_volt = u_volt;
	new_opp->supplies[0].u_volt_min = u_volt - tol;
	new_opp->supplies[0].u_volt_max = u_volt + tol;
1065
	new_opp->available = true;
1066
	new_opp->dynamic = dynamic;
1067

1068
	ret = _opp_add(dev, new_opp, opp_table);
1069 1070 1071 1072
	if (ret) {
		/* Don't return error for duplicate OPPs */
		if (ret == -EBUSY)
			ret = 0;
1073
		goto free_opp;
1074
	}
1075

1076 1077 1078 1079
	/*
	 * Notify the changes in the availability of the operable
	 * frequency/voltage list.
	 */
1080
	blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ADD, new_opp);
1081
	return 0;
1082 1083

free_opp:
1084 1085
	_opp_free(new_opp);

1086
	return ret;
1087
}
1088

1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
/**
 * dev_pm_opp_set_supported_hw() - Set supported platforms
 * @dev: Device for which supported-hw has to be set.
 * @versions: Array of hierarchy of versions to match.
 * @count: Number of elements in the array.
 *
 * This is required only for the V2 bindings, and it enables a platform to
 * specify the hierarchy of versions it supports. OPP layer will then enable
 * OPPs, which are available for those versions, based on its 'opp-supported-hw'
 * property.
 */
1100 1101
struct opp_table *dev_pm_opp_set_supported_hw(struct device *dev,
			const u32 *versions, unsigned int count)
1102
{
1103
	struct opp_table *opp_table;
1104
	int ret;
1105

1106 1107 1108
	opp_table = dev_pm_opp_get_opp_table(dev);
	if (!opp_table)
		return ERR_PTR(-ENOMEM);
1109

1110 1111
	/* Make sure there are no concurrent readers while updating opp_table */
	WARN_ON(!list_empty(&opp_table->opp_list));
1112

1113 1114
	/* Do we already have a version hierarchy associated with opp_table? */
	if (opp_table->supported_hw) {
1115 1116 1117 1118 1119 1120
		dev_err(dev, "%s: Already have supported hardware list\n",
			__func__);
		ret = -EBUSY;
		goto err;
	}

1121
	opp_table->supported_hw = kmemdup(versions, count * sizeof(*versions),
1122
					GFP_KERNEL);
1123
	if (!opp_table->supported_hw) {
1124 1125 1126 1127
		ret = -ENOMEM;
		goto err;
	}

1128
	opp_table->supported_hw_count = count;
1129 1130

	return opp_table;
1131 1132

err:
1133
	dev_pm_opp_put_opp_table(opp_table);
1134

1135
	return ERR_PTR(ret);
1136 1137 1138 1139 1140
}
EXPORT_SYMBOL_GPL(dev_pm_opp_set_supported_hw);

/**
 * dev_pm_opp_put_supported_hw() - Releases resources blocked for supported hw
1141
 * @opp_table: OPP table returned by dev_pm_opp_set_supported_hw().
1142 1143
 *
 * This is required only for the V2 bindings, and is called for a matching
1144
 * dev_pm_opp_set_supported_hw(). Until this is called, the opp_table structure
1145 1146
 * will not be freed.
 */
1147
void dev_pm_opp_put_supported_hw(struct opp_table *opp_table)
1148
{
1149 1150
	/* Make sure there are no concurrent readers while updating opp_table */
	WARN_ON(!list_empty(&opp_table->opp_list));
1151

1152
	if (!opp_table->supported_hw) {
1153 1154 1155
		pr_err("%s: Doesn't have supported hardware list\n",
		       __func__);
		return;
1156 1157
	}

1158 1159 1160
	kfree(opp_table->supported_hw);
	opp_table->supported_hw = NULL;
	opp_table->supported_hw_count = 0;
1161

1162
	dev_pm_opp_put_opp_table(opp_table);
1163 1164 1165
}
EXPORT_SYMBOL_GPL(dev_pm_opp_put_supported_hw);

1166 1167
/**
 * dev_pm_opp_set_prop_name() - Set prop-extn name
V
Viresh Kumar 已提交
1168
 * @dev: Device for which the prop-name has to be set.
1169 1170 1171 1172 1173 1174 1175
 * @name: name to postfix to properties.
 *
 * This is required only for the V2 bindings, and it enables a platform to
 * specify the extn to be used for certain property names. The properties to
 * which the extension will apply are opp-microvolt and opp-microamp. OPP core
 * should postfix the property name with -<name> while looking for them.
 */
1176
struct opp_table *dev_pm_opp_set_prop_name(struct device *dev, const char *name)
1177
{
1178
	struct opp_table *opp_table;
1179
	int ret;
1180

1181 1182 1183
	opp_table = dev_pm_opp_get_opp_table(dev);
	if (!opp_table)
		return ERR_PTR(-ENOMEM);
1184

1185 1186
	/* Make sure there are no concurrent readers while updating opp_table */
	WARN_ON(!list_empty(&opp_table->opp_list));
1187

1188 1189
	/* Do we already have a prop-name associated with opp_table? */
	if (opp_table->prop_name) {
1190
		dev_err(dev, "%s: Already have prop-name %s\n", __func__,
1191
			opp_table->prop_name);
1192 1193 1194 1195
		ret = -EBUSY;
		goto err;
	}

1196 1197
	opp_table->prop_name = kstrdup(name, GFP_KERNEL);
	if (!opp_table->prop_name) {
1198 1199 1200 1201
		ret = -ENOMEM;
		goto err;
	}

1202
	return opp_table;
1203 1204

err:
1205
	dev_pm_opp_put_opp_table(opp_table);
1206

1207
	return ERR_PTR(ret);
1208 1209 1210 1211 1212
}
EXPORT_SYMBOL_GPL(dev_pm_opp_set_prop_name);

/**
 * dev_pm_opp_put_prop_name() - Releases resources blocked for prop-name
1213
 * @opp_table: OPP table returned by dev_pm_opp_set_prop_name().
1214 1215
 *
 * This is required only for the V2 bindings, and is called for a matching
1216
 * dev_pm_opp_set_prop_name(). Until this is called, the opp_table structure
1217 1218
 * will not be freed.
 */
1219
void dev_pm_opp_put_prop_name(struct opp_table *opp_table)
1220
{
1221 1222
	/* Make sure there are no concurrent readers while updating opp_table */
	WARN_ON(!list_empty(&opp_table->opp_list));
1223

1224
	if (!opp_table->prop_name) {
1225 1226
		pr_err("%s: Doesn't have a prop-name\n", __func__);
		return;
1227 1228
	}

1229 1230
	kfree(opp_table->prop_name);
	opp_table->prop_name = NULL;
1231

1232
	dev_pm_opp_put_opp_table(opp_table);
1233 1234 1235
}
EXPORT_SYMBOL_GPL(dev_pm_opp_put_prop_name);

1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267
static int _allocate_set_opp_data(struct opp_table *opp_table)
{
	struct dev_pm_set_opp_data *data;
	int len, count = opp_table->regulator_count;

	if (WARN_ON(!count))
		return -EINVAL;

	/* space for set_opp_data */
	len = sizeof(*data);

	/* space for old_opp.supplies and new_opp.supplies */
	len += 2 * sizeof(struct dev_pm_opp_supply) * count;

	data = kzalloc(len, GFP_KERNEL);
	if (!data)
		return -ENOMEM;

	data->old_opp.supplies = (void *)(data + 1);
	data->new_opp.supplies = data->old_opp.supplies + count;

	opp_table->set_opp_data = data;

	return 0;
}

static void _free_set_opp_data(struct opp_table *opp_table)
{
	kfree(opp_table->set_opp_data);
	opp_table->set_opp_data = NULL;
}

1268
/**
1269
 * dev_pm_opp_set_regulators() - Set regulator names for the device
1270
 * @dev: Device for which regulator name is being set.
1271 1272
 * @names: Array of pointers to the names of the regulator.
 * @count: Number of regulators.
1273 1274
 *
 * In order to support OPP switching, OPP layer needs to know the name of the
1275 1276
 * device's regulators, as the core would be required to switch voltages as
 * well.
1277 1278 1279
 *
 * This must be called before any OPPs are initialized for the device.
 */
1280 1281 1282
struct opp_table *dev_pm_opp_set_regulators(struct device *dev,
					    const char * const names[],
					    unsigned int count)
1283
{
1284
	struct opp_table *opp_table;
1285
	struct regulator *reg;
1286
	int ret, i;
1287

1288 1289 1290
	opp_table = dev_pm_opp_get_opp_table(dev);
	if (!opp_table)
		return ERR_PTR(-ENOMEM);
1291 1292

	/* This should be called before OPPs are initialized */
1293
	if (WARN_ON(!list_empty(&opp_table->opp_list))) {
1294 1295 1296 1297
		ret = -EBUSY;
		goto err;
	}

1298
	/* Already have regulators set */
1299
	if (opp_table->regulators) {
1300 1301 1302
		ret = -EBUSY;
		goto err;
	}
1303 1304 1305 1306 1307 1308

	opp_table->regulators = kmalloc_array(count,
					      sizeof(*opp_table->regulators),
					      GFP_KERNEL);
	if (!opp_table->regulators) {
		ret = -ENOMEM;
1309 1310 1311
		goto err;
	}

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
	for (i = 0; i < count; i++) {
		reg = regulator_get_optional(dev, names[i]);
		if (IS_ERR(reg)) {
			ret = PTR_ERR(reg);
			if (ret != -EPROBE_DEFER)
				dev_err(dev, "%s: no regulator (%s) found: %d\n",
					__func__, names[i], ret);
			goto free_regulators;
		}

		opp_table->regulators[i] = reg;
	}

	opp_table->regulator_count = count;
1326

1327 1328 1329 1330 1331
	/* Allocate block only once to pass to set_opp() routines */
	ret = _allocate_set_opp_data(opp_table);
	if (ret)
		goto free_regulators;

1332
	return opp_table;
1333

1334 1335 1336 1337 1338 1339
free_regulators:
	while (i != 0)
		regulator_put(opp_table->regulators[--i]);

	kfree(opp_table->regulators);
	opp_table->regulators = NULL;
1340
	opp_table->regulator_count = 0;
1341
err:
1342
	dev_pm_opp_put_opp_table(opp_table);
1343

1344
	return ERR_PTR(ret);
1345
}
1346
EXPORT_SYMBOL_GPL(dev_pm_opp_set_regulators);
1347 1348

/**
1349 1350
 * dev_pm_opp_put_regulators() - Releases resources blocked for regulator
 * @opp_table: OPP table returned from dev_pm_opp_set_regulators().
1351
 */
1352
void dev_pm_opp_put_regulators(struct opp_table *opp_table)
1353
{
1354 1355 1356 1357
	int i;

	if (!opp_table->regulators) {
		pr_err("%s: Doesn't have regulators set\n", __func__);
1358
		return;
1359 1360
	}

1361 1362
	/* Make sure there are no concurrent readers while updating opp_table */
	WARN_ON(!list_empty(&opp_table->opp_list));
1363

1364 1365 1366
	for (i = opp_table->regulator_count - 1; i >= 0; i--)
		regulator_put(opp_table->regulators[i]);

1367 1368
	_free_set_opp_data(opp_table);

1369 1370 1371
	kfree(opp_table->regulators);
	opp_table->regulators = NULL;
	opp_table->regulator_count = 0;
1372

1373
	dev_pm_opp_put_opp_table(opp_table);
1374
}
1375
EXPORT_SYMBOL_GPL(dev_pm_opp_put_regulators);
1376

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
/**
 * dev_pm_opp_register_set_opp_helper() - Register custom set OPP helper
 * @dev: Device for which the helper is getting registered.
 * @set_opp: Custom set OPP helper.
 *
 * This is useful to support complex platforms (like platforms with multiple
 * regulators per device), instead of the generic OPP set rate helper.
 *
 * This must be called before any OPPs are initialized for the device.
 */
1387
struct opp_table *dev_pm_opp_register_set_opp_helper(struct device *dev,
1388 1389 1390 1391 1392 1393
			int (*set_opp)(struct dev_pm_set_opp_data *data))
{
	struct opp_table *opp_table;
	int ret;

	if (!set_opp)
1394
		return ERR_PTR(-EINVAL);
1395

1396 1397 1398
	opp_table = dev_pm_opp_get_opp_table(dev);
	if (!opp_table)
		return ERR_PTR(-ENOMEM);
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413

	/* This should be called before OPPs are initialized */
	if (WARN_ON(!list_empty(&opp_table->opp_list))) {
		ret = -EBUSY;
		goto err;
	}

	/* Already have custom set_opp helper */
	if (WARN_ON(opp_table->set_opp)) {
		ret = -EBUSY;
		goto err;
	}

	opp_table->set_opp = set_opp;

1414
	return opp_table;
1415 1416

err:
1417
	dev_pm_opp_put_opp_table(opp_table);
1418

1419
	return ERR_PTR(ret);
1420 1421 1422 1423 1424 1425
}
EXPORT_SYMBOL_GPL(dev_pm_opp_register_set_opp_helper);

/**
 * dev_pm_opp_register_put_opp_helper() - Releases resources blocked for
 *					   set_opp helper
1426
 * @opp_table: OPP table returned from dev_pm_opp_register_set_opp_helper().
1427
 *
1428
 * Release resources blocked for platform specific set_opp helper.
1429
 */
1430
void dev_pm_opp_register_put_opp_helper(struct opp_table *opp_table)
1431 1432
{
	if (!opp_table->set_opp) {
1433 1434 1435
		pr_err("%s: Doesn't have custom set_opp helper set\n",
		       __func__);
		return;
1436 1437 1438 1439 1440 1441 1442
	}

	/* Make sure there are no concurrent readers while updating opp_table */
	WARN_ON(!list_empty(&opp_table->opp_list));

	opp_table->set_opp = NULL;

1443
	dev_pm_opp_put_opp_table(opp_table);
1444 1445 1446
}
EXPORT_SYMBOL_GPL(dev_pm_opp_register_put_opp_helper);

1447 1448 1449 1450 1451 1452
/**
 * dev_pm_opp_add()  - Add an OPP table from a table definitions
 * @dev:	device for which we do this operation
 * @freq:	Frequency in Hz for this OPP
 * @u_volt:	Voltage in uVolts for this OPP
 *
1453
 * This function adds an opp definition to the opp table and returns status.
1454 1455 1456 1457
 * The opp is made available by default and it can be controlled using
 * dev_pm_opp_enable/disable functions.
 *
 * Return:
1458
 * 0		On success OR
1459
 *		Duplicate OPPs (both freq and volt are same) and opp->available
1460
 * -EEXIST	Freq are same and volt are different OR
1461
 *		Duplicate OPPs (both freq and volt are same) and !opp->available
1462
 * -ENOMEM	Memory allocation failure
1463 1464 1465
 */
int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
{
1466 1467 1468
	struct opp_table *opp_table;
	int ret;

1469 1470 1471
	opp_table = dev_pm_opp_get_opp_table(dev);
	if (!opp_table)
		return -ENOMEM;
1472 1473 1474

	ret = _opp_add_v1(opp_table, dev, freq, u_volt, true);

1475
	dev_pm_opp_put_opp_table(opp_table);
1476
	return ret;
1477
}
1478
EXPORT_SYMBOL_GPL(dev_pm_opp_add);
1479 1480

/**
1481
 * _opp_set_availability() - helper to set the availability of an opp
1482 1483 1484 1485
 * @dev:		device for which we do this operation
 * @freq:		OPP frequency to modify availability
 * @availability_req:	availability status requested for this opp
 *
1486 1487
 * Set the availability of an OPP, opp_{enable,disable} share a common logic
 * which is isolated here.
1488
 *
1489
 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1490
 * copy operation, returns 0 if no modification was done OR modification was
1491 1492
 * successful.
 */
1493 1494
static int _opp_set_availability(struct device *dev, unsigned long freq,
				 bool availability_req)
1495
{
1496
	struct opp_table *opp_table;
1497
	struct dev_pm_opp *tmp_opp, *opp = ERR_PTR(-ENODEV);
1498 1499
	int r = 0;

1500 1501 1502 1503
	/* Find the opp_table */
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table)) {
		r = PTR_ERR(opp_table);
1504
		dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
1505
		return r;
1506 1507
	}

V
Viresh Kumar 已提交
1508 1509
	mutex_lock(&opp_table->lock);

1510
	/* Do we have the frequency? */
1511
	list_for_each_entry(tmp_opp, &opp_table->opp_list, node) {
1512 1513 1514 1515 1516
		if (tmp_opp->rate == freq) {
			opp = tmp_opp;
			break;
		}
	}
V
Viresh Kumar 已提交
1517

1518 1519 1520 1521 1522 1523 1524 1525 1526
	if (IS_ERR(opp)) {
		r = PTR_ERR(opp);
		goto unlock;
	}

	/* Is update really needed? */
	if (opp->available == availability_req)
		goto unlock;

1527
	opp->available = availability_req;
1528

1529 1530
	/* Notify the change of the OPP availability */
	if (availability_req)
1531
		blocking_notifier_call_chain(&opp_table->head, OPP_EVENT_ENABLE,
1532
					     opp);
1533
	else
1534
		blocking_notifier_call_chain(&opp_table->head,
1535
					     OPP_EVENT_DISABLE, opp);
1536 1537

unlock:
1538 1539
	mutex_unlock(&opp_table->lock);
	dev_pm_opp_put_opp_table(opp_table);
1540 1541 1542 1543
	return r;
}

/**
1544
 * dev_pm_opp_enable() - Enable a specific OPP
1545 1546 1547 1548 1549
 * @dev:	device for which we do this operation
 * @freq:	OPP frequency to enable
 *
 * Enables a provided opp. If the operation is valid, this returns 0, else the
 * corresponding error value. It is meant to be used for users an OPP available
1550
 * after being temporarily made unavailable with dev_pm_opp_disable.
1551
 *
1552
 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1553
 * copy operation, returns 0 if no modification was done OR modification was
1554
 * successful.
1555
 */
1556
int dev_pm_opp_enable(struct device *dev, unsigned long freq)
1557
{
1558
	return _opp_set_availability(dev, freq, true);
1559
}
1560
EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
1561 1562

/**
1563
 * dev_pm_opp_disable() - Disable a specific OPP
1564 1565 1566 1567 1568 1569
 * @dev:	device for which we do this operation
 * @freq:	OPP frequency to disable
 *
 * Disables a provided opp. If the operation is valid, this returns
 * 0, else the corresponding error value. It is meant to be a temporary
 * control by users to make this OPP not available until the circumstances are
1570
 * right to make it available again (with a call to dev_pm_opp_enable).
1571
 *
1572
 * Return: -EINVAL for bad pointers, -ENOMEM if no memory available for the
1573
 * copy operation, returns 0 if no modification was done OR modification was
1574
 * successful.
1575
 */
1576
int dev_pm_opp_disable(struct device *dev, unsigned long freq)
1577
{
1578
	return _opp_set_availability(dev, freq, false);
1579
}
1580
EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
1581

1582
/**
1583 1584 1585
 * dev_pm_opp_register_notifier() - Register OPP notifier for the device
 * @dev:	Device for which notifier needs to be registered
 * @nb:		Notifier block to be registered
1586
 *
1587 1588 1589 1590 1591 1592 1593 1594
 * Return: 0 on success or a negative error value.
 */
int dev_pm_opp_register_notifier(struct device *dev, struct notifier_block *nb)
{
	struct opp_table *opp_table;
	int ret;

	opp_table = _find_opp_table(dev);
1595 1596 1597
	if (IS_ERR(opp_table))
		return PTR_ERR(opp_table);

1598
	ret = blocking_notifier_chain_register(&opp_table->head, nb);
1599

1600
	dev_pm_opp_put_opp_table(opp_table);
1601 1602 1603 1604 1605 1606 1607 1608 1609

	return ret;
}
EXPORT_SYMBOL(dev_pm_opp_register_notifier);

/**
 * dev_pm_opp_unregister_notifier() - Unregister OPP notifier for the device
 * @dev:	Device for which notifier needs to be unregistered
 * @nb:		Notifier block to be unregistered
1610
 *
1611
 * Return: 0 on success or a negative error value.
1612
 */
1613 1614
int dev_pm_opp_unregister_notifier(struct device *dev,
				   struct notifier_block *nb)
1615
{
1616 1617
	struct opp_table *opp_table;
	int ret;
1618

1619
	opp_table = _find_opp_table(dev);
1620 1621
	if (IS_ERR(opp_table))
		return PTR_ERR(opp_table);
1622

1623
	ret = blocking_notifier_chain_unregister(&opp_table->head, nb);
1624

1625
	dev_pm_opp_put_opp_table(opp_table);
1626 1627

	return ret;
1628
}
1629
EXPORT_SYMBOL(dev_pm_opp_unregister_notifier);
1630

1631 1632 1633
/*
 * Free OPPs either created using static entries present in DT or even the
 * dynamically added entries based on remove_all param.
1634
 */
1635 1636
void _dev_pm_opp_remove_table(struct opp_table *opp_table, struct device *dev,
			      bool remove_all)
V
Viresh Kumar 已提交
1637 1638 1639
{
	struct dev_pm_opp *opp, *tmp;

1640 1641 1642 1643 1644
	/* Find if opp_table manages a single device */
	if (list_is_singular(&opp_table->dev_list)) {
		/* Free static OPPs */
		list_for_each_entry_safe(opp, tmp, &opp_table->opp_list, node) {
			if (remove_all || !opp->dynamic)
1645
				dev_pm_opp_put(opp);
1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
		}
	} else {
		_remove_opp_dev(_find_opp_dev(dev, opp_table), opp_table);
	}
}

void _dev_pm_opp_find_and_remove_table(struct device *dev, bool remove_all)
{
	struct opp_table *opp_table;

1656 1657 1658 1659
	/* Check for existing table for 'dev' */
	opp_table = _find_opp_table(dev);
	if (IS_ERR(opp_table)) {
		int error = PTR_ERR(opp_table);
V
Viresh Kumar 已提交
1660 1661

		if (error != -ENODEV)
1662
			WARN(1, "%s: opp_table: %d\n",
V
Viresh Kumar 已提交
1663 1664 1665
			     IS_ERR_OR_NULL(dev) ?
					"Invalid device" : dev_name(dev),
			     error);
1666
		return;
V
Viresh Kumar 已提交
1667 1668
	}

1669
	_dev_pm_opp_remove_table(opp_table, dev, remove_all);
V
Viresh Kumar 已提交
1670

1671
	dev_pm_opp_put_opp_table(opp_table);
V
Viresh Kumar 已提交
1672
}
1673 1674

/**
1675
 * dev_pm_opp_remove_table() - Free all OPPs associated with the device
1676
 * @dev:	device pointer used to lookup OPP table.
1677
 *
1678 1679
 * Free both OPPs created using static entries present in DT and the
 * dynamically added entries.
1680
 */
1681
void dev_pm_opp_remove_table(struct device *dev)
1682
{
1683
	_dev_pm_opp_find_and_remove_table(dev, true);
1684
}
1685
EXPORT_SYMBOL_GPL(dev_pm_opp_remove_table);