domain.c 47.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * drivers/base/power/domain.c - Common code related to device power domains.
 *
 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
 *
 * This file is released under the GPLv2.
 */

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/io.h>
#include <linux/pm_runtime.h>
#include <linux/pm_domain.h>
14
#include <linux/pm_qos.h>
15 16
#include <linux/slab.h>
#include <linux/err.h>
17 18
#include <linux/sched.h>
#include <linux/suspend.h>
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
#include <linux/export.h>

#define GENPD_DEV_CALLBACK(genpd, type, callback, dev)		\
({								\
	type (*__routine)(struct device *__d); 			\
	type __ret = (type)0;					\
								\
	__routine = genpd->dev_ops.callback; 			\
	if (__routine) {					\
		__ret = __routine(dev); 			\
	} else {						\
		__routine = dev_gpd_data(dev)->ops.callback;	\
		if (__routine) 					\
			__ret = __routine(dev);			\
	}							\
	__ret;							\
})
36

37 38 39 40 41
#define GENPD_DEV_TIMED_CALLBACK(genpd, type, callback, dev, field, name)	\
({										\
	ktime_t __start = ktime_get();						\
	type __retval = GENPD_DEV_CALLBACK(genpd, type, callback, dev);		\
	s64 __elapsed = ktime_to_ns(ktime_sub(ktime_get(), __start));		\
42 43 44
	struct gpd_timing_data *__td = &dev_gpd_data(dev)->td;			\
	if (!__retval && __elapsed > __td->field) {				\
		__td->field = __elapsed;					\
45 46
		dev_warn(dev, name " latency exceeded, new value %lld ns\n",	\
			__elapsed);						\
47 48
		genpd->max_off_time_changed = true;				\
		__td->constraint_changed = true;				\
49 50 51 52
	}									\
	__retval;								\
})

53 54 55
static LIST_HEAD(gpd_list);
static DEFINE_MUTEX(gpd_list_lock);

56 57
#ifdef CONFIG_PM

58
struct generic_pm_domain *dev_to_genpd(struct device *dev)
59 60 61 62
{
	if (IS_ERR_OR_NULL(dev->pm_domain))
		return ERR_PTR(-EINVAL);

63
	return pd_to_genpd(dev->pm_domain);
64
}
65

66 67
static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
{
68 69
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
					stop_latency_ns, "stop");
70 71 72 73
}

static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
{
74 75
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
					start_latency_ns, "start");
76 77
}

78 79
static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
{
80 81
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
					save_state_latency_ns, "state save");
82 83 84 85
}

static int genpd_restore_dev(struct generic_pm_domain *genpd, struct device *dev)
{
86 87 88
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, restore_state, dev,
					restore_state_latency_ns,
					"state restore");
89 90
}

91
static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
92
{
93 94 95 96 97 98 99 100 101 102 103 104
	bool ret = false;

	if (!WARN_ON(atomic_read(&genpd->sd_count) == 0))
		ret = !!atomic_dec_and_test(&genpd->sd_count);

	return ret;
}

static void genpd_sd_counter_inc(struct generic_pm_domain *genpd)
{
	atomic_inc(&genpd->sd_count);
	smp_mb__after_atomic_inc();
105 106
}

107 108 109 110 111 112 113 114 115 116 117 118
static void genpd_acquire_lock(struct generic_pm_domain *genpd)
{
	DEFINE_WAIT(wait);

	mutex_lock(&genpd->lock);
	/*
	 * Wait for the domain to transition into either the active,
	 * or the power off state.
	 */
	for (;;) {
		prepare_to_wait(&genpd->status_wait_queue, &wait,
				TASK_UNINTERRUPTIBLE);
119 120
		if (genpd->status == GPD_STATE_ACTIVE
		    || genpd->status == GPD_STATE_POWER_OFF)
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
			break;
		mutex_unlock(&genpd->lock);

		schedule();

		mutex_lock(&genpd->lock);
	}
	finish_wait(&genpd->status_wait_queue, &wait);
}

static void genpd_release_lock(struct generic_pm_domain *genpd)
{
	mutex_unlock(&genpd->lock);
}

136 137 138 139 140 141
static void genpd_set_active(struct generic_pm_domain *genpd)
{
	if (genpd->resume_count == 0)
		genpd->status = GPD_STATE_ACTIVE;
}

142
/**
143
 * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
144 145
 * @genpd: PM domain to power up.
 *
146
 * Restore power to @genpd and all of its masters so that it is possible to
147 148
 * resume a device belonging to it.
 */
149 150
int __pm_genpd_poweron(struct generic_pm_domain *genpd)
	__releases(&genpd->lock) __acquires(&genpd->lock)
151
{
152
	struct gpd_link *link;
153
	DEFINE_WAIT(wait);
154 155
	int ret = 0;

156
	/* If the domain's master is being waited for, we have to wait too. */
157 158 159
	for (;;) {
		prepare_to_wait(&genpd->status_wait_queue, &wait,
				TASK_UNINTERRUPTIBLE);
160
		if (genpd->status != GPD_STATE_WAIT_MASTER)
161 162
			break;
		mutex_unlock(&genpd->lock);
163

164 165 166 167 168
		schedule();

		mutex_lock(&genpd->lock);
	}
	finish_wait(&genpd->status_wait_queue, &wait);
169

170
	if (genpd->status == GPD_STATE_ACTIVE
171
	    || (genpd->prepared_count > 0 && genpd->suspend_power_off))
172
		return 0;
173

174 175
	if (genpd->status != GPD_STATE_POWER_OFF) {
		genpd_set_active(genpd);
176
		return 0;
177 178
	}

179 180 181 182 183 184 185
	/*
	 * The list is guaranteed not to change while the loop below is being
	 * executed, unless one of the masters' .power_on() callbacks fiddles
	 * with it.
	 */
	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_inc(link->master);
186
		genpd->status = GPD_STATE_WAIT_MASTER;
187

188 189
		mutex_unlock(&genpd->lock);

190
		ret = pm_genpd_poweron(link->master);
191 192 193

		mutex_lock(&genpd->lock);

194 195
		/*
		 * The "wait for parent" status is guaranteed not to change
196
		 * while the master is powering on.
197 198 199
		 */
		genpd->status = GPD_STATE_POWER_OFF;
		wake_up_all(&genpd->status_wait_queue);
200 201
		if (ret) {
			genpd_sd_counter_dec(link->master);
202
			goto err;
203
		}
204 205
	}

206
	if (genpd->power_on) {
207 208 209
		ktime_t time_start = ktime_get();
		s64 elapsed_ns;

210
		ret = genpd->power_on(genpd);
211 212
		if (ret)
			goto err;
213 214

		elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
215
		if (elapsed_ns > genpd->power_on_latency_ns) {
216
			genpd->power_on_latency_ns = elapsed_ns;
217
			genpd->max_off_time_changed = true;
218 219 220 221 222
			if (genpd->name)
				pr_warning("%s: Power-on latency exceeded, "
					"new value %lld ns\n", genpd->name,
					elapsed_ns);
		}
223
	}
