devices.txt 33 KB

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