| Message ID | 20200319162937.34664-3-alazar@startmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Maxim MAX1241 driver | expand |
On Thu, 2020-03-19 at 18:29 +0200, Alexandru Lazar wrote: > Add device-tree bindings documentation for the MAX1241 device driver. > > Signed-off-by: Alexandru Lazar <alazar@startmail.com> > --- > .../bindings/iio/adc/maxim,max1241.yaml | 62 +++++++++++++++++++ > 1 file changed, 62 insertions(+) > create mode 100644 > Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml > > diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml > b/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml > new file mode 100644 > index 000000000000..28c73ed795aa > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml > @@ -0,0 +1,62 @@ > +# SPDX-License-Identifier: GPL-2.0 > +# Copyright 2020 Ioan-Alexandru Lazar > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: Maxim MAX1241 12-bit, single-channel analog to digital converter > + > +maintainers: > + - Ioan-Alexandru Lazar <alazar@startmail.com> > + > +description: | > + Bindings for the max1241 12-bit, single-channel ADC device. This > + driver supports voltage reading and can optionally be configured for > + power-down mode operation. The datasheet can be found at: > + https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf > + > +properties: > + compatible: > + enum: > + - maxim,max1241 > + > + reg: > + description: SPI chip select number for this device Rob will probably complain that you don't need to document[add description] to standard attributes [like SPI's 'reg' parameter] Just listing it here, should be sufficient. So, you can drop the description. > + maxItems: 1 > + > + vref-supply: > + description: > + Device tree identifier of the regulator that provides the external > + reference voltage. > + maxItems: 1 > + > + shdn-gpios: > + description: > + GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If > + specified, the /SHDN pin will be asserted between conversions, > + thus enabling power-down mode. > + maxItems: 1 > + > +required: > + - compatible > + - reg > + - vref-supply > + > +examples: > + - | > + #include <dt-bindings/gpio/gpio.h> > + spi0 { > + #address-cells = <1>; > + #size-cells = <0>; > + > + adc@0 { > + compatible = "maxim,max1241"; > + reg = <0>; > + vref-supply = <&vdd_3v3_reg>; > + spi-max-frequency = <1000000>; > + shdn-gpios = <&gpio 26 1>; > + }; > + }; > + > +
> > + reg: > > + description: SPI chip select number for this device > > Rob will probably complain that you don't need to document[add description] to > standard attributes [like SPI's 'reg' parameter] > Just listing it here, should be sufficient. So, you can drop the > description. Makes sense -- should've thought of it, considering I dropped the doc for spi-frequency as well. My brain is still wired to the non-standard txt docs it seems, sorry! I'm going to make a v4 for this (I think I need to reorder the patch series anyway -- the dt-bindings should come first) and Cc: the dt-bindings list with as well. Thanks again for all your help! Best regards, Alex
On Fri, 2020-03-20 at 10:33 +0200, Alexandru Lazar wrote: > [External] > > > > + reg: > > > + description: SPI chip select number for this device > > > > Rob will probably complain that you don't need to document[add description] > > to > > standard attributes [like SPI's 'reg' parameter] > > Just listing it here, should be sufficient. So, you can drop the > > description. > > Makes sense -- should've thought of it, considering I dropped the doc > for spi-frequency as well. My brain is still wired to the non-standard > txt docs it seems, sorry! > I think many people aren't yet super-comfortable with the new yaml format, which probably makes Rob's life a bit difficult. I guess it should become easier once version 5.4+ becomes more popular. > I'm going to make a v4 for this (I think I need to reorder the patch > series anyway -- the dt-bindings should come first) and Cc: the > dt-bindings list with as well. The order of the bindings vs code is a bit relaxed [atm]. But may become more strict [later at some point]. I think the official version is bindings-first & driver-next, but it's still accepted to do it the other way around. > > Thanks again for all your help! > > Best regards, > Alex
diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml new file mode 100644 index 000000000000..28c73ed795aa --- /dev/null +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml @@ -0,0 +1,62 @@ +# SPDX-License-Identifier: GPL-2.0 +# Copyright 2020 Ioan-Alexandru Lazar +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/iio/adc/maxim,max1241.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Maxim MAX1241 12-bit, single-channel analog to digital converter + +maintainers: + - Ioan-Alexandru Lazar <alazar@startmail.com> + +description: | + Bindings for the max1241 12-bit, single-channel ADC device. This + driver supports voltage reading and can optionally be configured for + power-down mode operation. The datasheet can be found at: + https://datasheets.maximintegrated.com/en/ds/MAX1240-MAX1241.pdf + +properties: + compatible: + enum: + - maxim,max1241 + + reg: + description: SPI chip select number for this device + maxItems: 1 + + vref-supply: + description: + Device tree identifier of the regulator that provides the external + reference voltage. + maxItems: 1 + + shdn-gpios: + description: + GPIO spec for the GPIO pin connected to the ADC's /SHDN pin. If + specified, the /SHDN pin will be asserted between conversions, + thus enabling power-down mode. + maxItems: 1 + +required: + - compatible + - reg + - vref-supply + +examples: + - | + #include <dt-bindings/gpio/gpio.h> + spi0 { + #address-cells = <1>; + #size-cells = <0>; + + adc@0 { + compatible = "maxim,max1241"; + reg = <0>; + vref-supply = <&vdd_3v3_reg>; + spi-max-frequency = <1000000>; + shdn-gpios = <&gpio 26 1>; + }; + }; + +
Add device-tree bindings documentation for the MAX1241 device driver. Signed-off-by: Alexandru Lazar <alazar@startmail.com> --- .../bindings/iio/adc/maxim,max1241.yaml | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml