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

34 35 36 37 38
#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));		\
39 40 41
	struct gpd_timing_data *__td = &dev_gpd_data(dev)->td;			\
	if (!__retval && __elapsed > __td->field) {				\
		__td->field = __elapsed;					\
42
		dev_dbg(dev, name " latency exceeded, new value %lld ns\n",	\
43
			__elapsed);						\
44 45
		genpd->max_off_time_changed = true;				\
		__td->constraint_changed = true;				\
46 47 48 49
	}									\
	__retval;								\
})

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

53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
static struct generic_pm_domain *pm_genpd_lookup_name(const char *domain_name)
{
	struct generic_pm_domain *genpd = NULL, *gpd;

	if (IS_ERR_OR_NULL(domain_name))
		return NULL;

	mutex_lock(&gpd_list_lock);
	list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
		if (!strcmp(gpd->name, domain_name)) {
			genpd = gpd;
			break;
		}
	}
	mutex_unlock(&gpd_list_lock);
	return genpd;
}

71
struct generic_pm_domain *dev_to_genpd(struct device *dev)
72 73 74 75
{
	if (IS_ERR_OR_NULL(dev->pm_domain))
		return ERR_PTR(-EINVAL);

76
	return pd_to_genpd(dev->pm_domain);
77
}
78

79 80
static int genpd_stop_dev(struct generic_pm_domain *genpd, struct device *dev)
{
81 82
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, stop, dev,
					stop_latency_ns, "stop");
83 84 85 86
}

static int genpd_start_dev(struct generic_pm_domain *genpd, struct device *dev)
{
87 88
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, start, dev,
					start_latency_ns, "start");
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
	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);
104
	smp_mb__after_atomic();
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 144 145
static void genpd_recalc_cpu_exit_latency(struct generic_pm_domain *genpd)
{
	s64 usecs64;

146
	if (!genpd->cpuidle_data)
147 148 149 150
		return;

	usecs64 = genpd->power_on_latency_ns;
	do_div(usecs64, NSEC_PER_USEC);
151 152
	usecs64 += genpd->cpuidle_data->saved_exit_latency;
	genpd->cpuidle_data->idle_state->exit_latency = usecs64;
153 154
}

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
static int genpd_power_on(struct generic_pm_domain *genpd)
{
	ktime_t time_start;
	s64 elapsed_ns;
	int ret;

	if (!genpd->power_on)
		return 0;

	time_start = ktime_get();
	ret = genpd->power_on(genpd);
	if (ret)
		return ret;

	elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
	if (elapsed_ns <= genpd->power_on_latency_ns)
		return ret;

	genpd->power_on_latency_ns = elapsed_ns;
	genpd->max_off_time_changed = true;
	genpd_recalc_cpu_exit_latency(genpd);
	pr_warn("%s: Power-%s latency exceeded, new value %lld ns\n",
		genpd->name, "on", elapsed_ns);

	return ret;
}

static int genpd_power_off(struct generic_pm_domain *genpd)
{
	ktime_t time_start;
	s64 elapsed_ns;
	int ret;

	if (!genpd->power_off)
		return 0;

	time_start = ktime_get();
	ret = genpd->power_off(genpd);
	if (ret == -EBUSY)
		return ret;

	elapsed_ns = ktime_to_ns(ktime_sub(ktime_get(), time_start));
	if (elapsed_ns <= genpd->power_off_latency_ns)
		return ret;

	genpd->power_off_latency_ns = elapsed_ns;
	genpd->max_off_time_changed = true;
	pr_warn("%s: Power-%s latency exceeded, new value %lld ns\n",
		genpd->name, "off", elapsed_ns);

	return ret;
}

208
/**
209
 * __pm_genpd_poweron - Restore power to a given PM domain and its masters.
210 211
 * @genpd: PM domain to power up.
 *
212
 * Restore power to @genpd and all of its masters so that it is possible to
213 214
 * resume a device belonging to it.
 */
215
static int __pm_genpd_poweron(struct generic_pm_domain *genpd)
216
	__releases(&genpd->lock) __acquires(&genpd->lock)
217
{
218
	struct gpd_link *link;
219
	DEFINE_WAIT(wait);
220 221
	int ret = 0;

222
	/* If the domain's master is being waited for, we have to wait too. */
223 224 225
	for (;;) {
		prepare_to_wait(&genpd->status_wait_queue, &wait,
				TASK_UNINTERRUPTIBLE);
226
		if (genpd->status != GPD_STATE_WAIT_MASTER)
227 228
			break;
		mutex_unlock(&genpd->lock);
229

230 231 232 233 234
		schedule();

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

236
	if (genpd->status == GPD_STATE_ACTIVE
237
	    || (genpd->prepared_count > 0 && genpd->suspend_power_off))
238
		return 0;
239

240 241
	if (genpd->status != GPD_STATE_POWER_OFF) {
		genpd_set_active(genpd);
242
		return 0;
243 244
	}

245
	if (genpd->cpuidle_data) {
246
		cpuidle_pause_and_lock();
247
		genpd->cpuidle_data->idle_state->disabled = true;
248 249 250 251
		cpuidle_resume_and_unlock();
		goto out;
	}

252 253 254 255 256 257 258
	/*
	 * 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);
259
		genpd->status = GPD_STATE_WAIT_MASTER;
260

261 262
		mutex_unlock(&genpd->lock);

263
		ret = pm_genpd_poweron(link->master);
264 265 266

		mutex_lock(&genpd->lock);

267 268
		/*
		 * The "wait for parent" status is guaranteed not to change
269
		 * while the master is powering on.
270 271 272
		 */
		genpd->status = GPD_STATE_POWER_OFF;
		wake_up_all(&genpd->status_wait_queue);
273 274
		if (ret) {
			genpd_sd_counter_dec(link->master);
275
			goto err;
276
		}
277 278
	}

279 280 281
	ret = genpd_power_on(genpd);
	if (ret)
		goto err;
282

283
 out:
284 285
	genpd_set_active(genpd);

286
	return 0;
287 288

 err:
289 290
	list_for_each_entry_continue_reverse(link, &genpd->slave_links, slave_node)
		genpd_sd_counter_dec(link->master);
291

292 293 294 295
	return ret;
}

/**
296
 * pm_genpd_poweron - Restore power to a given PM domain and its masters.
297 298 299 300 301 302 303 304 305 306
 * @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;
307 308
}

309 310 311 312 313 314 315 316 317 318 319 320
/**
 * pm_genpd_name_poweron - Restore power to a given PM domain and its masters.
 * @domain_name: Name of the PM domain to power up.
 */
int pm_genpd_name_poweron(const char *domain_name)
{
	struct generic_pm_domain *genpd;

	genpd = pm_genpd_lookup_name(domain_name);
	return genpd ? pm_genpd_poweron(genpd) : -EINVAL;
}

321 322
#ifdef CONFIG_PM_RUNTIME

323 324 325 326 327 328
static int genpd_start_dev_no_timing(struct generic_pm_domain *genpd,
				     struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, int, start, dev);
}

329 330 331 332 333 334 335 336 337 338 339 340 341
static int genpd_save_dev(struct generic_pm_domain *genpd, struct device *dev)
{
	return GENPD_DEV_TIMED_CALLBACK(genpd, int, save_state, dev,
					save_state_latency_ns, "state save");
}

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

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
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;
366
		if (pdd && pdd->dev) {
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
			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;
}

389 390
/**
 * __pm_genpd_save_device - Save the pre-suspend state of a device.
391
 * @pdd: Domain data of the device to save the state of.
392 393
 * @genpd: PM domain the device belongs to.
 */
