[12/13] cpufreq: intel_pstate: Supply struct attribute description for get_aperf_mperf_shift()

Message ID 20200714145049.2496163-13-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.
Fixes the following W=1 kernel build warning(s):

 drivers/cpufreq/intel_pstate.c:293: warning: Function parameter or member 'get_aperf_mperf_shift' not described in 'pstate_funcs'

Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Cc: Len Brown <lenb@kernel.org>
Cc: Dirk Brandewie <dirk.j.brandewie@intel.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/cpufreq/intel_pstate.c | 2 ++
 1 file changed, 2 insertions(+)

-- 
2.25.1

Comments

Rafael J. Wysocki July 14, 2020, 4:35 p.m. | #1
On Tue, Jul 14, 2020 at 4:51 PM Lee Jones <lee.jones@linaro.org> wrote:
>

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

>

>  drivers/cpufreq/intel_pstate.c:293: warning: Function parameter or member 'get_aperf_mperf_shift' not described in 'pstate_funcs'

>

> Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>

> Cc: Len Brown <lenb@kernel.org>

> Cc: Dirk Brandewie <dirk.j.brandewie@intel.com>

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

> ---

>  drivers/cpufreq/intel_pstate.c | 2 ++

>  1 file changed, 2 insertions(+)

>

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

> index 44c7b4677675d..f92fc69c87269 100644

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

> +++ b/drivers/cpufreq/intel_pstate.c

> @@ -275,6 +275,8 @@ static struct cpudata **all_cpu_data;

>   * @get_min:           Callback to get minimum P state

>   * @get_turbo:         Callback to get turbo P state

>   * @get_scaling:       Callback to get frequency scaling factor

> + * @get_aperf_mperf_shift: Callback to get the number of clock cycles after

> + *                     aperf, merf is incremented


This added description is inaccurate.  It should be something like
"Callback to get the APERF vs MPERF frequency difference".

>   * @get_val:           Callback to convert P state to actual MSR write value

>   * @get_vid:           Callback to get VID data for Atom platforms

>   *

> --
Lee Jones July 14, 2020, 9:03 p.m. | #2
On Tue, 14 Jul 2020, Rafael J. Wysocki wrote:

> On Tue, Jul 14, 2020 at 4:51 PM Lee Jones <lee.jones@linaro.org> wrote:

> >

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

> >

> >  drivers/cpufreq/intel_pstate.c:293: warning: Function parameter or member 'get_aperf_mperf_shift' not described in 'pstate_funcs'

> >

> > Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>

> > Cc: Len Brown <lenb@kernel.org>

> > Cc: Dirk Brandewie <dirk.j.brandewie@intel.com>

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

> > ---

> >  drivers/cpufreq/intel_pstate.c | 2 ++

> >  1 file changed, 2 insertions(+)

> >

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

> > index 44c7b4677675d..f92fc69c87269 100644

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

> > +++ b/drivers/cpufreq/intel_pstate.c

> > @@ -275,6 +275,8 @@ static struct cpudata **all_cpu_data;

> >   * @get_min:           Callback to get minimum P state

> >   * @get_turbo:         Callback to get turbo P state

> >   * @get_scaling:       Callback to get frequency scaling factor

> > + * @get_aperf_mperf_shift: Callback to get the number of clock cycles after

> > + *                     aperf, merf is incremented

> 

> This added description is inaccurate.  It should be something like

> "Callback to get the APERF vs MPERF frequency difference".


Does that mean the description of @aperf_mperf_shift above is also
incorrect?

> >   * @get_val:           Callback to convert P state to actual MSR write value

> >   * @get_vid:           Callback to get VID data for Atom platforms

> >   *

> > --


-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
Rafael J. Wysocki July 15, 2020, 12:38 p.m. | #3
On Tue, Jul 14, 2020 at 11:28 PM Lee Jones <lee.jones@linaro.org> wrote:
>

> On Tue, 14 Jul 2020, Rafael J. Wysocki wrote:

>

> > On Tue, Jul 14, 2020 at 4:51 PM Lee Jones <lee.jones@linaro.org> wrote:

> > >

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

> > >

> > >  drivers/cpufreq/intel_pstate.c:293: warning: Function parameter or member 'get_aperf_mperf_shift' not described in 'pstate_funcs'

> > >

> > > Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>

> > > Cc: Len Brown <lenb@kernel.org>

> > > Cc: Dirk Brandewie <dirk.j.brandewie@intel.com>

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

> > > ---

> > >  drivers/cpufreq/intel_pstate.c | 2 ++

> > >  1 file changed, 2 insertions(+)

> > >

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

> > > index 44c7b4677675d..f92fc69c87269 100644

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

> > > +++ b/drivers/cpufreq/intel_pstate.c

> > > @@ -275,6 +275,8 @@ static struct cpudata **all_cpu_data;

> > >   * @get_min:           Callback to get minimum P state

> > >   * @get_turbo:         Callback to get turbo P state

> > >   * @get_scaling:       Callback to get frequency scaling factor

> > > + * @get_aperf_mperf_shift: Callback to get the number of clock cycles after

> > > + *                     aperf, merf is incremented

> >

> > This added description is inaccurate.  It should be something like

> > "Callback to get the APERF vs MPERF frequency difference".

>

> Does that mean the description of @aperf_mperf_shift above is also

> incorrect?


It is slightly unclear, let me improve it.

Thanks!

Patch

diff --git a/drivers/cpufreq/intel_pstate.c b/drivers/cpufreq/intel_pstate.c
index 44c7b4677675d..f92fc69c87269 100644
--- a/drivers/cpufreq/intel_pstate.c
+++ b/drivers/cpufreq/intel_pstate.c
@@ -275,6 +275,8 @@  static struct cpudata **all_cpu_data;
  * @get_min:		Callback to get minimum P state
  * @get_turbo:		Callback to get turbo P state
  * @get_scaling:	Callback to get frequency scaling factor
+ * @get_aperf_mperf_shift: Callback to get the number of clock cycles after
+ *			aperf, merf is incremented
  * @get_val:		Callback to convert P state to actual MSR write value
  * @get_vid:		Callback to get VID data for Atom platforms
  *