main.c 26.3 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

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

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

43
LIST_HEAD(dpm_list);
L
Linus Torvalds 已提交
44

45
static DEFINE_MUTEX(dpm_list_mtx);
46
static pm_message_t pm_transition;
L
Linus Torvalds 已提交
47

48 49 50 51 52 53
/*
 * 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;

54
/**
55
 * device_pm_init - Initialize the PM-related part of a device object.
56 57 58 59 60
 * @dev: Device object being initialized.
 */
void device_pm_init(struct device *dev)
{
	dev->power.status = DPM_ON;
61
	init_completion(&dev->power.completion);
62 63 64
	pm_runtime_init(dev);
}

65
/**
66
 * device_pm_lock - Lock the list of active devices used by the PM core.
67 68 69 70 71 72 73
 */
void device_pm_lock(void)
{
	mutex_lock(&dpm_list_mtx);
}

/**
74
 * device_pm_unlock - Unlock the list of active devices used by the PM core.
75 76 77 78 79
 */
void device_pm_unlock(void)
{
	mutex_unlock(&dpm_list_mtx);
}
80

81
/**
82 83
 * device_pm_add - Add a device to the PM core's list of active devices.
 * @dev: Device to add to the list.
84
 */
85
void device_pm_add(struct device *dev)
L
Linus Torvalds 已提交
86 87
{
	pr_debug("PM: Adding info for %s:%s\n",
88 89
		 dev->bus ? dev->bus->name : "No Bus",
		 kobject_name(&dev->kobj));
90
	mutex_lock(&dpm_list_mtx);
91
	if (dev->parent) {
92 93
		if (dev->parent->power.status >= DPM_SUSPENDING)
			dev_warn(dev, "parent %s should not be sleeping\n",
94
				 dev_name(dev->parent));
95 96 97 98 99 100
	} 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
		 */
101
		dev_WARN(dev, "Parentless device registered during a PM transaction\n");
102
	}
103 104

	list_add_tail(&dev->power.entry, &dpm_list);
105
	mutex_unlock(&dpm_list_mtx);
L
Linus Torvalds 已提交
106 107
}

108
/**
109 110
 * device_pm_remove - Remove a device from the PM core's list of active devices.
 * @dev: Device to be removed from the list.
111
 */
112
void device_pm_remove(struct device *dev)
L
Linus Torvalds 已提交
113 114
{
	pr_debug("PM: Removing info for %s:%s\n",
115 116
		 dev->bus ? dev->bus->name : "No Bus",
		 kobject_name(&dev->kobj));
117
	complete_all(&dev->power.completion);
118
	mutex_lock(&dpm_list_mtx);
L
Linus Torvalds 已提交
119
	list_del_init(&dev->power.entry);
120
	mutex_unlock(&dpm_list_mtx);
121
	pm_runtime_remove(dev);
122 123
}

124
/**
125 126 127
 * 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.
128 129 130 131 132 133 134 135 136 137 138 139 140
 */
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);
}

/**
141 142 143
 * 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.
144 145 146 147 148 149 150 151 152 153 154 155 156
 */
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);
}

/**
157 158
 * device_pm_move_last - Move device to end of the PM core's list of devices.
 * @dev: Device to move in dpm_list.
159 160 161 162 163 164 165 166 167
 */
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);
}

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

194 195 196 197 198 199 200 201 202 203
/**
 * 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;

204
	if (async || (pm_async_enabled && dev->power.async_suspend))
205 206 207 208 209 210 211 212 213 214 215 216 217 218
		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);
}

219
/**
220 221 222 223
 * 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.
224
 */
225 226 227
static int pm_op(struct device *dev,
		 const struct dev_pm_ops *ops,
		 pm_message_t state)
228 229
{
	int error = 0;
230
	ktime_t calltime;
231

232
	calltime = initcall_debug_start(dev);
233 234 235 236 237 238 239 240 241 242 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

	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;
	}
280

281
	initcall_debug_report(dev, calltime, error);
282

283 284 285 286
	return error;
}

