diff mbox series

[v2,1/4] iio: ti-ads124s08: Add DT binding documentation

Message ID 20181211191207.21900-1-dmurphy@ti.com
State Superseded
Headers show
Series [v2,1/4] iio: ti-ads124s08: Add DT binding documentation | expand

Commit Message

Dan Murphy Dec. 11, 2018, 7:12 p.m. UTC
Adding binding documentation for Texas Instruments ADS124S08
and ADS124S06 ADC.

S08 is a 12 channel ADC
S06 is a 6 channel ADC

Datesheet can be found here:
http://www.ti.com/lit/gpn/ads124s08

Signed-off-by: Dan Murphy <dmurphy@ti.com>

---

v2 - Fixed incorrect compatible example and removed vref-supply - https://lore.kernel.org/patchwork/patch/1021047/

 .../bindings/iio/adc/ti-ads124s08.txt         | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt

-- 
2.20.0.rc2.7.g965798d1f2

Comments

Jonathan Cameron Dec. 16, 2018, 10:52 a.m. UTC | #1
On Tue, 11 Dec 2018 13:12:04 -0600
Dan Murphy <dmurphy@ti.com> wrote:

> Adding binding documentation for Texas Instruments ADS124S08

> and ADS124S06 ADC.

> 

> S08 is a 12 channel ADC

> S06 is a 6 channel ADC

> 

> Datesheet can be found here:

> http://www.ti.com/lit/gpn/ads124s08

> 

> Signed-off-by: Dan Murphy <dmurphy@ti.com>

> ---

> 

> v2 - Fixed incorrect compatible example and removed vref-supply - https://lore.kernel.org/patchwork/patch/1021047/


There is a reasonable argument to put the binding in there even if
not currently used.   However, I see it actually has multiple
power supplies, so perhaps this needs more thought first.

One other thing inline that I 'might' 'fix' depending on what is later
in the series.

> 

>  .../bindings/iio/adc/ti-ads124s08.txt         | 23 +++++++++++++++++++

>  1 file changed, 23 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt

> 

> diff --git a/Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt b/Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt

> new file mode 100644

> index 000000000000..6993e76e61c6

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt

> @@ -0,0 +1,23 @@

> +* Texas Instruments' ads124s08 and ads124s06 ADC chip

> +

> +Required properties:

> + - compatible: Should be "ti,ads124s08" or "ti,ads124s06"

One per line.
- compatible: Should be one of
	"ti..."
	"ti..."

It's easier to add other parts with out having to rewrite the sentence
to cover the now more than 2 case.

If that's all I find in the series, I'll just fix it up when applying.

Jonathan
> + - reg: spi chip select number for the device

> +

> +Recommended properties:

> + - spi-max-frequency: Definition as per

> +		Documentation/devicetree/bindings/spi/spi-bus.txt

> + - spi-cpha: Definition as per

> +		Documentation/devicetree/bindings/spi/spi-bus.txt

> +

> +Optional properties:

> + - reset-gpios: GPIO pin used to reset the device.

> +

> +Example:

> +adc@0 {

> +	compatible = "ti,ads124s08";

> +	reg = <0>;

> +	spi-max-frequency = <1000000>;

> +	spi-cpha;

> +	reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;

> +};
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt b/Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt
new file mode 100644
index 000000000000..6993e76e61c6
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/ti-ads124s08.txt
@@ -0,0 +1,23 @@ 
+* Texas Instruments' ads124s08 and ads124s06 ADC chip
+
+Required properties:
+ - compatible: Should be "ti,ads124s08" or "ti,ads124s06"
+ - reg: spi chip select number for the device
+
+Recommended properties:
+ - spi-max-frequency: Definition as per
+		Documentation/devicetree/bindings/spi/spi-bus.txt
+ - spi-cpha: Definition as per
+		Documentation/devicetree/bindings/spi/spi-bus.txt
+
+Optional properties:
+ - reset-gpios: GPIO pin used to reset the device.
+
+Example:
+adc@0 {
+	compatible = "ti,ads124s08";
+	reg = <0>;
+	spi-max-frequency = <1000000>;
+	spi-cpha;
+	reset-gpios = <&gpio1 16 GPIO_ACTIVE_LOW>;
+};