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

[Lee Jones]

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

> On Tue, Jul 14, 2020 at 4:51 PM Lee Jones <lee.jones@xxxxxxxxxx> 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@xxxxxxxxxxxxxxx>
> > Cc: Len Brown <lenb@xxxxxxxxxx>
> > Cc: Dirk Brandewie <dirk.j.brandewie@xxxxxxxxx>
> > Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> > ---
> >  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