394
static int __pm_genpd_save_device(struct pm_domain_data *pdd,
395
				  struct generic_pm_domain *genpd)
396
	__releases(&genpd->lock) __acquires(&genpd->lock)
397
{
398
	struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
399
	struct device *dev = pdd->dev;
400 401
	int ret = 0;

402
	if (gpd_data->need_restore > 0)
403 404
		return 0;

405 406 407 408 409 410 411 412 413 414
	/*
	 * If the value of the need_restore flag is still unknown at this point,
	 * we trust that pm_genpd_poweroff() has verified that the device is
	 * already runtime PM suspended.
	 */
	if (gpd_data->need_restore < 0) {
		gpd_data->need_restore = 1;
		return 0;
	}

415 416
	mutex_unlock(&genpd->lock);

417 418 419
	genpd_start_dev(genpd, dev);
	ret = genpd_save_dev(genpd, dev);
	genpd_stop_dev(genpd, dev);
420

421 422
	mutex_lock(&genpd->lock);

423
	if (!ret)
424
		gpd_data->need_restore = 1;
425 426 427 428 429 430

	return ret;
}

/**
 * __pm_genpd_restore_device - Restore the pre-suspend state of a device.
431
 * @pdd: Domain data of the device to restore the state of.
432 433
 * @genpd: PM domain the device belongs to.
 */
434
static void __pm_genpd_restore_device(struct pm_domain_data *pdd,
435
				      struct generic_pm_domain *genpd)
436
	__releases(&genpd->lock) __acquires(&genpd->lock)
437
{
438
	struct generic_pm_domain_data *gpd_data = to_gpd_data(pdd);
439
	struct device *dev = pdd->dev;
440
	int need_restore = gpd_data->need_restore;
441

442
	gpd_data->need_restore = 0;
443 444
	mutex_unlock(&genpd->lock);

445
	genpd_start_dev(genpd, dev);
446 447 448 449 450

	/*
	 * Call genpd_restore_dev() for recently added devices too (need_restore
	 * is negative then).
	 */
451 452
	if (need_restore)
		genpd_restore_dev(genpd, dev);
453

454
	mutex_lock(&genpd->lock);
455 456
}

457 458 459 460 461 462 463 464 465 466 467
/**
 * 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)
{
468
	return genpd->status == GPD_STATE_WAIT_MASTER
469
		|| genpd->status == GPD_STATE_ACTIVE || genpd->resume_count > 0;
470 471
}

472 473 474 475 476 477 478
/**
 * 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.
 */
479
static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
480
{
481
	queue_work(pm_wq, &genpd->power_off_work);
482 483
}

484 485 486 487 488 489 490 491 492
/**
 * 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)
493
	__releases(&genpd->lock) __acquires(&genpd->lock)
494
{
495
	struct pm_domain_data *pdd;
496
	struct gpd_link *link;
497
	unsigned int not_suspended;
498
	int ret = 0;
499

500 501 502 503
 start:
	/*
	 * Do not try to power off the domain in the following situations:
	 * (1) The domain is already in the "power off" state.
504
	 * (2) The domain is waiting for its master to power up.
505
	 * (3) One of the domain's devices is being resumed right now.
506
	 * (4) System suspend is in progress.
507
	 */
508
	if (genpd->status == GPD_STATE_POWER_OFF
509
	    || genpd->status == GPD_STATE_WAIT_MASTER
510
	    || genpd->resume_count > 0 || genpd->prepared_count > 0)
511 512
		return 0;

513
	if (atomic_read(&genpd->sd_count) > 0)
514 515 516
		return -EBUSY;

	not_suspended = 0;
517 518 519 520 521 522 523 524 525
	list_for_each_entry(pdd, &genpd->dev_list, list_node) {
		enum pm_qos_flags_status stat;

		stat = dev_pm_qos_flags(pdd->dev,
					PM_QOS_FLAG_NO_POWER_OFF
						| PM_QOS_FLAG_REMOTE_WAKEUP);
		if (stat > PM_QOS_FLAGS_NONE)
			return -EBUSY;

526
		if (pdd->dev->driver && (!pm_runtime_suspended(pdd->dev)
527
		    || pdd->dev->power.irq_safe))
528
			not_suspended++;
529
	}
530 531 532 533

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

534 535 536 537 538 539 540 541 542
	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;
	}

543 544 545 546 547
	if (genpd->gov && genpd->gov->power_down_ok) {
		if (!genpd->gov->power_down_ok(&genpd->domain))
			return -EAGAIN;
	}

548
	genpd->status = GPD_STATE_BUSY;
549
	genpd->poweroff_task = current;
550

551
	list_for_each_entry_reverse(pdd, &genpd->dev_list, list_node) {
552
		ret = atomic_read(&genpd->sd_count) == 0 ?
553
			__pm_genpd_save_device(pdd, genpd) : -EBUSY;
554 555 556 557

		if (genpd_abort_poweroff(genpd))
			goto out;

558 559 560 561
		if (ret) {
			genpd_set_active(genpd);
			goto out;
		}
562

563 564 565 566 567
		if (genpd->status == GPD_STATE_REPEAT) {
			genpd->poweroff_task = NULL;
			goto start;
		}
	}
568

569
	if (genpd->cpuidle_data) {
570
		/*
571 572 573 574 575
		 * If cpuidle_data is set, cpuidle should turn the domain off
		 * when the CPU in it is idle.  In that case we don't decrement
		 * the subdomain counts of the master domains, so that power is
		 * not removed from the current domain prematurely as a result
		 * of cutting off the masters' power.
576 577 578
		 */
		genpd->status = GPD_STATE_POWER_OFF;
		cpuidle_pause_and_lock();
579
		genpd->cpuidle_data->idle_state->disabled = false;
580 581 582 583
		cpuidle_resume_and_unlock();
		goto out;
	}

584 585 586
	if (genpd->power_off) {
		if (atomic_read(&genpd->sd_count) > 0) {
			ret = -EBUSY;
587 588
			goto out;
		}
589

590
		/*
591 592
		 * If sd_count > 0 at this point, one of the subdomains hasn't
		 * managed to call pm_genpd_poweron() for the master yet after
593 594 595 596 597
		 * 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).
		 */
598
		ret = genpd_power_off(genpd);
599 600 601 602 603
		if (ret == -EBUSY) {
			genpd_set_active(genpd);
			goto out;
		}
	}
604

605
	genpd->status = GPD_STATE_POWER_OFF;
606

607 608 609 610
	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_dec(link->master);
		genpd_queue_power_off_work(link->master);
	}
611

612 613 614 615
 out:
	genpd->poweroff_task = NULL;
	wake_up_all(&genpd->status_wait_queue);
	return ret;
616 617 618 619 620 621 622 623 624 625 626 627
}

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

628
	genpd_acquire_lock(genpd);
629
	pm_genpd_poweroff(genpd);
630
	genpd_release_lock(genpd);
631 632 633 634 635 636 637 638 639 640 641 642 643
}

/**
 * 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;
644
	struct generic_pm_domain_data *gpd_data;
645
	bool (*stop_ok)(struct device *__dev);
646
	int ret;
647 648 649

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

650 651
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
652 653
		return -EINVAL;

654 655 656 657
	stop_ok = genpd->gov ? genpd->gov->stop_ok : NULL;
	if (stop_ok && !stop_ok(dev))
		return -EBUSY;

658 659 660
	ret = genpd_stop_dev(genpd, dev);
	if (ret)
		return ret;
661

662 663 664 665 666 667 668
	/*
	 * 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;

669
	mutex_lock(&genpd->lock);
670 671 672 673 674 675 676 677 678 679

	/*
	 * If we have an unknown state of the need_restore flag, it means none
	 * of the runtime PM callbacks has been invoked yet. Let's update the
	 * flag to reflect that the current state is active.
	 */
	gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
	if (gpd_data->need_restore < 0)
		gpd_data->need_restore = 0;

