[v6,4/6] Documentation: amd_pstate: Move amd_pstate param to alphabetical order

Message ID 20230206172157.49887-5-wyes.karny@amd.com
State New
Headers
Series amd_pstate: Add guided autonomous mode support |

Commit Message

Wyes Karny Feb. 6, 2023, 5:21 p.m. UTC
  Move amd_pstate command line param description to correct alphabetical
order.

Signed-off-by: Wyes Karny <wyes.karny@amd.com>
Reviewed-by: Mario Limonciello <mario.limonciello@amd.com>
---
 .../admin-guide/kernel-parameters.txt         | 46 +++++++++----------
 1 file changed, 23 insertions(+), 23 deletions(-)
  

Comments

Huang Rui Feb. 16, 2023, 6:12 a.m. UTC | #1
On Tue, Feb 07, 2023 at 01:21:55AM +0800, Karny, Wyes wrote:
> Move amd_pstate command line param description to correct alphabetical
> order.
> 
> Signed-off-by: Wyes Karny <wyes.karny@amd.com>
> Reviewed-by: Mario Limonciello <mario.limonciello@amd.com>

Wyes, could you squeeze this minor patch to patch 3? I think we won't need
an additional patch to fix alphabetical order in the documentation.

Thanks,
Ray

> ---
>  .../admin-guide/kernel-parameters.txt         | 46 +++++++++----------
>  1 file changed, 23 insertions(+), 23 deletions(-)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 56d5c189e458..d7685b4268ba 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -339,6 +339,29 @@
>  			             This mode requires kvm-amd.avic=1.
>  			             (Default when IOMMU HW support is present.)
>  
> +	amd_pstate=	[X86]
> +			disable
> +			  Do not enable amd_pstate as the default
> +			  scaling driver for the supported processors
> +			passive
> +			  Use amd_pstate with passive mode as a scaling driver.
> +			  In this mode autonomous selection is disabled.
> +			  Driver requests a desired performance level and platform
> +			  tries to match the same performance level if it is
> +			  satisfied by guaranteed performance level.
> +			active
> +			  Use amd_pstate_epp driver instance as the scaling driver,
> +			  driver provides a hint to the hardware if software wants
> +			  to bias toward performance (0x0) or energy efficiency (0xff)
> +			  to the CPPC firmware. then CPPC power algorithm will
> +			  calculate the runtime workload and adjust the realtime cores
> +			  frequency.
> +			guided
> +			  Activate guided autonomous mode. Driver requests minimum and
> +			  maximum performance level and the platform autonomously
> +			  selects a performance level in this range and appropriate
> +			  to the current workload.
> +
>  	amijoy.map=	[HW,JOY] Amiga joystick support
>  			Map of devices attached to JOY0DAT and JOY1DAT
>  			Format: <a>,<b>
> @@ -7009,26 +7032,3 @@
>  				memory, and other data can't be written using
>  				xmon commands.
>  			off	xmon is disabled.
> -
> -	amd_pstate=	[X86]
> -			disable
> -			  Do not enable amd_pstate as the default
> -			  scaling driver for the supported processors
> -			passive
> -			  Use amd_pstate with passive mode as a scaling driver.
> -			  In this mode autonomous selection is disabled.
> -			  Driver requests a desired performance level and platform
> -			  tries to match the same performance level if it is
> -			  satisfied by guaranteed performance level.
> -			active
> -			  Use amd_pstate_epp driver instance as the scaling driver,
> -			  driver provides a hint to the hardware if software wants
> -			  to bias toward performance (0x0) or energy efficiency (0xff)
> -			  to the CPPC firmware. then CPPC power algorithm will
> -			  calculate the runtime workload and adjust the realtime cores
> -			  frequency.
> -			guided
> -			  Activate guided autonomous mode. Driver requests minimum and
> -			  maximum performance level and the platform autonomously
> -			  selects a performance level in this range and appropriate
> -			  to the current workload.
> -- 
> 2.34.1
>
  
Huang Rui Feb. 16, 2023, 6:33 a.m. UTC | #2
On Thu, Feb 16, 2023 at 02:12:53PM +0800, Huang Rui wrote:
> On Tue, Feb 07, 2023 at 01:21:55AM +0800, Karny, Wyes wrote:
> > Move amd_pstate command line param description to correct alphabetical
> > order.
> > 
> > Signed-off-by: Wyes Karny <wyes.karny@amd.com>
> > Reviewed-by: Mario Limonciello <mario.limonciello@amd.com>
> 
> Wyes, could you squeeze this minor patch to patch 3? I think we won't need
> an additional patch to fix alphabetical order in the documentation.

