[PATCH 3/7] PM: runtime: remove kernel-doc warnings

[PATCH 3/7] PM: runtime: remove kernel-doc warnings

[Pierre-Louis Bossart]

remove make W=1 warnings

drivers/base/power/runtime.c:926: warning: Function parameter or
member 'timer' not described in 'pm_suspend_timer_fn'

drivers/base/power/runtime.c:926: warning: Excess function parameter
'data' description in 'pm_suspend_timer_fn'

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
---
 drivers/base/power/runtime.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
index fe1dad68aee4..1fc1a992f90c 100644
--- a/drivers/base/power/runtime.c
+++ b/drivers/base/power/runtime.c
@@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
 
 /**
  * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
- * @data: Device pointer passed by pm_schedule_suspend().
+ * @timer: hrtimer used by pm_schedule_suspend().
  *
  * Check if the time is right and queue a suspend request.
  */
-- 
2.25.1

[PATCH 4/7] PM: wakeup: fix kernel-doc warnings and fix typos

[Pierre-Louis Bossart]

Remove make W=1 warnings and fit 'Itereates' typos

drivers/base/power/wakeup.c:403: warning: wrong kernel-doc identifier on line:
 * device_wakeup_arm_wake_irqs(void)

drivers/base/power/wakeup.c:419: warning: wrong kernel-doc identifier on line:
 * device_wakeup_disarm_wake_irqs(void)

drivers/base/power/wakeup.c:537: warning: Function parameter or member
'enable' not described in 'device_set_wakeup_enable'

drivers/base/power/wakeup.c:592: warning: expecting prototype for
wakup_source_activate(). Prototype was for wakeup_source_activate()
instead

drivers/base/power/wakeup.c:697: warning: expecting prototype for
wakup_source_deactivate(). Prototype was for
wakeup_source_deactivate() instead

drivers/base/power/wakeup.c:795: warning: Function parameter or member
't' not described in 'pm_wakeup_timer_fn'

drivers/base/power/wakeup.c:795: warning: Excess function parameter
'data' description in 'pm_wakeup_timer_fn'

drivers/base/power/wakeup.c:1027: warning: Function parameter or
member 'set' not described in 'pm_wakep_autosleep_enabled'

drivers/base/power/wakeup.c:1027: warning: Excess function parameter
'enabled' description in 'pm_wakep_autosleep_enabled'

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
---
 drivers/base/power/wakeup.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/drivers/base/power/wakeup.c b/drivers/base/power/wakeup.c
