Re: [PATCH v2 11/11] amd-pstate: Add missing documentation for `amd_pstate_prefcore_ranking`

[Gautham R. Shenoy]

On Tue, Sep 03, 2024 at 03:37:01PM -0500, Mario Limonciello wrote:
> From: Mario Limonciello <mario.limonciello@xxxxxxx>
> 
> `amd_pstate_prefcore_ranking` reflects the dynamic rankings of a CPU
> core based on platform conditions.  Explicitly include it in the
> documentation.

Thanks for adding this.

> 
> Signed-off-by: Mario Limonciello <mario.limonciello@xxxxxxx>

Reviewed-by: Gautham R. Shenoy <gautham.shenoy@xxxxxxx>

> ---
>  Documentation/admin-guide/pm/amd-pstate.rst | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
> index d5c050ea390dc..210a808b74ec2 100644
> --- a/Documentation/admin-guide/pm/amd-pstate.rst
> +++ b/Documentation/admin-guide/pm/amd-pstate.rst
> @@ -252,7 +252,8 @@ In some ASICs, the highest CPPC performance is not the one in the ``_CPC``
>  table, so we need to expose it to sysfs. If boost is not active, but
>  still supported, this maximum frequency will be larger than the one in
>  ``cpuinfo``. On systems that support preferred core, the driver will have
> -different values for some cores than others.
> +different values for some cores than others and this will reflect the values
> +advertised by the platform at bootup.
>  This attribute is read-only.
>  
>  ``amd_pstate_lowest_nonlinear_freq``
> @@ -268,6 +269,12 @@ This attribute is read-only.
>  Whether the platform supports the preferred core feature and it has been
>  enabled. This attribute is read-only.
>  
> +``amd_pstate_prefcore_ranking``
> +
> +The performance ranking of the core. This number doesn't have any unit, but
> +larger numbers are preferred at the time of reading. This can change at
> +runtime based on platform conditions. This attribute is read-only.
> +
>  ``energy_performance_available_preferences``
>  
>  A list of all the supported EPP preferences that could be used for
> -- 
> 2.43.0
>