Linux-IIO Archive on lore.kernel.org
 help / Atom feed
* [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding
@ 2019-05-18 22:41 Renato Lui Geh
  2019-05-19 11:32 ` Jonathan Cameron
  0 siblings, 1 reply; 5+ messages in thread
From: Renato Lui Geh @ 2019-05-18 22:41 UTC (permalink / raw)
  To: lars, Michael.Hennerich, jic23, knaack.h, pmeerw, gregkh,
	stefan.popa, alexandru.Ardelean, robh+dt, mark.rutland
  Cc: linux-iio, devel, linux-kernel, kernel-usp, devicetree

This patch adds a YAML binding for the Analog Devices AD7780/1 and
AD7170/1 analog-to-digital converters.

Signed-off-by: Renato Lui Geh <renatogeh@gmail.com>
---
 .../bindings/iio/adc/adi,ad7780.txt           | 48 -----------
 .../bindings/iio/adc/adi,ad7780.yaml          | 85 +++++++++++++++++++
 2 files changed, 85 insertions(+), 48 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
 create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml

diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
deleted file mode 100644
index 440e52555349..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-* Analog Devices AD7170/AD7171/AD7780/AD7781
-
-Data sheets:
-
-- AD7170:
-	* https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
-- AD7171:
-	* https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
-- AD7780:
-	* https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
-- AD7781:
-	* https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
-
-Required properties:
-
-- compatible: should be one of
-	* "adi,ad7170"
-	* "adi,ad7171"
-	* "adi,ad7780"
-	* "adi,ad7781"
-- reg: spi chip select number for the device
-- vref-supply: the regulator supply for the ADC reference voltage
-
-Optional properties:
-
-- powerdown-gpios:  must be the device tree identifier of the PDRST pin. If
-		    specified, it will be asserted during driver probe. As the
-		    line is active high, it should be marked GPIO_ACTIVE_HIGH.
-- adi,gain-gpios:   must be the device tree identifier of the GAIN pin. Only for
-		    the ad778x chips. If specified, it will be asserted during
-		    driver probe. As the line is active low, it should be marked
-		    GPIO_ACTIVE_LOW.
-- adi,filter-gpios: must be the device tree identifier of the FILTER pin. Only
-		    for the ad778x chips. 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,ad7780";
-	reg =	      <0>;
-	vref-supply = <&vdd_supply>
-
-	powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
-	adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
-	adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
-};
diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
new file mode 100644
index 000000000000..931bc4f8ec04
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
@@ -0,0 +1,85 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7780.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AD7170/AD7171/AD7780/AD7781 analog to digital converters
+
+maintainers:
+  - Michael Hennerich <michael.hennerich@analog.com>
+
+description: |
+  The ad7780 is a sigma-delta analog to digital converter. This driver provides
+  reading voltage values and status bits from both the ad778x and ad717x series.
+  Its interface also allows writing on the FILTER and GAIN GPIO pins on the
+  ad778x.
+
+  Specifications on the converters can be found at:
+    AD7170:
+      https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
+    AD7171:
+      https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
+    AD7780:
+      https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
+    AD7781:
+      https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,ad7170
+      - adi,ad7171
+      - adi,ad7780
+      - adi,ad7781
+
+  reg:
+    description:
+      Chip select number for the device
+    maxItems: 1
+
+  vref-supply:
+    description:
+      The regulator supply for the ADC reference voltage
+    maxItems: 1
+
+  powerdown-gpios:
+    description:
+      Must be the device tree identifier of the PDRST pin. If
+      specified, it will be asserted during driver probe. As the
+      line is active high, it should be marked GPIO_ACTIVE_HIGH.
+    maxItems: 1
+
+  adi,gain-gpios:
+    description:
+      Must be the device tree identifier of the GAIN pin. Only for
+      the ad778x chips. If specified, it will be asserted during
+      driver probe. As the line is active low, it should be marked
+      GPIO_ACTIVE_LOW.
+    maxItems: 1
+
+  adi,filter-gpios:
+    description:
+      Must be the device tree identifier of the FILTER pin. Only
+      for the ad778x chips. If specified, it will be asserted
+      during driver probe. As the line is active low, it should be
+      marked GPIO_ACTIVE_LOW.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    adc@0 {
+      compatible =  "adi,ad7780";
+      reg = <0>;
+      vref-supply = <&vdd_supply>;
+
+      powerdown-gpios  = <&gpio0 12 GPIO_ACTIVE_HIGH>;
+      adi,gain-gpios   = <&gpio1  5 GPIO_ACTIVE_LOW>;
+      adi,filter-gpios = <&gpio2 15 GPIO_ACTIVE_LOW>;
+    };
-- 
2.21.0


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding
  2019-05-18 22:41 [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding Renato Lui Geh
@ 2019-05-19 11:32 ` Jonathan Cameron
  2019-05-20  8:32   ` Ardelean, Alexandru
  0 siblings, 1 reply; 5+ messages in thread
From: Jonathan Cameron @ 2019-05-19 11:32 UTC (permalink / raw)
  To: Renato Lui Geh
  Cc: lars, Michael.Hennerich, knaack.h, pmeerw, gregkh, stefan.popa,
	alexandru.Ardelean, robh+dt, mark.rutland, linux-iio, devel,
	linux-kernel, kernel-usp, devicetree

On Sat, 18 May 2019 19:41:12 -0300
Renato Lui Geh <renatogeh@gmail.com> wrote:

> This patch adds a YAML binding for the Analog Devices AD7780/1 and
> AD7170/1 analog-to-digital converters.
> 
> Signed-off-by: Renato Lui Geh <renatogeh@gmail.com>
One comment inline.  I'll also be needing an ack from Analog on this,
preferably Michael's.

Thanks,

Jonathan
> ---
>  .../bindings/iio/adc/adi,ad7780.txt           | 48 -----------
>  .../bindings/iio/adc/adi,ad7780.yaml          | 85 +++++++++++++++++++
>  2 files changed, 85 insertions(+), 48 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> deleted file mode 100644
> index 440e52555349..000000000000
> --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> +++ /dev/null
> @@ -1,48 +0,0 @@
> -* Analog Devices AD7170/AD7171/AD7780/AD7781
> -
> -Data sheets:
> -
> -- AD7170:
> -	* https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
> -- AD7171:
> -	* https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
> -- AD7780:
> -	* https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
> -- AD7781:
> -	* https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
> -
> -Required properties:
> -
> -- compatible: should be one of
> -	* "adi,ad7170"
> -	* "adi,ad7171"
> -	* "adi,ad7780"
> -	* "adi,ad7781"
> -- reg: spi chip select number for the device
> -- vref-supply: the regulator supply for the ADC reference voltage
> -
> -Optional properties:
> -
> -- powerdown-gpios:  must be the device tree identifier of the PDRST pin. If
> -		    specified, it will be asserted during driver probe. As the
> -		    line is active high, it should be marked GPIO_ACTIVE_HIGH.
> -- adi,gain-gpios:   must be the device tree identifier of the GAIN pin. Only for
> -		    the ad778x chips. If specified, it will be asserted during
> -		    driver probe. As the line is active low, it should be marked
> -		    GPIO_ACTIVE_LOW.
> -- adi,filter-gpios: must be the device tree identifier of the FILTER pin. Only
> -		    for the ad778x chips. 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,ad7780";
> -	reg =	      <0>;
> -	vref-supply = <&vdd_supply>
> -
> -	powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
> -	adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
> -	adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
> -};
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> new file mode 100644
> index 000000000000..931bc4f8ec04
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> @@ -0,0 +1,85 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/adi,ad7780.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AD7170/AD7171/AD7780/AD7781 analog to digital converters
> +
> +maintainers:
> +  - Michael Hennerich <michael.hennerich@analog.com>
> +
> +description: |
> +  The ad7780 is a sigma-delta analog to digital converter. This driver provides
> +  reading voltage values and status bits from both the ad778x and ad717x series.
> +  Its interface also allows writing on the FILTER and GAIN GPIO pins on the
> +  ad778x.
> +
> +  Specifications on the converters can be found at:
> +    AD7170:
> +      https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
> +    AD7171:
> +      https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
> +    AD7780:
> +      https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
> +    AD7781:
> +      https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,ad7170
> +      - adi,ad7171
> +      - adi,ad7780
> +      - adi,ad7781
> +
> +  reg:
> +    description:
> +      Chip select number for the device
> +    maxItems: 1
> +
> +  vref-supply:
> +    description:
> +      The regulator supply for the ADC reference voltage
> +    maxItems: 1
> +
> +  powerdown-gpios:
> +    description:
> +      Must be the device tree identifier of the PDRST pin. If
> +      specified, it will be asserted during driver probe. As the
> +      line is active high, it should be marked GPIO_ACTIVE_HIGH.
> +    maxItems: 1
> +
> +  adi,gain-gpios:
> +    description:
> +      Must be the device tree identifier of the GAIN pin. Only for
> +      the ad778x chips. If specified, it will be asserted during
> +      driver probe. As the line is active low, it should be marked
> +      GPIO_ACTIVE_LOW.
> +    maxItems: 1
> +
> +  adi,filter-gpios:
> +    description:
> +      Must be the device tree identifier of the FILTER pin. Only
> +      for the ad778x chips. If specified, it will be asserted
> +      during driver probe. As the line is active low, it should be
> +      marked GPIO_ACTIVE_LOW.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - vref-supply
Is that actually true?  I'd imagine it'll use a stub regulator if
it isn't supplied.

> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    adc@0 {
> +      compatible =  "adi,ad7780";
> +      reg = <0>;
> +      vref-supply = <&vdd_supply>;
> +
> +      powerdown-gpios  = <&gpio0 12 GPIO_ACTIVE_HIGH>;
> +      adi,gain-gpios   = <&gpio1  5 GPIO_ACTIVE_LOW>;
> +      adi,filter-gpios = <&gpio2 15 GPIO_ACTIVE_LOW>;
> +    };


^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding
  2019-05-19 11:32 ` Jonathan Cameron
@ 2019-05-20  8:32   ` Ardelean, Alexandru
  2019-05-25  0:28     ` Renato Lui Geh
  0 siblings, 1 reply; 5+ messages in thread
From: Ardelean, Alexandru @ 2019-05-20  8:32 UTC (permalink / raw)
  To: renatogeh, jic23
  Cc: kernel-usp, lars, robh+dt, Popa, Stefan Serban, knaack.h,
	linux-kernel, devicetree, Hennerich, Michael, linux-iio, devel,
	mark.rutland, pmeerw, gregkh

On Sun, 2019-05-19 at 12:32 +0100, Jonathan Cameron wrote:
> [External]
> 
> 
> On Sat, 18 May 2019 19:41:12 -0300
> Renato Lui Geh <renatogeh@gmail.com> wrote:
> 
> > This patch adds a YAML binding for the Analog Devices AD7780/1 and
> > AD7170/1 analog-to-digital converters.
> > 
> > Signed-off-by: Renato Lui Geh <renatogeh@gmail.com>
> 
> One comment inline.  I'll also be needing an ack from Analog on this,
> preferably Michael's.
> 
> Thanks,
> 
> Jonathan
> > ---
> >  .../bindings/iio/adc/adi,ad7780.txt           | 48 -----------
> >  .../bindings/iio/adc/adi,ad7780.yaml          | 85 +++++++++++++++++++

You should also update the MAINTAINERS file.
Maybe in a following patch.
It looks like there is not entry in there, so maybe you need to add a new
one.

Something like:


ANALOG DEVICES INC AD7780 DRIVER
M:      Michael Hennerich <Michael.Hennerich@analog.com>
M:      Renato Lui Geh <renatogeh@gmail.com>
L:      linux-iio@vger.kernel.org
W:      http://ez.analog.com/community/linux-device-drivers
S:      Supported
F:      drivers/iio/adc/ad7780.c
F:      Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml

This should be after this block
ANALOG DEVICES INC AD7768-1 DRIVER

Note that I added you as a co-maintainer.
If you want, you do not need to add that line.

> >  2 files changed, 85 insertions(+), 48 deletions(-)
> >  delete mode 100644
> > Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> >  create mode 100644
> > Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> > b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> > deleted file mode 100644
> > index 440e52555349..000000000000
> > --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> > +++ /dev/null
> > @@ -1,48 +0,0 @@
> > -* Analog Devices AD7170/AD7171/AD7780/AD7781
> > -
> > -Data sheets:
> > -
> > -- AD7170:
> > -     * 
> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
> > -- AD7171:
> > -     * 
> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
> > -- AD7780:
> > -     * 
> > https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
> > -- AD7781:
> > -     * 
> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
> > -
> > -Required properties:
> > -
> > -- compatible: should be one of
> > -     * "adi,ad7170"
> > -     * "adi,ad7171"
> > -     * "adi,ad7780"
> > -     * "adi,ad7781"
> > -- reg: spi chip select number for the device
> > -- vref-supply: the regulator supply for the ADC reference voltage
> > -
> > -Optional properties:
> > -
> > -- powerdown-gpios:  must be the device tree identifier of the PDRST
> > pin. If
> > -                 specified, it will be asserted during driver probe.
> > As the
> > -                 line is active high, it should be marked
> > GPIO_ACTIVE_HIGH.
> > -- adi,gain-gpios:   must be the device tree identifier of the GAIN
> > pin. Only for
> > -                 the ad778x chips. If specified, it will be asserted
> > during
> > -                 driver probe. As the line is active low, it should be
> > marked
> > -                 GPIO_ACTIVE_LOW.
> > -- adi,filter-gpios: must be the device tree identifier of the FILTER
> > pin. Only
> > -                 for the ad778x chips. 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,ad7780";
> > -     reg =         <0>;
> > -     vref-supply = <&vdd_supply>
> > -
> > -     powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
> > -     adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
> > -     adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> > b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> > new file mode 100644
> > index 000000000000..931bc4f8ec04
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> > @@ -0,0 +1,85 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/adc/adi,ad7780.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Analog Devices AD7170/AD7171/AD7780/AD7781 analog to digital
> > converters
> > +
> > +maintainers:
> > +  - Michael Hennerich <michael.hennerich@analog.com>
> > +
> > +description: |
> > +  The ad7780 is a sigma-delta analog to digital converter. This driver
> > provides
> > +  reading voltage values and status bits from both the ad778x and
> > ad717x series.
> > +  Its interface also allows writing on the FILTER and GAIN GPIO pins
> > on the
> > +  ad778x.
> > +
> > +  Specifications on the converters can be found at:
> > +    AD7170:
> > +      
> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
> > +    AD7171:
> > +      
> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
> > +    AD7780:
> > +      
> > https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
> > +    AD7781:
> > +      
> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - adi,ad7170
> > +      - adi,ad7171
> > +      - adi,ad7780
> > +      - adi,ad7781
> > +
> > +  reg:
> > +    description:
> > +      Chip select number for the device

No need to add a description.
This is pretty standard.

> > +    maxItems: 1
> > +
> > +  vref-supply:
> > +    description:
> > +      The regulator supply for the ADC reference voltage
> > +    maxItems: 1
> > +

As I see in the driver, it's not vref-supply, it's avdd-supply.

> > +  powerdown-gpios:
> > +    description:
> > +      Must be the device tree identifier of the PDRST pin. If
> > +      specified, it will be asserted during driver probe. As the
> > +      line is active high, it should be marked GPIO_ACTIVE_HIGH.
> > +    maxItems: 1
> > +
> > +  adi,gain-gpios:
> > +    description:
> > +      Must be the device tree identifier of the GAIN pin. Only for
> > +      the ad778x chips. If specified, it will be asserted during
> > +      driver probe. As the line is active low, it should be marked
> > +      GPIO_ACTIVE_LOW.
> > +    maxItems: 1
> > +
> > +  adi,filter-gpios:
> > +    description:
> > +      Must be the device tree identifier of the FILTER pin. Only
> > +      for the ad778x chips. If specified, it will be asserted
> > +      during driver probe. As the line is active low, it should be
> > +      marked GPIO_ACTIVE_LOW.
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - vref-supply
> 
> Is that actually true?  I'd imagine it'll use a stub regulator if
> it isn't supplied.

Hmm, I also think this can be omitted as required.
devm_regulator_get() is used.
devm_regulator_get_exclusive() would be needed to make this required.

> 
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/gpio/gpio.h>
> > +    adc@0 {

The adc@0 block should be included in a spi block.

So, something like

spi0 {
     adc@0 {
            compatible =  "adi,ad7780";
            reg =         <0>;
            avdd-supply = <&vdd_supply>

            powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
            adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
            adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
     };
};

I know this wasn't the case before, but it should be (from what I recall).

> > +      compatible =  "adi,ad7780";
> > +      reg = <0>;
> > +      vref-supply = <&vdd_supply>;
> > +
> > +      powerdown-gpios  = <&gpio0 12 GPIO_ACTIVE_HIGH>;
> > +      adi,gain-gpios   = <&gpio1  5 GPIO_ACTIVE_LOW>;
> > +      adi,filter-gpios = <&gpio2 15 GPIO_ACTIVE_LOW>;

Rest looks good.

Thanks
Alex

> > +    };
> 
> 

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding
  2019-05-20  8:32   ` Ardelean, Alexandru
@ 2019-05-25  0:28     ` Renato Lui Geh
  2019-05-26 17:50       ` Jonathan Cameron
  0 siblings, 1 reply; 5+ messages in thread
From: Renato Lui Geh @ 2019-05-25  0:28 UTC (permalink / raw)
  To: Ardelean, Alexandru
  Cc: renatogeh, jic23, kernel-usp, lars, robh+dt, Popa, Stefan Serban,
	knaack.h, linux-kernel, devicetree, Hennerich, Michael,
	linux-iio, devel, mark.rutland, pmeerw, gregkh

Hi Jonathan, Alex,

Thanks for the review. Some comments inline.

Thanks,
Renato

On 05/20, Ardelean, Alexandru wrote:
>On Sun, 2019-05-19 at 12:32 +0100, Jonathan Cameron wrote:
>> [External]
>>
>>
>> On Sat, 18 May 2019 19:41:12 -0300
>> Renato Lui Geh <renatogeh@gmail.com> wrote:
>>
>> > This patch adds a YAML binding for the Analog Devices AD7780/1 and
>> > AD7170/1 analog-to-digital converters.
>> >
>> > Signed-off-by: Renato Lui Geh <renatogeh@gmail.com>
>>
>> One comment inline.  I'll also be needing an ack from Analog on this,
>> preferably Michael's.
>>
>> Thanks,
>>
>> Jonathan
>> > ---
>> >  .../bindings/iio/adc/adi,ad7780.txt           | 48 -----------
>> >  .../bindings/iio/adc/adi,ad7780.yaml          | 85 +++++++++++++++++++
>
>You should also update the MAINTAINERS file.
>Maybe in a following patch.
>It looks like there is not entry in there, so maybe you need to add a new
>one.
>
>Something like:
>
>
>ANALOG DEVICES INC AD7780 DRIVER
>M:      Michael Hennerich <Michael.Hennerich@analog.com>
>M:      Renato Lui Geh <renatogeh@gmail.com>
>L:      linux-iio@vger.kernel.org
>W:      http://ez.analog.com/community/linux-device-drivers
>S:      Supported
>F:      drivers/iio/adc/ad7780.c
>F:      Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
>
>This should be after this block
>ANALOG DEVICES INC AD7768-1 DRIVER
>
>Note that I added you as a co-maintainer.
>If you want, you do not need to add that line.
>
>> >  2 files changed, 85 insertions(+), 48 deletions(-)
>> >  delete mode 100644
>> > Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
>> >  create mode 100644
>> > Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
>> >
>> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
>> > b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
>> > deleted file mode 100644
>> > index 440e52555349..000000000000
>> > --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
>> > +++ /dev/null
>> > @@ -1,48 +0,0 @@
>> > -* Analog Devices AD7170/AD7171/AD7780/AD7781
>> > -
>> > -Data sheets:
>> > -
>> > -- AD7170:
>> > -     *
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
>> > -- AD7171:
>> > -     *
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
>> > -- AD7780:
>> > -     *
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
>> > -- AD7781:
>> > -     *
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
>> > -
>> > -Required properties:
>> > -
>> > -- compatible: should be one of
>> > -     * "adi,ad7170"
>> > -     * "adi,ad7171"
>> > -     * "adi,ad7780"
>> > -     * "adi,ad7781"
>> > -- reg: spi chip select number for the device
>> > -- vref-supply: the regulator supply for the ADC reference voltage
>> > -
>> > -Optional properties:
>> > -
>> > -- powerdown-gpios:  must be the device tree identifier of the PDRST
>> > pin. If
>> > -                 specified, it will be asserted during driver probe.
>> > As the
>> > -                 line is active high, it should be marked
>> > GPIO_ACTIVE_HIGH.
>> > -- adi,gain-gpios:   must be the device tree identifier of the GAIN
>> > pin. Only for
>> > -                 the ad778x chips. If specified, it will be asserted
>> > during
>> > -                 driver probe. As the line is active low, it should be
>> > marked
>> > -                 GPIO_ACTIVE_LOW.
>> > -- adi,filter-gpios: must be the device tree identifier of the FILTER
>> > pin. Only
>> > -                 for the ad778x chips. 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,ad7780";
>> > -     reg =         <0>;
>> > -     vref-supply = <&vdd_supply>
>> > -
>> > -     powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
>> > -     adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
>> > -     adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
>> > -};
>> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
>> > b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
>> > new file mode 100644
>> > index 000000000000..931bc4f8ec04
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
>> > @@ -0,0 +1,85 @@
>> > +# SPDX-License-Identifier: GPL-2.0
>> > +%YAML 1.2
>> > +---
>> > +$id: http://devicetree.org/schemas/iio/adc/adi,ad7780.yaml#
>> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> > +
>> > +title: Analog Devices AD7170/AD7171/AD7780/AD7781 analog to digital
>> > converters
>> > +
>> > +maintainers:
>> > +  - Michael Hennerich <michael.hennerich@analog.com>
>> > +
>> > +description: |
>> > +  The ad7780 is a sigma-delta analog to digital converter. This driver
>> > provides
>> > +  reading voltage values and status bits from both the ad778x and
>> > ad717x series.
>> > +  Its interface also allows writing on the FILTER and GAIN GPIO pins
>> > on the
>> > +  ad778x.
>> > +
>> > +  Specifications on the converters can be found at:
>> > +    AD7170:
>> > +
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
>> > +    AD7171:
>> > +
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
>> > +    AD7780:
>> > +
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
>> > +    AD7781:
>> > +
>> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
>> > +
>> > +properties:
>> > +  compatible:
>> > +    enum:
>> > +      - adi,ad7170
>> > +      - adi,ad7171
>> > +      - adi,ad7780
>> > +      - adi,ad7781
>> > +
>> > +  reg:
>> > +    description:
>> > +      Chip select number for the device
>
>No need to add a description.
>This is pretty standard.
>
>> > +    maxItems: 1
>> > +
>> > +  vref-supply:
>> > +    description:
>> > +      The regulator supply for the ADC reference voltage
>> > +    maxItems: 1
>> > +
>
>As I see in the driver, it's not vref-supply, it's avdd-supply.

You're absolutely right. Shouldn't have mindlessly copied
from the txt, even though the txt's was also my fault.

By the way, a quick look at ad7170 and ad7780's datasheets
shows that the 7170 uses VDD, and the 7780, AVDD. Are they
equivalent?
>
>> > +  powerdown-gpios:
>> > +    description:
>> > +      Must be the device tree identifier of the PDRST pin. If
>> > +      specified, it will be asserted during driver probe. As the
>> > +      line is active high, it should be marked GPIO_ACTIVE_HIGH.
>> > +    maxItems: 1
>> > +
>> > +  adi,gain-gpios:
>> > +    description:
>> > +      Must be the device tree identifier of the GAIN pin. Only for
>> > +      the ad778x chips. If specified, it will be asserted during
>> > +      driver probe. As the line is active low, it should be marked
>> > +      GPIO_ACTIVE_LOW.
>> > +    maxItems: 1
>> > +
>> > +  adi,filter-gpios:
>> > +    description:
>> > +      Must be the device tree identifier of the FILTER pin. Only
>> > +      for the ad778x chips. If specified, it will be asserted
>> > +      during driver probe. As the line is active low, it should be
>> > +      marked GPIO_ACTIVE_LOW.
>> > +    maxItems: 1
>> > +
>> > +required:
>> > +  - compatible
>> > +  - reg
>> > +  - vref-supply
>>
>> Is that actually true?  I'd imagine it'll use a stub regulator if
>> it isn't supplied.
>
>Hmm, I also think this can be omitted as required.
>devm_regulator_get() is used.
>devm_regulator_get_exclusive() would be needed to make this required.

I see. So the difference between devm_regulator_get and
devm_regulator_get_optional is that the former uses a stub
when the requested reg isn't supplied, and the latter
doesn't?
>
>>
>> > +
>> > +examples:
>> > +  - |
>> > +    #include <dt-bindings/gpio/gpio.h>
>> > +    adc@0 {
>
>The adc@0 block should be included in a spi block.
>
>So, something like
>
>spi0 {
>     adc@0 {
>            compatible =  "adi,ad7780";
>            reg =         <0>;
>            avdd-supply = <&vdd_supply>
>
>            powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
>            adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
>            adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
>     };
>};
>
>I know this wasn't the case before, but it should be (from what I recall).
>
>> > +      compatible =  "adi,ad7780";
>> > +      reg = <0>;
>> > +      vref-supply = <&vdd_supply>;
>> > +
>> > +      powerdown-gpios  = <&gpio0 12 GPIO_ACTIVE_HIGH>;
>> > +      adi,gain-gpios   = <&gpio1  5 GPIO_ACTIVE_LOW>;
>> > +      adi,filter-gpios = <&gpio2 15 GPIO_ACTIVE_LOW>;
>
>Rest looks good.
>
>Thanks
>Alex
>
>> > +    };
>>
>>

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding
  2019-05-25  0:28     ` Renato Lui Geh
@ 2019-05-26 17:50       ` Jonathan Cameron
  0 siblings, 0 replies; 5+ messages in thread
From: Jonathan Cameron @ 2019-05-26 17:50 UTC (permalink / raw)
  To: Renato Lui Geh
  Cc: Ardelean, Alexandru, kernel-usp, lars, robh+dt, Popa,
	Stefan Serban, knaack.h, linux-kernel, devicetree, Hennerich,
	Michael, linux-iio, devel, mark.rutland, pmeerw, gregkh

On Fri, 24 May 2019 21:28:02 -0300
Renato Lui Geh <renatogeh@gmail.com> wrote:

> Hi Jonathan, Alex,
> 
> Thanks for the review. Some comments inline.
> 
> Thanks,
> Renato
> 
> On 05/20, Ardelean, Alexandru wrote:
> >On Sun, 2019-05-19 at 12:32 +0100, Jonathan Cameron wrote:  
> >> [External]
> >>
> >>
> >> On Sat, 18 May 2019 19:41:12 -0300
> >> Renato Lui Geh <renatogeh@gmail.com> wrote:
> >>  
> >> > This patch adds a YAML binding for the Analog Devices AD7780/1 and
> >> > AD7170/1 analog-to-digital converters.
> >> >
> >> > Signed-off-by: Renato Lui Geh <renatogeh@gmail.com>  
> >>
> >> One comment inline.  I'll also be needing an ack from Analog on this,
> >> preferably Michael's.
> >>
> >> Thanks,
> >>
> >> Jonathan  
> >> > ---
> >> >  .../bindings/iio/adc/adi,ad7780.txt           | 48 -----------
> >> >  .../bindings/iio/adc/adi,ad7780.yaml          | 85 +++++++++++++++++++  
> >
> >You should also update the MAINTAINERS file.
> >Maybe in a following patch.
> >It looks like there is not entry in there, so maybe you need to add a new
> >one.
> >
> >Something like:
> >
> >
> >ANALOG DEVICES INC AD7780 DRIVER
> >M:      Michael Hennerich <Michael.Hennerich@analog.com>
> >M:      Renato Lui Geh <renatogeh@gmail.com>
> >L:      linux-iio@vger.kernel.org
> >W:      http://ez.analog.com/community/linux-device-drivers
> >S:      Supported
> >F:      drivers/iio/adc/ad7780.c
> >F:      Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> >
> >This should be after this block
> >ANALOG DEVICES INC AD7768-1 DRIVER
> >
> >Note that I added you as a co-maintainer.
> >If you want, you do not need to add that line.
> >  
> >> >  2 files changed, 85 insertions(+), 48 deletions(-)
> >> >  delete mode 100644
> >> > Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> >> >  create mode 100644
> >> > Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> >> >
> >> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> >> > b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> >> > deleted file mode 100644
> >> > index 440e52555349..000000000000
> >> > --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.txt
> >> > +++ /dev/null
> >> > @@ -1,48 +0,0 @@
> >> > -* Analog Devices AD7170/AD7171/AD7780/AD7781
> >> > -
> >> > -Data sheets:
> >> > -
> >> > -- AD7170:
> >> > -     *
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
> >> > -- AD7171:
> >> > -     *
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
> >> > -- AD7780:
> >> > -     *
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
> >> > -- AD7781:
> >> > -     *
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
> >> > -
> >> > -Required properties:
> >> > -
> >> > -- compatible: should be one of
> >> > -     * "adi,ad7170"
> >> > -     * "adi,ad7171"
> >> > -     * "adi,ad7780"
> >> > -     * "adi,ad7781"
> >> > -- reg: spi chip select number for the device
> >> > -- vref-supply: the regulator supply for the ADC reference voltage
> >> > -
> >> > -Optional properties:
> >> > -
> >> > -- powerdown-gpios:  must be the device tree identifier of the PDRST
> >> > pin. If
> >> > -                 specified, it will be asserted during driver probe.
> >> > As the
> >> > -                 line is active high, it should be marked
> >> > GPIO_ACTIVE_HIGH.
> >> > -- adi,gain-gpios:   must be the device tree identifier of the GAIN
> >> > pin. Only for
> >> > -                 the ad778x chips. If specified, it will be asserted
> >> > during
> >> > -                 driver probe. As the line is active low, it should be
> >> > marked
> >> > -                 GPIO_ACTIVE_LOW.
> >> > -- adi,filter-gpios: must be the device tree identifier of the FILTER
> >> > pin. Only
> >> > -                 for the ad778x chips. 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,ad7780";
> >> > -     reg =         <0>;
> >> > -     vref-supply = <&vdd_supply>
> >> > -
> >> > -     powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
> >> > -     adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
> >> > -     adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
> >> > -};
> >> > diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> >> > b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> >> > new file mode 100644
> >> > index 000000000000..931bc4f8ec04
> >> > --- /dev/null
> >> > +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7780.yaml
> >> > @@ -0,0 +1,85 @@
> >> > +# SPDX-License-Identifier: GPL-2.0
> >> > +%YAML 1.2
> >> > +---
> >> > +$id: http://devicetree.org/schemas/iio/adc/adi,ad7780.yaml#
> >> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> >> > +
> >> > +title: Analog Devices AD7170/AD7171/AD7780/AD7781 analog to digital
> >> > converters
> >> > +
> >> > +maintainers:
> >> > +  - Michael Hennerich <michael.hennerich@analog.com>
> >> > +
> >> > +description: |
> >> > +  The ad7780 is a sigma-delta analog to digital converter. This driver
> >> > provides
> >> > +  reading voltage values and status bits from both the ad778x and
> >> > ad717x series.
> >> > +  Its interface also allows writing on the FILTER and GAIN GPIO pins
> >> > on the
> >> > +  ad778x.
> >> > +
> >> > +  Specifications on the converters can be found at:
> >> > +    AD7170:
> >> > +
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7170.pdf
> >> > +    AD7171:
> >> > +
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7171.pdf
> >> > +    AD7780:
> >> > +
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/ad7780.pdf
> >> > +    AD7781:
> >> > +
> >> > https://www.analog.com/media/en/technical-documentation/data-sheets/AD7781.pdf
> >> > +
> >> > +properties:
> >> > +  compatible:
> >> > +    enum:
> >> > +      - adi,ad7170
> >> > +      - adi,ad7171
> >> > +      - adi,ad7780
> >> > +      - adi,ad7781
> >> > +
> >> > +  reg:
> >> > +    description:
> >> > +      Chip select number for the device  
> >
> >No need to add a description.
> >This is pretty standard.
> >  
> >> > +    maxItems: 1
> >> > +
> >> > +  vref-supply:
> >> > +    description:
> >> > +      The regulator supply for the ADC reference voltage
> >> > +    maxItems: 1
> >> > +  
> >
> >As I see in the driver, it's not vref-supply, it's avdd-supply.  
> 
> You're absolutely right. Shouldn't have mindlessly copied
> from the txt, even though the txt's was also my fault.
> 
> By the way, a quick look at ad7170 and ad7780's datasheets
> shows that the 7170 uses VDD, and the 7780, AVDD. Are they
> equivalent?
> >  
> >> > +  powerdown-gpios:
> >> > +    description:
> >> > +      Must be the device tree identifier of the PDRST pin. If
> >> > +      specified, it will be asserted during driver probe. As the
> >> > +      line is active high, it should be marked GPIO_ACTIVE_HIGH.
> >> > +    maxItems: 1
> >> > +
> >> > +  adi,gain-gpios:
> >> > +    description:
> >> > +      Must be the device tree identifier of the GAIN pin. Only for
> >> > +      the ad778x chips. If specified, it will be asserted during
> >> > +      driver probe. As the line is active low, it should be marked
> >> > +      GPIO_ACTIVE_LOW.
> >> > +    maxItems: 1
> >> > +
> >> > +  adi,filter-gpios:
> >> > +    description:
> >> > +      Must be the device tree identifier of the FILTER pin. Only
> >> > +      for the ad778x chips. If specified, it will be asserted
> >> > +      during driver probe. As the line is active low, it should be
> >> > +      marked GPIO_ACTIVE_LOW.
> >> > +    maxItems: 1
> >> > +
> >> > +required:
> >> > +  - compatible
> >> > +  - reg
> >> > +  - vref-supply  
> >>
> >> Is that actually true?  I'd imagine it'll use a stub regulator if
> >> it isn't supplied.  
> >
> >Hmm, I also think this can be omitted as required.
> >devm_regulator_get() is used.
> >devm_regulator_get_exclusive() would be needed to make this required.  
> 
> I see. So the difference between devm_regulator_get and
> devm_regulator_get_optional is that the former uses a stub
> when the requested reg isn't supplied, and the latter
> doesn't?
Correct.  If you 'require' a regulator you actually have to use
the optional form and then check if you got one. Otherwise you get
a stub and only find out later that you can't read it's current
value.

Jonathan

> >  
> >>  
> >> > +
> >> > +examples:
> >> > +  - |
> >> > +    #include <dt-bindings/gpio/gpio.h>
> >> > +    adc@0 {  
> >
> >The adc@0 block should be included in a spi block.
> >
> >So, something like
> >
> >spi0 {
> >     adc@0 {
> >            compatible =  "adi,ad7780";
> >            reg =         <0>;
> >            avdd-supply = <&vdd_supply>
> >
> >            powerdown-gpios  = <&gpio 12 GPIO_ACTIVE_HIGH>;
> >            adi,gain-gpios   = <&gpio  5 GPIO_ACTIVE_LOW>;
> >            adi,filter-gpios = <&gpio 15 GPIO_ACTIVE_LOW>;
> >     };
> >};
> >
> >I know this wasn't the case before, but it should be (from what I recall).
> >  
> >> > +      compatible =  "adi,ad7780";
> >> > +      reg = <0>;
> >> > +      vref-supply = <&vdd_supply>;
> >> > +
> >> > +      powerdown-gpios  = <&gpio0 12 GPIO_ACTIVE_HIGH>;
> >> > +      adi,gain-gpios   = <&gpio1  5 GPIO_ACTIVE_LOW>;
> >> > +      adi,filter-gpios = <&gpio2 15 GPIO_ACTIVE_LOW>;  
> >
> >Rest looks good.
> >
> >Thanks
> >Alex
> >  
> >> > +    };  
> >>
> >>  


^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, back to index

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-05-18 22:41 [PATCH] dt-bindings: iio: adc: add adi,ad7780.yaml binding Renato Lui Geh
2019-05-19 11:32 ` Jonathan Cameron
2019-05-20  8:32   ` Ardelean, Alexandru
2019-05-25  0:28     ` Renato Lui Geh
2019-05-26 17:50       ` Jonathan Cameron

Linux-IIO Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-iio/0 linux-iio/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-iio linux-iio/ https://lore.kernel.org/linux-iio \
		linux-iio@vger.kernel.org linux-iio@archiver.kernel.org
	public-inbox-index linux-iio


Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-iio


AGPL code for this site: git clone https://public-inbox.org/ public-inbox