| Message ID | 20220824125203.685287-2-ramona.bolboaca@analog.com (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | iio: adc: add max11205 adc driver | expand |
On 24/08/2022 15:52, Ramona Bolboaca wrote: > Add bindings documentation file and MAINTAINERS entry for MAX11205. > > Signed-off-by: Ramona Bolboaca <ramona.bolboaca@analog.com> > --- > .../bindings/iio/adc/maxim,max11205.yaml | 65 +++++++++++++++++++ > MAINTAINERS | 8 +++ > 2 files changed, 73 insertions(+) > create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > > diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > new file mode 100644 > index 000000000000..bddd18a44969 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > @@ -0,0 +1,65 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/adc/maxim,max11205.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Maxim MAX11205 ADC > + > +maintainers: > + - Ramona Bolboaca <ramona.bolboaca@analog.com> > + > +description: | > + The MAX11205 is an ultra-low-power (< 300FA max > + active current), high-resolution, serial-output ADC. > + > + https://datasheets.maximintegrated.com/en/ds/MAX11205.pdf > + > +properties: > + compatible: > + enum: > + - maxim,max11205a > + - maxim,max11205b > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + spi-max-frequency: > + maximum: 5000000 > + > + spi-cpha: true Both properties are good, but still you should reference /schemas/spi/spi-peripheral-props.yaml in allOf and use unevaluatedProperties:false. See other bindings for SPI devices. > + > + vref-supply: > + description: > + The regulator supply for the ADC reference voltage. > + > +required: > + - compatible > + - reg > + - spi-max-frequency > + - spi-cpha > + - interrupts > + - vref-supply > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + max11205@0 { adc Node names should be generic. https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation > + compatible = "maxim,max11205a"; Messed up indentation. Use 4 spaces. > + reg = <0>; > + spi-max-frequency = <5000000>; > + spi-cpha; Best regards, Krzysztof
On Wed, 24 Aug 2022 15:52:02 +0300 Ramona Bolboaca <ramona.bolboaca@analog.com> wrote: > Add bindings documentation file and MAINTAINERS entry for MAX11205. > > Signed-off-by: Ramona Bolboaca <ramona.bolboaca@analog.com> Hi Ramona, Welcome to IIO. A few comments inline to add to what Krzysztof sent. Thanks, Jonathan > --- > .../bindings/iio/adc/maxim,max11205.yaml | 65 +++++++++++++++++++ > MAINTAINERS | 8 +++ > 2 files changed, 73 insertions(+) > create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > > diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > new file mode 100644 > index 000000000000..bddd18a44969 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > @@ -0,0 +1,65 @@ > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/adc/maxim,max11205.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Maxim MAX11205 ADC > + > +maintainers: > + - Ramona Bolboaca <ramona.bolboaca@analog.com> > + > +description: | > + The MAX11205 is an ultra-low-power (< 300FA max > + active current), high-resolution, serial-output ADC. Wrap lines nearer to 75-80 chars. > + > + https://datasheets.maximintegrated.com/en/ds/MAX11205.pdf > + > +properties: > + compatible: > + enum: > + - maxim,max11205a > + - maxim,max11205b > + > + reg: > + maxItems: 1 > + > + interrupts: > + maxItems: 1 > + > + spi-max-frequency: > + maximum: 5000000 > + > + spi-cpha: true > + > + vref-supply: > + description: > + The regulator supply for the ADC reference voltage. Might be worth mentioning it's a differential reference. I'm not 100% sure how we handle those... I guess as a regulator, but it's a little unusual. Jonathan > + > +required: > + - compatible > + - reg > + - spi-max-frequency > + - spi-cpha > + - interrupts > + - vref-supply > + > +additionalProperties: false > + > +examples: > + - | > + #include <dt-bindings/interrupt-controller/irq.h> > + spi { > + #address-cells = <1>; > + #size-cells = <0>; > + max11205@0 { > + compatible = "maxim,max11205a"; > + reg = <0>; > + spi-max-frequency = <5000000>; > + spi-cpha; > + interrupt-parent = <&gpio>; > + interrupts = <19 IRQ_TYPE_EDGE_FALLING>; > + vref-supply = <&max11205_vref>; > + }; > + }; > +... > diff --git a/MAINTAINERS b/MAINTAINERS > index 96f47a7865d6..db1b5dc03988 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -12341,6 +12341,14 @@ S: Maintained > F: Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml > F: drivers/iio/proximity/mb1232.c > > +MAXIM MAX11205 DRIVER > +M: Ramona Bolboaca <ramona.bolboaca@analog.com> > +L: linux-iio@vger.kernel.org > +S: Supported > +W: https://ez.analog.com/linux-software-drivers > +F: Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml > +F: drivers/iio/adc/max11205.c > + > MAXIM MAX17040 FAMILY FUEL GAUGE DRIVERS > R: Iskren Chernev <iskren.chernev@gmail.com> > R: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml new file mode 100644 index 000000000000..bddd18a44969 --- /dev/null +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml @@ -0,0 +1,65 @@ +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/adc/maxim,max11205.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Maxim MAX11205 ADC + +maintainers: + - Ramona Bolboaca <ramona.bolboaca@analog.com> + +description: | + The MAX11205 is an ultra-low-power (< 300FA max + active current), high-resolution, serial-output ADC. + + https://datasheets.maximintegrated.com/en/ds/MAX11205.pdf + +properties: + compatible: + enum: + - maxim,max11205a + - maxim,max11205b + + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + spi-max-frequency: + maximum: 5000000 + + spi-cpha: true + + vref-supply: + description: + The regulator supply for the ADC reference voltage. + +required: + - compatible + - reg + - spi-max-frequency + - spi-cpha + - interrupts + - vref-supply + +additionalProperties: false + +examples: + - | + #include <dt-bindings/interrupt-controller/irq.h> + spi { + #address-cells = <1>; + #size-cells = <0>; + max11205@0 { + compatible = "maxim,max11205a"; + reg = <0>; + spi-max-frequency = <5000000>; + spi-cpha; + interrupt-parent = <&gpio>; + interrupts = <19 IRQ_TYPE_EDGE_FALLING>; + vref-supply = <&max11205_vref>; + }; + }; +... diff --git a/MAINTAINERS b/MAINTAINERS index 96f47a7865d6..db1b5dc03988 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12341,6 +12341,14 @@ S: Maintained F: Documentation/devicetree/bindings/iio/proximity/maxbotix,mb1232.yaml F: drivers/iio/proximity/mb1232.c +MAXIM MAX11205 DRIVER +M: Ramona Bolboaca <ramona.bolboaca@analog.com> +L: linux-iio@vger.kernel.org +S: Supported +W: https://ez.analog.com/linux-software-drivers +F: Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml +F: drivers/iio/adc/max11205.c + MAXIM MAX17040 FAMILY FUEL GAUGE DRIVERS R: Iskren Chernev <iskren.chernev@gmail.com> R: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Add bindings documentation file and MAINTAINERS entry for MAX11205. Signed-off-by: Ramona Bolboaca <ramona.bolboaca@analog.com> --- .../bindings/iio/adc/maxim,max11205.yaml | 65 +++++++++++++++++++ MAINTAINERS | 8 +++ 2 files changed, 73 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max11205.yaml