/**
287 288 289 290
 * 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.
291
 *
292 293
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
294
 */
295 296
static int pm_noirq_op(struct device *dev,
			const struct dev_pm_ops *ops,
297 298 299
			pm_message_t state)
{
	int error = 0;
300 301 302
	ktime_t calltime, delta, rettime;

	if (initcall_debug) {
303 304 305
		pr_info("calling  %s+ @ %i, parent: %s\n",
				dev_name(dev), task_pid_nr(current),
				dev->parent ? dev_name(dev->parent) : "none");
306 307
		calltime = ktime_get();
	}
308 309 310 311 312 313 314 315 316 317 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

	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;
	}
355 356 357 358

	if (initcall_debug) {
		rettime = ktime_get();
		delta = ktime_sub(rettime, calltime);
359 360 361
		printk("initcall %s_i+ returned %d after %Ld usecs\n",
			dev_name(dev), error,
			(unsigned long long)ktime_to_ns(delta) >> 10);
362 363
	}

364 365 366 367 368 369 370 371 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
	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);
}

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
static void dpm_show_time(ktime_t starttime, pm_message_t state, char *info)
{
	ktime_t calltime;
	s64 usecs64;
	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);
}

422 423 424
/*------------------------- Resume routines -------------------------*/

/**
425 426 427
 * device_resume_noirq - Execute an "early resume" callback for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
428
 *
429 430
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
431
 */
432
static int device_resume_noirq(struct device *dev, pm_message_t state)
433 434 435 436 437 438
{
	int error = 0;

	TRACE_DEVICE(dev);
	TRACE_RESUME(0);

439
	if (dev->bus && dev->bus->pm) {
440 441
		pm_dev_dbg(dev, state, "EARLY ");
		error = pm_noirq_op(dev, dev->bus->pm, state);
442 443
		if (error)
			goto End;
444
	}
445

446 447 448 449 450 451 452 453 454 455 456 457 458
	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:
459 460 461 462 463
	TRACE_RESUME(error);
	return error;
}

/**
464 465
 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
466
 *
467 468
 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
 * enable device drivers to receive interrupts.
469
 */
470
void dpm_resume_noirq(pm_message_t state)
471
{
472
	struct device *dev;
473
	ktime_t starttime = ktime_get();
474

475
	mutex_lock(&dpm_list_mtx);
476
	transition_started = false;
477 478 479
	list_for_each_entry(dev, &dpm_list, power.entry)
		if (dev->power.status > DPM_OFF) {
			int error;
480

481
			dev->power.status = DPM_OFF;
482
			error = device_resume_noirq(dev, state);
483 484 485
			if (error)
				pm_dev_err(dev, state, " early", error);
		}
486
	mutex_unlock(&dpm_list_mtx);
487
	dpm_show_time(starttime, state, "early");
488
	resume_device_irqs();
489
}
490
EXPORT_SYMBOL_GPL(dpm_resume_noirq);
491

492 493
/**
 * legacy_resume - Execute a legacy (bus or class) resume callback for device.
R
Randy Dunlap 已提交
494 495
 * @dev: Device to resume.
 * @cb: Resume callback to execute.
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
 */
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;
}

512
/**
513
 * device_resume - Execute "resume" callbacks for given device.
514 515
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
516
 * @async: If true, the device is being resumed asynchronously.
517
 */
518
static int device_resume(struct device *dev, pm_message_t state, bool async)
519 520 521 522 523
{
	int error = 0;

	TRACE_DEVICE(dev);
	TRACE_RESUME(0);
524

525
	dpm_wait(dev->parent, async);
526
	device_lock(dev);
527

528 529
	dev->power.status = DPM_RESUMING;

530 531 532
	if (dev->bus) {
		if (dev->bus->pm) {
			pm_dev_dbg(dev, state, "");
533
			error = pm_op(dev, dev->bus->pm, state);
534 535
		} else if (dev->bus->resume) {
			pm_dev_dbg(dev, state, "legacy ");
536
			error = legacy_resume(dev, dev->bus->resume);
537 538 539
		}
		if (error)
			goto End;
540 541
	}

542 543 544 545 546 547 548
	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;
549 550
	}