680 681 682
	genpd->in_progress++;
	pm_genpd_poweroff(genpd);
	genpd->in_progress--;
683
	mutex_unlock(&genpd->lock);
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698

	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;
699
	DEFINE_WAIT(wait);
700 701 702 703
	int ret;

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

704 705
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
706 707
		return -EINVAL;

708 709
	/* If power.irq_safe, the PM domain is never powered off. */
	if (dev->power.irq_safe)
710
		return genpd_start_dev_no_timing(genpd, dev);
711

712
	mutex_lock(&genpd->lock);
713 714 715 716 717
	ret = __pm_genpd_poweron(genpd);
	if (ret) {
		mutex_unlock(&genpd->lock);
		return ret;
	}
718
	genpd->status = GPD_STATE_BUSY;
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
	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);
737
	__pm_genpd_restore_device(dev->power.subsys_data->domain_data, genpd);
738 739
	genpd->resume_count--;
	genpd_set_active(genpd);
740
	wake_up_all(&genpd->status_wait_queue);
741
	mutex_unlock(&genpd->lock);
742

743 744 745
	return 0;
}

746 747 748 749 750 751 752 753
static bool pd_ignore_unused;
static int __init pd_ignore_unused_setup(char *__unused)
{
	pd_ignore_unused = true;
	return 1;
}
__setup("pd_ignore_unused", pd_ignore_unused_setup);

754 755 756 757 758 759 760
/**
 * 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;

761 762 763 764 765
	if (pd_ignore_unused) {
		pr_warn("genpd: Not disabling unused power domains\n");
		return;
	}

766 767 768 769 770 771 772 773
	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);
}

774 775 776 777 778 779 780
static int __init genpd_poweroff_unused(void)
{
	pm_genpd_poweroff_unused();
	return 0;
}
late_initcall(genpd_poweroff_unused);

781 782
#else

783 784 785 786 787 788
static inline int genpd_dev_pm_qos_notifier(struct notifier_block *nb,
					    unsigned long val, void *ptr)
{
	return NOTIFY_DONE;
}

789 790 791
static inline void
genpd_queue_power_off_work(struct generic_pm_domain *genpd) {}

792 793 794 795 796 797 798
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 */

799 800
#ifdef CONFIG_PM_SLEEP

801 802 803 804
/**
 * pm_genpd_present - Check if the given PM domain has been initialized.
 * @genpd: PM domain to check.
 */
805
static bool pm_genpd_present(const struct generic_pm_domain *genpd)
806
{
807
	const struct generic_pm_domain *gpd;
808 809 810 811 812 813 814 815 816 817 818

	if (IS_ERR_OR_NULL(genpd))
		return false;

	list_for_each_entry(gpd, &gpd_list, gpd_list_node)
		if (gpd == genpd)
			return true;

	return false;
}

819 820 821 822 823 824
static bool genpd_dev_active_wakeup(struct generic_pm_domain *genpd,
				    struct device *dev)
{
	return GENPD_DEV_CALLBACK(genpd, bool, active_wakeup, dev);
}

825
/**
826
 * pm_genpd_sync_poweroff - Synchronously power off a PM domain and its masters.
827 828 829
 * @genpd: PM domain to power off, if possible.
 *
 * Check if the given PM domain can be powered off (during system suspend or
830
 * hibernation) and do that if so.  Also, in that case propagate to its masters.
831
 *
832 833 834 835
 * This function is only called in "noirq" and "syscore" 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).
836 837 838
 */
static void pm_genpd_sync_poweroff(struct generic_pm_domain *genpd)
{
839
	struct gpd_link *link;
840

841
	if (genpd->status == GPD_STATE_POWER_OFF)
842 843
		return;

844 845
	if (genpd->suspended_count != genpd->device_count
	    || atomic_read(&genpd->sd_count) > 0)
846 847
		return;

848
	genpd_power_off(genpd);
849

850
	genpd->status = GPD_STATE_POWER_OFF;
851 852 853 854

	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		genpd_sd_counter_dec(link->master);
		pm_genpd_sync_poweroff(link->master);
855 856 857
	}
}

858 859 860 861
/**
 * pm_genpd_sync_poweron - Synchronously power on a PM domain and its masters.
 * @genpd: PM domain to power on.
 *
862 863 864 865
 * This function is only called in "noirq" and "syscore" 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).
866 867 868 869 870 871 872 873 874 875 876 877 878
 */
static void pm_genpd_sync_poweron(struct generic_pm_domain *genpd)
{
	struct gpd_link *link;

	if (genpd->status != GPD_STATE_POWER_OFF)
		return;

	list_for_each_entry(link, &genpd->slave_links, slave_node) {
		pm_genpd_sync_poweron(link->master);
		genpd_sd_counter_inc(link->master);
	}

879
	genpd_power_on(genpd);
880 881 882 883

	genpd->status = GPD_STATE_ACTIVE;
}

884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
/**
 * 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;

907
	active_wakeup = genpd_dev_active_wakeup(genpd, dev);
908 909 910
	return device_may_wakeup(dev) ? active_wakeup : !active_wakeup;
}

911 912 913 914 915 916 917 918 919 920 921 922
/**
 * 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;
923
	int ret;
924 925 926 927 928 929 930

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

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

931 932 933 934 935 936 937 938 939 940
	/*
	 * 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()) {
941
		pm_runtime_put(dev);
942 943 944
		return -EBUSY;
	}

945 946 947
	if (resume_needed(dev, genpd))
		pm_runtime_resume(dev);

948
	genpd_acquire_lock(genpd);
949

950 951
	if (genpd->prepared_count++ == 0) {
		genpd->suspended_count = 0;
952
		genpd->suspend_power_off = genpd->status == GPD_STATE_POWER_OFF;
953
	}
954 955

	genpd_release_lock(genpd);
956 957

	if (genpd->suspend_power_off) {
958
		pm_runtime_put_noidle(dev);
959 960 961 962
		return 0;
	}

	/*
963 964
	 * 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
965
	 * is suspended (e.g. it's been stopped by genpd_stop_dev()), we need
966
	 * to make it operational.
967
	 */
968
	pm_runtime_resume(dev);
969 970
	__pm_runtime_disable(dev, false);

971 972 973 974 975 976 977 978
	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);
979
		pm_runtime_enable(dev);
980
	}
981

982
	pm_runtime_put(dev);
983
	return ret;
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
}

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

1004
	return genpd->suspend_power_off ? 0 : pm_generic_suspend(dev);
1005 1006 1007
}

/**
1008
 * pm_genpd_suspend_late - Late suspend of a device from an I/O PM domain.
1009 1010 1011 1012 1013 1014
 * @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.
 */
1015
static int pm_genpd_suspend_late(struct device *dev)
1016 1017 1018 1019 1020 1021 1022 1023 1024
{
	struct generic_pm_domain *genpd;

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

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

1025
	return genpd->suspend_power_off ? 0 : pm_generic_suspend_late(dev);
1026
}
1027

1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
/**
 * 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;
1044

1045
	if (genpd->suspend_power_off
1046
	    || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
1047 1048
		return 0;

1049
	genpd_stop_dev(genpd, dev);
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062

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

/**
1063
 * pm_genpd_resume_noirq - Start of resume of device in an I/O PM domain.
1064 1065
 * @dev: Device to resume.
 *
1066
 * Restore power to the device's PM domain, if necessary, and start the device.
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
 */
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;

