blob: 1a216c114a0f148b164cb7f766d5dfef1cf2df8b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * drivers/base/power/main.c - Where the driver meets power management.
3 *
4 * Copyright (c) 2003 Patrick Mochel
5 * Copyright (c) 2003 Open Source Development Lab
6 *
7 * This file is released under the GPLv2
8 *
9 *
10 * The driver model core calls device_pm_add() when a device is registered.
11 * This will intialize the embedded device_pm_info object in the device
12 * and add it to the list of power-controlled devices. sysfs entries for
13 * controlling device power management will also be added.
14 *
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020015 * A separate list is used for keeping track of power info, because the power
16 * domain dependencies may differ from the ancestral dependencies that the
17 * subsystem list maintains.
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
19
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/device.h>
Alan Sterncd59abf2007-09-21 15:36:56 -040021#include <linux/kallsyms.h>
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -070022#include <linux/mutex.h>
Alan Sterncd59abf2007-09-21 15:36:56 -040023#include <linux/pm.h>
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020024#include <linux/pm_runtime.h>
Alan Sterncd59abf2007-09-21 15:36:56 -040025#include <linux/resume-trace.h>
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +010026#include <linux/interrupt.h>
Arjan van de Venf2511772009-12-13 20:29:01 +010027#include <linux/sched.h>
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -070028
Alan Sterncd59abf2007-09-21 15:36:56 -040029#include "../base.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include "power.h"
31
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010032/*
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020033 * The entries in the dpm_list list are in a depth first order, simply
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010034 * because children are guaranteed to be discovered after parents, and
35 * are inserted at the back of the list on discovery.
36 *
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010037 * Since device_pm_add() may be called with a device semaphore held,
38 * we must never try to acquire a device semaphore while holding
39 * dpm_list_mutex.
40 */
41
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020042LIST_HEAD(dpm_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Alan Sterncd59abf2007-09-21 15:36:56 -040044static DEFINE_MUTEX(dpm_list_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020046/*
47 * Set once the preparation of devices for a PM transition has started, reset
48 * before starting to resume devices. Protected by dpm_list_mtx.
49 */
50static bool transition_started;
51
52/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020053 * device_pm_init - Initialize the PM-related part of a device object.
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020054 * @dev: Device object being initialized.
55 */
56void device_pm_init(struct device *dev)
57{
58 dev->power.status = DPM_ON;
59 pm_runtime_init(dev);
60}
61
62/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020063 * device_pm_lock - Lock the list of active devices used by the PM core.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020064 */
65void device_pm_lock(void)
66{
67 mutex_lock(&dpm_list_mtx);
68}
69
70/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020071 * device_pm_unlock - Unlock the list of active devices used by the PM core.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020072 */
73void device_pm_unlock(void)
74{
75 mutex_unlock(&dpm_list_mtx);
76}
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010077
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010078/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020079 * device_pm_add - Add a device to the PM core's list of active devices.
80 * @dev: Device to add to the list.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010081 */
Alan Stern3b98aea2008-08-07 13:06:12 -040082void device_pm_add(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 pr_debug("PM: Adding info for %s:%s\n",
Dmitry Torokhovc48ea602007-04-11 01:37:18 -040085 dev->bus ? dev->bus->name : "No Bus",
86 kobject_name(&dev->kobj));
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -070087 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020088 if (dev->parent) {
Rafael J. Wysockif5a6d952008-08-09 01:05:13 +020089 if (dev->parent->power.status >= DPM_SUSPENDING)
90 dev_warn(dev, "parent %s should not be sleeping\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +010091 dev_name(dev->parent));
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020092 } else if (transition_started) {
93 /*
94 * We refuse to register parentless devices while a PM
95 * transition is in progress in order to avoid leaving them
96 * unhandled down the road
97 */
Arjan van de Ven728f0892008-09-20 19:09:00 -070098 dev_WARN(dev, "Parentless device registered during a PM transaction\n");
Rafael J. Wysocki58aca232008-03-12 00:57:22 +010099 }
Alan Stern3b98aea2008-08-07 13:06:12 -0400100
101 list_add_tail(&dev->power.entry, &dpm_list);
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -0700102 mutex_unlock(&dpm_list_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103}
104
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100105/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200106 * device_pm_remove - Remove a device from the PM core's list of active devices.
107 * @dev: Device to be removed from the list.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100108 */
Rafael J. Wysocki9cddad72007-06-13 15:53:34 +0200109void device_pm_remove(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110{
111 pr_debug("PM: Removing info for %s:%s\n",
Dmitry Torokhovc48ea602007-04-11 01:37:18 -0400112 dev->bus ? dev->bus->name : "No Bus",
113 kobject_name(&dev->kobj));
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -0700114 mutex_lock(&dpm_list_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 list_del_init(&dev->power.entry);
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -0700116 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200117 pm_runtime_remove(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100118}
119
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200120/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200121 * device_pm_move_before - Move device in the PM core's list of active devices.
122 * @deva: Device to move in dpm_list.
123 * @devb: Device @deva should come before.
Cornelia Huckffa6a702009-03-04 12:44:00 +0100124 */
125void device_pm_move_before(struct device *deva, struct device *devb)
126{
127 pr_debug("PM: Moving %s:%s before %s:%s\n",
128 deva->bus ? deva->bus->name : "No Bus",
129 kobject_name(&deva->kobj),
130 devb->bus ? devb->bus->name : "No Bus",
131 kobject_name(&devb->kobj));
132 /* Delete deva from dpm_list and reinsert before devb. */
133 list_move_tail(&deva->power.entry, &devb->power.entry);
134}
135
136/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200137 * device_pm_move_after - Move device in the PM core's list of active devices.
138 * @deva: Device to move in dpm_list.
139 * @devb: Device @deva should come after.
Cornelia Huckffa6a702009-03-04 12:44:00 +0100140 */
141void device_pm_move_after(struct device *deva, struct device *devb)
142{
143 pr_debug("PM: Moving %s:%s after %s:%s\n",
144 deva->bus ? deva->bus->name : "No Bus",
145 kobject_name(&deva->kobj),
146 devb->bus ? devb->bus->name : "No Bus",
147 kobject_name(&devb->kobj));
148 /* Delete deva from dpm_list and reinsert after devb. */
149 list_move(&deva->power.entry, &devb->power.entry);
150}
151
152/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200153 * device_pm_move_last - Move device to end of the PM core's list of devices.
154 * @dev: Device to move in dpm_list.
Cornelia Huckffa6a702009-03-04 12:44:00 +0100155 */
156void device_pm_move_last(struct device *dev)
157{
158 pr_debug("PM: Moving %s:%s to end of list\n",
159 dev->bus ? dev->bus->name : "No Bus",
160 kobject_name(&dev->kobj));
161 list_move_tail(&dev->power.entry, &dpm_list);
162}
163
164/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200165 * pm_op - Execute the PM operation appropriate for given PM event.
166 * @dev: Device to handle.
167 * @ops: PM operations to choose from.
168 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200169 */
Dmitry Torokhovd9ab7712009-07-22 00:37:25 +0200170static int pm_op(struct device *dev,
171 const struct dev_pm_ops *ops,
172 pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200173{
174 int error = 0;
Arjan van de Venf2511772009-12-13 20:29:01 +0100175 ktime_t calltime, delta, rettime;
176
177 if (initcall_debug) {
178 pr_info("calling %s+ @ %i\n",
179 dev_name(dev), task_pid_nr(current));
180 calltime = ktime_get();
181 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200182
183 switch (state.event) {
184#ifdef CONFIG_SUSPEND
185 case PM_EVENT_SUSPEND:
186 if (ops->suspend) {
187 error = ops->suspend(dev);
188 suspend_report_result(ops->suspend, error);
189 }
190 break;
191 case PM_EVENT_RESUME:
192 if (ops->resume) {
193 error = ops->resume(dev);
194 suspend_report_result(ops->resume, error);
195 }
196 break;
197#endif /* CONFIG_SUSPEND */
198#ifdef CONFIG_HIBERNATION
199 case PM_EVENT_FREEZE:
200 case PM_EVENT_QUIESCE:
201 if (ops->freeze) {
202 error = ops->freeze(dev);
203 suspend_report_result(ops->freeze, error);
204 }
205 break;
206 case PM_EVENT_HIBERNATE:
207 if (ops->poweroff) {
208 error = ops->poweroff(dev);
209 suspend_report_result(ops->poweroff, error);
210 }
211 break;
212 case PM_EVENT_THAW:
213 case PM_EVENT_RECOVER:
214 if (ops->thaw) {
215 error = ops->thaw(dev);
216 suspend_report_result(ops->thaw, error);
217 }
218 break;
219 case PM_EVENT_RESTORE:
220 if (ops->restore) {
221 error = ops->restore(dev);
222 suspend_report_result(ops->restore, error);
223 }
224 break;
225#endif /* CONFIG_HIBERNATION */
226 default:
227 error = -EINVAL;
228 }
Arjan van de Venf2511772009-12-13 20:29:01 +0100229
230 if (initcall_debug) {
231 rettime = ktime_get();
232 delta = ktime_sub(rettime, calltime);
233 pr_info("call %s+ returned %d after %Ld usecs\n", dev_name(dev),
234 error, (unsigned long long)ktime_to_ns(delta) >> 10);
235 }
236
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200237 return error;
238}
239
240/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200241 * pm_noirq_op - Execute the PM operation appropriate for given PM event.
242 * @dev: Device to handle.
243 * @ops: PM operations to choose from.
244 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200245 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200246 * The driver of @dev will not receive interrupts while this function is being
247 * executed.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200248 */
Dmitry Torokhovd9ab7712009-07-22 00:37:25 +0200249static int pm_noirq_op(struct device *dev,
250 const struct dev_pm_ops *ops,
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200251 pm_message_t state)
252{
253 int error = 0;
Arjan van de Venf2511772009-12-13 20:29:01 +0100254 ktime_t calltime, delta, rettime;
255
256 if (initcall_debug) {
257 pr_info("calling %s_i+ @ %i\n",
258 dev_name(dev), task_pid_nr(current));
259 calltime = ktime_get();
260 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200261
262 switch (state.event) {
263#ifdef CONFIG_SUSPEND
264 case PM_EVENT_SUSPEND:
265 if (ops->suspend_noirq) {
266 error = ops->suspend_noirq(dev);
267 suspend_report_result(ops->suspend_noirq, error);
268 }
269 break;
270 case PM_EVENT_RESUME:
271 if (ops->resume_noirq) {
272 error = ops->resume_noirq(dev);
273 suspend_report_result(ops->resume_noirq, error);
274 }
275 break;
276#endif /* CONFIG_SUSPEND */
277#ifdef CONFIG_HIBERNATION
278 case PM_EVENT_FREEZE:
279 case PM_EVENT_QUIESCE:
280 if (ops->freeze_noirq) {
281 error = ops->freeze_noirq(dev);
282 suspend_report_result(ops->freeze_noirq, error);
283 }
284 break;
285 case PM_EVENT_HIBERNATE:
286 if (ops->poweroff_noirq) {
287 error = ops->poweroff_noirq(dev);
288 suspend_report_result(ops->poweroff_noirq, error);
289 }
290 break;
291 case PM_EVENT_THAW:
292 case PM_EVENT_RECOVER:
293 if (ops->thaw_noirq) {
294 error = ops->thaw_noirq(dev);
295 suspend_report_result(ops->thaw_noirq, error);
296 }
297 break;
298 case PM_EVENT_RESTORE:
299 if (ops->restore_noirq) {
300 error = ops->restore_noirq(dev);
301 suspend_report_result(ops->restore_noirq, error);
302 }
303 break;
304#endif /* CONFIG_HIBERNATION */
305 default:
306 error = -EINVAL;
307 }
Arjan van de Venf2511772009-12-13 20:29:01 +0100308
309 if (initcall_debug) {
310 rettime = ktime_get();
311 delta = ktime_sub(rettime, calltime);
312 printk("initcall %s_i+ returned %d after %Ld usecs\n", dev_name(dev),
313 error, (unsigned long long)ktime_to_ns(delta) >> 10);
314 }
315
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200316 return error;
317}
318
319static char *pm_verb(int event)
320{
321 switch (event) {
322 case PM_EVENT_SUSPEND:
323 return "suspend";
324 case PM_EVENT_RESUME:
325 return "resume";
326 case PM_EVENT_FREEZE:
327 return "freeze";
328 case PM_EVENT_QUIESCE:
329 return "quiesce";
330 case PM_EVENT_HIBERNATE:
331 return "hibernate";
332 case PM_EVENT_THAW:
333 return "thaw";
334 case PM_EVENT_RESTORE:
335 return "restore";
336 case PM_EVENT_RECOVER:
337 return "recover";
338 default:
339 return "(unknown PM event)";
340 }
341}
342
343static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
344{
345 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
346 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
347 ", may wakeup" : "");
348}
349
350static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
351 int error)
352{
353 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
354 kobject_name(&dev->kobj), pm_verb(state.event), info, error);
355}
356
Alan Sterncd59abf2007-09-21 15:36:56 -0400357/*------------------------- Resume routines -------------------------*/
358
359/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200360 * device_resume_noirq - Execute an "early resume" callback for given device.
361 * @dev: Device to handle.
362 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400363 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200364 * The driver of @dev will not receive interrupts while this function is being
365 * executed.
Alan Sterncd59abf2007-09-21 15:36:56 -0400366 */
Alan Sternd1616302009-05-24 22:05:42 +0200367static int device_resume_noirq(struct device *dev, pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400368{
369 int error = 0;
370
371 TRACE_DEVICE(dev);
372 TRACE_RESUME(0);
373
Rafael J. Wysocki33c33742009-12-13 20:31:12 +0100374 if (dev->bus && dev->bus->pm) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200375 pm_dev_dbg(dev, state, "EARLY ");
376 error = pm_noirq_op(dev, dev->bus->pm, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100377 }
Rafael J. Wysocki33c33742009-12-13 20:31:12 +0100378
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100379 TRACE_RESUME(error);
380 return error;
381}
382
383/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200384 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
385 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100386 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200387 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
388 * enable device drivers to receive interrupts.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100389 */
Alan Sternd1616302009-05-24 22:05:42 +0200390void dpm_resume_noirq(pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100391{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200392 struct device *dev;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100393
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200394 mutex_lock(&dpm_list_mtx);
Xiaotian Feng3eb132c2009-08-20 20:28:33 +0200395 transition_started = false;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200396 list_for_each_entry(dev, &dpm_list, power.entry)
397 if (dev->power.status > DPM_OFF) {
398 int error;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100399
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200400 dev->power.status = DPM_OFF;
Alan Sternd1616302009-05-24 22:05:42 +0200401 error = device_resume_noirq(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200402 if (error)
403 pm_dev_err(dev, state, " early", error);
404 }
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200405 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100406 resume_device_irqs();
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100407}
Alan Sternd1616302009-05-24 22:05:42 +0200408EXPORT_SYMBOL_GPL(dpm_resume_noirq);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100409
410/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200411 * device_resume - Execute "resume" callbacks for given device.
412 * @dev: Device to handle.
413 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100414 */
Alan Sternd1616302009-05-24 22:05:42 +0200415static int device_resume(struct device *dev, pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100416{
417 int error = 0;
418
419 TRACE_DEVICE(dev);
420 TRACE_RESUME(0);
Alan Sterncd59abf2007-09-21 15:36:56 -0400421
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100422 down(&dev->sem);
423
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200424 if (dev->bus) {
425 if (dev->bus->pm) {
426 pm_dev_dbg(dev, state, "");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200427 error = pm_op(dev, dev->bus->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200428 } else if (dev->bus->resume) {
429 pm_dev_dbg(dev, state, "legacy ");
430 error = dev->bus->resume(dev);
431 }
432 if (error)
433 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400434 }
435
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200436 if (dev->type) {
437 if (dev->type->pm) {
438 pm_dev_dbg(dev, state, "type ");
439 error = pm_op(dev, dev->type->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200440 }
441 if (error)
442 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400443 }
444
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200445 if (dev->class) {
446 if (dev->class->pm) {
447 pm_dev_dbg(dev, state, "class ");
448 error = pm_op(dev, dev->class->pm, state);
449 } else if (dev->class->resume) {
450 pm_dev_dbg(dev, state, "legacy class ");
451 error = dev->class->resume(dev);
452 }
Alan Sterncd59abf2007-09-21 15:36:56 -0400453 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200454 End:
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100455 up(&dev->sem);
456
Alan Sterncd59abf2007-09-21 15:36:56 -0400457 TRACE_RESUME(error);
458 return error;
459}
460
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100461/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200462 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
463 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100464 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200465 * Execute the appropriate "resume" callback for all devices whose status
466 * indicates that they are suspended.
Alan Sterncd59abf2007-09-21 15:36:56 -0400467 */
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200468static void dpm_resume(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400469{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200470 struct list_head list;
Alan Sterncd59abf2007-09-21 15:36:56 -0400471
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200472 INIT_LIST_HEAD(&list);
473 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200474 while (!list_empty(&dpm_list)) {
475 struct device *dev = to_device(dpm_list.next);
476
477 get_device(dev);
478 if (dev->power.status >= DPM_OFF) {
479 int error;
480
481 dev->power.status = DPM_RESUMING;
482 mutex_unlock(&dpm_list_mtx);
483
Alan Sternd1616302009-05-24 22:05:42 +0200484 error = device_resume(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200485
486 mutex_lock(&dpm_list_mtx);
487 if (error)
488 pm_dev_err(dev, state, "", error);
489 } else if (dev->power.status == DPM_SUSPENDING) {
490 /* Allow new children of the device to be registered */
491 dev->power.status = DPM_RESUMING;
492 }
493 if (!list_empty(&dev->power.entry))
494 list_move_tail(&dev->power.entry, &list);
495 put_device(dev);
Alan Sterncd59abf2007-09-21 15:36:56 -0400496 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200497 list_splice(&list, &dpm_list);
498 mutex_unlock(&dpm_list_mtx);
499}
500
501/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200502 * device_complete - Complete a PM transition for given device.
503 * @dev: Device to handle.
504 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200505 */
Alan Sternd1616302009-05-24 22:05:42 +0200506static void device_complete(struct device *dev, pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200507{
508 down(&dev->sem);
509
510 if (dev->class && dev->class->pm && dev->class->pm->complete) {
511 pm_dev_dbg(dev, state, "completing class ");
512 dev->class->pm->complete(dev);
513 }
514
515 if (dev->type && dev->type->pm && dev->type->pm->complete) {
516 pm_dev_dbg(dev, state, "completing type ");
517 dev->type->pm->complete(dev);
518 }
519
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200520 if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200521 pm_dev_dbg(dev, state, "completing ");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200522 dev->bus->pm->complete(dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200523 }
524
525 up(&dev->sem);
526}
527
528/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200529 * dpm_complete - Complete a PM transition for all non-sysdev devices.
530 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200531 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200532 * Execute the ->complete() callbacks for all devices whose PM status is not
533 * DPM_ON (this allows new devices to be registered).
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200534 */
535static void dpm_complete(pm_message_t state)
536{
537 struct list_head list;
538
539 INIT_LIST_HEAD(&list);
540 mutex_lock(&dpm_list_mtx);
Romit Dasguptae528e872009-10-28 22:56:02 +0100541 transition_started = false;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200542 while (!list_empty(&dpm_list)) {
543 struct device *dev = to_device(dpm_list.prev);
544
545 get_device(dev);
546 if (dev->power.status > DPM_ON) {
547 dev->power.status = DPM_ON;
548 mutex_unlock(&dpm_list_mtx);
549
Alan Sternd1616302009-05-24 22:05:42 +0200550 device_complete(dev, state);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200551 pm_runtime_put_noidle(dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200552
553 mutex_lock(&dpm_list_mtx);
554 }
555 if (!list_empty(&dev->power.entry))
556 list_move(&dev->power.entry, &list);
557 put_device(dev);
558 }
559 list_splice(&list, &dpm_list);
Alan Sterncd59abf2007-09-21 15:36:56 -0400560 mutex_unlock(&dpm_list_mtx);
561}
562
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100563/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200564 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
565 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400566 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200567 * Execute "resume" callbacks for all devices and complete the PM transition of
568 * the system.
Alan Sterncd59abf2007-09-21 15:36:56 -0400569 */
Alan Sternd1616302009-05-24 22:05:42 +0200570void dpm_resume_end(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400571{
572 might_sleep();
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200573 dpm_resume(state);
574 dpm_complete(state);
Alan Sterncd59abf2007-09-21 15:36:56 -0400575}
Alan Sternd1616302009-05-24 22:05:42 +0200576EXPORT_SYMBOL_GPL(dpm_resume_end);
Alan Sterncd59abf2007-09-21 15:36:56 -0400577
578
Alan Sterncd59abf2007-09-21 15:36:56 -0400579/*------------------------- Suspend routines -------------------------*/
580
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200581/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200582 * resume_event - Return a "resume" message for given "suspend" sleep state.
583 * @sleep_state: PM message representing a sleep state.
584 *
585 * Return a PM message representing the resume event corresponding to given
586 * sleep state.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200587 */
588static pm_message_t resume_event(pm_message_t sleep_state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400589{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200590 switch (sleep_state.event) {
591 case PM_EVENT_SUSPEND:
592 return PMSG_RESUME;
593 case PM_EVENT_FREEZE:
594 case PM_EVENT_QUIESCE:
595 return PMSG_RECOVER;
596 case PM_EVENT_HIBERNATE:
597 return PMSG_RESTORE;
Alan Sterncd59abf2007-09-21 15:36:56 -0400598 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200599 return PMSG_ON;
Alan Sterncd59abf2007-09-21 15:36:56 -0400600}
601
602/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200603 * device_suspend_noirq - Execute a "late suspend" callback for given device.
604 * @dev: Device to handle.
605 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100606 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200607 * The driver of @dev will not receive interrupts while this function is being
608 * executed.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100609 */
Alan Sternd1616302009-05-24 22:05:42 +0200610static int device_suspend_noirq(struct device *dev, pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100611{
612 int error = 0;
613
Rafael J. Wysocki33c33742009-12-13 20:31:12 +0100614 if (dev->bus && dev->bus->pm) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200615 pm_dev_dbg(dev, state, "LATE ");
616 error = pm_noirq_op(dev, dev->bus->pm, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100617 }
618 return error;
619}
620
621/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200622 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
623 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100624 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200625 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
626 * handlers for all non-sysdev devices.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100627 */
Alan Sternd1616302009-05-24 22:05:42 +0200628int dpm_suspend_noirq(pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100629{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200630 struct device *dev;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100631 int error = 0;
632
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100633 suspend_device_irqs();
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200634 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200635 list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
Alan Sternd1616302009-05-24 22:05:42 +0200636 error = device_suspend_noirq(dev, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100637 if (error) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200638 pm_dev_err(dev, state, " late", error);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100639 break;
640 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200641 dev->power.status = DPM_OFF_IRQ;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100642 }
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200643 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100644 if (error)
Alan Sternd1616302009-05-24 22:05:42 +0200645 dpm_resume_noirq(resume_event(state));
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100646 return error;
647}
Alan Sternd1616302009-05-24 22:05:42 +0200648EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100649
650/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200651 * device_suspend - Execute "suspend" callbacks for given device.
652 * @dev: Device to handle.
653 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400654 */
Alan Sternd1616302009-05-24 22:05:42 +0200655static int device_suspend(struct device *dev, pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400656{
657 int error = 0;
658
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100659 down(&dev->sem);
660
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200661 if (dev->class) {
662 if (dev->class->pm) {
663 pm_dev_dbg(dev, state, "class ");
664 error = pm_op(dev, dev->class->pm, state);
665 } else if (dev->class->suspend) {
666 pm_dev_dbg(dev, state, "legacy class ");
667 error = dev->class->suspend(dev, state);
668 suspend_report_result(dev->class->suspend, error);
669 }
670 if (error)
671 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400672 }
673
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200674 if (dev->type) {
675 if (dev->type->pm) {
676 pm_dev_dbg(dev, state, "type ");
677 error = pm_op(dev, dev->type->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200678 }
679 if (error)
680 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400681 }
682
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200683 if (dev->bus) {
684 if (dev->bus->pm) {
685 pm_dev_dbg(dev, state, "");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200686 error = pm_op(dev, dev->bus->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200687 } else if (dev->bus->suspend) {
688 pm_dev_dbg(dev, state, "legacy ");
689 error = dev->bus->suspend(dev, state);
690 suspend_report_result(dev->bus->suspend, error);
691 }
Alan Sterncd59abf2007-09-21 15:36:56 -0400692 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200693 End:
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100694 up(&dev->sem);
695
Alan Sterncd59abf2007-09-21 15:36:56 -0400696 return error;
697}
698
699/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200700 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
701 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400702 */
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100703static int dpm_suspend(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400704{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200705 struct list_head list;
Alan Sterncd59abf2007-09-21 15:36:56 -0400706 int error = 0;
707
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200708 INIT_LIST_HEAD(&list);
Alan Sterncd59abf2007-09-21 15:36:56 -0400709 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200710 while (!list_empty(&dpm_list)) {
711 struct device *dev = to_device(dpm_list.prev);
Alan Sterncd59abf2007-09-21 15:36:56 -0400712
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200713 get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100714 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200715
Alan Sternd1616302009-05-24 22:05:42 +0200716 error = device_suspend(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200717
Alan Stern1b3cbec2008-02-29 11:50:22 -0500718 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100719 if (error) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200720 pm_dev_err(dev, state, "", error);
721 put_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100722 break;
723 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200724 dev->power.status = DPM_OFF;
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100725 if (!list_empty(&dev->power.entry))
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200726 list_move(&dev->power.entry, &list);
727 put_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100728 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200729 list_splice(&list, dpm_list.prev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100730 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200731 return error;
732}
733
734/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200735 * device_prepare - Prepare a device for system power transition.
736 * @dev: Device to handle.
737 * @state: PM transition of the system being carried out.
738 *
739 * Execute the ->prepare() callback(s) for given device. No new children of the
740 * device may be registered after this function has returned.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200741 */
Alan Sternd1616302009-05-24 22:05:42 +0200742static int device_prepare(struct device *dev, pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200743{
744 int error = 0;
745
746 down(&dev->sem);
747
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200748 if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200749 pm_dev_dbg(dev, state, "preparing ");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200750 error = dev->bus->pm->prepare(dev);
751 suspend_report_result(dev->bus->pm->prepare, error);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200752 if (error)
753 goto End;
754 }
755
756 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
757 pm_dev_dbg(dev, state, "preparing type ");
758 error = dev->type->pm->prepare(dev);
759 suspend_report_result(dev->type->pm->prepare, error);
760 if (error)
761 goto End;
762 }
763
764 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
765 pm_dev_dbg(dev, state, "preparing class ");
766 error = dev->class->pm->prepare(dev);
767 suspend_report_result(dev->class->pm->prepare, error);
768 }
769 End:
770 up(&dev->sem);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100771
772 return error;
773}
774
775/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200776 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
777 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400778 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200779 * Execute the ->prepare() callback(s) for all devices.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200780 */
781static int dpm_prepare(pm_message_t state)
782{
783 struct list_head list;
784 int error = 0;
785
786 INIT_LIST_HEAD(&list);
787 mutex_lock(&dpm_list_mtx);
788 transition_started = true;
789 while (!list_empty(&dpm_list)) {
790 struct device *dev = to_device(dpm_list.next);
791
792 get_device(dev);
793 dev->power.status = DPM_PREPARING;
794 mutex_unlock(&dpm_list_mtx);
795
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200796 pm_runtime_get_noresume(dev);
797 if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
798 /* Wake-up requested during system sleep transition. */
799 pm_runtime_put_noidle(dev);
800 error = -EBUSY;
801 } else {
802 error = device_prepare(dev, state);
803 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200804
805 mutex_lock(&dpm_list_mtx);
806 if (error) {
807 dev->power.status = DPM_ON;
808 if (error == -EAGAIN) {
809 put_device(dev);
Sebastian Ott886a7a32009-07-08 13:26:05 +0200810 error = 0;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200811 continue;
812 }
813 printk(KERN_ERR "PM: Failed to prepare device %s "
814 "for power transition: error %d\n",
815 kobject_name(&dev->kobj), error);
816 put_device(dev);
817 break;
818 }
819 dev->power.status = DPM_SUSPENDING;
820 if (!list_empty(&dev->power.entry))
821 list_move_tail(&dev->power.entry, &list);
822 put_device(dev);
823 }
824 list_splice(&list, &dpm_list);
825 mutex_unlock(&dpm_list_mtx);
826 return error;
827}
828
829/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200830 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
831 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200832 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200833 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
834 * callbacks for them.
Alan Sterncd59abf2007-09-21 15:36:56 -0400835 */
Alan Sternd1616302009-05-24 22:05:42 +0200836int dpm_suspend_start(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400837{
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100838 int error;
Alan Sterncd59abf2007-09-21 15:36:56 -0400839
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100840 might_sleep();
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200841 error = dpm_prepare(state);
842 if (!error)
843 error = dpm_suspend(state);
Alan Sterncd59abf2007-09-21 15:36:56 -0400844 return error;
Alan Sterncd59abf2007-09-21 15:36:56 -0400845}
Alan Sternd1616302009-05-24 22:05:42 +0200846EXPORT_SYMBOL_GPL(dpm_suspend_start);
Alan Sterncd59abf2007-09-21 15:36:56 -0400847
848void __suspend_report_result(const char *function, void *fn, int ret)
849{
Bjorn Helgaasc80cfb02008-10-15 22:01:35 -0700850 if (ret)
851 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
Alan Sterncd59abf2007-09-21 15:36:56 -0400852}
853EXPORT_SYMBOL_GPL(__suspend_report_result);