diff mbox series

[15/20] dt-bindings:iio:adc:ad7768-1 yaml conversion

Message ID 20200905173004.216081-16-jic23@kernel.org
State Superseded
Headers show
Series dt-bindings:iio:adc: Another set of yaml conversions. | expand

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch warning total: 0 errors, 3 warnings, 89 lines checked

Commit Message

Jonathan Cameron Sept. 5, 2020, 5:29 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Fairly straight conversion.  The one oddity in the original binding
is that spi-cpha and spi-cpol were not marked as required, but were
in the example.  Looking at the datasheet, there isn't any documented
flexibility in the possible SPI modes, so I have moved these to requires.
For spi-max-frequency I have gone the other way.  I absolutely agree
that it is good to specify this in the dt-binding, but it's not
strictly required.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Stefan Popa <stefan.popa@analog.com>
---
 .../bindings/iio/adc/adi,ad7768-1.txt         | 41 ---------
 .../bindings/iio/adc/adi,ad7768-1.yaml        | 89 +++++++++++++++++++
 2 files changed, 89 insertions(+), 41 deletions(-)

Comments

Jonathan Cameron Sept. 6, 2020, 4:13 p.m. UTC | #1
On Sat,  5 Sep 2020 18:29:59 +0100
Jonathan Cameron <jic23@kernel.org> wrote:

> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Fairly straight conversion.  The one oddity in the original binding
> is that spi-cpha and spi-cpol were not marked as required, but were
> in the example.  Looking at the datasheet, there isn't any documented
> flexibility in the possible SPI modes, so I have moved these to requires.
> For spi-max-frequency I have gone the other way.  I absolutely agree
> that it is good to specify this in the dt-binding, but it's not
> strictly required.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Stefan Popa <stefan.popa@analog.com>

As Stefan bounced, I guess not the best choice for maintainer on this
binding going forwards.

Shall we go the same way as with the code Maintenance and make it
Michael's problem? :)

