opp.c 24.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * 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.
 */

#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/err.h>
#include <linux/slab.h>
18
#include <linux/device.h>
19 20 21
#include <linux/list.h>
#include <linux/rculist.h>
#include <linux/rcupdate.h>
22
#include <linux/pm_opp.h>
23
#include <linux/of.h>
24
#include <linux/export.h>
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

/*
 * Internal data structure organization with the OPP layer library is as
 * follows:
 * dev_opp_list (root)
 *	|- device 1 (represents voltage domain 1)
 *	|	|- opp 1 (availability, freq, voltage)
 *	|	|- opp 2 ..
 *	...	...
 *	|	`- opp n ..
 *	|- device 2 (represents the next voltage domain)
 *	...
 *	`- device m (represents mth voltage domain)
 * device 1, 2.. are represented by dev_opp structure while each opp
 * is represented by the opp structure.
 */

/**
43
 * struct dev_pm_opp - Generic OPP description structure
44 45 46 47 48 49 50 51
 * @node:	opp list node. The nodes are maintained throughout the lifetime
 *		of boot. It is expected only an optimal set of OPPs are
 *		added to the library by the SoC framework.
 *		RCU usage: opp list is traversed with RCU locks. node
 *		modification is possible realtime, hence the modifications
 *		are protected by the dev_opp_list_lock for integrity.
 *		IMPORTANT: the opp nodes should be maintained in increasing
 *		order.
52
 * @dynamic:	not-created from static DT entries.
53 54 55 56
 * @available:	true/false - marks if this OPP as available or not
 * @rate:	Frequency in hertz
 * @u_volt:	Nominal voltage in microvolts corresponding to this OPP
 * @dev_opp:	points back to the device_opp struct this opp belongs to
57
 * @rcu_head:	RCU callback head used for deferred freeing
58 59 60
 *
 * This structure stores the OPP information for a given device.
 */
61
struct dev_pm_opp {
62 63 64
	struct list_head node;

	bool available;
65
	bool dynamic;
66 67 68 69
	unsigned long rate;
	unsigned long u_volt;

	struct device_opp *dev_opp;
70
	struct rcu_head rcu_head;
71 72 73 74 75 76 77 78 79 80
};

/**
 * struct device_opp - Device opp structure
 * @node:	list node - contains the devices with OPPs that
 *		have been registered. Nodes once added are not modified in this
 *		list.
 *		RCU usage: nodes are not modified in the list of device_opp,
 *		however addition is possible and is secured by dev_opp_list_lock
 * @dev:	device pointer
81
 * @srcu_head:	notifier head to notify the OPP availability changes.
82
 * @rcu_head:	RCU callback head used for deferred freeing
83 84 85 86
 * @opp_list:	list of opps
 *
 * This is an internal data structure maintaining the link to opps attached to
 * a device. This structure is not meant to be shared to users as it is
87 88 89 90 91
 * meant for book keeping and private to OPP library.
 *
 * Because the opp structures can be used from both rcu and srcu readers, we
 * need to wait for the grace period of both of them before freeing any
 * resources. And so we have used kfree_rcu() from within call_srcu() handlers.
92 93 94 95 96
 */
struct device_opp {
	struct list_head node;

	struct device *dev;
97
	struct srcu_notifier_head srcu_head;
98
	struct rcu_head rcu_head;
99 100 101 102 103 104 105 106 107 108 109 110
	struct list_head opp_list;
};

/*
 * The root of the list of all devices. All device_opp structures branch off
 * from here, with each device_opp containing the list of opp it supports in
 * various states of availability.
 */
static LIST_HEAD(dev_opp_list);
/* Lock to allow exclusive modification to the device and opp lists */
static DEFINE_MUTEX(dev_opp_list_lock);

