| Message ID | 20241203143729.478-1-paul.barker.ct@bp.renesas.com |
|---|---|
| State | Accepted |
| Commit | ccb84dc8f4a02e7d30ffd388522996546b4d00e1 |
| Headers | show |
| Series | Documentation: PM: Clarify pm_runtime_resume_and_get return value | expand |
On Tue, Dec 3, 2024 at 3:38 PM Paul Barker <paul.barker.ct@bp.renesas.com> wrote: > > 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@bp.renesas.com> > --- > 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 > -- Applied (with some minor adjustments) as 6.13-rc material, thanks!
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
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@bp.renesas.com> --- Documentation/power/runtime_pm.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)