diff options
Diffstat (limited to 'Documentation/power')
-rw-r--r-- | Documentation/power/runtime_pm.txt | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/power/runtime_pm.txt b/Documentation/power/runtime_pm.txt index f49a33b704d2..4a3109b28847 100644 --- a/Documentation/power/runtime_pm.txt +++ b/Documentation/power/runtime_pm.txt | |||
@@ -38,7 +38,7 @@ struct dev_pm_ops { | |||
38 | ... | 38 | ... |
39 | int (*runtime_suspend)(struct device *dev); | 39 | int (*runtime_suspend)(struct device *dev); |
40 | int (*runtime_resume)(struct device *dev); | 40 | int (*runtime_resume)(struct device *dev); |
41 | void (*runtime_idle)(struct device *dev); | 41 | int (*runtime_idle)(struct device *dev); |
42 | ... | 42 | ... |
43 | }; | 43 | }; |
44 | 44 | ||
@@ -71,9 +71,9 @@ what to do to handle the device). | |||
71 | purpose). | 71 | purpose). |
72 | 72 | ||
73 | In particular, if the driver requires remote wakeup capability for proper | 73 | In particular, if the driver requires remote wakeup capability for proper |
74 | functioning and device_may_wakeup() returns 'false' for the device, then | 74 | functioning and device_run_wake() returns 'false' for the device, then |
75 | ->runtime_suspend() should return -EBUSY. On the other hand, if | 75 | ->runtime_suspend() should return -EBUSY. On the other hand, if |
76 | device_may_wakeup() returns 'true' for the device and the device is put | 76 | device_run_wake() returns 'true' for the device and the device is put |
77 | into a low power state during the execution of its bus type's | 77 | into a low power state during the execution of its bus type's |
78 | ->runtime_suspend(), it is expected that remote wake-up (i.e. hardware mechanism | 78 | ->runtime_suspend(), it is expected that remote wake-up (i.e. hardware mechanism |
79 | allowing the device to request a change of its power state, such as PCI PME) | 79 | allowing the device to request a change of its power state, such as PCI PME) |
@@ -114,7 +114,8 @@ The action performed by a bus type's ->runtime_idle() callback is totally | |||
114 | dependent on the bus type in question, but the expected and recommended action | 114 | dependent on the bus type in question, but the expected and recommended action |
115 | is to check if the device can be suspended (i.e. if all of the conditions | 115 | is to check if the device can be suspended (i.e. if all of the conditions |
116 | necessary for suspending the device are satisfied) and to queue up a suspend | 116 | necessary for suspending the device are satisfied) and to queue up a suspend |
117 | request for the device in that case. | 117 | request for the device in that case. The value returned by this callback is |
118 | ignored by the PM core. | ||
118 | 119 | ||
119 | The helper functions provided by the PM core, described in Section 4, guarantee | 120 | The helper functions provided by the PM core, described in Section 4, guarantee |
120 | that the following constraints are met with respect to the bus type's run-time | 121 | that the following constraints are met with respect to the bus type's run-time |
@@ -214,6 +215,9 @@ defined in include/linux/pm.h: | |||
214 | being executed for that device and it is not practical to wait for the | 215 | being executed for that device and it is not practical to wait for the |
215 | suspend to complete; means "start a resume as soon as you've suspended" | 216 | suspend to complete; means "start a resume as soon as you've suspended" |
216 | 217 | ||
218 | unsigned int run_wake; | ||
219 | - set if the device is capable of generating run-time wake-up events | ||
220 | |||
217 | enum rpm_status runtime_status; | 221 | enum rpm_status runtime_status; |
218 | - the run-time PM status of the device; this field's initial value is | 222 | - the run-time PM status of the device; this field's initial value is |
219 | RPM_SUSPENDED, which means that each device is initially regarded by the | 223 | RPM_SUSPENDED, which means that each device is initially regarded by the |