Jonathan
> ---
>  .../bindings/iio/adc/adi,ad7768-1.txt         | 41 ---------
>  .../bindings/iio/adc/adi,ad7768-1.yaml        | 89 +++++++++++++++++++
>  2 files changed, 89 insertions(+), 41 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt
> deleted file mode 100644
> index 9f5b88cf680d..000000000000
> --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt
> +++ /dev/null
> @@ -1,41 +0,0 @@
> -Analog Devices AD7768-1 ADC device driver
> -
> -Required properties for the AD7768-1:
> -
> -- compatible: Must be "adi,ad7768-1"
> -- reg: SPI chip select number for the device
> -- spi-max-frequency: Max SPI frequency to use
> -	see: Documentation/devicetree/bindings/spi/spi-bus.txt
> -- clocks: phandle to the master clock (mclk)
> -	see: Documentation/devicetree/bindings/clock/clock-bindings.txt
> -- clock-names: Must be "mclk".
> -- interrupts: IRQ line for the ADC
> -	see: Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
> -- vref-supply: vref supply can be used as reference for conversion
> -- adi,sync-in-gpios: must be the device tree identifier of the SYNC-IN pin. Enables
> -	synchronization of multiple devices that require simultaneous sampling.
> -	A pulse is always required if the configuration is changed in any way, for example
> -	if the filter decimation rate changes. As the line is active low, it should
> -	be marked GPIO_ACTIVE_LOW.
> -
> -Optional properties:
> -
> - - reset-gpios : GPIO spec for the RESET pin. If specified, it will be asserted during
> -	driver probe. As the line is active low, it should be marked GPIO_ACTIVE_LOW.
> -
> -Example:
> -
> -	adc@0 {
> -		compatible = "adi,ad7768-1";
> -		reg = <0>;
> -		spi-max-frequency = <2000000>;
> -		spi-cpol;
> -		spi-cpha;
> -		vref-supply = <&adc_vref>;
> -		interrupts = <25 IRQ_TYPE_EDGE_RISING>;
> -		interrupt-parent = <&gpio>;
> -		adi,sync-in-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
> -		reset-gpios = <&gpio 27 GPIO_ACTIVE_LOW>;
> -		clocks = <&ad7768_mclk>;
> -		clock-names = "mclk";
> -	};
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml
> new file mode 100644
> index 000000000000..a2c559d0c947
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml
> @@ -0,0 +1,89 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/adi,ad7768-1.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AD7768-1 ADC device driver
> +
> +maintainers:
> +  - Stefan Popa <stefan.popa@analog.com>
> +
> +description: |
> +  Datasheet at:
> +    https://www.analog.com/media/en/technical-documentation/data-sheets/ad7768-1.pdf
> +
> +properties:
> +  compatible:
> +    const: adi,ad7768-1
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    const: mclk
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  vref-supply:
> +    description:
> +      ADC reference voltage supply
> +
> +  adi,sync-in-gpios:
> +    description:
> +      Enables synchronization of multiple devices that require simultaneous
> +      sampling. A pulse is always required if the configuration is changed
> +      in any way, for example if the filter decimation rate changes.
> +      As the line is active low, it should be marked GPIO_ACTIVE_LOW.
> +
> +  reset-gpios:
> +    maxItems: 1
> +
> +  spi-max-frequency: true
> +
> +  spi-cpol: true
> +  spi-cpha : true
> +
> +  "#io-channel-cells":
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - clock-names
> +  - vref-supply
> +  - spi-cpol
> +  - spi-cpha
> +  - adi,sync-in-gpios
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        adc@0 {
> +            compatible = "adi,ad7768-1";
> +            reg = <0>;
> +            spi-max-frequency = <2000000>;
> +            spi-cpol;
> +            spi-cpha;
> +            vref-supply = <&adc_vref>;
> +            interrupts = <25 IRQ_TYPE_EDGE_RISING>;
> +            interrupt-parent = <&gpio>;
> +            adi,sync-in-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
> +            reset-gpios = <&gpio 27 GPIO_ACTIVE_LOW>;
> +            clocks = <&ad7768_mclk>;
> +            clock-names = "mclk";
> +        };
> +    };
> +...
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt
deleted file mode 100644
index 9f5b88cf680d..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt
+++ /dev/null
@@ -1,41 +0,0 @@ 
-Analog Devices AD7768-1 ADC device driver
-
-Required properties for the AD7768-1:
-
-- compatible: Must be "adi,ad7768-1"
-- reg: SPI chip select number for the device
-- spi-max-frequency: Max SPI frequency to use
-	see: Documentation/devicetree/bindings/spi/spi-bus.txt
-- clocks: phandle to the master clock (mclk)
-	see: Documentation/devicetree/bindings/clock/clock-bindings.txt
-- clock-names: Must be "mclk".
-- interrupts: IRQ line for the ADC
-	see: Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
-- vref-supply: vref supply can be used as reference for conversion
-- adi,sync-in-gpios: must be the device tree identifier of the SYNC-IN pin. Enables
-	synchronization of multiple devices that require simultaneous sampling.
-	A pulse is always required if the configuration is changed in any way, for example
-	if the filter decimation rate changes. As the line is active low, it should
-	be marked GPIO_ACTIVE_LOW.
-
-Optional properties:
-
- - reset-gpios : GPIO spec for the RESET pin. If specified, it will be asserted during
-	driver probe. As the line is active low, it should be marked GPIO_ACTIVE_LOW.
-
-Example:
-
-	adc@0 {
-		compatible = "adi,ad7768-1";
-		reg = <0>;
-		spi-max-frequency = <2000000>;
-		spi-cpol;
-		spi-cpha;
-		vref-supply = <&adc_vref>;
-		interrupts = <25 IRQ_TYPE_EDGE_RISING>;
-		interrupt-parent = <&gpio>;
-		adi,sync-in-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
-		reset-gpios = <&gpio 27 GPIO_ACTIVE_LOW>;
-		clocks = <&ad7768_mclk>;
-		clock-names = "mclk";
-	};
diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml
new file mode 100644
index 000000000000..a2c559d0c947
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml
@@ -0,0 +1,89 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7768-1.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AD7768-1 ADC device driver
+
+maintainers:
+  - Stefan Popa <stefan.popa@analog.com>
+
+description: |
+  Datasheet at:
+    https://www.analog.com/media/en/technical-documentation/data-sheets/ad7768-1.pdf
+
+properties:
+  compatible:
+    const: adi,ad7768-1
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: mclk
+
+  interrupts:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      ADC reference voltage supply
+
+  adi,sync-in-gpios:
+    description:
+      Enables synchronization of multiple devices that require simultaneous
+      sampling. A pulse is always required if the configuration is changed
+      in any way, for example if the filter decimation rate changes.
+      As the line is active low, it should be marked GPIO_ACTIVE_LOW.
+
+  reset-gpios:
+    maxItems: 1
+
+  spi-max-frequency: true
+
+  spi-cpol: true
+  spi-cpha : true
+
+  "#io-channel-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - vref-supply
+  - spi-cpol
+  - spi-cpha
+  - adi,sync-in-gpios
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/gpio/gpio.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "adi,ad7768-1";
+            reg = <0>;
+            spi-max-frequency = <2000000>;
+            spi-cpol;
+            spi-cpha;
+            vref-supply = <&adc_vref>;
+            interrupts = <25 IRQ_TYPE_EDGE_RISING>;
+            interrupt-parent = <&gpio>;
+            adi,sync-in-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
+            reset-gpios = <&gpio 27 GPIO_ACTIVE_LOW>;
+            clocks = <&ad7768_mclk>;
+            clock-names = "mclk";
+        };
+    };
+...