domain.c 42.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * 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>
#include <linux/slab.h>
#include <linux/err.h>
16 17
#include <linux/sched.h>
#include <linux/suspend.h>
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
#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;							\
})
35

36 37 38 39 40 41 42 43 44 45 46 47 48 49
#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));		\
	struct generic_pm_domain_data *__gpd_data = dev_gpd_data(dev);		\
	if (__elapsed > __gpd_data->td.field) {					\
		__gpd_data->td.field = __elapsed;				\
		dev_warn(dev, name " latency exceeded, new value %lld ns\n",	\
			__elapsed);						\
	}									\
	__retval;								\
})

50 51 52
static LIST_HEAD(gpd_list);
static DEFINE_MUTEX(gpd_list_lock);

53 54
#ifdef CONFIG_PM

55
struct generic_pm_domain *dev_to_genpd(struct device *dev)
56 57 58 59
{
	if (IS_ERR_OR_NULL(dev->pm_domain))
		return ERR_PTR(-EINVAL);

60
	return pd_to_genpd(dev->pm_domain);
61
}
62

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

static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
{
71 72
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
					start_latency_ns, "start");
73 74
}

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

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

88
static bool genpd_sd_counter_dec(struct generic_pm_domain *genpd)
89
{
90 91 92 93 94 95 96 97 98 99 100 101
	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();
102 103
}

104 105 106 107 108 109 110 111 112 113 114 115
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);
116 117
		if (genpd->status == GPD_STATE_ACTIVE
		    || genpd->status == GPD_STATE_POWER_OFF)
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
			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);
}

133 134 135 136 137 138
static void genpd_set_active(struct generic_pm_domain *genpd)
{
	if (genpd->resume_count == 0)
		genpd->status = GPD_STATE_ACTIVE;
}

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

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

161 162 163 164 165
		schedule();

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

167
	if (genpd->status == GPD_STATE_ACTIVE
168
	    || (genpd->prepared_count > 0 && genpd->suspend_power_off))
169
		return 0;
170

171 172
	if (genpd->status != GPD_STATE_POWER_OFF) {
		genpd_set_active(genpd);
173
		return 0;
174 175
	}

176 177 178 179 180 181 182
	/*
	 * 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);
183
		genpd->status = GPD_STATE_WAIT_MASTER;
184

185 186
		mutex_unlock(&genpd->lock);

187
		ret = pm_genpd_poweron(link->master);
188 189 190

		mutex_lock(&genpd->lock);

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

203
	if (genpd->power_on) {
204 205 206
		ktime_t time_start = ktime_get();
		s64 elapsed_ns;

207
		ret = genpd->power_on(genpd);
208 209
		if (ret)
			goto err;
210 211

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

221 222
	genpd_set_active(genpd);

223
	return 0;
224 225

 err:
226 227
	list_for_each_entry_continue_reverse(link, &genpd->slave_links, slave_node)
		genpd_sd_counter_dec(link->master);
228

229 230 231 232
	return ret;
}

/**
233
 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
234 235 236 237 238 239 240 241 242 243
 * @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;
244 245 246 247 248 249
}

#endif /* CONFIG_PM */

#ifdef CONFIG_PM_RUNTIME

250 251
/**
 * __pm_genpd_save_device - Save the pre-suspend state of a device.
252
 * @pdd: Domain data of the device to save the state of.
253 254
 * @genpd: PM domain the device belongs to.
 */
255
static int __pm_genpd_save_device(struct pm_domain_data *pdd,
256
				  struct generic_pm_domain *genpd)
257
	__releases(&genpd->lock) __acquires(&genpd->lock)
258
{
259
	struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
260
	struct device *dev = pdd->dev;
261 262
	int ret = 0;

263
	if (gpd_data->need_restore)
264 265
		return 0;

266 267
	mutex_unlock(&genpd->lock);

268 269 270
	genpd_start_dev(genpd, dev);
	ret = genpd_save_dev(genpd, dev);
	genpd_stop_dev(genpd, dev);
271

272 273
	mutex_lock(&genpd->lock);

274
	if (!ret)
275
		gpd_data->need_restore = true;
276 277 278 279 280 281

	return ret;
}

