diff mbox

[v2,11/11] power: supplies: bq275xx: adds device tree binding documentation.

Message ID 1482451507-37676-12-git-send-email-chris@lapa.com.au (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

chris@lapa.com.au Dec. 23, 2016, 12:05 a.m. UTC 
From: Chris Lapa <chris@lapa.com.au>

The bq275xx binding is a standard i2c style binding, however the
deprecated compatible fields and different revisions warrant its own
documentation.

Signed-off-by: Chris Lapa <chris@lapa.com.au>
---
 .../devicetree/bindings/power/supply/bq275xx.txt   | 27 ++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/supply/bq275xx.txt

Comments

Sebastian Reichel Jan. 6, 2017, 12:06 a.m. UTC | #1 
Hi,

On Fri, Dec 23, 2016 at 11:05:07AM +1100, Chris Lapa wrote:
> From: Chris Lapa <chris@lapa.com.au>
> 
> The bq275xx binding is a standard i2c style binding, however the
> deprecated compatible fields and different revisions warrant its own
> documentation.

Please add the other supported i2c bq27xxx chips and name the file
bq27xxx.txt. Otherwise maintaining this will become annoying.

-- Sebastian
chris@lapa.com.au Jan. 6, 2017, 12:32 a.m. UTC | #2 
On 6/1/17 11:06 am, Sebastian Reichel wrote:
> Hi,
>
> On Fri, Dec 23, 2016 at 11:05:07AM +1100, Chris Lapa wrote:
>> From: Chris Lapa <chris@lapa.com.au>
>>
>> The bq275xx binding is a standard i2c style binding, however the
>> deprecated compatible fields and different revisions warrant its own
>> documentation.
>
> Please add the other supported i2c bq27xxx chips and name the file
> bq27xxx.txt. Otherwise maintaining this will become annoying.
>
> -- Sebastian
>

Makes sense, will do.
--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/bq275xx.txt b/Documentation/devicetree/bindings/power/supply/bq275xx.txt
new file mode 100644
index 0000000..8f4f759
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/bq275xx.txt
@@ -0,0 +1,27 @@ 
+binding for BQ275XX fuel gauge family
+
+Supports revisions listed below in the BQ275XX family of fuel gauges.
+Each revision is slightly different enough to warrant separate
+comapatible fields.
+
+Required properties:
+- compatible:
+    * "ti,bq27500" - deprecated
+    * "ti,bq27510" - deprecated
+    * "ti,bq27520" - deprecated
+    * "ti,bq27500-1" - BQ27500/1
+    * "ti,bq27510g1" - BQ27510-g1
+    * "ti,bq27510g2" - BQ27510-g2
+    * "ti,bq27510g3" - BQ27510-g3
+    * "ti,bq27520g1" - BQ27520-g1
+    * "ti,bq27520g2" - BQ27520-g2
+    * "ti,bq27520g3" - BQ27520-g3
+    * "ti,bq27520g4" - BQ27520-g4
+- reg: The 7-bit I2C address.
+
+Example:
+
+	fuelgauge: bq27510g3@55 {
+		compatible = "ti,bq27510g3";
+		reg = <0x55>;
+	};