Linux-Devicetree Archive on lore.kernel.org
 help / color / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: linux-iio@vger.kernel.org
Cc: Rob Herring <robh+dt@kernel.org>,
	devicetree@vger.kernel.org,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Oskar Andero <oskar.andero@gmail.com>
Subject: [PATCH 01/13] dt-bindings: iio: adc: microchip,mcp3201 yaml conversion.
Date: Sun,  9 Aug 2020 12:17:41 +0100
Message-ID: <20200809111753.156236-2-jic23@kernel.org> (raw)
In-Reply-To: <20200809111753.156236-1-jic23@kernel.org>

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

Drops the deprecated compatibles without the vendor name.
Whilst the driver continues to support these for old dt blobs,
any dt bindings that are actuallly verified against this document should
be fixed to add the vendor name.

Enforces rule that spi-cpol == spi-cpha.  Is there a cleaner way to
do this?

Added the #io-channel-cells property to allow for consumers.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Oskar Andero <oskar.andero@gmail.com>
---
 .../devicetree/bindings/iio/adc/mcp320x.txt   | 57 ------------
 .../bindings/iio/adc/microchip,mcp3201.yaml   | 93 +++++++++++++++++++
 2 files changed, 93 insertions(+), 57 deletions(-)

diff --git a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt b/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
deleted file mode 100644
index 56373d643f76..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/mcp320x.txt
+++ /dev/null
@@ -1,57 +0,0 @@
-* Microchip Analog to Digital Converter (ADC)
-
-The node for this driver must be a child node of a SPI controller, hence
-all mandatory properties described in
-
-        Documentation/devicetree/bindings/spi/spi-bus.txt
-
-must be specified.
-
-Required properties:
-	- compatible:  	Must be one of the following, depending on the
-			model:
-				"mcp3001" (DEPRECATED)
-				"mcp3002" (DEPRECATED)
-				"mcp3004" (DEPRECATED)
-				"mcp3008" (DEPRECATED)
-				"mcp3201" (DEPRECATED)
-				"mcp3202" (DEPRECATED)
-				"mcp3204" (DEPRECATED)
-				"mcp3208" (DEPRECATED)
-				"mcp3301" (DEPRECATED)
-
-				"microchip,mcp3001"
-				"microchip,mcp3002"
-				"microchip,mcp3004"
-				"microchip,mcp3008"
-				"microchip,mcp3201"
-				"microchip,mcp3202"
-				"microchip,mcp3204"
-				"microchip,mcp3208"
-				"microchip,mcp3301"
-				"microchip,mcp3550-50"
-				"microchip,mcp3550-60"
-				"microchip,mcp3551"
-				"microchip,mcp3553"
-
-			NOTE: The use of the compatibles with no vendor prefix
-			is deprecated and only listed because old DT use them.
-
-	- spi-cpha, spi-cpol (boolean):
-			Either SPI mode (0,0) or (1,1) must be used, so specify
-			none or both of spi-cpha, spi-cpol.  The MCP3550/1/3
-			is more efficient in mode (1,1) as only 3 instead of
-			4 bytes need to be read from the ADC, but not all SPI
-			masters support it.
-
-	- vref-supply:	Phandle to the external reference voltage supply.
-
-Examples:
-spi_controller {
-	mcp3x0x@0 {
-		compatible = "microchip,mcp3002";
-		reg = <0>;
-		spi-max-frequency = <1000000>;
-		vref-supply = <&vref_reg>;
-	};
-};
diff --git a/Documentation/devicetree/bindings/iio/adc/microchip,mcp3201.yaml b/Documentation/devicetree/bindings/iio/adc/microchip,mcp3201.yaml
new file mode 100644
index 000000000000..38dfb856da62
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/microchip,mcp3201.yaml
@@ -0,0 +1,93 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/microchip,mcp3201.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Microchip mcp3201 and similar ADCs
+
+maintainers:
+  - Oskar Andero <oskar.andero@gmail.com>
+
+description: |
+   Family of simple ADCs with an I2C inteface.
+
+properties:
+  compatible:
+    enum:
+      - microchip,mcp3001
+      - microchip,mcp3002
+      - microchip,mcp3004
+      - microchip,mcp3008
+      - microchip,mcp3201
+      - microchip,mcp3202
+      - microchip,mcp3204
+      - microchip,mcp3208
+      - microchip,mcp3301
+      - microchip,mcp3550-50
+      - microchip,mcp3550-60
+      - microchip,mcp3551
+      - microchip,mcp3553
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency: true
+  spi-cpha: true
+  spi-cpol: true
+
+  vref-supply:
+    description: External reference.
+
+  "#io-channel-cells":
+    const: 1
+
+allOf:
+  - if:
+      required:
+        - spi-cpha
+    then:
+      required:
+        - spi-cpol
+    else:
+      properties:
+        spi-cpol: false
+  - if:
+      required:
+        - spi-cpol
+    then:
+      required:
+        - spi-cpha
+    else:
+      properties:
+        spi-cpha: false
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "microchip,mcp3002";
+            reg = <0>;
+            vref-supply = <&vref_reg>;
+            spi-cpha;
+            spi-cpol;
+            #io-channel-cells = <1>;
+        };
+        adc@1 {
+            compatible = "microchip,mcp3002";
+            reg = <1>;
+            vref-supply = <&vref_reg>;
+            spi-max-frequency = <1500000>;
+        };
+    };
+...
-- 
2.28.0


  reply index

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-09 11:17 [PATCH 00/13] dt-bindings: yaml conversions of some simple ADC bindings Jonathan Cameron
2020-08-09 11:17 ` Jonathan Cameron [this message]
2020-08-18  2:24   ` [PATCH 01/13] dt-bindings: iio: adc: microchip,mcp3201 yaml conversion Rob Herring
2020-08-30 13:25     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 02/13] dt-bindings: trivial-devices: Add mcp342x ADCs and drop separate binding doc Jonathan Cameron
2020-08-18  2:27   ` Rob Herring
2020-08-29 17:48     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 03/13] dt-bindings: iio: adc: ti,adc108s102 yaml conversion Jonathan Cameron
2020-08-18  2:27   ` Rob Herring
2020-08-29 17:50     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 04/13] dt-bindings: iio: adc: lltc,ltc2497 " Jonathan Cameron
2020-08-18  2:28   ` Rob Herring
2020-08-29 17:50     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 05/13] dt-bindings: iio: adc: ti,adc161s626 " Jonathan Cameron
2020-08-11  3:35   ` Matt Ranostay
2020-08-18  2:28   ` Rob Herring
2020-08-29 17:51     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 06/13] dt-bindings: iio: adc: ti,adc0832 " Jonathan Cameron
2020-08-18  2:29   ` Rob Herring
2020-08-09 11:17 ` [PATCH 07/13] dt-bindings: iio: adc: ti,adc084s021 " Jonathan Cameron
2020-08-18  2:30   ` Rob Herring
2020-08-29 17:53     ` Jonathan Cameron
2020-10-27 15:28       ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 08/13] dt-bindings: iio: adc: ti,adc12138 " Jonathan Cameron
2020-08-12 16:29   ` Rob Herring
2020-08-16  9:06     ` Jonathan Cameron
2020-08-17 14:17   ` Rob Herring
2020-08-09 11:17 ` [PATCH 09/13] dt-bindings: iio: adc: ti,adc128s052 " Jonathan Cameron
2020-08-18  2:30   ` Rob Herring
2020-08-29 17:55     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 10/13] dt-bindings: iio: adc: ti,ads7950 binding conversion Jonathan Cameron
2020-08-12 16:30   ` David Lechner
2020-08-30 15:55     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 11/13] dt-bindings: iio: adc: ti,ads8344 yaml conversion Jonathan Cameron
2020-08-18  2:31   ` Rob Herring
2020-08-29 17:58     ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 12/13] dt-bindings: iio: adc: tlc4541 - recover accidentally dropped binding doc Jonathan Cameron
2020-08-29 17:57   ` Jonathan Cameron
2020-08-09 11:17 ` [PATCH 13/13] dt-bindings: iio: adc: ti,tlc4541 binding conversion Jonathan Cameron
2020-08-10  0:42   ` Phil Reid
2020-08-18  2:32   ` Rob Herring
2020-08-29 17:59     ` 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=20200809111753.156236-2-jic23@kernel.org \
    --to=jic23@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=devicetree@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=oskar.andero@gmail.com \
    --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

Linux-Devicetree Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-devicetree/0 linux-devicetree/git/0.git
	git clone --mirror https://lore.kernel.org/linux-devicetree/1 linux-devicetree/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-devicetree linux-devicetree/ https://lore.kernel.org/linux-devicetree \
		devicetree@vger.kernel.org
	public-inbox-index linux-devicetree

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-devicetree


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git