/**
 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
282
 * @pdd: Domain data of the device to restore the state of.
283 284
 * @genpd: PM domain the device belongs to.
 */
285
static void __pm_genpd_restore_device(struct pm_domain_data *pdd,
286
				      struct generic_pm_domain *genpd)
287
	__releases(&genpd->lock) __acquires(&genpd->lock)
288
{
289
	struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
290
	struct device *dev = pdd->dev;
291

292
	if (!gpd_data->need_restore)
293 294
		return;

295 296
	mutex_unlock(&genpd->lock);

297 298 299
	genpd_start_dev(genpd, dev);
	genpd_restore_dev(genpd, dev);
	genpd_stop_dev(genpd, dev);
300

301 302
	mutex_lock(&genpd->lock);

303
	gpd_data->need_restore = false;
304 305
}

306 307 308 309 310 311 312 313 314 315 316
/**
 * 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)
{
317
	return genpd->status == GPD_STATE_WAIT_MASTER
318
		|| genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
319 320
}

321 322 323 324 325 326 327
/**
 * 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.
 */
328
void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
329 330 331 332 333
{
	if (!work_pending(&genpd->power_off_work))
		queue_work(pm_wq, &genpd->power_off_work);
}

334 335 336 337 338 339 340 341 342
/**
 * 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)
343
	__releases(&genpd->lock) __acquires(&genpd->lock)
344
{
345
	struct pm_domain_data *pdd;
346
	struct gpd_link *link;
347
	unsigned int not_suspended;
348
	int ret = 0;
349

350 351 352 353
 start:
	/*
	 * Do not try to power off the domain in the following situations:
	 * (1) The domain is already in the "power off" state.
354
	 * (2) The domain is waiting for its master to power up.
355
	 * (3) One of the domain's devices is being resumed right now.
356
	 * (4) System suspend is in progress.
357
	 */
358
	if (genpd->status == GPD_STATE_POWER_OFF
359
	    || genpd->status == GPD_STATE_WAIT_MASTER
360
	    || genpd->resume_count > 0 || genpd->prepared_count > 0)
361 362
		return 0;

363
	if (atomic_read(&genpd->sd_count) > 0)
364 365 366
		return -EBUSY;

	not_suspended = 0;
367
	list_for_each_entry(pdd, &genpd->dev_list, list_node)
368 369
		if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
		    || pdd->dev->power.irq_safe))
370 371 372 373 374
			not_suspended++;

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

375 376 377 378 379 380 381 382 383
	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;
	}

384 385 386 387 388
	if (genpd->gov && genpd->gov->power_down_ok) {
		if (!genpd->gov->power_down_ok(&genpd->domain))
			return -EAGAIN;
	}

389
	genpd->status = GPD_STATE_BUSY;
390
	genpd->poweroff_task = current;
391

392
	list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
393
		ret = atomic_read(&genpd->sd_count) == 0 ?
394
			__pm_genpd_save_device(pdd, genpd) : -EBUSY;
395 396 397 398

		if (genpd_abort_poweroff(genpd))
			goto out;

399 400 401 402
		if (ret) {
			genpd_set_active(genpd);
			goto out;
		}
403

404 405 406 407 408
		if (genpd->status == GPD_STATE_REPEAT) {
			genpd->poweroff_task = NULL;
			goto start;
		}
	}
409

410
	if (genpd->power_off) {
411 412 413
		ktime_t time_start;
		s64 elapsed_ns;

414 415
		if (atomic_read(&genpd->sd_count) > 0) {
			ret = -EBUSY;
416 417
			goto out;
		}
418

419 420
		time_start = ktime_get();

421
		/*
422 423
		 * If sd_count > 0 at this point, one of the subdomains hasn't
		 * managed to call pm_genpd_poweron() for the master yet after
424 425 426 427 428
		 * 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).
		 */
429 430 431 432 433
		ret = genpd->power_off(genpd);
		if (ret == -EBUSY) {
			genpd_set_active(genpd);
			goto out;
		}
434 435

		elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
436
		if (elapsed_ns > genpd->power_off_latency_ns) {
437
			genpd->power_off_latency_ns = elapsed_ns;
438 439 440 441 442
			if (genpd->name)
				pr_warning("%s: Power-off latency exceeded, "
					"new value %lld ns\n", genpd->name,
					elapsed_ns);
		}
443
	}