1078
	if (genpd->suspend_power_off
1079
	    || (dev->power.wakeup_path && genpd_dev_active_wakeup(genpd, dev)))
1080 1081 1082 1083 1084 1085 1086
		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.
	 */
1087
	pm_genpd_sync_poweron(genpd);
1088 1089
	genpd->suspended_count--;

1090
	return genpd_start_dev(genpd, dev);
1091 1092 1093
}

/**
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
 * 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;

1112
	return genpd->suspend_power_off ? 0 : pm_generic_resume_early(dev);
1113 1114 1115 1116
}

/**
 * pm_genpd_resume - Resume of device in an I/O PM domain.
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
 * @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;

1133
	return genpd->suspend_power_off ? 0 : pm_generic_resume(dev);
1134 1135 1136
}

/**
1137
 * pm_genpd_freeze - Freezing a device in an I/O PM domain.
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
 * @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;

1154
	return genpd->suspend_power_off ? 0 : pm_generic_freeze(dev);
1155 1156 1157
}

/**
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
 * 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;

1176
	return genpd->suspend_power_off ? 0 : pm_generic_freeze_late(dev);
1177 1178 1179 1180
}

/**
 * pm_genpd_freeze_noirq - Completion of freezing a device in an I/O PM domain.
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
 * @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;

1198
	return genpd->suspend_power_off ? 0 : genpd_stop_dev(genpd, dev);
1199
}
1200

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
/**
 * 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;
1211

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

1214 1215 1216 1217
	genpd = dev_to_genpd(dev);
	if (IS_ERR(genpd))
		return -EINVAL;

1218
	return genpd->suspend_power_off ? 0 : genpd_start_dev(genpd, dev);
1219 1220 1221
}

/**
1222
 * pm_genpd_thaw_early - Early thaw of device in an I/O PM domain.
1223 1224 1225 1226 1227 1228 1229
 * @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.
 */
1230
static int pm_genpd_thaw_early(struct device *dev)
1231 1232 1233 1234 1235 1236 1237 1238 1239
{
	struct generic_pm_domain *genpd;

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

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

1240
	return genpd->suspend_power_off ? 0 : pm_generic_thaw_early(dev);
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
}

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

1261
	return genpd->suspend_power_off ? 0 : pm_generic_thaw(dev);
1262 1263 1264
}

/**
1265
 * pm_genpd_restore_noirq - Start of restore of device in an I/O PM domain.
1266 1267
 * @dev: Device to resume.
 *
1268 1269
 * 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.
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284
 */
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.
1285 1286 1287
	 *
	 * At this point suspended_count == 0 means we are being run for the
	 * first time for the given domain in the present cycle.
1288
	 */
1289
	if (genpd->suspended_count++ == 0) {
1290
		/*
1291
		 * The boot kernel might put the domain into arbitrary state,
1292 1293
		 * so make it appear as powered off to pm_genpd_sync_poweron(),
		 * so that it tries to power it on in case it was really off.
1294
		 */
1295 1296 1297 1298 1299 1300
		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.
			 */
1301
			genpd_power_off(genpd);
1302 1303 1304

			return 0;
		}
1305 1306
	}

1307 1308 1309
	if (genpd->suspend_power_off)
		return 0;

1310
	pm_genpd_sync_poweron(genpd);
1311

1312
	return genpd_start_dev(genpd, dev);
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
}

/**
 * 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);
1345
		pm_runtime_set_active(dev);
1346
		pm_runtime_enable(dev);
1347
		pm_request_idle(dev);
1348 1349 1350
	}
}

1351
/**
1352
 * genpd_syscore_switch - Switch power during system core suspend or resume.
1353 1354 1355 1356 1357
 * @dev: Device that normally is marked as "always on" to switch power for.
 *
 * This routine may only be called during the system core (syscore) suspend or
 * resume phase for devices whose "always on" flags are set.
 */
1358
static void genpd_syscore_switch(struct device *dev, bool suspend)
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
{
	struct generic_pm_domain *genpd;

	genpd = dev_to_genpd(dev);
	if (!pm_genpd_present(genpd))
		return;

	if (suspend) {
		genpd->suspended_count++;
		pm_genpd_sync_poweroff(genpd);
	} else {
		pm_genpd_sync_poweron(genpd);
		genpd->suspended_count--;
	}
}
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385

void pm_genpd_syscore_poweroff(struct device *dev)
{
	genpd_syscore_switch(dev, true);
}
EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweroff);

void pm_genpd_syscore_poweron(struct device *dev)
{
	genpd_syscore_switch(dev, false);
}
EXPORT_SYMBOL_GPL(pm_genpd_syscore_poweron);
1386

1387 1388 1389 1390
#else

#define pm_genpd_prepare		NULL
#define pm_genpd_suspend		NULL
1391
#define pm_genpd_suspend_late		NULL
1392
#define pm_genpd_suspend_noirq		NULL
1393
#define pm_genpd_resume_early		NULL
1394 1395 1396
#define pm_genpd_resume_noirq		NULL
#define pm_genpd_resume			NULL
#define pm_genpd_freeze			NULL
1397
#define pm_genpd_freeze_late		NULL
1398
#define pm_genpd_freeze_noirq		NULL
1399
#define pm_genpd_thaw_early		NULL
1400 1401 1402 1403 1404 1405 1406
#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 */

1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
static struct generic_pm_domain_data *__pm_genpd_alloc_dev_data(struct device *dev)
{
	struct generic_pm_domain_data *gpd_data;

	gpd_data = kzalloc(sizeof(*gpd_data), GFP_KERNEL);
	if (!gpd_data)
		return NULL;

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

static void __pm_genpd_free_dev_data(struct device *dev,
				     struct generic_pm_domain_data *gpd_data)
{
	dev_pm_qos_remove_notifier(dev, &gpd_data->nb);
	kfree(gpd_data);
}

1428
/**
1429
 * __pm_genpd_add_device - Add a device to an I/O PM domain.
1430 1431
 * @genpd: PM domain to add the device to.
 * @dev: Device to be added.
1432
 * @td: Set of PM QoS timing parameters to attach to the device.
1433
 */
1434 1435
int __pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev,
			  struct gpd_timing_data *td)
1436
{
1437
	struct generic_pm_domain_data *gpd_data_new, *gpd_data = NULL;
1438
	struct pm_domain_data *pdd;
1439 1440 1441 1442 1443 1444 1445
	int ret = 0;

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

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

1446 1447
	gpd_data_new = __pm_genpd_alloc_dev_data(dev);
	if (!gpd_data_new)
1448 1449
		return -ENOMEM;

1450
	genpd_acquire_lock(genpd);
1451

1452 1453 1454 1455 1456
	if (genpd->prepared_count > 0) {
		ret = -EAGAIN;
		goto out;
	}

1457 1458
	list_for_each_entry(pdd, &genpd->dev_list, list_node)
		if (pdd->dev == dev) {
1459 1460 1461 1462
			ret = -EINVAL;
			goto out;
		}

1463 1464 1465 1466
	ret = dev_pm_get_subsys_data(dev);
	if (ret)
		goto out;

1467
	genpd->device_count++;
1468
	genpd->max_off_time_changed = true;
1469

1470
	spin_lock_irq(&dev->power.lock);
1471

1472
	dev->pm_domain = &genpd->domain;
1473 1474 1475 1476 1477 1478 1479
	if (dev->power.subsys_data->domain_data) {
		gpd_data = to_gpd_data(dev->power.subsys_data->domain_data);
	} else {
		gpd_data = gpd_data_new;
		dev->power.subsys_data->domain_data = &gpd_data->base;
	}
	gpd_data->refcount++;
1480 1481
	if (td)
		gpd_data->td = *td;
1482

1483 1484
	spin_unlock_irq(&dev->power.lock);

1485
	if (genpd->attach_dev)
1486
		genpd->attach_dev(genpd, dev);
1487

1488 1489 1490
	mutex_lock(&gpd_data->lock);
	gpd_data->base.dev = dev;
	list_add_tail(&gpd_data->base.list_node, &genpd->dev_list);
1491
	gpd_data->need_restore = -1;
1492 1493 1494 1495
	gpd_data->td.constraint_changed = true;
	gpd_data->td.effective_constraint_ns = -1;
	mutex_unlock(&gpd_data->lock);

1496
 out:
1497
	genpd_release_lock(genpd);
1498

1499 1500 1501
	if (gpd_data != gpd_data_new)
		__pm_genpd_free_dev_data(dev, gpd_data_new);

1502 1503 1504
	return ret;
}

