[PATCH] Documentation: PM: Clarify pm_runtime_resume_and_get return value

From: Paul Barker
Date: Tue Dec 03 2024 - 09:40:23 EST


Update the documentation to match the behaviour of the code.

The function 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@xxxxxxxxxxxxxx>
---
Documentation/power/runtime_pm.rst | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/power/runtime_pm.rst b/Documentation/power/runtime_pm.rst
index 53d1996460ab..a86f1173980a 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
--
2.43.0