[07/13] cpufreq: powernv-cpufreq: Fix a bunch of kerneldoc related issues

Message ID 20200714145049.2496163-8-lee.jones@linaro.org
State Superseded
Headers show
Series
  • Rid W=1 warnings in CPUFreq
Related show

Commit Message

Lee Jones July 14, 2020, 2:50 p.m.
Repair problems with formatting and missing attributes/parameters, and
demote header comments which do not meet the required standards
applicable to kerneldoc.

Fixes the following W=1 kernel build warning(s):

 drivers/cpufreq/powernv-cpufreq.c:84: warning: Function parameter or member 'last_lpstate_idx' not described in 'global_pstate_info'
 drivers/cpufreq/powernv-cpufreq.c:84: warning: Function parameter or member 'last_gpstate_idx' not described in 'global_pstate_info'
 drivers/cpufreq/powernv-cpufreq.c:84: warning: Function parameter or member 'policy' not described in 'global_pstate_info'
 drivers/cpufreq/powernv-cpufreq.c:182: warning: Function parameter or member 'i' not described in 'idx_to_pstate'
 drivers/cpufreq/powernv-cpufreq.c:201: warning: Function parameter or member 'pstate' not described in 'pstate_to_idx'
 drivers/cpufreq/powernv-cpufreq.c:670: warning: Function parameter or member 't' not described in 'gpstate_timer_handler'
 drivers/cpufreq/powernv-cpufreq.c:670: warning: Excess function parameter 'data' description in 'gpstate_timer_handler'

Cc: Michael Ellerman <mpe@ellerman.id.au>
Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/cpufreq/powernv-cpufreq.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

-- 
2.25.1

Comments

Viresh Kumar July 15, 2020, 3:09 a.m. | #1
On 14-07-20, 15:50, Lee Jones wrote:
> Repair problems with formatting and missing attributes/parameters, and

> demote header comments which do not meet the required standards

> applicable to kerneldoc.

> 

> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/cpufreq/powernv-cpufreq.c:84: warning: Function parameter or member 'last_lpstate_idx' not described in 'global_pstate_info'

>  drivers/cpufreq/powernv-cpufreq.c:84: warning: Function parameter or member 'last_gpstate_idx' not described in 'global_pstate_info'

>  drivers/cpufreq/powernv-cpufreq.c:84: warning: Function parameter or member 'policy' not described in 'global_pstate_info'

>  drivers/cpufreq/powernv-cpufreq.c:182: warning: Function parameter or member 'i' not described in 'idx_to_pstate'

>  drivers/cpufreq/powernv-cpufreq.c:201: warning: Function parameter or member 'pstate' not described in 'pstate_to_idx'

>  drivers/cpufreq/powernv-cpufreq.c:670: warning: Function parameter or member 't' not described in 'gpstate_timer_handler'

>  drivers/cpufreq/powernv-cpufreq.c:670: warning: Excess function parameter 'data' description in 'gpstate_timer_handler'

> 

> Cc: Michael Ellerman <mpe@ellerman.id.au>

> Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>

> Cc: Paul Mackerras <paulus@samba.org>

> Cc: linuxppc-dev@lists.ozlabs.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/cpufreq/powernv-cpufreq.c | 11 ++++++-----

>  1 file changed, 6 insertions(+), 5 deletions(-)

> 

> diff --git a/drivers/cpufreq/powernv-cpufreq.c b/drivers/cpufreq/powernv-cpufreq.c

> index 068cc53abe320..2e5a8b8a4abaa 100644

> --- a/drivers/cpufreq/powernv-cpufreq.c

> +++ b/drivers/cpufreq/powernv-cpufreq.c

> @@ -64,13 +64,14 @@

>   *				highest_lpstate_idx

>   * @last_sampled_time:		Time from boot in ms when global pstates were

>   *				last set

> - * @last_lpstate_idx,		Last set value of local pstate and global

> - * last_gpstate_idx		pstate in terms of cpufreq table index

> + * @last_lpstate_idx:		Last set value of local pstate and global

