main.c 26.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * drivers/base/power/main.c - Where the driver meets power management.
 *
 * Copyright (c) 2003 Patrick Mochel
 * Copyright (c) 2003 Open Source Development Lab
 *
 * This file is released under the GPLv2
 *
 *
 * The driver model core calls device_pm_add() when a device is registered.
 * This will intialize the embedded device_pm_info object in the device
 * and add it to the list of power-controlled devices. sysfs entries for
 * controlling device power management will also be added.
 *
15 16 17
 * A separate list is used for keeping track of power info, because the power
 * domain dependencies may differ from the ancestral dependencies that the
 * subsystem list maintains.
L
Linus Torvalds 已提交
18 19 20
 */

#include <linux/device.h>
21
#include <linux/kallsyms.h>
22
#include <linux/mutex.h>
23
#include <linux/pm.h>
24
#include <linux/pm_runtime.h>
25
#include <linux/resume-trace.h>
26
#include <linux/interrupt.h>
27
#include <linux/sched.h>
28
#include <linux/async.h>
29
#include <linux/suspend.h>
30

31
#include "../base.h"
L
Linus Torvalds 已提交
32 33
#include "power.h"

34
/*
35
 * The entries in the dpm_list list are in a depth first order, simply
36 37 38
 * because children are guaranteed to be discovered after parents, and
 * are inserted at the back of the list on discovery.
 *
39 40
 * Since device_pm_add() may be called with a device lock held,
 * we must never try to acquire a device lock while holding
41 42 43
 * dpm_list_mutex.
 */

44
LIST_HEAD(dpm_list);
45 46 47
LIST_HEAD(dpm_prepared_list);
LIST_HEAD(dpm_suspended_list);
LIST_HEAD(dpm_noirq_list);
L
Linus Torvalds 已提交
48

49
static DEFINE_MUTEX(dpm_list_mtx);
50
static pm_message_t pm_transition;
L
Linus Torvalds 已提交
51

52 53 54 55 56 57
/*
 * Set once the preparation of devices for a PM transition has started, reset
 * before starting to resume devices.  Protected by dpm_list_mtx.
 */
static bool transition_started;

58 59
static int async_error;

60
/**
61
 * device_pm_init - Initialize the PM-related part of a device object.
62 63 64 65
 * @dev: Device object being initialized.
 */
void device_pm_init(struct device *dev)
{
66
	dev->power.in_suspend = false;
67
	init_completion(&dev->power.completion);
68
	complete_all(&dev->power.completion);
69 70
	dev->power.wakeup = NULL;
	spin_lock_init(&dev->power.lock);
71 72 73
	pm_runtime_init(dev);
}

74
/**
75
 * device_pm_lock - Lock the list of active devices used by the PM core.
76 77 78 79 80 81 82
 */
void device_pm_lock(void)
{
	mutex_lock(&dpm_list_mtx);
}

/**
83
 * device_pm_unlock - Unlock the list of active devices used by the PM core.
84 85 86 87 88
 */
void device_pm_unlock(void)
{
	mutex_unlock(&dpm_list_mtx);
}
89

90
/**
91 92
 * device_pm_add - Add a device to the PM core's list of active devices.
 * @dev: Device to add to the list.
93
 */
94
void device_pm_add(struct device *dev)
L
Linus Torvalds 已提交
95 96
{
	pr_debug("PM: Adding info for %s:%s\n",
97 98
		 dev->bus ? dev->bus->name : "No Bus",
		 kobject_name(&dev->kobj));
99
	mutex_lock(&dpm_list_mtx);
100
	if (dev->parent) {
101
		if (dev->parent->power.in_suspend)
102
			dev_warn(dev, "parent %s should not be sleeping\n",
103
				 dev_name(dev->parent));
104 105 106 107 108 109
	} else if (transition_started) {
		/*
		 * We refuse to register parentless devices while a PM
		 * transition is in progress in order to avoid leaving them
		 * unhandled down the road
		 */
110
		dev_WARN(dev, "Parentless device registered during a PM transaction\n");
111
	}
112 113

	list_add_tail(&dev->power.entry, &dpm_list);
114
	mutex_unlock(&dpm_list_mtx);
L
Linus Torvalds 已提交
115 116
}

117
/**
118 119
 * device_pm_remove - Remove a device from the PM core's list of active devices.
 * @dev: Device to be removed from the list.
120
 */
