Re: [PATCH] dt-bindings: iio: ad7949: switch binding to yaml

From: Alexandru Ardelean
Date: Mon May 20 2019 - 07:33:07 EST


On Sun, May 19, 2019 at 8:29 PM Jonathan Cameron <jic23@xxxxxxxxxx> wrote:
>
> On Sat, 18 May 2019 19:40:36 -0300
> JoÃo Victor Marques de Oliveira <joao.marques.oliveira@xxxxxx> wrote:
>
> > Changes switches from old text bindings, to YAML bindings, and also
> > include adi,reference-select property to specify the source for the
> > reference voltage signal.
> >
> > Signed-off-by: JoÃo Victor Marques de Oliveira <joao.marques.oliveira@xxxxxx>
> > Signed-off-by: Thiago L. A. Miller <tmiller@xxxxxxxxxxxxx>
> > Co-developed-by: Thiago L. A. Miller <tmiller@xxxxxxxxxxxxx>
> > Signed-off-by: Osvaldo M. Yasuda <omyasuda@xxxxxxxxxxxx>
> > Co-developed-by: Osvaldo M. Yasuda <omyasuda@xxxxxxxxxxxx>
> > ---
> > We're adding Charles-Antoine Couret as main dt maintainer since we have
> > just switched documentation to yaml format.
>
> Hmm. I'm not sure it makes sense to list you all as maintainers
> of this rather simple binding.
>
> We also just went through some changes on the reference handling so
> I think you are based on stale information here.
>
> Thanks,
>
> Jonathan
>
> >
> > .../devicetree/bindings/iio/adc/ad7949.txt | 16 -----
> > .../devicetree/bindings/iio/adc/ad7949.yaml | 71 +++++++++++++++++++
> > 2 files changed, 71 insertions(+), 16 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/iio/adc/ad7949.txt
> > create mode 100644 Documentation/devicetree/bindings/iio/adc/ad7949.yaml

Maybe also update the MAINTAINERS file with this.

> >
> > diff --git a/Documentation/devicetree/bindings/iio/adc/ad7949.txt b/Documentation/devicetree/bindings/iio/adc/ad7949.txt
> > deleted file mode 100644
> > index c7f5057356b1..000000000000
> > --- a/Documentation/devicetree/bindings/iio/adc/ad7949.txt
> > +++ /dev/null
> > @@ -1,16 +0,0 @@
> > -* Analog Devices AD7949/AD7682/AD7689
> > -
> > -Required properties:
> > - - compatible: Should be one of
> > - * "adi,ad7949"
> > - * "adi,ad7682"
> > - * "adi,ad7689"
> > - - reg: spi chip select number for the device
> > - - vref-supply: The regulator supply for ADC reference voltage
> > -
> > -Example:
> > -adc@0 {
> > - compatible = "adi,ad7949";
> > - reg = <0>;
> > - vref-supply = <&vdd_supply>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/iio/adc/ad7949.yaml b/Documentation/devicetree/bindings/iio/adc/ad7949.yaml
> > new file mode 100644
> > index 000000000000..111c9e26f8e7
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/adc/ad7949.yaml
> > @@ -0,0 +1,71 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/adc/ad7949.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +

nitpick: extra line

> > +title: Analog Devices AD7949/AD7682/AD7689
> > +
> > +maintainers:
> > + - Charles-Antoine Couret <charles-antoine.couret@xxxxxxxxxxxxx>
> > + - JoÃo Victor Marques de Oliveira <joao.marques.oliveira@xxxxxx>
> > + - Thiago L. A. Miller <tmiller@xxxxxxxxxxxxx>
> > + - Osvaldo M. Yasuda <omyasuda@xxxxxxxxxxxx>
> > +
> > +properties:
> > + compatible:
> > + enum:
> > + - adi,ad7949
> > + - adi,ad7682
> > + - adi,ad7689
> > +
> > + reg:
> > + description:
> > + spi chip select number for the device

this doesn't need a description
it's a standard property

> > + maxItems: 1
> > +
> > + vref-supply:
> > + description:
> > + The regulator supply for ADC reference voltage
> > + maxItems: 1
> > +
> > + adi,reference-select:
> > + enum: [0, 1, 2, 3, 6, 7]
> > + description:
> > + Select the reference voltage source to use when converting the input voltages.
> > + 0 - Internal 2.5V reference; temperature sensor enabled
> > + 1 - Internal 4.096V reference; temperature sensor enabled
> > + 2 - External reference, temperature sensor enabled, no buffer
> > + 3 - External reference, temperature sensor enabled, buffer enabled
> > + 6 - External reference, temperature sensor disabled, no buffer
> > + 7 - External reference, temperature sensor disabled, buffer enabled
> This is changing...
>
> > + maxItems: 1
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - vref-supply
> > +
> > +examples:
> > + - |
> > + spi0 {
> > + #address-cells = <0x1>;
> > + #size-cells = <0x0>;
> > + adc@0 {
> > + compatible = "adi,ad7949";
> > + reg = <0>;
> > + adi,reference-select = <0>;
> > + vref-supply = <&vdd_supply>;
> > + };
> > + };

One example is enough in this case.
They don't differ much.

> > + - |
> > + spi0 {
> > + #address-cells = <0x1>;
> > + #size-cells = <0x0>;
> > + adc@0 {
> > + compatible = "adi,ad7949";
> > + reg = <0>;
> > + adi,reference-select = <0>;
> > + };
> > + };
>