Linux-IIO Archive on lore.kernel.org
 help / color / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: linux-iio@vger.kernel.org, Rob Herring <robh+dt@kernel.org>
Cc: Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Matt Ranostay <matt.ranostay@konsulko.com>
Subject: [PATCH 11/29] dt-bindings:iio:proximity:ams,as3935 yaml conversion
Date: Sun, 11 Oct 2020 18:07:31 +0100
Message-ID: <20201011170749.243680-12-jic23@kernel.org> (raw)
In-Reply-To: <20201011170749.243680-1-jic23@kernel.org>

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

A straight forward conversion of this binding. I have added
a maximum SPI frequency from the datasheet.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Matt Ranostay <matt.ranostay@konsulko.com>
---
 .../bindings/iio/proximity/ams,as3935.yaml    | 71 +++++++++++++++++++
 .../bindings/iio/proximity/as3935.txt         | 34 ---------
 2 files changed, 71 insertions(+), 34 deletions(-)

diff --git a/Documentation/devicetree/bindings/iio/proximity/ams,as3935.yaml b/Documentation/devicetree/bindings/iio/proximity/ams,as3935.yaml
new file mode 100644
index 000000000000..7fcba5d6d508
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/proximity/ams,as3935.yaml
@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/proximity/ams,as3935.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Austrian Microsystems AS3935 Franklin lightning sensor
+
+maintainers:
+  - Matt Ranostay <matt.ranostay@konsulko.com>
+
+description:
+  This lightening distance sensor uses an I2C or SPI interface. The
+  binding currently only covers the SPI option.
+
+properties:
+  compatible:
+    const: ams,as3935
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 2000000
+
+  spi-cpha: true
+
+  interrupts:
+    maxItems: 1
+
+  ams,tuning-capacitor-pf:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Calibration tuning capacitor stepping value. This will require using
+      the calibration data from the manufacturer.
+    minimum: 0
+    maximum: 120
+
+  ams,nflwdth:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description:
+      Set the noise and watchdog threshold register on startup. This will
+      need to set according to the noise from the MCU board, and possibly
+      the local environment. Refer to the datasheet for the threshold settings.
+
+required:
+  - compatible
+  - reg
+  - spi-cpha
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+    lightning@0 {
+            compatible = "ams,as3935";
+            reg = <0>;
+            spi-max-frequency = <400000>;
+            spi-cpha;
+            interrupt-parent = <&gpio1>;
+            interrupts = <16 1>;
+            ams,tuning-capacitor-pf = <80>;
+            ams,nflwdth = <0x44>;
+        };
+    };
+...
diff --git a/Documentation/devicetree/bindings/iio/proximity/as3935.txt b/Documentation/devicetree/bindings/iio/proximity/as3935.txt
deleted file mode 100644
index 849115585d55..000000000000
--- a/Documentation/devicetree/bindings/iio/proximity/as3935.txt
+++ /dev/null
@@ -1,34 +0,0 @@
-Austrian Microsystems AS3935 Franklin lightning sensor device driver
-
-Required properties:
-	- compatible: must be "ams,as3935"
-	- reg: SPI chip select number for the device
-	- spi-max-frequency: specifies maximum SPI clock frequency
-	- spi-cpha: SPI Mode 1. Refer to spi/spi-bus.txt for generic SPI
-	slave node bindings.
-	- interrupts : the sole interrupt generated by the device
-
-	Refer to interrupt-controller/interrupts.txt for generic
-	interrupt client node bindings.
-
-Optional properties:
-	- ams,tuning-capacitor-pf: Calibration tuning capacitor stepping
-	  value 0 - 120pF. This will require using the calibration data from
-	  the manufacturer.
-	- ams,nflwdth: Set the noise and watchdog threshold register on
-	  startup. This will need to set according to the noise from the
-	  MCU board, and possibly the local environment. Refer to the
-	  datasheet for the threshold settings.
-
-Example:
-
-as3935@0 {
-	compatible = "ams,as3935";
-	reg = <0>;
-	spi-max-frequency = <400000>;
-	spi-cpha;
-	interrupt-parent = <&gpio1>;
-	interrupts = <16 1>;
-	ams,tuning-capacitor-pf = <80>;
-	ams,nflwdth = <0x44>;
-};
-- 
2.28.0


  parent reply index

