diff options
| author | Paul Barker <paul.barker.ct@bp.renesas.com> | 2024-12-03 15:37:29 +0100 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2024-12-10 20:14:22 +0100 |
| commit | ccb84dc8f4a02e7d30ffd388522996546b4d00e1 (patch) | |
| tree | 33271d47d4ad30de662b77f7ff4fef25f07cb452 /Documentation/power/runtime_pm.rst | |
| parent | Linux 6.13-rc2 (diff) | |
| download | linux-ccb84dc8f4a02e7d30ffd388522996546b4d00e1.tar.xz linux-ccb84dc8f4a02e7d30ffd388522996546b4d00e1.zip | |
Documentation: PM: Clarify pm_runtime_resume_and_get() return value
Update the documentation to match the behaviour of the code.
pm_runtime_resume_and_get() always returns 0 on success, even if
__pm_runtime_resume() returns 1.
Fixes: 2c412337cfe6 ("PM: runtime: Add documentation for pm_runtime_resume_and_get()")
Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Link: https://patch.msgid.link/20241203143729.478-1-paul.barker.ct@bp.renesas.com
[ rjw: Subject and changelog edits, adjusted new comment formatting ]
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Diffstat (limited to 'Documentation/power/runtime_pm.rst')
| -rw-r--r-- | Documentation/power/runtime_pm.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/power/runtime_pm.rst b/Documentation/power/runtime_pm.rst index 53d1996460ab..12f429359a82 100644 --- a/Documentation/power/runtime_pm.rst +++ b/Documentation/power/runtime_pm.rst @@ -347,7 +347,9 @@ drivers/base/power/runtime.c and include/linux/pm_runtime.h: `int pm_runtime_resume_and_get(struct device *dev);` - run pm_runtime_resume(dev) and if successful, increment the device's - usage counter; return the result of pm_runtime_resume + usage counter; returns 0 on success (whether or not the device's + runtime PM status was already 'active') or the error code from + pm_runtime_resume() on failure. `int pm_request_idle(struct device *dev);` - submit a request to execute the subsystem-level idle callback for the |