224

225 226
	genpd_set_active(genpd);

227
	return 0;
228 229

 err:
230 231
	list_for_each_entry_continue_reverse(link, &genpd->slave_links, slave_node)
		genpd_sd_counter_dec(link->master);
232

233 234 235 236
	return ret;
}

/**
237
 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
238 239 240 241 242 243 244 245 246 247
 * @genpd: PM domain to power up.
 */
int pm_genpd_poweron(struct generic_pm_domain *genpd)
{
	int ret;

	mutex_lock(&genpd->lock);
	ret = __pm_genpd_poweron(genpd);
	mutex_unlock(&genpd->lock);
	return ret;
248 249 250 251 252 253
}

#endif /* CONFIG_PM */

#ifdef CONFIG_PM_RUNTIME

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
static int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
				     unsigned long val, void *ptr)
{
	struct generic_pm_domain_data *gpd_data;
	struct device *dev;

	gpd_data = container_of(nb, struct generic_pm_domain_data, nb);

	mutex_lock(&gpd_data->lock);
	dev = gpd_data->base.dev;
	if (!dev) {
		mutex_unlock(&gpd_data->lock);
		return NOTIFY_DONE;
	}
	mutex_unlock(&gpd_data->lock);

	for (;;) {
		struct generic_pm_domain *genpd;
		struct pm_domain_data *pdd;

		spin_lock_irq(&dev->power.lock);

		pdd = dev->power.subsys_data ?
				dev->power.subsys_data->domain_data : NULL;
		if (pdd) {
			to_gpd_data(pdd)->td.constraint_changed = true;
			genpd = dev_to_genpd(dev);
		} else {
			genpd = ERR_PTR(-ENODATA);
		}

		spin_unlock_irq(&dev->power.lock);

		if (!IS_ERR(genpd)) {
			mutex_lock(&genpd->lock);
			genpd->max_off_time_changed = true;
			mutex_unlock(&genpd->lock);
		}

		dev = dev->parent;
		if (!dev || dev->power.ignore_children)
			break;
	}

	return NOTIFY_DONE;
}

301 302
/**
 * __pm_genpd_save_device - Save the pre-suspend state of a device.
303
 * @pdd: Domain data of the device to save the state of.
304 305
 * @genpd: PM domain the device belongs to.
 */
306
static int __pm_genpd_save_device(struct pm_domain_data *pdd,
307
				  struct generic_pm_domain *genpd)
308
	__releases(&genpd->lock) __acquires(&genpd->lock)
309
{
310
	struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
311
	struct device *dev = pdd->dev;
312 313
	int ret = 0;

314
	if (gpd_data->need_restore)
315 316
		return 0;

317 318
	mutex_unlock(&genpd->lock);

319 320 321
	genpd_start_dev(genpd, dev);
	ret = genpd_save_dev(genpd, dev);
	genpd_stop_dev(genpd, dev);
322

323 324
	mutex_lock(&genpd->lock);

325
	if (!ret)
326
		gpd_data->need_restore = true;
327 328 329 330 331 332

	return ret;
}

/**
 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
333
 * @pdd: Domain data of the device to restore the state of.
334 335
 * @genpd: PM domain the device belongs to.
 */
336
static void __pm_genpd_restore_device(struct pm_domain_data *pdd,
337
				      struct generic_pm_domain *genpd)
338
	__releases(&genpd->lock) __acquires(&genpd->lock)
339
{
340
	struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
341
	struct device *dev = pdd->dev;
342
	bool need_restore = gpd_data->need_restore;
343

344
	gpd_data->need_restore = false;
345 346
	mutex_unlock(&genpd->lock);

347
	genpd_start_dev(genpd, dev);
348 349
	if (need_restore)
		genpd_restore_dev(genpd, dev);
350

351
	mutex_lock(&genpd->lock);
352 353
}

354 355 356 357 358 359 360 361 362 363 364
/**
 * genpd_abort_poweroff - Check if a PM domain power off should be aborted.
 * @genpd: PM domain to check.
 *
 * Return true if a PM domain's status changed to GPD_STATE_ACTIVE during
 * a "power off" operation, which means that a "power on" has occured in the
 * meantime, or if its resume_count field is different from zero, which means
 * that one of its devices has been resumed in the meantime.
 */
static bool genpd_abort_poweroff(struct generic_pm_domain *genpd)
{
365
	return genpd->status == GPD_STATE_WAIT_MASTER
366
		|| genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
367 368
}

369 370 371 372 373 374 375
/**
 * genpd_queue_power_off_work - Queue up the execution of pm_genpd_poweroff().
 * @genpd: PM domait to power off.
 *
 * Queue up the execution of pm_genpd_poweroff() unless it's already been done
 * before.
 */
376
void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
377 378 379 380 381
{
	if (!work_pending(&genpd->power_off_work))
		queue_work(pm_wq, &genpd->power_off_work);
}

382 383 384 385 386 387 388 389 390
/**
 * pm_genpd_poweroff - Remove power from a given PM domain.
 * @genpd: PM domain to power down.
 *
 * If all of the @genpd's devices have been suspended and all of its subdomains
 * have been powered down, run the runtime suspend callbacks provided by all of
 * the @genpd's devices' drivers and remove power from @genpd.
 */
static int pm_genpd_poweroff(struct generic_pm_domain *genpd)
391
	__releases(&genpd->lock) __acquires(&genpd->lock)
392
{
393
	struct pm_domain_data *pdd;
394
	struct gpd_link *link;
395
	unsigned int not_suspended;
396
	int ret = 0;
397

398 399 400 401
 start:
	/*
	 * Do not try to power off the domain in the following situations:
	 * (1) The domain is already in the "power off" state.
402
	 * (2) The domain is waiting for its master to power up.
403
	 * (3) One of the domain's devices is being resumed right now.
404
	 * (4) System suspend is in progress.
405
	 */
406
	if (genpd->status == GPD_STATE_POWER_OFF
407
	    || genpd->status == GPD_STATE_WAIT_MASTER
408
	    || genpd->resume_count > 0 || genpd->prepared_count > 0)
409 410
		return 0;

411
	if (atomic_read(&genpd->sd_count) > 0)
412 413 414
		return -EBUSY;

	not_suspended = 0;
415
	list_for_each_entry(pdd, &genpd->dev_list, list_node)
416
		if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
417
		    || pdd->dev->power.irq_safe || to_gpd_data(pdd)->always_on))
418 419 420 421 422
			not_suspended++;

	if (not_suspended > genpd->in_progress)
		return -EBUSY;

423 424 425 426 427 428 429 430 431
	if (genpd->poweroff_task) {
		/*
		 * Another instance of pm_genpd_poweroff() is executing
		 * callbacks, so tell it to start over and return.
		 */
		genpd->status = GPD_STATE_REPEAT;
		return 0;
	}

