[v2,2/3] dt-bindings: iio: adc: Add binding for AD7380 ADCs

Message ID 20231213-ad7380-mainline-v2-2-cd32150d84a3@baylibre.com
State New
Headers
Series iio: adc: add new ad7380 driver |

Commit Message

David Lechner Dec. 13, 2023, 11:21 a.m. UTC
  This adds a binding specification for the Analog Devices Inc. AD7380
family of ADCs.

Signed-off-by: David Lechner <dlechner@baylibre.com>
---

v2 changes:
- Added maxItems to reg property
- Replaced adi,sdo-mode property with spi-rx-bus-channels
- Made spi-rx-bus-channels property optional with default value of 1
    (this made the if: check more complex)
- Changed example to use gpio for interrupt

 .../devicetree/bindings/iio/adc/adi,ad7380.yaml    | 107 +++++++++++++++++++++
 MAINTAINERS                                        |   9 ++
 2 files changed, 116 insertions(+)
  

Comments

Conor Dooley Dec. 13, 2023, 4:10 p.m. UTC | #1
On Wed, Dec 13, 2023 at 05:21:19AM -0600, David Lechner wrote:
> This adds a binding specification for the Analog Devices Inc. AD7380
> family of ADCs.
> 
> Signed-off-by: David Lechner <dlechner@baylibre.com>
> ---
> 
> v2 changes:
> - Added maxItems to reg property
> - Replaced adi,sdo-mode property with spi-rx-bus-channels
> - Made spi-rx-bus-channels property optional with default value of 1
>     (this made the if: check more complex)
> - Changed example to use gpio for interrupt
> 
>  .../devicetree/bindings/iio/adc/adi,ad7380.yaml    | 107 +++++++++++++++++++++
>  MAINTAINERS                                        |   9 ++
>  2 files changed, 116 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
> new file mode 100644
> index 000000000000..43d58c52f7dd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
> @@ -0,0 +1,107 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/adi,ad7380.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices Simultaneous Sampling Analog to Digital Converters
> +
> +maintainers:
> +  - Michael Hennerich <Michael.Hennerich@analog.com>
> +  - Nuno Sá <nuno.sa@analog.com>
> +
> +description: |
> +  * https://www.analog.com/en/products/ad7380.html
> +  * https://www.analog.com/en/products/ad7381.html
> +  * https://www.analog.com/en/products/ad7383.html
> +  * https://www.analog.com/en/products/ad7384.html
> +
> +$ref: /schemas/spi/spi-peripheral-props.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,ad7380
> +      - adi,ad7381
> +      - adi,ad7383
> +      - adi,ad7384
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 80000000
> +  spi-cpol: true
> +  spi-cpha: true
> +
> +  spi-rx-bus-channels:

This is now being framed as a standard property, so I think it should be
in spi-peripheral-props, no? Granted, you'd need a rather more
generalised explanation of the property in that case.

> +    description:
> +      In 1-wire mode, the SDOA pin acts as the sole data line and the SDOB/ALERT
> +      pin acts as the ALERT interrupt signal. In 2-wire mode, data for input A
> +      is read from SDOA and data for input B is read from SDOB/ALERT (and the
> +      ALERT interrupt signal is not available).
> +    enum: [1, 2]

Jonathan also mentioned specifying that this defaults to 1-wire. I
didn't see a response or that implemented. Did you miss that comment
from him?

Cheers,
Conor.

