All of lore.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>,
	Dirk Eibach <eibach@gdsys.de>,
	Daniel Baluta <daniel.baluta@nxp.com>
Subject: [PATCH 16/20] dt-bindings:iio:adc:ti,ads1015 yaml conversion
Date: Sat,  5 Sep 2020 18:30:00 +0100	[thread overview]
Message-ID: <20200905173004.216081-17-jic23@kernel.org> (raw)
In-Reply-To: <20200905173004.216081-1-jic23@kernel.org>

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

This binding was moved over from hwmon some time ago so is a bit
unusual in terms of IIO bindings.  However, conversion was fairly
straight forwards.

I've listed both Dirk (who think wrote original binding) and Daniel
who added the IIO driver for this device.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Dirk Eibach <eibach@gdsys.de>
Cc: Daniel Baluta <daniel.baluta@nxp.com>
---
 .../devicetree/bindings/iio/adc/ads1015.txt   |  73 -----------
 .../bindings/iio/adc/ti,ads1015.yaml          | 113 ++++++++++++++++++
 2 files changed, 113 insertions(+), 73 deletions(-)

diff --git a/Documentation/devicetree/bindings/iio/adc/ads1015.txt b/Documentation/devicetree/bindings/iio/adc/ads1015.txt
deleted file mode 100644
index 918a507d1159..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/ads1015.txt
+++ /dev/null
@@ -1,73 +0,0 @@
-ADS1015 (I2C)
-
-This device is a 12-bit A-D converter with 4 inputs.
-
-The inputs can be used single ended or in certain differential combinations.
-
-For configuration all possible combinations are mapped to 8 channels:
-  0: Voltage over AIN0 and AIN1.
-  1: Voltage over AIN0 and AIN3.
-  2: Voltage over AIN1 and AIN3.
-  3: Voltage over AIN2 and AIN3.
-  4: Voltage over AIN0 and GND.
-  5: Voltage over AIN1 and GND.
-  6: Voltage over AIN2 and GND.
-  7: Voltage over AIN3 and GND.
-
-Each channel can be configured individually:
- - pga is the programmable gain amplifier (values are full scale)
-    0: +/- 6.144 V
-    1: +/- 4.096 V
-    2: +/- 2.048 V (default)
-    3: +/- 1.024 V
-    4: +/- 0.512 V
-    5: +/- 0.256 V
- - data_rate in samples per second
-    0: 128
-    1: 250
-    2: 490
-    3: 920
-    4: 1600 (default)
-    5: 2400
-    6: 3300
-
-1) The /ads1015 node
-
-  Required properties:
-
-   - compatible : must be "ti,ads1015"
-   - reg : I2C bus address of the device
-   - #address-cells : must be <1>
-   - #size-cells : must be <0>
-
-  The node contains child nodes for each channel that the platform uses.
-
-  Example ADS1015 node:
-
-    ads1015@49 {
-	    compatible = "ti,ads1015";
-	    reg = <0x49>;
-	    #address-cells = <1>;
-	    #size-cells = <0>;
-
-	    [ child node definitions... ]
-    }
-
-2) channel nodes
-
-  Required properties:
-
-   - reg : the channel number
-
-  Optional properties:
-
-   - ti,gain : the programmable gain amplifier setting
-   - ti,datarate : the converter data rate
-
-  Example ADS1015 channel node:
-
-    channel@4 {
-	    reg = <4>;
-	    ti,gain = <3>;
-	    ti,datarate = <5>;
-    };
diff --git a/Documentation/devicetree/bindings/iio/adc/ti,ads1015.yaml b/Documentation/devicetree/bindings/iio/adc/ti,ads1015.yaml
new file mode 100644
index 000000000000..9922ca78ccd0
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/ti,ads1015.yaml
@@ -0,0 +1,113 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/ti,ads1015.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI ADS1015 4 channel I2C analog to digital converter
+
+maintainers:
+  - Dirk Eibach <eibach@gdsys.de>
+  - Daniel Baluta <daniel.baluta@nxp.com>
+
+description: |
+  Datasheet at: https://www.ti.com/lit/gpn/ads1015
+  Supports both single ended and differential channels.
+
+properties:
+  compatible:
+    const: ti,ads1015
+
+  reg:
+    maxItems: 1
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+  "#io-channel-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - "#address-cells"
+  - "#size-cells"
+
+additionalProperties: false
+
+patternProperties:
+  "^channel@[0-7]+$":
+    type: object
+    description:
+      Child nodes needed for each channel that the platform uses.
+
+    properties:
+      reg:
+        description: |
+          0: Voltage over AIN0 and AIN1.
+          1: Voltage over AIN0 and AIN3.
+          2: Voltage over AIN1 and AIN3.
+          3: Voltage over AIN2 and AIN3.
+          4: Voltage over AIN0 and GND.
+          5: Voltage over AIN1 and GND.
+          6: Voltage over AIN2 and GND.
+          7: Voltage over AIN3 and GND.
+        items:
+          - minimum: 0
+            maximum: 7
+
+      ti,gain:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 5
+        description: |
+          pga is the programmable gain amplifier (values are full scale)
+          0: +/- 6.144 V
+          1: +/- 4.096 V
+          2: +/- 2.048 V (default)
+          3: +/- 1.024 V
+          4: +/- 0.512 V
+          5: +/- 0.256 V
+
+      ti,datarate:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 6
+        description: |
+          Data aquisition rate in samples per second
+          0: 128
+          1: 250
+          2: 490
+          3: 920
+          4: 1600 (default)
+          5: 2400
+          6: 3300
+
+    required:
+      - reg
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@49 {
+            compatible = "ti,ads1015";
+            reg = <0x49>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+            channel@0 {
+              reg = <0>;
+            };
+            channel@4 {
+              reg = <4>;
+              ti,gain = <3>;
+              ti,datarate = <5>;
+            };
+        };
+    };
+...
-- 
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 ` [PATCH 15/20] dt-bindings:iio:adc:ad7768-1 " Jonathan Cameron
2020-09-06 16:13   ` Jonathan Cameron
2020-09-05 17:30 ` Jonathan Cameron [this message]
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-17-jic23@kernel.org \
    --to=jic23@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=daniel.baluta@nxp.com \
    --cc=devicetree@vger.kernel.org \
    --cc=eibach@gdsys.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.