432 433 434 435 436
	if (genpd->gov && genpd->gov->power_down_ok) {
		if (!genpd->gov->power_down_ok(&genpd->domain))
			return -EAGAIN;
	}

437
	genpd->status = GPD_STATE_BUSY;
438
	genpd->poweroff_task = current;
439

440
	list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
441
		ret = atomic_read(&genpd->sd_count) == 0 ?
442
			__pm_genpd_save_device(pdd, genpd) : -EBUSY;
443 444 445 446

		if (genpd_abort_poweroff(genpd))
			goto out;

447 448 449 450
		if (ret) {
			genpd_set_active(genpd);
			goto out;
		}
451

452 453 454 455 456
		if (genpd->status == GPD_STATE_REPEAT) {
			genpd->poweroff_task = NULL;
			goto start;
		}
	}
457

458
	if (genpd->power_off) {
459 460 461
		ktime_t time_start;
		s64 elapsed_ns;

462 463
		if (atomic_read(&genpd->sd_count) > 0) {
			ret = -EBUSY;
464 465
			goto out;
		}
466

467 468
		time_start = ktime_get();

469
		/*
470 471
		 * If sd_count > 0 at this point, one of the subdomains hasn't
		 * managed to call pm_genpd_poweron() for the master yet after
472 473 474 475 476
		 * incrementing it.  In that case pm_genpd_poweron() will wait
		 * for us to drop the lock, so we can call .power_off() and let
		 * the pm_genpd_poweron() restore power for us (this shouldn't
		 * happen very often).
		 */
477 478 479 480 481
		ret = genpd->power_off(genpd);
		if (ret == -EBUSY) {
			genpd_set_active(genpd);
			goto out;
		}
482 483

		elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
484
		if (elapsed_ns > genpd->power_off_latency_ns) {
485
			genpd->power_off_latency_ns = elapsed_ns;
486
			genpd->max_off_time_changed = true;
487 488 489 490 491
			if (genpd->name)
				pr_warning("%s: Power-off latency exceeded, "
					"new value %lld ns\n", genpd->name,
					elapsed_ns);
		}
492
	}
493

494
	genpd->status = GPD_STATE_POWER_OFF;
495

496 497 498 499
	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_dec(link->master);
		genpd_queue_power_off_work(link->master);
	}
500

501 502 503 504
 out:
	genpd->poweroff_task = NULL;
	wake_up_all(&genpd->status_wait_queue);
	return ret;
505 506 507 508 509 510 511 512 513 514 515 516
}

/**
 * genpd_power_off_work_fn - Power off PM domain whose subdomain count is 0.
 * @work: Work structure used for scheduling the execution of this function.
 */
static void genpd_power_off_work_fn(struct work_struct *work)
{
	struct generic_pm_domain *genpd;

	genpd = container_of(work, struct generic_pm_domain, power_off_work);

517
	genpd_acquire_lock(genpd);
518
	pm_genpd_poweroff(genpd);
519
	genpd_release_lock(genpd);
520 521 522 523 524 525 526 527 528 529 530 531 532
}

/**
 * pm_genpd_runtime_suspend - Suspend a device belonging to I/O PM domain.
 * @dev: Device to suspend.
 *
 * Carry out a runtime suspend of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 */
static int pm_genpd_runtime_suspend(struct device *dev)
{
	struct generic_pm_domain *genpd;
533
	bool (*stop_ok)(struct device *__dev);
534
	int ret;
535 536 537

	dev_dbg(dev, "%s()\n", __func__);

538 539
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
540 541
		return -EINVAL;

542 543
	might_sleep_if(!genpd->dev_irq_safe);

544 545 546
	if (dev_gpd_data(dev)->always_on)
		return -EBUSY;

547 548 549 550
	stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
	if (stop_ok && !stop_ok(dev))
		return -EBUSY;

551 552 553
	ret = genpd_stop_dev(genpd, dev);
	if (ret)
		return ret;
554

555 556 557 558 559 560 561
	/*
	 * If power.irq_safe is set, this routine will be run with interrupts
	 * off, so it can't use mutexes.
	 */
	if (dev->power.irq_safe)
		return 0;

562
	mutex_lock(&genpd->lock);
563 564 565
	genpd->in_progress++;
	pm_genpd_poweroff(genpd);
	genpd->in_progress--;
566
	mutex_unlock(&genpd->lock);
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581

	return 0;
}

/**
 * pm_genpd_runtime_resume - Resume a device belonging to I/O PM domain.
 * @dev: Device to resume.
 *
 * Carry out a runtime resume of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 */
static int pm_genpd_runtime_resume(struct device *dev)
{
	struct generic_pm_domain *genpd;
582
	DEFINE_WAIT(wait);
583 584 585 586
	int ret;

	dev_dbg(dev, "%s()\n", __func__);

587 588
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
589 590
		return -EINVAL;

591 592 593 594
	might_sleep_if(!genpd->dev_irq_safe);

	/* If power.irq_safe, the PM domain is never powered off. */
	if (dev->power.irq_safe)
595
		return genpd_start_dev(genpd, dev);
596

597
	mutex_lock(&genpd->lock);
598 599 600 601 602
	ret = __pm_genpd_poweron(genpd);
	if (ret) {
		mutex_unlock(&genpd->lock);
		return ret;
	}
603
	genpd->status = GPD_STATE_BUSY;
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
	genpd->resume_count++;
	for (;;) {
		prepare_to_wait(&genpd->status_wait_queue, &wait,
				TASK_UNINTERRUPTIBLE);
		/*
		 * If current is the powering off task, we have been called
		 * reentrantly from one of the device callbacks, so we should
		 * not wait.
		 */
		if (!genpd->poweroff_task || genpd->poweroff_task == current)
			break;
		mutex_unlock(&genpd->lock);

		schedule();

		mutex_lock(&genpd->lock);
	}
	finish_wait(&genpd->status_wait_queue, &wait);
622
	__pm_genpd_restore_device(dev->power.subsys_data->domain_data, genpd);
623 624
	genpd->resume_count--;
	genpd_set_active(genpd);
625
	wake_up_all(&genpd->status_wait_queue);
626
	mutex_unlock(&genpd->lock);
627

628 629 630
	return 0;
}

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
/**
 * pm_genpd_poweroff_unused - Power off all PM domains with no devices in use.
 */
void pm_genpd_poweroff_unused(void)
{
	struct generic_pm_domain *genpd;

	mutex_lock(&gpd_list_lock);

	list_for_each_entry(genpd, &gpd_list, gpd_list_node)
		genpd_queue_power_off_work(genpd);

	mutex_unlock(&gpd_list_lock);
}

646 647
#else

648 649 650 651 652 653
static inline int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
					    unsigned long val, void *ptr)
{
	return NOTIFY_DONE;
}

