mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] power: supply: Fix power limit documentation
@ 2026-08-21 15:39 Daniel Lezcano
  2026-09-09 21:33 ` Sebastian Reichel
  0 siblings, 1 reply; 3+ messages in thread
From: Daniel Lezcano @ 2026-08-21 15:39 UTC (permalink / raw)
  To: Sebastian Reichel
  Cc: Daniel Lezcano,
	open list:POWER SUPPLY CLASS/SUBSYSTEM and DRIVERS, open list

The documentation for the input current and voltage limits recommends
using those properties for problems that can be solved using a power
limit. This contradicts the recommendation to prefer input_power_limit
for such cases.

Similarly, the input_power_limit documentation recommends using the
current or voltage limits for problems that can be solved with a power
limit, which conveys the opposite of the intended meaning.

Fix the wording to clarify that input_power_limit should be preferred
whenever a power limit can address the problem, while current or
voltage limits should be used when it cannot.

Signed-off-by: Daniel Lezcano <daniel.lezcano@oss.qualcomm.com>
Signed-off-by: Daniel Lezcano <daniel.lezcano@kernel.org>
---
 Documentation/ABI/testing/sysfs-class-power | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
index 32697b926cc8..f0ef87d365dd 100644
--- a/Documentation/ABI/testing/sysfs-class-power
+++ b/Documentation/ABI/testing/sysfs-class-power
@@ -600,8 +600,8 @@ Description:
 		supply. Normally this is configured based on the type of
 		connection made (e.g. A configured SDP should output a maximum
 		of 500mA so the input current limit is set to the same value).
-		Use preferably input_power_limit, and for problems that can be
-		solved using power limit use input_current_limit.
+		Use preferably input_power_limit, and for problems that can not
+		be solved using power limit use input_current_limit.
 
 		Access: Read, Write
 
@@ -618,8 +618,8 @@ Description:
 		input power to 5V when the screen is on to meet Google's skin
 		temperature targets). Note that this feature should not be
 		used for safety critical things.
-		Use preferably input_power_limit, and for problems that can be
-		solved using power limit use input_voltage_limit.
+		Use preferably input_power_limit, and for problems that can not
+		be solved using power limit use input_voltage_limit.
 
 		Access: Read, Write
 
@@ -633,7 +633,7 @@ Description:
 		in the supply. Normally this is configured based on
 		system-level knowledge or user input. Use preferably this
 		feature to limit the incoming power and use current/voltage
-		limit only for problems that can be solved using power limit.
+		limit only for problems that can not be solved using power limit.
 
 		Access: Read, Write
 
-- 
2.43.0


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] power: supply: Fix power limit documentation
  2026-08-21 15:39 [PATCH] power: supply: Fix power limit documentation Daniel Lezcano
@ 2026-09-09 21:33 ` Sebastian Reichel
  2026-09-11 12:06   ` Daniel Lezcano
  0 siblings, 1 reply; 3+ messages in thread
From: Sebastian Reichel @ 2026-09-09 21:33 UTC (permalink / raw)
  To: Daniel Lezcano
  Cc: Daniel Lezcano,
	open list:POWER SUPPLY CLASS/SUBSYSTEM and DRIVERS, open list

[-- Attachment #1: Type: text/plain, Size: 2744 bytes --]

Hi,

On Fri, Aug 21, 2026 at 05:39:49PM +0200, Daniel Lezcano wrote:
> The documentation for the input current and voltage limits recommends
> using those properties for problems that can be solved using a power
> limit. This contradicts the recommendation to prefer input_power_limit
> for such cases.
> 
> Similarly, the input_power_limit documentation recommends using the
> current or voltage limits for problems that can be solved with a power
> limit, which conveys the opposite of the intended meaning.
> 
> Fix the wording to clarify that input_power_limit should be preferred
> whenever a power limit can address the problem, while current or
> voltage limits should be used when it cannot.

Patch LGTM.

> Signed-off-by: Daniel Lezcano <daniel.lezcano@oss.qualcomm.com>
> Signed-off-by: Daniel Lezcano <daniel.lezcano@kernel.org>

Is this intentional?

Greetings,

-- Sebastian

> ---
>  Documentation/ABI/testing/sysfs-class-power | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
> index 32697b926cc8..f0ef87d365dd 100644
> --- a/Documentation/ABI/testing/sysfs-class-power
> +++ b/Documentation/ABI/testing/sysfs-class-power
> @@ -600,8 +600,8 @@ Description:
>  		supply. Normally this is configured based on the type of
>  		connection made (e.g. A configured SDP should output a maximum
>  		of 500mA so the input current limit is set to the same value).
> -		Use preferably input_power_limit, and for problems that can be
> -		solved using power limit use input_current_limit.
> +		Use preferably input_power_limit, and for problems that can not
> +		be solved using power limit use input_current_limit.
>  
>  		Access: Read, Write
>  
> @@ -618,8 +618,8 @@ Description:
>  		input power to 5V when the screen is on to meet Google's skin
>  		temperature targets). Note that this feature should not be
>  		used for safety critical things.
> -		Use preferably input_power_limit, and for problems that can be
> -		solved using power limit use input_voltage_limit.
> +		Use preferably input_power_limit, and for problems that can not
> +		be solved using power limit use input_voltage_limit.
>  
>  		Access: Read, Write
>  
> @@ -633,7 +633,7 @@ Description:
>  		in the supply. Normally this is configured based on
>  		system-level knowledge or user input. Use preferably this
>  		feature to limit the incoming power and use current/voltage
> -		limit only for problems that can be solved using power limit.
> +		limit only for problems that can not be solved using power limit.
>  
>  		Access: Read, Write
>  
> -- 
> 2.43.0
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] power: supply: Fix power limit documentation
  2026-09-09 21:33 ` Sebastian Reichel
@ 2026-09-11 12:06   ` Daniel Lezcano
  0 siblings, 0 replies; 3+ messages in thread
From: Daniel Lezcano @ 2026-09-11 12:06 UTC (permalink / raw)
  To: Sebastian Reichel
  Cc: Daniel Lezcano,
	open list:POWER SUPPLY CLASS/SUBSYSTEM and DRIVERS, open list

On 9/9/26 23:33, Sebastian Reichel wrote:
> Hi,
> 
> On Fri, Aug 21, 2026 at 05:39:49PM +0200, Daniel Lezcano wrote:
>> The documentation for the input current and voltage limits recommends
>> using those properties for problems that can be solved using a power
>> limit. This contradicts the recommendation to prefer input_power_limit
>> for such cases.
>>
>> Similarly, the input_power_limit documentation recommends using the
>> current or voltage limits for problems that can be solved with a power
>> limit, which conveys the opposite of the intended meaning.
>>
>> Fix the wording to clarify that input_power_limit should be preferred
>> whenever a power limit can address the problem, while current or
>> voltage limits should be used when it cannot.
> 
> Patch LGTM.
> 
>> Signed-off-by: Daniel Lezcano <daniel.lezcano@oss.qualcomm.com>
>> Signed-off-by: Daniel Lezcano <daniel.lezcano@kernel.org>
> 
> Is this intentional?
No, my scripts again ...

Do you want me to resend or can you delete the kernel.org one ?

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-09-11 12:06 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-08-21 15:39 [PATCH] power: supply: Fix power limit documentation Daniel Lezcano
2026-09-09 21:33 ` Sebastian Reichel
2026-09-11 12:06   ` Daniel Lezcano

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®