PM / Runtime: Update runtime_idle() documentation for return value meaning
As of commit 45f0a85c82
('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>
This commit is contained in:
parent
dcb99fd9b0
commit
651665dbfd
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue