summaryrefslogtreecommitdiff
path: root/include/linux/pm.h
diff options
context:
space:
mode:
authorGeert Uytterhoeven <geert+renesas@linux-m68k.org>2014-03-17 21:26:11 +0100
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>2014-03-20 03:33:41 +0100
commit651665dbfdfca3201966c72edefdb0391160bea9 (patch)
tree19d81e9ad95986fe7d76cd6fd2a61d262d17617a /include/linux/pm.h
parentdcb99fd9b08cfe1afe426af4d8d3cbc429190f15 (diff)
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/linux/pm.h')
-rw-r--r--include/linux/pm.h6
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.