[v3,3/3] Documentation: intel_pstate: Add base_frequency information
diff mbox series

Message ID 20181012164400.3479-4-srinivas.pandruvada@linux.intel.com
State Superseded
Headers show
Series
  • cpufreq: intel_pstate: Base frequency attribute
Related show

Commit Message

Srinivas Pandruvada Oct. 12, 2018, 4:44 p.m. UTC
Updated documentation to explain base_frequency attribute.

Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
---
 Documentation/admin-guide/pm/intel_pstate.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Rafael J. Wysocki Oct. 15, 2018, 8:53 a.m. UTC | #1
On Fri, Oct 12, 2018 at 6:44 PM Srinivas Pandruvada
<srinivas.pandruvada@linux.intel.com> wrote:
>
> Updated documentation to explain base_frequency attribute.
>
> Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
> ---
>  Documentation/admin-guide/pm/intel_pstate.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/Documentation/admin-guide/pm/intel_pstate.rst b/Documentation/admin-guide/pm/intel_pstate.rst
> index 8f1d3de449b5..14a5505e073e 100644
> --- a/Documentation/admin-guide/pm/intel_pstate.rst
> +++ b/Documentation/admin-guide/pm/intel_pstate.rst
> @@ -465,6 +465,10 @@ Next, the following policy attributes have special meaning if
>         policy for the time interval between the last two invocations of the
>         driver's utilization update callback by the CPU scheduler for that CPU.
>
> +``base_frequency``
> +       When present, shows the base frequency of the CPU. Any frequency above
> +       this will be in the turbo frequency range.
> +

This isn't entirely correct, because base_frequency is not present in
the passive mode (and it is not present for the other drivers for that
matter).

>  The meaning of these attributes in the `passive mode <Passive Mode_>`_ is the
>  same as for other scaling drivers.

Instead, I would say:

"One more policy attribute is present if the `HWP feature is enabled
in the processor <Active Mode With HWP_>`_:"

here and I would add the description of the attribute below.

Thanks,
Rafael
Srinivas Pandruvada Oct. 15, 2018, 3:49 p.m. UTC | #2
On Mon, 2018-10-15 at 10:53 +0200, Rafael J. Wysocki wrote:
> On Fri, Oct 12, 2018 at 6:44 PM Srinivas Pandruvada
> <srinivas.pandruvada@linux.intel.com> wrote:
> > 
> > Updated documentation to explain base_frequency attribute.
> > 
> > Signed-off-by: Srinivas Pandruvada <
> > srinivas.pandruvada@linux.intel.com>
> > ---
> >  Documentation/admin-guide/pm/intel_pstate.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/Documentation/admin-guide/pm/intel_pstate.rst
> > b/Documentation/admin-guide/pm/intel_pstate.rst
> > index 8f1d3de449b5..14a5505e073e 100644
> > --- a/Documentation/admin-guide/pm/intel_pstate.rst
> > +++ b/Documentation/admin-guide/pm/intel_pstate.rst
> > @@ -465,6 +465,10 @@ Next, the following policy attributes have
> > special meaning if
> >         policy for the time interval between the last two
> > invocations of the
> >         driver's utilization update callback by the CPU scheduler
> > for that CPU.
> > 
> > +``base_frequency``
> > +       When present, shows the base frequency of the CPU. Any
> > frequency above
> > +       this will be in the turbo frequency range.
> > +
> 
> This isn't entirely correct, because base_frequency is not present in
> the passive mode (and it is not present for the other drivers for
> that
> matter).
That's why it said, "when present". This keeps door open to add to
other modes too in future if needed.

Thanks,
Srinivas

> 
> >  The meaning of these attributes in the `passive mode <Passive
> > Mode_>`_ is the
> >  same as for other scaling drivers.
> 
> Instead, I would say:
> 
> "One more policy attribute is present if the `HWP feature is enabled
> in the processor <Active Mode With HWP_>`_:"
> 
> here and I would add the description of the attribute below.
> 
> Thanks,
> Rafael

Patch
diff mbox series

diff --git a/Documentation/admin-guide/pm/intel_pstate.rst b/Documentation/admin-guide/pm/intel_pstate.rst
index 8f1d3de449b5..14a5505e073e 100644
--- a/Documentation/admin-guide/pm/intel_pstate.rst
+++ b/Documentation/admin-guide/pm/intel_pstate.rst
@@ -465,6 +465,10 @@  Next, the following policy attributes have special meaning if
 	policy for the time interval between the last two invocations of the
 	driver's utilization update callback by the CPU scheduler for that CPU.
 
+``base_frequency``
+	When present, shows the base frequency of the CPU. Any frequency above
+	this will be in the turbo frequency range.
+
 The meaning of these attributes in the `passive mode <Passive Mode_>`_ is the
 same as for other scaling drivers.