PM / Sleep: Correct inaccurate information in devices.txt
[platform/adaptation/renesas_rcar/renesas_kernel.git] / Documentation / power / devices.txt
1 Device Power Management
2
3 Copyright (c) 2010-2011 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
4 Copyright (c) 2010 Alan Stern <stern@rowland.harvard.edu>
5
6
7 Most of the code in Linux is device drivers, so most of the Linux power
8 management (PM) code is also driver-specific.  Most drivers will do very
9 little; others, especially for platforms with small batteries (like cell
10 phones), will do a lot.
11
12 This writeup gives an overview of how drivers interact with system-wide
13 power management goals, emphasizing the models and interfaces that are
14 shared by everything that hooks up to the driver model core.  Read it as
15 background for the domain-specific work you'd do with any specific driver.
16
17
18 Two Models for Device Power Management
19 ======================================
20 Drivers will use one or both of these models to put devices into low-power
21 states:
22
23     System Sleep model:
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").
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
35         leave the low-power state.  This feature may be enabled or disabled
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
39         system enter low-power states more often.
40
41     Runtime Power Management model:
42         Devices may also be put into low-power states while the system is
43         running, independently of other power management activity in principle.
44         However, devices are not generally independent of each other (for
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
47         device is on, it may be necessary to carry out some bus-specific
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).
51
52         For these reasons not only the device driver itself, but also the
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
59 There's not a lot to be said about those low-power states except that they are
60 very system-specific, and often device-specific.  Also, that if enough devices
61 have been put into low-power states (at runtime), the effect may be very similar
62 to entering some system-wide low-power state (system sleep) ... and that
63 synergies exist, so that several drivers using runtime PM might put the system
64 into a state where even deeper power saving options are available.
65
66 Most suspended devices will have quiesced all I/O: no more DMA or IRQs (except
67 for wakeup events), no more data read or written, and requests from upstream
68 drivers are no longer accepted.  A given bus or platform may have different
69 requirements though.
70
71 Examples of hardware wakeup events include an alarm from a real time clock,
72 network wake-on-LAN packets, keyboard or mouse activity, and media insertion
73 or removal (for PCMCIA, MMC/SD, USB, and so on).
74
75
76 Interfaces for Entering System Sleep States
77 ===========================================
78 There are programming interfaces provided for subsystems (bus type, device type,
79 device class) and device drivers to allow them to participate in the power
80 management of devices they are concerned with.  These interfaces cover both
81 system sleep and runtime power management.
82
83
84 Device Power Management Operations
85 ----------------------------------
86 Device power management operations, at the subsystem level as well as at the
87 device driver level, are implemented by defining and populating objects of type
88 struct dev_pm_ops:
89
90 struct 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 };
109
110 This structure is defined in include/linux/pm.h and the methods included in it
111 are also described in that file.  Their roles will be explained in what follows.
112 For now, it should be sufficient to remember that the last three methods are
113 specific to runtime power management while the remaining ones are used during
114 system-wide power transitions.
115
116 There also is a deprecated "old" or "legacy" interface for power management
117 operations available at least for some subsystems.  This approach does not use
118 struct dev_pm_ops objects and it is suitable only for implementing system sleep
119 power management methods.  Therefore it is not described in this document, so
120 please refer directly to the source code for more information about it.
121
122
123 Subsystem-Level Methods
124 -----------------------
125 The core methods to suspend and resume devices reside in struct dev_pm_ops
126 pointed to by the ops member of struct dev_pm_domain, or by the pm member of
127 struct bus_type, struct device_type and struct class.  They are mostly of
128 interest to the people writing infrastructure for platforms and buses, like PCI
129 or USB, or device type and device class drivers.
130
131 Bus drivers implement these methods as appropriate for the hardware and the
132 drivers using it; PCI works differently from USB, and so on.  Not many people
133 write subsystem-level drivers; most driver code is a "device driver" that builds
134 on top of bus-specific framework code.
135
136 For more information on these driver calls, see the description later;
137 they are called in phases for every device, respecting the parent-child
138 sequencing in the driver model tree.
139
140
141 /sys/devices/.../power/wakeup files
142 -----------------------------------
143 All devices in the driver model have two flags to control handling of wakeup
144 events (hardware signals that can force the device and/or system out of a low
145 power state).  These flags are initialized by bus or device driver code using
146 device_set_wakeup_capable() and device_set_wakeup_enable(), defined in
147 include/linux/pm_wakeup.h.
148
149 The "can_wakeup" flag just records whether the device (and its driver) can
150 physically support wakeup events.  The device_set_wakeup_capable() routine
151 affects this flag.  The "should_wakeup" flag controls whether the device should
152 try to use its wakeup mechanism.  device_set_wakeup_enable() affects this flag;
153 for the most part drivers should not change its value.  The initial value of
154 should_wakeup is supposed to be false for the majority of devices; the major
155 exceptions are power buttons, keyboards, and Ethernet adapters whose WoL
156 (wake-on-LAN) feature has been set up with ethtool.  It should also default
157 to true for devices that don't generate wakeup requests on their own but merely
158 forward wakeup requests from one bus to another (like PCI bridges).
159
160 Whether or not a device is capable of issuing wakeup events is a hardware
161 matter, and the kernel is responsible for keeping track of it.  By contrast,
162 whether or not a wakeup-capable device should issue wakeup events is a policy
163 decision, and it is managed by user space through a sysfs attribute: the
164 power/wakeup file.  User space can write the strings "enabled" or "disabled" to
165 set or clear the "should_wakeup" flag, respectively.  This file is only present
166 for wakeup-capable devices (i.e. devices whose "can_wakeup" flags are set)
167 and is created (or removed) by device_set_wakeup_capable().  Reads from the
168 file will return the corresponding string.
169
170 The device_may_wakeup() routine returns true only if both flags are set.
171 This information is used by subsystems, like the PCI bus type code, to see
172 whether or not to enable the devices' wakeup mechanisms.  If device wakeup
173 mechanisms are enabled or disabled directly by drivers, they also should use
174 device_may_wakeup() to decide what to do during a system sleep transition.
175 However for runtime power management, wakeup events should be enabled whenever
176 the device and driver both support them, regardless of the should_wakeup flag.
177
178
179 /sys/devices/.../power/control files
180 ------------------------------------
181 Each device in the driver model has a flag to control whether it is subject to
182 runtime power management.  This flag, called runtime_auto, is initialized by the
183 bus type (or generally subsystem) code using pm_runtime_allow() or
184 pm_runtime_forbid(); the default is to allow runtime power management.
185
186 The setting can be adjusted by user space by writing either "on" or "auto" to
187 the device's power/control sysfs file.  Writing "auto" calls pm_runtime_allow(),
188 setting the flag and allowing the device to be runtime power-managed by its
189 driver.  Writing "on" calls pm_runtime_forbid(), clearing the flag, returning
190 the device to full power if it was in a low-power state, and preventing the
191 device from being runtime power-managed.  User space can check the current value
192 of the runtime_auto flag by reading the file.
193
194 The device's runtime_auto flag has no effect on the handling of system-wide
195 power transitions.  In particular, the device can (and in the majority of cases
196 should and will) be put into a low-power state during a system-wide transition
197 to a sleep state even though its runtime_auto flag is clear.
198
199 For more information about the runtime power management framework, refer to
200 Documentation/power/runtime_pm.txt.
201
202
203 Calling Drivers to Enter and Leave System Sleep States
204 ======================================================
205 When the system goes into a sleep state, each device's driver is asked to
206 suspend the device by putting it into a state compatible with the target
207 system state.  That's usually some version of "off", but the details are
208 system-specific.  Also, wakeup-enabled devices will usually stay partly
209 functional in order to wake the system.
210
211 When the system leaves that low-power state, the device's driver is asked to
212 resume it by returning it to full power.  The suspend and resume operations
213 always go together, and both are multi-phase operations.
214
215 For simple drivers, suspend might quiesce the device using class code
216 and then turn its hardware as "off" as possible during suspend_noirq.  The
217 matching resume calls would then completely reinitialize the hardware
218 before reactivating its class I/O queues.
219
220 More power-aware drivers might prepare the devices for triggering system wakeup
221 events.
222
223
224 Call Sequence Guarantees
225 ------------------------
226 To ensure that bridges and similar links needing to talk to a device are
227 available when the device is suspended or resumed, the device tree is
228 walked in a bottom-up order to suspend devices.  A top-down order is
229 used to resume those devices.
230
231 The ordering of the device tree is defined by the order in which devices
232 get registered:  a child can never be registered, probed or resumed before
233 its parent; and can't be removed or suspended after that parent.
234
235 The policy is that the device tree should match hardware bus topology.
236 (Or at least the control bus, for devices which use multiple busses.)
237 In particular, this means that a device registration may fail if the parent of
238 the device is suspending (i.e. has been chosen by the PM core as the next
239 device to suspend) or has already suspended, as well as after all of the other
240 devices have been suspended.  Device drivers must be prepared to cope with such
241 situations.
242
243
244 System Power Management Phases
245 ------------------------------
246 Suspending or resuming the system is done in several phases.  Different phases
247 are used for standby or memory sleep states ("suspend-to-RAM") and the
248 hibernation state ("suspend-to-disk").  Each phase involves executing callbacks
249 for every device before the next phase begins.  Not all busses or classes
250 support all these callbacks and not all drivers use all the callbacks.  The
251 various phases always run after tasks have been frozen and before they are
252 unfrozen.  Furthermore, the *_noirq phases run at a time when IRQ handlers have
253 been disabled (except for those marked with the IRQF_NO_SUSPEND flag).
254
255 All phases use PM domain, bus, type, or class callbacks (that is, methods
256 defined in dev->pm_domain->ops, dev->bus->pm, dev->type->pm, or dev->class->pm).
257 These callbacks are regarded by the PM core as mutually exclusive.  Moreover,
258 PM domain callbacks always take precedence over bus, type and class callbacks,
259 while type callbacks take precedence over bus and class callbacks, and class
260 callbacks take precedence over bus callbacks.  To be precise, the following
261 rules 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
276 This allows PM domains and device types to override callbacks provided by bus
277 types or device classes if necessary.
278
279 These callbacks may in turn invoke device- or driver-specific methods stored in
280 dev->driver->pm, but they don't have to.
281
282
283 Entering System Suspend
284 -----------------------
285 When 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
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
298         driver in some way for the upcoming system power transition, but it
299         should not put the device into a low-power state.
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.
311
312         The majority of subsystems and device drivers need not implement this
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
319 At 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
321 state (as needed by the hardware), and placed the device into a low-power state.
322 On many platforms they will gate off one or more clock sources; sometimes they
323 will also switch off power supplies or reduce voltages.  (Drivers supporting
324 runtime PM may already have performed some or all of these steps.)
325
326 If device_may_wakeup(dev) returns true, the device should be prepared for
327 generating hardware wakeup signals to trigger a system wakeup event when the
328 system is in the sleep state.  For example, enable_irq_wake() might identify
329 GPIO signals hooked up to a switch or other external hardware, and
330 pci_enable_wake() does something similar for the PCI PME signal.
331
332 If any of these callbacks returns an error, the system won't enter the desired
333 low-power state.  Instead the PM core will unwind its actions by resuming all
334 the devices that were suspended.
335
336
337 Leaving System Suspend
338 ----------------------
339 When resuming from standby or memory sleep, the phases are:
340
341                 resume_noirq, resume, complete.
342
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.
350
351         For example, the PCI bus type's ->pm.resume_noirq() puts the device into
352         the full-power state (D0 in the PCI terminology) and restores the
353         standard configuration registers of the device.  Then it calls the
354         device driver's ->pm.resume_noirq() method to perform device-specific
355         actions.
356
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.
360
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.
365
366 At the end of these phases, drivers should be as functional as they were before
367 suspending: I/O can be performed using DMA and IRQs, and the relevant clocks are
368 gated on.  Even if the device was in a low-power state before the system sleep
369 because of runtime power management, afterwards it should be back in its
370 full-power state.  There are multiple reasons why it's best to do this; they are
371 discussed in more detail in Documentation/power/runtime_pm.txt.
372
373 However, the details here may again be platform-specific.  For example,
374 some systems support multiple "run" states, and the mode in effect at
375 the end of resume might not be the one which preceded suspension.
376 That means availability of certain clocks or power supplies changed,
377 which could easily affect how a driver works.
378
379 Drivers need to be able to handle hardware which has been reset since the
380 suspend methods were called, for example by complete reinitialization.
381 This may be the hardest part, and the one most protected by NDA'd documents
382 and chip errata.  It's simplest if the hardware state hasn't changed since
383 the suspend was carried out, but that can't be guaranteed (in fact, it usually
384 is not the case).
385
386 Drivers must also be prepared to notice that the device has been removed
387 while the system was powered down, whenever that's physically possible.
388 PCMCIA, MMC, USB, Firewire, SCSI, and even IDE are common examples of busses
389 where common Linux platforms will see such removal.  Details of how drivers
390 will notice and handle such removals are currently bus-specific, and often
391 involve a separate thread.
392
393 These callbacks may return an error value, but the PM core will ignore such
394 errors since there's nothing it can do about them other than printing them in
395 the system log.
396
397
398 Entering Hibernation
399 --------------------
400 Hibernating the system is more complicated than putting it into the standby or
401 memory sleep state, because it involves creating and saving a system image.
402 Therefore there are more phases for hibernation, with a different set of
403 callbacks.  These phases always run after tasks have been frozen and memory has
404 been freed.
405
406 The general procedure for hibernation is to quiesce all devices (freeze), create
407 an image of the system memory while everything is stable, reactivate all
408 devices (thaw), write the image to permanent storage, and finally shut down the
409 system (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
427 At this point the system image is created.  All devices should be inactive and
428 the contents of memory should remain undisturbed while this happens, so that the
429 image 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
442 At this point the system image is saved, and the devices then need to be
443 prepared for the upcoming system shutdown.  This is much like suspending them
444 before putting the system into the standby or memory sleep state, and the phases
445 are 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
453 The poweroff and poweroff_noirq callbacks should do essentially the same things
454 as the suspend and suspend_noirq callbacks.  The only notable difference is that
455 they need not store the device register values, because the registers should
456 already have been stored during the freeze or freeze_noirq phases.
457
458
459 Leaving Hibernation
460 -------------------
461 Resuming from hibernation is, again, more complicated than resuming from a sleep
462 state in which the contents of main memory are preserved, because it requires
463 a system image to be loaded into memory and the pre-hibernation memory contents
464 to be restored before control can be passed back to the image kernel.
465
466 Although in principle, the image might be loaded into memory and the
467 pre-hibernation memory contents restored by the boot loader, in practice this
468 can't be done because boot loaders aren't smart enough and there is no
469 established protocol for passing the necessary information.  So instead, the
470 boot loader loads a fresh instance of the kernel, called the boot kernel, into
471 memory and passes control to it in the usual way.  Then the boot kernel reads
472 the system image, restores the pre-hibernation memory contents, and passes
473 control to the image kernel.  Thus two different kernels are involved in
474 resuming from hibernation.  In fact, the boot kernel may be completely different
475 from the image kernel: a different configuration and even a different version.
476 This has important consequences for device drivers and their subsystems.
477
478 To be able to load the system image into memory, the boot kernel needs to
479 include at least a subset of device drivers allowing it to access the storage
480 medium containing the image, although it doesn't need to include all of the
481 drivers present in the image kernel.  After the image has been loaded, the
482 devices managed by the boot kernel need to be prepared for passing control back
483 to the image kernel.  This is very similar to the initial steps involved in
484 creating a system image, and it is accomplished in the same way, using prepare,
485 freeze, and freeze_noirq phases.  However the devices affected by these phases
486 are only those having drivers in the boot kernel; other devices will still be in
487 whatever state the boot loader left them.
488
489 Should the restoration of the pre-hibernation memory contents fail, the boot
490 kernel would go through the "thawing" procedure described above, using the
491 thaw_noirq, thaw, and complete phases, and then continue running normally.  This
492 happens only rarely.  Most often the pre-hibernation memory contents are
493 restored successfully and control is passed to the image kernel, which then
494 becomes responsible for bringing the system back to the working state.
495
496 To achieve this, the image kernel must restore the devices' pre-hibernation
497 functionality.  The operation is much like waking up from the memory sleep
498 state, although it involves different phases:
499
500         restore_noirq, restore, complete
501
502     1.  The restore_noirq phase is analogous to the resume_noirq phase.
503
504     2.  The restore phase is analogous to the resume phase.
505
506     3.  The complete phase is discussed above.
507
508 The main difference from resume[_noirq] is that restore[_noirq] must assume the
509 device has been accessed and reconfigured by the boot loader or the boot kernel.
510 Consequently the state of the device may be different from the state remembered
511 from the freeze and freeze_noirq phases.  The device may even need to be reset
512 and completely re-initialized.  In many cases this difference doesn't matter, so
513 the resume[_noirq] and restore[_norq] method pointers can be set to the same
514 routines.  Nevertheless, different callback pointers are used in case there is a
515 situation where it actually matters.
516
517
518 Device Power Management Domains
519 -------------------------------
520 Sometimes devices share reference clocks or other power resources.  In those
521 cases it generally is not possible to put devices into low-power states
522 individually.  Instead, a set of devices sharing a power resource can be put
523 into a low-power state together at the same time by turning off the shared
524 power resource.  Of course, they also need to be put into the full-power state
525 together, by turning the shared power resource on.  A set of devices with this
526 property is often referred to as a power domain.
527
528 Support for power domains is provided through the pm_domain field of struct
529 device.  This field is a pointer to an object of type struct dev_pm_domain,
530 defined in include/linux/pm.h, providing a set of power management callbacks
531 analogous to the subsystem-level and device driver callbacks that are executed
532 for the given device during all power transitions, instead of the respective
533 subsystem-level callbacks.  Specifically, if a device's pm_domain pointer is
534 not NULL, the ->suspend() callback from the object pointed to by it will be
535 executed instead of its subsystem's (e.g. bus type's) ->suspend() callback and
536 anlogously for all of the remaining callbacks.  In other words, power management
537 domain callbacks, if defined for the given device, always take precedence over
538 the callbacks provided by the device's subsystem (e.g. bus type).
539
540 The support for device power management domains is only relevant to platforms
541 needing to use the same device driver power management callbacks in many
542 different power domain configurations and wanting to avoid incorporating the
543 support for power domains into subsystem-level callbacks, for example by
544 modifying the platform bus type.  Other platforms need not implement it or take
545 it into account in any way.
546
547
548 Device Low Power (suspend) States
549 ---------------------------------
550 Device 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"
553 faster than from a full "off".
554
555 Some busses define rules about what different suspend states mean.  PCI
556 gives one example:  after the suspend sequence completes, a non-legacy
557 PCI device may not perform DMA or issue IRQs, and any wakeup events it
558 issues would be issued through the PME# bus signal.  Plus, there are
559 several PCI-standard device states, some of which are optional.
560
561 In contrast, integrated system-on-chip processors often use IRQs as the
562 wakeup event sources (so drivers would call enable_irq_wake) and might
563 be able to treat DMA completion as a wakeup event (sometimes DMA can stay
564 active too, it'd only be the CPU and some peripherals that sleep).
565
566 Some details here may be platform-specific.  Systems may have devices that
567 can be fully active in certain sleep states, such as an LCD display that's
568 refreshed using DMA while most of the system is sleeping lightly ... and
569 its frame buffer might even be updated by a DSP or other non-Linux CPU while
570 the Linux control processor stays idle.
571
572 Moreover, the specific actions taken may depend on the target system state.
573 One target system state might allow a given device to be very operational;
574 another might require a hard shut down with re-initialization on resume.
575 And two different target systems might use the same device in different
576 ways; the aforementioned LCD might be active in one product's "standby",
577 but a different product using the same SOC might work differently.
578
579
580 Power Management Notifiers
581 --------------------------
582 There are some operations that cannot be carried out by the power management
583 callbacks discussed above, because the callbacks occur too late or too early.
584 To handle these cases, subsystems and device drivers may register power
585 management notifiers that are called before tasks are frozen and after they have
586 been thawed.  Generally speaking, the PM notifiers are suitable for performing
587 actions that either require user space to be available, or at least won't
588 interfere with user space.
589
590 For details refer to Documentation/power/notifiers.txt.
591
592
593 Runtime Power Management
594 ========================
595 Many devices are able to dynamically power down while the system is still
596 running. This feature is useful for devices that are not being used, and
597 can offer significant power savings on a running system.  These devices
598 often support a range of runtime power states, which might use names such
599 as "off", "sleep", "idle", "active", and so on.  Those states will in some
600 cases (like PCI) be partially constrained by the bus the device uses, and will
601 usually include hardware states that are also used in system sleep states.
602
603 A system-wide power transition can be started while some devices are in low
604 power states due to runtime power management.  The system sleep PM callbacks
605 should recognize such situations and react to them appropriately, but the
606 necessary actions are subsystem-specific.
607
608 In some cases the decision may be made at the subsystem level while in other
609 cases the device driver may be left to decide.  In some cases it may be
610 desirable to leave a suspended device in that state during a system-wide power
611 transition, but in other cases the device must be put back into the full-power
612 state temporarily, for example so that its system wakeup capability can be
613 disabled.  This all depends on the hardware and the design of the subsystem and
614 device driver in question.
615
616 During system-wide resume from a sleep state it's easiest to put devices into
617 the full-power state, as explained in Documentation/power/runtime_pm.txt.  Refer
618 to that document for more information regarding this particular issue as well as
619 for information on the device runtime power management framework in general.