111 112 113 114 115 116 117 118
#define opp_rcu_lockdep_assert()					\
do {									\
	rcu_lockdep_assert(rcu_read_lock_held() ||			\
				lockdep_is_held(&dev_opp_list_lock),	\
			   "Missing rcu_read_lock() or "		\
			   "dev_opp_list_lock protection");		\
} while (0)

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
/**
 * find_device_opp() - find device_opp struct using device pointer
 * @dev:	device pointer used to lookup device OPPs
 *
 * Search list of device OPPs for one containing matching device. Does a RCU
 * reader operation to grab the pointer needed.
 *
 * Returns pointer to 'struct device_opp' if found, otherwise -ENODEV or
 * -EINVAL based on type of error.
 *
 * Locking: This function must be called under rcu_read_lock(). device_opp
 * is a RCU protected pointer. This means that device_opp is valid as long
 * as we are under RCU lock.
 */
static struct device_opp *find_device_opp(struct device *dev)
{
	struct device_opp *tmp_dev_opp, *dev_opp = ERR_PTR(-ENODEV);

	if (unlikely(IS_ERR_OR_NULL(dev))) {
		pr_err("%s: Invalid parameters\n", __func__);
		return ERR_PTR(-EINVAL);
	}

	list_for_each_entry_rcu(tmp_dev_opp, &dev_opp_list, node) {
		if (tmp_dev_opp->dev == dev) {
			dev_opp = tmp_dev_opp;
			break;
		}
	}

	return dev_opp;
}

/**
153
 * dev_pm_opp_get_voltage() - Gets the voltage corresponding to an available opp
154 155 156 157 158 159 160 161 162 163 164 165 166
 * @opp:	opp for which voltage has to be returned for
 *
 * Return voltage in micro volt corresponding to the opp, else
 * return 0
 *
 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
 * protected pointer. This means that opp which could have been fetched by
 * opp_find_freq_{exact,ceil,floor} functions is valid as long as we are
 * under RCU lock. The pointer returned by the opp_find_freq family must be
 * used in the same section as the usage of this function with the pointer
 * prior to unlocking with rcu_read_unlock() to maintain the integrity of the
 * pointer.
 */
167
unsigned long dev_pm_opp_get_voltage(struct dev_pm_opp *opp)
168
{
169
	struct dev_pm_opp *tmp_opp;
170 171 172 173 174 175 176 177 178 179
	unsigned long v = 0;

	tmp_opp = rcu_dereference(opp);
	if (unlikely(IS_ERR_OR_NULL(tmp_opp)) || !tmp_opp->available)
		pr_err("%s: Invalid parameters\n", __func__);
	else
		v = tmp_opp->u_volt;

	return v;
}
180
EXPORT_SYMBOL_GPL(dev_pm_opp_get_voltage);
181 182

/**
183
 * dev_pm_opp_get_freq() - Gets the frequency corresponding to an available opp
184 185 186 187 188 189 190 191 192 193 194 195 196
 * @opp:	opp for which frequency has to be returned for
 *
 * Return frequency in hertz corresponding to the opp, else
 * return 0
 *
 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
 * protected pointer. This means that opp which could have been fetched by
 * opp_find_freq_{exact,ceil,floor} functions is valid as long as we are
 * under RCU lock. The pointer returned by the opp_find_freq family must be
 * used in the same section as the usage of this function with the pointer
 * prior to unlocking with rcu_read_unlock() to maintain the integrity of the
 * pointer.
 */
197
unsigned long dev_pm_opp_get_freq(struct dev_pm_opp *opp)
198
{
199
	struct dev_pm_opp *tmp_opp;
200 201 202 203 204 205 206 207 208 209
	unsigned long f = 0;

	tmp_opp = rcu_dereference(opp);
	if (unlikely(IS_ERR_OR_NULL(tmp_opp)) || !tmp_opp->available)
		pr_err("%s: Invalid parameters\n", __func__);
	else
		f = tmp_opp->rate;

	return f;
}
210
EXPORT_SYMBOL_GPL(dev_pm_opp_get_freq);
211 212

/**
213
 * dev_pm_opp_get_opp_count() - Get number of opps available in the opp list
214 215 216 217 218
 * @dev:	device for which we do this operation
 *
 * This function returns the number of available opps if there are any,
 * else returns 0 if none or the corresponding error value.
 *
219
 * Locking: This function takes rcu_read_lock().
220
 */