654 655 656 657 658 659 660
static inline void genpd_power_off_work_fn(struct work_struct *work) {}

#define pm_genpd_runtime_suspend	NULL
#define pm_genpd_runtime_resume		NULL

#endif /* CONFIG_PM_RUNTIME */

661 662
#ifdef CONFIG_PM_SLEEP

663 664 665 666 667 668
static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
				    struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
}

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
static int genpd_suspend_dev(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, suspend, dev);
}

static int genpd_suspend_late(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, suspend_late, dev);
}

static int genpd_resume_early(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, resume_early, dev);
}

static int genpd_resume_dev(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, resume, dev);
}

static int genpd_freeze_dev(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, freeze, dev);
}

static int genpd_freeze_late(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, freeze_late, dev);
}

static int genpd_thaw_early(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, thaw_early, dev);
}

static int genpd_thaw_dev(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, thaw, dev);
}

709
/**
710
 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
711 712 713
 * @genpd: PM domain to power off, if possible.
 *
 * Check if the given PM domain can be powered off (during system suspend or
714
 * hibernation) and do that if so.  Also, in that case propagate to its masters.
715 716 717 718 719 720 721
 *
 * This function is only called in "noirq" stages of system power transitions,
 * so it need not acquire locks (all of the "noirq" callbacks are executed
 * sequentially, so it is guaranteed that it will never run twice in parallel).
 */
static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
{
722
	struct gpd_link *link;
723

724
	if (genpd->status == GPD_STATE_POWER_OFF)
725 726
		return;

727 728
	if (genpd->suspended_count != genpd->device_count
	    || atomic_read(&genpd->sd_count) > 0)
729 730 731 732 733
		return;

	if (genpd->power_off)
		genpd->power_off(genpd);

734
	genpd->status = GPD_STATE_POWER_OFF;
735 736 737 738

	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_dec(link->master);
		pm_genpd_sync_poweroff(link->master);
739 740 741
	}
}

742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
/**
 * resume_needed - Check whether to resume a device before system suspend.
 * @dev: Device to check.
 * @genpd: PM domain the device belongs to.
 *
 * There are two cases in which a device that can wake up the system from sleep
 * states should be resumed by pm_genpd_prepare(): (1) if the device is enabled
 * to wake up the system and it has to remain active for this purpose while the
 * system is in the sleep state and (2) if the device is not enabled to wake up
 * the system from sleep states and it generally doesn't generate wakeup signals
 * by itself (those signals are generated on its behalf by other parts of the
 * system).  In the latter case it may be necessary to reconfigure the device's
 * wakeup settings during system suspend, because it may have been set up to
 * signal remote wakeup from the system's working state as needed by runtime PM.
 * Return 'true' in either of the above cases.
 */
static bool resume_needed(struct device *dev, struct generic_pm_domain *genpd)
{
	bool active_wakeup;

	if (!device_can_wakeup(dev))
		return false;

765
	active_wakeup = genpd_dev_active_wakeup(genpd, dev);
766 767 768
	return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
}

769 770 771 772 773 774 775 776 777 778 779 780
/**
 * pm_genpd_prepare - Start power transition of a device in a PM domain.
 * @dev: Device to start the transition of.
 *
 * Start a power transition of a device (during a system-wide power transition)
 * under the assumption that its pm_domain field points to the domain member of
 * an object of type struct generic_pm_domain representing a PM domain
 * consisting of I/O devices.
 */
static int pm_genpd_prepare(struct device *dev)
{
	struct generic_pm_domain *genpd;
781
	int ret;
782 783 784 785 786 787 788

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

789 790 791 792 793 794 795 796 797 798 799 800 801 802
	/*
	 * If a wakeup request is pending for the device, it should be woken up
	 * at this point and a system wakeup event should be reported if it's
	 * set up to wake up the system from sleep states.
	 */
	pm_runtime_get_noresume(dev);
	if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
		pm_wakeup_event(dev, 0);

	if (pm_wakeup_pending()) {
		pm_runtime_put_sync(dev);
		return -EBUSY;
	}

803 804 805
	if (resume_needed(dev, genpd))
		pm_runtime_resume(dev);

806
	genpd_acquire_lock(genpd);
807

808 809
	if (genpd->prepared_count++ == 0) {
		genpd->suspended_count = 0;
810
		genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
811
	}
812 813

	genpd_release_lock(genpd);
814 815

	if (genpd->suspend_power_off) {
816
		pm_runtime_put_noidle(dev);
817 818 819 820
		return 0;
	}

	/*
821 822
	 * The PM domain must be in the GPD_STATE_ACTIVE state at this point,
	 * so pm_genpd_poweron() will return immediately, but if the device
823
	 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
824
	 * to make it operational.
825
	 */
826
	pm_runtime_resume(dev);
827 828
	__pm_runtime_disable(dev, false);

829 830 831 832 833 834 835 836
	ret = pm_generic_prepare(dev);
	if (ret) {
		mutex_lock(&genpd->lock);

		if (--genpd->prepared_count == 0)
			genpd->suspend_power_off = false;

		mutex_unlock(&genpd->lock);
837
		pm_runtime_enable(dev);
838
	}
839 840

	pm_runtime_put_sync(dev);
841
	return ret;
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
}

/**
 * pm_genpd_suspend - Suspend a device belonging to an I/O PM domain.
 * @dev: Device to suspend.
 *
 * Suspend a device under the assumption that its pm_domain field points to the
 * domain member of an object of type struct generic_pm_domain representing
 * a PM domain consisting of I/O devices.
 */
static int pm_genpd_suspend(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

862
	return genpd->suspend_power_off ? 0 : genpd_suspend_dev(genpd, dev);
863 864 865
}

/**
866
 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
867 868 869 870 871 872
 * @dev: Device to suspend.
 *
 * Carry out a late suspend of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a PM domain consisting of I/O devices.
 */
873
static int pm_genpd_suspend_late(struct device *dev)
874 875 876 877 878 879 880 881 882
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

883 884
	return genpd->suspend_power_off ? 0 : genpd_suspend_late(genpd, dev);
}
885

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
/**
 * pm_genpd_suspend_noirq - Completion of suspend of device in an I/O PM domain.
 * @dev: Device to suspend.
 *
 * Stop the device and remove power from the domain if all devices in it have
 * been stopped.
 */
