public inbox for linux-iio@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: linux-iio@vger.kernel.org, Rob Herring <robh+dt@kernel.org>,
	devicetree@vger.kernel.org
Cc: Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Stefan Popa <stefan.popa@analog.com>
Subject: [PATCH 15/20] dt-bindings:iio:adc:ad7768-1 yaml conversion
Date: Sat,  5 Sep 2020 18:29:59 +0100	[thread overview]
Message-ID: <20200905173004.216081-16-jic23@kernel.org> (raw)
In-Reply-To: <20200905173004.216081-1-jic23@kernel.org>

From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Fairly straight conversion.  The one oddity in the original binding
is that spi-cpha and spi-cpol were not marked as required, but were
in the example.  Looking at the datasheet, there isn't any documented
flexibility in the possible SPI modes, so I have moved these to requires.
For spi-max-frequency I have gone the other way.  I absolutely agree
that it is good to specify this in the dt-binding, but it's not
strictly required.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Stefan Popa <stefan.popa@analog.com>
---
 .../bindings/iio/adc/adi,ad7768-1.txt         | 41 ---------
 .../bindings/iio/adc/adi,ad7768-1.yaml        | 89 +++++++++++++++++++
 2 files changed, 89 insertions(+), 41 deletions(-)

diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt
deleted file mode 100644
index 9f5b88cf680d..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-Analog Devices AD7768-1 ADC device driver
-
-Required properties for the AD7768-1:
-
-- compatible: Must be "adi,ad7768-1"
-- reg: SPI chip select number for the device
-- spi-max-frequency: Max SPI frequency to use
-	see: Documentation/devicetree/bindings/spi/spi-bus.txt
-- clocks: phandle to the master clock (mclk)
-	see: Documentation/devicetree/bindings/clock/clock-bindings.txt
-- clock-names: Must be "mclk".
-- interrupts: IRQ line for the ADC
-	see: Documentation/devicetree/bindings/interrupt-controller/interrupts.txt
-- vref-supply: vref supply can be used as reference for conversion
-- adi,sync-in-gpios: must be the device tree identifier of the SYNC-IN pin. Enables
-	synchronization of multiple devices that require simultaneous sampling.
-	A pulse is always required if the configuration is changed in any way, for example
-	if the filter decimation rate changes. As the line is active low, it should
-	be marked GPIO_ACTIVE_LOW.
-
-Optional properties:
-
- - reset-gpios : GPIO spec for the RESET pin. If specified, it will be asserted during
-	driver probe. As the line is active low, it should be marked GPIO_ACTIVE_LOW.
-
-Example:
-
-	adc@0 {
-		compatible = "adi,ad7768-1";
-		reg = <0>;
-		spi-max-frequency = <2000000>;
-		spi-cpol;
-		spi-cpha;
-		vref-supply = <&adc_vref>;
-		interrupts = <25 IRQ_TYPE_EDGE_RISING>;
-		interrupt-parent = <&gpio>;
-		adi,sync-in-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
-		reset-gpios = <&gpio 27 GPIO_ACTIVE_LOW>;
-		clocks = <&ad7768_mclk>;
-		clock-names = "mclk";
-	};
diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml
new file mode 100644
index 000000000000..a2c559d0c947
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7768-1.yaml
@@ -0,0 +1,89 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7768-1.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AD7768-1 ADC device driver
+
+maintainers:
+  - Stefan Popa <stefan.popa@analog.com>
+
+description: |
+  Datasheet at:
+    https://www.analog.com/media/en/technical-documentation/data-sheets/ad7768-1.pdf
+
+properties:
+  compatible:
+    const: adi,ad7768-1
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    const: mclk
+
+  interrupts:
+    maxItems: 1
+
+  vref-supply:
+    description:
+      ADC reference voltage supply
+
+  adi,sync-in-gpios:
+    description:
+      Enables synchronization of multiple devices that require simultaneous
+      sampling. A pulse is always required if the configuration is changed
+      in any way, for example if the filter decimation rate changes.
+      As the line is active low, it should be marked GPIO_ACTIVE_LOW.
+
+  reset-gpios:
+    maxItems: 1
+
+  spi-max-frequency: true
+
+  spi-cpol: true
+  spi-cpha : true
+
+  "#io-channel-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - vref-supply
+  - spi-cpol
+  - spi-cpha
+  - adi,sync-in-gpios
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/gpio/gpio.h>
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "adi,ad7768-1";
+            reg = <0>;
+            spi-max-frequency = <2000000>;
+            spi-cpol;
+            spi-cpha;
+            vref-supply = <&adc_vref>;
+            interrupts = <25 IRQ_TYPE_EDGE_RISING>;
+            interrupt-parent = <&gpio>;
+            adi,sync-in-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
+            reset-gpios = <&gpio 27 GPIO_ACTIVE_LOW>;
+            clocks = <&ad7768_mclk>;
+            clock-names = "mclk";
+        };
+    };
+...
-- 
2.28.0


  parent reply	other threads:[~2020-09-05 17:32 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-05 17:29 [PATCH 00/20] dt-bindings:iio:adc: Another set of yaml conversions Jonathan Cameron
2020-09-05 17:29 ` [PATCH 01/20] dt-bindings:iio:adc:fsl,vf610-adc conversion to yaml Jonathan Cameron
2020-09-05 17:29 ` [PATCH 02/20] dt-bindings:iio:adc:ti,twl4030-madc yaml conversion Jonathan Cameron
2020-09-08 20:52   ` Sebastian Reichel
2020-09-05 17:29 ` [PATCH 03/20] dt-bindings:iio:adc:st,stmpe-adc " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 04/20] dt-bindings:iio:adc: aspeed,ast2400 " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 05/20] dt-bindings:iio:adc:marvell,berlin2-adc " Jonathan Cameron
2020-09-08 19:44   ` Rob Herring
2020-09-05 17:29 ` [PATCH 06/20] dt-bindings:iio:adc:sprd,sc2720-adc " Jonathan Cameron
2020-09-07 17:46   ` Orson Zhai
2020-09-08  9:12     ` Jonathan Cameron
2020-09-09  5:46       ` Orson Zhai
2020-09-05 17:29 ` [PATCH 07/20] dt-bindings:iio:adc:nuvoton,nau7802 " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 08/20] dt-bindings:iio:adc:nuvoton,npcm750-adc " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 09/20] dt-bindings:iio:adc:nxp,lpc1850-adc " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 10/20] dt-bindings:iio:adc:lpc3220-adc " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 11/20] dt-bindings:iio:adc:motorola,cpcap-adc " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 12/20] dt-bindings:iio:adc:dlg,da9150-gpadc " Jonathan Cameron
2020-09-08 12:07   ` Adam Thomson
2020-09-05 17:29 ` [PATCH 13/20] dt-bindings:iio:adc:cosmic,10001-adc " Jonathan Cameron
2020-09-05 17:29 ` [PATCH 14/20] dt-bindings:iio:adc:adi,ad7949 " Jonathan Cameron
2020-09-05 17:29 ` Jonathan Cameron [this message]
2020-09-06 16:13   ` [PATCH 15/20] dt-bindings:iio:adc:ad7768-1 " Jonathan Cameron
2020-09-05 17:30 ` [PATCH 16/20] dt-bindings:iio:adc:ti,ads1015 " Jonathan Cameron
2020-09-05 17:30 ` [PATCH 17/20] dt-bindings:iio:adc:holt,hi8435 " Jonathan Cameron
2020-09-05 17:30 ` [PATCH 18/20] dt-bindings:iio:adc:amlogic,meson-saradc " Jonathan Cameron
2020-09-06 10:00   ` Martin Blumenstingl
2020-09-06 12:12     ` Jonathan Cameron
2020-09-05 17:30 ` [PATCH 19/20] dt-bindings:iio:adc:fsl,imx7d-adc " Jonathan Cameron
2020-09-05 17:30 ` [PATCH 20/20] dt-bindings:iio:adc:fsl,imx25-gcq " Jonathan Cameron

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200905173004.216081-16-jic23@kernel.org \
    --to=jic23@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=devicetree@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    --cc=stefan.popa@analog.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox