[PATCH] scsi: docs: Add description for missing options of link_power_management_policy

[PATCH] scsi: docs: Add description for missing options of link_power_management_policy

[Yiwei Lin]

With the kernel update we have more different policy for SCSI
link power management. Add the corresponding description to
the file.

Signed-off-by: Yiwei Lin <s921975628@gmail.com>
---
 .../scsi/link_power_management_policy.rst       | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/Documentation/scsi/link_power_management_policy.rst b/Documentation/scsi/link_power_management_policy.rst
index 64288dcf1..07fbfd937 100644
--- a/Documentation/scsi/link_power_management_policy.rst
+++ b/Documentation/scsi/link_power_management_policy.rst
@@ -5,13 +5,13 @@ Link Power Managent Policy
 ==========================
 
 This parameter allows the user to set the link (interface) power management.
-There are 3 possible options:
+There are 6 possible options:
 
 =====================   =====================================================
 Value			Effect
 =====================   =====================================================
-min_power		Tell the controller to try to make the link use the
-			least possible power when possible.  This may
+min_power		Enable slumber mode(no partial mode) for the link to
+			use the least possible power when possible.  This may
 			sacrifice some performance due to increased latency
 			when coming out of lower power states.
 
@@ -22,4 +22,15 @@ max_performance		Generally, this means no power management.  Tell
 medium_power		Tell the controller to enter a lower power state
 			when possible, but do not enter the lowest power
 			state, thus improving latency over min_power setting.
+
+keep_firmware_settings	Do not change the current firmware settings for
+			Power management. This is the default setting.
+
+med_power_with_dipm	Same as medium_power, but additionally with
+			Device-initiated power management(DIPM) enabled,
+			as Intel Rapid Storage Technology(IRST) does.
+
+min_power_with_partial	Same as min_power, but additionally with partial
+			power state enabled, which may improve performance
+			over min_power setting.
 =====================   =====================================================
-- 
2.34.1

Re: [PATCH] scsi: docs: Add description for missing options of link_power_management_policy

[Randy Dunlap]

Hi,

On 1/14/26 7:29 PM, Yiwei Lin wrote:
> With the kernel update we have more different policy for SCSI
> link power management. Add the corresponding description to
> the file.
> 
> Signed-off-by: Yiwei Lin <s921975628@gmail.com>
> ---
>  .../scsi/link_power_management_policy.rst       | 17 ++++++++++++++---
>  1 file changed, 14 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/scsi/link_power_management_policy.rst b/Documentation/scsi/link_power_management_policy.rst
> index 64288dcf1..07fbfd937 100644
> --- a/Documentation/scsi/link_power_management_policy.rst
> +++ b/Documentation/scsi/link_power_management_policy.rst
> @@ -5,13 +5,13 @@ Link Power Managent Policy
>  ==========================
>  
>  This parameter allows the user to set the link (interface) power management.
> -There are 3 possible options:
> +There are 6 possible options:
>  

These table headings lines (the ===== lines) need to be as long or longer than
the text. keep_firmware_settings and min_power_with_partial are longer than the
headings ===== line.
Please extend the Value column headings ===== line by one character (just
replace a space by '=') to avoid these warnings:

Documentation/scsi/link_power_management_policy.rst:26: ERROR: Malformed table.
Text in column margin in table line 17.


>  =====================   =====================================================
>  Value			Effect
>  =====================   =====================================================
> -min_power		Tell the controller to try to make the link use the
> -			least possible power when possible.  This may
> +min_power		Enable slumber mode(no partial mode) for the link to
> +			use the least possible power when possible.  This may
>  			sacrifice some performance due to increased latency
>  			when coming out of lower power states.
>  
> @@ -22,4 +22,15 @@ max_performance		Generally, this means no power management.  Tell
>  medium_power		Tell the controller to enter a lower power state
>  			when possible, but do not enter the lowest power
>  			state, thus improving latency over min_power setting.
> +
> +keep_firmware_settings	Do not change the current firmware settings for
> +			Power management. This is the default setting.
> +
> +med_power_with_dipm	Same as medium_power, but additionally with
> +			Device-initiated power management(DIPM) enabled,
> +			as Intel Rapid Storage Technology(IRST) does.
> +
> +min_power_with_partial	Same as min_power, but additionally with partial
> +			power state enabled, which may improve performance
> +			over min_power setting.
>  =====================   =====================================================

-- 
~Randy

Re: [PATCH] scsi: docs: Add description for missing options of link_power_management_policy

[Yiwei Lin]

On 1/15/2026 2:34 PM, Randy Dunlap wrote:
> Hi,
>
> On 1/14/26 7:29 PM, Yiwei Lin wrote:
>> With the kernel update we have more different policy for SCSI
>> link power management. Add the corresponding description to
>> the file.
>>
>> Signed-off-by: Yiwei Lin <s921975628@gmail.com>
>> ---
>>   .../scsi/link_power_management_policy.rst       | 17 ++++++++++++++---
>>   1 file changed, 14 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/scsi/link_power_management_policy.rst b/Documentation/scsi/link_power_management_policy.rst
>> index 64288dcf1..07fbfd937 100644
>> --- a/Documentation/scsi/link_power_management_policy.rst
>> +++ b/Documentation/scsi/link_power_management_policy.rst
>> @@ -5,13 +5,13 @@ Link Power Managent Policy
>>   ==========================
>>   
>>   This parameter allows the user to set the link (interface) power management.
>> -There are 3 possible options:
>> +There are 6 possible options:
>>   
> These table headings lines (the ===== lines) need to be as long or longer than
> the text. keep_firmware_settings and min_power_with_partial are longer than the
> headings ===== line.
> Please extend the Value column headings ===== line by one character (just
> replace a space by '=') to avoid these warnings:
>
> Documentation/scsi/link_power_management_policy.rst:26: ERROR: Malformed table.
> Text in column margin in table line 17.
>
Thanks for pointing that out. I just sent a V2 patch for the fix.
>>   =====================   =====================================================
>>   Value			Effect
>>   =====================   =====================================================
>> -min_power		Tell the controller to try to make the link use the
>> -			least possible power when possible.  This may
>> +min_power		Enable slumber mode(no partial mode) for the link to
>> +			use the least possible power when possible.  This may
>>   			sacrifice some performance due to increased latency
>>   			when coming out of lower power states.
>>   
>> @@ -22,4 +22,15 @@ max_performance		Generally, this means no power management.  Tell
>>   medium_power		Tell the controller to enter a lower power state
>>   			when possible, but do not enter the lowest power
>>   			state, thus improving latency over min_power setting.
>> +
>> +keep_firmware_settings	Do not change the current firmware settings for
>> +			Power management. This is the default setting.
>> +
>> +med_power_with_dipm	Same as medium_power, but additionally with
>> +			Device-initiated power management(DIPM) enabled,
>> +			as Intel Rapid Storage Technology(IRST) does.
>> +
>> +min_power_with_partial	Same as min_power, but additionally with partial
>> +			power state enabled, which may improve performance
>> +			over min_power setting.
>>   =====================   =====================================================