diff mbox

dt-bindings: power: New bindings for ltc3651-charger

Message ID 1493966315-15893-1-git-send-email-mike.looijmans@topic.nl (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

Mike Looijmans May 5, 2017, 6:38 a.m. UTC
This adds the devicetree bindings documentation for the LTC3651 battery charger.

Signed-off-by: Mike Looijmans <mike.looijmans@topic.nl>
---
 .../bindings/power/supply/ltc3651-charger.txt      | 26 ++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt

Comments

Rob Herring (Arm) May 8, 2017, 5:12 p.m. UTC | #1
On Fri, May 05, 2017 at 08:38:35AM +0200, Mike Looijmans wrote:
> This adds the devicetree bindings documentation for the LTC3651 battery charger.
> 
> Signed-off-by: Mike Looijmans <mike.looijmans@topic.nl>
> ---
>  .../bindings/power/supply/ltc3651-charger.txt      | 26 ++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
> 
> diff --git a/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt b/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
> new file mode 100644
> index 0000000..a7dd80f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
> @@ -0,0 +1,26 @@
> +ltc3651-charger
> +
> +Required properties:
> + - compatible: "lltc,ltc3651-charger"
> + - acpr-gpios: Connect to ACPR output. See remark below.
> +
> +Optional properties:
> + - fault-gpios: Connect to FAULT output. See remark below.
> + - chrg-gpios: Connect to CHRG output. See remark below.

All the gpios need vendor prefix.

> +
> +The ltc3651 outputs are open-drain type and active low. The driver assumes the
> +GPIO reports "active" when the output is asserted, so if the pins have been
> +connected directly, the GPIO flags should be set to active low also.
> +
> +The driver will attempt to aquire interrupts for all GPIOs. If the system is
> +not capabale of providing that, the driver cannot report changes and userspace
> +will need to periodically read the sysfs attributes to detect changes.

If these are interrupts, then you should use the interrupt binding 
instead (most GPIO controllers are also interrupt controllers).

> +
> +Example:
> +
> +	charger: battery-charger {
> +		compatible = "lltc,ltc3651-charger";
> +		acpr-gpios = <&gpio0 68 GPIO_ACTIVE_LOW>;
> +		fault-gpios = <&gpio0 64 GPIO_ACTIVE_LOW>;
> +		chrg-gpios = <&gpio0 63 GPIO_ACTIVE_LOW>;
> +	};
> -- 
> 1.9.1
>
Mike Looijmans May 9, 2017, 5:26 a.m. UTC | #2
On 08-05-17 19:12, Rob Herring wrote:
> On Fri, May 05, 2017 at 08:38:35AM +0200, Mike Looijmans wrote:
>> This adds the devicetree bindings documentation for the LTC3651 battery charger.
>>
>> Signed-off-by: Mike Looijmans <mike.looijmans@topic.nl>
>> ---
>>  .../bindings/power/supply/ltc3651-charger.txt      | 26 ++++++++++++++++++++++
>>  1 file changed, 26 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
>>
>> diff --git a/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt b/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
>> new file mode 100644
>> index 0000000..a7dd80f
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
>> @@ -0,0 +1,26 @@
>> +ltc3651-charger
>> +
>> +Required properties:
>> + - compatible: "lltc,ltc3651-charger"
>> + - acpr-gpios: Connect to ACPR output. See remark below.
>> +
>> +Optional properties:
>> + - fault-gpios: Connect to FAULT output. See remark below.
>> + - chrg-gpios: Connect to CHRG output. See remark below.
>
> All the gpios need vendor prefix.

Will prefix "lltc," adjust the driver and submit new patches.

>
>> +
>> +The ltc3651 outputs are open-drain type and active low. The driver assumes the
>> +GPIO reports "active" when the output is asserted, so if the pins have been
>> +connected directly, the GPIO flags should be set to active low also.
>> +
>> +The driver will attempt to aquire interrupts for all GPIOs. If the system is
>> +not capabale of providing that, the driver cannot report changes and userspace
>> +will need to periodically read the sysfs attributes to detect changes.
>
> If these are interrupts, then you should use the interrupt binding
> instead (most GPIO controllers are also interrupt controllers).

They're GPIO (the driver needs the current state), the use of interrupts is 
just to detect changes. Similar to gpio-charger for example. Interrupt 
bindings cannot provide the current state of the line.


>
>> +
>> +Example:
>> +
>> +	charger: battery-charger {
>> +		compatible = "lltc,ltc3651-charger";
>> +		acpr-gpios = <&gpio0 68 GPIO_ACTIVE_LOW>;
>> +		fault-gpios = <&gpio0 64 GPIO_ACTIVE_LOW>;
>> +		chrg-gpios = <&gpio0 63 GPIO_ACTIVE_LOW>;
>> +	};
>> --
>> 1.9.1
>>



Kind regards,

Mike Looijmans
System Expert

TOPIC Products
Materiaalweg 4, NL-5681 RJ Best
Postbus 440, NL-5680 AK Best
Telefoon: +31 (0) 499 33 69 79
E-mail: mike.looijmans@topicproducts.com
Website: www.topicproducts.com

Please consider the environment before printing this e-mail
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt b/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
new file mode 100644
index 0000000..a7dd80f
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/ltc3651-charger.txt
@@ -0,0 +1,26 @@ 
+ltc3651-charger
+
+Required properties:
+ - compatible: "lltc,ltc3651-charger"
+ - acpr-gpios: Connect to ACPR output. See remark below.
+
+Optional properties:
+ - fault-gpios: Connect to FAULT output. See remark below.
+ - chrg-gpios: Connect to CHRG output. See remark below.
+
+The ltc3651 outputs are open-drain type and active low. The driver assumes the
+GPIO reports "active" when the output is asserted, so if the pins have been
+connected directly, the GPIO flags should be set to active low also.
+
+The driver will attempt to aquire interrupts for all GPIOs. If the system is
+not capabale of providing that, the driver cannot report changes and userspace
+will need to periodically read the sysfs attributes to detect changes.
+
+Example:
+
+	charger: battery-charger {
+		compatible = "lltc,ltc3651-charger";
+		acpr-gpios = <&gpio0 68 GPIO_ACTIVE_LOW>;
+		fault-gpios = <&gpio0 64 GPIO_ACTIVE_LOW>;
+		chrg-gpios = <&gpio0 63 GPIO_ACTIVE_LOW>;
+	};