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

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

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

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

44
static DEFINE_MUTEX(dpm_list_mtx);
L
Linus Torvalds 已提交
45

46 47 48 49 50 51
/*
 * 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;

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

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

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

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

	list_add_tail(&dev->power.entry, &dpm_list);
102
	mutex_unlock(&dpm_list_mtx);
L
Linus Torvalds 已提交
103 104
}

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

120
/**
121 122 123
 * 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.
124 125 126 127 128 129 130 131 132 133 134 135 136
 */
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);
}

/**
137 138 139
 * 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.
140 141 142 143 144 145 146 147 148 149 150 151 152
 */
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);
}

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

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

190
/**
191 192 193 194
 * 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.
195
 */
196 197 198
static int pm_op(struct device *dev,
		 const struct dev_pm_ops *ops,
		 pm_message_t state)
199 200
{
	int error = 0;
201
	ktime_t calltime;
202

203
	calltime = initcall_debug_start(dev);
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250

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

252
	initcall_debug_report(dev, calltime, error);
253

254 255 256 257
	return error;
}

/**
258 259 260 261
 * 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.
262
 *
263 264
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
265
 */
266 267
static int pm_noirq_op(struct device *dev,
			const struct dev_pm_ops *ops,
268 269 270
			pm_message_t state)
{
	int error = 0;
271 272 273 274 275 276 277
	ktime_t calltime, delta, rettime;

	if (initcall_debug) {
		pr_info("calling  %s_i+ @ %i\n",
				dev_name(dev), task_pid_nr(current));
		calltime = ktime_get();
	}
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324

	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;
	}
325 326 327 328

	if (initcall_debug) {
		rettime = ktime_get();
		delta = ktime_sub(rettime, calltime);
329 330 331
		printk("initcall %s_i+ returned %d after %Ld usecs\n",
			dev_name(dev), error,
			(unsigned long long)ktime_to_ns(delta) >> 10);
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 365 366 367 368 369 370 371 372 373 374
	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);
}

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
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);
}

392 393 394
/*------------------------- Resume routines -------------------------*/

/**
395 396 397
 * device_resume_noirq - Execute an "early resume" callback for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
398
 *
399 400
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
401
 */
402
static int device_resume_noirq(struct device *dev, pm_message_t state)
403 404 405 406 407 408
{
	int error = 0;

	TRACE_DEVICE(dev);
	TRACE_RESUME(0);

409
	if (dev->bus && dev->bus->pm) {
410 411
		pm_dev_dbg(dev, state, "EARLY ");
		error = pm_noirq_op(dev, dev->bus->pm, state);
412
	}
413

414 415 416 417 418
	TRACE_RESUME(error);
	return error;
}

/**
419 420
 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
421
 *
422 423
 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
 * enable device drivers to receive interrupts.
424
 */
425
void dpm_resume_noirq(pm_message_t state)
426
{
427
	struct device *dev;
428
	ktime_t starttime = ktime_get();
429

430
	mutex_lock(&dpm_list_mtx);
431
	transition_started = false;
432 433 434
	list_for_each_entry(dev, &dpm_list, power.entry)
		if (dev->power.status > DPM_OFF) {
			int error;
435

436
			dev->power.status = DPM_OFF;
437
			error = device_resume_noirq(dev, state);
438 439 440
			if (error)
				pm_dev_err(dev, state, " early", error);
		}
441
	mutex_unlock(&dpm_list_mtx);
442
	dpm_show_time(starttime, state, "early");
443
	resume_device_irqs();
444
}
445
EXPORT_SYMBOL_GPL(dpm_resume_noirq);
446

447 448
/**
 * legacy_resume - Execute a legacy (bus or class) resume callback for device.
R
Randy Dunlap 已提交
449 450
 * @dev: Device to resume.
 * @cb: Resume callback to execute.
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
 */
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;
}

467
/**
468 469 470
 * device_resume - Execute "resume" callbacks for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
471
 */
472
static int device_resume(struct device *dev, pm_message_t state)
473 474 475 476 477
{
	int error = 0;

	TRACE_DEVICE(dev);
	TRACE_RESUME(0);
478

479 480
	down(&dev->sem);

481 482 483
	if (dev->bus) {
		if (dev->bus->pm) {
			pm_dev_dbg(dev, state, "");
484
			error = pm_op(dev, dev->bus->pm, state);
485 486
		} else if (dev->bus->resume) {
			pm_dev_dbg(dev, state, "legacy ");
487
			error = legacy_resume(dev, dev->bus->resume);
488 489 490
		}
		if (error)
			goto End;
491 492
	}

493 494 495 496 497 498 499
	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;
500 501
	}

