devices.txt 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  1. Device Power Management
  2. Copyright (c) 2010-2011 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
  3. Copyright (c) 2010 Alan Stern <stern@rowland.harvard.edu>
  4. Most of the code in Linux is device drivers, so most of the Linux power
  5. management (PM) code is also driver-specific. Most drivers will do very
  6. little; others, especially for platforms with small batteries (like cell
  7. phones), will do a lot.
  8. This writeup gives an overview of how drivers interact with system-wide
  9. power management goals, emphasizing the models and interfaces that are
  10. shared by everything that hooks up to the driver model core. Read it as
  11. background for the domain-specific work you'd do with any specific driver.
  12. Two Models for Device Power Management
  13. ======================================
  14. Drivers will use one or both of these models to put devices into low-power
  15. states:
  16. System Sleep model:
  17. Drivers can enter low-power states as part of entering system-wide
  18. low-power states like "suspend" (also known as "suspend-to-RAM"), or
  19. (mostly for systems with disks) "hibernation" (also known as
  20. "suspend-to-disk").
  21. This is something that device, bus, and class drivers collaborate on
  22. by implementing various role-specific suspend and resume methods to
  23. cleanly power down hardware and software subsystems, then reactivate
  24. them without loss of data.
  25. Some drivers can manage hardware wakeup events, which make the system
  26. leave the low-power state. This feature may be enabled or disabled
  27. using the relevant /sys/devices/.../power/wakeup file (for Ethernet
  28. drivers the ioctl interface used by ethtool may also be used for this
  29. purpose); enabling it may cost some power usage, but let the whole
  30. system enter low-power states more often.
  31. Runtime Power Management model:
  32. Devices may also be put into low-power states while the system is
  33. running, independently of other power management activity in principle.
  34. However, devices are not generally independent of each other (for
  35. example, a parent device cannot be suspended unless all of its child
  36. devices have been suspended). Moreover, depending on the bus type the
  37. device is on, it may be necessary to carry out some bus-specific
  38. operations on the device for this purpose. Devices put into low power
  39. states at run time may require special handling during system-wide power
  40. transitions (suspend or hibernation).
  41. For these reasons not only the device driver itself, but also the
  42. appropriate subsystem (bus type, device type or device class) driver and
  43. the PM core are involved in runtime power management. As in the system
  44. sleep power management case, they need to collaborate by implementing
  45. various role-specific suspend and resume methods, so that the hardware
  46. is cleanly powered down and reactivated without data or service loss.
  47. There's not a lot to be said about those low-power states except that they are
  48. very system-specific, and often device-specific. Also, that if enough devices
  49. have been put into low-power states (at runtime), the effect may be very similar
  50. to entering some system-wide low-power state (system sleep) ... and that
  51. synergies exist, so that several drivers using runtime PM might put the system
  52. into a state where even deeper power saving options are available.
  53. Most suspended devices will have quiesced all I/O: no more DMA or IRQs (except
  54. for wakeup events), no more data read or written, and requests from upstream
  55. drivers are no longer accepted. A given bus or platform may have different
  56. requirements though.
  57. Examples of hardware wakeup events include an alarm from a real time clock,
  58. network wake-on-LAN packets, keyboard or mouse activity, and media insertion
  59. or removal (for PCMCIA, MMC/SD, USB, and so on).
  60. Interfaces for Entering System Sleep States
  61. ===========================================
  62. There are programming interfaces provided for subsystems (bus type, device type,
  63. device class) and device drivers to allow them to participate in the power
  64. management of devices they are concerned with. These interfaces cover both
  65. system sleep and runtime power management.
  66. Device Power Management Operations
  67. ----------------------------------
  68. Device power management operations, at the subsystem level as well as at the
  69. device driver level, are implemented by defining and populating objects of type
  70. struct dev_pm_ops:
  71. struct dev_pm_ops {
  72. int (*prepare)(struct device *dev);
  73. void (*complete)(struct device *dev);
  74. int (*suspend)(struct device *dev);
  75. int (*resume)(struct device *dev);
  76. int (*freeze)(struct device *dev);
  77. int (*thaw)(struct device *dev);
  78. int (*poweroff)(struct device *dev);
  79. int (*restore)(struct device *dev);
  80. int (*suspend_late)(struct device *dev);
  81. int (*resume_early)(struct device *dev);
  82. int (*freeze_late)(struct device *dev);
  83. int (*thaw_early)(struct device *dev);
  84. int (*poweroff_late)(struct device *dev);
  85. int (*restore_early)(struct device *dev);
  86. int (*suspend_noirq)(struct device *dev);
  87. int (*resume_noirq)(struct device *dev);
  88. int (*freeze_noirq)(struct device *dev);
  89. int (*thaw_noirq)(struct device *dev);
  90. int (*poweroff_noirq)(struct device *dev);
  91. int (*restore_noirq)(struct device *dev);
  92. int (*runtime_suspend)(struct device *dev);
  93. int (*runtime_resume)(struct device *dev);
  94. int (*runtime_idle)(struct device *dev);
  95. };
  96. This structure is defined in include/linux/pm.h and the methods included in it
  97. are also described in that file. Their roles will be explained in what follows.
  98. For now, it should be sufficient to remember that the last three methods are
  99. specific to runtime power management while the remaining ones are used during
  100. system-wide power transitions.
  101. There also is a deprecated "old" or "legacy" interface for power management
  102. operations available at least for some subsystems. This approach does not use
  103. struct dev_pm_ops objects and it is suitable only for implementing system sleep
  104. power management methods. Therefore it is not described in this document, so
  105. please refer directly to the source code for more information about it.
  106. Subsystem-Level Methods
  107. -----------------------
  108. The core methods to suspend and resume devices reside in struct dev_pm_ops
  109. pointed to by the ops member of struct dev_pm_domain, or by the pm member of
  110. struct bus_type, struct device_type and struct class. They are mostly of
  111. interest to the people writing infrastructure for platforms and buses, like PCI
  112. or USB, or device type and device class drivers. They also are relevant to the
  113. writers of device drivers whose subsystems (PM domains, device types, device
  114. classes and bus types) don't provide all power management methods.
  115. Bus drivers implement these methods as appropriate for the hardware and the
  116. drivers using it; PCI works differently from USB, and so on. Not many people
  117. write subsystem-level drivers; most driver code is a "device driver" that builds
  118. on top of bus-specific framework code.
  119. For more information on these driver calls, see the description later;
  120. they are called in phases for every device, respecting the parent-child
  121. sequencing in the driver model tree.
  122. /sys/devices/.../power/wakeup files
  123. -----------------------------------
  124. All device objects in the driver model contain fields that control the handling
  125. of system wakeup events (hardware signals that can force the system out of a
  126. sleep state). These fields are initialized by bus or device driver code using
  127. device_set_wakeup_capable() and device_set_wakeup_enable(), defined in
  128. include/linux/pm_wakeup.h.
  129. The "power.can_wakeup" flag just records whether the device (and its driver) can
  130. physically support wakeup events. The device_set_wakeup_capable() routine
  131. affects this flag. The "power.wakeup" field is a pointer to an object of type
  132. struct wakeup_source used for controlling whether or not the device should use
  133. its system wakeup mechanism and for notifying the PM core of system wakeup
  134. events signaled by the device. This object is only present for wakeup-capable
  135. devices (i.e. devices whose "can_wakeup" flags are set) and is created (or
  136. removed) by device_set_wakeup_capable().
  137. Whether or not a device is capable of issuing wakeup events is a hardware
  138. matter, and the kernel is responsible for keeping track of it. By contrast,
  139. whether or not a wakeup-capable device should issue wakeup events is a policy
  140. decision, and it is managed by user space through a sysfs attribute: the
  141. "power/wakeup" file. User space can write the strings "enabled" or "disabled"
  142. to it to indicate whether or not, respectively, the device is supposed to signal
  143. system wakeup. This file is only present if the "power.wakeup" object exists
  144. for the given device and is created (or removed) along with that object, by
  145. device_set_wakeup_capable(). Reads from the file will return the corresponding
  146. string.
  147. The "power/wakeup" file is supposed to contain the "disabled" string initially
  148. for the majority of devices; the major exceptions are power buttons, keyboards,
  149. and Ethernet adapters whose WoL (wake-on-LAN) feature has been set up with
  150. ethtool. It should also default to "enabled" for devices that don't generate
  151. wakeup requests on their own but merely forward wakeup requests from one bus to
  152. another (like PCI Express ports).
  153. The device_may_wakeup() routine returns true only if the "power.wakeup" object
  154. exists and the corresponding "power/wakeup" file contains the string "enabled".
  155. This information is used by subsystems, like the PCI bus type code, to see
  156. whether or not to enable the devices' wakeup mechanisms. If device wakeup
  157. mechanisms are enabled or disabled directly by drivers, they also should use
  158. device_may_wakeup() to decide what to do during a system sleep transition.
  159. Device drivers, however, are not supposed to call device_set_wakeup_enable()
  160. directly in any case.
  161. It ought to be noted that system wakeup is conceptually different from "remote
  162. wakeup" used by runtime power management, although it may be supported by the
  163. same physical mechanism. Remote wakeup is a feature allowing devices in
  164. low-power states to trigger specific interrupts to signal conditions in which
  165. they should be put into the full-power state. Those interrupts may or may not
  166. be used to signal system wakeup events, depending on the hardware design. On
  167. some systems it is impossible to trigger them from system sleep states. In any
  168. case, remote wakeup should always be enabled for runtime power management for
  169. all devices and drivers that support it.
  170. /sys/devices/.../power/control files
  171. ------------------------------------
  172. Each device in the driver model has a flag to control whether it is subject to
  173. runtime power management. This flag, called runtime_auto, is initialized by the
  174. bus type (or generally subsystem) code using pm_runtime_allow() or
  175. pm_runtime_forbid(); the default is to allow runtime power management.
  176. The setting can be adjusted by user space by writing either "on" or "auto" to
  177. the device's power/control sysfs file. Writing "auto" calls pm_runtime_allow(),
  178. setting the flag and allowing the device to be runtime power-managed by its
  179. driver. Writing "on" calls pm_runtime_forbid(), clearing the flag, returning
  180. the device to full power if it was in a low-power state, and preventing the
  181. device from being runtime power-managed. User space can check the current value
  182. of the runtime_auto flag by reading the file.
  183. The device's runtime_auto flag has no effect on the handling of system-wide
  184. power transitions. In particular, the device can (and in the majority of cases
  185. should and will) be put into a low-power state during a system-wide transition
  186. to a sleep state even though its runtime_auto flag is clear.
  187. For more information about the runtime power management framework, refer to
  188. Documentation/power/runtime_pm.txt.
  189. Calling Drivers to Enter and Leave System Sleep States
  190. ======================================================
  191. When the system goes into a sleep state, each device's driver is asked to
  192. suspend the device by putting it into a state compatible with the target
  193. system state. That's usually some version of "off", but the details are
  194. system-specific. Also, wakeup-enabled devices will usually stay partly
  195. functional in order to wake the system.
  196. When the system leaves that low-power state, the device's driver is asked to
  197. resume it by returning it to full power. The suspend and resume operations
  198. always go together, and both are multi-phase operations.
  199. For simple drivers, suspend might quiesce the device using class code
  200. and then turn its hardware as "off" as possible during suspend_noirq. The
  201. matching resume calls would then completely reinitialize the hardware
  202. before reactivating its class I/O queues.
  203. More power-aware drivers might prepare the devices for triggering system wakeup
  204. events.
  205. Call Sequence Guarantees
  206. ------------------------
  207. To ensure that bridges and similar links needing to talk to a device are
  208. available when the device is suspended or resumed, the device tree is
  209. walked in a bottom-up order to suspend devices. A top-down order is
  210. used to resume those devices.
  211. The ordering of the device tree is defined by the order in which devices
  212. get registered: a child can never be registered, probed or resumed before
  213. its parent; and can't be removed or suspended after that parent.
  214. The policy is that the device tree should match hardware bus topology.
  215. (Or at least the control bus, for devices which use multiple busses.)
  216. In particular, this means that a device registration may fail if the parent of
  217. the device is suspending (i.e. has been chosen by the PM core as the next
  218. device to suspend) or has already suspended, as well as after all of the other
  219. devices have been suspended. Device drivers must be prepared to cope with such
  220. situations.
  221. System Power Management Phases
  222. ------------------------------
  223. Suspending or resuming the system is done in several phases. Different phases
  224. are used for freeze, standby, and memory sleep states ("suspend-to-RAM") and the
  225. hibernation state ("suspend-to-disk"). Each phase involves executing callbacks
  226. for every device before the next phase begins. Not all busses or classes
  227. support all these callbacks and not all drivers use all the callbacks. The
  228. various phases always run after tasks have been frozen and before they are
  229. unfrozen. Furthermore, the *_noirq phases run at a time when IRQ handlers have
  230. been disabled (except for those marked with the IRQF_NO_SUSPEND flag).
  231. All phases use PM domain, bus, type, class or driver callbacks (that is, methods
  232. defined in dev->pm_domain->ops, dev->bus->pm, dev->type->pm, dev->class->pm or
  233. dev->driver->pm). These callbacks are regarded by the PM core as mutually
  234. exclusive. Moreover, PM domain callbacks always take precedence over all of the
  235. other callbacks and, for example, type callbacks take precedence over bus, class
  236. and driver callbacks. To be precise, the following rules are used to determine
  237. which callback to execute in the given phase:
  238. 1. If dev->pm_domain is present, the PM core will choose the callback
  239. included in dev->pm_domain->ops for execution
  240. 2. Otherwise, if both dev->type and dev->type->pm are present, the callback
  241. included in dev->type->pm will be chosen for execution.
  242. 3. Otherwise, if both dev->class and dev->class->pm are present, the
  243. callback included in dev->class->pm will be chosen for execution.
  244. 4. Otherwise, if both dev->bus and dev->bus->pm are present, the callback
  245. included in dev->bus->pm will be chosen for execution.
  246. This allows PM domains and device types to override callbacks provided by bus
  247. types or device classes if necessary.
  248. The PM domain, type, class and bus callbacks may in turn invoke device- or
  249. driver-specific methods stored in dev->driver->pm, but they don't have to do
  250. that.
  251. If the subsystem callback chosen for execution is not present, the PM core will
  252. execute the corresponding method from dev->driver->pm instead if there is one.
  253. Entering System Suspend
  254. -----------------------
  255. When the system goes into the freeze, standby or memory sleep state,
  256. the phases are:
  257. prepare, suspend, suspend_late, suspend_noirq.
  258. 1. The prepare phase is meant to prevent races by preventing new devices
  259. from being registered; the PM core would never know that all the
  260. children of a device had been suspended if new children could be
  261. registered at will. (By contrast, devices may be unregistered at any
  262. time.) Unlike the other suspend-related phases, during the prepare
  263. phase the device tree is traversed top-down.
  264. After the prepare callback method returns, no new children may be
  265. registered below the device. The method may also prepare the device or
  266. driver in some way for the upcoming system power transition, but it
  267. should not put the device into a low-power state.
  268. 2. The suspend methods should quiesce the device to stop it from performing
  269. I/O. They also may save the device registers and put it into the
  270. appropriate low-power state, depending on the bus type the device is on,
  271. and they may enable wakeup events.
  272. 3 For a number of devices it is convenient to split suspend into the
  273. "quiesce device" and "save device state" phases, in which cases
  274. suspend_late is meant to do the latter. It is always executed after
  275. runtime power management has been disabled for all devices.
  276. 4. The suspend_noirq phase occurs after IRQ handlers have been disabled,
  277. which means that the driver's interrupt handler will not be called while
  278. the callback method is running. The methods should save the values of
  279. the device's registers that weren't saved previously and finally put the
  280. device into the appropriate low-power state.
  281. The majority of subsystems and device drivers need not implement this
  282. callback. However, bus types allowing devices to share interrupt
  283. vectors, like PCI, generally need it; otherwise a driver might encounter
  284. an error during the suspend phase by fielding a shared interrupt
  285. generated by some other device after its own device had been set to low
  286. power.
  287. At the end of these phases, drivers should have stopped all I/O transactions
  288. (DMA, IRQs), saved enough state that they can re-initialize or restore previous
  289. state (as needed by the hardware), and placed the device into a low-power state.
  290. On many platforms they will gate off one or more clock sources; sometimes they
  291. will also switch off power supplies or reduce voltages. (Drivers supporting
  292. runtime PM may already have performed some or all of these steps.)
  293. If device_may_wakeup(dev) returns true, the device should be prepared for
  294. generating hardware wakeup signals to trigger a system wakeup event when the
  295. system is in the sleep state. For example, enable_irq_wake() might identify
  296. GPIO signals hooked up to a switch or other external hardware, and
  297. pci_enable_wake() does something similar for the PCI PME signal.
  298. If any of these callbacks returns an error, the system won't enter the desired
  299. low-power state. Instead the PM core will unwind its actions by resuming all
  300. the devices that were suspended.
  301. Leaving System Suspend
  302. ----------------------
  303. When resuming from freeze, standby or memory sleep, the phases are:
  304. resume_noirq, resume_early, resume, complete.
  305. 1. The resume_noirq callback methods should perform any actions needed
  306. before the driver's interrupt handlers are invoked. This generally
  307. means undoing the actions of the suspend_noirq phase. If the bus type
  308. permits devices to share interrupt vectors, like PCI, the method should
  309. bring the device and its driver into a state in which the driver can
  310. recognize if the device is the source of incoming interrupts, if any,
  311. and handle them correctly.
  312. For example, the PCI bus type's ->pm.resume_noirq() puts the device into
  313. the full-power state (D0 in the PCI terminology) and restores the
  314. standard configuration registers of the device. Then it calls the
  315. device driver's ->pm.resume_noirq() method to perform device-specific
  316. actions.
  317. 2. The resume_early methods should prepare devices for the execution of
  318. the resume methods. This generally involves undoing the actions of the
  319. preceding suspend_late phase.
  320. 3 The resume methods should bring the the device back to its operating
  321. state, so that it can perform normal I/O. This generally involves
  322. undoing the actions of the suspend phase.
  323. 4. The complete phase should undo the actions of the prepare phase. Note,
  324. however, that new children may be registered below the device as soon as
  325. the resume callbacks occur; it's not necessary to wait until the
  326. complete phase.
  327. At the end of these phases, drivers should be as functional as they were before
  328. suspending: I/O can be performed using DMA and IRQs, and the relevant clocks are
  329. gated on. Even if the device was in a low-power state before the system sleep
  330. because of runtime power management, afterwards it should be back in its
  331. full-power state. There are multiple reasons why it's best to do this; they are
  332. discussed in more detail in Documentation/power/runtime_pm.txt.
  333. However, the details here may again be platform-specific. For example,
  334. some systems support multiple "run" states, and the mode in effect at
  335. the end of resume might not be the one which preceded suspension.
  336. That means availability of certain clocks or power supplies changed,
  337. which could easily affect how a driver works.
  338. Drivers need to be able to handle hardware which has been reset since the
  339. suspend methods were called, for example by complete reinitialization.
  340. This may be the hardest part, and the one most protected by NDA'd documents
  341. and chip errata. It's simplest if the hardware state hasn't changed since
  342. the suspend was carried out, but that can't be guaranteed (in fact, it usually
  343. is not the case).
  344. Drivers must also be prepared to notice that the device has been removed
  345. while the system was powered down, whenever that's physically possible.
  346. PCMCIA, MMC, USB, Firewire, SCSI, and even IDE are common examples of busses
  347. where common Linux platforms will see such removal. Details of how drivers
  348. will notice and handle such removals are currently bus-specific, and often
  349. involve a separate thread.
  350. These callbacks may return an error value, but the PM core will ignore such
  351. errors since there's nothing it can do about them other than printing them in
  352. the system log.
  353. Entering Hibernation
  354. --------------------
  355. Hibernating the system is more complicated than putting it into the other
  356. sleep states, because it involves creating and saving a system image.
  357. Therefore there are more phases for hibernation, with a different set of
  358. callbacks. These phases always run after tasks have been frozen and memory has
  359. been freed.
  360. The general procedure for hibernation is to quiesce all devices (freeze), create
  361. an image of the system memory while everything is stable, reactivate all
  362. devices (thaw), write the image to permanent storage, and finally shut down the
  363. system (poweroff). The phases used to accomplish this are:
  364. prepare, freeze, freeze_late, freeze_noirq, thaw_noirq, thaw_early,
  365. thaw, complete, prepare, poweroff, poweroff_late, poweroff_noirq
  366. 1. The prepare phase is discussed in the "Entering System Suspend" section
  367. above.
  368. 2. The freeze methods should quiesce the device so that it doesn't generate
  369. IRQs or DMA, and they may need to save the values of device registers.
  370. However the device does not have to be put in a low-power state, and to
  371. save time it's best not to do so. Also, the device should not be
  372. prepared to generate wakeup events.
  373. 3. The freeze_late phase is analogous to the suspend_late phase described
  374. above, except that the device should not be put in a low-power state and
  375. should not be allowed to generate wakeup events by it.
  376. 4. The freeze_noirq phase is analogous to the suspend_noirq phase discussed
  377. above, except again that the device should not be put in a low-power
  378. state and should not be allowed to generate wakeup events.
  379. At this point the system image is created. All devices should be inactive and
  380. the contents of memory should remain undisturbed while this happens, so that the
  381. image forms an atomic snapshot of the system state.
  382. 5. The thaw_noirq phase is analogous to the resume_noirq phase discussed
  383. above. The main difference is that its methods can assume the device is
  384. in the same state as at the end of the freeze_noirq phase.
  385. 6. The thaw_early phase is analogous to the resume_early phase described
  386. above. Its methods should undo the actions of the preceding
  387. freeze_late, if necessary.
  388. 7. The thaw phase is analogous to the resume phase discussed above. Its
  389. methods should bring the device back to an operating state, so that it
  390. can be used for saving the image if necessary.
  391. 8. The complete phase is discussed in the "Leaving System Suspend" section
  392. above.
  393. At this point the system image is saved, and the devices then need to be
  394. prepared for the upcoming system shutdown. This is much like suspending them
  395. before putting the system into the freeze, standby or memory sleep state,
  396. and the phases are similar.
  397. 9. The prepare phase is discussed above.
  398. 10. The poweroff phase is analogous to the suspend phase.
  399. 11. The poweroff_late phase is analogous to the suspend_late phase.
  400. 12. The poweroff_noirq phase is analogous to the suspend_noirq phase.
  401. The poweroff, poweroff_late and poweroff_noirq callbacks should do essentially
  402. the same things as the suspend, suspend_late and suspend_noirq callbacks,
  403. respectively. The only notable difference is that they need not store the
  404. device register values, because the registers should already have been stored
  405. during the freeze, freeze_late or freeze_noirq phases.
  406. Leaving Hibernation
  407. -------------------
  408. Resuming from hibernation is, again, more complicated than resuming from a sleep
  409. state in which the contents of main memory are preserved, because it requires
  410. a system image to be loaded into memory and the pre-hibernation memory contents
  411. to be restored before control can be passed back to the image kernel.
  412. Although in principle, the image might be loaded into memory and the
  413. pre-hibernation memory contents restored by the boot loader, in practice this
  414. can't be done because boot loaders aren't smart enough and there is no
  415. established protocol for passing the necessary information. So instead, the
  416. boot loader loads a fresh instance of the kernel, called the boot kernel, into
  417. memory and passes control to it in the usual way. Then the boot kernel reads
  418. the system image, restores the pre-hibernation memory contents, and passes
  419. control to the image kernel. Thus two different kernels are involved in
  420. resuming from hibernation. In fact, the boot kernel may be completely different
  421. from the image kernel: a different configuration and even a different version.
  422. This has important consequences for device drivers and their subsystems.
  423. To be able to load the system image into memory, the boot kernel needs to
  424. include at least a subset of device drivers allowing it to access the storage
  425. medium containing the image, although it doesn't need to include all of the
  426. drivers present in the image kernel. After the image has been loaded, the
  427. devices managed by the boot kernel need to be prepared for passing control back
  428. to the image kernel. This is very similar to the initial steps involved in
  429. creating a system image, and it is accomplished in the same way, using prepare,
  430. freeze, and freeze_noirq phases. However the devices affected by these phases
  431. are only those having drivers in the boot kernel; other devices will still be in
  432. whatever state the boot loader left them.
  433. Should the restoration of the pre-hibernation memory contents fail, the boot
  434. kernel would go through the "thawing" procedure described above, using the
  435. thaw_noirq, thaw, and complete phases, and then continue running normally. This
  436. happens only rarely. Most often the pre-hibernation memory contents are
  437. restored successfully and control is passed to the image kernel, which then
  438. becomes responsible for bringing the system back to the working state.
  439. To achieve this, the image kernel must restore the devices' pre-hibernation
  440. functionality. The operation is much like waking up from the memory sleep
  441. state, although it involves different phases:
  442. restore_noirq, restore_early, restore, complete
  443. 1. The restore_noirq phase is analogous to the resume_noirq phase.
  444. 2. The restore_early phase is analogous to the resume_early phase.
  445. 3. The restore phase is analogous to the resume phase.
  446. 4. The complete phase is discussed above.
  447. The main difference from resume[_early|_noirq] is that restore[_early|_noirq]
  448. must assume the device has been accessed and reconfigured by the boot loader or
  449. the boot kernel. Consequently the state of the device may be different from the
  450. state remembered from the freeze, freeze_late and freeze_noirq phases. The
  451. device may even need to be reset and completely re-initialized. In many cases
  452. this difference doesn't matter, so the resume[_early|_noirq] and
  453. restore[_early|_norq] method pointers can be set to the same routines.
  454. Nevertheless, different callback pointers are used in case there is a situation
  455. where it actually does matter.
  456. Device Power Management Domains
  457. -------------------------------
  458. Sometimes devices share reference clocks or other power resources. In those
  459. cases it generally is not possible to put devices into low-power states
  460. individually. Instead, a set of devices sharing a power resource can be put
  461. into a low-power state together at the same time by turning off the shared
  462. power resource. Of course, they also need to be put into the full-power state
  463. together, by turning the shared power resource on. A set of devices with this
  464. property is often referred to as a power domain.
  465. Support for power domains is provided through the pm_domain field of struct
  466. device. This field is a pointer to an object of type struct dev_pm_domain,
  467. defined in include/linux/pm.h, providing a set of power management callbacks
  468. analogous to the subsystem-level and device driver callbacks that are executed
  469. for the given device during all power transitions, instead of the respective
  470. subsystem-level callbacks. Specifically, if a device's pm_domain pointer is
  471. not NULL, the ->suspend() callback from the object pointed to by it will be
  472. executed instead of its subsystem's (e.g. bus type's) ->suspend() callback and
  473. analogously for all of the remaining callbacks. In other words, power
  474. management domain callbacks, if defined for the given device, always take
  475. precedence over the callbacks provided by the device's subsystem (e.g. bus
  476. type).
  477. The support for device power management domains is only relevant to platforms
  478. needing to use the same device driver power management callbacks in many
  479. different power domain configurations and wanting to avoid incorporating the
  480. support for power domains into subsystem-level callbacks, for example by
  481. modifying the platform bus type. Other platforms need not implement it or take
  482. it into account in any way.
  483. Device Low Power (suspend) States
  484. ---------------------------------
  485. Device low-power states aren't standard. One device might only handle
  486. "on" and "off", while another might support a dozen different versions of
  487. "on" (how many engines are active?), plus a state that gets back to "on"
  488. faster than from a full "off".
  489. Some busses define rules about what different suspend states mean. PCI
  490. gives one example: after the suspend sequence completes, a non-legacy
  491. PCI device may not perform DMA or issue IRQs, and any wakeup events it
  492. issues would be issued through the PME# bus signal. Plus, there are
  493. several PCI-standard device states, some of which are optional.
  494. In contrast, integrated system-on-chip processors often use IRQs as the
  495. wakeup event sources (so drivers would call enable_irq_wake) and might
  496. be able to treat DMA completion as a wakeup event (sometimes DMA can stay
  497. active too, it'd only be the CPU and some peripherals that sleep).
  498. Some details here may be platform-specific. Systems may have devices that
  499. can be fully active in certain sleep states, such as an LCD display that's
  500. refreshed using DMA while most of the system is sleeping lightly ... and
  501. its frame buffer might even be updated by a DSP or other non-Linux CPU while
  502. the Linux control processor stays idle.
  503. Moreover, the specific actions taken may depend on the target system state.
  504. One target system state might allow a given device to be very operational;
  505. another might require a hard shut down with re-initialization on resume.
  506. And two different target systems might use the same device in different
  507. ways; the aforementioned LCD might be active in one product's "standby",
  508. but a different product using the same SOC might work differently.
  509. Power Management Notifiers
  510. --------------------------
  511. There are some operations that cannot be carried out by the power management
  512. callbacks discussed above, because the callbacks occur too late or too early.
  513. To handle these cases, subsystems and device drivers may register power
  514. management notifiers that are called before tasks are frozen and after they have
  515. been thawed. Generally speaking, the PM notifiers are suitable for performing
  516. actions that either require user space to be available, or at least won't
  517. interfere with user space.
  518. For details refer to Documentation/power/notifiers.txt.
  519. Runtime Power Management
  520. ========================
  521. Many devices are able to dynamically power down while the system is still
  522. running. This feature is useful for devices that are not being used, and
  523. can offer significant power savings on a running system. These devices
  524. often support a range of runtime power states, which might use names such
  525. as "off", "sleep", "idle", "active", and so on. Those states will in some
  526. cases (like PCI) be partially constrained by the bus the device uses, and will
  527. usually include hardware states that are also used in system sleep states.
  528. A system-wide power transition can be started while some devices are in low
  529. power states due to runtime power management. The system sleep PM callbacks
  530. should recognize such situations and react to them appropriately, but the
  531. necessary actions are subsystem-specific.
  532. In some cases the decision may be made at the subsystem level while in other
  533. cases the device driver may be left to decide. In some cases it may be
  534. desirable to leave a suspended device in that state during a system-wide power
  535. transition, but in other cases the device must be put back into the full-power
  536. state temporarily, for example so that its system wakeup capability can be
  537. disabled. This all depends on the hardware and the design of the subsystem and
  538. device driver in question.
  539. During system-wide resume from a sleep state it's easiest to put devices into
  540. the full-power state, as explained in Documentation/power/runtime_pm.txt. Refer
  541. to that document for more information regarding this particular issue as well as
  542. for information on the device runtime power management framework in general.