444

445
	genpd->status = GPD_STATE_POWER_OFF;
446 447 448 449 450 451 452 453 454 455 456
	genpd->power_off_time = ktime_get();

	/* Update PM QoS information for devices in the domain. */
	list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
		struct gpd_timing_data *td = &to_gpd_data(pdd)->td;

		pm_runtime_update_max_time_suspended(pdd->dev,
					td->start_latency_ns +
					td->restore_state_latency_ns +
					genpd->power_on_latency_ns);
	}
457

458 459 460 461
	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_dec(link->master);
		genpd_queue_power_off_work(link->master);
	}
462

463 464 465 466
 out:
	genpd->poweroff_task = NULL;
	wake_up_all(&genpd->status_wait_queue);
	return ret;
467 468 469 470 471 472 473 474 475 476 477 478
}

/**
 * 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);

479
	genpd_acquire_lock(genpd);
480
	pm_genpd_poweroff(genpd);
481
	genpd_release_lock(genpd);
482 483 484 485 486 487 488 489 490 491 492 493 494
}

/**
 * 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;
495
	bool (*stop_ok)(struct device *__dev);
496
	int ret;
497 498 499

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

500 501
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
502 503
		return -EINVAL;

504 505
	might_sleep_if(!genpd->dev_irq_safe);

506 507 508 509
	stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
	if (stop_ok && !stop_ok(dev))
		return -EBUSY;

510 511 512
	ret = genpd_stop_dev(genpd, dev);
	if (ret)
		return ret;
513

514 515 516
	pm_runtime_update_max_time_suspended(dev,
				dev_gpd_data(dev)->td.start_latency_ns);

517 518 519 520 521 522 523
	/*
	 * 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;

524
	mutex_lock(&genpd->lock);
525 526 527
	genpd->in_progress++;
	pm_genpd_poweroff(genpd);
	genpd->in_progress--;
528
	mutex_unlock(&genpd->lock);
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543

	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;
544
	DEFINE_WAIT(wait);
545 546 547 548
	int ret;

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

549 550
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
551 552
		return -EINVAL;

553 554 555 556 557 558
	might_sleep_if(!genpd->dev_irq_safe);

	/* If power.irq_safe, the PM domain is never powered off. */
	if (dev->power.irq_safe)
		goto out;

559
	mutex_lock(&genpd->lock);
560 561 562 563 564
	ret = __pm_genpd_poweron(genpd);
	if (ret) {
		mutex_unlock(&genpd->lock);
		return ret;
	}
565
	genpd->status = GPD_STATE_BUSY;
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
	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);
584
	__pm_genpd_restore_device(dev->power.subsys_data->domain_data, genpd);
585 586
	genpd->resume_count--;
	genpd_set_active(genpd);
587
	wake_up_all(&genpd->status_wait_queue);
588
	mutex_unlock(&genpd->lock);
589

590
 out:
591
	genpd_start_dev(genpd, dev);
592 593 594 595

	return 0;
}

596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
/**
 * 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);
}

611 612 613 614 615 616 617 618 619
#else

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 */

620 621
#ifdef CONFIG_PM_SLEEP

622 623 624 625 626 627
static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
				    struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
}

628 629 630 631 632 633 634 635 636 637 638 639 640 641 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
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);
}

