diff mbox series

[v2,1/2] dt-bindings: power: Convert ingenic,battery.txt to YAML

Message ID 20200906144726.8852-1-contact@artur-rojek.eu
State New
Headers show
Series [v2,1/2] dt-bindings: power: Convert ingenic,battery.txt to YAML | expand

Commit Message

Artur Rojek Sept. 6, 2020, 2:47 p.m. UTC
Convert the textual documentation of Device Tree bindings for the
Ingenic JZ47xx SoCs battery to YAML.

Signed-off-by: Artur Rojek <contact@artur-rojek.eu>
---

Changes:
    v2: move introduction of new compatibles into a separate patch

 .../bindings/power/supply/ingenic,battery.txt | 31 ----------
 .../power/supply/ingenic,battery.yaml         | 60 +++++++++++++++++++
 2 files changed, 60 insertions(+), 31 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.txt
 create mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml

Comments

Rob Herring (Arm) Sept. 15, 2020, 1:09 a.m. UTC | #1
On Sun, Sep 06, 2020 at 04:47:25PM +0200, Artur Rojek wrote:
> Convert the textual documentation of Device Tree bindings for the

> Ingenic JZ47xx SoCs battery to YAML.

> 

> Signed-off-by: Artur Rojek <contact@artur-rojek.eu>

> ---

> 

> Changes:

>     v2: move introduction of new compatibles into a separate patch

> 

>  .../bindings/power/supply/ingenic,battery.txt | 31 ----------

>  .../power/supply/ingenic,battery.yaml         | 60 +++++++++++++++++++

>  2 files changed, 60 insertions(+), 31 deletions(-)

>  delete mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.txt

>  create mode 100644 Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml

> 

> diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt b/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt

> deleted file mode 100644

> index 66430bf73815..000000000000

> --- a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt

> +++ /dev/null

> @@ -1,31 +0,0 @@

> -* Ingenic JZ47xx battery bindings

> -

> -Required properties:

> -

> -- compatible: Must be "ingenic,jz4740-battery".

> -- io-channels: phandle and IIO specifier pair to the IIO device.

> -  Format described in iio-bindings.txt.

> -- monitored-battery: phandle to a "simple-battery" compatible node.

> -

> -The "monitored-battery" property must be a phandle to a node using the format

> -described in battery.txt, with the following properties being required:

> -

> -- voltage-min-design-microvolt: Drained battery voltage.

> -- voltage-max-design-microvolt: Fully charged battery voltage.

> -

> -Example:

> -

> -#include <dt-bindings/iio/adc/ingenic,adc.h>

> -

> -simple_battery: battery {

> -	compatible = "simple-battery";

> -	voltage-min-design-microvolt = <3600000>;

> -	voltage-max-design-microvolt = <4200000>;

> -};

> -

> -ingenic_battery {

> -	compatible = "ingenic,jz4740-battery";

> -	io-channels = <&adc INGENIC_ADC_BATTERY>;

> -	io-channel-names = "battery";

> -	monitored-battery = <&simple_battery>;

> -};

> diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml

> new file mode 100644

> index 000000000000..b4e0275ac63a

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml

> @@ -0,0 +1,60 @@

> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

> +# Copyright 2019-2020 Artur Rojek

> +%YAML 1.2

> +---

> +$id: "http://devicetree.org/schemas/power/supply/ingenic,battery.yaml#"

> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

> +

> +title: Ingenic JZ47xx battery bindings

> +

> +maintainers:

> +  - Artur Rojek <contact@artur-rojek.eu>

> +

> +properties:

> +  compatible:

> +    const: ingenic,jz4740-battery

> +

> +  io-channels:

> +    items:

> +      - description: >

> +          phandle and IIO specifier pair to the IIO device.

> +          See Documentation/devicetree/bindings/iio/iio-bindings.txt for more

> +          details.


No need to redefine common properties. 'maxItems: 1' is sufficient here.

> +

> +  io-channel-names:

> +    const: "battery"


Don't need quotes.

> +

> +  monitored-battery:

> +    items:

> +      - description: >


'monitored-battery' is always a single item. So just need 'description'.

> +          phandle to a "simple-battery" compatible node.

> +

> +          This property must be a phandle to a node using the format described

> +          in battery.txt, with the following properties being required:

> +          - voltage-min-design-microvolt: drained battery voltage,

> +          - voltage-max-design-microvolt: fully charged battery voltage.

> +

> +required:

> +  - compatible

> +  - io-channels

> +  - io-channel-names

> +  - monitored-battery

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    #include <dt-bindings/iio/adc/ingenic,adc.h>

> +

> +    simple_battery: battery {

> +            compatible = "simple-battery";

> +            voltage-min-design-microvolt = <3600000>;

> +            voltage-max-design-microvolt = <4200000>;

> +    };

> +

> +    ingenic-battery {

> +            compatible = "ingenic,jz4740-battery";

> +            io-channels = <&adc INGENIC_ADC_BATTERY>;

> +            io-channel-names = "battery";

> +            monitored-battery = <&simple_battery>;

> +    };

> -- 

> 2.28.0

>
Rob Herring (Arm) Sept. 15, 2020, 1:09 a.m. UTC | #2
On Sun, 06 Sep 2020 16:47:26 +0200, Artur Rojek wrote:
> This binding can support Ingenic JZ4725B and JZ4770 SoCs, as they are
> compatible with Ingenic JZ4740 battery.
> 
> Introduce the following compatible property combinations:
>  compatible = "ingenic,jz4725b-battery", "ingenic,jz4740-battery",
>  compatible = "ingenic,jz4770-battery", "ingenic,jz4740-battery"
> 
> Signed-off-by: Artur Rojek <contact@artur-rojek.eu>
> ---
> 
> Changes:
>     v2: new patch
> 
>  .../devicetree/bindings/power/supply/ingenic,battery.yaml | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 

Reviewed-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt b/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt
deleted file mode 100644
index 66430bf73815..000000000000
--- a/Documentation/devicetree/bindings/power/supply/ingenic,battery.txt
+++ /dev/null
@@ -1,31 +0,0 @@ 
-* Ingenic JZ47xx battery bindings
-
-Required properties:
-
-- compatible: Must be "ingenic,jz4740-battery".
-- io-channels: phandle and IIO specifier pair to the IIO device.
-  Format described in iio-bindings.txt.
-- monitored-battery: phandle to a "simple-battery" compatible node.
-
-The "monitored-battery" property must be a phandle to a node using the format
-described in battery.txt, with the following properties being required:
-
-- voltage-min-design-microvolt: Drained battery voltage.
-- voltage-max-design-microvolt: Fully charged battery voltage.
-
-Example:
-
-#include <dt-bindings/iio/adc/ingenic,adc.h>
-
-simple_battery: battery {
-	compatible = "simple-battery";
-	voltage-min-design-microvolt = <3600000>;
-	voltage-max-design-microvolt = <4200000>;
-};
-
-ingenic_battery {
-	compatible = "ingenic,jz4740-battery";
-	io-channels = <&adc INGENIC_ADC_BATTERY>;
-	io-channel-names = "battery";
-	monitored-battery = <&simple_battery>;
-};
diff --git a/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml
new file mode 100644
index 000000000000..b4e0275ac63a
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/supply/ingenic,battery.yaml
@@ -0,0 +1,60 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2019-2020 Artur Rojek
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/power/supply/ingenic,battery.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Ingenic JZ47xx battery bindings
+
+maintainers:
+  - Artur Rojek <contact@artur-rojek.eu>
+
+properties:
+  compatible:
+    const: ingenic,jz4740-battery
+
+  io-channels:
+    items:
+      - description: >
+          phandle and IIO specifier pair to the IIO device.
+          See Documentation/devicetree/bindings/iio/iio-bindings.txt for more
+          details.
+
+  io-channel-names:
+    const: "battery"
+
+  monitored-battery:
+    items:
+      - description: >
+          phandle to a "simple-battery" compatible node.
+
+          This property must be a phandle to a node using the format described
+          in battery.txt, with the following properties being required:
+          - voltage-min-design-microvolt: drained battery voltage,
+          - voltage-max-design-microvolt: fully charged battery voltage.
+
+required:
+  - compatible
+  - io-channels
+  - io-channel-names
+  - monitored-battery
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/iio/adc/ingenic,adc.h>
+
+    simple_battery: battery {
+            compatible = "simple-battery";
+            voltage-min-design-microvolt = <3600000>;
+            voltage-max-design-microvolt = <4200000>;
+    };
+
+    ingenic-battery {
+            compatible = "ingenic,jz4740-battery";
+            io-channels = <&adc INGENIC_ADC_BATTERY>;
+            io-channel-names = "battery";
+            monitored-battery = <&simple_battery>;
+    };