static int pm_genpd_suspend_noirq(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;
902

903
	if (genpd->suspend_power_off || dev_gpd_data(dev)->always_on
904
	    || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
905 906
		return 0;

907
	genpd_stop_dev(genpd, dev);
908 909 910 911 912 913 914 915 916 917 918 919 920

	/*
	 * Since all of the "noirq" callbacks are executed sequentially, it is
	 * guaranteed that this function will never run twice in parallel for
	 * the same PM domain, so it is not necessary to use locking here.
	 */
	genpd->suspended_count++;
	pm_genpd_sync_poweroff(genpd);

	return 0;
}

/**
921
 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
922 923
 * @dev: Device to resume.
 *
924
 * Restore power to the device's PM domain, if necessary, and start the device.
925 926 927 928 929 930 931 932 933 934 935
 */
static int pm_genpd_resume_noirq(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

936
	if (genpd->suspend_power_off || dev_gpd_data(dev)->always_on
937
	    || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
938 939 940 941 942 943 944 945 946 947
		return 0;

	/*
	 * Since all of the "noirq" callbacks are executed sequentially, it is
	 * guaranteed that this function will never run twice in parallel for
	 * the same PM domain, so it is not necessary to use locking here.
	 */
	pm_genpd_poweron(genpd);
	genpd->suspended_count--;

948
	return genpd_start_dev(genpd, dev);
949 950 951
}

/**
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
 * pm_genpd_resume_early - Early resume of a device in an I/O PM domain.
 * @dev: Device to resume.
 *
 * Carry out an early resume of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a power domain consisting of I/O
 * devices.
 */
static int pm_genpd_resume_early(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

	return genpd->suspend_power_off ? 0 : genpd_resume_early(genpd, dev);
}

/**
 * pm_genpd_resume - Resume of device in an I/O PM domain.
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
 * @dev: Device to resume.
 *
 * Resume a device under the assumption that its pm_domain field points to the
 * domain member of an object of type struct generic_pm_domain representing
 * a power domain consisting of I/O devices.
 */
static int pm_genpd_resume(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

991
	return genpd->suspend_power_off ? 0 : genpd_resume_dev(genpd, dev);
992 993 994
}

/**
995
 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
 * @dev: Device to freeze.
 *
 * Freeze a device under the assumption that its pm_domain field points to the
 * domain member of an object of type struct generic_pm_domain representing
 * a power domain consisting of I/O devices.
 */
static int pm_genpd_freeze(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

1012
	return genpd->suspend_power_off ? 0 : genpd_freeze_dev(genpd, dev);
1013 1014 1015
}

/**
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
 * pm_genpd_freeze_late - Late freeze of a device in an I/O PM domain.
 * @dev: Device to freeze.
 *
 * Carry out a late freeze of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a power domain consisting of I/O
 * devices.
 */
static int pm_genpd_freeze_late(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

	return genpd->suspend_power_off ? 0 : genpd_freeze_late(genpd, dev);
}

/**
 * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
 * @dev: Device to freeze.
 *
 * Carry out a late freeze of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a power domain consisting of I/O
 * devices.
 */
static int pm_genpd_freeze_noirq(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

1056 1057
	return genpd->suspend_power_off || dev_gpd_data(dev)->always_on ?
		0 : genpd_stop_dev(genpd, dev);
1058
}
1059

1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
/**
 * pm_genpd_thaw_noirq - Early thaw of device in an I/O PM domain.
 * @dev: Device to thaw.
 *
 * Start the device, unless power has been removed from the domain already
 * before the system transition.
 */
static int pm_genpd_thaw_noirq(struct device *dev)
{
	struct generic_pm_domain *genpd;
1070

1071
	dev_dbg(dev, "%s()\n", __func__);
1072

1073 1074 1075 1076
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

1077 1078
	return genpd->suspend_power_off || dev_gpd_data(dev)->always_on ?
		0 : genpd_start_dev(genpd, dev);
1079 1080 1081
}

/**
1082
 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
1083 1084 1085 1086 1087 1088 1089
 * @dev: Device to thaw.
 *
 * Carry out an early thaw of a device under the assumption that its
 * pm_domain field points to the domain member of an object of type
 * struct generic_pm_domain representing a power domain consisting of I/O
 * devices.
 */
1090
static int pm_genpd_thaw_early(struct device *dev)
1091 1092 1093 1094 1095 1096 1097 1098 1099
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

1100
	return genpd->suspend_power_off ? 0 : genpd_thaw_early(genpd, dev);
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
}

/**
 * pm_genpd_thaw - Thaw a device belonging to an I/O power domain.
 * @dev: Device to thaw.
 *
 * Thaw a device under the assumption that its pm_domain field points to the
 * domain member of an object of type struct generic_pm_domain representing
 * a power domain consisting of I/O devices.
 */
static int pm_genpd_thaw(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

1121
	return genpd->suspend_power_off ? 0 : genpd_thaw_dev(genpd, dev);
1122 1123 1124
}

/**
1125
 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1126 1127
 * @dev: Device to resume.
 *
1128 1129
 * Make sure the domain will be in the same power state as before the
 * hibernation the system is resuming from and start the device if necessary.
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
 */
static int pm_genpd_restore_noirq(struct device *dev)
{
	struct generic_pm_domain *genpd;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

	/*
	 * Since all of the "noirq" callbacks are executed sequentially, it is
	 * guaranteed that this function will never run twice in parallel for
	 * the same PM domain, so it is not necessary to use locking here.
1145 1146 1147
	 *
	 * At this point suspended_count == 0 means we are being run for the
	 * first time for the given domain in the present cycle.
1148
	 */
1149
	if (genpd->suspended_count++ == 0) {
1150
		/*
1151 1152 1153
		 * The boot kernel might put the domain into arbitrary state,
		 * so make it appear as powered off to pm_genpd_poweron(), so
		 * that it tries to power it on in case it was really off.
1154
		 */
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
		genpd->status = GPD_STATE_POWER_OFF;
		if (genpd->suspend_power_off) {
			/*
			 * If the domain was off before the hibernation, make
			 * sure it will be off going forward.
			 */
			if (genpd->power_off)
				genpd->power_off(genpd);

			return 0;
		}
1166 1167
	}

1168 1169 1170
	if (genpd->suspend_power_off)
		return 0;

1171 1172
	pm_genpd_poweron(genpd);

1173
	return dev_gpd_data(dev)->always_on ? 0 : genpd_start_dev(genpd, dev);
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
}

/**
 * pm_genpd_complete - Complete power transition of a device in a power domain.
 * @dev: Device to complete the transition of.
 *
 * Complete a power transition of a device (during a system-wide power
 * transition) under the assumption that its pm_domain field points to the
 * domain member of an object of type struct generic_pm_domain representing
 * a power domain consisting of I/O devices.
 */
static void pm_genpd_complete(struct device *dev)
{
	struct generic_pm_domain *genpd;
	bool run_complete;

	dev_dbg(dev, "%s()\n", __func__);

	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return;

	mutex_lock(&genpd->lock);

	run_complete = !genpd->suspend_power_off;
	if (--genpd->prepared_count == 0)
		genpd->suspend_power_off = false;

	mutex_unlock(&genpd->lock);

	if (run_complete) {
		pm_generic_complete(dev);
1206
		pm_runtime_set_active(dev);
1207
		pm_runtime_enable(dev);
1208
		pm_runtime_idle(dev);
1209 1210 1211 1212 1213 1214 1215
	}
}

#else

#define pm_genpd_prepare		NULL
#define pm_genpd_suspend		NULL
1216
#define pm_genpd_suspend_late		NULL
1217
#define pm_genpd_suspend_noirq		NULL
1218
#define pm_genpd_resume_early		NULL
1219 1220 1221
#define pm_genpd_resume_noirq		NULL
#define pm_genpd_resume			NULL
#define pm_genpd_freeze			NULL
1222
#define pm_genpd_freeze_late		NULL
1223
#define pm_genpd_freeze_noirq		NULL
1224
#define pm_genpd_thaw_early		NULL
1225 1226 1227 1228 1229 1230 1231
#define pm_genpd_thaw_noirq		NULL
#define pm_genpd_thaw			NULL
#define pm_genpd_restore_noirq		NULL
#define pm_genpd_complete		NULL

#endif /* CONFIG_PM_SLEEP */

1232
/**
1233
 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1234 1235
 * @genpd: PM domain to add the device to.
 * @dev: Device to be added.
1236
 * @td: Set of PM QoS timing parameters to attach to the device.
1237
 */
1238 1239
int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
			  struct gpd_timing_data *td)