> + * @last_gpstate_idx:		pstate in terms of cpufreq table index

>   * @timer:			Is used for ramping down if cpu goes idle for

>   *				a long time with global pstate held high

>   * @gpstate_lock:		A spinlock to maintain synchronization between

>   *				routines called by the timer handler and

>   *				governer's target_index calls

> + * @policy:			Associated CPUFreq policy

>   */

>  struct global_pstate_info {

>  	int highest_lpstate_idx;

> @@ -170,7 +171,7 @@ static inline u8 extract_pstate(u64 pmsr_val, unsigned int shift)

>  

>  /* Use following functions for conversions between pstate_id and index */

>  

> -/**

> +/*

>   * idx_to_pstate : Returns the pstate id corresponding to the

>   *		   frequency in the cpufreq frequency table

>   *		   powernv_freqs indexed by @i.

> @@ -188,7 +189,7 @@ static inline u8 idx_to_pstate(unsigned int i)

>  	return powernv_freqs[i].driver_data;

>  }

>  

> -/**

> +/*

>   * pstate_to_idx : Returns the index in the cpufreq frequencytable

>   *		   powernv_freqs for the frequency whose corresponding

>   *		   pstate id is @pstate.

> @@ -660,7 +661,7 @@ static inline void  queue_gpstate_timer(struct global_pstate_info *gpstates)

>  /**

>   * gpstate_timer_handler

>   *

> - * @data: pointer to cpufreq_policy on which timer was queued

> + * @t: Timer context used to fetch global pstate info struct

>   *

>   * This handler brings down the global pstate closer to the local pstate

>   * according quadratic equation. Queues a new timer if it is still not equal


Acked-by: Viresh Kumar <viresh.kumar@linaro.org>


-- 
viresh

Patch

diff --git a/drivers/cpufreq/powernv-cpufreq.c b/drivers/cpufreq/powernv-cpufreq.c
index 068cc53abe320..2e5a8b8a4abaa 100644
--- a/drivers/cpufreq/powernv-cpufreq.c
+++ b/drivers/cpufreq/powernv-cpufreq.c
@@ -64,13 +64,14 @@ 
  *				highest_lpstate_idx
  * @last_sampled_time:		Time from boot in ms when global pstates were
  *				last set
- * @last_lpstate_idx,		Last set value of local pstate and global
- * last_gpstate_idx		pstate in terms of cpufreq table index
+ * @last_lpstate_idx:		Last set value of local pstate and global
+ * @last_gpstate_idx:		pstate in terms of cpufreq table index
  * @timer:			Is used for ramping down if cpu goes idle for
  *				a long time with global pstate held high
  * @gpstate_lock:		A spinlock to maintain synchronization between
  *				routines called by the timer handler and
  *				governer's target_index calls
+ * @policy:			Associated CPUFreq policy
  */
 struct global_pstate_info {
 	int highest_lpstate_idx;
@@ -170,7 +171,7 @@  static inline u8 extract_pstate(u64 pmsr_val, unsigned int shift)
 
 /* Use following functions for conversions between pstate_id and index */
 
-/**
+/*
  * idx_to_pstate : Returns the pstate id corresponding to the
  *		   frequency in the cpufreq frequency table
  *		   powernv_freqs indexed by @i.
@@ -188,7 +189,7 @@  static inline u8 idx_to_pstate(unsigned int i)
 	return powernv_freqs[i].driver_data;
 }
 
-/**
+/*
  * pstate_to_idx : Returns the index in the cpufreq frequencytable
  *		   powernv_freqs for the frequency whose corresponding
  *		   pstate id is @pstate.
@@ -660,7 +661,7 @@  static inline void  queue_gpstate_timer(struct global_pstate_info *gpstates)
 /**
  * gpstate_timer_handler
  *
- * @data: pointer to cpufreq_policy on which timer was queued
+ * @t: Timer context used to fetch global pstate info struct
  *
  * This handler brings down the global pstate closer to the local pstate
  * according quadratic equation. Queues a new timer if it is still not equal