Re: [PATCH v2 3/4] dt-bindings: iio: adc: Migrate AD7606 documentation to yaml

[Rob Herring <robh+dt@kernel.org>]

On Wed, Aug 7, 2019 at 8:32 AM Beniamin Bia <beniamin.bia@analog.com> wrote:
>
> The documentation for ad7606 was migrated to yaml.
>
> Signed-off-by: Beniamin Bia <beniamin.bia@analog.com>
> ---
> Changes in v2:
> -old txt file was deleted
>
>  .../bindings/iio/adc/adi,ad7606.txt           |  66 ---------
>  .../bindings/iio/adc/adi,ad7606.yaml          | 134 ++++++++++++++++++
>  MAINTAINERS                                   |   2 +-
>  3 files changed, 135 insertions(+), 67 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7606.txt
>  create mode 100644 Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7606.txt b/Documentation/devicetree/bindings/iio/adc/adi,ad7606.txt
> deleted file mode 100644
> index d8652460198e..000000000000
> --- a/Documentation/devicetree/bindings/iio/adc/adi,ad7606.txt
> +++ /dev/null
> @@ -1,66 +0,0 @@
> -Analog Devices AD7606 Simultaneous Sampling ADC
> -
> -Required properties for the AD7606:
> -
> -- compatible: Must be one of
> -       * "adi,ad7605-4"
> -       * "adi,ad7606-8"
> -       * "adi,ad7606-6"
> -       * "adi,ad7606-4"
> -       * "adi,ad7616"
> -- reg: SPI chip select number for the device
> -- spi-max-frequency: Max SPI frequency to use
> -       see: Documentation/devicetree/bindings/spi/spi-bus.txt
> -- spi-cpha: See Documentation/devicetree/bindings/spi/spi-bus.txt
> -- avcc-supply: phandle to the Avcc power supply
> -- interrupts: IRQ line for the ADC
> -       see: Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
> -- adi,conversion-start-gpios: must be the device tree identifier of the CONVST pin.
> -                 This logic input is used to initiate conversions on the analog
> -                 input channels. As the line is active high, it should be marked
> -                 GPIO_ACTIVE_HIGH.
> -
> -Optional properties:
> -
> -- reset-gpios: must be the device tree identifier of the RESET pin. If specified,
> -              it will be asserted during driver probe. As the line is active high,
> -              it should be marked GPIO_ACTIVE_HIGH.
> -- standby-gpios: must be the device tree identifier of the STBY pin. This pin is used
> -               to place the AD7606 into one of two power-down modes, Standby mode or
> -               Shutdown mode. As the line is active low, it should be marked
> -               GPIO_ACTIVE_LOW.
> -- adi,first-data-gpios: must be the device tree identifier of the FRSTDATA pin.
> -                   The FRSTDATA output indicates when the first channel, V1, is
> -                   being read back on either the parallel, byte or serial interface.
> -                   As the line is active high, it should be marked GPIO_ACTIVE_HIGH.
> -- adi,range-gpios: must be the device tree identifier of the RANGE pin. The polarity on
> -             this pin determines the input range of the analog input channels. If
> -             this pin is tied to a logic high, the analog input range is ±10V for
> -             all channels. If this pin is tied to a logic low, the analog input range
> -             is ±5V for all channels. As the line is active high, it should be marked
> -             GPIO_ACTIVE_HIGH.
> -- adi,oversampling-ratio-gpios: must be the device tree identifier of the over-sampling
> -                               mode pins. As the line is active high, it should be marked
> -                               GPIO_ACTIVE_HIGH.
> -
> -Example:
> -
> -       adc@0 {
> -               compatible = "adi,ad7606-8";
> -               reg = <0>;
> -               spi-max-frequency = <1000000>;
> -               spi-cpol;
> -
> -               avcc-supply = <&adc_vref>;
> -
> -               interrupts = <25 IRQ_TYPE_EDGE_FALLING>;
> -               interrupt-parent = <&gpio>;
> -
> -               adi,conversion-start-gpios = <&gpio 17 GPIO_ACTIVE_HIGH>;
> -               reset-gpios = <&gpio 27 GPIO_ACTIVE_HIGH>;
> -               adi,first-data-gpios = <&gpio 22 GPIO_ACTIVE_HIGH>;
> -               adi,oversampling-ratio-gpios = <&gpio 18 GPIO_ACTIVE_HIGH
> -                                               &gpio 23 GPIO_ACTIVE_HIGH
> -                                               &gpio 26 GPIO_ACTIVE_HIGH>;
> -               standby-gpios = <&gpio 24 GPIO_ACTIVE_LOW>;
> -       };
> diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml
> new file mode 100644
> index 000000000000..509dbe9c84d2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml
> @@ -0,0 +1,134 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/adi,ad7606.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices AD7606 Simultaneous Sampling ADC
> +
> +maintainers:
> +  - Beniamin Bia <beniamin.bia@analog.com>
> +  - Stefan Popa <stefan.popa@analog.com>
> +
> +description: |
> +  Analog Devices AD7606 Simultaneous Sampling ADC
> +  https://www.analog.com/media/en/technical-documentation/data-sheets/ad7606_7606-6_7606-4.pdf
> +  https://www.analog.com/media/en/technical-documentation/data-sheets/AD7616.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,ad7605-4
> +      - adi,ad7606-8
> +      - adi,ad7606-6
> +      - adi,ad7606-4
> +      - adi,ad7616
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-cpha: true
> +
> +  avcc-supply:
> +    description:
> +      Phandle to the Avcc power supply
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  adi,conversion-start-gpios:
> +    description:
> +      Must be the device tree identifier of the CONVST pin.
> +      This logic input is used to initiate conversions on the analog
> +      input channels. As the line is active high, it should be marked
> +      GPIO_ACTIVE_HIGH.
> +    maxItems: 1
> +
> +  reset-gpios:
> +    description:
> +      Must be the device tree identifier of the RESET 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
> +
> +  standby-gpios:
> +    description:
> +       Must be the device tree identifier of the STBY pin. This pin is used
> +       to place the AD7606 into one of two power-down modes, Standby mode or
> +       Shutdown mode. As the line is active low, it should be marked
> +       GPIO_ACTIVE_LOW.
> +    maxItems: 1
> +
> +  adi,first-data-gpios:
> +    description:
> +      Must be the device tree identifier of the FRSTDATA pin.
> +      The FRSTDATA output indicates when the first channel, V1, is
> +      being read back on either the parallel, byte or serial interface.
> +      As the line is active high, it should be marked GPIO_ACTIVE_HIGH.
> +    maxItems: 1
> +
> +  adi,range-gpios:
> +    description:
> +      Must be the device tree identifier of the RANGE pin. The polarity on
> +      this pin determines the input range of the analog input channels. If
> +      this pin is tied to a logic high, the analog input range is ±10V for
> +      all channels. If this pin is tied to a logic low, the analog input range
> +      is ±5V for all channels. As the line is active high, it should be marked
> +      GPIO_ACTIVE_HIGH.
> +    maxItems: 1
> +
> +  adi,oversampling-ratio-gpios:
> +    description:
> +      Must be the device tree identifier of the over-sampling
> +      mode pins. As the line is active high, it should be marked
> +      GPIO_ACTIVE_HIGH.
> +    maxItems: 1
> +
> +  adi,sw-mode:
> +    description:
> +      Software mode of operation, so far available only for ad7616.
> +      It is enabled when all three oversampling mode pins are connected to
> +      high level. The device is configured by the corresponding registers. If the
> +      adi,oversampling-ratio-gpios property is defined, then the driver will set the
> +      oversampling gpios to high. Otherwise, it is assumed that the pins are hardwired
> +      to VDD.
> +    maxItems: 1
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +  - spi-cpha
> +  - avcc-supply
> +  - interrupts
> +  - adi,conversion-start-gpios
> +
> +examples:
> +  - |
> +    spi0 {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        adc@0 {
> +                compatible = "adi,ad7606-8";
> +                reg = <0>;
> +                spi-max-frequency = <1000000>;
> +                spi-cpol;
> +
> +                avcc-supply = <&adc_vref>;
> +
> +                interrupts = <25 IRQ_TYPE_EDGE_FALLING>;
> +                interrupt-parent = <&gpio>;
> +
> +                adi,conversion-start-gpios = <&gpio 17 GPIO_ACTIVE_HIGH>;
> +                reset-gpios = <&gpio 27 GPIO_ACTIVE_HIGH>;
> +                adi,first-data-gpios = <&gpio 22 GPIO_ACTIVE_HIGH>;
> +                adi,oversampling-ratio-gpios = <&gpio 18 GPIO_ACTIVE_HIGH
> +                                                &gpio 23 GPIO_ACTIVE_HIGH
> +                                                &gpio 26 GPIO_ACTIVE_HIGH>;

The schema defines there is only 1 GPIO, but there are 3 here. Please
fix (note this shows up in -next due to dtc update).

Rob