1505 1506 1507 1508 1509 1510 1511 1512 1513
/**
 * __pm_genpd_name_add_device - Find I/O PM domain and add a device to it.
 * @domain_name: Name of the PM domain to add the device to.
 * @dev: Device to be added.
 * @td: Set of PM QoS timing parameters to attach to the device.
 */
int __pm_genpd_name_add_device(const char *domain_name, struct device *dev,
			       struct gpd_timing_data *td)
{
1514
	return __pm_genpd_add_device(pm_genpd_lookup_name(domain_name), dev, td);
1515 1516
}

1517 1518 1519 1520 1521 1522 1523 1524
/**
 * 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)
{
1525
	struct generic_pm_domain_data *gpd_data;
1526
	struct pm_domain_data *pdd;
1527
	bool remove = false;
1528
	int ret = 0;
1529 1530 1531

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

1532 1533 1534
	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)
1535 1536
		return -EINVAL;

1537
	genpd_acquire_lock(genpd);
1538

1539 1540 1541 1542 1543
	if (genpd->prepared_count > 0) {
		ret = -EAGAIN;
		goto out;
	}

1544 1545 1546
	genpd->device_count--;
	genpd->max_off_time_changed = true;

1547
	if (genpd->detach_dev)
1548
		genpd->detach_dev(genpd, dev);
1549

1550
	spin_lock_irq(&dev->power.lock);
1551

1552 1553 1554
	dev->pm_domain = NULL;
	pdd = dev->power.subsys_data->domain_data;
	list_del_init(&pdd->list_node);
1555 1556 1557 1558 1559 1560
	gpd_data = to_gpd_data(pdd);
	if (--gpd_data->refcount == 0) {
		dev->power.subsys_data->domain_data = NULL;
		remove = true;
	}

1561
	spin_unlock_irq(&dev->power.lock);
1562

1563 1564 1565 1566 1567 1568 1569
	mutex_lock(&gpd_data->lock);
	pdd->dev = NULL;
	mutex_unlock(&gpd_data->lock);

	genpd_release_lock(genpd);

	dev_pm_put_subsys_data(dev);
1570 1571 1572
	if (remove)
		__pm_genpd_free_dev_data(dev, gpd_data);

1573
	return 0;
1574

1575
 out:
1576
	genpd_release_lock(genpd);
1577 1578 1579 1580

	return ret;
}

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
/**
 * 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)
1595
		to_gpd_data(psd->domain_data)->need_restore = val ? 1 : 0;
1596 1597 1598 1599 1600

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

1601 1602 1603
/**
 * pm_genpd_add_subdomain - Add a subdomain to an I/O PM domain.
 * @genpd: Master PM domain to add the subdomain to.
1604
 * @subdomain: Subdomain to be added.
1605 1606
 */
int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
1607
			   struct generic_pm_domain *subdomain)
1608
{
1609
	struct gpd_link *link;
1610 1611
	int ret = 0;

1612 1613
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain)
	    || genpd == subdomain)
1614 1615
		return -EINVAL;

1616 1617
 start:
	genpd_acquire_lock(genpd);
1618
	mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);
1619

1620 1621 1622
	if (subdomain->status != GPD_STATE_POWER_OFF
	    && subdomain->status != GPD_STATE_ACTIVE) {
		mutex_unlock(&subdomain->lock);
1623 1624 1625 1626 1627
		genpd_release_lock(genpd);
		goto start;
	}

	if (genpd->status == GPD_STATE_POWER_OFF
1628
	    &&  subdomain->status != GPD_STATE_POWER_OFF) {
1629 1630 1631 1632
		ret = -EINVAL;
		goto out;
	}

1633
	list_for_each_entry(link, &genpd->master_links, master_node) {
1634
		if (link->slave == subdomain && link->master == genpd) {
1635 1636 1637 1638 1639
			ret = -EINVAL;
			goto out;
		}
	}

1640 1641 1642 1643 1644 1645 1646
	link = kzalloc(sizeof(*link), GFP_KERNEL);
	if (!link) {
		ret = -ENOMEM;
		goto out;
	}
	link->master = genpd;
	list_add_tail(&link->master_node, &genpd->master_links);
1647 1648 1649
	link->slave = subdomain;
	list_add_tail(&link->slave_node, &subdomain->slave_links);
	if (subdomain->status != GPD_STATE_POWER_OFF)
1650
		genpd_sd_counter_inc(genpd);
1651 1652

 out:
1653
	mutex_unlock(&subdomain->lock);
1654
	genpd_release_lock(genpd);
1655 1656 1657 1658

	return ret;
}

1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
/**
 * pm_genpd_add_subdomain_names - Add a subdomain to an I/O PM domain.
 * @master_name: Name of the master PM domain to add the subdomain to.
 * @subdomain_name: Name of the subdomain to be added.
 */
int pm_genpd_add_subdomain_names(const char *master_name,
				 const char *subdomain_name)
{
	struct generic_pm_domain *master = NULL, *subdomain = NULL, *gpd;

	if (IS_ERR_OR_NULL(master_name) || IS_ERR_OR_NULL(subdomain_name))
		return -EINVAL;

	mutex_lock(&gpd_list_lock);
	list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
		if (!master && !strcmp(gpd->name, master_name))
			master = gpd;

		if (!subdomain && !strcmp(gpd->name, subdomain_name))
			subdomain = gpd;

		if (master && subdomain)
			break;
	}
	mutex_unlock(&gpd_list_lock);

	return pm_genpd_add_subdomain(master, subdomain);
}

1688 1689 1690
/**
 * pm_genpd_remove_subdomain - Remove a subdomain from an I/O PM domain.
 * @genpd: Master PM domain to remove the subdomain from.
1691
 * @subdomain: Subdomain to be removed.
1692 1693
 */
int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
1694
			      struct generic_pm_domain *subdomain)
1695
{
1696
	struct gpd_link *link;
1697 1698
	int ret = -EINVAL;

1699
	if (IS_ERR_OR_NULL(genpd) || IS_ERR_OR_NULL(subdomain))
1700 1701
		return -EINVAL;

1702 1703
 start:
	genpd_acquire_lock(genpd);
1704

1705 1706
	list_for_each_entry(link, &genpd->master_links, master_node) {
		if (link->slave != subdomain)
1707 1708 1709 1710
			continue;

		mutex_lock_nested(&subdomain->lock, SINGLE_DEPTH_NESTING);

1711 1712 1713 1714 1715 1716 1717
		if (subdomain->status != GPD_STATE_POWER_OFF
		    && subdomain->status != GPD_STATE_ACTIVE) {
			mutex_unlock(&subdomain->lock);
			genpd_release_lock(genpd);
			goto start;
		}

1718 1719 1720
		list_del(&link->master_node);
		list_del(&link->slave_node);
		kfree(link);
1721
		if (subdomain->status != GPD_STATE_POWER_OFF)
1722 1723 1724 1725 1726 1727 1728 1729
			genpd_sd_counter_dec(genpd);

		mutex_unlock(&subdomain->lock);

		ret = 0;
		break;
	}

1730
	genpd_release_lock(genpd);
1731 1732 1733 1734

	return ret;
}