1240
{
1241
	struct generic_pm_domain_data *gpd_data;
1242
	struct pm_domain_data *pdd;
1243 1244 1245 1246 1247 1248 1249
	int ret = 0;

	dev_dbg(dev, "%s()\n", __func__);

	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev))
		return -EINVAL;

1250 1251 1252 1253 1254 1255 1256 1257
	gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
	if (!gpd_data)
		return -ENOMEM;

	mutex_init(&gpd_data->lock);
	gpd_data->nb.notifier_call = genpd_dev_pm_qos_notifier;
	dev_pm_qos_add_notifier(dev, &gpd_data->nb);

1258
	genpd_acquire_lock(genpd);
1259

1260 1261 1262 1263 1264
	if (genpd->prepared_count > 0) {
		ret = -EAGAIN;
		goto out;
	}

1265 1266
	list_for_each_entry(pdd, &genpd->dev_list, list_node)
		if (pdd->dev == dev) {
1267 1268 1269 1270
			ret = -EINVAL;
			goto out;
		}

1271
	genpd->device_count++;
1272
	genpd->max_off_time_changed = true;
1273

1274
	dev_pm_get_subsys_data(dev);
1275 1276 1277 1278

	mutex_lock(&gpd_data->lock);
	spin_lock_irq(&dev->power.lock);
	dev->pm_domain = &genpd->domain;
1279 1280 1281
	dev->power.subsys_data->domain_data = &gpd_data->base;
	gpd_data->base.dev = dev;
	list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1282
	gpd_data->need_restore = genpd->status == GPD_STATE_POWER_OFF;
1283 1284
	if (td)
		gpd_data->td = *td;
1285

1286 1287 1288 1289 1290 1291 1292 1293 1294
	gpd_data->td.constraint_changed = true;
	gpd_data->td.effective_constraint_ns = -1;
	spin_unlock_irq(&dev->power.lock);
	mutex_unlock(&gpd_data->lock);

	genpd_release_lock(genpd);

	return 0;

1295
 out:
1296
	genpd_release_lock(genpd);
1297

1298 1299
	dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
	kfree(gpd_data);
1300 1301 1302
	return ret;
}

T
Thomas Abraham 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
/**
 * __pm_genpd_of_add_device - Add a device to an I/O PM domain.
 * @genpd_node: Device tree node pointer representing a PM domain to which the
 *   the device is added to.
 * @dev: Device to be added.
 * @td: Set of PM QoS timing parameters to attach to the device.
 */
int __pm_genpd_of_add_device(struct device_node *genpd_node, struct device *dev,
			     struct gpd_timing_data *td)
{
	struct generic_pm_domain *genpd = NULL, *gpd;

	dev_dbg(dev, "%s()\n", __func__);

	if (IS_ERR_OR_NULL(genpd_node) || IS_ERR_OR_NULL(dev))
		return -EINVAL;

	mutex_lock(&gpd_list_lock);
	list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
		if (gpd->of_node == genpd_node) {
			genpd = gpd;
			break;
		}
	}
	mutex_unlock(&gpd_list_lock);

	if (!genpd)
		return -EINVAL;

	return __pm_genpd_add_device(genpd, dev, td);
}

1335 1336 1337 1338 1339 1340 1341 1342
/**
 * pm_genpd_remove_device - Remove a device from an I/O PM domain.
 * @genpd: PM domain to remove the device from.
 * @dev: Device to be removed.
 */
int pm_genpd_remove_device(struct generic_pm_domain *genpd,
			   struct device *dev)
{
1343
	struct generic_pm_domain_data *gpd_data;
1344
	struct pm_domain_data *pdd;
1345
	int ret = 0;
1346 1347 1348

	dev_dbg(dev, "%s()\n", __func__);

1349 1350 1351
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(dev)
	    ||  IS_ERR_OR_NULL(dev->pm_domain)
	    ||  pd_to_genpd(dev->pm_domain) != genpd)
1352 1353
		return -EINVAL;

1354
	genpd_acquire_lock(genpd);
1355

1356 1357 1358 1359 1360
	if (genpd->prepared_count > 0) {
		ret = -EAGAIN;
		goto out;
	}

1361 1362 1363 1364
	genpd->device_count--;
	genpd->max_off_time_changed = true;

	spin_lock_irq(&dev->power.lock);
1365 1366 1367 1368
	dev->pm_domain = NULL;
	pdd = dev->power.subsys_data->domain_data;
	list_del_init(&pdd->list_node);
	dev->power.subsys_data->domain_data = NULL;
1369
	spin_unlock_irq(&dev->power.lock);
1370

1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
	gpd_data = to_gpd_data(pdd);
	mutex_lock(&gpd_data->lock);
	pdd->dev = NULL;
	mutex_unlock(&gpd_data->lock);

	genpd_release_lock(genpd);

	dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
	kfree(gpd_data);
	dev_pm_put_subsys_data(dev);
	return 0;
1382

1383
 out:
1384
	genpd_release_lock(genpd);
1385 1386 1387 1388

	return ret;
}

1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
/**
 * pm_genpd_dev_always_on - Set/unset the "always on" flag for a given device.
 * @dev: Device to set/unset the flag for.
 * @val: The new value of the device's "always on" flag.
 */
void pm_genpd_dev_always_on(struct device *dev, bool val)
{
	struct pm_subsys_data *psd;
	unsigned long flags;

	spin_lock_irqsave(&dev->power.lock, flags);

	psd = dev_to_psd(dev);
	if (psd && psd->domain_data)
		to_gpd_data(psd->domain_data)->always_on = val;

	spin_unlock_irqrestore(&dev->power.lock, flags);
}
EXPORT_SYMBOL_GPL(pm_genpd_dev_always_on);