221
int dev_pm_opp_get_opp_count(struct device *dev)
222 223
{
	struct device_opp *dev_opp;
224
	struct dev_pm_opp *temp_opp;
225 226
	int count = 0;

227
	rcu_read_lock();
228

229 230
	dev_opp = find_device_opp(dev);
	if (IS_ERR(dev_opp)) {
231 232 233 234
		count = PTR_ERR(dev_opp);
		dev_err(dev, "%s: device OPP not found (%d)\n",
			__func__, count);
		goto out_unlock;
235 236 237 238 239 240 241
	}

	list_for_each_entry_rcu(temp_opp, &dev_opp->opp_list, node) {
		if (temp_opp->available)
			count++;
	}

242 243
out_unlock:
	rcu_read_unlock();
244 245
	return count;
}
246
EXPORT_SYMBOL_GPL(dev_pm_opp_get_opp_count);
247 248

/**
249
 * dev_pm_opp_find_freq_exact() - search for an exact frequency
250 251
 * @dev:		device for which we do this operation
 * @freq:		frequency to search for
252
 * @available:		true/false - match for available opp
253 254 255
 *
 * Searches for exact match in the opp list and returns pointer to the matching
 * opp if found, else returns ERR_PTR in case of error and should be handled
256 257 258 259
 * 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
260 261 262 263 264 265 266 267 268 269 270 271 272 273
 *
 * 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.
 *
 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
 * protected pointer. The reason for the same is that the opp pointer which is
 * returned will remain valid for use with opp_get_{voltage, freq} only while
 * under the locked area. The pointer returned must be used prior to unlocking
 * with rcu_read_unlock() to maintain the integrity of the pointer.
 */
274 275 276
struct dev_pm_opp *dev_pm_opp_find_freq_exact(struct device *dev,
					      unsigned long freq,
					      bool available)
277 278
{
	struct device_opp *dev_opp;
279
	struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
280

281 282
	opp_rcu_lockdep_assert();

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
	dev_opp = find_device_opp(dev);
	if (IS_ERR(dev_opp)) {
		int r = PTR_ERR(dev_opp);
		dev_err(dev, "%s: device OPP not found (%d)\n", __func__, r);
		return ERR_PTR(r);
	}

	list_for_each_entry_rcu(temp_opp, &dev_opp->opp_list, node) {
		if (temp_opp->available == available &&
				temp_opp->rate == freq) {
			opp = temp_opp;
			break;
		}
	}

	return opp;
}
300
EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_exact);
301 302

/**
303
 * dev_pm_opp_find_freq_ceil() - Search for an rounded ceil freq
304 305 306 307 308 309 310
 * @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.
 *
 * Returns matching *opp and refreshes *freq accordingly, else returns
311 312 313 314 315
 * 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
316 317 318 319 320 321 322
 *
 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
 * protected pointer. The reason for the same is that the opp pointer which is
 * returned will remain valid for use with opp_get_{voltage, freq} only while
 * under the locked area. The pointer returned must be used prior to unlocking
 * with rcu_read_unlock() to maintain the integrity of the pointer.
 */
323 324
struct dev_pm_opp *dev_pm_opp_find_freq_ceil(struct device *dev,
					     unsigned long *freq)
325 326
{
	struct device_opp *dev_opp;
327
	struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
328

329 330
	opp_rcu_lockdep_assert();

331 332 333 334 335 336 337
	if (!dev || !freq) {
		dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
		return ERR_PTR(-EINVAL);
	}

	dev_opp = find_device_opp(dev);
	if (IS_ERR(dev_opp))
338
		return ERR_CAST(dev_opp);
339 340 341 342 343 344 345 346 347 348 349

	list_for_each_entry_rcu(temp_opp, &dev_opp->opp_list, node) {
		if (temp_opp->available && temp_opp->rate >= *freq) {
			opp = temp_opp;
			*freq = opp->rate;
			break;
		}
	}

	return opp;
}
350
EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_ceil);
351 352