668
/**
669
 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
670 671 672
 * @genpd: PM domain to power off, if possible.
 *
 * Check if the given PM domain can be powered off (during system suspend or
673
 * hibernation) and do that if so.  Also, in that case propagate to its masters.
674 675 676 677 678 679 680
 *
 * 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)
{
681
	struct gpd_link *link;
682

683
	if (genpd->status == GPD_STATE_POWER_OFF)
684 685
		return;

686 687
	if (genpd->suspended_count != genpd->device_count
	    || atomic_read(&genpd->sd_count) > 0)
688 689 690 691 692
		return;

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

693
	genpd->status = GPD_STATE_POWER_OFF;
694 695 696 697

	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_dec(link->master);
		pm_genpd_sync_poweroff(link->master);
698 699 700
	}
}

701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
/**
 * 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;

724
	active_wakeup = genpd_dev_active_wakeup(genpd, dev);
725 726 727
	return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
}

728 729 730 731 732 733 734 735 736 737 738 739
/**
 * 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;
740
	int ret;
741 742 743 744 745 746 747

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

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

748 749 750 751 752 753 754 755 756 757 758 759 760 761
	/*
	 * 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;
	}

762 763 764
	if (resume_needed(dev, genpd))
		pm_runtime_resume(dev);

765
	genpd_acquire_lock(genpd);
766 767

	if (genpd->prepared_count++ == 0)
768 769 770
		genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;

	genpd_release_lock(genpd);
771 772

	if (genpd->suspend_power_off) {
773
		pm_runtime_put_noidle(dev);
774 775 776 777
		return 0;
	}

	/*
778 779
	 * 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
780
	 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
781
	 * to make it operational.
782
	 */
783
	pm_runtime_resume(dev);
784 785
	__pm_runtime_disable(dev, false);

786 787 788 789 790 791 792 793
	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);
794
		pm_runtime_enable(dev);
795
	}
796 797

	pm_runtime_put_sync(dev);
798
	return ret;
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
}

/**
 * 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;

819
	return genpd->suspend_power_off ? 0 : genpd_suspend_dev(genpd, dev);
820 821 822
}

/**
823
 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
824 825 826 827 828 829
 * @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.
 */
830
static int pm_genpd_suspend_late(struct device *dev)
831 832 833 834 835 836 837 838 839
{
	struct generic_pm_domain *genpd;

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

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

840 841
	return genpd->suspend_power_off ? 0 : genpd_suspend_late(genpd, dev);
}
842

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
/**
 * 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;
859

860 861
	if (genpd->suspend_power_off
	    || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
862 863
		return 0;

864
	genpd_stop_dev(genpd, dev);
865 866 867 868 869 870 871 872 873 874 875 876 877

	/*
	 * 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;
}

/**
878
 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
879 880
 * @dev: Device to resume.
 *
881
 * Restore power to the device's PM domain, if necessary, and start the device.
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
 */
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;

	if (genpd->suspend_power_off)
		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--;

904
	return genpd_start_dev(genpd, dev);
905 906 907
}

/**
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
 * 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.
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
 * @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;

947
	return genpd->suspend_power_off ? 0 : genpd_resume_dev(genpd, dev);
948 949 950
}

/**
951
 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
 * @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;

968
	return genpd->suspend_power_off ? 0 : genpd_freeze_dev(genpd, dev);
969 970 971
}

/**
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
 * 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.
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
 * @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;

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

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
/**
 * 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;
1025

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

1028 1029 1030 1031 1032
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

	return genpd->suspend_power_off ? 0 : genpd_start_dev(genpd, dev);
1033 1034 1035
}

/**
1036
 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
1037 1038 1039 1040 1041 1042 1043
 * @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.
 */
1044
static int pm_genpd_thaw_early(struct device *dev)
1045 1046 1047 1048 1049 1050 1051 1052 1053
{
	struct generic_pm_domain *genpd;

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

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

1054
	return genpd->suspend_power_off ? 0 : genpd_thaw_early(genpd, dev);
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
}

/**
 * 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;

1075
	return genpd->suspend_power_off ? 0 : genpd_thaw_dev(genpd, dev);
1076 1077 1078
}

/**
1079
 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1080 1081
 * @dev: Device to resume.
 *
1082 1083
 * 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.
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
 */
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.
	 */