Alternative, you can move this patch prior patch3, then patch3 (guided
autonomous" can add the documentation in correct order.

Thanks,
Ray

> 
> Thanks,
> Ray
> 
> > ---
> >  .../admin-guide/kernel-parameters.txt         | 46 +++++++++----------
> >  1 file changed, 23 insertions(+), 23 deletions(-)
> > 
> > diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> > index 56d5c189e458..d7685b4268ba 100644
> > --- a/Documentation/admin-guide/kernel-parameters.txt
> > +++ b/Documentation/admin-guide/kernel-parameters.txt
> > @@ -339,6 +339,29 @@
> >  			             This mode requires kvm-amd.avic=1.
> >  			             (Default when IOMMU HW support is present.)
> >  
> > +	amd_pstate=	[X86]
> > +			disable
> > +			  Do not enable amd_pstate as the default
> > +			  scaling driver for the supported processors
> > +			passive
> > +			  Use amd_pstate with passive mode as a scaling driver.
> > +			  In this mode autonomous selection is disabled.
> > +			  Driver requests a desired performance level and platform
> > +			  tries to match the same performance level if it is
> > +			  satisfied by guaranteed performance level.
> > +			active
> > +			  Use amd_pstate_epp driver instance as the scaling driver,
> > +			  driver provides a hint to the hardware if software wants
> > +			  to bias toward performance (0x0) or energy efficiency (0xff)
> > +			  to the CPPC firmware. then CPPC power algorithm will
> > +			  calculate the runtime workload and adjust the realtime cores
> > +			  frequency.
> > +			guided
> > +			  Activate guided autonomous mode. Driver requests minimum and
> > +			  maximum performance level and the platform autonomously
> > +			  selects a performance level in this range and appropriate
> > +			  to the current workload.
> > +
> >  	amijoy.map=	[HW,JOY] Amiga joystick support
> >  			Map of devices attached to JOY0DAT and JOY1DAT
> >  			Format: <a>,<b>
> > @@ -7009,26 +7032,3 @@
> >  				memory, and other data can't be written using
> >  				xmon commands.
> >  			off	xmon is disabled.
> > -
> > -	amd_pstate=	[X86]
> > -			disable
> > -			  Do not enable amd_pstate as the default
> > -			  scaling driver for the supported processors
> > -			passive
> > -			  Use amd_pstate with passive mode as a scaling driver.
> > -			  In this mode autonomous selection is disabled.
> > -			  Driver requests a desired performance level and platform
> > -			  tries to match the same performance level if it is
> > -			  satisfied by guaranteed performance level.
> > -			active
> > -			  Use amd_pstate_epp driver instance as the scaling driver,
> > -			  driver provides a hint to the hardware if software wants
> > -			  to bias toward performance (0x0) or energy efficiency (0xff)
> > -			  to the CPPC firmware. then CPPC power algorithm will
> > -			  calculate the runtime workload and adjust the realtime cores
> > -			  frequency.
> > -			guided
> > -			  Activate guided autonomous mode. Driver requests minimum and
> > -			  maximum performance level and the platform autonomously
> > -			  selects a performance level in this range and appropriate
> > -			  to the current workload.
> > -- 
> > 2.34.1
> >
  
Wyes Karny Feb. 16, 2023, 6:44 a.m. UTC | #3
On 16 Feb 14:33, Huang Rui wrote:
> On Thu, Feb 16, 2023 at 02:12:53PM +0800, Huang Rui wrote:
> > On Tue, Feb 07, 2023 at 01:21:55AM +0800, Karny, Wyes wrote:
> > > Move amd_pstate command line param description to correct alphabetical
> > > order.
> > > 
> > > Signed-off-by: Wyes Karny <wyes.karny@amd.com>
> > > Reviewed-by: Mario Limonciello <mario.limonciello@amd.com>
> > 
> > Wyes, could you squeeze this minor patch to patch 3? I think we won't need
> > an additional patch to fix alphabetical order in the documentation.
> 
> Alternative, you can move this patch prior patch3, then patch3 (guided
> autonomous" can add the documentation in correct order.

Sure, will reorder this.

Thanks,
Wyes
> 
> Thanks,
> Ray
> 
> > 
> > Thanks,
> > Ray
> > 
> > > ---
> > >  .../admin-guide/kernel-parameters.txt         | 46 +++++++++----------
> > >  1 file changed, 23 insertions(+), 23 deletions(-)
> > > 
> > > diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> > > index 56d5c189e458..d7685b4268ba 100644
> > > --- a/Documentation/admin-guide/kernel-parameters.txt
> > > +++ b/Documentation/admin-guide/kernel-parameters.txt
> > > @@ -339,6 +339,29 @@
> > >  			             This mode requires kvm-amd.avic=1.
> > >  			             (Default when IOMMU HW support is present.)
> > >  
> > > +	amd_pstate=	[X86]
> > > +			disable
> > > +			  Do not enable amd_pstate as the default
> > > +			  scaling driver for the supported processors
> > > +			passive
> > > +			  Use amd_pstate with passive mode as a scaling driver.
> > > +			  In this mode autonomous selection is disabled.
> > > +			  Driver requests a desired performance level and platform
> > > +			  tries to match the same performance level if it is
> > > +			  satisfied by guaranteed performance level.
> > > +			active
> > > +			  Use amd_pstate_epp driver instance as the scaling driver,
> > > +			  driver provides a hint to the hardware if software wants
> > > +			  to bias toward performance (0x0) or energy efficiency (0xff)
> > > +			  to the CPPC firmware. then CPPC power algorithm will
> > > +			  calculate the runtime workload and adjust the realtime cores
> > > +			  frequency.
> > > +			guided
> > > +			  Activate guided autonomous mode. Driver requests minimum and
> > > +			  maximum performance level and the platform autonomously
> > > +			  selects a performance level in this range and appropriate
> > > +			  to the current workload.
> > > +
> > >  	amijoy.map=	[HW,JOY] Amiga joystick support
> > >  			Map of devices attached to JOY0DAT and JOY1DAT
> > >  			Format: <a>,<b>
> > > @@ -7009,26 +7032,3 @@
> > >  				memory, and other data can't be written using
> > >  				xmon commands.
> > >  			off	xmon is disabled.
> > > -
> > > -	amd_pstate=	[X86]
> > > -			disable
> > > -			  Do not enable amd_pstate as the default
> > > -			  scaling driver for the supported processors
> > > -			passive
> > > -			  Use amd_pstate with passive mode as a scaling driver.
> > > -			  In this mode autonomous selection is disabled.
> > > -			  Driver requests a desired performance level and platform
> > > -			  tries to match the same performance level if it is
> > > -			  satisfied by guaranteed performance level.
> > > -			active
> > > -			  Use amd_pstate_epp driver instance as the scaling driver,
> > > -			  driver provides a hint to the hardware if software wants
> > > -			  to bias toward performance (0x0) or energy efficiency (0xff)
> > > -			  to the CPPC firmware. then CPPC power algorithm will
> > > -			  calculate the runtime workload and adjust the realtime cores
> > > -			  frequency.
> > > -			guided
> > > -			  Activate guided autonomous mode. Driver requests minimum and
> > > -			  maximum performance level and the platform autonomously
> > > -			  selects a performance level in this range and appropriate
> > > -			  to the current workload.
> > > -- 
> > > 2.34.1
> > >
  

Patch

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 56d5c189e458..d7685b4268ba 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -339,6 +339,29 @@ 
 			             This mode requires kvm-amd.avic=1.
 			             (Default when IOMMU HW support is present.)
 
+	amd_pstate=	[X86]
+			disable
+			  Do not enable amd_pstate as the default
+			  scaling driver for the supported processors
+			passive
+			  Use amd_pstate with passive mode as a scaling driver.
+			  In this mode autonomous selection is disabled.
+			  Driver requests a desired performance level and platform
+			  tries to match the same performance level if it is
+			  satisfied by guaranteed performance level.
+			active
+			  Use amd_pstate_epp driver instance as the scaling driver,
+			  driver provides a hint to the hardware if software wants
+			  to bias toward performance (0x0) or energy efficiency (0xff)
+			  to the CPPC firmware. then CPPC power algorithm will
+			  calculate the runtime workload and adjust the realtime cores
+			  frequency.
+			guided
+			  Activate guided autonomous mode. Driver requests minimum and
+			  maximum performance level and the platform autonomously
+			  selects a performance level in this range and appropriate
+			  to the current workload.
+
 	amijoy.map=	[HW,JOY] Amiga joystick support
 			Map of devices attached to JOY0DAT and JOY1DAT
 			Format: <a>,<b>
@@ -7009,26 +7032,3 @@ 
 				memory, and other data can't be written using
 				xmon commands.
 			off	xmon is disabled.
-
-	amd_pstate=	[X86]
-			disable
-			  Do not enable amd_pstate as the default
-			  scaling driver for the supported processors
-			passive
-			  Use amd_pstate with passive mode as a scaling driver.
-			  In this mode autonomous selection is disabled.
-			  Driver requests a desired performance level and platform
-			  tries to match the same performance level if it is
-			  satisfied by guaranteed performance level.
-			active
-			  Use amd_pstate_epp driver instance as the scaling driver,
-			  driver provides a hint to the hardware if software wants
-			  to bias toward performance (0x0) or energy efficiency (0xff)
-			  to the CPPC firmware. then CPPC power algorithm will
-			  calculate the runtime workload and adjust the realtime cores
-			  frequency.
-			guided
-			  Activate guided autonomous mode. Driver requests minimum and
-			  maximum performance level and the platform autonomously
-			  selects a performance level in this range and appropriate
-			  to the current workload.