1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
/**
 * pm_genpd_attach_cpuidle - Connect the given PM domain with cpuidle.
 * @genpd: PM domain to be connected with cpuidle.
 * @state: cpuidle state this domain can disable/enable.
 *
 * Make a PM domain behave as though it contained a CPU core, that is, instead
 * of calling its power down routine it will enable the given cpuidle state so
 * that the cpuidle subsystem can power it down (if possible and desirable).
 */
int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state)
1745 1746
{
	struct cpuidle_driver *cpuidle_drv;
1747
	struct gpd_cpuidle_data *cpuidle_data;
1748 1749 1750 1751 1752 1753 1754 1755
	struct cpuidle_state *idle_state;
	int ret = 0;

	if (IS_ERR_OR_NULL(genpd) || state < 0)
		return -EINVAL;

	genpd_acquire_lock(genpd);

1756
	if (genpd->cpuidle_data) {
1757 1758 1759
		ret = -EEXIST;
		goto out;
	}
1760 1761
	cpuidle_data = kzalloc(sizeof(*cpuidle_data), GFP_KERNEL);
	if (!cpuidle_data) {
1762 1763 1764 1765 1766 1767
		ret = -ENOMEM;
		goto out;
	}
	cpuidle_drv = cpuidle_driver_ref();
	if (!cpuidle_drv) {
		ret = -ENODEV;
1768
		goto err_drv;
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
	}
	if (cpuidle_drv->state_count <= state) {
		ret = -EINVAL;
		goto err;
	}
	idle_state = &cpuidle_drv->states[state];
	if (!idle_state->disabled) {
		ret = -EAGAIN;
		goto err;
	}
1779 1780 1781
	cpuidle_data->idle_state = idle_state;
	cpuidle_data->saved_exit_latency = idle_state->exit_latency;
	genpd->cpuidle_data = cpuidle_data;
1782 1783 1784 1785 1786 1787 1788 1789
	genpd_recalc_cpu_exit_latency(genpd);

 out:
	genpd_release_lock(genpd);
	return ret;

 err:
	cpuidle_driver_unref();
1790 1791

 err_drv:
1792
	kfree(cpuidle_data);
1793 1794 1795
	goto out;
}

1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
/**
 * pm_genpd_name_attach_cpuidle - Find PM domain and connect cpuidle to it.
 * @name: Name of the domain to connect to cpuidle.
 * @state: cpuidle state this domain can manipulate.
 */
int pm_genpd_name_attach_cpuidle(const char *name, int state)
{
	return pm_genpd_attach_cpuidle(pm_genpd_lookup_name(name), state);
}

1806 1807 1808 1809 1810 1811 1812 1813
/**
 * pm_genpd_detach_cpuidle - Remove the cpuidle connection from a PM domain.
 * @genpd: PM domain to remove the cpuidle connection from.
 *
 * Remove the cpuidle connection set up by pm_genpd_attach_cpuidle() from the
 * given PM domain.
 */
int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
1814
{
1815
	struct gpd_cpuidle_data *cpuidle_data;
1816 1817 1818 1819 1820 1821 1822 1823
	struct cpuidle_state *idle_state;
	int ret = 0;

	if (IS_ERR_OR_NULL(genpd))
		return -EINVAL;

	genpd_acquire_lock(genpd);

1824 1825
	cpuidle_data = genpd->cpuidle_data;
	if (!cpuidle_data) {
1826 1827 1828
		ret = -ENODEV;
		goto out;
	}
1829
	idle_state = cpuidle_data->idle_state;
1830 1831 1832 1833
	if (!idle_state->disabled) {
		ret = -EAGAIN;
		goto out;
	}
1834
	idle_state->exit_latency = cpuidle_data->saved_exit_latency;
1835
	cpuidle_driver_unref();
1836 1837
	genpd->cpuidle_data = NULL;
	kfree(cpuidle_data);
1838 1839 1840 1841 1842 1843

 out:
	genpd_release_lock(genpd);
	return ret;
}

1844 1845 1846 1847 1848 1849 1850 1851 1852
/**
 * pm_genpd_name_detach_cpuidle - Find PM domain and disconnect cpuidle from it.
 * @name: Name of the domain to disconnect cpuidle from.
 */
int pm_genpd_name_detach_cpuidle(const char *name)
{
	return pm_genpd_detach_cpuidle(pm_genpd_lookup_name(name));
}

1853 1854
/* Default device callbacks for generic PM domains. */

1855
/**
1856
 * pm_genpd_default_save_state - Default "save device state" for PM domains.
1857 1858 1859 1860 1861 1862
 * @dev: Device to handle.
 */
static int pm_genpd_default_save_state(struct device *dev)
{
	int (*cb)(struct device *__dev);

1863 1864 1865 1866 1867 1868 1869 1870
	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;
1871

1872 1873 1874 1875
	if (!cb && dev->driver && dev->driver->pm)
		cb = dev->driver->pm->runtime_suspend;

	return cb ? cb(dev) : 0;
1876 1877 1878
}

/**
1879
 * pm_genpd_default_restore_state - Default PM domains "restore device state".
1880 1881 1882 1883 1884 1885
 * @dev: Device to handle.
 */
static int pm_genpd_default_restore_state(struct device *dev)
{
	int (*cb)(struct device *__dev);

1886 1887 1888 1889 1890 1891 1892 1893
	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;
1894

1895 1896 1897 1898
	if (!cb && dev->driver && dev->driver->pm)
		cb = dev->driver->pm->runtime_resume;

	return cb ? cb(dev) : 0;
1899 1900
}