121
void device_pm_remove(struct device *dev)
L
Linus Torvalds 已提交
122 123
{
	pr_debug("PM: Removing info for %s:%s\n",
124 125
		 dev->bus ? dev->bus->name : "No Bus",
		 kobject_name(&dev->kobj));
126
	complete_all(&dev->power.completion);
127
	mutex_lock(&dpm_list_mtx);
L
Linus Torvalds 已提交
128
	list_del_init(&dev->power.entry);
129
	mutex_unlock(&dpm_list_mtx);
130
	device_wakeup_disable(dev);
131
	pm_runtime_remove(dev);
132 133
}

134
/**
135 136 137
 * device_pm_move_before - Move device in the PM core's list of active devices.
 * @deva: Device to move in dpm_list.
 * @devb: Device @deva should come before.
138 139 140 141 142 143 144 145 146 147 148 149 150
 */
void device_pm_move_before(struct device *deva, struct device *devb)
{
	pr_debug("PM: Moving %s:%s before %s:%s\n",
		 deva->bus ? deva->bus->name : "No Bus",
		 kobject_name(&deva->kobj),
		 devb->bus ? devb->bus->name : "No Bus",
		 kobject_name(&devb->kobj));
	/* Delete deva from dpm_list and reinsert before devb. */
	list_move_tail(&deva->power.entry, &devb->power.entry);
}

/**
151 152 153
 * device_pm_move_after - Move device in the PM core's list of active devices.
 * @deva: Device to move in dpm_list.
 * @devb: Device @deva should come after.
154 155 156 157 158 159 160 161 162 163 164 165 166
 */
void device_pm_move_after(struct device *deva, struct device *devb)
{
	pr_debug("PM: Moving %s:%s after %s:%s\n",
		 deva->bus ? deva->bus->name : "No Bus",
		 kobject_name(&deva->kobj),
		 devb->bus ? devb->bus->name : "No Bus",
		 kobject_name(&devb->kobj));
	/* Delete deva from dpm_list and reinsert after devb. */
	list_move(&deva->power.entry, &devb->power.entry);
}

/**
167 168
 * device_pm_move_last - Move device to end of the PM core's list of devices.
 * @dev: Device to move in dpm_list.
169 170 171 172 173 174 175 176 177
 */
void device_pm_move_last(struct device *dev)
{
	pr_debug("PM: Moving %s:%s to end of list\n",
		 dev->bus ? dev->bus->name : "No Bus",
		 kobject_name(&dev->kobj));
	list_move_tail(&dev->power.entry, &dpm_list);
}

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
static ktime_t initcall_debug_start(struct device *dev)
{
	ktime_t calltime = ktime_set(0, 0);

	if (initcall_debug) {
		pr_info("calling  %s+ @ %i\n",
				dev_name(dev), task_pid_nr(current));
		calltime = ktime_get();
	}

	return calltime;
}

static void initcall_debug_report(struct device *dev, ktime_t calltime,
				  int error)
{
	ktime_t delta, rettime;

	if (initcall_debug) {
		rettime = ktime_get();
		delta = ktime_sub(rettime, calltime);
		pr_info("call %s+ returned %d after %Ld usecs\n", dev_name(dev),
			error, (unsigned long long)ktime_to_ns(delta) >> 10);
	}
}

204 205 206 207 208 209 210 211 212 213
/**
 * dpm_wait - Wait for a PM operation to complete.
 * @dev: Device to wait for.
 * @async: If unset, wait only if the device's power.async_suspend flag is set.
 */
static void dpm_wait(struct device *dev, bool async)
{
	if (!dev)
		return;

214
	if (async || (pm_async_enabled && dev->power.async_suspend))
215 216 217 218 219 220 221 222 223 224 225 226 227 228
		wait_for_completion(&dev->power.completion);
}

static int dpm_wait_fn(struct device *dev, void *async_ptr)
{
	dpm_wait(dev, *((bool *)async_ptr));
	return 0;
}

static void dpm_wait_for_children(struct device *dev, bool async)
{
       device_for_each_child(dev, &async, dpm_wait_fn);
}

229
/**
230 231 232 233
 * pm_op - Execute the PM operation appropriate for given PM event.
 * @dev: Device to handle.
 * @ops: PM operations to choose from.
 * @state: PM transition of the system being carried out.
234
 */
235 236 237
static int pm_op(struct device *dev,
		 const struct dev_pm_ops *ops,
		 pm_message_t state)