1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
/**
 * pm_genpd_dev_need_restore - Set/unset the device's "need restore" flag.
 * @dev: Device to set/unset the flag for.
 * @val: The new value of the device's "need restore" flag.
 */
void pm_genpd_dev_need_restore(struct device *dev, bool val)
{
	struct pm_subsys_data *psd;
	unsigned long flags;

	spin_lock_irqsave(&dev->power.lock, flags);

	psd = dev_to_psd(dev);
	if (psd && psd->domain_data)
		to_gpd_data(psd->domain_data)->need_restore = val;

	spin_unlock_irqrestore(&dev->power.lock, flags);
}
EXPORT_SYMBOL_GPL(pm_genpd_dev_need_restore);

1429 1430 1431
/**
 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
 * @genpd: Master PM domain to add the subdomain to.
1432
 * @subdomain: Subdomain to be added.
1433 1434
 */
int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1435
			   struct generic_pm_domain *subdomain)
1436
{
1437
	struct gpd_link *link;
1438 1439
	int ret = 0;

1440
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1441 1442
		return -EINVAL;

1443 1444
 start:
	genpd_acquire_lock(genpd);
1445
	mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1446

1447 1448 1449
	if (subdomain->status != GPD_STATE_POWER_OFF
	    && subdomain->status != GPD_STATE_ACTIVE) {
		mutex_unlock(&subdomain->lock);
1450 1451 1452 1453 1454
		genpd_release_lock(genpd);
		goto start;
	}

	if (genpd->status == GPD_STATE_POWER_OFF
1455
	    &&  subdomain->status != GPD_STATE_POWER_OFF) {
1456 1457 1458 1459
		ret = -EINVAL;
		goto out;
	}

1460
	list_for_each_entry(link, &genpd->master_links, master_node) {
1461
		if (link->slave == subdomain && link->master == genpd) {
1462 1463 1464 1465 1466
			ret = -EINVAL;
			goto out;
		}
	}

1467 1468 1469 1470 1471 1472 1473
	link = kzalloc(sizeof(*link), GFP_KERNEL);
	if (!link) {
		ret = -ENOMEM;
		goto out;
	}
	link->master = genpd;
	list_add_tail(&link->master_node, &genpd->master_links);
1474 1475 1476
	link->slave = subdomain;
	list_add_tail(&link->slave_node, &subdomain->slave_links);
	if (subdomain->status != GPD_STATE_POWER_OFF)
1477
		genpd_sd_counter_inc(genpd);
1478 1479

 out:
1480
	mutex_unlock(&subdomain->lock);
1481
	genpd_release_lock(genpd);
1482 1483 1484 1485 1486 1487 1488

	return ret;
}

/**
 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
 * @genpd: Master PM domain to remove the subdomain from.
1489
 * @subdomain: Subdomain to be removed.
1490 1491
 */
int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1492
			      struct generic_pm_domain *subdomain)
1493
{
1494
	struct gpd_link *link;
1495 1496
	int ret = -EINVAL;

1497
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1498 1499
		return -EINVAL;

1500 1501
 start:
	genpd_acquire_lock(genpd);
1502

1503 1504
	list_for_each_entry(link, &genpd->master_links, master_node) {
		if (link->slave != subdomain)
1505 1506 1507 1508
			continue;

		mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);

1509 1510 1511 1512 1513 1514 1515
		if (subdomain->status != GPD_STATE_POWER_OFF
		    && subdomain->status != GPD_STATE_ACTIVE) {
			mutex_unlock(&subdomain->lock);
			genpd_release_lock(genpd);
			goto start;
		}

1516 1517 1518
		list_del(&link->master_node);
		list_del(&link->slave_node);
		kfree(link);
1519
		if (subdomain->status != GPD_STATE_POWER_OFF)
1520 1521 1522 1523 1524 1525 1526 1527
			genpd_sd_counter_dec(genpd);

		mutex_unlock(&subdomain->lock);

		ret = 0;
		break;
	}

1528
	genpd_release_lock(genpd);
1529 1530 1531 1532

	return ret;
}

1533 1534 1535 1536
/**
 * pm_genpd_add_callbacks - Add PM domain callbacks to a given device.
 * @dev: Device to add the callbacks to.
 * @ops: Set of callbacks to add.
1537
 * @td: Timing data to add to the device along with the callbacks (optional).
1538
 */
1539 1540
int pm_genpd_add_callbacks(struct device *dev, struct gpd_dev_ops *ops,
			   struct gpd_timing_data *td)
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
{
	struct pm_domain_data *pdd;
	int ret = 0;

	if (!(dev && dev->power.subsys_data && ops))
		return -EINVAL;

	pm_runtime_disable(dev);
	device_pm_lock();

	pdd = dev->power.subsys_data->domain_data;
	if (pdd) {
		struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);

		gpd_data->ops = *ops;
1556 1557
		if (td)
			gpd_data->td = *td;
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
	} else {
		ret = -EINVAL;
	}

	device_pm_unlock();
	pm_runtime_enable(dev);

	return ret;
}
EXPORT_SYMBOL_GPL(pm_genpd_add_callbacks);

/**
1570
 * __pm_genpd_remove_callbacks - Remove PM domain callbacks from a given device.
1571
 * @dev: Device to remove the callbacks from.
1572
 * @clear_td: If set, clear the device's timing data too.
1573
 */
1574
int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
{
	struct pm_domain_data *pdd;
	int ret = 0;

	if (!(dev && dev->power.subsys_data))
		return -EINVAL;

	pm_runtime_disable(dev);
	device_pm_lock();

	pdd = dev->power.subsys_data->domain_data;
	if (pdd) {
		struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);

		gpd_data->ops = (struct gpd_dev_ops){ 0 };
1590 1591
		if (clear_td)
			gpd_data->td = (struct gpd_timing_data){ 0 };
1592 1593 1594 1595 1596 1597 1598 1599 1600
	} else {
		ret = -EINVAL;
	}

	device_pm_unlock();
	pm_runtime_enable(dev);

	return ret;
}
1601
EXPORT_SYMBOL_GPL(__pm_genpd_remove_callbacks);
1602

1603 1604
/* Default device callbacks for generic PM domains. */

1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616
/**
 * pm_genpd_default_save_state - Default "save device state" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_save_state(struct device *dev)
{
	int (*cb)(struct device *__dev);

	cb = dev_gpd_data(dev)->ops.save_state;
	if (cb)
		return cb(dev);

1617 1618 1619 1620 1621 1622 1623 1624
	if (dev->type && dev->type->pm)
		cb = dev->type->pm->runtime_suspend;
	else if (dev->class && dev->class->pm)
		cb = dev->class->pm->runtime_suspend;
	else if (dev->bus && dev->bus->pm)
		cb = dev->bus->pm->runtime_suspend;
	else
		cb = NULL;
1625

1626 1627 1628 1629
	if (!cb && dev->driver && dev->driver->pm)
		cb = dev->driver->pm->runtime_suspend;

	return cb ? cb(dev) : 0;
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
}

/**
 * pm_genpd_default_restore_state - Default PM domians "restore device state".
 * @dev: Device to handle.
 */