551 552 553 554 555 556
	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 ");
557
			error = legacy_resume(dev, dev->class->resume);
558
		}
559
	}
560
 End:
561
	device_unlock(dev);
562
	complete_all(&dev->power.completion);
563

564 565 566 567
	TRACE_RESUME(error);
	return error;
}

568 569 570 571 572
static void async_resume(void *data, async_cookie_t cookie)
{
	struct device *dev = (struct device *)data;
	int error;

573
	error = device_resume(dev, pm_transition, true);
574 575 576 577 578
	if (error)
		pm_dev_err(dev, pm_transition, " async", error);
	put_device(dev);
}

579
static bool is_async(struct device *dev)
580
{
581 582
	return dev->power.async_suspend && pm_async_enabled
		&& !pm_trace_is_enabled();
583 584
}

585
/**
586 587
 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
588
 *
589 590
 * Execute the appropriate "resume" callback for all devices whose status
 * indicates that they are suspended.
591 592 593 594
 */
static void dpm_resume(pm_message_t state)
{
	struct list_head list;
595
	struct device *dev;
596
	ktime_t starttime = ktime_get();
597 598 599

	INIT_LIST_HEAD(&list);
	mutex_lock(&dpm_list_mtx);
600
	pm_transition = state;
601

602 603 604 605 606 607 608 609 610 611 612 613 614
	list_for_each_entry(dev, &dpm_list, power.entry) {
		if (dev->power.status < DPM_OFF)
			continue;

		INIT_COMPLETION(dev->power.completion);
		if (is_async(dev)) {
			get_device(dev);
			async_schedule(async_resume, dev);
		}
	}

	while (!list_empty(&dpm_list)) {
		dev = to_device(dpm_list.next);
615
		get_device(dev);
616
		if (dev->power.status >= DPM_OFF && !is_async(dev)) {
617 618 619 620
			int error;

			mutex_unlock(&dpm_list_mtx);

621
			error = device_resume(dev, state, false);
622 623 624 625 626 627 628 629 630 631 632 633 634 635

			mutex_lock(&dpm_list_mtx);
			if (error)
				pm_dev_err(dev, state, "", error);
		} else if (dev->power.status == DPM_SUSPENDING) {
			/* Allow new children of the device to be registered */
			dev->power.status = DPM_RESUMING;
		}
		if (!list_empty(&dev->power.entry))
			list_move_tail(&dev->power.entry, &list);
		put_device(dev);
	}
	list_splice(&list, &dpm_list);
	mutex_unlock(&dpm_list_mtx);
636
	async_synchronize_full();
637
	dpm_show_time(starttime, state, NULL);
638 639 640
}

/**
641 642 643
 * device_complete - Complete a PM transition for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
644
 */
645
static void device_complete(struct device *dev, pm_message_t state)
646
{
647
	device_lock(dev);
648 649 650 651 652 653 654 655 656 657 658

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

659
	if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
660
		pm_dev_dbg(dev, state, "completing ");
661
		dev->bus->pm->complete(dev);
662 663
	}

664
	device_unlock(dev);
665 666 667
}

/**
668 669
 * dpm_complete - Complete a PM transition for all non-sysdev devices.
 * @state: PM transition of the system being carried out.
670
 *
671 672
 * Execute the ->complete() callbacks for all devices whose PM status is not
 * DPM_ON (this allows new devices to be registered).
673
 */
674
static void dpm_complete(pm_message_t state)
675
{
676 677 678
	struct list_head list;

	INIT_LIST_HEAD(&list);
679
	mutex_lock(&dpm_list_mtx);
R
Romit Dasgupta 已提交
680
	transition_started = false;
681 682
	while (!list_empty(&dpm_list)) {
		struct device *dev = to_device(dpm_list.prev);
683

684 685 686 687 688
		get_device(dev);
		if (dev->power.status > DPM_ON) {
			dev->power.status = DPM_ON;
			mutex_unlock(&dpm_list_mtx);

689
			device_complete(dev, state);
690
			pm_runtime_put_sync(dev);
691 692 693 694 695 696

			mutex_lock(&dpm_list_mtx);
		}
		if (!list_empty(&dev->power.entry))
			list_move(&dev->power.entry, &list);
		put_device(dev);
697
	}
698
	list_splice(&list, &dpm_list);
699 700 701 702
	mutex_unlock(&dpm_list_mtx);
}

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


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

