| Message ID | 20200317201710.23180-3-alazar@startmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Maxim MAX1241 driver | expand |
On Tue, 2020-03-17 at 22:17 +0200, Alexandru Lazar wrote: > [External] > > Add device-tree bindings documentation for the MAX1241 device driver. > curious: did you run dt_binding_check ? typically what i do is: ARCH=arm make defconfig # no idea why this is still needed for bindings check # i mean, i see the deps, but i don't feel is needed # ¯\_(ツ)_/¯ ARCH=arm make dt_binding_check \ DT_SCHEMA_FILES=Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml # should be on one line # for dependencies, see https://github.com/torvalds/linux/blob/master/Documentation/devicetree/writing-schema.rst#dependencies It might be that Rob's bot will come back and tell us anything wrong with this file. > Signed-off-by: Alexandru Lazar <alazar@startmail.com> > --- > .../bindings/iio/adc/maxim,max1241.yaml | 60 +++++++++++++++++++ > 1 file changed, 60 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..abb90d382067 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml > @@ -0,0 +1,60 @@ > +# SPDX-License-Identifier: GPL-2.0 > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/iio/adc/adi,ad7780.yaml# This isn't AD7780 :p adi,ad7780.yaml# -> 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: > + maxItems: 1 > + > + vref-supply: > + description: > + Device tree identifier of the regulator that provides the external > + reference voltage. > + maxItems: 1 > + > + spi-max-frequency: > + maxItems: 1 this could probably be omitted; it's documented in some spi.yaml file and is considered a standard property > + > + 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 { > + adc@0 { > + compatible = "maxim,max1241"; > + reg = <0>; > + vref-supply = <&vdd_3v3_reg>; > + spi-max-frequency = <1000000>; > + shdn-gpios = <&gpio 26 1>; > + }; > + }; > + > +
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..abb90d382067 --- /dev/null +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml @@ -0,0 +1,60 @@ +# 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: 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: + maxItems: 1 + + vref-supply: + description: + Device tree identifier of the regulator that provides the external + reference voltage. + maxItems: 1 + + spi-max-frequency: + 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 { + 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 | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 Documentation/devicetree/bindings/iio/adc/maxim,max1241.yaml