devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Matheus Tavares <matheus.bernardino@usp.br>
To: Lars-Peter Clausen <lars@metafoo.de>,
	Michael Hennerich <Michael.Hennerich@analog.com>,
	Jonathan Cameron <jic23@kernel.org>,
	Hartmut Knaack <knaack.h@gmx.de>,
	Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Rob Herring <robh+dt@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>
Cc: linux-iio@vger.kernel.org, devel@driverdev.osuosl.org,
	devicetree@vger.kernel.org, linux-kernel@vger.kernel.org,
	Alexandru Ardelean <alexandru.ardelean@analog.com>,
	kernel-usp@googlegroups.com, victorcolombo@gmail.com
Subject: [PATCH v3 4/7] dt-bindings:iio:resolver: Add docs for ad2s90
Date: Fri, 23 Nov 2018 22:23:09 -0200	[thread overview]
Message-ID: <20181124002312.6923-5-matheus.bernardino@usp.br> (raw)
In-Reply-To: <20181124002312.6923-1-matheus.bernardino@usp.br>

This patch adds the device tree binding documentation for the ad2s90
resolver-to-digital converter.

Signed-off-by: Matheus Tavares <matheus.bernardino@usp.br>
---
Changes in v3:
 - Added reference to spi-bus documentation after spi properties, as
 suggested by Alexandru Ardelean.

Changes in v2:
 - Rewritten 'spi-cpol and spi-cpha' item to say that the device can
 work in either mode (0,0) or (1,1) and explain how they should be
 specified in DT.

 .../bindings/iio/resolver/ad2s90.txt          | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/resolver/ad2s90.txt

diff --git a/Documentation/devicetree/bindings/iio/resolver/ad2s90.txt b/Documentation/devicetree/bindings/iio/resolver/ad2s90.txt
new file mode 100644
index 000000000000..477d41fa6467
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/resolver/ad2s90.txt
@@ -0,0 +1,31 @@
+Analog Devices AD2S90 Resolver-to-Digital Converter
+
+https://www.analog.com/en/products/ad2s90.html
+
+Required properties:
+  - compatible: should be "adi,ad2s90"
+  - reg: SPI chip select number for the device
+  - spi-max-frequency: set maximum clock frequency, must be 830000
+  - spi-cpol and spi-cpha:
+        Either SPI mode (0,0) or (1,1) must be used, so specify none or both of
+        spi-cpha, spi-cpol.
+
+See for more details:
+    Documentation/devicetree/bindings/spi/spi-bus.txt
+
+Note about max frequency:
+    Chip's max frequency, as specified in its datasheet, is 2Mhz. But a 600ns
+    delay is expected between the application of a logic LO to CS and the
+    application of SCLK, as also specified. And since the delay is not
+    implemented in the spi code, to satisfy it, SCLK's period should be at most
+    2 * 600ns, so the max frequency should be 1 / (2 * 6e-7), which gives
+    roughly 830000Hz.
+
+Example:
+resolver@0 {
+	compatible = "adi,ad2s90";
+	reg = <0>;
+	spi-max-frequency = <830000>;
+	spi-cpol;
+	spi-cpha;
+};
-- 
2.18.0

  parent reply	other threads:[~2018-11-24  0:23 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-24  0:23 [PATCH v3 0/7] staging:iio:ad2s90: Add dt support and move out of staging Matheus Tavares
2018-11-24  0:23 ` [PATCH v3 1/7] staging:iio:ad2s90: Add device tree support Matheus Tavares
2018-12-01 15:34   ` Jonathan Cameron
2018-11-24  0:23 ` [PATCH v3 2/7] staging:iio:ad2s90: Remove spi setup that should be done via dt Matheus Tavares
2018-12-01 15:34   ` Jonathan Cameron
2018-11-24  0:23 ` [PATCH v3 3/7] staging:iio:ad2s90: Add max frequency check at probe Matheus Tavares
2018-12-01 15:37   ` Jonathan Cameron
2018-11-24  0:23 ` Matheus Tavares [this message]
2018-11-27  1:52   ` [PATCH v3 4/7] dt-bindings:iio:resolver: Add docs for ad2s90 Rob Herring
2018-12-01 15:37     ` Jonathan Cameron
2018-11-24  0:23 ` [PATCH v3 5/7] staging:iio:ad2s90: Replace license text w/ SPDX identifier Matheus Tavares
2018-12-01 15:38   ` Jonathan Cameron
2018-11-24  0:23 ` [PATCH v3 6/7] staging:iio:ad2s90: Add comment to device state mutex Matheus Tavares
2018-12-01 15:39   ` Jonathan Cameron
2018-11-24  0:23 ` [PATCH v3 7/7] staging:iio:ad2s90: Move out of staging Matheus Tavares
2018-11-25  9:56   ` Jonathan Cameron
2018-11-26  7:34   ` Ardelean, Alexandru
2018-12-01 15:41     ` 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=20181124002312.6923-5-matheus.bernardino@usp.br \
    --to=matheus.bernardino@usp.br \
    --cc=Michael.Hennerich@analog.com \
    --cc=alexandru.ardelean@analog.com \
    --cc=devel@driverdev.osuosl.org \
    --cc=devicetree@vger.kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=jic23@kernel.org \
    --cc=kernel-usp@googlegroups.com \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=pmeerw@pmeerw.net \
    --cc=robh+dt@kernel.org \
    --cc=victorcolombo@gmail.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;
as well as URLs for NNTP newsgroup(s).