720
/**
721 722 723 724 725
 * 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.
726 727
 */
static pm_message_t resume_event(pm_message_t sleep_state)
728
{
729 730 731 732 733 734 735 736
	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;
737
	}
738
	return PMSG_ON;
739 740 741
}

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

753 754 755 756 757 758 759 760 761 762 763 764 765 766
	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;
	}

767
	if (dev->bus && dev->bus->pm) {
768 769
		pm_dev_dbg(dev, state, "LATE ");
		error = pm_noirq_op(dev, dev->bus->pm, state);
770
	}
771 772

End:
773 774 775 776
	return error;
}

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

789
	suspend_device_irqs();
790
	mutex_lock(&dpm_list_mtx);
791
	list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
792
		error = device_suspend_noirq(dev, state);
793
		if (error) {
794
			pm_dev_err(dev, state, " late", error);
795 796
			break;
		}
797
		dev->power.status = DPM_OFF_IRQ;
798
	}
799
	mutex_unlock(&dpm_list_mtx);
800
	if (error)
801
		dpm_resume_noirq(resume_event(state));
802 803
	else
		dpm_show_time(starttime, state, "late");
804 805
	return error;
}
806
EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
807

808 809
/**
 * legacy_suspend - Execute a legacy (bus or class) suspend callback for device.
R
Randy Dunlap 已提交
810 811 812
 * @dev: Device to suspend.
 * @state: PM transition of the system being carried out.
 * @cb: Suspend callback to execute.
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829
 */
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;
}

830 831
static int async_error;

832
/**
833 834 835
 * device_suspend - Execute "suspend" callbacks for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
836
 * @async: If true, the device is being suspended asynchronously.
837
 */
838
static int __device_suspend(struct device *dev, pm_message_t state, bool async)
839 840 841
{
	int error = 0;

842
	dpm_wait_for_children(dev, async);
843
	device_lock(dev);
844

845 846 847
	if (async_error)
		goto End;

848 849 850 851 852 853
	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 ");
854
			error = legacy_suspend(dev, state, dev->class->suspend);
855 856 857
		}
		if (error)
			goto End;
858 859
	}

860 861 862 863 864 865 866
	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;
867 868
	}

869 870 871
	if (dev->bus) {
		if (dev->bus->pm) {
			pm_dev_dbg(dev, state, "");
872
			error = pm_op(dev, dev->bus->pm, state);
873 874
		} else if (dev->bus->suspend) {
			pm_dev_dbg(dev, state, "legacy ");
875
			error = legacy_suspend(dev, state, dev->bus->suspend);
876
		}
877
	}
878 879 880 881

	if (!error)
		dev->power.status = DPM_OFF;

882
 End:
883
	device_unlock(dev);
884
	complete_all(&dev->power.completion);
885

886 887 888
	return error;
}

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
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);
	if (error) {
		pm_dev_err(dev, pm_transition, " async", error);
		async_error = error;
	}

	put_device(dev);
}

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

907
	if (pm_async_enabled && dev->power.async_suspend) {
908 909 910 911 912 913 914 915
		get_device(dev);
		async_schedule(async_suspend, dev);
		return 0;
	}

	return __device_suspend(dev, pm_transition, false);
}

916
/**
917 918
 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
 * @state: PM transition of the system being carried out.
919
 */
