PM / Runtime: Make documentation follow the new behavior of irq_safe
[deliverable/linux.git] / Documentation / power / devices.txt
CommitLineData
624f6ec8
RW
1Device Power Management
2
7538e3db 3Copyright (c) 2010-2011 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
d6f9cda1
AS
4Copyright (c) 2010 Alan Stern <stern@rowland.harvard.edu>
5
624f6ec8 6
4fc08400 7Most of the code in Linux is device drivers, so most of the Linux power
d6f9cda1
AS
8management (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.
4fc08400
DB
11
12This 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.
16
17
18Two 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:
d6f9cda1
AS
24 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").
4fc08400
DB
28
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
d6f9cda1 35 leave the low-power state. This feature may be enabled or disabled
624f6ec8
RW
36 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
d6f9cda1 39 system enter low-power states more often.
4fc08400
DB
40
41 Runtime Power Management model:
d6f9cda1 42 Devices may also be put into low-power states while the system is
624f6ec8
RW
43 running, independently of other power management activity in principle.
44 However, devices are not generally independent of each other (for
d6f9cda1
AS
45 example, a parent device cannot be suspended unless all of its child
46 devices have been suspended). Moreover, depending on the bus type the
624f6ec8 47 device is on, it may be necessary to carry out some bus-specific
d6f9cda1
AS
48 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).
624f6ec8
RW
51
52 For these reasons not only the device driver itself, but also the
d6f9cda1
AS
53 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.
58
59There'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.
65
66Most 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.
4fc08400
DB
70
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).
74
75
76Interfaces for Entering System Sleep States
77===========================================
d6f9cda1
AS
78There 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.
624f6ec8
RW
82
83
84Device 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:
89
90struct 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);
108};
4fc08400 109
624f6ec8
RW
110This 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.
d6f9cda1
AS
112For 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
624f6ec8 114system-wide power transitions.
4fc08400 115
d6f9cda1
AS
116There 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.
624f6ec8
RW
121
122
123Subsystem-Level Methods
124-----------------------
125The core methods to suspend and resume devices reside in struct dev_pm_ops
5841eb64
RW
126pointed 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.
1da177e4 130
d6f9cda1
AS
131Bus 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.
4fc08400
DB
135
136For more information on these driver calls, see the description later;
137they are called in phases for every device, respecting the parent-child
624f6ec8 138sequencing in the driver model tree.
4fc08400
DB
139
140
141/sys/devices/.../power/wakeup files
142-----------------------------------
d6f9cda1
AS
143All 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.
4fc08400
DB
148
149The "can_wakeup" flag just records whether the device (and its driver) can
d6f9cda1
AS
150physically 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
8f88893c
AS
156(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).
d6f9cda1
AS
159
160Whether 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
cb8f51bd
RW
165set 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.
d6f9cda1
AS
169
170The device_may_wakeup() routine returns true only if both flags are set.
cb8f51bd
RW
171This 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.
624f6ec8
RW
177
178
179/sys/devices/.../power/control files
180------------------------------------
d6f9cda1
AS
181Each 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.
185
186The 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.
624f6ec8
RW
193
194The device's runtime_auto flag has no effect on the handling of system-wide
d6f9cda1
AS
195power 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.
624f6ec8 198
d6f9cda1
AS
199For more information about the runtime power management framework, refer to
200Documentation/power/runtime_pm.txt.
4fc08400
DB
201
202
d6f9cda1
AS
203Calling 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
4fc08400
DB
207system 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
d6f9cda1
AS
211When 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.
4fc08400 214
d6f9cda1
AS
215For simple drivers, suspend might quiesce the device using class code
216and then turn its hardware as "off" as possible during suspend_noirq. The
4fc08400
DB
217matching resume calls would then completely reinitialize the hardware
218before reactivating its class I/O queues.
219
624f6ec8
RW
220More power-aware drivers might prepare the devices for triggering system wakeup
221events.
4fc08400
DB
222
223
224Call Sequence Guarantees
225------------------------
624f6ec8 226To ensure that bridges and similar links needing to talk to a device are
4fc08400
DB
227available 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.)
58aca232 237In particular, this means that a device registration may fail if the parent of
624f6ec8 238the device is suspending (i.e. has been chosen by the PM core as the next
58aca232
RW
239device 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.
4fc08400
DB
242
243
d6f9cda1
AS
244System 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
fa8ce723 253been disabled (except for those marked with the IRQF_NO_SUSPEND flag).
624f6ec8 254
5841eb64
RW
255All 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.
4fc08400 278
d6f9cda1
AS
279These callbacks may in turn invoke device- or driver-specific methods stored in
280dev->driver->pm, but they don't have to.
4fc08400 281
4fc08400 282
d6f9cda1
AS
283Entering System Suspend
284-----------------------
285When the system goes into the standby or memory sleep state, the phases are:
286
287 prepare, suspend, suspend_noirq.
288
289 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.
295
91e7c75b
RW
296 After the prepare callback method returns, no new children may be
297 registered below the device. The method may also prepare the device or
fa8ce723
RW
298 driver in some way for the upcoming system power transition, but it
299 should not put the device into a low-power state.
d6f9cda1
AS
300
301 2. The suspend methods should quiesce the device to stop it from performing
302 I/O. They also may save the device registers and put it into the
303 appropriate low-power state, depending on the bus type the device is on,
304 and they may enable wakeup events.
305
306 3. The suspend_noirq phase occurs after IRQ handlers have been disabled,
307 which means that the driver's interrupt handler will not be called while
308 the callback method is running. The methods should save the values of
309 the device's registers that weren't saved previously and finally put the
310 device into the appropriate low-power state.
624f6ec8
RW
311
312 The majority of subsystems and device drivers need not implement this
d6f9cda1
AS
313 callback. However, bus types allowing devices to share interrupt
314 vectors, like PCI, generally need it; otherwise a driver might encounter
315 an error during the suspend phase by fielding a shared interrupt
316 generated by some other device after its own device had been set to low
317 power.
318
319At the end of these phases, drivers should have stopped all I/O transactions
320(DMA, IRQs), saved enough state that they can re-initialize or restore previous
321state (as needed by the hardware), and placed the device into a low-power state.
322On many platforms they will gate off one or more clock sources; sometimes they
323will also switch off power supplies or reduce voltages. (Drivers supporting
324runtime PM may already have performed some or all of these steps.)
624f6ec8
RW
325
326If device_may_wakeup(dev) returns true, the device should be prepared for
d6f9cda1
AS
327generating hardware wakeup signals to trigger a system wakeup event when the
328system is in the sleep state. For example, enable_irq_wake() might identify
624f6ec8
RW
329GPIO signals hooked up to a switch or other external hardware, and
330pci_enable_wake() does something similar for the PCI PME signal.
331
d6f9cda1
AS
332If any of these callbacks returns an error, the system won't enter the desired
333low-power state. Instead the PM core will unwind its actions by resuming all
334the devices that were suspended.
4fc08400
DB
335
336
d6f9cda1
AS
337Leaving System Suspend
338----------------------
339When resuming from standby or memory sleep, the phases are:
4fc08400 340
d6f9cda1 341 resume_noirq, resume, complete.
4fc08400 342
d6f9cda1
AS
343 1. The resume_noirq callback methods should perform any actions needed
344 before the driver's interrupt handlers are invoked. This generally
345 means undoing the actions of the suspend_noirq phase. If the bus type
346 permits devices to share interrupt vectors, like PCI, the method should
347 bring the device and its driver into a state in which the driver can
348 recognize if the device is the source of incoming interrupts, if any,
349 and handle them correctly.
4fc08400 350
624f6ec8 351 For example, the PCI bus type's ->pm.resume_noirq() puts the device into
d6f9cda1
AS
352 the full-power state (D0 in the PCI terminology) and restores the
353 standard configuration registers of the device. Then it calls the
624f6ec8 354 device driver's ->pm.resume_noirq() method to perform device-specific
d6f9cda1 355 actions.
4fc08400 356
d6f9cda1
AS
357 2. The resume methods should bring the the device back to its operating
358 state, so that it can perform normal I/O. This generally involves
359 undoing the actions of the suspend phase.
4fc08400 360
d6f9cda1
AS
361 3. The complete phase uses only a bus callback. The method should undo the
362 actions of the prepare phase. Note, however, that new children may be
363 registered below the device as soon as the resume callbacks occur; it's
364 not necessary to wait until the complete phase.
4fc08400 365
d6f9cda1
AS
366At the end of these phases, drivers should be as functional as they were before
367suspending: I/O can be performed using DMA and IRQs, and the relevant clocks are
368gated on. Even if the device was in a low-power state before the system sleep
369because of runtime power management, afterwards it should be back in its
370full-power state. There are multiple reasons why it's best to do this; they are
371discussed in more detail in Documentation/power/runtime_pm.txt.
4fc08400
DB
372
373However, the details here may again be platform-specific. For example,
374some systems support multiple "run" states, and the mode in effect at
624f6ec8 375the end of resume might not be the one which preceded suspension.
4fc08400
DB
376That means availability of certain clocks or power supplies changed,
377which could easily affect how a driver works.
378
4fc08400
DB
379Drivers need to be able to handle hardware which has been reset since the
380suspend methods were called, for example by complete reinitialization.
381This may be the hardest part, and the one most protected by NDA'd documents
382and chip errata. It's simplest if the hardware state hasn't changed since
25985edc 383the suspend was carried out, but that can't be guaranteed (in fact, it usually
624f6ec8 384is not the case).
4fc08400
DB
385
386Drivers must also be prepared to notice that the device has been removed
d6f9cda1 387while the system was powered down, whenever that's physically possible.
4fc08400
DB
388PCMCIA, MMC, USB, Firewire, SCSI, and even IDE are common examples of busses
389where common Linux platforms will see such removal. Details of how drivers
390will notice and handle such removals are currently bus-specific, and often
391involve a separate thread.
1da177e4 392
d6f9cda1
AS
393These callbacks may return an error value, but the PM core will ignore such
394errors since there's nothing it can do about them other than printing them in
395the system log.
1da177e4 396
d6f9cda1
AS
397
398Entering Hibernation
399--------------------
400Hibernating the system is more complicated than putting it into the standby or
401memory sleep state, because it involves creating and saving a system image.
402Therefore there are more phases for hibernation, with a different set of
403callbacks. These phases always run after tasks have been frozen and memory has
404been freed.
405
406The general procedure for hibernation is to quiesce all devices (freeze), create
407an image of the system memory while everything is stable, reactivate all
408devices (thaw), write the image to permanent storage, and finally shut down the
409system (poweroff). The phases used to accomplish this are:
410
411 prepare, freeze, freeze_noirq, thaw_noirq, thaw, complete,
412 prepare, poweroff, poweroff_noirq
413
414 1. The prepare phase is discussed in the "Entering System Suspend" section
415 above.
416
417 2. The freeze methods should quiesce the device so that it doesn't generate
418 IRQs or DMA, and they may need to save the values of device registers.
419 However the device does not have to be put in a low-power state, and to
420 save time it's best not to do so. Also, the device should not be
421 prepared to generate wakeup events.
422
423 3. The freeze_noirq phase is analogous to the suspend_noirq phase discussed
424 above, except again that the device should not be put in a low-power
425 state and should not be allowed to generate wakeup events.
426
427At this point the system image is created. All devices should be inactive and
428the contents of memory should remain undisturbed while this happens, so that the
429image forms an atomic snapshot of the system state.
430
431 4. The thaw_noirq phase is analogous to the resume_noirq phase discussed
432 above. The main difference is that its methods can assume the device is
433 in the same state as at the end of the freeze_noirq phase.
434
435 5. The thaw phase is analogous to the resume phase discussed above. Its
436 methods should bring the device back to an operating state, so that it
437 can be used for saving the image if necessary.
438
439 6. The complete phase is discussed in the "Leaving System Suspend" section
440 above.
441
442At this point the system image is saved, and the devices then need to be
443prepared for the upcoming system shutdown. This is much like suspending them
444before putting the system into the standby or memory sleep state, and the phases
445are similar.
446
447 7. The prepare phase is discussed above.
448
449 8. The poweroff phase is analogous to the suspend phase.
450
451 9. The poweroff_noirq phase is analogous to the suspend_noirq phase.
452
453The poweroff and poweroff_noirq callbacks should do essentially the same things
454as the suspend and suspend_noirq callbacks. The only notable difference is that
455they need not store the device register values, because the registers should
456already have been stored during the freeze or freeze_noirq phases.
457
458
459Leaving Hibernation
460-------------------
624f6ec8
RW
461Resuming from hibernation is, again, more complicated than resuming from a sleep
462state in which the contents of main memory are preserved, because it requires
463a system image to be loaded into memory and the pre-hibernation memory contents
464to be restored before control can be passed back to the image kernel.
465
d6f9cda1
AS
466Although in principle, the image might be loaded into memory and the
467pre-hibernation memory contents restored by the boot loader, in practice this
468can't be done because boot loaders aren't smart enough and there is no
469established protocol for passing the necessary information. So instead, the
470boot loader loads a fresh instance of the kernel, called the boot kernel, into
471memory and passes control to it in the usual way. Then the boot kernel reads
472the system image, restores the pre-hibernation memory contents, and passes
473control to the image kernel. Thus two different kernels are involved in
474resuming from hibernation. In fact, the boot kernel may be completely different
475from the image kernel: a different configuration and even a different version.
476This has important consequences for device drivers and their subsystems.
477
478To be able to load the system image into memory, the boot kernel needs to
479include at least a subset of device drivers allowing it to access the storage
480medium containing the image, although it doesn't need to include all of the
481drivers present in the image kernel. After the image has been loaded, the
482devices managed by the boot kernel need to be prepared for passing control back
483to the image kernel. This is very similar to the initial steps involved in
484creating a system image, and it is accomplished in the same way, using prepare,
485freeze, and freeze_noirq phases. However the devices affected by these phases
486are only those having drivers in the boot kernel; other devices will still be in
487whatever state the boot loader left them.
624f6ec8
RW
488
489Should the restoration of the pre-hibernation memory contents fail, the boot
d6f9cda1
AS
490kernel would go through the "thawing" procedure described above, using the
491thaw_noirq, thaw, and complete phases, and then continue running normally. This
492happens only rarely. Most often the pre-hibernation memory contents are
493restored successfully and control is passed to the image kernel, which then
494becomes responsible for bringing the system back to the working state.
624f6ec8 495
d6f9cda1
AS
496To achieve this, the image kernel must restore the devices' pre-hibernation
497functionality. The operation is much like waking up from the memory sleep
498state, although it involves different phases:
624f6ec8 499
d6f9cda1 500 restore_noirq, restore, complete
624f6ec8 501
d6f9cda1 502 1. The restore_noirq phase is analogous to the resume_noirq phase.
624f6ec8 503
d6f9cda1 504 2. The restore phase is analogous to the resume phase.
624f6ec8 505
d6f9cda1 506 3. The complete phase is discussed above.
624f6ec8 507
d6f9cda1
AS
508The main difference from resume[_noirq] is that restore[_noirq] must assume the
509device has been accessed and reconfigured by the boot loader or the boot kernel.
510Consequently the state of the device may be different from the state remembered
511from the freeze and freeze_noirq phases. The device may even need to be reset
512and completely re-initialized. In many cases this difference doesn't matter, so
513the resume[_noirq] and restore[_norq] method pointers can be set to the same
514routines. Nevertheless, different callback pointers are used in case there is a
515situation where it actually matters.
1da177e4 516
1da177e4 517
564b905a
RW
518Device Power Management Domains
519-------------------------------
7538e3db
RW
520Sometimes devices share reference clocks or other power resources. In those
521cases it generally is not possible to put devices into low-power states
522individually. Instead, a set of devices sharing a power resource can be put
523into a low-power state together at the same time by turning off the shared
524power resource. Of course, they also need to be put into the full-power state
525together, by turning the shared power resource on. A set of devices with this
526property is often referred to as a power domain.
527
564b905a
RW
528Support for power domains is provided through the pm_domain field of struct
529device. This field is a pointer to an object of type struct dev_pm_domain,
7538e3db
RW
530defined in include/linux/pm.h, providing a set of power management callbacks
531analogous to the subsystem-level and device driver callbacks that are executed
ca9c6890
RW
532for the given device during all power transitions, instead of the respective
533subsystem-level callbacks. Specifically, if a device's pm_domain pointer is
534not NULL, the ->suspend() callback from the object pointed to by it will be
535executed instead of its subsystem's (e.g. bus type's) ->suspend() callback and
536anlogously for all of the remaining callbacks. In other words, power management
537domain callbacks, if defined for the given device, always take precedence over
538the callbacks provided by the device's subsystem (e.g. bus type).
539
540The support for device power management domains is only relevant to platforms
541needing to use the same device driver power management callbacks in many
542different power domain configurations and wanting to avoid incorporating the
543support for power domains into subsystem-level callbacks, for example by
544modifying the platform bus type. Other platforms need not implement it or take
545it into account in any way.
7538e3db
RW
546
547
d6f9cda1
AS
548Device Low Power (suspend) States
549---------------------------------
550Device low-power states aren't standard. One device might only handle
551"on" and "off, while another might support a dozen different versions of
552"on" (how many engines are active?), plus a state that gets back to "on"
553faster than from a full "off".
554
555Some busses define rules about what different suspend states mean. PCI
556gives one example: after the suspend sequence completes, a non-legacy
557PCI device may not perform DMA or issue IRQs, and any wakeup events it
558issues would be issued through the PME# bus signal. Plus, there are
559several PCI-standard device states, some of which are optional.
560
561In contrast, integrated system-on-chip processors often use IRQs as the
562wakeup event sources (so drivers would call enable_irq_wake) and might
563be able to treat DMA completion as a wakeup event (sometimes DMA can stay
564active too, it'd only be the CPU and some peripherals that sleep).
565
566Some details here may be platform-specific. Systems may have devices that
567can be fully active in certain sleep states, such as an LCD display that's
568refreshed using DMA while most of the system is sleeping lightly ... and
569its frame buffer might even be updated by a DSP or other non-Linux CPU while
570the Linux control processor stays idle.
571
572Moreover, the specific actions taken may depend on the target system state.
573One target system state might allow a given device to be very operational;
574another might require a hard shut down with re-initialization on resume.
575And two different target systems might use the same device in different
576ways; the aforementioned LCD might be active in one product's "standby",
577but a different product using the same SOC might work differently.
578
579
624f6ec8
RW
580Power Management Notifiers
581--------------------------
d6f9cda1
AS
582There are some operations that cannot be carried out by the power management
583callbacks discussed above, because the callbacks occur too late or too early.
584To handle these cases, subsystems and device drivers may register power
585management notifiers that are called before tasks are frozen and after they have
586been thawed. Generally speaking, the PM notifiers are suitable for performing
587actions that either require user space to be available, or at least won't
588interfere with user space.
624f6ec8
RW
589
590For details refer to Documentation/power/notifiers.txt.
591
592
4fc08400
DB
593Runtime Power Management
594========================
595Many devices are able to dynamically power down while the system is still
596running. This feature is useful for devices that are not being used, and
597can offer significant power savings on a running system. These devices
598often support a range of runtime power states, which might use names such
599as "off", "sleep", "idle", "active", and so on. Those states will in some
d6f9cda1 600cases (like PCI) be partially constrained by the bus the device uses, and will
4fc08400
DB
601usually include hardware states that are also used in system sleep states.
602
d6f9cda1
AS
603A system-wide power transition can be started while some devices are in low
604power states due to runtime power management. The system sleep PM callbacks
605should recognize such situations and react to them appropriately, but the
606necessary actions are subsystem-specific.
607
608In some cases the decision may be made at the subsystem level while in other
609cases the device driver may be left to decide. In some cases it may be
610desirable to leave a suspended device in that state during a system-wide power
611transition, but in other cases the device must be put back into the full-power
612state temporarily, for example so that its system wakeup capability can be
613disabled. This all depends on the hardware and the design of the subsystem and
614device driver in question.
615
455716e9
RW
616During system-wide resume from a sleep state it's easiest to put devices into
617the full-power state, as explained in Documentation/power/runtime_pm.txt. Refer
618to that document for more information regarding this particular issue as well as
624f6ec8 619for information on the device runtime power management framework in general.
This page took 1.005644 seconds and 5 git commands to generate.