diff options
| author | Geert Uytterhoeven <geert+renesas@linux-m68k.org> | 2014-03-18 00:26:11 +0400 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2014-03-20 06:33:41 +0400 |
| commit | 651665dbfdfca3201966c72edefdb0391160bea9 (patch) | |
| tree | 19d81e9ad95986fe7d76cd6fd2a61d262d17617a /include | |
| parent | dcb99fd9b08cfe1afe426af4d8d3cbc429190f15 (diff) | |
| download | linux-651665dbfdfca3201966c72edefdb0391160bea9.tar.xz | |
PM / Runtime: Update runtime_idle() documentation for return value meaning
As of commit 45f0a85c8258 ('PM / Runtime: Rework the "runtime idle"
helper routine'), the return value of ->runtime_idle() is no longer
ignored by the PM core, but used to decide whether to suspend the
device or not.
Update the documentation to match the code.
Signed-off-by: Geert Uytterhoeven <geert+renesas@linux-m68k.org>
Acked-by: Pavel Machek <pavel@ucw.cz>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/linux/pm.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/linux/pm.h b/include/linux/pm.h index 8c6583a53a06..0298b5e5de01 100644 --- a/include/linux/pm.h +++ b/include/linux/pm.h @@ -264,9 +264,9 @@ typedef struct pm_message { * registers, so that it is fully operational. * * @runtime_idle: Device appears to be inactive and it might be put into a - * low-power state if all of the necessary conditions are satisfied. Check - * these conditions and handle the device as appropriate, possibly queueing - * a suspend request for it. The return value is ignored by the PM core. + * low-power state if all of the necessary conditions are satisfied. + * Check these conditions, and return 0 if it's appropriate to let the PM + * core queue a suspend request for the device. * * Refer to Documentation/power/runtime_pm.txt for more information about the * role of the above callbacks in device runtime power management. |