1100
	genpd->status = GPD_STATE_POWER_OFF;
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
	if (genpd->suspend_power_off) {
		/*
		 * The boot kernel might put the domain into the power on state,
		 * so make sure it really is powered off.
		 */
		if (genpd->power_off)
			genpd->power_off(genpd);
		return 0;
	}

	pm_genpd_poweron(genpd);
	genpd->suspended_count--;

1114
	return genpd_start_dev(genpd, dev);
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
}

/**
 * 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);
1147
		pm_runtime_set_active(dev);
1148
		pm_runtime_enable(dev);
1149
		pm_runtime_idle(dev);
1150 1151 1152 1153 1154 1155 1156
	}
}

#else

#define pm_genpd_prepare		NULL
#define pm_genpd_suspend		NULL
1157
#define pm_genpd_suspend_late		NULL
1158
#define pm_genpd_suspend_noirq		NULL
1159
#define pm_genpd_resume_early		NULL
1160 1161 1162
#define pm_genpd_resume_noirq		NULL
#define pm_genpd_resume			NULL
#define pm_genpd_freeze			NULL
1163
#define pm_genpd_freeze_late		NULL
1164
#define pm_genpd_freeze_noirq		NULL
1165
#define pm_genpd_thaw_early		NULL
1166 1167 1168 1169 1170 1171 1172
#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 */

1173
/**
1174
 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1175 1176
 * @genpd: PM domain to add the device to.
 * @dev: Device to be added.
1177
 * @td: Set of PM QoS timing parameters to attach to the device.
1178
 */
1179 1180
int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
			  struct gpd_timing_data *td)
1181
{
1182
	struct generic_pm_domain_data *gpd_data;
1183
	struct pm_domain_data *pdd;
1184 1185 1186 1187 1188 1189 1190
	int ret = 0;

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

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

1191
	genpd_acquire_lock(genpd);
1192

1193
	if (genpd->status == GPD_STATE_POWER_OFF) {
1194 1195 1196 1197
		ret = -EINVAL;
		goto out;
	}

1198 1199 1200 1201 1202
	if (genpd->prepared_count > 0) {
		ret = -EAGAIN;
		goto out;
	}

1203 1204
	list_for_each_entry(pdd, &genpd->dev_list, list_node)
		if (pdd->dev == dev) {
1205 1206 1207 1208
			ret = -EINVAL;
			goto out;
		}

1209 1210 1211 1212 1213 1214
	gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
	if (!gpd_data) {
		ret = -ENOMEM;
		goto out;
	}

1215
	genpd->device_count++;
1216 1217

	dev->pm_domain = &genpd->domain;
1218
	dev_pm_get_subsys_data(dev);
1219 1220 1221 1222
	dev->power.subsys_data->domain_data = &gpd_data->base;
	gpd_data->base.dev = dev;
	gpd_data->need_restore = false;
	list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1223 1224
	if (td)
		gpd_data->td = *td;
1225 1226

 out:
1227
	genpd_release_lock(genpd);
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239

	return ret;
}

/**
 * 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)
{
1240
	struct pm_domain_data *pdd;
1241 1242 1243 1244 1245 1246 1247
	int ret = -EINVAL;

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

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

1248
	genpd_acquire_lock(genpd);
1249

1250 1251 1252 1253 1254
	if (genpd->prepared_count > 0) {
		ret = -EAGAIN;
		goto out;
	}

1255 1256
	list_for_each_entry(pdd, &genpd->dev_list, list_node) {
		if (pdd->dev != dev)
1257 1258
			continue;

1259 1260 1261
		list_del_init(&pdd->list_node);
		pdd->dev = NULL;
		dev_pm_put_subsys_data(dev);
1262
		dev->pm_domain = NULL;
1263
		kfree(to_gpd_data(pdd));
1264

1265
		genpd->device_count--;
1266 1267 1268 1269 1270

		ret = 0;
		break;
	}

1271
 out:
1272
	genpd_release_lock(genpd);
1273 1274 1275 1276 1277 1278 1279

	return ret;
}

/**
 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
 * @genpd: Master PM domain to add the subdomain to.
1280
 * @subdomain: Subdomain to be added.
1281 1282
 */