238 239
{
	int error = 0;
240
	ktime_t calltime;
241

242
	calltime = initcall_debug_start(dev);
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

	switch (state.event) {
#ifdef CONFIG_SUSPEND
	case PM_EVENT_SUSPEND:
		if (ops->suspend) {
			error = ops->suspend(dev);
			suspend_report_result(ops->suspend, error);
		}
		break;
	case PM_EVENT_RESUME:
		if (ops->resume) {
			error = ops->resume(dev);
			suspend_report_result(ops->resume, error);
		}
		break;
#endif /* CONFIG_SUSPEND */
#ifdef CONFIG_HIBERNATION
	case PM_EVENT_FREEZE:
	case PM_EVENT_QUIESCE:
		if (ops->freeze) {
			error = ops->freeze(dev);
			suspend_report_result(ops->freeze, error);
		}
		break;
	case PM_EVENT_HIBERNATE:
		if (ops->poweroff) {
			error = ops->poweroff(dev);
			suspend_report_result(ops->poweroff, error);
		}
		break;
	case PM_EVENT_THAW:
	case PM_EVENT_RECOVER:
		if (ops->thaw) {
			error = ops->thaw(dev);
			suspend_report_result(ops->thaw, error);
		}
		break;
	case PM_EVENT_RESTORE:
		if (ops->restore) {
			error = ops->restore(dev);
			suspend_report_result(ops->restore, error);
		}
		break;
#endif /* CONFIG_HIBERNATION */
	default:
		error = -EINVAL;
	}
290

291
	initcall_debug_report(dev, calltime, error);
292

293 294 295 296
	return error;
}

/**
297 298 299 300
 * pm_noirq_op - Execute the PM operation appropriate for given PM event.
 * @dev: Device to handle.
 * @ops: PM operations to choose from.
 * @state: PM transition of the system being carried out.
301
 *
302 303
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
304
 */
305 306
static int pm_noirq_op(struct device *dev,
			const struct dev_pm_ops *ops,
307 308 309
			pm_message_t state)
{
	int error = 0;
310
	ktime_t calltime = ktime_set(0, 0), delta, rettime;
311 312

	if (initcall_debug) {
313 314 315
		pr_info("calling  %s+ @ %i, parent: %s\n",
				dev_name(dev), task_pid_nr(current),
				dev->parent ? dev_name(dev->parent) : "none");
316 317
		calltime = ktime_get();
	}
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364

	switch (state.event) {
#ifdef CONFIG_SUSPEND
	case PM_EVENT_SUSPEND:
		if (ops->suspend_noirq) {
			error = ops->suspend_noirq(dev);
			suspend_report_result(ops->suspend_noirq, error);
		}
		break;
	case PM_EVENT_RESUME:
		if (ops->resume_noirq) {
			error = ops->resume_noirq(dev);
			suspend_report_result(ops->resume_noirq, error);
		}
		break;
#endif /* CONFIG_SUSPEND */
#ifdef CONFIG_HIBERNATION
	case PM_EVENT_FREEZE:
	case PM_EVENT_QUIESCE:
		if (ops->freeze_noirq) {
			error = ops->freeze_noirq(dev);
			suspend_report_result(ops->freeze_noirq, error);
		}
		break;
	case PM_EVENT_HIBERNATE:
		if (ops->poweroff_noirq) {
			error = ops->poweroff_noirq(dev);
			suspend_report_result(ops->poweroff_noirq, error);
		}
		break;
	case PM_EVENT_THAW:
	case PM_EVENT_RECOVER:
		if (ops->thaw_noirq) {
			error = ops->thaw_noirq(dev);
			suspend_report_result(ops->thaw_noirq, error);
		}
		break;
	case PM_EVENT_RESTORE:
		if (ops->restore_noirq) {
			error = ops->restore_noirq(dev);
			suspend_report_result(ops->restore_noirq, error);
		}
		break;
#endif /* CONFIG_HIBERNATION */
	default:
		error = -EINVAL;
	}
365 366 367 368

	if (initcall_debug) {
		rettime = ktime_get();
		delta = ktime_sub(rettime, calltime);
369 370 371
		printk("initcall %s_i+ returned %d after %Ld usecs\n",
			dev_name(dev), error,
			(unsigned long long)ktime_to_ns(delta) >> 10);
372 373
	}

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
	return error;
}

