[PATCH] PM: Add documentation for pm_runtime_resume_and_get()

[PATCH] PM: Add documentation for pm_runtime_resume_and_get()

[Alan Stern]

Commit dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to
deal with usage counter") added a new runtime-PM API function without
adding any documentation for it.  This patch adds the missing
documentation.

Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
CC: Zhang Qilong <zhangqilong3@huawei.com>
Fixes: dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to deal with usage counter")

---


[as1954]


 Documentation/power/runtime_pm.rst |    4 ++++
 1 file changed, 4 insertions(+)

Index: usb-devel/Documentation/power/runtime_pm.rst
===================================================================
--- usb-devel.orig/Documentation/power/runtime_pm.rst
+++ usb-devel/Documentation/power/runtime_pm.rst
@@ -339,6 +339,10 @@ drivers/base/power/runtime.c and include
       checked additionally, and -EACCES means that 'power.disable_depth' is
       different from 0
 
+  `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
+
   `int pm_request_idle(struct device *dev);`
     - submit a request to execute the subsystem-level idle callback for the
       device (the request is represented by a work item in pm_wq); returns 0 on

Re: [PATCH] PM: Add documentation for pm_runtime_resume_and_get()

[Rafael J. Wysocki]

On Thu, Apr 8, 2021 at 5:22 PM Alan Stern <stern@rowland.harvard.edu> wrote:
>
> Commit dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to
> deal with usage counter") added a new runtime-PM API function without
> adding any documentation for it.

Well, there is a kerneldoc comment which counts as documentation, so
I'd rather say "without updating the documentation in runtime_pm.rst".

> This patch adds the missing documentation.

But otherwise fair enough.

> Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
> CC: Zhang Qilong <zhangqilong3@huawei.com>
> Fixes: dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to deal with usage counter")
>
> ---
>
>
> [as1954]
>
>
>  Documentation/power/runtime_pm.rst |    4 ++++
>  1 file changed, 4 insertions(+)
>
> Index: usb-devel/Documentation/power/runtime_pm.rst
> ===================================================================
> --- usb-devel.orig/Documentation/power/runtime_pm.rst
> +++ usb-devel/Documentation/power/runtime_pm.rst
> @@ -339,6 +339,10 @@ drivers/base/power/runtime.c and include
>        checked additionally, and -EACCES means that 'power.disable_depth' is
>        different from 0
>
> +  `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
> +
>    `int pm_request_idle(struct device *dev);`
>      - submit a request to execute the subsystem-level idle callback for the
>        device (the request is represented by a work item in pm_wq); returns 0 on

Re: [PATCH] PM: Add documentation for pm_runtime_resume_and_get()

[Alan Stern]

On Thu, Apr 08, 2021 at 06:00:27PM +0200, Rafael J. Wysocki wrote:
> On Thu, Apr 8, 2021 at 5:22 PM Alan Stern <stern@rowland.harvard.edu> wrote:
> >
> > Commit dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to
> > deal with usage counter") added a new runtime-PM API function without
> > adding any documentation for it.
> 
> Well, there is a kerneldoc comment which counts as documentation, so
> I'd rather say "without updating the documentation in runtime_pm.rst".

Okay, that's a good point.  Feel free to make this change.

> > This patch adds the missing documentation.
> 
> But otherwise fair enough.

Thank you.

Alan Stern

> 
> > Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
> > CC: Zhang Qilong <zhangqilong3@huawei.com>
> > Fixes: dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to deal with usage counter")
> >
> > ---
> >
> >
> > [as1954]
> >
> >
> >  Documentation/power/runtime_pm.rst |    4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > Index: usb-devel/Documentation/power/runtime_pm.rst
> > ===================================================================
> > --- usb-devel.orig/Documentation/power/runtime_pm.rst
> > +++ usb-devel/Documentation/power/runtime_pm.rst
> > @@ -339,6 +339,10 @@ drivers/base/power/runtime.c and include
> >        checked additionally, and -EACCES means that 'power.disable_depth' is
> >        different from 0
> >
> > +  `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
> > +
> >    `int pm_request_idle(struct device *dev);`
> >      - submit a request to execute the subsystem-level idle callback for the
> >        device (the request is represented by a work item in pm_wq); returns 0 on

Re: [PATCH] PM: Add documentation for pm_runtime_resume_and_get()

[Rafael J. Wysocki]

On Thu, Apr 8, 2021 at 6:12 PM Alan Stern <stern@rowland.harvard.edu> wrote:
>
> On Thu, Apr 08, 2021 at 06:00:27PM +0200, Rafael J. Wysocki wrote:
> > On Thu, Apr 8, 2021 at 5:22 PM Alan Stern <stern@rowland.harvard.edu> wrote:
> > >
> > > Commit dd8088d5a896 ("PM: runtime: Add pm_runtime_resume_and_get to
> > > deal with usage counter") added a new runtime-PM API function without
> > > adding any documentation for it.
> >
> > Well, there is a kerneldoc comment which counts as documentation, so
> > I'd rather say "without updating the documentation in runtime_pm.rst".
>
> Okay, that's a good point.  Feel free to make this change.

So applied with this change made (as 5.13 material), thanks!