Thread overview: 62+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-11 17:07 [PATCH 00/29] dt-bindings:iio: Another set of yaml conversions Jonathan Cameron
2020-10-11 17:07 ` [PATCH 01/29] dt-bindings:iio:humidity:hdc100x Drop separate doc + add to trivial-devices Jonathan Cameron
2020-10-12 16:29   ` Matt Ranostay
2020-10-11 17:07 ` [PATCH 02/29] dt-bindings:iio:humidity:htu21 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 03/29] dt-bindings:iio:humidity:st,hts221 yaml conversion Jonathan Cameron
2020-10-11 17:07 ` [PATCH 04/29] dt-bindings:iio:humidity:dht11 " Jonathan Cameron
2020-10-11 17:52   ` Harald Geyer
2020-10-12 14:29     ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 05/29] dt-bindings:iio:pressure:ms5637 Drop separate doc + add to trivial-devices Jonathan Cameron
2020-10-11 17:07 ` [PATCH 06/29] dt-bindings:iio:pressure:murata,zpa2326 yaml conversion Jonathan Cameron
2020-10-11 17:07 ` [PATCH 07/29] dt-bindings:iio:pressure:meas,ms5611 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 08/29] dt-bindings:iio:pressure:hoperf,hp03 " Jonathan Cameron
2020-10-12 13:06   ` Rob Herring
2020-10-12 14:31     ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 09/29] dt-bindings:iio:proximity:semtech,sx9500 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 10/29] dt-bindings:iio:proximity:st,vl53l0x " Jonathan Cameron
2020-10-11 17:07 ` Jonathan Cameron [this message]
2020-10-12 16:37   ` [PATCH 11/29] dt-bindings:iio:proximity:ams,as3935 " Matt Ranostay
2020-10-11 17:07 ` [PATCH 12/29] dt-bindings:iio:dac:ti,dac5571 " Jonathan Cameron
2020-10-11 17:47   ` Sean Nyekjaer
2020-10-18  9:58     ` Jonathan Cameron
2020-10-18 15:06       ` Sean Nyekjaer
2020-10-11 17:07 ` [PATCH 13/29] dt-bindings:iio:dac:ti,dac7311 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 14/29] dt-bindings:iio:dac:ti,dac7512 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 15/29] dt-bindings:iio:dac:ti,dac7612 " Jonathan Cameron
2020-10-15  8:49   ` Ricardo Ribalda Delgado
2020-10-18 17:41     ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 16/29] dt-bindings:iio:dac:ti,dac082s085 " Jonathan Cameron
2020-10-28 20:31   ` Lukas Wunner
2020-10-29 15:50     ` Jonathan Cameron
2020-10-29 19:10       ` Lukas Wunner
2020-10-31 11:02         ` Jonathan Cameron
2020-10-31 13:07       ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 17/29] dt-bindings:iio:dac:adi,ad7303 " Jonathan Cameron
2020-10-11 17:13   ` Lars-Peter Clausen
2020-10-18 17:43     ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 18/29] dt-bindings:iio:dac:maxim,ds4424 " Jonathan Cameron
2020-10-18 17:47   ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 19/29] dt-bindings:iio:dac:fsl,vf610-dac " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 20/29] dt-bindings:iio:dac:microchip,mcp4725 " Jonathan Cameron
2020-10-12 14:02   ` Tomas Novotny
2020-10-12 14:39     ` Jonathan Cameron
2020-10-14  8:57       ` Tomas Novotny
2020-10-11 17:07 ` [PATCH 21/29] dt-bindings:iio:dac:maxim,max5821 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 22/29] dt-bindings:iio:dac:nxp,lpc1850-dac " Jonathan Cameron
2020-10-18 17:52   ` Jonathan Cameron
2020-10-18 18:44   ` Vladimir Zapolskiy
2020-10-11 17:07 ` [PATCH 23/29] dt-bindings:iio:dac:adi,ad5758 " Jonathan Cameron
2020-10-11 17:07 ` [PATCH 24/29] dt-bindings:iio:temperature:melexis,mlx90614 " Jonathan Cameron
2020-10-11 21:00   ` Crt Mori
2020-10-12  8:00     ` Crt Mori
2020-10-12 14:25       ` Jonathan Cameron
2020-10-11 17:07 ` [PATCH 25/29] dt-bindings:iio:temperature:melexis,mlx90632 conversion to yaml Jonathan Cameron
2020-10-11 21:01   ` Crt Mori
2020-10-11 17:07 ` [PATCH 26/29] dt-bindings:iio:temperature:meas,tsys01 move to trivial-devices.yaml Jonathan Cameron
2020-10-11 17:07 ` [PATCH 27/29] dt-bindings:iio:temperature:maxim,max31856 yaml conversion Jonathan Cameron
2020-10-11 17:07 ` [PATCH 28/29] dt-bindings:iio:temperature:maxim_thermocouple.txt to maxim,max31855k.yaml Jonathan Cameron
2020-10-12 16:40   ` Matt Ranostay
2020-10-11 17:07 ` [PATCH 29/29] dt-bindings:iio:temperature:ti,tmp07 yaml conversion Jonathan Cameron
2020-10-13  8:22   ` Manivannan Sadhasivam
2020-10-12 13:20 ` [PATCH 00/29] dt-bindings:iio: Another set of yaml conversions Rob Herring
2020-10-12 14:33   ` 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=20201011170749.243680-12-jic23@kernel.org \
    --to=jic23@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=linux-iio@vger.kernel.org \
    --cc=matt.ranostay@konsulko.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-IIO Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-iio/0 linux-iio/git/0.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-iio linux-iio/ https://lore.kernel.org/linux-iio \
		linux-iio@vger.kernel.org
	public-inbox-index linux-iio

Example config snippet for mirrors

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


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