static char *pm_verb(int event)
{
	switch (event) {
	case PM_EVENT_SUSPEND:
		return "suspend";
	case PM_EVENT_RESUME:
		return "resume";
	case PM_EVENT_FREEZE:
		return "freeze";
	case PM_EVENT_QUIESCE:
		return "quiesce";
	case PM_EVENT_HIBERNATE:
		return "hibernate";
	case PM_EVENT_THAW:
		return "thaw";
	case PM_EVENT_RESTORE:
		return "restore";
	case PM_EVENT_RECOVER:
		return "recover";
	default:
		return "(unknown PM event)";
	}
}

static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
{
	dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
		((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
		", may wakeup" : "");
}

static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
			int error)
{
	printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
		kobject_name(&dev->kobj), pm_verb(state.event), info, error);
}

415 416 417
static void dpm_show_time(ktime_t starttime, pm_message_t state, char *info)
{
	ktime_t calltime;
418
	u64 usecs64;
419 420 421 422 423 424 425 426 427 428 429 430 431
	int usecs;

	calltime = ktime_get();
	usecs64 = ktime_to_ns(ktime_sub(calltime, starttime));
	do_div(usecs64, NSEC_PER_USEC);
	usecs = usecs64;
	if (usecs == 0)
		usecs = 1;
	pr_info("PM: %s%s%s of devices complete after %ld.%03ld msecs\n",
		info ?: "", info ? " " : "", pm_verb(state.event),
		usecs / USEC_PER_MSEC, usecs % USEC_PER_MSEC);
}

432 433 434
/*------------------------- Resume routines -------------------------*/

/**
435 436 437
 * device_resume_noirq - Execute an "early resume" callback for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
438
 *
439 440
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
441
 */
442
static int device_resume_noirq(struct device *dev, pm_message_t state)
443 444 445 446 447 448
{
	int error = 0;

	TRACE_DEVICE(dev);
	TRACE_RESUME(0);

449
	if (dev->bus && dev->bus->pm) {
450 451
		pm_dev_dbg(dev, state, "EARLY ");
		error = pm_noirq_op(dev, dev->bus->pm, state);
452 453
		if (error)
			goto End;
454
	}
455

456 457 458 459 460 461 462 463 464 465 466 467 468
	if (dev->type && dev->type->pm) {
		pm_dev_dbg(dev, state, "EARLY type ");
		error = pm_noirq_op(dev, dev->type->pm, state);
		if (error)
			goto End;
	}

	if (dev->class && dev->class->pm) {
		pm_dev_dbg(dev, state, "EARLY class ");
		error = pm_noirq_op(dev, dev->class->pm, state);
	}

End:
469 470 471 472 473
	TRACE_RESUME(error);
	return error;
}

/**
474 475
 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
476
 *
477 478
 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
 * enable device drivers to receive interrupts.
479
 */
480
void dpm_resume_noirq(pm_message_t state)
481
{
482
	ktime_t starttime = ktime_get();
483

484
	mutex_lock(&dpm_list_mtx);
485
	transition_started = false;
486 487
	while (!list_empty(&dpm_noirq_list)) {
		struct device *dev = to_device(dpm_noirq_list.next);
488
		int error;
489 490

		get_device(dev);
491 492
		list_move_tail(&dev->power.entry, &dpm_suspended_list);
		mutex_unlock(&dpm_list_mtx);
493

494 495 496
		error = device_resume_noirq(dev, state);
		if (error)
			pm_dev_err(dev, state, " early", error);
497

498
		mutex_lock(&dpm_list_mtx);
499 500
		put_device(dev);
	}
501
	mutex_unlock(&dpm_list_mtx);
502
	dpm_show_time(starttime, state, "early");
503
	resume_device_irqs();
504
}
505
EXPORT_SYMBOL_GPL(dpm_resume_noirq);
506

507 508
/**
 * legacy_resume - Execute a legacy (bus or class) resume callback for device.
R
Randy Dunlap 已提交
509 510
 * @dev: Device to resume.
 * @cb: Resume callback to execute.
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
 */
static int legacy_resume(struct device *dev, int (*cb)(struct device *dev))
{
	int error;
	ktime_t calltime;

	calltime = initcall_debug_start(dev);

	error = cb(dev);
	suspend_report_result(cb, error);

	initcall_debug_report(dev, calltime, error);

	return error;
}

527
/**
528
 * device_resume - Execute "resume" callbacks for given device.
529 530
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
531
 * @async: If true, the device is being resumed asynchronously.
532
 */
