blob: df04cb4a3611b936c6da7a7f4d5b6ebf52a4f483 [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. Wysocki33c33742009-12-13 20:31:12 +0100375 if (dev->bus && dev->bus->pm) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200376 pm_dev_dbg(dev, state, "EARLY ");
377 error = pm_noirq_op(dev, dev->bus->pm, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100378 }
Rafael J. Wysocki33c33742009-12-13 20:31:12 +0100379
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100380 TRACE_RESUME(error);
381 return error;
382}
383
384/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200385 * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
386 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100387 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200388 * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
389 * enable device drivers to receive interrupts.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100390 */
Alan Sternd1616302009-05-24 22:05:42 +0200391void dpm_resume_noirq(pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100392{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200393 struct device *dev;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100394
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200395 mutex_lock(&dpm_list_mtx);
Xiaotian Feng3eb132c2009-08-20 20:28:33 +0200396 transition_started = false;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200397 list_for_each_entry(dev, &dpm_list, power.entry)
398 if (dev->power.status > DPM_OFF) {
399 int error;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100400
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200401 dev->power.status = DPM_OFF;
Alan Sternd1616302009-05-24 22:05:42 +0200402 error = device_resume_noirq(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200403 if (error)
404 pm_dev_err(dev, state, " early", error);
405 }
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200406 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100407 resume_device_irqs();
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100408}
Alan Sternd1616302009-05-24 22:05:42 +0200409EXPORT_SYMBOL_GPL(dpm_resume_noirq);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100410
411/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200412 * device_resume - Execute "resume" callbacks for given device.
413 * @dev: Device to handle.
414 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100415 */
Alan Sternd1616302009-05-24 22:05:42 +0200416static int device_resume(struct device *dev, pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100417{
418 int error = 0;
419
420 TRACE_DEVICE(dev);
421 TRACE_RESUME(0);
Alan Sterncd59abf2007-09-21 15:36:56 -0400422
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100423 down(&dev->sem);
424
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200425 if (dev->bus) {
426 if (dev->bus->pm) {
427 pm_dev_dbg(dev, state, "");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200428 error = pm_op(dev, dev->bus->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200429 } else if (dev->bus->resume) {
430 pm_dev_dbg(dev, state, "legacy ");
431 error = dev->bus->resume(dev);
432 }
433 if (error)
434 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400435 }
436
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200437 if (dev->type) {
438 if (dev->type->pm) {
439 pm_dev_dbg(dev, state, "type ");
440 error = pm_op(dev, dev->type->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200441 }
442 if (error)
443 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400444 }
445
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200446 if (dev->class) {
447 if (dev->class->pm) {
448 pm_dev_dbg(dev, state, "class ");
449 error = pm_op(dev, dev->class->pm, state);
450 } else if (dev->class->resume) {
451 pm_dev_dbg(dev, state, "legacy class ");
452 error = dev->class->resume(dev);
453 }
Alan Sterncd59abf2007-09-21 15:36:56 -0400454 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200455 End:
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100456 up(&dev->sem);
457
Alan Sterncd59abf2007-09-21 15:36:56 -0400458 TRACE_RESUME(error);
459 return error;
460}
461
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100462/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200463 * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
464 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100465 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200466 * Execute the appropriate "resume" callback for all devices whose status
467 * indicates that they are suspended.
Alan Sterncd59abf2007-09-21 15:36:56 -0400468 */
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200469static void dpm_resume(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400470{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200471 struct list_head list;
Alan Sterncd59abf2007-09-21 15:36:56 -0400472
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200473 INIT_LIST_HEAD(&list);
474 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200475 while (!list_empty(&dpm_list)) {
476 struct device *dev = to_device(dpm_list.next);
477
478 get_device(dev);
479 if (dev->power.status >= DPM_OFF) {
480 int error;
481
482 dev->power.status = DPM_RESUMING;
483 mutex_unlock(&dpm_list_mtx);
484
Alan Sternd1616302009-05-24 22:05:42 +0200485 error = device_resume(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200486
487 mutex_lock(&dpm_list_mtx);
488 if (error)
489 pm_dev_err(dev, state, "", error);
490 } else if (dev->power.status == DPM_SUSPENDING) {
491 /* Allow new children of the device to be registered */
492 dev->power.status = DPM_RESUMING;
493 }
494 if (!list_empty(&dev->power.entry))
495 list_move_tail(&dev->power.entry, &list);
496 put_device(dev);
Alan Sterncd59abf2007-09-21 15:36:56 -0400497 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200498 list_splice(&list, &dpm_list);
499 mutex_unlock(&dpm_list_mtx);
500}
501
502/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200503 * device_complete - Complete a PM transition for given device.
504 * @dev: Device to handle.
505 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200506 */
Alan Sternd1616302009-05-24 22:05:42 +0200507static void device_complete(struct device *dev, pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200508{
509 down(&dev->sem);
510
511 if (dev->class && dev->class->pm && dev->class->pm->complete) {
512 pm_dev_dbg(dev, state, "completing class ");
513 dev->class->pm->complete(dev);
514 }
515
516 if (dev->type && dev->type->pm && dev->type->pm->complete) {
517 pm_dev_dbg(dev, state, "completing type ");
518 dev->type->pm->complete(dev);
519 }
520
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200521 if (dev->bus && dev->bus->pm && dev->bus->pm->complete) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200522 pm_dev_dbg(dev, state, "completing ");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200523 dev->bus->pm->complete(dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200524 }
525
526 up(&dev->sem);
527}
528
529/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200530 * dpm_complete - Complete a PM transition for all non-sysdev devices.
531 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200532 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200533 * Execute the ->complete() callbacks for all devices whose PM status is not
534 * DPM_ON (this allows new devices to be registered).
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200535 */
536static void dpm_complete(pm_message_t state)
537{
538 struct list_head list;
539
540 INIT_LIST_HEAD(&list);
541 mutex_lock(&dpm_list_mtx);
Romit Dasguptae528e872009-10-28 22:56:02 +0100542 transition_started = false;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200543 while (!list_empty(&dpm_list)) {
544 struct device *dev = to_device(dpm_list.prev);
545
546 get_device(dev);
547 if (dev->power.status > DPM_ON) {
548 dev->power.status = DPM_ON;
549 mutex_unlock(&dpm_list_mtx);
550
Alan Sternd1616302009-05-24 22:05:42 +0200551 device_complete(dev, state);
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200552 pm_runtime_put_noidle(dev);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200553
554 mutex_lock(&dpm_list_mtx);
555 }
556 if (!list_empty(&dev->power.entry))
557 list_move(&dev->power.entry, &list);
558 put_device(dev);
559 }
560 list_splice(&list, &dpm_list);
Alan Sterncd59abf2007-09-21 15:36:56 -0400561 mutex_unlock(&dpm_list_mtx);
562}
563
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100564/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200565 * dpm_resume_end - Execute "resume" callbacks and complete system transition.
566 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400567 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200568 * Execute "resume" callbacks for all devices and complete the PM transition of
569 * the system.
Alan Sterncd59abf2007-09-21 15:36:56 -0400570 */
Alan Sternd1616302009-05-24 22:05:42 +0200571void dpm_resume_end(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400572{
573 might_sleep();
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200574 dpm_resume(state);
575 dpm_complete(state);
Alan Sterncd59abf2007-09-21 15:36:56 -0400576}
Alan Sternd1616302009-05-24 22:05:42 +0200577EXPORT_SYMBOL_GPL(dpm_resume_end);
Alan Sterncd59abf2007-09-21 15:36:56 -0400578
579
Alan Sterncd59abf2007-09-21 15:36:56 -0400580/*------------------------- Suspend routines -------------------------*/
581
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200582/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200583 * resume_event - Return a "resume" message for given "suspend" sleep state.
584 * @sleep_state: PM message representing a sleep state.
585 *
586 * Return a PM message representing the resume event corresponding to given
587 * sleep state.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200588 */
589static pm_message_t resume_event(pm_message_t sleep_state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400590{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200591 switch (sleep_state.event) {
592 case PM_EVENT_SUSPEND:
593 return PMSG_RESUME;
594 case PM_EVENT_FREEZE:
595 case PM_EVENT_QUIESCE:
596 return PMSG_RECOVER;
597 case PM_EVENT_HIBERNATE:
598 return PMSG_RESTORE;
Alan Sterncd59abf2007-09-21 15:36:56 -0400599 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200600 return PMSG_ON;
Alan Sterncd59abf2007-09-21 15:36:56 -0400601}
602
603/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200604 * device_suspend_noirq - Execute a "late suspend" callback for given device.
605 * @dev: Device to handle.
606 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100607 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200608 * The driver of @dev will not receive interrupts while this function is being
609 * executed.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100610 */
Alan Sternd1616302009-05-24 22:05:42 +0200611static int device_suspend_noirq(struct device *dev, pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100612{
613 int error = 0;
614
Rafael J. Wysocki33c33742009-12-13 20:31:12 +0100615 if (dev->bus && dev->bus->pm) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200616 pm_dev_dbg(dev, state, "LATE ");
617 error = pm_noirq_op(dev, dev->bus->pm, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100618 }
619 return error;
620}
621
622/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200623 * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
624 * @state: PM transition of the system being carried out.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100625 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200626 * Prevent device drivers from receiving interrupts and call the "noirq" suspend
627 * handlers for all non-sysdev devices.
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100628 */
Alan Sternd1616302009-05-24 22:05:42 +0200629int dpm_suspend_noirq(pm_message_t state)
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100630{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200631 struct device *dev;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100632 int error = 0;
633
Rafael J. Wysocki2ed8d2b2009-03-16 22:34:06 +0100634 suspend_device_irqs();
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200635 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200636 list_for_each_entry_reverse(dev, &dpm_list, power.entry) {
Alan Sternd1616302009-05-24 22:05:42 +0200637 error = device_suspend_noirq(dev, state);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100638 if (error) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200639 pm_dev_err(dev, state, " late", error);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100640 break;
641 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200642 dev->power.status = DPM_OFF_IRQ;
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100643 }
Rafael J. Wysocki32bdfac2009-05-24 21:15:07 +0200644 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100645 if (error)
Alan Sternd1616302009-05-24 22:05:42 +0200646 dpm_resume_noirq(resume_event(state));
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100647 return error;
648}
Alan Sternd1616302009-05-24 22:05:42 +0200649EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100650
651/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200652 * device_suspend - Execute "suspend" callbacks for given device.
653 * @dev: Device to handle.
654 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400655 */
Alan Sternd1616302009-05-24 22:05:42 +0200656static int device_suspend(struct device *dev, pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400657{
658 int error = 0;
659
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100660 down(&dev->sem);
661
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200662 if (dev->class) {
663 if (dev->class->pm) {
664 pm_dev_dbg(dev, state, "class ");
665 error = pm_op(dev, dev->class->pm, state);
666 } else if (dev->class->suspend) {
667 pm_dev_dbg(dev, state, "legacy class ");
668 error = dev->class->suspend(dev, state);
669 suspend_report_result(dev->class->suspend, error);
670 }
671 if (error)
672 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400673 }
674
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200675 if (dev->type) {
676 if (dev->type->pm) {
677 pm_dev_dbg(dev, state, "type ");
678 error = pm_op(dev, dev->type->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200679 }
680 if (error)
681 goto End;
Alan Sterncd59abf2007-09-21 15:36:56 -0400682 }
683
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200684 if (dev->bus) {
685 if (dev->bus->pm) {
686 pm_dev_dbg(dev, state, "");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200687 error = pm_op(dev, dev->bus->pm, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200688 } else if (dev->bus->suspend) {
689 pm_dev_dbg(dev, state, "legacy ");
690 error = dev->bus->suspend(dev, state);
691 suspend_report_result(dev->bus->suspend, error);
692 }
Alan Sterncd59abf2007-09-21 15:36:56 -0400693 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200694 End:
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100695 up(&dev->sem);
696
Alan Sterncd59abf2007-09-21 15:36:56 -0400697 return error;
698}
699
700/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200701 * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
702 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400703 */
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100704static int dpm_suspend(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400705{
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200706 struct list_head list;
Alan Sterncd59abf2007-09-21 15:36:56 -0400707 int error = 0;
708
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200709 INIT_LIST_HEAD(&list);
Alan Sterncd59abf2007-09-21 15:36:56 -0400710 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200711 while (!list_empty(&dpm_list)) {
712 struct device *dev = to_device(dpm_list.prev);
Alan Sterncd59abf2007-09-21 15:36:56 -0400713
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200714 get_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100715 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200716
Alan Sternd1616302009-05-24 22:05:42 +0200717 error = device_suspend(dev, state);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200718
Alan Stern1b3cbec2008-02-29 11:50:22 -0500719 mutex_lock(&dpm_list_mtx);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100720 if (error) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200721 pm_dev_err(dev, state, "", error);
722 put_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100723 break;
724 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200725 dev->power.status = DPM_OFF;
Rafael J. Wysocki7a8d37a2008-02-25 00:35:04 +0100726 if (!list_empty(&dev->power.entry))
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200727 list_move(&dev->power.entry, &list);
728 put_device(dev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100729 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200730 list_splice(&list, dpm_list.prev);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100731 mutex_unlock(&dpm_list_mtx);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200732 return error;
733}
734
735/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200736 * device_prepare - Prepare a device for system power transition.
737 * @dev: Device to handle.
738 * @state: PM transition of the system being carried out.
739 *
740 * Execute the ->prepare() callback(s) for given device. No new children of the
741 * device may be registered after this function has returned.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200742 */
Alan Sternd1616302009-05-24 22:05:42 +0200743static int device_prepare(struct device *dev, pm_message_t state)
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200744{
745 int error = 0;
746
747 down(&dev->sem);
748
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200749 if (dev->bus && dev->bus->pm && dev->bus->pm->prepare) {
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200750 pm_dev_dbg(dev, state, "preparing ");
Rafael J. Wysockiadf09492008-10-06 22:46:05 +0200751 error = dev->bus->pm->prepare(dev);
752 suspend_report_result(dev->bus->pm->prepare, error);
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200753 if (error)
754 goto End;
755 }
756
757 if (dev->type && dev->type->pm && dev->type->pm->prepare) {
758 pm_dev_dbg(dev, state, "preparing type ");
759 error = dev->type->pm->prepare(dev);
760 suspend_report_result(dev->type->pm->prepare, error);
761 if (error)
762 goto End;
763 }
764
765 if (dev->class && dev->class->pm && dev->class->pm->prepare) {
766 pm_dev_dbg(dev, state, "preparing class ");
767 error = dev->class->pm->prepare(dev);
768 suspend_report_result(dev->class->pm->prepare, error);
769 }
770 End:
771 up(&dev->sem);
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100772
773 return error;
774}
775
776/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200777 * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
778 * @state: PM transition of the system being carried out.
Alan Sterncd59abf2007-09-21 15:36:56 -0400779 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200780 * Execute the ->prepare() callback(s) for all devices.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200781 */
782static int dpm_prepare(pm_message_t state)
783{
784 struct list_head list;
785 int error = 0;
786
787 INIT_LIST_HEAD(&list);
788 mutex_lock(&dpm_list_mtx);
789 transition_started = true;
790 while (!list_empty(&dpm_list)) {
791 struct device *dev = to_device(dpm_list.next);
792
793 get_device(dev);
794 dev->power.status = DPM_PREPARING;
795 mutex_unlock(&dpm_list_mtx);
796
Rafael J. Wysocki5e928f72009-08-18 23:38:32 +0200797 pm_runtime_get_noresume(dev);
798 if (pm_runtime_barrier(dev) && device_may_wakeup(dev)) {
799 /* Wake-up requested during system sleep transition. */
800 pm_runtime_put_noidle(dev);
801 error = -EBUSY;
802 } else {
803 error = device_prepare(dev, state);
804 }
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200805
806 mutex_lock(&dpm_list_mtx);
807 if (error) {
808 dev->power.status = DPM_ON;
809 if (error == -EAGAIN) {
810 put_device(dev);
Sebastian Ott886a7a32009-07-08 13:26:05 +0200811 error = 0;
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200812 continue;
813 }
814 printk(KERN_ERR "PM: Failed to prepare device %s "
815 "for power transition: error %d\n",
816 kobject_name(&dev->kobj), error);
817 put_device(dev);
818 break;
819 }
820 dev->power.status = DPM_SUSPENDING;
821 if (!list_empty(&dev->power.entry))
822 list_move_tail(&dev->power.entry, &list);
823 put_device(dev);
824 }
825 list_splice(&list, &dpm_list);
826 mutex_unlock(&dpm_list_mtx);
827 return error;
828}
829
830/**
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200831 * dpm_suspend_start - Prepare devices for PM transition and suspend them.
832 * @state: PM transition of the system being carried out.
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200833 *
Rafael J. Wysocki20d652d2009-08-20 20:25:52 +0200834 * Prepare all non-sysdev devices for system PM transition and execute "suspend"
835 * callbacks for them.
Alan Sterncd59abf2007-09-21 15:36:56 -0400836 */
Alan Sternd1616302009-05-24 22:05:42 +0200837int dpm_suspend_start(pm_message_t state)
Alan Sterncd59abf2007-09-21 15:36:56 -0400838{
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100839 int error;
Alan Sterncd59abf2007-09-21 15:36:56 -0400840
Rafael J. Wysocki775b64d2008-01-12 20:40:46 +0100841 might_sleep();
Rafael J. Wysocki1eede072008-05-20 23:00:01 +0200842 error = dpm_prepare(state);
843 if (!error)
844 error = dpm_suspend(state);
Alan Sterncd59abf2007-09-21 15:36:56 -0400845 return error;
Alan Sterncd59abf2007-09-21 15:36:56 -0400846}
Alan Sternd1616302009-05-24 22:05:42 +0200847EXPORT_SYMBOL_GPL(dpm_suspend_start);
Alan Sterncd59abf2007-09-21 15:36:56 -0400848
849void __suspend_report_result(const char *function, void *fn, int ret)
850{
Bjorn Helgaasc80cfb02008-10-15 22:01:35 -0700851 if (ret)
852 printk(KERN_ERR "%s(): %pF returns %d\n", function, fn, ret);
Alan Sterncd59abf2007-09-21 15:36:56 -0400853}
854EXPORT_SYMBOL_GPL(__suspend_report_result);