/**
353
 * dev_pm_opp_find_freq_floor() - Search for a rounded floor freq
354 355 356 357 358 359 360
 * @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.
 *
 * Returns matching *opp and refreshes *freq accordingly, else returns
361 362 363 364 365
 * 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
366 367 368 369 370 371 372
 *
 * Locking: This function must be called under rcu_read_lock(). opp is a rcu
 * protected pointer. The reason for the same is that the opp pointer which is
 * returned will remain valid for use with opp_get_{voltage, freq} only while
 * under the locked area. The pointer returned must be used prior to unlocking
 * with rcu_read_unlock() to maintain the integrity of the pointer.
 */
373 374
struct dev_pm_opp *dev_pm_opp_find_freq_floor(struct device *dev,
					      unsigned long *freq)
375 376
{
	struct device_opp *dev_opp;
377
	struct dev_pm_opp *temp_opp, *opp = ERR_PTR(-ERANGE);
378

379 380
	opp_rcu_lockdep_assert();

381 382 383 384 385 386 387
	if (!dev || !freq) {
		dev_err(dev, "%s: Invalid argument freq=%p\n", __func__, freq);
		return ERR_PTR(-EINVAL);
	}

	dev_opp = find_device_opp(dev);
	if (IS_ERR(dev_opp))
388
		return ERR_CAST(dev_opp);
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403

	list_for_each_entry_rcu(temp_opp, &dev_opp->opp_list, node) {
		if (temp_opp->available) {
			/* go to the next node, before choosing prev */
			if (temp_opp->rate > *freq)
				break;
			else
				opp = temp_opp;
		}
	}
	if (!IS_ERR(opp))
		*freq = opp->rate;

	return opp;
}
404
EXPORT_SYMBOL_GPL(dev_pm_opp_find_freq_floor);
405

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
static struct device_opp *add_device_opp(struct device *dev)
{
	struct device_opp *dev_opp;

	/*
	 * Allocate a new device OPP table. In the infrequent case where a new
	 * device is needed to be added, we pay this penalty.
	 */
	dev_opp = kzalloc(sizeof(*dev_opp), GFP_KERNEL);
	if (!dev_opp)
		return NULL;

	dev_opp->dev = dev;
	srcu_init_notifier_head(&dev_opp->srcu_head);
	INIT_LIST_HEAD(&dev_opp->opp_list);

	/* Secure the device list modification */
	list_add_rcu(&dev_opp->node, &dev_opp_list);
	return dev_opp;
}

427 428
static int dev_pm_opp_add_dynamic(struct device *dev, unsigned long freq,
				  unsigned long u_volt, bool dynamic)
429 430
{
	struct device_opp *dev_opp = NULL;
431
	struct dev_pm_opp *opp, *new_opp;
432
	struct list_head *head;
433
	int ret;
434 435

	/* allocate new OPP node */
436
	new_opp = kzalloc(sizeof(*new_opp), GFP_KERNEL);
437 438 439 440 441 442 443 444
	if (!new_opp) {
		dev_warn(dev, "%s: Unable to create new OPP node\n", __func__);
		return -ENOMEM;
	}

	/* Hold our list modification lock here */
	mutex_lock(&dev_opp_list_lock);

445 446 447 448
	/* populate the opp table */
	new_opp->rate = freq;
	new_opp->u_volt = u_volt;
	new_opp->available = true;
449
	new_opp->dynamic = dynamic;
450

451 452 453
	/* Check for existing list for 'dev' */
	dev_opp = find_device_opp(dev);
	if (IS_ERR(dev_opp)) {
454
		dev_opp = add_device_opp(dev);
455
		if (!dev_opp) {
456 457
			ret = -ENOMEM;
			goto free_opp;
458 459
		}

460 461
		head = &dev_opp->opp_list;
		goto list_add;
462 463
	}

464 465 466 467
	/*
	 * Insert new OPP in order of increasing frequency
	 * and discard if already present
	 */
468 469
	head = &dev_opp->opp_list;
	list_for_each_entry_rcu(opp, &dev_opp->opp_list, node) {
470
		if (new_opp->rate <= opp->rate)
471 472 473 474 475
			break;
		else
			head = &opp->node;
	}

476 477
	/* Duplicate OPPs ? */
	if (new_opp->rate == opp->rate) {
478
		ret = opp->available && new_opp->u_volt == opp->u_volt ?
479 480 481 482 483
			0 : -EEXIST;

		dev_warn(dev, "%s: duplicate OPPs detected. Existing: freq: %lu, volt: %lu, enabled: %d. New: freq: %lu, volt: %lu, enabled: %d\n",
			 __func__, opp->rate, opp->u_volt, opp->available,
			 new_opp->rate, new_opp->u_volt, new_opp->available);
484
		goto free_opp;
485 486
	}

487
list_add:
488
	new_opp->dev_opp = dev_opp;
489 490 491
	list_add_rcu(&new_opp->node, head);
	mutex_unlock(&dev_opp_list_lock);

492 493 494 495
	/*
	 * Notify the changes in the availability of the operable
	 * frequency/voltage list.
	 */
496
	srcu_notifier_call_chain(&dev_opp->srcu_head, OPP_EVENT_ADD, new_opp);
497
	return 0;
498 499 500 501 502

free_opp:
	mutex_unlock(&dev_opp_list_lock);
	kfree(new_opp);
	return ret;
503
}
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531