533
static int device_resume(struct device *dev, pm_message_t state, bool async)
534 535 536 537 538
{
	int error = 0;

	TRACE_DEVICE(dev);
	TRACE_RESUME(0);
539

540
	dpm_wait(dev->parent, async);
541
	device_lock(dev);
542

543
	dev->power.in_suspend = false;
544

545 546 547
	if (dev->bus) {
		if (dev->bus->pm) {
			pm_dev_dbg(dev, state, "");
548
			error = pm_op(dev, dev->bus->pm, state);
549 550
		} else if (dev->bus->resume) {
			pm_dev_dbg(dev, state, "legacy ");
551
			error = legacy_resume(dev, dev->bus->resume);
552 553 554
		}
		if (error)
			goto End;
555 556
	}

557 558 559 560 561 562 563
	if (dev->type) {
		if (dev->type->pm) {
			pm_dev_dbg(dev, state, "type ");
			error = pm_op(dev, dev->type->pm, state);
		}
		if (error)
			goto End;
564 565
	}

566 567 568 569 570 571
	if (dev->class) {
		if (dev->class->pm) {
			pm_dev_dbg(dev, state, "class ");
			error = pm_op(dev, dev->class->pm, state);
		} else if (dev->class->resume) {
			pm_dev_dbg(dev, state, "legacy class ");
572
			error = legacy_resume(dev, dev->class->resume);
573
		}
574
	}
575
 End:
576
	device_unlock(dev);
577
	complete_all(&dev->power.completion);
578

579 580 581 582
	TRACE_RESUME(error);
	return error;
}

583 584 585 586 587
static void async_resume(void *data, async_cookie_t cookie)
{
	struct device *dev = (struct device *)data;
	int error;

588
	error = device_resume(dev, pm_transition, true);
589 590 591 592 593
	if (error)
		pm_dev_err(dev, pm_transition, " async", error);
	put_device(dev);
}

594
static bool is_async(struct device *dev)
595
{
596 597
	return dev->power.async_suspend && pm_async_enabled
		&& !pm_trace_is_enabled();
598 599
}

600
/**
601 602
 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
603
 *
604 605
 * Execute the appropriate "resume" callback for all devices whose status
 * indicates that they are suspended.
606 607 608
 */
static void dpm_resume(pm_message_t state)
{
609
	struct device *dev;
610
	ktime_t starttime = ktime_get();
611 612

	mutex_lock(&dpm_list_mtx);
613
	pm_transition = state;
614
	async_error = 0;
615

616
	list_for_each_entry(dev, &dpm_suspended_list, power.entry) {
617 618 619 620 621 622 623
		INIT_COMPLETION(dev->power.completion);
		if (is_async(dev)) {
			get_device(dev);
			async_schedule(async_resume, dev);
		}
	}

624 625
	while (!list_empty(&dpm_suspended_list)) {
		dev = to_device(dpm_suspended_list.next);
626
		get_device(dev);
627
		if (!is_async(dev)) {
628 629 630 631
			int error;

			mutex_unlock(&dpm_list_mtx);

632
			error = device_resume(dev, state, false);
633 634
			if (error)
				pm_dev_err(dev, state, "", error);
635 636

			mutex_lock(&dpm_list_mtx);
637 638
		}
		if (!list_empty(&dev->power.entry))
639
			list_move_tail(&dev->power.entry, &dpm_prepared_list);
640 641 642
		put_device(dev);
	}
	mutex_unlock(&dpm_list_mtx);
643
	async_synchronize_full();
644
	dpm_show_time(starttime, state, NULL);
645 646 647
}

/**
648 649 650
 * device_complete - Complete a PM transition for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
651
 */
652
static void device_complete(struct device *dev, pm_message_t state)
653
{
654
	device_lock(dev);
655 656 657 658 659 660 661 662 663 664 665

	if (dev->class && dev->class->pm && dev->class->pm->complete) {
		pm_dev_dbg(dev, state, "completing class ");
		dev->class->pm->complete(dev);
	}

	if (dev->type && dev->type->pm && dev->type->pm->complete) {
		pm_dev_dbg(dev, state, "completing type ");
		dev->type->pm->complete(dev);
	}

666
	if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
667
		pm_dev_dbg(dev, state, "completing ");
668
		dev->bus->pm->complete(dev);
669 670
	}

671
	device_unlock(dev);
672 673 674
}