static int pm_genpd_default_restore_state(struct device *dev)
{
	int (*cb)(struct device *__dev);

	cb = dev_gpd_data(dev)->ops.restore_state;
	if (cb)
		return cb(dev);

1644 1645 1646 1647 1648 1649 1650 1651
	if (dev->type && dev->type->pm)
		cb = dev->type->pm->runtime_resume;
	else if (dev->class && dev->class->pm)
		cb = dev->class->pm->runtime_resume;
	else if (dev->bus && dev->bus->pm)
		cb = dev->bus->pm->runtime_resume;
	else
		cb = NULL;
1652

1653 1654 1655 1656
	if (!cb && dev->driver && dev->driver->pm)
		cb = dev->driver->pm->runtime_resume;

	return cb ? cb(dev) : 0;
1657 1658
}

1659 1660
#ifdef CONFIG_PM_SLEEP

1661 1662 1663 1664 1665 1666
/**
 * pm_genpd_default_suspend - Default "device suspend" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_suspend(struct device *dev)
{
1667
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend;
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677

	return cb ? cb(dev) : pm_generic_suspend(dev);
}

/**
 * pm_genpd_default_suspend_late - Default "late device suspend" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_suspend_late(struct device *dev)
{
1678
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend_late;
1679

1680
	return cb ? cb(dev) : pm_generic_suspend_late(dev);
1681 1682 1683 1684 1685 1686 1687 1688
}

/**
 * pm_genpd_default_resume_early - Default "early device resume" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_resume_early(struct device *dev)
{
1689
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume_early;
1690

1691
	return cb ? cb(dev) : pm_generic_resume_early(dev);
1692 1693 1694 1695 1696 1697 1698 1699
}

/**
 * pm_genpd_default_resume - Default "device resume" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_resume(struct device *dev)
{
1700
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume;
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723

	return cb ? cb(dev) : pm_generic_resume(dev);
}

/**
 * pm_genpd_default_freeze - Default "device freeze" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_freeze(struct device *dev)
{
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.freeze;

	return cb ? cb(dev) : pm_generic_freeze(dev);
}

/**
 * pm_genpd_default_freeze_late - Default "late device freeze" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_freeze_late(struct device *dev)
{
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.freeze_late;

1724
	return cb ? cb(dev) : pm_generic_freeze_late(dev);
1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
}

/**
 * pm_genpd_default_thaw_early - Default "early device thaw" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_thaw_early(struct device *dev)
{
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.thaw_early;

1735
	return cb ? cb(dev) : pm_generic_thaw_early(dev);
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
}

/**
 * pm_genpd_default_thaw - Default "device thaw" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_thaw(struct device *dev)
{
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.thaw;

	return cb ? cb(dev) : pm_generic_thaw(dev);
}

1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
#else /* !CONFIG_PM_SLEEP */

#define pm_genpd_default_suspend	NULL
#define pm_genpd_default_suspend_late	NULL
#define pm_genpd_default_resume_early	NULL
#define pm_genpd_default_resume		NULL
#define pm_genpd_default_freeze		NULL
#define pm_genpd_default_freeze_late	NULL
#define pm_genpd_default_thaw_early	NULL
#define pm_genpd_default_thaw		NULL

#endif /* !CONFIG_PM_SLEEP */

1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
/**
 * pm_genpd_init - Initialize a generic I/O PM domain object.
 * @genpd: PM domain object to initialize.
 * @gov: PM domain governor to associate with the domain (may be NULL).
 * @is_off: Initial value of the domain's power_is_off field.
 */
void pm_genpd_init(struct generic_pm_domain *genpd,
		   struct dev_power_governor *gov, bool is_off)
{
	if (IS_ERR_OR_NULL(genpd))
		return;

1774 1775
	INIT_LIST_HEAD(&genpd->master_links);
	INIT_LIST_HEAD(&genpd->slave_links);
1776 1777 1778 1779 1780
	INIT_LIST_HEAD(&genpd->dev_list);
	mutex_init(&genpd->lock);
	genpd->gov = gov;
	INIT_WORK(&genpd->power_off_work, genpd_power_off_work_fn);
	genpd->in_progress = 0;
1781
	atomic_set(&genpd->sd_count, 0);
1782 1783
	genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
	init_waitqueue_head(&genpd->status_wait_queue);
1784 1785
	genpd->poweroff_task = NULL;
	genpd->resume_count = 0;
1786
	genpd->device_count = 0;
1787
	genpd->max_off_time_ns = -1;
1788
	genpd->max_off_time_changed = true;
1789 1790 1791
	genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
	genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
	genpd->domain.ops.runtime_idle = pm_generic_runtime_idle;
1792 1793
	genpd->domain.ops.prepare = pm_genpd_prepare;
	genpd->domain.ops.suspend = pm_genpd_suspend;
1794
	genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
1795 1796
	genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
	genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1797
	genpd->domain.ops.resume_early = pm_genpd_resume_early;
1798 1799
	genpd->domain.ops.resume = pm_genpd_resume;
	genpd->domain.ops.freeze = pm_genpd_freeze;
1800
	genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
1801 1802
	genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
	genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1803
	genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
1804
	genpd->domain.ops.thaw = pm_genpd_thaw;
1805
	genpd->domain.ops.poweroff = pm_genpd_suspend;
1806
	genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
1807
	genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
1808
	genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1809
	genpd->domain.ops.restore_early = pm_genpd_resume_early;
1810
	genpd->domain.ops.restore = pm_genpd_resume;
1811
	genpd->domain.ops.complete = pm_genpd_complete;
1812 1813
	genpd->dev_ops.save_state = pm_genpd_default_save_state;
	genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
1814 1815 1816 1817
	genpd->dev_ops.suspend = pm_genpd_default_suspend;
	genpd->dev_ops.suspend_late = pm_genpd_default_suspend_late;
	genpd->dev_ops.resume_early = pm_genpd_default_resume_early;
	genpd->dev_ops.resume = pm_genpd_default_resume;
1818 1819 1820 1821
	genpd->dev_ops.freeze = pm_genpd_default_freeze;
	genpd->dev_ops.freeze_late = pm_genpd_default_freeze_late;
	genpd->dev_ops.thaw_early = pm_genpd_default_thaw_early;
	genpd->dev_ops.thaw = pm_genpd_default_thaw;
1822 1823 1824 1825
	mutex_lock(&gpd_list_lock);
	list_add(&genpd->gpd_list_node, &gpd_list);
	mutex_unlock(&gpd_list_lock);
}