/**
 * 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
 *
 * This function adds an opp definition to the opp list and returns status.
 * The opp is made available by default and it can be controlled using
 * dev_pm_opp_enable/disable functions.
 *
 * Locking: The internal device_opp and opp structures are RCU protected.
 * Hence this function internally uses RCU updater strategy with mutex locks
 * to keep the integrity of the internal data structures. Callers should ensure
 * that this function is *NOT* called under RCU protection or in contexts where
 * mutex cannot be locked.
 *
 * 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
 */
int dev_pm_opp_add(struct device *dev, unsigned long freq, unsigned long u_volt)
{
	return dev_pm_opp_add_dynamic(dev, freq, u_volt, true);
}
532
EXPORT_SYMBOL_GPL(dev_pm_opp_add);
533

534 535 536 537 538 539 540 541 542 543 544
static void kfree_opp_rcu(struct rcu_head *head)
{
	struct dev_pm_opp *opp = container_of(head, struct dev_pm_opp, rcu_head);

	kfree_rcu(opp, rcu_head);
}

static void kfree_device_rcu(struct rcu_head *head)
{
	struct device_opp *device_opp = container_of(head, struct device_opp, rcu_head);

545
	kfree_rcu(device_opp, rcu_head);
546 547
}

548 549
static void __dev_pm_opp_remove(struct device_opp *dev_opp,
				struct dev_pm_opp *opp)
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 593 594 595 596 597 598 599 600 601 602 603 604
{
	/*
	 * Notify the changes in the availability of the operable
	 * frequency/voltage list.
	 */
	srcu_notifier_call_chain(&dev_opp->srcu_head, OPP_EVENT_REMOVE, opp);
	list_del_rcu(&opp->node);
	call_srcu(&dev_opp->srcu_head.srcu, &opp->rcu_head, kfree_opp_rcu);

	if (list_empty(&dev_opp->opp_list)) {
		list_del_rcu(&dev_opp->node);
		call_srcu(&dev_opp->srcu_head.srcu, &dev_opp->rcu_head,
			  kfree_device_rcu);
	}
}

/**
 * dev_pm_opp_remove()  - Remove an OPP from OPP list
 * @dev:	device for which we do this operation
 * @freq:	OPP to remove with matching 'freq'
 *
 * This function removes an opp from the opp list.
 */
void dev_pm_opp_remove(struct device *dev, unsigned long freq)
{
	struct dev_pm_opp *opp;
	struct device_opp *dev_opp;
	bool found = false;

	/* Hold our list modification lock here */
	mutex_lock(&dev_opp_list_lock);

	dev_opp = find_device_opp(dev);
	if (IS_ERR(dev_opp))
		goto unlock;

	list_for_each_entry(opp, &dev_opp->opp_list, node) {
		if (opp->rate == freq) {
			found = true;
			break;
		}
	}

	if (!found) {
		dev_warn(dev, "%s: Couldn't find OPP with freq: %lu\n",
			 __func__, freq);
		goto unlock;
	}

	__dev_pm_opp_remove(dev_opp, opp);
unlock:
	mutex_unlock(&dev_opp_list_lock);
}
EXPORT_SYMBOL_GPL(dev_pm_opp_remove);