/**
675 676
 * dpm_complete - Complete a PM transition for all non-sysdev devices.
 * @state: PM transition of the system being carried out.
677
 *
678 679
 * Execute the ->complete() callbacks for all devices whose PM status is not
 * DPM_ON (this allows new devices to be registered).
680
 */
681
static void dpm_complete(pm_message_t state)
682
{
683 684 685
	struct list_head list;

	INIT_LIST_HEAD(&list);
686
	mutex_lock(&dpm_list_mtx);
R
Romit Dasgupta 已提交
687
	transition_started = false;
688 689
	while (!list_empty(&dpm_prepared_list)) {
		struct device *dev = to_device(dpm_prepared_list.prev);
690

691
		get_device(dev);
692
		dev->power.in_suspend = false;
693 694
		list_move(&dev->power.entry, &list);
		mutex_unlock(&dpm_list_mtx);
695

696 697
		device_complete(dev, state);
		pm_runtime_put_sync(dev);
698

699
		mutex_lock(&dpm_list_mtx);
700
		put_device(dev);
701
	}
702
	list_splice(&list, &dpm_list);
703 704 705 706
	mutex_unlock(&dpm_list_mtx);
}

/**
707 708
 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
 * @state: PM transition of the system being carried out.
709
 *
710 711
 * Execute "resume" callbacks for all devices and complete the PM transition of
 * the system.
712
 */
713
void dpm_resume_end(pm_message_t state)
714
{
715
	might_sleep();
716 717
	dpm_resume(state);
	dpm_complete(state);
718
}
719
EXPORT_SYMBOL_GPL(dpm_resume_end);
720 721 722 723


/*------------------------- Suspend routines -------------------------*/

724
/**
725 726 727 728 729
 * resume_event - Return a "resume" message for given "suspend" sleep state.
 * @sleep_state: PM message representing a sleep state.
 *
 * Return a PM message representing the resume event corresponding to given
 * sleep state.
730 731
 */
static pm_message_t resume_event(pm_message_t sleep_state)
732
{
733 734 735 736 737 738 739 740
	switch (sleep_state.event) {
	case PM_EVENT_SUSPEND:
		return PMSG_RESUME;
	case PM_EVENT_FREEZE:
	case PM_EVENT_QUIESCE:
		return PMSG_RECOVER;
	case PM_EVENT_HIBERNATE:
		return PMSG_RESTORE;
741
	}
742
	return PMSG_ON;
743 744 745
}

/**
746 747 748
 * device_suspend_noirq - Execute a "late suspend" callback for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
749
 *
750 751
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
752
 */
753
static int device_suspend_noirq(struct device *dev, pm_message_t state)
754 755
{
	int error = 0;
756

757 758 759 760 761 762 763 764 765 766 767 768 769 770
	if (dev->class && dev->class->pm) {
		pm_dev_dbg(dev, state, "LATE class ");
		error = pm_noirq_op(dev, dev->class->pm, state);
		if (error)
			goto End;
	}

	if (dev->type && dev->type->pm) {
		pm_dev_dbg(dev, state, "LATE type ");
		error = pm_noirq_op(dev, dev->type->pm, state);
		if (error)
			goto End;
	}

771
	if (dev->bus && dev->bus->pm) {
772 773
		pm_dev_dbg(dev, state, "LATE ");
		error = pm_noirq_op(dev, dev->bus->pm, state);
774
	}
775 776

End:
777 778 779 780
	return error;
}

/**
781 782
 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
783
 *
784 785
 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
 * handlers for all non-sysdev devices.
786
 */
787
int dpm_suspend_noirq(pm_message_t state)
788
{
789
	ktime_t starttime = ktime_get();
790 791
	int error = 0;

792
	suspend_device_irqs();
793
	mutex_lock(&dpm_list_mtx);
794 795
	while (!list_empty(&dpm_suspended_list)) {
		struct device *dev = to_device(dpm_suspended_list.prev);
796 797 798 799

		get_device(dev);
		mutex_unlock(&dpm_list_mtx);

800
		error = device_suspend_noirq(dev, state);
801 802

		mutex_lock(&dpm_list_mtx);
803
		if (error) {
804
			pm_dev_err(dev, state, " late", error);
805
			put_device(dev);
806 807
			break;
		}
808
		if (!list_empty(&dev->power.entry))
809
			list_move(&dev->power.entry, &dpm_noirq_list);
810
		put_device(dev);
811
	}
812
	mutex_unlock(&dpm_list_mtx);
813
	if (error)
814
		dpm_resume_noirq(resume_event(state));
815 816
	else
		dpm_show_time(starttime, state, "late");
817 818
	return error;
}
819
EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
820