502 503 504 505 506 507
	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 ");
508
			error = legacy_resume(dev, dev->class->resume);
509
		}
510
	}
511
 End:
512 513
	up(&dev->sem);

514 515 516 517
	TRACE_RESUME(error);
	return error;
}

518
/**
519 520
 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
521
 *
522 523
 * Execute the appropriate "resume" callback for all devices whose status
 * indicates that they are suspended.
524 525 526 527
 */
static void dpm_resume(pm_message_t state)
{
	struct list_head list;
528
	ktime_t starttime = ktime_get();
529 530 531 532 533 534 535 536 537 538 539 540 541

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

		get_device(dev);
		if (dev->power.status >= DPM_OFF) {
			int error;

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

542
			error = device_resume(dev, state);
543 544 545 546 547 548 549 550 551 552 553 554 555 556

			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);
557
	dpm_show_time(starttime, state, NULL);
558 559 560
}

/**
561 562 563
 * device_complete - Complete a PM transition for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
564
 */
565
static void device_complete(struct device *dev, pm_message_t state)
566 567 568 569 570 571 572 573 574 575 576 577 578
{
	down(&dev->sem);

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

579
	if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
580
		pm_dev_dbg(dev, state, "completing ");
581
		dev->bus->pm->complete(dev);
582 583 584 585 586 587
	}

	up(&dev->sem);
}

/**
588 589
 * dpm_complete - Complete a PM transition for all non-sysdev devices.
 * @state: PM transition of the system being carried out.
590
 *
591 592
 * Execute the ->complete() callbacks for all devices whose PM status is not
 * DPM_ON (this allows new devices to be registered).
593
 */
594
static void dpm_complete(pm_message_t state)
595
{
596 597 598
	struct list_head list;

	INIT_LIST_HEAD(&list);
599
	mutex_lock(&dpm_list_mtx);
R
Romit Dasgupta 已提交
600
	transition_started = false;
601 602
	while (!list_empty(&dpm_list)) {
		struct device *dev = to_device(dpm_list.prev);
603

604 605 606 607 608
		get_device(dev);
		if (dev->power.status > DPM_ON) {
			dev->power.status = DPM_ON;
			mutex_unlock(&dpm_list_mtx);

609
			device_complete(dev, state);
610
			pm_runtime_put_sync(dev);
611 612 613 614 615 616

			mutex_lock(&dpm_list_mtx);
		}
		if (!list_empty(&dev->power.entry))
			list_move(&dev->power.entry, &list);
		put_device(dev);
617
	}
618
	list_splice(&list, &dpm_list);
619 620 621 622
	mutex_unlock(&dpm_list_mtx);
}

/**
623 624
 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
 * @state: PM transition of the system being carried out.
625
 *
626 627
 * Execute "resume" callbacks for all devices and complete the PM transition of
 * the system.
628
 */
629
void dpm_resume_end(pm_message_t state)
630
{
631
	might_sleep();
632 633
	dpm_resume(state);
	dpm_complete(state);
634
}
635
EXPORT_SYMBOL_GPL(dpm_resume_end);
636 637 638 639


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

640
/**
641 642 643 644 645
 * 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.
646 647
 */
static pm_message_t resume_event(pm_message_t sleep_state)
648
{
649 650 651 652 653 654 655 656
	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;
657
	}
658
	return PMSG_ON;
659 660 661
}

/**
662 663 664
 * device_suspend_noirq - Execute a "late suspend" callback for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
665
 *
666 667
 * The driver of @dev will not receive interrupts while this function is being
 * executed.
668
 */
669
static int device_suspend_noirq(struct device *dev, pm_message_t state)
670 671
{
	int error = 0;
672

673
	if (dev->bus && dev->bus->pm) {
674 675
		pm_dev_dbg(dev, state, "LATE ");
		error = pm_noirq_op(dev, dev->bus->pm, state);
676 677 678 679 680
	}
	return error;
}

/**
681 682
 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
 * @state: PM transition of the system being carried out.
683
 *
684 685
 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
 * handlers for all non-sysdev devices.
686
 */
687
int dpm_suspend_noirq(pm_message_t state)
688
{
689
	struct device *dev;
690
	ktime_t starttime = ktime_get();
691 692
	int error = 0;

693
	suspend_device_irqs();
694
	mutex_lock(&dpm_list_mtx);
695
	list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
696
		error = device_suspend_noirq(dev, state);
697
		if (error) {
698
			pm_dev_err(dev, state, " late", error);
699 700
			break;
		}
701
		dev->power.status = DPM_OFF_IRQ;
702
	}
703
	mutex_unlock(&dpm_list_mtx);