605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
/**
 * opp_set_availability() - helper to set the availability of an opp
 * @dev:		device for which we do this operation
 * @freq:		OPP frequency to modify availability
 * @availability_req:	availability status requested for this opp
 *
 * Set the availability of an OPP with an RCU operation, opp_{enable,disable}
 * share a common logic which is isolated here.
 *
 * Returns -EINVAL for bad pointers, -ENOMEM if no memory available for the
 * copy operation, returns 0 if no modifcation was done OR modification was
 * successful.
 *
 * Locking: The internal device_opp and opp structures are RCU protected.
 * Hence this function internally uses RCU updater strategy with mutex locks to
 * keep the integrity of the internal data structures. Callers should ensure
 * that this function is *NOT* called under RCU protection or in contexts where
 * mutex locking or synchronize_rcu() blocking calls cannot be used.
 */
static int opp_set_availability(struct device *dev, unsigned long freq,
		bool availability_req)
{
627
	struct device_opp *dev_opp;
628
	struct dev_pm_opp *new_opp, *tmp_opp, *opp = ERR_PTR(-ENODEV);
629 630 631
	int r = 0;

	/* keep the node allocated */
632
	new_opp = kmalloc(sizeof(*new_opp), GFP_KERNEL);
633 634 635 636 637 638 639 640
	if (!new_opp) {
		dev_warn(dev, "%s: Unable to create OPP\n", __func__);
		return -ENOMEM;
	}

	mutex_lock(&dev_opp_list_lock);

	/* Find the device_opp */
641
	dev_opp = find_device_opp(dev);
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
	if (IS_ERR(dev_opp)) {
		r = PTR_ERR(dev_opp);
		dev_warn(dev, "%s: Device OPP not found (%d)\n", __func__, r);
		goto unlock;
	}

	/* Do we have the frequency? */
	list_for_each_entry(tmp_opp, &dev_opp->opp_list, node) {
		if (tmp_opp->rate == freq) {
			opp = tmp_opp;
			break;
		}
	}
	if (IS_ERR(opp)) {
		r = PTR_ERR(opp);
		goto unlock;
	}

	/* Is update really needed? */
	if (opp->available == availability_req)
		goto unlock;
	/* copy the old data over */
	*new_opp = *opp;

	/* plug in new node */
	new_opp->available = availability_req;

	list_replace_rcu(&opp->node, &new_opp->node);
	mutex_unlock(&dev_opp_list_lock);
671
	call_srcu(&dev_opp->srcu_head.srcu, &opp->rcu_head, kfree_opp_rcu);
672

673 674
	/* Notify the change of the OPP availability */
	if (availability_req)
675
		srcu_notifier_call_chain(&dev_opp->srcu_head, OPP_EVENT_ENABLE,
676 677
					 new_opp);
	else
678
		srcu_notifier_call_chain(&dev_opp->srcu_head, OPP_EVENT_DISABLE,
679 680
					 new_opp);

V
Vincent Guittot 已提交
681
	return 0;
682 683 684 685 686 687 688 689

unlock:
	mutex_unlock(&dev_opp_list_lock);
	kfree(new_opp);
	return r;
}

/**
690
 * dev_pm_opp_enable() - Enable a specific OPP
691 692 693 694 695
 * @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
696
 * after being temporarily made unavailable with dev_pm_opp_disable.
697 698 699 700 701 702 703
 *
 * Locking: The internal device_opp and opp structures are RCU protected.
 * Hence this function indirectly uses RCU and mutex locks to keep the
 * integrity of the internal data structures. Callers should ensure that
 * this function is *NOT* called under RCU protection or in contexts where
 * mutex locking or synchronize_rcu() blocking calls cannot be used.
 */
704
int dev_pm_opp_enable(struct device *dev, unsigned long freq)
705 706 707
{
	return opp_set_availability(dev, freq, true);
}
708
EXPORT_SYMBOL_GPL(dev_pm_opp_enable);
709 710