821 822
/**
 * legacy_suspend - Execute a legacy (bus or class) suspend callback for device.
R
Randy Dunlap 已提交
823 824 825
 * @dev: Device to suspend.
 * @state: PM transition of the system being carried out.
 * @cb: Suspend callback to execute.
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
 */
static int legacy_suspend(struct device *dev, pm_message_t state,
			  int (*cb)(struct device *dev, pm_message_t state))
{
	int error;
	ktime_t calltime;

	calltime = initcall_debug_start(dev);

	error = cb(dev, state);
	suspend_report_result(cb, error);

	initcall_debug_report(dev, calltime, error);

	return error;
}

843
/**
844 845 846
 * device_suspend - Execute "suspend" callbacks for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
847
 * @async: If true, the device is being suspended asynchronously.
848
 */
849
static int __device_suspend(struct device *dev, pm_message_t state, bool async)
850 851 852
{
	int error = 0;

853
	dpm_wait_for_children(dev, async);
854
	device_lock(dev);
855

856 857 858
	if (async_error)
		goto End;

859 860 861 862 863
	if (pm_wakeup_pending()) {
		async_error = -EBUSY;
		goto End;
	}

864 865 866 867 868 869
	if (dev->class) {
		if (dev->class->pm) {
			pm_dev_dbg(dev, state, "class ");
			error = pm_op(dev, dev->class->pm, state);
		} else if (dev->class->suspend) {
			pm_dev_dbg(dev, state, "legacy class ");
870
			error = legacy_suspend(dev, state, dev->class->suspend);
871 872 873
		}
		if (error)
			goto End;
874 875
	}

876 877 878 879 880 881 882
	if (dev->type) {
		if (dev->type->pm) {
			pm_dev_dbg(dev, state, "type ");
			error = pm_op(dev, dev->type->pm, state);
		}
		if (error)
			goto End;
883 884
	}

885 886 887
	if (dev->bus) {
		if (dev->bus->pm) {
			pm_dev_dbg(dev, state, "");
888
			error = pm_op(dev, dev->bus->pm, state);
889 890
		} else if (dev->bus->suspend) {
			pm_dev_dbg(dev, state, "legacy ");
891
			error = legacy_suspend(dev, state, dev->bus->suspend);
892
		}
893
	}
894

895
 End:
896
	device_unlock(dev);
897
	complete_all(&dev->power.completion);
898

899 900 901
	if (error)
		async_error = error;

902 903 904
	return error;
}

905 906 907 908 909 910
static void async_suspend(void *data, async_cookie_t cookie)
{
	struct device *dev = (struct device *)data;
	int error;

	error = __device_suspend(dev, pm_transition, true);
911
	if (error)
912 913 914 915 916 917 918 919 920
		pm_dev_err(dev, pm_transition, " async", error);

	put_device(dev);
}

static int device_suspend(struct device *dev)
{
	INIT_COMPLETION(dev->power.completion);

921
	if (pm_async_enabled && dev->power.async_suspend) {
922 923 924 925 926 927 928 929
		get_device(dev);
		async_schedule(async_suspend, dev);
		return 0;
	}

	return __device_suspend(dev, pm_transition, false);
}

930
/**
931 932
 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
 * @state: PM transition of the system being carried out.
933
 */
934
static int dpm_suspend(pm_message_t state)
935
{
936
	ktime_t starttime = ktime_get();
937 938 939
	int error = 0;

	mutex_lock(&dpm_list_mtx);
940 941
	pm_transition = state;
	async_error = 0;
942 943
	while (!list_empty(&dpm_prepared_list)) {
		struct device *dev = to_device(dpm_prepared_list.prev);
944

945
		get_device(dev);
946
		mutex_unlock(&dpm_list_mtx);
947

948
		error = device_suspend(dev);
949

950
		mutex_lock(&dpm_list_mtx);
951
		if (error) {
952 953
			pm_dev_err(dev, state, "", error);
			put_device(dev);
954 955
			break;
		}
956
		if (!list_empty(&dev->power.entry))
957
			list_move(&dev->power.entry, &dpm_suspended_list);
958
		put_device(dev);
959 960
		if (async_error)
			break;
961 962
	}
	mutex_unlock(&dpm_list_mtx);
963 964 965
	async_synchronize_full();
	if (!error)
		error = async_error;
966 967
	if (!error)
		dpm_show_time(starttime, state, NULL);
968 969 970 971
	return error;
}