int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1283
			   struct generic_pm_domain *subdomain)
1284
{
1285
	struct gpd_link *link;
1286 1287
	int ret = 0;

1288
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1289 1290
		return -EINVAL;

1291 1292
 start:
	genpd_acquire_lock(genpd);
1293
	mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1294

1295 1296 1297
	if (subdomain->status != GPD_STATE_POWER_OFF
	    && subdomain->status != GPD_STATE_ACTIVE) {
		mutex_unlock(&subdomain->lock);
1298 1299 1300 1301 1302
		genpd_release_lock(genpd);
		goto start;
	}

	if (genpd->status == GPD_STATE_POWER_OFF
1303
	    &&  subdomain->status != GPD_STATE_POWER_OFF) {
1304 1305 1306 1307
		ret = -EINVAL;
		goto out;
	}

1308
	list_for_each_entry(link, &genpd->slave_links, slave_node) {
1309
		if (link->slave == subdomain && link->master == genpd) {
1310 1311 1312 1313 1314
			ret = -EINVAL;
			goto out;
		}
	}

1315 1316 1317 1318 1319 1320 1321
	link = kzalloc(sizeof(*link), GFP_KERNEL);
	if (!link) {
		ret = -ENOMEM;
		goto out;
	}
	link->master = genpd;
	list_add_tail(&link->master_node, &genpd->master_links);
1322 1323 1324
	link->slave = subdomain;
	list_add_tail(&link->slave_node, &subdomain->slave_links);
	if (subdomain->status != GPD_STATE_POWER_OFF)
1325
		genpd_sd_counter_inc(genpd);
1326 1327

 out:
1328
	mutex_unlock(&subdomain->lock);
1329
	genpd_release_lock(genpd);
1330 1331 1332 1333 1334 1335 1336

	return ret;
}

/**
 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
 * @genpd: Master PM domain to remove the subdomain from.
1337
 * @subdomain: Subdomain to be removed.
1338 1339
 */
int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1340
			      struct generic_pm_domain *subdomain)
1341
{
1342
	struct gpd_link *link;
1343 1344
	int ret = -EINVAL;

1345
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1346 1347
		return -EINVAL;

1348 1349
 start:
	genpd_acquire_lock(genpd);
1350

1351 1352
	list_for_each_entry(link, &genpd->master_links, master_node) {
		if (link->slave != subdomain)
1353 1354 1355 1356
			continue;

		mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);

1357 1358 1359 1360 1361 1362 1363
		if (subdomain->status != GPD_STATE_POWER_OFF
		    && subdomain->status != GPD_STATE_ACTIVE) {
			mutex_unlock(&subdomain->lock);
			genpd_release_lock(genpd);
			goto start;
		}

1364 1365 1366
		list_del(&link->master_node);
		list_del(&link->slave_node);
		kfree(link);
1367
		if (subdomain->status != GPD_STATE_POWER_OFF)
1368 1369 1370 1371 1372 1373 1374 1375
			genpd_sd_counter_dec(genpd);

		mutex_unlock(&subdomain->lock);

		ret = 0;
		break;
	}

1376
	genpd_release_lock(genpd);
1377 1378 1379 1380

	return ret;
}

1381 1382 1383 1384
/**
 * 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.
1385
 * @td: Timing data to add to the device along with the callbacks (optional).
1386
 */
1387 1388
int pm_genpd_add_callbacks(struct device *dev, struct gpd_dev_ops *ops,
			   struct gpd_timing_data *td)
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
{
	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;
1404 1405
		if (td)
			gpd_data->td = *td;
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
	} else {
		ret = -EINVAL;
	}

	device_pm_unlock();
	pm_runtime_enable(dev);

	return ret;
}
EXPORT_SYMBOL_GPL(pm_genpd_add_callbacks);

/**
1418
 * __pm_genpd_remove_callbacks - Remove PM domain callbacks from a given device.
1419
 * @dev: Device to remove the callbacks from.
1420
 * @clear_td: If set, clear the device's timing data too.
1421
 */
1422
int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437
{
	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 };