1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912
/**
 * 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;

1913 1914
	INIT_LIST_HEAD(&genpd->master_links);
	INIT_LIST_HEAD(&genpd->slave_links);
1915 1916 1917 1918 1919
	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;
1920
	atomic_set(&genpd->sd_count, 0);
1921 1922
	genpd->status = is_off ? GPD_STATE_POWER_OFF : GPD_STATE_ACTIVE;
	init_waitqueue_head(&genpd->status_wait_queue);
1923 1924
	genpd->poweroff_task = NULL;
	genpd->resume_count = 0;
1925
	genpd->device_count = 0;
1926
	genpd->max_off_time_ns = -1;
1927
	genpd->max_off_time_changed = true;
1928 1929
	genpd->domain.ops.runtime_suspend = pm_genpd_runtime_suspend;
	genpd->domain.ops.runtime_resume = pm_genpd_runtime_resume;
1930 1931
	genpd->domain.ops.prepare = pm_genpd_prepare;
	genpd->domain.ops.suspend = pm_genpd_suspend;
1932
	genpd->domain.ops.suspend_late = pm_genpd_suspend_late;
1933 1934
	genpd->domain.ops.suspend_noirq = pm_genpd_suspend_noirq;
	genpd->domain.ops.resume_noirq = pm_genpd_resume_noirq;
1935
	genpd->domain.ops.resume_early = pm_genpd_resume_early;
1936 1937
	genpd->domain.ops.resume = pm_genpd_resume;
	genpd->domain.ops.freeze = pm_genpd_freeze;
1938
	genpd->domain.ops.freeze_late = pm_genpd_freeze_late;
1939 1940
	genpd->domain.ops.freeze_noirq = pm_genpd_freeze_noirq;
	genpd->domain.ops.thaw_noirq = pm_genpd_thaw_noirq;
1941
	genpd->domain.ops.thaw_early = pm_genpd_thaw_early;
1942
	genpd->domain.ops.thaw = pm_genpd_thaw;
1943
	genpd->domain.ops.poweroff = pm_genpd_suspend;
1944
	genpd->domain.ops.poweroff_late = pm_genpd_suspend_late;
1945
	genpd->domain.ops.poweroff_noirq = pm_genpd_suspend_noirq;
1946
	genpd->domain.ops.restore_noirq = pm_genpd_restore_noirq;
1947
	genpd->domain.ops.restore_early = pm_genpd_resume_early;
1948
	genpd->domain.ops.restore = pm_genpd_resume;
1949
	genpd->domain.ops.complete = pm_genpd_complete;
1950 1951
	genpd->dev_ops.save_state = pm_genpd_default_save_state;
	genpd->dev_ops.restore_state = pm_genpd_default_restore_state;
1952 1953 1954 1955 1956 1957

	if (genpd->flags & GENPD_FLAG_PM_CLK) {
		genpd->dev_ops.stop = pm_clk_suspend;
		genpd->dev_ops.start = pm_clk_resume;
	}

1958 1959 1960 1961
	mutex_lock(&gpd_list_lock);
	list_add(&genpd->gpd_list_node, &gpd_list);
	mutex_unlock(&gpd_list_lock);
}
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110

#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
/*
 * Device Tree based PM domain providers.
 *
 * The code below implements generic device tree based PM domain providers that
 * bind device tree nodes with generic PM domains registered in the system.
 *
 * Any driver that registers generic PM domains and needs to support binding of
 * devices to these domains is supposed to register a PM domain provider, which
 * maps a PM domain specifier retrieved from the device tree to a PM domain.
 *
 * Two simple mapping functions have been provided for convenience:
 *  - __of_genpd_xlate_simple() for 1:1 device tree node to PM domain mapping.
 *  - __of_genpd_xlate_onecell() for mapping of multiple PM domains per node by
 *    index.
 */

/**
 * struct of_genpd_provider - PM domain provider registration structure
 * @link: Entry in global list of PM domain providers
 * @node: Pointer to device tree node of PM domain provider
 * @xlate: Provider-specific xlate callback mapping a set of specifier cells
 *         into a PM domain.
 * @data: context pointer to be passed into @xlate callback
 */
struct of_genpd_provider {
	struct list_head link;
	struct device_node *node;
	genpd_xlate_t xlate;
	void *data;
};

/* List of registered PM domain providers. */
static LIST_HEAD(of_genpd_providers);
/* Mutex to protect the list above. */
static DEFINE_MUTEX(of_genpd_mutex);

/**
 * __of_genpd_xlate_simple() - Xlate function for direct node-domain mapping
 * @genpdspec: OF phandle args to map into a PM domain
 * @data: xlate function private data - pointer to struct generic_pm_domain
 *
 * This is a generic xlate function that can be used to model PM domains that
 * have their own device tree nodes. The private data of xlate function needs
 * to be a valid pointer to struct generic_pm_domain.
 */
struct generic_pm_domain *__of_genpd_xlate_simple(
					struct of_phandle_args *genpdspec,
					void *data)
{
	if (genpdspec->args_count != 0)
		return ERR_PTR(-EINVAL);
	return data;
}
EXPORT_SYMBOL_GPL(__of_genpd_xlate_simple);

/**
 * __of_genpd_xlate_onecell() - Xlate function using a single index.
 * @genpdspec: OF phandle args to map into a PM domain
 * @data: xlate function private data - pointer to struct genpd_onecell_data
 *
 * This is a generic xlate function that can be used to model simple PM domain
 * controllers that have one device tree node and provide multiple PM domains.
 * A single cell is used as an index into an array of PM domains specified in
 * the genpd_onecell_data struct when registering the provider.
 */
struct generic_pm_domain *__of_genpd_xlate_onecell(
					struct of_phandle_args *genpdspec,
					void *data)
{
	struct genpd_onecell_data *genpd_data = data;
	unsigned int idx = genpdspec->args[0];

	if (genpdspec->args_count != 1)
		return ERR_PTR(-EINVAL);

	if (idx >= genpd_data->num_domains) {
		pr_err("%s: invalid domain index %u\n", __func__, idx);
		return ERR_PTR(-EINVAL);
	}

	if (!genpd_data->domains[idx])
		return ERR_PTR(-ENOENT);

	return genpd_data->domains[idx];
}
EXPORT_SYMBOL_GPL(__of_genpd_xlate_onecell);

/**
 * __of_genpd_add_provider() - Register a PM domain provider for a node
 * @np: Device node pointer associated with the PM domain provider.
 * @xlate: Callback for decoding PM domain from phandle arguments.
 * @data: Context pointer for @xlate callback.
 */
int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
			void *data)
{
	struct of_genpd_provider *cp;

	cp = kzalloc(sizeof(*cp), GFP_KERNEL);
	if (!cp)
		return -ENOMEM;

	cp->node = of_node_get(np);
	cp->data = data;
	cp->xlate = xlate;

	mutex_lock(&of_genpd_mutex);
	list_add(&cp->link, &of_genpd_providers);
	mutex_unlock(&of_genpd_mutex);
	pr_debug("Added domain provider from %s\n", np->full_name);

	return 0;
}
EXPORT_SYMBOL_GPL(__of_genpd_add_provider);

/**
 * of_genpd_del_provider() - Remove a previously registered PM domain provider
 * @np: Device node pointer associated with the PM domain provider
 */
void of_genpd_del_provider(struct device_node *np)
{
	struct of_genpd_provider *cp;

	mutex_lock(&of_genpd_mutex);
	list_for_each_entry(cp, &of_genpd_providers, link) {
		if (cp->node == np) {
			list_del(&cp->link);
			of_node_put(cp->node);
			kfree(cp);
			break;
		}
	}
	mutex_unlock(&of_genpd_mutex);
}
EXPORT_SYMBOL_GPL(of_genpd_del_provider);

/**
 * of_genpd_get_from_provider() - Look-up PM domain
 * @genpdspec: OF phandle args to use for look-up
 *
 * Looks for a PM domain provider under the node specified by @genpdspec and if
 * found, uses xlate function of the provider to map phandle args to a PM
 * domain.
 *
 * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR()
 * on failure.
 */
2111
struct generic_pm_domain *of_genpd_get_from_provider(
2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130
					struct of_phandle_args *genpdspec)
{
	struct generic_pm_domain *genpd = ERR_PTR(-ENOENT);
	struct of_genpd_provider *provider;

	mutex_lock(&of_genpd_mutex);

	/* Check if we have such a provider in our array */
	list_for_each_entry(provider, &of_genpd_providers, link) {
		if (provider->node == genpdspec->np)
			genpd = provider->xlate(genpdspec, provider->data);
		if (!IS_ERR(genpd))
			break;
	}

	mutex_unlock(&of_genpd_mutex);

	return genpd;
}
2131
EXPORT_SYMBOL_GPL(of_genpd_get_from_provider);
2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245

/**
 * genpd_dev_pm_detach - Detach a device from its PM domain.
 * @dev: Device to attach.
 * @power_off: Currently not used
 *
 * Try to locate a corresponding generic PM domain, which the device was
 * attached to previously. If such is found, the device is detached from it.
 */
