mirror of
https://github.com/torvalds/linux.git
synced 2026-11-20 13:03:48 +00:00
PM: runtime: Clarify ->runtime_idle() callback return value handling
This doc says "Negative error return codes are ignored by the PM core" for ->runtime_idle(). This is misleading: any non-zero return value (including negative error codes such as -EBUSY or -EAGAIN) tells the PM core to abort automatic suspension of the device, which is commonly used by subsystems to prevent immediate runtime suspend. Clarify that unlike ->runtime_suspend() and ->runtime_resume(), the PM core does not treat negative return values from ->runtime_idle() as a fatal device error, and that any non-zero value stops the PM core from suspending the device. Signed-off-by: Brian Norris <[email protected]> Link: https://patch.msgid.link/20260929194956.v3.5.If6e26acac7770c65446dd0b81f891948abb38973@changeid Signed-off-by: Rafael J. Wysocki <[email protected]>
This commit is contained in:
committed by
Rafael J. Wysocki
parent
86122467ee
commit
aedc51762a
@@ -158,9 +158,14 @@ suspending the device are satisfied) and to queue up a suspend request for the
|
||||
device in that case. If there is no idle callback, or if the callback returns
|
||||
0, then the PM core will attempt to carry out a runtime suspend of the device,
|
||||
also respecting devices configured for autosuspend. In essence this means a
|
||||
call to pm_runtime_autosuspend(). To prevent this (for example, if the callback
|
||||
routine has started a delayed suspend), the routine must return a non-zero
|
||||
value. Negative error return codes are ignored by the PM core.
|
||||
call to pm_runtime_autosuspend().
|
||||
|
||||
To prevent this suspension (for example, if the callback routine has scheduled
|
||||
a delayed suspend or determined the device cannot be idle), the routine must
|
||||
return a non-zero value (typically -EBUSY or -EAGAIN). Unlike
|
||||
->runtime_suspend() and ->runtime_resume(), the PM core does not treat negative
|
||||
return codes from ->runtime_idle() as a fatal device error; any non-zero value
|
||||
simply stops the PM core from suspending the device.
|
||||
|
||||
The helper functions provided by the PM core, described in `Section 4`_,
|
||||
guarantee that the following constraints are met with respect to runtime PM
|
||||
|
||||
Reference in New Issue
Block a user