920
static int dpm_suspend(pm_message_t state)
921
{
922
	struct list_head list;
923
	ktime_t starttime = ktime_get();
924 925
	int error = 0;

926
	INIT_LIST_HEAD(&list);
927
	mutex_lock(&dpm_list_mtx);
928 929
	pm_transition = state;
	async_error = 0;
930 931
	while (!list_empty(&dpm_list)) {
		struct device *dev = to_device(dpm_list.prev);
932

933
		get_device(dev);
934
		mutex_unlock(&dpm_list_mtx);
935

936
		error = device_suspend(dev);
937

938
		mutex_lock(&dpm_list_mtx);
939
		if (error) {
940 941
			pm_dev_err(dev, state, "", error);
			put_device(dev);
942 943
			break;
		}
944
		if (!list_empty(&dev->power.entry))
945 946
			list_move(&dev->power.entry, &list);
		put_device(dev);
947 948
		if (async_error)
			break;
949
	}
950
	list_splice(&list, dpm_list.prev);
951
	mutex_unlock(&dpm_list_mtx);
952 953 954
	async_synchronize_full();
	if (!error)
		error = async_error;
955 956
	if (!error)
		dpm_show_time(starttime, state, NULL);
957 958 959 960
	return error;
}

/**
961 962 963 964 965 966
 * 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.
967
 */
968
static int device_prepare(struct device *dev, pm_message_t state)
969 970 971
{
	int error = 0;

972
	device_lock(dev);
973

974
	if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
975
		pm_dev_dbg(dev, state, "preparing ");
976 977
		error = dev->bus->pm->prepare(dev);
		suspend_report_result(dev->bus->pm->prepare, error);
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
		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:
996
	device_unlock(dev);
997 998 999

	return error;
}
1000

1001
/**
1002 1003
 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
 * @state: PM transition of the system being carried out.
1004
 *
1005
 * Execute the ->prepare() callback(s) for all devices.
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
 */
static int dpm_prepare(pm_message_t state)
{
	struct list_head list;
	int error = 0;

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

		get_device(dev);
		dev->power.status = DPM_PREPARING;
		mutex_unlock(&dpm_list_mtx);

1022 1023 1024
		pm_runtime_get_noresume(dev);
		if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
			/* Wake-up requested during system sleep transition. */
1025
			pm_runtime_put_sync(dev);
1026 1027 1028 1029
			error = -EBUSY;
		} else {
			error = device_prepare(dev, state);
		}
1030 1031 1032 1033 1034 1035

		mutex_lock(&dpm_list_mtx);
		if (error) {
			dev->power.status = DPM_ON;
			if (error == -EAGAIN) {
				put_device(dev);
S
Sebastian Ott 已提交
1036
				error = 0;
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
				continue;
			}
			printk(KERN_ERR "PM: Failed to prepare device %s "
				"for power transition: error %d\n",
				kobject_name(&dev->kobj), error);
			put_device(dev);
			break;
		}
		dev->power.status = DPM_SUSPENDING;
		if (!list_empty(&dev->power.entry))
			list_move_tail(&dev->power.entry, &list);
		put_device(dev);
	}
	list_splice(&list, &dpm_list);
	mutex_unlock(&dpm_list_mtx);
1052 1053 1054
	return error;
}

1055
/**
1056 1057
 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
 * @state: PM transition of the system being carried out.
1058
 *
1059 1060
 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
 * callbacks for them.
1061
 */
1062
int dpm_suspend_start(pm_message_t state)
1063 1064
{
	int error;
1065

1066
	might_sleep();
1067 1068 1069
	error = dpm_prepare(state);
	if (!error)
		error = dpm_suspend(state);
1070 1071
	return error;
}
1072
EXPORT_SYMBOL_GPL(dpm_suspend_start);
1073 1074 1075

void __suspend_report_result(const char *function, void *fn, int ret)
{
1076 1077
	if (ret)
		printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
1078 1079
}
EXPORT_SYMBOL_GPL(__suspend_report_result);
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090

/**
 * 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.
 */
void device_pm_wait_for_dev(struct device *subordinate, struct device *dev)
{
	dpm_wait(dev, subordinate->power.async_suspend);
}
EXPORT_SYMBOL_GPL(device_pm_wait_for_dev);