static void genpd_dev_pm_detach(struct device *dev, bool power_off)
{
	struct generic_pm_domain *pd = NULL, *gpd;
	int ret = 0;

	if (!dev->pm_domain)
		return;

	mutex_lock(&gpd_list_lock);
	list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
		if (&gpd->domain == dev->pm_domain) {
			pd = gpd;
			break;
		}
	}
	mutex_unlock(&gpd_list_lock);

	if (!pd)
		return;

	dev_dbg(dev, "removing from PM domain %s\n", pd->name);

	while (1) {
		ret = pm_genpd_remove_device(pd, dev);
		if (ret != -EAGAIN)
			break;
		cond_resched();
	}

	if (ret < 0) {
		dev_err(dev, "failed to remove from PM domain %s: %d",
			pd->name, ret);
		return;
	}

	/* Check if PM domain can be powered off after removing this device. */
	genpd_queue_power_off_work(pd);
}

/**
 * genpd_dev_pm_attach - Attach a device to its PM domain using DT.
 * @dev: Device to attach.
 *
 * Parse device's OF node to find a PM domain specifier. If such is found,
 * attaches the device to retrieved pm_domain ops.
 *
 * Both generic and legacy Samsung-specific DT bindings are supported to keep
 * backwards compatibility with existing DTBs.
 *
 * Returns 0 on successfully attached PM domain or negative error code.
 */
int genpd_dev_pm_attach(struct device *dev)
{
	struct of_phandle_args pd_args;
	struct generic_pm_domain *pd;
	int ret;

	if (!dev->of_node)
		return -ENODEV;

	if (dev->pm_domain)
		return -EEXIST;

	ret = of_parse_phandle_with_args(dev->of_node, "power-domains",
					"#power-domain-cells", 0, &pd_args);
	if (ret < 0) {
		if (ret != -ENOENT)
			return ret;

		/*
		 * Try legacy Samsung-specific bindings
		 * (for backwards compatibility of DT ABI)
		 */
		pd_args.args_count = 0;
		pd_args.np = of_parse_phandle(dev->of_node,
						"samsung,power-domain", 0);
		if (!pd_args.np)
			return -ENOENT;
	}

	pd = of_genpd_get_from_provider(&pd_args);
	if (IS_ERR(pd)) {
		dev_dbg(dev, "%s() failed to find PM domain: %ld\n",
			__func__, PTR_ERR(pd));
		of_node_put(dev->of_node);
		return PTR_ERR(pd);
	}

	dev_dbg(dev, "adding to PM domain %s\n", pd->name);

	while (1) {
		ret = pm_genpd_add_device(pd, dev);
		if (ret != -EAGAIN)
			break;
		cond_resched();
	}

	if (ret < 0) {
		dev_err(dev, "failed to add to PM domain %s: %d",
			pd->name, ret);
		of_node_put(dev->of_node);
		return ret;
	}

	dev->pm_domain->detach = genpd_dev_pm_detach;
2246
	pm_genpd_poweron(pd);
2247 2248 2249 2250 2251

	return 0;
}
EXPORT_SYMBOL_GPL(genpd_dev_pm_attach);
#endif
2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408


/***        debugfs support        ***/

#ifdef CONFIG_PM_ADVANCED_DEBUG
#include <linux/pm.h>
#include <linux/device.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/init.h>
#include <linux/kobject.h>
static struct dentry *pm_genpd_debugfs_dir;

/*
 * TODO: This function is a slightly modified version of rtpm_status_show
 * from sysfs.c, but dependencies between PM_GENERIC_DOMAINS and PM_RUNTIME
 * are too loose to generalize it.
 */
#ifdef CONFIG_PM_RUNTIME
static void rtpm_status_str(struct seq_file *s, struct device *dev)
{
	static const char * const status_lookup[] = {
		[RPM_ACTIVE] = "active",
		[RPM_RESUMING] = "resuming",
		[RPM_SUSPENDED] = "suspended",
		[RPM_SUSPENDING] = "suspending"
	};
	const char *p = "";

	if (dev->power.runtime_error)
		p = "error";
	else if (dev->power.disable_depth)
		p = "unsupported";
	else if (dev->power.runtime_status < ARRAY_SIZE(status_lookup))
		p = status_lookup[dev->power.runtime_status];
	else
		WARN_ON(1);

	seq_puts(s, p);
}
#else
static void rtpm_status_str(struct seq_file *s, struct device *dev)
{
	seq_puts(s, "active");
}
#endif

static int pm_genpd_summary_one(struct seq_file *s,
		struct generic_pm_domain *gpd)
{
	static const char * const status_lookup[] = {
		[GPD_STATE_ACTIVE] = "on",
		[GPD_STATE_WAIT_MASTER] = "wait-master",
		[GPD_STATE_BUSY] = "busy",
		[GPD_STATE_REPEAT] = "off-in-progress",
		[GPD_STATE_POWER_OFF] = "off"
	};
	struct pm_domain_data *pm_data;
	const char *kobj_path;
	struct gpd_link *link;
	int ret;

	ret = mutex_lock_interruptible(&gpd->lock);
	if (ret)
		return -ERESTARTSYS;

	if (WARN_ON(gpd->status >= ARRAY_SIZE(status_lookup)))
		goto exit;
	seq_printf(s, "%-30s  %-15s  ", gpd->name, status_lookup[gpd->status]);

	/*
	 * Modifications on the list require holding locks on both
	 * master and slave, so we are safe.
	 * Also gpd->name is immutable.
	 */
	list_for_each_entry(link, &gpd->master_links, master_node) {
		seq_printf(s, "%s", link->slave->name);
		if (!list_is_last(&link->master_node, &gpd->master_links))
			seq_puts(s, ", ");
	}

	list_for_each_entry(pm_data, &gpd->dev_list, list_node) {
		kobj_path = kobject_get_path(&pm_data->dev->kobj, GFP_KERNEL);
		if (kobj_path == NULL)
			continue;

		seq_printf(s, "\n    %-50s  ", kobj_path);
		rtpm_status_str(s, pm_data->dev);
		kfree(kobj_path);
	}

	seq_puts(s, "\n");
exit:
	mutex_unlock(&gpd->lock);

	return 0;
}

static int pm_genpd_summary_show(struct seq_file *s, void *data)
{
	struct generic_pm_domain *gpd;
	int ret = 0;

	seq_puts(s, "    domain                      status         slaves\n");
	seq_puts(s, "           /device                                      runtime status\n");
	seq_puts(s, "----------------------------------------------------------------------\n");

	ret = mutex_lock_interruptible(&gpd_list_lock);
	if (ret)
		return -ERESTARTSYS;

	list_for_each_entry(gpd, &gpd_list, gpd_list_node) {
		ret = pm_genpd_summary_one(s, gpd);
		if (ret)
			break;
	}
	mutex_unlock(&gpd_list_lock);

	return ret;
}

static int pm_genpd_summary_open(struct inode *inode, struct file *file)
{
	return single_open(file, pm_genpd_summary_show, NULL);
}

static const struct file_operations pm_genpd_summary_fops = {
	.open = pm_genpd_summary_open,
	.read = seq_read,
	.llseek = seq_lseek,
	.release = single_release,
};

static int __init pm_genpd_debug_init(void)
{
	struct dentry *d;

	pm_genpd_debugfs_dir = debugfs_create_dir("pm_genpd", NULL);

	if (!pm_genpd_debugfs_dir)
		return -ENOMEM;

	d = debugfs_create_file("pm_genpd_summary", S_IRUGO,
			pm_genpd_debugfs_dir, NULL, &pm_genpd_summary_fops);
	if (!d)
		return -ENOMEM;

	return 0;
}
late_initcall(pm_genpd_debug_init);

static void __exit pm_genpd_debug_exit(void)
{
	debugfs_remove_recursive(pm_genpd_debugfs_dir);
}
__exitcall(pm_genpd_debug_exit);
#endif /* CONFIG_PM_ADVANCED_DEBUG */