1438 1439
		if (clear_td)
			gpd_data->td = (struct gpd_timing_data){ 0 };
1440 1441 1442 1443 1444 1445 1446 1447 1448
	} else {
		ret = -EINVAL;
	}

	device_pm_unlock();
	pm_runtime_enable(dev);

	return ret;
}
1449
EXPORT_SYMBOL_GPL(__pm_genpd_remove_callbacks);
1450

1451 1452
/* Default device callbacks for generic PM domains. */

1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
/**
 * 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);
	struct device_driver *drv = dev->driver;

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

	if (drv && drv->pm && drv->pm->runtime_suspend)
		return drv->pm->runtime_suspend(dev);

	return 0;
}

/**
 * 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);
	struct device_driver *drv = dev->driver;

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

	if (drv && drv->pm && drv->pm->runtime_resume)
		return drv->pm->runtime_resume(dev);

	return 0;
}

1491 1492
#ifdef CONFIG_PM_SLEEP

1493 1494 1495 1496 1497 1498
/**
 * pm_genpd_default_suspend - Default "device suspend" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_suspend(struct device *dev)
{
1499
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend;
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509

	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)
{
1510
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.suspend_late;
1511

1512
	return cb ? cb(dev) : pm_generic_suspend_late(dev);
1513 1514 1515 1516 1517 1518 1519 1520
}

/**
 * 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)
{
1521
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume_early;
1522

1523
	return cb ? cb(dev) : pm_generic_resume_early(dev);
1524 1525 1526 1527 1528 1529 1530 1531
}

/**
 * pm_genpd_default_resume - Default "device resume" for PM domians.
 * @dev: Device to handle.
 */
static int pm_genpd_default_resume(struct device *dev)
{
1532
	int (*cb)(struct device *__dev) = dev_gpd_data(dev)->ops.resume;
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555

	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;

1556
	return cb ? cb(dev) : pm_generic_freeze_late(dev);
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
}

/**
 * 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;

1567
	return cb ? cb(dev) : pm_generic_thaw_early(dev);
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
}

/**
 * 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);
}

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
#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 */

1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
/**
 * 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;

1606 1607
	INIT_LIST_HEAD(&genpd->master_links);
	INIT_LIST_HEAD(&genpd->slave_links);
1608 1609 1610 1611 1612
	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;
1613
	atomic_set(&genpd->sd_count, 0);
1614 1615
	genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
	init_waitqueue_head(&genpd->status_wait_queue);
1616 1617
	genpd->poweroff_task = NULL;
	genpd->resume_count = 0;
1618 1619
	genpd->device_count = 0;
	genpd->suspended_count = 0;
1620
	genpd->max_off_time_ns = -1;
1621 1622 1623
	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;
1624 1625
	genpd->domain.ops.prepare = pm_genpd_prepare;
	genpd->domain.ops.suspend = pm_genpd_suspend;
1626
	genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
1627 1628
	genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
	genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1629
	genpd->domain.ops.resume_early = pm_genpd_resume_early;
1630 1631
	genpd->domain.ops.resume = pm_genpd_resume;
	genpd->domain.ops.freeze = pm_genpd_freeze;
1632
	genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
1633 1634
	genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
	genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1635
	genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
1636
	genpd->domain.ops.thaw = pm_genpd_thaw;
1637
	genpd->domain.ops.poweroff = pm_genpd_suspend;
1638
	genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
1639
	genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
1640
	genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1641
	genpd->domain.ops.restore_early = pm_genpd_resume_early;
1642
	genpd->domain.ops.restore = pm_genpd_resume;
1643
	genpd->domain.ops.complete = pm_genpd_complete;
1644 1645
	genpd->dev_ops.save_state = pm_genpd_default_save_state;
	genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
1646 1647 1648 1649
	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;
1650 1651 1652 1653
	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;
1654 1655 1656 1657
	mutex_lock(&gpd_list_lock);
	list_add(&genpd->gpd_list_node, &gpd_list);
	mutex_unlock(&gpd_list_lock);
}