> +
> +  vcc-supply:
> +    description: A 3V to 3.6V supply that powers the chip.
> +
> +  vlogic-supply:
> +    description:
> +      A 1.65V to 3.6V supply for the logic pins.
> +
> +  refio-supply:
> +    description:
> +      A 2.5V to 3.3V supply for the external reference voltage. When omitted,
> +      the internal 2.5V reference is used.
> +
> +  interrupts:
> +    description:
> +      When the device is using 1-wire mode, this property is used to optionally
> +      specify the ALERT interrupt.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - vcc-supply
> +  - vlogic-supply
> +
> +allOf:
> +  - if:
> +      required:
> +        - spi-rx-bus-channels
> +    then:
> +      if:
> +        properties:
> +          spi-rx-bus-channels:
> +            const: 2
> +      then:
> +        properties:
> +          interrupts: false
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +
> +    spi {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        adc@0 {
> +            compatible = "adi,ad7380";
> +            reg = <0>;
> +
> +            spi-cpol;
> +            spi-cpha;
> +            spi-max-frequency = <80000000>;
> +
> +            interrupts = <27 IRQ_TYPE_EDGE_FALLING>;
> +            interrupt-parent = <&gpio0>;
> +
> +            vcc-supply = <&supply_3_3V>;
> +            vlogic-supply = <&supply_3_3V>;
> +            refio-supply = <&supply_2_5V>;
> +        };
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index fe1f6f97f96a..e2a998be5879 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -430,6 +430,15 @@ W:	http://wiki.analog.com/AD7142
>  W:	https://ez.analog.com/linux-software-drivers
>  F:	drivers/input/misc/ad714x.c
>  
> +AD738X ADC DRIVER (AD7380/1/2/4)
> +M:	Michael Hennerich <michael.hennerich@analog.com>
> +M:	Nuno Sá <nuno.sa@analog.com>
> +R:	David Lechner <dlechner@baylibre.com>
> +S:	Supported
> +W:	https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad738x
> +W:	https://ez.analog.com/linux-software-drivers
> +F:	Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
> +
>  AD7877 TOUCHSCREEN DRIVER
>  M:	Michael Hennerich <michael.hennerich@analog.com>
>  S:	Supported
> 
> -- 
> 2.34.1
>
  
Conor Dooley Dec. 13, 2023, 4:11 p.m. UTC | #2
On Wed, Dec 13, 2023 at 04:10:40PM +0000, Conor Dooley wrote:
> On Wed, Dec 13, 2023 at 05:21:19AM -0600, David Lechner wrote:
> > This adds a binding specification for the Analog Devices Inc. AD7380
> > family of ADCs.
> > 
> > Signed-off-by: David Lechner <dlechner@baylibre.com>
> > ---
> > 
> > v2 changes:
> > - Added maxItems to reg property
> > - Replaced adi,sdo-mode property with spi-rx-bus-channels
> > - Made spi-rx-bus-channels property optional with default value of 1
> >     (this made the if: check more complex)
> > - Changed example to use gpio for interrupt
> > 
> >  .../devicetree/bindings/iio/adc/adi,ad7380.yaml    | 107 +++++++++++++++++++++
> >  MAINTAINERS                                        |   9 ++
> >  2 files changed, 116 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
> > new file mode 100644
> > index 000000000000..43d58c52f7dd
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
> > @@ -0,0 +1,107 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/adc/adi,ad7380.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Analog Devices Simultaneous Sampling Analog to Digital Converters
> > +
> > +maintainers:
> > +  - Michael Hennerich <Michael.Hennerich@analog.com>
> > +  - Nuno Sá <nuno.sa@analog.com>
> > +
> > +description: |
> > +  * https://www.analog.com/en/products/ad7380.html
> > +  * https://www.analog.com/en/products/ad7381.html
> > +  * https://www.analog.com/en/products/ad7383.html
> > +  * https://www.analog.com/en/products/ad7384.html
> > +
> > +$ref: /schemas/spi/spi-peripheral-props.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - adi,ad7380
> > +      - adi,ad7381
> > +      - adi,ad7383
> > +      - adi,ad7384
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  spi-max-frequency:
> > +    maximum: 80000000
> > +  spi-cpol: true
> > +  spi-cpha: true
> > +
> > +  spi-rx-bus-channels:
> 
> This is now being framed as a standard property, so I think it should be
> in spi-peripheral-props, no? Granted, you'd need a rather more
> generalised explanation of the property in that case.
> 
> > +    description:
> > +      In 1-wire mode, the SDOA pin acts as the sole data line and the SDOB/ALERT
> > +      pin acts as the ALERT interrupt signal. In 2-wire mode, data for input A
> > +      is read from SDOA and data for input B is read from SDOB/ALERT (and the
> > +      ALERT interrupt signal is not available).
> > +    enum: [1, 2]
> 
> Jonathan also mentioned specifying that this defaults to 1-wire. I
> didn't see a response or that implemented. Did you miss that comment
> from him?

Ah, I read the patchset backwards, d'oh. I see you did in fact do both
of these things. Apologies!
  
Conor Dooley Dec. 13, 2023, 4:15 p.m. UTC | #3
On Wed, Dec 13, 2023 at 05:21:19AM -0600, David Lechner wrote:
> This adds a binding specification for the Analog Devices Inc. AD7380
> family of ADCs.
> 
> Signed-off-by: David Lechner <dlechner@baylibre.com>

Having read the patchset in the correct order, this patch now
seems fine to me.
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Cheers,
Conor.
  

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
new file mode 100644
index 000000000000..43d58c52f7dd
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
@@ -0,0 +1,107 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7380.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices Simultaneous Sampling Analog to Digital Converters
+
+maintainers:
+  - Michael Hennerich <Michael.Hennerich@analog.com>
+  - Nuno Sá <nuno.sa@analog.com>
+
+description: |
+  * https://www.analog.com/en/products/ad7380.html
+  * https://www.analog.com/en/products/ad7381.html
+  * https://www.analog.com/en/products/ad7383.html
+  * https://www.analog.com/en/products/ad7384.html
+
+$ref: /schemas/spi/spi-peripheral-props.yaml#
+
+properties:
+  compatible:
+    enum:
+      - adi,ad7380
+      - adi,ad7381
+      - adi,ad7383
+      - adi,ad7384
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 80000000
+  spi-cpol: true
+  spi-cpha: true
+
+  spi-rx-bus-channels:
+    description:
+      In 1-wire mode, the SDOA pin acts as the sole data line and the SDOB/ALERT
+      pin acts as the ALERT interrupt signal. In 2-wire mode, data for input A
+      is read from SDOA and data for input B is read from SDOB/ALERT (and the
+      ALERT interrupt signal is not available).
+    enum: [1, 2]
+
+  vcc-supply:
+    description: A 3V to 3.6V supply that powers the chip.
+
+  vlogic-supply:
+    description:
+      A 1.65V to 3.6V supply for the logic pins.
+
+  refio-supply:
+    description:
+      A 2.5V to 3.3V supply for the external reference voltage. When omitted,
+      the internal 2.5V reference is used.
+
+  interrupts:
+    description:
+      When the device is using 1-wire mode, this property is used to optionally
+      specify the ALERT interrupt.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vcc-supply
+  - vlogic-supply
+
+allOf:
+  - if:
+      required:
+        - spi-rx-bus-channels
+    then:
+      if:
+        properties:
+          spi-rx-bus-channels:
+            const: 2
+      then:
+        properties:
+          interrupts: false
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "adi,ad7380";
+            reg = <0>;
+
+            spi-cpol;
+            spi-cpha;
+            spi-max-frequency = <80000000>;
+
+            interrupts = <27 IRQ_TYPE_EDGE_FALLING>;
+            interrupt-parent = <&gpio0>;
+
+            vcc-supply = <&supply_3_3V>;
+            vlogic-supply = <&supply_3_3V>;
+            refio-supply = <&supply_2_5V>;
+        };
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index fe1f6f97f96a..e2a998be5879 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -430,6 +430,15 @@  W:	http://wiki.analog.com/AD7142
 W:	https://ez.analog.com/linux-software-drivers
 F:	drivers/input/misc/ad714x.c
 
+AD738X ADC DRIVER (AD7380/1/2/4)
+M:	Michael Hennerich <michael.hennerich@analog.com>
+M:	Nuno Sá <nuno.sa@analog.com>
+R:	David Lechner <dlechner@baylibre.com>
+S:	Supported
+W:	https://wiki.analog.com/resources/tools-software/linux-drivers/iio-adc/ad738x
+W:	https://ez.analog.com/linux-software-drivers
+F:	Documentation/devicetree/bindings/iio/adc/adi,ad7380.yaml
+
 AD7877 TOUCHSCREEN DRIVER
 M:	Michael Hennerich <michael.hennerich@analog.com>
 S:	Supported