diff mbox series

[2/2] dt-bindings:iio:dac:dpot-dac: yaml conversion.

Message ID 20201011163031.240708-3-jic23@kernel.org (mailing list archive)
State New, archived
Headers show
Series dt-bindings:iio:consumer yaml bindings | expand

Commit Message

Jonathan Cameron Oct. 11, 2020, 4:30 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Txt to yaml format conversion.  I dropped the example section
describind the measurement ADC, as that isn't strictly part
of this binding. Uses a reference to the new iio-consumers.yaml
binding.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Peter Rosin <peda@axentia.se>
---
 .../devicetree/bindings/iio/dac/dpot-dac.txt  | 41 ------------
 .../devicetree/bindings/iio/dac/dpot-dac.yaml | 67 +++++++++++++++++++
 2 files changed, 67 insertions(+), 41 deletions(-)

Comments

Peter Rosin Oct. 11, 2020, 8:35 p.m. UTC | #1
Hi!

On 2020-10-11 18:30, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Txt to yaml format conversion.  I dropped the example section
> describind the measurement ADC, as that isn't strictly part
> of this binding. Uses a reference to the new iio-consumers.yaml
> binding.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Peter Rosin <peda@axentia.se>

While not being competent at checking the yaml thingies, I can at least
ack the zap of the irrelevant part of the example and generally support
the conversion to a more strict representation.

Acked-by: Peter Rosin <peda@axentia.se>

> ---
>  .../devicetree/bindings/iio/dac/dpot-dac.txt  | 41 ------------
>  .../devicetree/bindings/iio/dac/dpot-dac.yaml | 67 +++++++++++++++++++
>  2 files changed, 67 insertions(+), 41 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/dac/dpot-dac.txt b/Documentation/devicetree/bindings/iio/dac/dpot-dac.txt
> deleted file mode 100644
> index fdf47a01bfef..000000000000
> --- a/Documentation/devicetree/bindings/iio/dac/dpot-dac.txt
> +++ /dev/null
> @@ -1,41 +0,0 @@
> -Bindings for DAC emulation using a digital potentiometer
> -
> -It is assumed that the dpot is used as a voltage divider between the
> -current dpot wiper setting and the maximum resistance of the dpot. The
> -divided voltage is provided by a vref regulator.
> -
> -                  .------.
> -   .-----------.  |      |
> -   | vref      |--'    .---.
> -   | regulator |--.    |   |
> -   '-----------'  |    | d |
> -                  |    | p |
> -                  |    | o |  wiper
> -                  |    | t |<---------+
> -                  |    |   |
> -                  |    '---'       dac output voltage
> -                  |      |
> -                  '------+------------+
> -
> -Required properties:
> -- compatible: Should be "dpot-dac"
> -- vref-supply: The regulator supplying the voltage divider.
> -- io-channels: Channel node of the dpot to be used for the voltage division.
> -- io-channel-names: Should be "dpot".
> -
> -Example:
> -
> -	&i2c {
> -		dpot: mcp4651-503@28 {
> -			compatible = "microchip,mcp4651-503";
> -			reg = <0x28>;
> -			#io-channel-cells = <1>;
> -		};
> -	};
> -
> -	dac {
> -		compatible = "dpot-dac";
> -		vref-supply = <&reg_3v3>;
> -		io-channels = <&dpot 0>;
> -		io-channel-names = "dpot";
> -	};
> diff --git a/Documentation/devicetree/bindings/iio/dac/dpot-dac.yaml b/Documentation/devicetree/bindings/iio/dac/dpot-dac.yaml
> new file mode 100644
> index 000000000000..b4a8073a3a3c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/dac/dpot-dac.yaml
> @@ -0,0 +1,67 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/dac/dpot-dac.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: DAC emulation using a digital potentiometer
> +
> +maintainers:
> +  - Peter Rosin <peda@axentia.se>

Heh, I don't know the first thing about yaml so I will probably need
help with that. I still want to know about changes though.

Cheers,
Peter

*snip*
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/dac/dpot-dac.txt b/Documentation/devicetree/bindings/iio/dac/dpot-dac.txt
deleted file mode 100644
index fdf47a01bfef..000000000000
--- a/Documentation/devicetree/bindings/iio/dac/dpot-dac.txt
+++ /dev/null
@@ -1,41 +0,0 @@ 
-Bindings for DAC emulation using a digital potentiometer
-
-It is assumed that the dpot is used as a voltage divider between the
-current dpot wiper setting and the maximum resistance of the dpot. The
-divided voltage is provided by a vref regulator.
-
-                  .------.
-   .-----------.  |      |
-   | vref      |--'    .---.
-   | regulator |--.    |   |
-   '-----------'  |    | d |
-                  |    | p |
-                  |    | o |  wiper
-                  |    | t |<---------+
-                  |    |   |
-                  |    '---'       dac output voltage
-                  |      |
-                  '------+------------+
-
-Required properties:
-- compatible: Should be "dpot-dac"
-- vref-supply: The regulator supplying the voltage divider.
-- io-channels: Channel node of the dpot to be used for the voltage division.
-- io-channel-names: Should be "dpot".
-
-Example:
-
-	&i2c {
-		dpot: mcp4651-503@28 {
-			compatible = "microchip,mcp4651-503";
-			reg = <0x28>;
-			#io-channel-cells = <1>;
-		};
-	};
-
-	dac {
-		compatible = "dpot-dac";
-		vref-supply = <&reg_3v3>;
-		io-channels = <&dpot 0>;
-		io-channel-names = "dpot";
-	};
diff --git a/Documentation/devicetree/bindings/iio/dac/dpot-dac.yaml b/Documentation/devicetree/bindings/iio/dac/dpot-dac.yaml
new file mode 100644
index 000000000000..b4a8073a3a3c
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/dac/dpot-dac.yaml
@@ -0,0 +1,67 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/dac/dpot-dac.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: DAC emulation using a digital potentiometer
+
+maintainers:
+  - Peter Rosin <peda@axentia.se>
+
+description: |
+  It is assumed that the dpot is used as a voltage divider between the
+  current dpot wiper setting and the maximum resistance of the dpot. The
+  divided voltage is provided by a vref regulator.
+
+                  .------.
+   .-----------.  |      |
+   | vref      |--'    .---.
+   | regulator |--.    |   |
+   '-----------'  |    | d |
+                  |    | p |
+                  |    | o |  wiper
+                  |    | t |<---------+
+                  |    |   |
+                  |    '---'       dac output voltage
+                  |      |
+                  '------+------------+
+
+allOf:
+  - $ref: "../iio-consumer.yaml#"
+
+properties:
+  compatible:
+    const: dpot-dac
+
+  reg:
+    maxItems: 1
+
+  vref-supply:
+    description: Regulator supplying the voltage divider.
+
+  io-channels:
+    maxItems: 1
+    description: |
+      Channel node of the dpot to be used for the voltage division.
+
+  io-channel-names:
+    const: dpot
+
+required:
+  - compatible
+  - vref-supply
+  - io-channels
+  - io-channel-names
+
+additionalProperties: false
+
+examples:
+  - |
+    dac {
+        compatible = "dpot-dac";
+        vref-supply = <&reg_3v3>;
+        io-channels = <&dpot 0>;
+        io-channel-names = "dpot";
+    };
+...