/**
972 973 974 975 976 977
 * device_prepare - Prepare a device for system power transition.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
 *
 * Execute the ->prepare() callback(s) for given device.  No new children of the
 * device may be registered after this function has returned.
978
 */
979
static int device_prepare(struct device *dev, pm_message_t state)
980 981 982
{
	int error = 0;

983
	device_lock(dev);
984

985
	if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
986
		pm_dev_dbg(dev, state, "preparing ");
987 988
		error = dev->bus->pm->prepare(dev);
		suspend_report_result(dev->bus->pm->prepare, error);
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
		if (error)
			goto End;
	}

	if (dev->type && dev->type->pm && dev->type->pm->prepare) {
		pm_dev_dbg(dev, state, "preparing type ");
		error = dev->type->pm->prepare(dev);
		suspend_report_result(dev->type->pm->prepare, error);
		if (error)
			goto End;
	}

	if (dev->class && dev->class->pm && dev->class->pm->prepare) {
		pm_dev_dbg(dev, state, "preparing class ");
		error = dev->class->pm->prepare(dev);
		suspend_report_result(dev->class->pm->prepare, error);
	}
 End:
1007
	device_unlock(dev);
1008 1009 1010

	return error;
}
1011

1012
/**
1013 1014
 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
 * @state: PM transition of the system being carried out.
1015
 *
1016
 * Execute the ->prepare() callback(s) for all devices.
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
 */
static int dpm_prepare(pm_message_t state)
{
	int error = 0;

	mutex_lock(&dpm_list_mtx);
	transition_started = true;
	while (!list_empty(&dpm_list)) {
		struct device *dev = to_device(dpm_list.next);

		get_device(dev);
		mutex_unlock(&dpm_list_mtx);

1030
		pm_runtime_get_noresume(dev);
1031 1032 1033
		if (pm_runtime_barrier(dev) && device_may_wakeup(dev))
			pm_wakeup_event(dev, 0);

1034
		if (pm_wakeup_pending()) {
1035
			pm_runtime_put_sync(dev);
1036 1037 1038 1039
			error = -EBUSY;
		} else {
			error = device_prepare(dev, state);
		}
1040 1041 1042 1043 1044

		mutex_lock(&dpm_list_mtx);
		if (error) {
			if (error == -EAGAIN) {
				put_device(dev);
S
Sebastian Ott 已提交
1045
				error = 0;
1046 1047
				continue;
			}
1048 1049
			printk(KERN_INFO "PM: Device %s not prepared "
				"for power transition: code %d\n",
1050 1051 1052 1053
				kobject_name(&dev->kobj), error);
			put_device(dev);
			break;
		}
1054
		dev->power.in_suspend = true;
1055
		if (!list_empty(&dev->power.entry))
1056
			list_move_tail(&dev->power.entry, &dpm_prepared_list);
1057 1058 1059
		put_device(dev);
	}
	mutex_unlock(&dpm_list_mtx);
1060 1061 1062
	return error;
}

1063
/**
1064 1065
 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
 * @state: PM transition of the system being carried out.
1066
 *
1067 1068
 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
 * callbacks for them.
1069
 */
1070
int dpm_suspend_start(pm_message_t state)
1071 1072
{
	int error;
1073

1074
	might_sleep();
1075 1076 1077
	error = dpm_prepare(state);
	if (!error)
		error = dpm_suspend(state);
1078 1079
	return error;
}
1080
EXPORT_SYMBOL_GPL(dpm_suspend_start);
1081 1082 1083

void __suspend_report_result(const char *function, void *fn, int ret)
{
1084 1085
	if (ret)
		printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
1086 1087
}
EXPORT_SYMBOL_GPL(__suspend_report_result);
1088 1089 1090 1091 1092 1093

/**
 * device_pm_wait_for_dev - Wait for suspend/resume of a device to complete.
 * @dev: Device to wait for.
 * @subordinate: Device that needs to wait for @dev.
 */
1094
int device_pm_wait_for_dev(struct device *subordinate, struct device *dev)
1095 1096
{
	dpm_wait(dev, subordinate->power.async_suspend);
1097
	return async_error;
1098 1099
}
EXPORT_SYMBOL_GPL(device_pm_wait_for_dev);