Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 651665db authored by Geert Uytterhoeven's avatar Geert Uytterhoeven Committed by Rafael J. Wysocki
Browse files

PM / Runtime: Update runtime_idle() documentation for return value meaning 



As of commit 45f0a85c ('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: default avatarGeert Uytterhoeven <geert+renesas@linux-m68k.org>
Acked-by: default avatarPavel Machek <pavel@ucw.cz>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent dcb99fd9

include/linux/pm.h

+3 −3
Original line number Diff line number Diff line
@@ -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.