@@ -2,6 +2,7 @@ Device Power Management
22
33Copyright (c) 2010-2011 Rafael J. Wysocki <rjw@sisk.pl>, Novell Inc.
44Copyright (c) 2010 Alan Stern <stern@rowland.harvard.edu>
5+ Copyright (c) 2014 Intel Corp., Rafael J. Wysocki <rafael.j.wysocki@intel.com>
56
67
78Most of the code in Linux is device drivers, so most of the Linux power
@@ -326,6 +327,20 @@ the phases are:
326327 driver in some way for the upcoming system power transition, but it
327328 should not put the device into a low-power state.
328329
330+ For devices supporting runtime power management, the return value of the
331+ prepare callback can be used to indicate to the PM core that it may
332+ safely leave the device in runtime suspend (if runtime-suspended
333+ already), provided that all of the device's descendants are also left in
334+ runtime suspend. Namely, if the prepare callback returns a positive
335+ number and that happens for all of the descendants of the device too,
336+ and all of them (including the device itself) are runtime-suspended, the
337+ PM core will skip the suspend, suspend_late and suspend_noirq suspend
338+ phases as well as the resume_noirq, resume_early and resume phases of
339+ the following system resume for all of these devices. In that case,
340+ the complete callback will be called directly after the prepare callback
341+ and is entirely responsible for bringing the device back to the
342+ functional state as appropriate.
343+
329344 2. The suspend methods should quiesce the device to stop it from performing
330345 I/O. They also may save the device registers and put it into the
331346 appropriate low-power state, depending on the bus type the device is on,
@@ -400,12 +415,23 @@ When resuming from freeze, standby or memory sleep, the phases are:
400415 the resume callbacks occur; it's not necessary to wait until the
401416 complete phase.
402417
418+ Moreover, if the preceding prepare callback returned a positive number,
419+ the device may have been left in runtime suspend throughout the whole
420+ system suspend and resume (the suspend, suspend_late, suspend_noirq
421+ phases of system suspend and the resume_noirq, resume_early, resume
422+ phases of system resume may have been skipped for it). In that case,
423+ the complete callback is entirely responsible for bringing the device
424+ back to the functional state after system suspend if necessary. [For
425+ example, it may need to queue up a runtime resume request for the device
426+ for this purpose.] To check if that is the case, the complete callback
427+ can consult the device's power.direct_complete flag. Namely, if that
428+ flag is set when the complete callback is being run, it has been called
429+ directly after the preceding prepare and special action may be required
430+ to make the device work correctly afterward.
431+
403432At the end of these phases, drivers should be as functional as they were before
404433suspending: I/O can be performed using DMA and IRQs, and the relevant clocks are
405- gated on. Even if the device was in a low-power state before the system sleep
406- because of runtime power management, afterwards it should be back in its
407- full-power state. There are multiple reasons why it's best to do this; they are
408- discussed in more detail in Documentation/power/runtime_pm.txt.
434+ gated on.
409435
410436However, the details here may again be platform-specific. For example,
411437some systems support multiple "run" states, and the mode in effect at
0 commit comments