diff mbox series

[v5,3/3] power_supply: Add missing documentation for CHARGE_CONTROL_* properties

Message ID 20190418164314.161065-3-ncrews@chromium.org (mailing list archive)
State Not Applicable, archived
Headers show
Series [v5,1/3] power_supply: Add Standard, Adaptive, and Custom charge types | expand

Commit Message

Nick Crews April 18, 2019, 4:43 p.m. UTC
The existing POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT and
POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX properties
don't have documentation. I add that documentation here.

v5 changes:
- Split this commit out from the previous two commits.

Signed-off-by: Nick Crews <ncrews@chromium.org>
---
 Documentation/ABI/testing/sysfs-class-power | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Comments

Enric Balletbo i Serra April 23, 2019, 1:56 p.m. UTC | #1
On 18/4/19 18:43, Nick Crews wrote:
> The existing POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT and
> POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX properties
> don't have documentation. I add that documentation here.
> 
> v5 changes:
> - Split this commit out from the previous two commits.
> 
> Signed-off-by: Nick Crews <ncrews@chromium.org>

Reviewed-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>

> ---
>  Documentation/ABI/testing/sysfs-class-power | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
> index a5b144f61de8..b77e30b9014e 100644
> --- a/Documentation/ABI/testing/sysfs-class-power
> +++ b/Documentation/ABI/testing/sysfs-class-power
> @@ -114,6 +114,25 @@ Description:
>  		Access: Read
>  		Valid values: Represented in microamps
>  
> +What:		/sys/class/power_supply/<supply_name>/charge_control_limit
> +Date:		Oct 2012
> +Contact:	linux-pm@vger.kernel.org
> +Description:
> +		Maximum allowable charging current. Used for charge rate
> +		throttling for thermal cooling or improving battery health.
> +
> +		Access: Read, Write
> +		Valid values: Represented in microamps
> +
> +What:		/sys/class/power_supply/<supply_name>/charge_control_limit_max
> +Date:		Oct 2012
> +Contact:	linux-pm@vger.kernel.org
> +Description:
> +		Maximum legal value for the charge_control_limit property.
> +
> +		Access: Read
> +		Valid values: Represented in microamps
> +
>  What:		/sys/class/power_supply/<supply_name>/charge_control_start_threshold
>  Date:		April 2019
>  Contact:	linux-pm@vger.kernel.org
>
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-power b/Documentation/ABI/testing/sysfs-class-power
index a5b144f61de8..b77e30b9014e 100644
--- a/Documentation/ABI/testing/sysfs-class-power
+++ b/Documentation/ABI/testing/sysfs-class-power
@@ -114,6 +114,25 @@  Description:
 		Access: Read
 		Valid values: Represented in microamps
 
+What:		/sys/class/power_supply/<supply_name>/charge_control_limit
+Date:		Oct 2012
+Contact:	linux-pm@vger.kernel.org
+Description:
+		Maximum allowable charging current. Used for charge rate
+		throttling for thermal cooling or improving battery health.
+
+		Access: Read, Write
+		Valid values: Represented in microamps
+
+What:		/sys/class/power_supply/<supply_name>/charge_control_limit_max
+Date:		Oct 2012
+Contact:	linux-pm@vger.kernel.org
+Description:
+		Maximum legal value for the charge_control_limit property.
+
+		Access: Read
+		Valid values: Represented in microamps
+
 What:		/sys/class/power_supply/<supply_name>/charge_control_start_threshold
 Date:		April 2019
 Contact:	linux-pm@vger.kernel.org