diff mbox

[v4,11/18] dt-bindings: power: supply: add AXP20X/AXP22X battery DT binding

Message ID 20170315105537.22349-12-quentin.schulz@free-electrons.com (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

Quentin Schulz March 15, 2017, 10:55 a.m. UTC
The X-Powers AXP20X and AXP22X PMICs can have a battery as power supply.

This patch adds the DT binding documentation for the battery power
supply which gets various data from the PMIC, such as the battery status
(charging, discharging, full, dead), current max limit, current current,
battery capacity (in percentage), voltage max and min limits, current
voltage and battery capacity (in Ah).

Signed-off-by: Quentin Schulz <quentin.schulz@free-electrons.com>
Acked-by: Chen-Yu Tsai <wens@csie.org>
Acked-by: Maxime Ripard <maxime.ripard@free-electrons.com>
---

v4:
 - added monitored-battery optional property,
 - added example with battery,

v3:
 - removed constant charge current property, now should use the WIP
 battery framework,

v2:
 - changed DT node name from ac_power_supply to ac-power-supply,
 - removed io-channels and io-channel-names from DT (the IIO mapping is
 done in the IIO ADC driver now),
 - added x-powers,constant-charge-current property to set the maximal
 default constant current charge of the battery,
 .../bindings/power/supply/axp20x_battery.txt       | 30 ++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/axp20x_battery.txt

Comments

Sebastian Reichel March 15, 2017, 10:28 p.m. UTC | #1
Hi,

On Wed, Mar 15, 2017 at 11:55:30AM +0100, Quentin Schulz wrote:
> The X-Powers AXP20X and AXP22X PMICs can have a battery as power supply.
> 
> This patch adds the DT binding documentation for the battery power
> supply which gets various data from the PMIC, such as the battery status
> (charging, discharging, full, dead), current max limit, current current,
> battery capacity (in percentage), voltage max and min limits, current
> voltage and battery capacity (in Ah).
> 
> Signed-off-by: Quentin Schulz <quentin.schulz@free-electrons.com>
> Acked-by: Chen-Yu Tsai <wens@csie.org>
> Acked-by: Maxime Ripard <maxime.ripard@free-electrons.com>

I suggest to do "s/battery-power-supply/battery-fuel-gauge/g"

> ---
> 
> v4:
>  - added monitored-battery optional property,
>  - added example with battery,
> 
> v3:
>  - removed constant charge current property, now should use the WIP
>  battery framework,
> 
> v2:
>  - changed DT node name from ac_power_supply to ac-power-supply,

ac-power-supply?

-- Sebastian

>  - removed io-channels and io-channel-names from DT (the IIO mapping is
>  done in the IIO ADC driver now),
>  - added x-powers,constant-charge-current property to set the maximal
>  default constant current charge of the battery,
>  .../bindings/power/supply/axp20x_battery.txt       | 30 ++++++++++++++++++++++
>  1 file changed, 30 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
> 
> diff --git a/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt b/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
> new file mode 100644
> index 0000000..89cb7a2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
> @@ -0,0 +1,30 @@
> +AXP20x and AXP22x battery power supply
> +
> +Required Properties:
> + - compatible, one of:
> +			"x-powers,axp209-battery-power-supply"
> +			"x-powers,axp221-battery-power-supply"
> +
> +Optional properties:
> + - monitored-battery, phandle to a fixed battery
> +
> +This node is a subnode of the axp20x/axp22x PMIC.
> +
> +The AXP20X and AXP22X can read the battery voltage, charge and discharge
> +currents of the battery by reading ADC channels from the AXP20X/AXP22X
> +ADC.
> +
> +Example:
> +
> +battery: battery {
> +	compatible = "fixed-battery";
> +	voltage-min-design-microvolt = <3200000>;
> +	constant-charge-microamp = <300000>;
> +};
> +
> +&axp209 {
> +	battery_power_supply: battery-power-supply {
> +		compatible = "x-powers,axp209-battery-power-supply";
> +		monitored-battery = <&battery>;
> +	}
> +};
> -- 
> 2.9.3
>
Quentin Schulz March 15, 2017, 10:41 p.m. UTC | #2
Hi,

On 15/03/2017 23:28, Sebastian Reichel wrote:
> Hi,
> 
> On Wed, Mar 15, 2017 at 11:55:30AM +0100, Quentin Schulz wrote:
>> The X-Powers AXP20X and AXP22X PMICs can have a battery as power supply.
>>
>> This patch adds the DT binding documentation for the battery power
>> supply which gets various data from the PMIC, such as the battery status
>> (charging, discharging, full, dead), current max limit, current current,
>> battery capacity (in percentage), voltage max and min limits, current
>> voltage and battery capacity (in Ah).
>>
>> Signed-off-by: Quentin Schulz <quentin.schulz@free-electrons.com>
>> Acked-by: Chen-Yu Tsai <wens@csie.org>
>> Acked-by: Maxime Ripard <maxime.ripard@free-electrons.com>
> 
> I suggest to do "s/battery-power-supply/battery-fuel-gauge/g"
> 

The IP is way more than a simple fuel gauge, you have info about the
voltage, current, you can set different things, even though you have the
percentage of the battery returned by the PMIC.

Does it really make sense to rename it that way?

Thanks,
Quentin

>> ---
>>
>> v4:
>>  - added monitored-battery optional property,
>>  - added example with battery,
>>
>> v3:
>>  - removed constant charge current property, now should use the WIP
>>  battery framework,
>>
>> v2:
>>  - changed DT node name from ac_power_supply to ac-power-supply,
> 
> ac-power-supply?
> 
> -- Sebastian
> 
>>  - removed io-channels and io-channel-names from DT (the IIO mapping is
>>  done in the IIO ADC driver now),
>>  - added x-powers,constant-charge-current property to set the maximal
>>  default constant current charge of the battery,
>>  .../bindings/power/supply/axp20x_battery.txt       | 30 ++++++++++++++++++++++
>>  1 file changed, 30 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
>>
>> diff --git a/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt b/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
>> new file mode 100644
>> index 0000000..89cb7a2
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
>> @@ -0,0 +1,30 @@
>> +AXP20x and AXP22x battery power supply
>> +
>> +Required Properties:
>> + - compatible, one of:
>> +			"x-powers,axp209-battery-power-supply"
>> +			"x-powers,axp221-battery-power-supply"
>> +
>> +Optional properties:
>> + - monitored-battery, phandle to a fixed battery
>> +
>> +This node is a subnode of the axp20x/axp22x PMIC.
>> +
>> +The AXP20X and AXP22X can read the battery voltage, charge and discharge
>> +currents of the battery by reading ADC channels from the AXP20X/AXP22X
>> +ADC.
>> +
>> +Example:
>> +
>> +battery: battery {
>> +	compatible = "fixed-battery";
>> +	voltage-min-design-microvolt = <3200000>;
>> +	constant-charge-microamp = <300000>;
>> +};
>> +
>> +&axp209 {
>> +	battery_power_supply: battery-power-supply {
>> +		compatible = "x-powers,axp209-battery-power-supply";
>> +		monitored-battery = <&battery>;
>> +	}
>> +};
>> -- 
>> 2.9.3
>>
>>
>>
>> _______________________________________________
>> linux-arm-kernel mailing list
>> linux-arm-kernel@lists.infradead.org
>> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Sebastian Reichel March 15, 2017, 11:02 p.m. UTC | #3
Hi,

On Wed, Mar 15, 2017 at 11:41:07PM +0100, Quentin Schulz wrote:
> Hi,
> 
> On 15/03/2017 23:28, Sebastian Reichel wrote:
> > Hi,
> > 
> > On Wed, Mar 15, 2017 at 11:55:30AM +0100, Quentin Schulz wrote:
> >> The X-Powers AXP20X and AXP22X PMICs can have a battery as power supply.
> >>
> >> This patch adds the DT binding documentation for the battery power
> >> supply which gets various data from the PMIC, such as the battery status
> >> (charging, discharging, full, dead), current max limit, current current,
> >> battery capacity (in percentage), voltage max and min limits, current
> >> voltage and battery capacity (in Ah).
> >>
> >> Signed-off-by: Quentin Schulz <quentin.schulz@free-electrons.com>
> >> Acked-by: Chen-Yu Tsai <wens@csie.org>
> >> Acked-by: Maxime Ripard <maxime.ripard@free-electrons.com>
> > 
> > I suggest to do "s/battery-power-supply/battery-fuel-gauge/g"
> > 
> 
> The IP is way more than a simple fuel gauge, you have info about the
> voltage, current, you can set different things, even though you have the
> percentage of the battery returned by the PMIC.

Most chips sold under the label battery-fuel-gauges actually give
you that kind of information ;)

> Does it really make sense to rename it that way?

If everybody is fine with it I don't mind too much.

-- Sebastian
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt b/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
new file mode 100644
index 0000000..89cb7a2
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/axp20x_battery.txt
@@ -0,0 +1,30 @@ 
+AXP20x and AXP22x battery power supply
+
+Required Properties:
+ - compatible, one of:
+			"x-powers,axp209-battery-power-supply"
+			"x-powers,axp221-battery-power-supply"
+
+Optional properties:
+ - monitored-battery, phandle to a fixed battery
+
+This node is a subnode of the axp20x/axp22x PMIC.
+
+The AXP20X and AXP22X can read the battery voltage, charge and discharge
+currents of the battery by reading ADC channels from the AXP20X/AXP22X
+ADC.
+
+Example:
+
+battery: battery {
+	compatible = "fixed-battery";
+	voltage-min-design-microvolt = <3200000>;
+	constant-charge-microamp = <300000>;
+};
+
+&axp209 {
+	battery_power_supply: battery-power-supply {
+		compatible = "x-powers,axp209-battery-power-supply";
+		monitored-battery = <&battery>;
+	}
+};