/**
711
 * dev_pm_opp_disable() - Disable a specific OPP
712 713 714 715 716 717
 * @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
718
 * right to make it available again (with a call to dev_pm_opp_enable).
719 720 721 722 723 724 725
 *
 * Locking: The internal device_opp and opp structures are RCU protected.
 * Hence this function indirectly uses RCU and mutex locks to keep the
 * integrity of the internal data structures. Callers should ensure that
 * this function is *NOT* called under RCU protection or in contexts where
 * mutex locking or synchronize_rcu() blocking calls cannot be used.
 */
726
int dev_pm_opp_disable(struct device *dev, unsigned long freq)
727 728 729
{
	return opp_set_availability(dev, freq, false);
}
730
EXPORT_SYMBOL_GPL(dev_pm_opp_disable);
731

732
/**
733
 * dev_pm_opp_get_notifier() - find notifier_head of the device with opp
734 735
 * @dev:	device pointer used to lookup device OPPs.
 */
736
struct srcu_notifier_head *dev_pm_opp_get_notifier(struct device *dev)
737 738 739 740
{
	struct device_opp *dev_opp = find_device_opp(dev);

	if (IS_ERR(dev_opp))
741
		return ERR_CAST(dev_opp); /* matching type */
742

743
	return &dev_opp->srcu_head;
744
}
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

#ifdef CONFIG_OF
/**
 * of_init_opp_table() - Initialize opp table from device tree
 * @dev:	device pointer used to lookup device OPPs.
 *
 * Register the initial OPP table with the OPP library for given device.
 */
int of_init_opp_table(struct device *dev)
{
	const struct property *prop;
	const __be32 *val;
	int nr;

	prop = of_find_property(dev->of_node, "operating-points", NULL);
	if (!prop)
		return -ENODEV;
	if (!prop->value)
		return -ENODATA;

	/*
	 * Each OPP is a set of tuples consisting of frequency and
	 * voltage like <freq-kHz vol-uV>.
	 */
	nr = prop->length / sizeof(u32);
	if (nr % 2) {
		dev_err(dev, "%s: Invalid OPP list\n", __func__);
		return -EINVAL;
	}

	val = prop->value;
	while (nr) {
		unsigned long freq = be32_to_cpup(val++) * 1000;
		unsigned long volt = be32_to_cpup(val++);

780
		if (dev_pm_opp_add_dynamic(dev, freq, volt, false))
781 782 783 784 785 786 787
			dev_warn(dev, "%s: Failed to add OPP %ld\n",
				 __func__, freq);
		nr -= 2;
	}

	return 0;
}
788
EXPORT_SYMBOL_GPL(of_init_opp_table);
789 790 791 792 793 794 795 796 797

/**
 * of_free_opp_table() - Free OPP table entries created from static DT entries
 * @dev:	device pointer used to lookup device OPPs.
 *
 * Free OPPs created using static entries present in DT.
 */
void of_free_opp_table(struct device *dev)
{
798
	struct device_opp *dev_opp;
799 800 801 802
	struct dev_pm_opp *opp, *tmp;

	/* Check for existing list for 'dev' */
	dev_opp = find_device_opp(dev);
803 804 805 806 807 808 809
	if (IS_ERR(dev_opp)) {
		int error = PTR_ERR(dev_opp);
		if (error != -ENODEV)
			WARN(1, "%s: dev_opp: %d\n",
			     IS_ERR_OR_NULL(dev) ?
					"Invalid device" : dev_name(dev),
			     error);
810
		return;
811
	}
812 813 814 815 816 817 818 819 820 821 822 823 824

	/* Hold our list modification lock here */
	mutex_lock(&dev_opp_list_lock);

	/* Free static OPPs */
	list_for_each_entry_safe(opp, tmp, &dev_opp->opp_list, node) {
		if (!opp->dynamic)
			__dev_pm_opp_remove(dev_opp, opp);
	}

	mutex_unlock(&dev_opp_list_lock);
}
EXPORT_SYMBOL_GPL(of_free_opp_table);
825
#endif