index 92073ac68473..f0b37c188514 100644
--- a/drivers/base/power/wakeup.c
+++ b/drivers/base/power/wakeup.c
@@ -400,9 +400,9 @@ void device_wakeup_detach_irq(struct device *dev)
 }
 
 /**
- * device_wakeup_arm_wake_irqs(void)
+ * device_wakeup_arm_wake_irqs -
  *
- * Itereates over the list of device wakeirqs to arm them.
+ * Iterates over the list of device wakeirqs to arm them.
  */
 void device_wakeup_arm_wake_irqs(void)
 {
@@ -416,9 +416,9 @@ void device_wakeup_arm_wake_irqs(void)
 }
 
 /**
- * device_wakeup_disarm_wake_irqs(void)
+ * device_wakeup_disarm_wake_irqs -
  *
- * Itereates over the list of device wakeirqs to disarm them.
+ * Iterates over the list of device wakeirqs to disarm them.
  */
 void device_wakeup_disarm_wake_irqs(void)
 {
@@ -532,6 +532,7 @@ EXPORT_SYMBOL_GPL(device_init_wakeup);
 /**
  * device_set_wakeup_enable - Enable or disable a device to wake up the system.
  * @dev: Device to handle.
+ * @enable: enable/disable flag
  */
 int device_set_wakeup_enable(struct device *dev, bool enable)
 {
@@ -581,7 +582,7 @@ static bool wakeup_source_not_registered(struct wakeup_source *ws)
  */
 
 /**
- * wakup_source_activate - Mark given wakeup source as active.
+ * wakeup_source_activate - Mark given wakeup source as active.
  * @ws: Wakeup source to handle.
  *
  * Update the @ws' statistics and, if @ws has just been activated, notify the PM
@@ -686,7 +687,7 @@ static inline void update_prevent_sleep_time(struct wakeup_source *ws,
 #endif
 
 /**
- * wakup_source_deactivate - Mark given wakeup source as inactive.
+ * wakeup_source_deactivate - Mark given wakeup source as inactive.
  * @ws: Wakeup source to handle.
  *
  * Update the @ws' statistics and notify the PM core that the wakeup source has
@@ -785,7 +786,7 @@ EXPORT_SYMBOL_GPL(pm_relax);
 
 /**
  * pm_wakeup_timer_fn - Delayed finalization of a wakeup event.
- * @data: Address of the wakeup source object associated with the event source.
+ * @t: timer list
  *
  * Call wakeup_source_deactivate() for the wakeup source whose address is stored
  * in @data if it is currently active and its timer has not been canceled and
@@ -1021,7 +1022,7 @@ bool pm_save_wakeup_count(unsigned int count)
 #ifdef CONFIG_PM_AUTOSLEEP
 /**
  * pm_wakep_autosleep_enabled - Modify autosleep_enabled for all wakeup sources.
- * @enabled: Whether to set or to clear the autosleep_enabled flags.
+ * @set: Whether to set or to clear the autosleep_enabled flags.
  */
 void pm_wakep_autosleep_enabled(bool set)
 {
-- 
2.25.1

[PATCH 5/7] PM: clk: remove kernel-doc warning

[Pierre-Louis Bossart]

Remove make W=1 warning:

drivers/base/power/clock_ops.c:148: warning: expecting prototype for
pm_clk_enable(). Prototype was for __pm_clk_enable() instead

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
---
 drivers/base/power/clock_ops.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/base/power/clock_ops.c b/drivers/base/power/clock_ops.c
index 84d5acb6301b..0251f3e6e61d 100644
--- a/drivers/base/power/clock_ops.c
+++ b/drivers/base/power/clock_ops.c
@@ -140,7 +140,7 @@ static void pm_clk_op_unlock(struct pm_subsys_data *psd, unsigned long *flags)
 }
 
 /**
- * pm_clk_enable - Enable a clock, reporting any errors
+ * __pm_clk_enable - Enable a clock, reporting any errors
  * @dev: The device for the given clock
  * @ce: PM clock entry corresponding to the clock.
  */
-- 
2.25.1

Re: [PATCH 3/7] PM: runtime: remove kernel-doc warnings

[Rafael J. Wysocki]

On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
<pierre-louis.bossart@linux.intel.com> wrote:
>
> remove make W=1 warnings
>
> drivers/base/power/runtime.c:926: warning: Function parameter or
> member 'timer' not described in 'pm_suspend_timer_fn'
>
> drivers/base/power/runtime.c:926: warning: Excess function parameter
> 'data' description in 'pm_suspend_timer_fn'
>
> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
> ---
>  drivers/base/power/runtime.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> index fe1dad68aee4..1fc1a992f90c 100644
> --- a/drivers/base/power/runtime.c
> +++ b/drivers/base/power/runtime.c
> @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
>
>  /**
>   * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
> - * @data: Device pointer passed by pm_schedule_suspend().
> + * @timer: hrtimer used by pm_schedule_suspend().
>   *
>   * Check if the time is right and queue a suspend request.
>   */
> --

I can apply this along with the [4-5/7].  Do you want me to do that?

Re: [PATCH 3/7] PM: runtime: remove kernel-doc warnings

[Pierre-Louis Bossart]

On 4/1/21 8:40 AM, Rafael J. Wysocki wrote:
> On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
> <pierre-louis.bossart@linux.intel.com> wrote:
>>
>> remove make W=1 warnings
>>
>> drivers/base/power/runtime.c:926: warning: Function parameter or
>> member 'timer' not described in 'pm_suspend_timer_fn'
>>
>> drivers/base/power/runtime.c:926: warning: Excess function parameter
>> 'data' description in 'pm_suspend_timer_fn'
>>
>> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
>> ---
>>   drivers/base/power/runtime.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
>> index fe1dad68aee4..1fc1a992f90c 100644
>> --- a/drivers/base/power/runtime.c
>> +++ b/drivers/base/power/runtime.c
>> @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
>>
>>   /**
>>    * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
>> - * @data: Device pointer passed by pm_schedule_suspend().
>> + * @timer: hrtimer used by pm_schedule_suspend().
>>    *
>>    * Check if the time is right and queue a suspend request.
>>    */
>> --
> 
> I can apply this along with the [4-5/7].  Do you want me to do that?

Works for me. I wasn't sure by looking at the MAINTAINERS file which 
files in drivers/base/ are maintained by whom, so sent the patches as a 
single set.

Re: [PATCH 3/7] PM: runtime: remove kernel-doc warnings

[Greg Kroah-Hartman]

On Thu, Apr 01, 2021 at 09:13:18AM -0500, Pierre-Louis Bossart wrote:
> 
> 
> On 4/1/21 8:40 AM, Rafael J. Wysocki wrote:
> > On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
> > <pierre-louis.bossart@linux.intel.com> wrote:
> > > 
> > > remove make W=1 warnings
> > > 
> > > drivers/base/power/runtime.c:926: warning: Function parameter or
> > > member 'timer' not described in 'pm_suspend_timer_fn'
> > > 
> > > drivers/base/power/runtime.c:926: warning: Excess function parameter
> > > 'data' description in 'pm_suspend_timer_fn'
> > > 
> > > Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
> > > ---
> > >   drivers/base/power/runtime.c | 2 +-
> > >   1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> > > index fe1dad68aee4..1fc1a992f90c 100644
> > > --- a/drivers/base/power/runtime.c
> > > +++ b/drivers/base/power/runtime.c
> > > @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
> > > 
> > >   /**
> > >    * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
> > > - * @data: Device pointer passed by pm_schedule_suspend().
> > > + * @timer: hrtimer used by pm_schedule_suspend().
> > >    *
> > >    * Check if the time is right and queue a suspend request.
> > >    */
> > > --
> > 
> > I can apply this along with the [4-5/7].  Do you want me to do that?
> 
> Works for me. I wasn't sure by looking at the MAINTAINERS file which files
> in drivers/base/ are maintained by whom, so sent the patches as a single
> set.

That's fine, we can work it out :)

Re: [PATCH 3/7] PM: runtime: remove kernel-doc warnings

[Rafael J. Wysocki]

On Thu, Apr 1, 2021 at 4:13 PM Pierre-Louis Bossart
<pierre-louis.bossart@linux.intel.com> wrote:
>
>
>
> On 4/1/21 8:40 AM, Rafael J. Wysocki wrote:
> > On Thu, Apr 1, 2021 at 1:26 AM Pierre-Louis Bossart
> > <pierre-louis.bossart@linux.intel.com> wrote:
> >>
> >> remove make W=1 warnings
> >>
> >> drivers/base/power/runtime.c:926: warning: Function parameter or
> >> member 'timer' not described in 'pm_suspend_timer_fn'
> >>
> >> drivers/base/power/runtime.c:926: warning: Excess function parameter
> >> 'data' description in 'pm_suspend_timer_fn'
> >>
> >> Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
> >> ---
> >>   drivers/base/power/runtime.c | 2 +-
> >>   1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> >> index fe1dad68aee4..1fc1a992f90c 100644
> >> --- a/drivers/base/power/runtime.c
> >> +++ b/drivers/base/power/runtime.c
> >> @@ -951,7 +951,7 @@ static void pm_runtime_work(struct work_struct *work)
> >>
> >>   /**
> >>    * pm_suspend_timer_fn - Timer function for pm_schedule_suspend().
> >> - * @data: Device pointer passed by pm_schedule_suspend().
> >> + * @timer: hrtimer used by pm_schedule_suspend().
> >>    *
> >>    * Check if the time is right and queue a suspend request.
> >>    */
> >> --
> >
> > I can apply this along with the [4-5/7].  Do you want me to do that?
>
> Works for me. I wasn't sure by looking at the MAINTAINERS file which
> files in drivers/base/ are maintained by whom, so sent the patches as a
> single set.

All three applied now as 5.13 material, thanks!