blob: 30f0ceebd36c3ec32b4e48022dca9ec2fddb76aa [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. Wysocki775b64d2008-01-12 20:40:46 +010026#include <linux/rwsem.h>
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +010027#include <linux/interrupt.h>
Arjan van de Venf2511772009-12-13 20:29:01 +010028#include <linux/sched.h>
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -070029
Alan Sterncd59abf2007-09-21 15:36:56 -040030#include "../base.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include "power.h"
32
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010033/*
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020034 * The entries in the dpm_list list are in a depth first order, simply
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010035 * because children are guaranteed to be discovered after parents, and
36 * are inserted at the back of the list on discovery.
37 *
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010038 * Since device_pm_add() may be called with a device semaphore held,
39 * we must never try to acquire a device semaphore while holding
40 * dpm_list_mutex.
41 */
42
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020043LIST_HEAD(dpm_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Alan Sterncd59abf2007-09-21 15:36:56 -040045static DEFINE_MUTEX(dpm_list_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020047/*
48 * Set once the preparation of devices for a PM transition has started, reset
49 * before starting to resume devices. Protected by dpm_list_mtx.
50 */
51static bool transition_started;
52
53/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020054 * device_pm_init - Initialize the PM-related part of a device object.
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +020055 * @dev: Device object being initialized.
56 */
57void device_pm_init(struct device *dev)
58{
59 dev->power.status = DPM_ON;
60 pm_runtime_init(dev);
61}
62
63/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020064 * device_pm_lock - Lock the list of active devices used by the PM core.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020065 */
66void device_pm_lock(void)
67{
68 mutex_lock(&dpm_list_mtx);
69}
70
71/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020072 * device_pm_unlock - Unlock the list of active devices used by the PM core.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020073 */
74void device_pm_unlock(void)
75{
76 mutex_unlock(&dpm_list_mtx);
77}
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010078
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010079/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +020080 * device_pm_add - Add a device to the PM core's list of active devices.
81 * @dev: Device to add to the list.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +010082 */
Alan Stern3b98aea2008-08-07 13:06:12 -040083void device_pm_add(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 pr_debug("PM: Adding info for %s:%s\n",
Dmitry Torokhovc48ea602007-04-11 01:37:18 -040086 dev->bus ? dev->bus->name : "No Bus",
87 kobject_name(&dev->kobj));
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -070088 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020089 if (dev->parent) {
Rafael J. Wysockif5a6d952008-08-09 01:05:13 +020090 if (dev->parent->power.status >= DPM_SUSPENDING)
91 dev_warn(dev, "parent %s should not be sleeping\n",
Kay Sievers1e0b2cf2008-10-30 01:36:48 +010092 dev_name(dev->parent));
Rafael J. Wysocki1eede072008-05-20 23:00:01 +020093 } else if (transition_started) {
94 /*
95 * We refuse to register parentless devices while a PM
96 * transition is in progress in order to avoid leaving them
97 * unhandled down the road
98 */
Arjan van de Ven728f0892008-09-20 19:09:00 -070099 dev_WARN(dev, "Parentless device registered during a PM transaction\n");
Rafael J. Wysocki58aca232008-03-12 00:57:22 +0100100 }
Alan Stern3b98aea2008-08-07 13:06:12 -0400101
102 list_add_tail(&dev->power.entry, &dpm_list);
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -0700103 mutex_unlock(&dpm_list_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104}
105
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100106/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200107 * device_pm_remove - Remove a device from the PM core's list of active devices.
108 * @dev: Device to be removed from the list.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100109 */
Rafael J. Wysocki9cddad72007-06-13 15:53:34 +0200110void device_pm_remove(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
112 pr_debug("PM: Removing info for %s:%s\n",
Dmitry Torokhovc48ea602007-04-11 01:37:18 -0400113 dev->bus ? dev->bus->name : "No Bus",
114 kobject_name(&dev->kobj));
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -0700115 mutex_lock(&dpm_list_mtx);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 list_del_init(&dev->power.entry);
Matthias Kaehlcke11048dc2007-05-23 14:19:41 -0700117 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200118 pm_runtime_remove(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100119}
120
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200121/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200122 * device_pm_move_before - Move device in the PM core's list of active devices.
123 * @deva: Device to move in dpm_list.
124 * @devb: Device @deva should come before.
Cornelia Huckffa6a702009-03-04 12:44:00 +0100125 */
126void device_pm_move_before(struct device *deva, struct device *devb)
127{
128 pr_debug("PM: Moving %s:%s before %s:%s\n",
129 deva->bus ? deva->bus->name : "No Bus",
130 kobject_name(&deva->kobj),
131 devb->bus ? devb->bus->name : "No Bus",
132 kobject_name(&devb->kobj));
133 /* Delete deva from dpm_list and reinsert before devb. */
134 list_move_tail(&deva->power.entry, &devb->power.entry);
135}
136
137/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200138 * device_pm_move_after - Move device in the PM core's list of active devices.
139 * @deva: Device to move in dpm_list.
140 * @devb: Device @deva should come after.
Cornelia Huckffa6a702009-03-04 12:44:00 +0100141 */
142void device_pm_move_after(struct device *deva, struct device *devb)
143{
144 pr_debug("PM: Moving %s:%s after %s:%s\n",
145 deva->bus ? deva->bus->name : "No Bus",
146 kobject_name(&deva->kobj),
147 devb->bus ? devb->bus->name : "No Bus",
148 kobject_name(&devb->kobj));
149 /* Delete deva from dpm_list and reinsert after devb. */
150 list_move(&deva->power.entry, &devb->power.entry);
151}
152
153/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200154 * device_pm_move_last - Move device to end of the PM core's list of devices.
155 * @dev: Device to move in dpm_list.
Cornelia Huckffa6a702009-03-04 12:44:00 +0100156 */
157void device_pm_move_last(struct device *dev)
158{
159 pr_debug("PM: Moving %s:%s to end of list\n",
160 dev->bus ? dev->bus->name : "No Bus",
161 kobject_name(&dev->kobj));
162 list_move_tail(&dev->power.entry, &dpm_list);
163}
164
165/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200166 * pm_op - Execute the PM operation appropriate for given PM event.
167 * @dev: Device to handle.
168 * @ops: PM operations to choose from.
169 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200170 */
Dmitry Torokhovd9ab7712009-07-22 00:37:25 +0200171static int pm_op(struct device *dev,
172 const struct dev_pm_ops *ops,
173 pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200174{
175 int error = 0;
Arjan van de Venf2511772009-12-13 20:29:01 +0100176 ktime_t calltime, delta, rettime;
177
178 if (initcall_debug) {
179 pr_info("calling %s+ @ %i\n",
180 dev_name(dev), task_pid_nr(current));
181 calltime = ktime_get();
182 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200183
184 switch (state.event) {
185#ifdef CONFIG_SUSPEND
186 case PM_EVENT_SUSPEND:
187 if (ops->suspend) {
188 error = ops->suspend(dev);
189 suspend_report_result(ops->suspend, error);
190 }
191 break;
192 case PM_EVENT_RESUME:
193 if (ops->resume) {
194 error = ops->resume(dev);
195 suspend_report_result(ops->resume, error);
196 }
197 break;
198#endif /* CONFIG_SUSPEND */
199#ifdef CONFIG_HIBERNATION
200 case PM_EVENT_FREEZE:
201 case PM_EVENT_QUIESCE:
202 if (ops->freeze) {
203 error = ops->freeze(dev);
204 suspend_report_result(ops->freeze, error);
205 }
206 break;
207 case PM_EVENT_HIBERNATE:
208 if (ops->poweroff) {
209 error = ops->poweroff(dev);
210 suspend_report_result(ops->poweroff, error);
211 }
212 break;
213 case PM_EVENT_THAW:
214 case PM_EVENT_RECOVER:
215 if (ops->thaw) {
216 error = ops->thaw(dev);
217 suspend_report_result(ops->thaw, error);
218 }
219 break;
220 case PM_EVENT_RESTORE:
221 if (ops->restore) {
222 error = ops->restore(dev);
223 suspend_report_result(ops->restore, error);
224 }
225 break;
226#endif /* CONFIG_HIBERNATION */
227 default:
228 error = -EINVAL;
229 }
Arjan van de Venf2511772009-12-13 20:29:01 +0100230
231 if (initcall_debug) {
232 rettime = ktime_get();
233 delta = ktime_sub(rettime, calltime);
234 pr_info("call %s+ returned %d after %Ld usecs\n", dev_name(dev),
235 error, (unsigned long long)ktime_to_ns(delta) >> 10);
236 }
237
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200238 return error;
239}
240
241/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200242 * pm_noirq_op - Execute the PM operation appropriate for given PM event.
243 * @dev: Device to handle.
244 * @ops: PM operations to choose from.
245 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200246 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200247 * The driver of @dev will not receive interrupts while this function is being
248 * executed.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200249 */
Dmitry Torokhovd9ab7712009-07-22 00:37:25 +0200250static int pm_noirq_op(struct device *dev,
251 const struct dev_pm_ops *ops,
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200252 pm_message_t state)
253{
254 int error = 0;
Arjan van de Venf2511772009-12-13 20:29:01 +0100255 ktime_t calltime, delta, rettime;
256
257 if (initcall_debug) {
258 pr_info("calling %s_i+ @ %i\n",
259 dev_name(dev), task_pid_nr(current));
260 calltime = ktime_get();
261 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200262
263 switch (state.event) {
264#ifdef CONFIG_SUSPEND
265 case PM_EVENT_SUSPEND:
266 if (ops->suspend_noirq) {
267 error = ops->suspend_noirq(dev);
268 suspend_report_result(ops->suspend_noirq, error);
269 }
270 break;
271 case PM_EVENT_RESUME:
272 if (ops->resume_noirq) {
273 error = ops->resume_noirq(dev);
274 suspend_report_result(ops->resume_noirq, error);
275 }
276 break;
277#endif /* CONFIG_SUSPEND */
278#ifdef CONFIG_HIBERNATION
279 case PM_EVENT_FREEZE:
280 case PM_EVENT_QUIESCE:
281 if (ops->freeze_noirq) {
282 error = ops->freeze_noirq(dev);
283 suspend_report_result(ops->freeze_noirq, error);
284 }
285 break;
286 case PM_EVENT_HIBERNATE:
287 if (ops->poweroff_noirq) {
288 error = ops->poweroff_noirq(dev);
289 suspend_report_result(ops->poweroff_noirq, error);
290 }
291 break;
292 case PM_EVENT_THAW:
293 case PM_EVENT_RECOVER:
294 if (ops->thaw_noirq) {
295 error = ops->thaw_noirq(dev);
296 suspend_report_result(ops->thaw_noirq, error);
297 }
298 break;
299 case PM_EVENT_RESTORE:
300 if (ops->restore_noirq) {
301 error = ops->restore_noirq(dev);
302 suspend_report_result(ops->restore_noirq, error);
303 }
304 break;
305#endif /* CONFIG_HIBERNATION */
306 default:
307 error = -EINVAL;
308 }
Arjan van de Venf2511772009-12-13 20:29:01 +0100309
310 if (initcall_debug) {
311 rettime = ktime_get();
312 delta = ktime_sub(rettime, calltime);
313 printk("initcall %s_i+ returned %d after %Ld usecs\n", dev_name(dev),
314 error, (unsigned long long)ktime_to_ns(delta) >> 10);
315 }
316
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200317 return error;
318}
319
320static char *pm_verb(int event)
321{
322 switch (event) {
323 case PM_EVENT_SUSPEND:
324 return "suspend";
325 case PM_EVENT_RESUME:
326 return "resume";
327 case PM_EVENT_FREEZE:
328 return "freeze";
329 case PM_EVENT_QUIESCE:
330 return "quiesce";
331 case PM_EVENT_HIBERNATE:
332 return "hibernate";
333 case PM_EVENT_THAW:
334 return "thaw";
335 case PM_EVENT_RESTORE:
336 return "restore";
337 case PM_EVENT_RECOVER:
338 return "recover";
339 default:
340 return "(unknown PM event)";
341 }
342}
343
344static void pm_dev_dbg(struct device *dev, pm_message_t state, char *info)
345{
346 dev_dbg(dev, "%s%s%s\n", info, pm_verb(state.event),
347 ((state.event & PM_EVENT_SLEEP) && device_may_wakeup(dev)) ?
348 ", may wakeup" : "");
349}
350
351static void pm_dev_err(struct device *dev, pm_message_t state, char *info,
352 int error)
353{
354 printk(KERN_ERR "PM: Device %s failed to %s%s: error %d\n",
355 kobject_name(&dev->kobj), pm_verb(state.event), info, error);
356}
357
Alan Sterncd59abf2007-09-21 15:36:56 -0400358/*------------------------- Resume routines -------------------------*/
359
360/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200361 * device_resume_noirq - Execute an "early resume" callback for given device.
362 * @dev: Device to handle.
363 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400364 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200365 * The driver of @dev will not receive interrupts while this function is being
366 * executed.
Alan Sterncd59abf2007-09-21 15:36:56 -0400367 */
Alan Sternd1616302009-05-24 22:05:42 +0200368static int device_resume_noirq(struct device *dev, pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400369{
370 int error = 0;
371
372 TRACE_DEVICE(dev);
373 TRACE_RESUME(0);
374
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200375 if (!dev->bus)
376 goto End;
377
378 if (dev->bus->pm) {
379 pm_dev_dbg(dev, state, "EARLY ");
380 error = pm_noirq_op(dev, dev->bus->pm, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100381 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200382 End:
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100383 TRACE_RESUME(error);
384 return error;
385}
386
387/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200388 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
389 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100390 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200391 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
392 * enable device drivers to receive interrupts.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100393 */
Alan Sternd1616302009-05-24 22:05:42 +0200394void dpm_resume_noirq(pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100395{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200396 struct device *dev;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100397
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200398 mutex_lock(&dpm_list_mtx);
Xiaotian Feng3eb132c2009-08-20 20:28:33 +0200399 transition_started = false;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200400 list_for_each_entry(dev, &dpm_list, power.entry)
401 if (dev->power.status > DPM_OFF) {
402 int error;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100403
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200404 dev->power.status = DPM_OFF;
Alan Sternd1616302009-05-24 22:05:42 +0200405 error = device_resume_noirq(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200406 if (error)
407 pm_dev_err(dev, state, " early", error);
408 }
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200409 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100410 resume_device_irqs();
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100411}
Alan Sternd1616302009-05-24 22:05:42 +0200412EXPORT_SYMBOL_GPL(dpm_resume_noirq);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100413
414/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200415 * device_resume - Execute "resume" callbacks for given device.
416 * @dev: Device to handle.
417 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100418 */
Alan Sternd1616302009-05-24 22:05:42 +0200419static int device_resume(struct device *dev, pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100420{
421 int error = 0;
422
423 TRACE_DEVICE(dev);
424 TRACE_RESUME(0);
Alan Sterncd59abf2007-09-21 15:36:56 -0400425
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100426 down(&dev->sem);
427
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200428 if (dev->bus) {
429 if (dev->bus->pm) {
430 pm_dev_dbg(dev, state, "");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200431 error = pm_op(dev, dev->bus->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200432 } else if (dev->bus->resume) {
433 pm_dev_dbg(dev, state, "legacy ");
434 error = dev->bus->resume(dev);
435 }
436 if (error)
437 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400438 }
439
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200440 if (dev->type) {
441 if (dev->type->pm) {
442 pm_dev_dbg(dev, state, "type ");
443 error = pm_op(dev, dev->type->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200444 }
445 if (error)
446 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400447 }
448
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200449 if (dev->class) {
450 if (dev->class->pm) {
451 pm_dev_dbg(dev, state, "class ");
452 error = pm_op(dev, dev->class->pm, state);
453 } else if (dev->class->resume) {
454 pm_dev_dbg(dev, state, "legacy class ");
455 error = dev->class->resume(dev);
456 }
Alan Sterncd59abf2007-09-21 15:36:56 -0400457 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200458 End:
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100459 up(&dev->sem);
460
Alan Sterncd59abf2007-09-21 15:36:56 -0400461 TRACE_RESUME(error);
462 return error;
463}
464
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100465/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200466 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
467 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100468 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200469 * Execute the appropriate "resume" callback for all devices whose status
470 * indicates that they are suspended.
Alan Sterncd59abf2007-09-21 15:36:56 -0400471 */
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200472static void dpm_resume(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400473{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200474 struct list_head list;
Alan Sterncd59abf2007-09-21 15:36:56 -0400475
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200476 INIT_LIST_HEAD(&list);
477 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200478 while (!list_empty(&dpm_list)) {
479 struct device *dev = to_device(dpm_list.next);
480
481 get_device(dev);
482 if (dev->power.status >= DPM_OFF) {
483 int error;
484
485 dev->power.status = DPM_RESUMING;
486 mutex_unlock(&dpm_list_mtx);
487
Alan Sternd1616302009-05-24 22:05:42 +0200488 error = device_resume(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200489
490 mutex_lock(&dpm_list_mtx);
491 if (error)
492 pm_dev_err(dev, state, "", error);
493 } else if (dev->power.status == DPM_SUSPENDING) {
494 /* Allow new children of the device to be registered */
495 dev->power.status = DPM_RESUMING;
496 }
497 if (!list_empty(&dev->power.entry))
498 list_move_tail(&dev->power.entry, &list);
499 put_device(dev);
Alan Sterncd59abf2007-09-21 15:36:56 -0400500 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200501 list_splice(&list, &dpm_list);
502 mutex_unlock(&dpm_list_mtx);
503}
504
505/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200506 * device_complete - Complete a PM transition for given device.
507 * @dev: Device to handle.
508 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200509 */
Alan Sternd1616302009-05-24 22:05:42 +0200510static void device_complete(struct device *dev, pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200511{
512 down(&dev->sem);
513
514 if (dev->class && dev->class->pm && dev->class->pm->complete) {
515 pm_dev_dbg(dev, state, "completing class ");
516 dev->class->pm->complete(dev);
517 }
518
519 if (dev->type && dev->type->pm && dev->type->pm->complete) {
520 pm_dev_dbg(dev, state, "completing type ");
521 dev->type->pm->complete(dev);
522 }
523
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200524 if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200525 pm_dev_dbg(dev, state, "completing ");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200526 dev->bus->pm->complete(dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200527 }
528
529 up(&dev->sem);
530}
531
532/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200533 * dpm_complete - Complete a PM transition for all non-sysdev devices.
534 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200535 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200536 * Execute the ->complete() callbacks for all devices whose PM status is not
537 * DPM_ON (this allows new devices to be registered).
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200538 */
539static void dpm_complete(pm_message_t state)
540{
541 struct list_head list;
542
543 INIT_LIST_HEAD(&list);
544 mutex_lock(&dpm_list_mtx);
Romit Dasguptae528e872009-10-28 22:56:02 +0100545 transition_started = false;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200546 while (!list_empty(&dpm_list)) {
547 struct device *dev = to_device(dpm_list.prev);
548
549 get_device(dev);
550 if (dev->power.status > DPM_ON) {
551 dev->power.status = DPM_ON;
552 mutex_unlock(&dpm_list_mtx);
553
Alan Sternd1616302009-05-24 22:05:42 +0200554 device_complete(dev, state);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200555 pm_runtime_put_noidle(dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200556
557 mutex_lock(&dpm_list_mtx);
558 }
559 if (!list_empty(&dev->power.entry))
560 list_move(&dev->power.entry, &list);
561 put_device(dev);
562 }
563 list_splice(&list, &dpm_list);
Alan Sterncd59abf2007-09-21 15:36:56 -0400564 mutex_unlock(&dpm_list_mtx);
565}
566
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100567/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200568 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
569 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400570 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200571 * Execute "resume" callbacks for all devices and complete the PM transition of
572 * the system.
Alan Sterncd59abf2007-09-21 15:36:56 -0400573 */
Alan Sternd1616302009-05-24 22:05:42 +0200574void dpm_resume_end(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400575{
576 might_sleep();
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200577 dpm_resume(state);
578 dpm_complete(state);
Alan Sterncd59abf2007-09-21 15:36:56 -0400579}
Alan Sternd1616302009-05-24 22:05:42 +0200580EXPORT_SYMBOL_GPL(dpm_resume_end);
Alan Sterncd59abf2007-09-21 15:36:56 -0400581
582
Alan Sterncd59abf2007-09-21 15:36:56 -0400583/*------------------------- Suspend routines -------------------------*/
584
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200585/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200586 * resume_event - Return a "resume" message for given "suspend" sleep state.
587 * @sleep_state: PM message representing a sleep state.
588 *
589 * Return a PM message representing the resume event corresponding to given
590 * sleep state.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200591 */
592static pm_message_t resume_event(pm_message_t sleep_state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400593{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200594 switch (sleep_state.event) {
595 case PM_EVENT_SUSPEND:
596 return PMSG_RESUME;
597 case PM_EVENT_FREEZE:
598 case PM_EVENT_QUIESCE:
599 return PMSG_RECOVER;
600 case PM_EVENT_HIBERNATE:
601 return PMSG_RESTORE;
Alan Sterncd59abf2007-09-21 15:36:56 -0400602 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200603 return PMSG_ON;
Alan Sterncd59abf2007-09-21 15:36:56 -0400604}
605
606/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200607 * device_suspend_noirq - Execute a "late suspend" callback for given device.
608 * @dev: Device to handle.
609 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100610 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200611 * The driver of @dev will not receive interrupts while this function is being
612 * executed.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100613 */
Alan Sternd1616302009-05-24 22:05:42 +0200614static int device_suspend_noirq(struct device *dev, pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100615{
616 int error = 0;
617
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200618 if (!dev->bus)
619 return 0;
620
621 if (dev->bus->pm) {
622 pm_dev_dbg(dev, state, "LATE ");
623 error = pm_noirq_op(dev, dev->bus->pm, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100624 }
625 return error;
626}
627
628/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200629 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
630 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100631 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200632 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
633 * handlers for all non-sysdev devices.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100634 */
Alan Sternd1616302009-05-24 22:05:42 +0200635int dpm_suspend_noirq(pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100636{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200637 struct device *dev;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100638 int error = 0;
639
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100640 suspend_device_irqs();
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200641 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200642 list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
Alan Sternd1616302009-05-24 22:05:42 +0200643 error = device_suspend_noirq(dev, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100644 if (error) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200645 pm_dev_err(dev, state, " late", error);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100646 break;
647 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200648 dev->power.status = DPM_OFF_IRQ;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100649 }
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200650 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100651 if (error)
Alan Sternd1616302009-05-24 22:05:42 +0200652 dpm_resume_noirq(resume_event(state));
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100653 return error;
654}
Alan Sternd1616302009-05-24 22:05:42 +0200655EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100656
657/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200658 * device_suspend - Execute "suspend" callbacks for given device.
659 * @dev: Device to handle.
660 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400661 */
Alan Sternd1616302009-05-24 22:05:42 +0200662static int device_suspend(struct device *dev, pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400663{
664 int error = 0;
665
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100666 down(&dev->sem);
667
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200668 if (dev->class) {
669 if (dev->class->pm) {
670 pm_dev_dbg(dev, state, "class ");
671 error = pm_op(dev, dev->class->pm, state);
672 } else if (dev->class->suspend) {
673 pm_dev_dbg(dev, state, "legacy class ");
674 error = dev->class->suspend(dev, state);
675 suspend_report_result(dev->class->suspend, error);
676 }
677 if (error)
678 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400679 }
680
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200681 if (dev->type) {
682 if (dev->type->pm) {
683 pm_dev_dbg(dev, state, "type ");
684 error = pm_op(dev, dev->type->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200685 }
686 if (error)
687 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400688 }
689
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200690 if (dev->bus) {
691 if (dev->bus->pm) {
692 pm_dev_dbg(dev, state, "");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200693 error = pm_op(dev, dev->bus->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200694 } else if (dev->bus->suspend) {
695 pm_dev_dbg(dev, state, "legacy ");
696 error = dev->bus->suspend(dev, state);
697 suspend_report_result(dev->bus->suspend, error);
698 }
Alan Sterncd59abf2007-09-21 15:36:56 -0400699 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200700 End:
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100701 up(&dev->sem);
702
Alan Sterncd59abf2007-09-21 15:36:56 -0400703 return error;
704}
705
706/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200707 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
708 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400709 */
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100710static int dpm_suspend(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400711{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200712 struct list_head list;
Alan Sterncd59abf2007-09-21 15:36:56 -0400713 int error = 0;
714
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200715 INIT_LIST_HEAD(&list);
Alan Sterncd59abf2007-09-21 15:36:56 -0400716 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200717 while (!list_empty(&dpm_list)) {
718 struct device *dev = to_device(dpm_list.prev);
Alan Sterncd59abf2007-09-21 15:36:56 -0400719
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200720 get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100721 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200722
Alan Sternd1616302009-05-24 22:05:42 +0200723 error = device_suspend(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200724
Alan Stern1b3cbec2008-02-29 11:50:22 -0500725 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100726 if (error) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200727 pm_dev_err(dev, state, "", error);
728 put_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100729 break;
730 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200731 dev->power.status = DPM_OFF;
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100732 if (!list_empty(&dev->power.entry))
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200733 list_move(&dev->power.entry, &list);
734 put_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100735 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200736 list_splice(&list, dpm_list.prev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100737 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200738 return error;
739}
740
741/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200742 * device_prepare - Prepare a device for system power transition.
743 * @dev: Device to handle.
744 * @state: PM transition of the system being carried out.
745 *
746 * Execute the ->prepare() callback(s) for given device. No new children of the
747 * device may be registered after this function has returned.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200748 */
Alan Sternd1616302009-05-24 22:05:42 +0200749static int device_prepare(struct device *dev, pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200750{
751 int error = 0;
752
753 down(&dev->sem);
754
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200755 if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200756 pm_dev_dbg(dev, state, "preparing ");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200757 error = dev->bus->pm->prepare(dev);
758 suspend_report_result(dev->bus->pm->prepare, error);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200759 if (error)
760 goto End;
761 }
762
763 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
764 pm_dev_dbg(dev, state, "preparing type ");
765 error = dev->type->pm->prepare(dev);
766 suspend_report_result(dev->type->pm->prepare, error);
767 if (error)
768 goto End;
769 }
770
771 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
772 pm_dev_dbg(dev, state, "preparing class ");
773 error = dev->class->pm->prepare(dev);
774 suspend_report_result(dev->class->pm->prepare, error);
775 }
776 End:
777 up(&dev->sem);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100778
779 return error;
780}
781
782/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200783 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
784 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400785 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200786 * Execute the ->prepare() callback(s) for all devices.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200787 */
788static int dpm_prepare(pm_message_t state)
789{
790 struct list_head list;
791 int error = 0;
792
793 INIT_LIST_HEAD(&list);
794 mutex_lock(&dpm_list_mtx);
795 transition_started = true;
796 while (!list_empty(&dpm_list)) {
797 struct device *dev = to_device(dpm_list.next);
798
799 get_device(dev);
800 dev->power.status = DPM_PREPARING;
801 mutex_unlock(&dpm_list_mtx);
802
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200803 pm_runtime_get_noresume(dev);
804 if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
805 /* Wake-up requested during system sleep transition. */
806 pm_runtime_put_noidle(dev);
807 error = -EBUSY;
808 } else {
809 error = device_prepare(dev, state);
810 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200811
812 mutex_lock(&dpm_list_mtx);
813 if (error) {
814 dev->power.status = DPM_ON;
815 if (error == -EAGAIN) {
816 put_device(dev);
Sebastian Ott886a7a32009-07-08 13:26:05 +0200817 error = 0;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200818 continue;
819 }
820 printk(KERN_ERR "PM: Failed to prepare device %s "
821 "for power transition: error %d\n",
822 kobject_name(&dev->kobj), error);
823 put_device(dev);
824 break;
825 }
826 dev->power.status = DPM_SUSPENDING;
827 if (!list_empty(&dev->power.entry))
828 list_move_tail(&dev->power.entry, &list);
829 put_device(dev);
830 }
831 list_splice(&list, &dpm_list);
832 mutex_unlock(&dpm_list_mtx);
833 return error;
834}
835
836/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200837 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
838 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200839 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200840 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
841 * callbacks for them.
Alan Sterncd59abf2007-09-21 15:36:56 -0400842 */
Alan Sternd1616302009-05-24 22:05:42 +0200843int dpm_suspend_start(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400844{
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100845 int error;
Alan Sterncd59abf2007-09-21 15:36:56 -0400846
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100847 might_sleep();
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200848 error = dpm_prepare(state);
849 if (!error)
850 error = dpm_suspend(state);
Alan Sterncd59abf2007-09-21 15:36:56 -0400851 return error;
Alan Sterncd59abf2007-09-21 15:36:56 -0400852}
Alan Sternd1616302009-05-24 22:05:42 +0200853EXPORT_SYMBOL_GPL(dpm_suspend_start);
Alan Sterncd59abf2007-09-21 15:36:56 -0400854
855void __suspend_report_result(const char *function, void *fn, int ret)
856{
Bjorn Helgaasc80cfb02008-10-15 22:01:35 -0700857 if (ret)
858 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
Alan Sterncd59abf2007-09-21 15:36:56 -0400859}
860EXPORT_SYMBOL_GPL(__suspend_report_result);