[v3,6/6] Documentation: amd_pstate: Update amd_pstate status sysfs for guided

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

Commit Message

Wyes Karny Jan. 19, 2023, 11:50 a.m. UTC
  Update amd_pstate status sysfs for guided mode.

Signed-off-by: Wyes Karny <wyes.karny@amd.com>
---
 Documentation/admin-guide/pm/amd-pstate.rst | 32 ++++++++++++++++-----
 1 file changed, 25 insertions(+), 7 deletions(-)
  

Comments

Bagas Sanjaya Jan. 19, 2023, 12:30 p.m. UTC | #1
On 1/19/23 18:50, Wyes Karny wrote:
> +- In autonomous mode, platform ignores the desired performance level request
> +  and takes into account only the values set to the Minimum requested
> +  performance, Maximum requested performance and Energy Performance Preference
> +  registers.

"minimum, maximum, and energy performance registers."

> +- In non-autonomous mode, platform gets desired performance level
> +  from OS directly through Desired Performance Register.
> +- In guided-autonomous mode, platform sets operating performance level
> +  autonomously according to the current workload and within the limits set by
> +  OS through min and max performance registers.
>  

The rest is LGTM.
  
Wyes Karny Jan. 20, 2023, 4:16 a.m. UTC | #2
On 1/19/2023 6:00 PM, Bagas Sanjaya wrote:
> On 1/19/23 18:50, Wyes Karny wrote:
>> +- In autonomous mode, platform ignores the desired performance level request
>> +  and takes into account only the values set to the Minimum requested
>> +  performance, Maximum requested performance and Energy Performance Preference
>> +  registers.
> 
> "minimum, maximum, and energy performance registers."

Thanks for reviewing! Will update.

> 
>> +- In non-autonomous mode, platform gets desired performance level
>> +  from OS directly through Desired Performance Register.
>> +- In guided-autonomous mode, platform sets operating performance level
>> +  autonomously according to the current workload and within the limits set by
>> +  OS through min and max performance registers.
>>  
> 
> The rest is LGTM.
>
  

Patch

diff --git a/Documentation/admin-guide/pm/amd-pstate.rst b/Documentation/admin-guide/pm/amd-pstate.rst
index 5304adf2fc2f..d85a141109e5 100644
--- a/Documentation/admin-guide/pm/amd-pstate.rst
+++ b/Documentation/admin-guide/pm/amd-pstate.rst
@@ -303,13 +303,19 @@  efficiency frequency management method on AMD processors.
 AMD Pstate Driver Operation Modes
 =================================
 
-``amd_pstate`` CPPC has two operation modes: CPPC Autonomous(active) mode and
-CPPC non-autonomous(passive) mode.
-active mode and passive mode can be chosen by different kernel parameters.
-When in Autonomous mode, CPPC ignores requests done in the Desired Performance
-Target register and takes into account only the values set to the Minimum requested
-performance, Maximum requested performance, and Energy Performance Preference
-registers. When Autonomous is disabled, it only considers the Desired Performance Target.
+``amd_pstate`` CPPC has 3 operation modes: autonomous (active) mode,
+non-autonomous (passive) mode and guided autonomous (guided) mode.
+Active/passive/guided mode can be chosen by different kernel parameters.
+
+- In autonomous mode, platform ignores the desired performance level request
+  and takes into account only the values set to the Minimum requested
+  performance, Maximum requested performance and Energy Performance Preference
+  registers.
+- In non-autonomous mode, platform gets desired performance level
+  from OS directly through Desired Performance Register.
+- In guided-autonomous mode, platform sets operating performance level
+  autonomously according to the current workload and within the limits set by
+  OS through min and max performance registers.
 
 Active Mode
 ------------
@@ -338,6 +344,15 @@  to the Performance Reduction Tolerance register. Above the nominal performance l
 processor must provide at least nominal performance requested and go higher if current
 operating conditions allow.
 
+Guided Mode
+-----------
+
+``amd_pstate=guided``
+
+If ``amd_pstate=guided`` is passed to kernel command line option then this mode
+is activated.  In this 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.
 
 User Space Interface in ``sysfs``
 =================================
@@ -358,6 +373,9 @@  control its functionality at the system level.  They are located in the
 	"passive"
 		The driver is functional and in the ``passive mode``
 
+        "guided"
+                The driver is functional and in the ``guided mode``
+
 	"disable"
 		The driver is unregistered and not functional now.