704
	if (error)
705
		dpm_resume_noirq(resume_event(state));
706 707
	else
		dpm_show_time(starttime, state, "late");
708 709
	return error;
}
710
EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
711

712 713
/**
 * legacy_suspend - Execute a legacy (bus or class) suspend callback for device.
R
Randy Dunlap 已提交
714 715 716
 * @dev: Device to suspend.
 * @state: PM transition of the system being carried out.
 * @cb: Suspend callback to execute.
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
 */
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;
}

734
/**
735 736 737
 * device_suspend - Execute "suspend" callbacks for given device.
 * @dev: Device to handle.
 * @state: PM transition of the system being carried out.
738
 */
739
static int device_suspend(struct device *dev, pm_message_t state)
740 741 742
{
	int error = 0;

743 744
	down(&dev->sem);

745 746 747 748 749 750
	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 ");
751
			error = legacy_suspend(dev, state, dev->class->suspend);
752 753 754
		}
		if (error)
			goto End;
755 756
	}

757 758 759 760 761 762 763
	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;
764 765
	}

766 767 768
	if (dev->bus) {
		if (dev->bus->pm) {
			pm_dev_dbg(dev, state, "");
769
			error = pm_op(dev, dev->bus->pm, state);
770 771
		} else if (dev->bus->suspend) {
			pm_dev_dbg(dev, state, "legacy ");
772
			error = legacy_suspend(dev, state, dev->bus->suspend);
773
		}
774
	}
775
 End:
776 777
	up(&dev->sem);

778 779 780 781
	return error;
}

/**
782 783
 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
 * @state: PM transition of the system being carried out.
784
 */
785
static int dpm_suspend(pm_message_t state)
786
{
787
	struct list_head list;
788
	ktime_t starttime = ktime_get();
789 790
	int error = 0;

791
	INIT_LIST_HEAD(&list);
792
	mutex_lock(&dpm_list_mtx);
793 794
	while (!list_empty(&dpm_list)) {
		struct device *dev = to_device(dpm_list.prev);
795

796
		get_device(dev);
797
		mutex_unlock(&dpm_list_mtx);
798

799
		error = device_suspend(dev, state);
800

801
		mutex_lock(&dpm_list_mtx);
802
		if (error) {
803 804
			pm_dev_err(dev, state, "", error);
			put_device(dev);
805 806
			break;
		}
807
		dev->power.status = DPM_OFF;
808
		if (!list_empty(&dev->power.entry))
809 810
			list_move(&dev->power.entry, &list);
		put_device(dev);
811
	}
812
	list_splice(&list, dpm_list.prev);
813
	mutex_unlock(&dpm_list_mtx);
814 815
	if (!error)
		dpm_show_time(starttime, state, NULL);
816 817 818 819
	return error;
}

/**
820 821 822 823 824 825
 * 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.
826
 */
827
static int device_prepare(struct device *dev, pm_message_t state)
828 829 830 831 832
{
	int error = 0;

	down(&dev->sem);

833
	if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
834
		pm_dev_dbg(dev, state, "preparing ");
835 836
		error = dev->bus->pm->prepare(dev);
		suspend_report_result(dev->bus->pm->prepare, error);
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
		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:
	up(&dev->sem);

	return error;
}
859

860
/**
861 862
 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
 * @state: PM transition of the system being carried out.
863
 *
864
 * Execute the ->prepare() callback(s) for all devices.
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
 */
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);

881 882 883
		pm_runtime_get_noresume(dev);
		if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
			/* Wake-up requested during system sleep transition. */
884
			pm_runtime_put_sync(dev);
885 886 887 888
			error = -EBUSY;
		} else {
			error = device_prepare(dev, state);
		}
889 890 891 892 893 894

		mutex_lock(&dpm_list_mtx);
		if (error) {
			dev->power.status = DPM_ON;
			if (error == -EAGAIN) {
				put_device(dev);
S
Sebastian Ott 已提交
895
				error = 0;
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
				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);
911 912 913
	return error;
}

914
/**
915 916
 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
 * @state: PM transition of the system being carried out.
917
 *
918 919
 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
 * callbacks for them.
920
 */
921
int dpm_suspend_start(pm_message_t state)
922 923
{
	int error;
924

925
	might_sleep();
926 927 928
	error = dpm_prepare(state);
	if (!error)
		error = dpm_suspend(state);
929 930
	return error;
}
931
EXPORT_SYMBOL_GPL(dpm_suspend_start);
932 933 934

void __suspend_report_result(const char *function, void *fn, int ret)
{
935 936
	if (ret)
		printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
937 938
}
EXPORT_SYMBOL_GPL(__suspend_report_result);