blob: 4342acbeee101d58a14235e98f798bc78537b2d3 [file] [log] [blame]
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +01001Device Power Management
2
Rafael J. Wysocki7538e3d2011-02-16 21:53:17 +01003Copyright (c) 2010-2011 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
Alan Sternd6f9cda2010-03-26 23:53:55 +01004Copyright (c) 2010 Alan Stern <stern@rowland.harvard.edu>
5
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +01006
David Brownell4fc08402006-08-10 16:38:28 -07007Most of the code in Linux is device drivers, so most of the Linux power
Alan Sternd6f9cda2010-03-26 23:53:55 +01008management (PM) code is also driver-specific. Most drivers will do very
9little; others, especially for platforms with small batteries (like cell
10phones), will do a lot.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
David Brownell4fc08402006-08-10 16:38:28 -070012This writeup gives an overview of how drivers interact with system-wide
13power management goals, emphasizing the models and interfaces that are
14shared by everything that hooks up to the driver model core. Read it as
15background for the domain-specific work you'd do with any specific driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17
David Brownell4fc08402006-08-10 16:38:28 -070018Two Models for Device Power Management
19======================================
20Drivers will use one or both of these models to put devices into low-power
21states:
22
23 System Sleep model:
Alan Sternd6f9cda2010-03-26 23:53:55 +010024 Drivers can enter low-power states as part of entering system-wide
25 low-power states like "suspend" (also known as "suspend-to-RAM"), or
26 (mostly for systems with disks) "hibernation" (also known as
27 "suspend-to-disk").
David Brownell4fc08402006-08-10 16:38:28 -070028
29 This is something that device, bus, and class drivers collaborate on
30 by implementing various role-specific suspend and resume methods to
31 cleanly power down hardware and software subsystems, then reactivate
32 them without loss of data.
33
34 Some drivers can manage hardware wakeup events, which make the system
Alan Sternd6f9cda2010-03-26 23:53:55 +010035 leave the low-power state. This feature may be enabled or disabled
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +010036 using the relevant /sys/devices/.../power/wakeup file (for Ethernet
37 drivers the ioctl interface used by ethtool may also be used for this
38 purpose); enabling it may cost some power usage, but let the whole
Alan Sternd6f9cda2010-03-26 23:53:55 +010039 system enter low-power states more often.
David Brownell4fc08402006-08-10 16:38:28 -070040
41 Runtime Power Management model:
Alan Sternd6f9cda2010-03-26 23:53:55 +010042 Devices may also be put into low-power states while the system is
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +010043 running, independently of other power management activity in principle.
44 However, devices are not generally independent of each other (for
Alan Sternd6f9cda2010-03-26 23:53:55 +010045 example, a parent device cannot be suspended unless all of its child
46 devices have been suspended). Moreover, depending on the bus type the
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +010047 device is on, it may be necessary to carry out some bus-specific
Alan Sternd6f9cda2010-03-26 23:53:55 +010048 operations on the device for this purpose. Devices put into low power
49 states at run time may require special handling during system-wide power
50 transitions (suspend or hibernation).
David Brownell4fc08402006-08-10 16:38:28 -070051
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +010052 For these reasons not only the device driver itself, but also the
Alan Sternd6f9cda2010-03-26 23:53:55 +010053 appropriate subsystem (bus type, device type or device class) driver and
54 the PM core are involved in runtime power management. As in the system
55 sleep power management case, they need to collaborate by implementing
56 various role-specific suspend and resume methods, so that the hardware
57 is cleanly powered down and reactivated without data or service loss.
David Brownell4fc08402006-08-10 16:38:28 -070058
Alan Sternd6f9cda2010-03-26 23:53:55 +010059There's not a lot to be said about those low-power states except that they are
60very system-specific, and often device-specific. Also, that if enough devices
61have been put into low-power states (at runtime), the effect may be very similar
62to entering some system-wide low-power state (system sleep) ... and that
63synergies exist, so that several drivers using runtime PM might put the system
64into a state where even deeper power saving options are available.
David Brownell4fc08402006-08-10 16:38:28 -070065
Alan Sternd6f9cda2010-03-26 23:53:55 +010066Most suspended devices will have quiesced all I/O: no more DMA or IRQs (except
67for wakeup events), no more data read or written, and requests from upstream
68drivers are no longer accepted. A given bus or platform may have different
69requirements though.
David Brownell4fc08402006-08-10 16:38:28 -070070
71Examples of hardware wakeup events include an alarm from a real time clock,
72network wake-on-LAN packets, keyboard or mouse activity, and media insertion
73or removal (for PCMCIA, MMC/SD, USB, and so on).
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75
David Brownell4fc08402006-08-10 16:38:28 -070076Interfaces for Entering System Sleep States
77===========================================
Alan Sternd6f9cda2010-03-26 23:53:55 +010078There are programming interfaces provided for subsystems (bus type, device type,
79device class) and device drivers to allow them to participate in the power
80management of devices they are concerned with. These interfaces cover both
81system sleep and runtime power management.
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
David Brownell4fc08402006-08-10 16:38:28 -070083
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +010084Device Power Management Operations
85----------------------------------
86Device power management operations, at the subsystem level as well as at the
87device driver level, are implemented by defining and populating objects of type
88struct dev_pm_ops:
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +010090struct dev_pm_ops {
91 int (*prepare)(struct device *dev);
92 void (*complete)(struct device *dev);
93 int (*suspend)(struct device *dev);
94 int (*resume)(struct device *dev);
95 int (*freeze)(struct device *dev);
96 int (*thaw)(struct device *dev);
97 int (*poweroff)(struct device *dev);
98 int (*restore)(struct device *dev);
99 int (*suspend_noirq)(struct device *dev);
100 int (*resume_noirq)(struct device *dev);
101 int (*freeze_noirq)(struct device *dev);
102 int (*thaw_noirq)(struct device *dev);
103 int (*poweroff_noirq)(struct device *dev);
104 int (*restore_noirq)(struct device *dev);
105 int (*runtime_suspend)(struct device *dev);
106 int (*runtime_resume)(struct device *dev);
107 int (*runtime_idle)(struct device *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108};
109
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100110This structure is defined in include/linux/pm.h and the methods included in it
111are also described in that file. Their roles will be explained in what follows.
Alan Sternd6f9cda2010-03-26 23:53:55 +0100112For now, it should be sufficient to remember that the last three methods are
113specific to runtime power management while the remaining ones are used during
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100114system-wide power transitions.
115
Alan Sternd6f9cda2010-03-26 23:53:55 +0100116There also is a deprecated "old" or "legacy" interface for power management
117operations available at least for some subsystems. This approach does not use
118struct dev_pm_ops objects and it is suitable only for implementing system sleep
119power management methods. Therefore it is not described in this document, so
120please refer directly to the source code for more information about it.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100121
122
123Subsystem-Level Methods
124-----------------------
125The core methods to suspend and resume devices reside in struct dev_pm_ops
Rafael J. Wysocki5841eb62011-11-23 21:18:39 +0100126pointed to by the ops member of struct dev_pm_domain, or by the pm member of
127struct bus_type, struct device_type and struct class. They are mostly of
128interest to the people writing infrastructure for platforms and buses, like PCI
129or USB, or device type and device class drivers.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100130
Alan Sternd6f9cda2010-03-26 23:53:55 +0100131Bus drivers implement these methods as appropriate for the hardware and the
132drivers using it; PCI works differently from USB, and so on. Not many people
133write subsystem-level drivers; most driver code is a "device driver" that builds
134on top of bus-specific framework code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
David Brownell4fc08402006-08-10 16:38:28 -0700136For more information on these driver calls, see the description later;
137they are called in phases for every device, respecting the parent-child
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100138sequencing in the driver model tree.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140
David Brownell4fc08402006-08-10 16:38:28 -0700141/sys/devices/.../power/wakeup files
142-----------------------------------
Alan Sternd6f9cda2010-03-26 23:53:55 +0100143All devices in the driver model have two flags to control handling of wakeup
144events (hardware signals that can force the device and/or system out of a low
145power state). These flags are initialized by bus or device driver code using
146device_set_wakeup_capable() and device_set_wakeup_enable(), defined in
147include/linux/pm_wakeup.h.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
David Brownell4fc08402006-08-10 16:38:28 -0700149The "can_wakeup" flag just records whether the device (and its driver) can
Alan Sternd6f9cda2010-03-26 23:53:55 +0100150physically support wakeup events. The device_set_wakeup_capable() routine
151affects this flag. The "should_wakeup" flag controls whether the device should
152try to use its wakeup mechanism. device_set_wakeup_enable() affects this flag;
153for the most part drivers should not change its value. The initial value of
154should_wakeup is supposed to be false for the majority of devices; the major
155exceptions are power buttons, keyboards, and Ethernet adapters whose WoL
Alan Stern8f888932011-09-26 17:38:50 +0200156(wake-on-LAN) feature has been set up with ethtool. It should also default
157to true for devices that don't generate wakeup requests on their own but merely
158forward wakeup requests from one bus to another (like PCI bridges).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Alan Sternd6f9cda2010-03-26 23:53:55 +0100160Whether or not a device is capable of issuing wakeup events is a hardware
161matter, and the kernel is responsible for keeping track of it. By contrast,
162whether or not a wakeup-capable device should issue wakeup events is a policy
163decision, and it is managed by user space through a sysfs attribute: the
164power/wakeup file. User space can write the strings "enabled" or "disabled" to
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100165set or clear the "should_wakeup" flag, respectively. This file is only present
166for wakeup-capable devices (i.e. devices whose "can_wakeup" flags are set)
167and is created (or removed) by device_set_wakeup_capable(). Reads from the
168file will return the corresponding string.
Alan Sternd6f9cda2010-03-26 23:53:55 +0100169
170The device_may_wakeup() routine returns true only if both flags are set.
Rafael J. Wysockicb8f51b2011-02-08 23:26:02 +0100171This information is used by subsystems, like the PCI bus type code, to see
172whether or not to enable the devices' wakeup mechanisms. If device wakeup
173mechanisms are enabled or disabled directly by drivers, they also should use
174device_may_wakeup() to decide what to do during a system sleep transition.
175However for runtime power management, wakeup events should be enabled whenever
176the device and driver both support them, regardless of the should_wakeup flag.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100179/sys/devices/.../power/control files
180------------------------------------
Alan Sternd6f9cda2010-03-26 23:53:55 +0100181Each device in the driver model has a flag to control whether it is subject to
182runtime power management. This flag, called runtime_auto, is initialized by the
183bus type (or generally subsystem) code using pm_runtime_allow() or
184pm_runtime_forbid(); the default is to allow runtime power management.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Alan Sternd6f9cda2010-03-26 23:53:55 +0100186The setting can be adjusted by user space by writing either "on" or "auto" to
187the device's power/control sysfs file. Writing "auto" calls pm_runtime_allow(),
188setting the flag and allowing the device to be runtime power-managed by its
189driver. Writing "on" calls pm_runtime_forbid(), clearing the flag, returning
190the device to full power if it was in a low-power state, and preventing the
191device from being runtime power-managed. User space can check the current value
192of the runtime_auto flag by reading the file.
David Brownell4fc08402006-08-10 16:38:28 -0700193
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100194The device's runtime_auto flag has no effect on the handling of system-wide
Alan Sternd6f9cda2010-03-26 23:53:55 +0100195power transitions. In particular, the device can (and in the majority of cases
196should and will) be put into a low-power state during a system-wide transition
197to a sleep state even though its runtime_auto flag is clear.
David Brownell4fc08402006-08-10 16:38:28 -0700198
Alan Sternd6f9cda2010-03-26 23:53:55 +0100199For more information about the runtime power management framework, refer to
200Documentation/power/runtime_pm.txt.
David Brownell4fc08402006-08-10 16:38:28 -0700201
202
Alan Sternd6f9cda2010-03-26 23:53:55 +0100203Calling Drivers to Enter and Leave System Sleep States
204======================================================
205When the system goes into a sleep state, each device's driver is asked to
206suspend the device by putting it into a state compatible with the target
David Brownell4fc08402006-08-10 16:38:28 -0700207system state. That's usually some version of "off", but the details are
208system-specific. Also, wakeup-enabled devices will usually stay partly
209functional in order to wake the system.
210
Alan Sternd6f9cda2010-03-26 23:53:55 +0100211When the system leaves that low-power state, the device's driver is asked to
212resume it by returning it to full power. The suspend and resume operations
213always go together, and both are multi-phase operations.
David Brownell4fc08402006-08-10 16:38:28 -0700214
Alan Sternd6f9cda2010-03-26 23:53:55 +0100215For simple drivers, suspend might quiesce the device using class code
216and then turn its hardware as "off" as possible during suspend_noirq. The
David Brownell4fc08402006-08-10 16:38:28 -0700217matching resume calls would then completely reinitialize the hardware
218before reactivating its class I/O queues.
219
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100220More power-aware drivers might prepare the devices for triggering system wakeup
221events.
David Brownell4fc08402006-08-10 16:38:28 -0700222
223
224Call Sequence Guarantees
225------------------------
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100226To ensure that bridges and similar links needing to talk to a device are
David Brownell4fc08402006-08-10 16:38:28 -0700227available when the device is suspended or resumed, the device tree is
228walked in a bottom-up order to suspend devices. A top-down order is
229used to resume those devices.
230
231The ordering of the device tree is defined by the order in which devices
232get registered: a child can never be registered, probed or resumed before
233its parent; and can't be removed or suspended after that parent.
234
235The policy is that the device tree should match hardware bus topology.
236(Or at least the control bus, for devices which use multiple busses.)
Rafael J. Wysocki58aca232008-03-12 00:57:22 +0100237In particular, this means that a device registration may fail if the parent of
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100238the device is suspending (i.e. has been chosen by the PM core as the next
Rafael J. Wysocki58aca232008-03-12 00:57:22 +0100239device to suspend) or has already suspended, as well as after all of the other
240devices have been suspended. Device drivers must be prepared to cope with such
241situations.
David Brownell4fc08402006-08-10 16:38:28 -0700242
243
Alan Sternd6f9cda2010-03-26 23:53:55 +0100244System Power Management Phases
245------------------------------
246Suspending or resuming the system is done in several phases. Different phases
247are used for standby or memory sleep states ("suspend-to-RAM") and the
248hibernation state ("suspend-to-disk"). Each phase involves executing callbacks
249for every device before the next phase begins. Not all busses or classes
250support all these callbacks and not all drivers use all the callbacks. The
251various phases always run after tasks have been frozen and before they are
252unfrozen. Furthermore, the *_noirq phases run at a time when IRQ handlers have
253been disabled (except for those marked with the IRQ_WAKEUP flag).
David Brownell4fc08402006-08-10 16:38:28 -0700254
Rafael J. Wysocki5841eb62011-11-23 21:18:39 +0100255All phases use PM domain, bus, type, or class callbacks (that is, methods
256defined in dev->pm_domain->ops, dev->bus->pm, dev->type->pm, or dev->class->pm).
257These callbacks are regarded by the PM core as mutually exclusive. Moreover,
258PM domain callbacks always take precedence over bus, type and class callbacks,
259while type callbacks take precedence over bus and class callbacks, and class
260callbacks take precedence over bus callbacks. To be precise, the following
261rules are used to determine which callback to execute in the given phase:
262
263 1. If dev->pm_domain is present, the PM core will attempt to execute the
264 callback included in dev->pm_domain->ops. If that callback is not
265 present, no action will be carried out for the given device.
266
267 2. Otherwise, if both dev->type and dev->type->pm are present, the callback
268 included in dev->type->pm will be executed.
269
270 3. Otherwise, if both dev->class and dev->class->pm are present, the
271 callback included in dev->class->pm will be executed.
272
273 4. Otherwise, if both dev->bus and dev->bus->pm are present, the callback
274 included in dev->bus->pm will be executed.
275
276This allows PM domains and device types to override callbacks provided by bus
277types or device classes if necessary.
David Brownell4fc08402006-08-10 16:38:28 -0700278
Alan Sternd6f9cda2010-03-26 23:53:55 +0100279These callbacks may in turn invoke device- or driver-specific methods stored in
280dev->driver->pm, but they don't have to.
David Brownell4fc08402006-08-10 16:38:28 -0700281
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100282
Alan Sternd6f9cda2010-03-26 23:53:55 +0100283Entering System Suspend
284-----------------------
285When the system goes into the standby or memory sleep state, the phases are:
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100286
Alan Sternd6f9cda2010-03-26 23:53:55 +0100287 prepare, suspend, suspend_noirq.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100288
Alan Sternd6f9cda2010-03-26 23:53:55 +0100289 1. The prepare phase is meant to prevent races by preventing new devices
290 from being registered; the PM core would never know that all the
291 children of a device had been suspended if new children could be
292 registered at will. (By contrast, devices may be unregistered at any
293 time.) Unlike the other suspend-related phases, during the prepare
294 phase the device tree is traversed top-down.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100295
Rafael J. Wysocki91e7c752011-05-17 23:26:00 +0200296 After the prepare callback method returns, no new children may be
297 registered below the device. The method may also prepare the device or
298 driver in some way for the upcoming system power transition (for
299 example, by allocating additional memory required for this purpose), but
300 it should not put the device into a low-power state.
Alan Sternd6f9cda2010-03-26 23:53:55 +0100301
302 2. The suspend methods should quiesce the device to stop it from performing
303 I/O. They also may save the device registers and put it into the
304 appropriate low-power state, depending on the bus type the device is on,
305 and they may enable wakeup events.
306
307 3. The suspend_noirq phase occurs after IRQ handlers have been disabled,
308 which means that the driver's interrupt handler will not be called while
309 the callback method is running. The methods should save the values of
310 the device's registers that weren't saved previously and finally put the
311 device into the appropriate low-power state.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100312
313 The majority of subsystems and device drivers need not implement this
Alan Sternd6f9cda2010-03-26 23:53:55 +0100314 callback. However, bus types allowing devices to share interrupt
315 vectors, like PCI, generally need it; otherwise a driver might encounter
316 an error during the suspend phase by fielding a shared interrupt
317 generated by some other device after its own device had been set to low
318 power.
David Brownell4fc08402006-08-10 16:38:28 -0700319
Alan Sternd6f9cda2010-03-26 23:53:55 +0100320At the end of these phases, drivers should have stopped all I/O transactions
321(DMA, IRQs), saved enough state that they can re-initialize or restore previous
322state (as needed by the hardware), and placed the device into a low-power state.
323On many platforms they will gate off one or more clock sources; sometimes they
324will also switch off power supplies or reduce voltages. (Drivers supporting
325runtime PM may already have performed some or all of these steps.)
David Brownell4fc08402006-08-10 16:38:28 -0700326
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100327If device_may_wakeup(dev) returns true, the device should be prepared for
Alan Sternd6f9cda2010-03-26 23:53:55 +0100328generating hardware wakeup signals to trigger a system wakeup event when the
329system is in the sleep state. For example, enable_irq_wake() might identify
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100330GPIO signals hooked up to a switch or other external hardware, and
331pci_enable_wake() does something similar for the PCI PME signal.
David Brownell4fc08402006-08-10 16:38:28 -0700332
Alan Sternd6f9cda2010-03-26 23:53:55 +0100333If any of these callbacks returns an error, the system won't enter the desired
334low-power state. Instead the PM core will unwind its actions by resuming all
335the devices that were suspended.
David Brownell4fc08402006-08-10 16:38:28 -0700336
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100337
Alan Sternd6f9cda2010-03-26 23:53:55 +0100338Leaving System Suspend
339----------------------
340When resuming from standby or memory sleep, the phases are:
341
342 resume_noirq, resume, complete.
343
344 1. The resume_noirq callback methods should perform any actions needed
345 before the driver's interrupt handlers are invoked. This generally
346 means undoing the actions of the suspend_noirq phase. If the bus type
347 permits devices to share interrupt vectors, like PCI, the method should
348 bring the device and its driver into a state in which the driver can
349 recognize if the device is the source of incoming interrupts, if any,
350 and handle them correctly.
351
352 For example, the PCI bus type's ->pm.resume_noirq() puts the device into
353 the full-power state (D0 in the PCI terminology) and restores the
354 standard configuration registers of the device. Then it calls the
355 device driver's ->pm.resume_noirq() method to perform device-specific
356 actions.
357
358 2. The resume methods should bring the the device back to its operating
359 state, so that it can perform normal I/O. This generally involves
360 undoing the actions of the suspend phase.
361
362 3. The complete phase uses only a bus callback. The method should undo the
363 actions of the prepare phase. Note, however, that new children may be
364 registered below the device as soon as the resume callbacks occur; it's
365 not necessary to wait until the complete phase.
366
367At the end of these phases, drivers should be as functional as they were before
368suspending: I/O can be performed using DMA and IRQs, and the relevant clocks are
369gated on. Even if the device was in a low-power state before the system sleep
370because of runtime power management, afterwards it should be back in its
371full-power state. There are multiple reasons why it's best to do this; they are
372discussed in more detail in Documentation/power/runtime_pm.txt.
373
374However, the details here may again be platform-specific. For example,
375some systems support multiple "run" states, and the mode in effect at
376the end of resume might not be the one which preceded suspension.
377That means availability of certain clocks or power supplies changed,
378which could easily affect how a driver works.
379
380Drivers need to be able to handle hardware which has been reset since the
381suspend methods were called, for example by complete reinitialization.
382This may be the hardest part, and the one most protected by NDA'd documents
383and chip errata. It's simplest if the hardware state hasn't changed since
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300384the suspend was carried out, but that can't be guaranteed (in fact, it usually
Alan Sternd6f9cda2010-03-26 23:53:55 +0100385is not the case).
386
387Drivers must also be prepared to notice that the device has been removed
388while the system was powered down, whenever that's physically possible.
389PCMCIA, MMC, USB, Firewire, SCSI, and even IDE are common examples of busses
390where common Linux platforms will see such removal. Details of how drivers
391will notice and handle such removals are currently bus-specific, and often
392involve a separate thread.
393
394These callbacks may return an error value, but the PM core will ignore such
395errors since there's nothing it can do about them other than printing them in
396the system log.
397
398
399Entering Hibernation
400--------------------
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100401Hibernating the system is more complicated than putting it into the standby or
Alan Sternd6f9cda2010-03-26 23:53:55 +0100402memory sleep state, because it involves creating and saving a system image.
403Therefore there are more phases for hibernation, with a different set of
404callbacks. These phases always run after tasks have been frozen and memory has
405been freed.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100406
Alan Sternd6f9cda2010-03-26 23:53:55 +0100407The general procedure for hibernation is to quiesce all devices (freeze), create
408an image of the system memory while everything is stable, reactivate all
409devices (thaw), write the image to permanent storage, and finally shut down the
410system (poweroff). The phases used to accomplish this are:
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100411
Alan Sternd6f9cda2010-03-26 23:53:55 +0100412 prepare, freeze, freeze_noirq, thaw_noirq, thaw, complete,
413 prepare, poweroff, poweroff_noirq
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100414
Alan Sternd6f9cda2010-03-26 23:53:55 +0100415 1. The prepare phase is discussed in the "Entering System Suspend" section
416 above.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100417
Alan Sternd6f9cda2010-03-26 23:53:55 +0100418 2. The freeze methods should quiesce the device so that it doesn't generate
419 IRQs or DMA, and they may need to save the values of device registers.
420 However the device does not have to be put in a low-power state, and to
421 save time it's best not to do so. Also, the device should not be
422 prepared to generate wakeup events.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100423
Alan Sternd6f9cda2010-03-26 23:53:55 +0100424 3. The freeze_noirq phase is analogous to the suspend_noirq phase discussed
425 above, except again that the device should not be put in a low-power
426 state and should not be allowed to generate wakeup events.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100427
Alan Sternd6f9cda2010-03-26 23:53:55 +0100428At this point the system image is created. All devices should be inactive and
429the contents of memory should remain undisturbed while this happens, so that the
430image forms an atomic snapshot of the system state.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100431
Alan Sternd6f9cda2010-03-26 23:53:55 +0100432 4. The thaw_noirq phase is analogous to the resume_noirq phase discussed
433 above. The main difference is that its methods can assume the device is
434 in the same state as at the end of the freeze_noirq phase.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100435
Alan Sternd6f9cda2010-03-26 23:53:55 +0100436 5. The thaw phase is analogous to the resume phase discussed above. Its
437 methods should bring the device back to an operating state, so that it
438 can be used for saving the image if necessary.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100439
Alan Sternd6f9cda2010-03-26 23:53:55 +0100440 6. The complete phase is discussed in the "Leaving System Suspend" section
441 above.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100442
Alan Sternd6f9cda2010-03-26 23:53:55 +0100443At this point the system image is saved, and the devices then need to be
444prepared for the upcoming system shutdown. This is much like suspending them
445before putting the system into the standby or memory sleep state, and the phases
446are similar.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100447
Alan Sternd6f9cda2010-03-26 23:53:55 +0100448 7. The prepare phase is discussed above.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100449
Alan Sternd6f9cda2010-03-26 23:53:55 +0100450 8. The poweroff phase is analogous to the suspend phase.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100451
Alan Sternd6f9cda2010-03-26 23:53:55 +0100452 9. The poweroff_noirq phase is analogous to the suspend_noirq phase.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100453
Alan Sternd6f9cda2010-03-26 23:53:55 +0100454The poweroff and poweroff_noirq callbacks should do essentially the same things
455as the suspend and suspend_noirq callbacks. The only notable difference is that
456they need not store the device register values, because the registers should
457already have been stored during the freeze or freeze_noirq phases.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100458
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100459
Alan Sternd6f9cda2010-03-26 23:53:55 +0100460Leaving Hibernation
461-------------------
462Resuming from hibernation is, again, more complicated than resuming from a sleep
463state in which the contents of main memory are preserved, because it requires
464a system image to be loaded into memory and the pre-hibernation memory contents
465to be restored before control can be passed back to the image kernel.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100466
Alan Sternd6f9cda2010-03-26 23:53:55 +0100467Although in principle, the image might be loaded into memory and the
468pre-hibernation memory contents restored by the boot loader, in practice this
469can't be done because boot loaders aren't smart enough and there is no
470established protocol for passing the necessary information. So instead, the
471boot loader loads a fresh instance of the kernel, called the boot kernel, into
472memory and passes control to it in the usual way. Then the boot kernel reads
473the system image, restores the pre-hibernation memory contents, and passes
474control to the image kernel. Thus two different kernels are involved in
475resuming from hibernation. In fact, the boot kernel may be completely different
476from the image kernel: a different configuration and even a different version.
477This has important consequences for device drivers and their subsystems.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100478
Alan Sternd6f9cda2010-03-26 23:53:55 +0100479To be able to load the system image into memory, the boot kernel needs to
480include at least a subset of device drivers allowing it to access the storage
481medium containing the image, although it doesn't need to include all of the
482drivers present in the image kernel. After the image has been loaded, the
483devices managed by the boot kernel need to be prepared for passing control back
484to the image kernel. This is very similar to the initial steps involved in
485creating a system image, and it is accomplished in the same way, using prepare,
486freeze, and freeze_noirq phases. However the devices affected by these phases
487are only those having drivers in the boot kernel; other devices will still be in
488whatever state the boot loader left them.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100489
Alan Sternd6f9cda2010-03-26 23:53:55 +0100490Should the restoration of the pre-hibernation memory contents fail, the boot
491kernel would go through the "thawing" procedure described above, using the
492thaw_noirq, thaw, and complete phases, and then continue running normally. This
493happens only rarely. Most often the pre-hibernation memory contents are
494restored successfully and control is passed to the image kernel, which then
495becomes responsible for bringing the system back to the working state.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100496
Alan Sternd6f9cda2010-03-26 23:53:55 +0100497To achieve this, the image kernel must restore the devices' pre-hibernation
498functionality. The operation is much like waking up from the memory sleep
499state, although it involves different phases:
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100500
Alan Sternd6f9cda2010-03-26 23:53:55 +0100501 restore_noirq, restore, complete
502
503 1. The restore_noirq phase is analogous to the resume_noirq phase.
504
505 2. The restore phase is analogous to the resume phase.
506
507 3. The complete phase is discussed above.
508
509The main difference from resume[_noirq] is that restore[_noirq] must assume the
510device has been accessed and reconfigured by the boot loader or the boot kernel.
511Consequently the state of the device may be different from the state remembered
512from the freeze and freeze_noirq phases. The device may even need to be reset
513and completely re-initialized. In many cases this difference doesn't matter, so
514the resume[_noirq] and restore[_norq] method pointers can be set to the same
515routines. Nevertheless, different callback pointers are used in case there is a
516situation where it actually matters.
517
518
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200519Device Power Management Domains
520-------------------------------
Rafael J. Wysocki7538e3d2011-02-16 21:53:17 +0100521Sometimes devices share reference clocks or other power resources. In those
522cases it generally is not possible to put devices into low-power states
523individually. Instead, a set of devices sharing a power resource can be put
524into a low-power state together at the same time by turning off the shared
525power resource. Of course, they also need to be put into the full-power state
526together, by turning the shared power resource on. A set of devices with this
527property is often referred to as a power domain.
528
Rafael J. Wysocki564b9052011-06-23 01:52:55 +0200529Support for power domains is provided through the pm_domain field of struct
530device. This field is a pointer to an object of type struct dev_pm_domain,
Rafael J. Wysocki7538e3d2011-02-16 21:53:17 +0100531defined in include/linux/pm.h, providing a set of power management callbacks
532analogous to the subsystem-level and device driver callbacks that are executed
Rafael J. Wysockica9c6892011-06-21 23:25:32 +0200533for the given device during all power transitions, instead of the respective
534subsystem-level callbacks. Specifically, if a device's pm_domain pointer is
535not NULL, the ->suspend() callback from the object pointed to by it will be
536executed instead of its subsystem's (e.g. bus type's) ->suspend() callback and
537anlogously for all of the remaining callbacks. In other words, power management
538domain callbacks, if defined for the given device, always take precedence over
539the callbacks provided by the device's subsystem (e.g. bus type).
Rafael J. Wysocki7538e3d2011-02-16 21:53:17 +0100540
Rafael J. Wysockica9c6892011-06-21 23:25:32 +0200541The support for device power management domains is only relevant to platforms
542needing to use the same device driver power management callbacks in many
543different power domain configurations and wanting to avoid incorporating the
544support for power domains into subsystem-level callbacks, for example by
545modifying the platform bus type. Other platforms need not implement it or take
546it into account in any way.
Rafael J. Wysocki7538e3d2011-02-16 21:53:17 +0100547
548
David Brownell4fc08402006-08-10 16:38:28 -0700549Device Low Power (suspend) States
550---------------------------------
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100551Device low-power states aren't standard. One device might only handle
David Brownell4fc08402006-08-10 16:38:28 -0700552"on" and "off, while another might support a dozen different versions of
553"on" (how many engines are active?), plus a state that gets back to "on"
554faster than from a full "off".
555
556Some busses define rules about what different suspend states mean. PCI
557gives one example: after the suspend sequence completes, a non-legacy
558PCI device may not perform DMA or issue IRQs, and any wakeup events it
559issues would be issued through the PME# bus signal. Plus, there are
560several PCI-standard device states, some of which are optional.
561
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100562In contrast, integrated system-on-chip processors often use IRQs as the
David Brownell4fc08402006-08-10 16:38:28 -0700563wakeup event sources (so drivers would call enable_irq_wake) and might
564be able to treat DMA completion as a wakeup event (sometimes DMA can stay
565active too, it'd only be the CPU and some peripherals that sleep).
566
567Some details here may be platform-specific. Systems may have devices that
568can be fully active in certain sleep states, such as an LCD display that's
569refreshed using DMA while most of the system is sleeping lightly ... and
570its frame buffer might even be updated by a DSP or other non-Linux CPU while
571the Linux control processor stays idle.
572
573Moreover, the specific actions taken may depend on the target system state.
574One target system state might allow a given device to be very operational;
575another might require a hard shut down with re-initialization on resume.
576And two different target systems might use the same device in different
577ways; the aforementioned LCD might be active in one product's "standby",
578but a different product using the same SOC might work differently.
579
580
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100581Power Management Notifiers
582--------------------------
Alan Sternd6f9cda2010-03-26 23:53:55 +0100583There are some operations that cannot be carried out by the power management
584callbacks discussed above, because the callbacks occur too late or too early.
585To handle these cases, subsystems and device drivers may register power
586management notifiers that are called before tasks are frozen and after they have
587been thawed. Generally speaking, the PM notifiers are suitable for performing
588actions that either require user space to be available, or at least won't
589interfere with user space.
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100590
591For details refer to Documentation/power/notifiers.txt.
592
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594Runtime Power Management
David Brownell4fc08402006-08-10 16:38:28 -0700595========================
596Many devices are able to dynamically power down while the system is still
597running. This feature is useful for devices that are not being used, and
598can offer significant power savings on a running system. These devices
599often support a range of runtime power states, which might use names such
600as "off", "sleep", "idle", "active", and so on. Those states will in some
Alan Sternd6f9cda2010-03-26 23:53:55 +0100601cases (like PCI) be partially constrained by the bus the device uses, and will
David Brownell4fc08402006-08-10 16:38:28 -0700602usually include hardware states that are also used in system sleep states.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Alan Sternd6f9cda2010-03-26 23:53:55 +0100604A system-wide power transition can be started while some devices are in low
605power states due to runtime power management. The system sleep PM callbacks
606should recognize such situations and react to them appropriately, but the
607necessary actions are subsystem-specific.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Alan Sternd6f9cda2010-03-26 23:53:55 +0100609In some cases the decision may be made at the subsystem level while in other
610cases the device driver may be left to decide. In some cases it may be
611desirable to leave a suspended device in that state during a system-wide power
612transition, but in other cases the device must be put back into the full-power
613state temporarily, for example so that its system wakeup capability can be
614disabled. This all depends on the hardware and the design of the subsystem and
615device driver in question.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
Rafael J. Wysocki455716e2011-07-01 22:29:05 +0200617During system-wide resume from a sleep state it's easiest to put devices into
618the full-power state, as explained in Documentation/power/runtime_pm.txt. Refer
619to that document for more information regarding this particular issue as well as
Rafael J. Wysocki624f6ec2010-03-26 23:53:42 +0100620for information on the device runtime power management framework in general.