Re: [PATCH] dt-bindings: power: Convert bq27xxx dt to yaml

[Dan Murphy]

Andrew

On 5/4/20 12:08 PM, Andrew F. Davis wrote:
On 5/4/20 12:44 PM, Dan Murphy wrote:
Adding Andrew in manually.
On 5/4/20 11:41 AM, Dan Murphy wrote:
Convert the bq27xxx.txt to yaml format

CC: Pali Rohár <p...@kernel.org>
CC: Andrew F. Davis" <a...@ti.com>
Signed-off-by: Dan Murphy <dmur...@ti.com>
---
   .../bindings/power/supply/bq27xxx.txt         | 56 -----------
   .../bindings/power/supply/bq27xxx.yaml        | 95 +++++++++++++++++++
   2 files changed, 95 insertions(+), 56 deletions(-)
   delete mode 100644
Documentation/devicetree/bindings/power/supply/bq27xxx.txt
   create mode 100644
Documentation/devicetree/bindings/power/supply/bq27xxx.yaml

diff --git
a/Documentation/devicetree/bindings/power/supply/bq27xxx.txt
b/Documentation/devicetree/bindings/power/supply/bq27xxx.txt
deleted file mode 100644
index 4fa8e08df2b6..000000000000
--- a/Documentation/devicetree/bindings/power/supply/bq27xxx.txt
+++ /dev/null
@@ -1,56 +0,0 @@
-TI BQ27XXX fuel gauge family
-
-Required properties:
-- compatible: contains one of the following:
- * "ti,bq27200" - BQ27200
- * "ti,bq27210" - BQ27210
- * "ti,bq27500" - deprecated, use revision specific property below
- * "ti,bq27510" - deprecated, use revision specific property below
- * "ti,bq27520" - deprecated, use revision specific property below
- * "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
- * "ti,bq27521" - BQ27521
- * "ti,bq27530" - BQ27530
- * "ti,bq27531" - BQ27531
- * "ti,bq27541" - BQ27541
- * "ti,bq27542" - BQ27542
- * "ti,bq27546" - BQ27546
- * "ti,bq27742" - BQ27742
- * "ti,bq27545" - BQ27545
- * "ti,bq27411" - BQ27411
- * "ti,bq27421" - BQ27421
- * "ti,bq27425" - BQ27425
- * "ti,bq27426" - BQ27426
- * "ti,bq27441" - BQ27441
- * "ti,bq27621" - BQ27621
-- reg: integer, I2C address of the fuel gauge.
-
-Optional properties:
-- monitored-battery: phandle of battery characteristics node
-    The fuel gauge uses the following battery properties:
-    + energy-full-design-microwatt-hours
-    + charge-full-design-microamp-hours
-    + voltage-min-design-microvolt
-  Both or neither of the *-full-design-*-hours properties must be set.
-  See Documentation/devicetree/bindings/power/supply/battery.txt
-
-Example:
-
-    bat: battery {
-        compatible = "simple-battery";
-        voltage-min-design-microvolt = <3200000>;
-        energy-full-design-microwatt-hours = <5290000>;
-        charge-full-design-microamp-hours = <1430000>;
-    };
-
-    bq27510g3: fuel-gauge@55 {
-        compatible = "ti,bq27510g3";
-        reg = <0x55>;
-        monitored-battery = <&bat>;
-    };
diff --git
a/Documentation/devicetree/bindings/power/supply/bq27xxx.yaml
b/Documentation/devicetree/bindings/power/supply/bq27xxx.yaml
new file mode 100644
index 000000000000..6c53ee849004
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/bq27xxx.yaml
@@ -0,0 +1,95 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (C) 2020 Texas Instruments Incorporated
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/power/supply/bq27xxx.yaml#";
+$schema: "http://devicetree.org/meta-schemas/core.yaml#";
+
+title: TI BQ27XXX fuel gauge family
+
+maintainers:
+  - Pali Rohár <p...@kernel.org>
+  - Andrew F. Davis" <a...@ti.com>

Extra " at end of name.

Ack


+  - Sebastian Reichel <s...@kernel.org>
+
+description: |
+  Support various Texas Instruments fuel gauge devices that share
similar
+  register maps and power supply properties
+
+properties:
+  compatible:
+    enum:
+      - ti,bq27200 - BQ27200
+      - ti,bq27210 - BQ27210
+      - ti,bq27500 - deprecated, use revision specific property below
+      - ti,bq27510 - deprecated, use revision specific property below
+      - ti,bq27520 - deprecated, use revision specific property below
+      - 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
+      - ti,bq27521 - BQ27521
+      - ti,bq27530 - BQ27530
+      - ti,bq27531 - BQ27531
+      - ti,bq27541 - BQ27541
+      - ti,bq27542 - BQ27542
+      - ti,bq27546 - BQ27546
+      - ti,bq27742 - BQ27742
+      - ti,bq27545 - BQ27545
+      - ti,bq27411 - BQ27411
+      - ti,bq27421 - BQ27421
+      - ti,bq27425 - BQ27425
+      - ti,bq27426 - BQ27426
+      - ti,bq27441 - BQ27441
+      - ti,bq27621 - BQ27621
+
+  reg:
+    maxItems: 1
+    description: integer, I2C address of the fuel gauge.
+
+  monitored-battery:
+    description: phandle of battery characteristics node
+
+  energy-full-design-microwatt-hours:
+    description: |
+      See Documentation/devicetree/bindings/power/supply/battery.txt.
+      If this property is set then charge-full-design-microamp-hours
must be
+      set as well.

These are properties of the battery node and should be described in
their binding, they are not part of the fuel gauge node here.

OK.  I will add the explanation back from the original text file that 
these are used by the fuel gauge from the battery node.

Dan