From: Guillaume Stols <gstols@baylibre.com>
To: Lars-Peter Clausen <lars@metafoo.de>,
Michael Hennerich <Michael.Hennerich@analog.com>,
Jonathan Cameron <jic23@kernel.org>,
Rob Herring <robh@kernel.org>,
Krzysztof Kozlowski <krzk+dt@kernel.org>,
Conor Dooley <conor+dt@kernel.org>
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
Michael Hennerich <michael.hennerich@analog.com>,
linux-fbdev@vger.kernel.org, devicetree@vger.kernel.org,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
Guillaume Stols <gstols@baylibre.com>,
jstephan@baylibre.com, dlechner@baylibre.com
Subject: [PATCH v3 2/8] dt-bindings: iio: adc: adi,ad7606: improve descriptions
Date: Tue, 02 Jul 2024 17:34:06 +0000 [thread overview]
Message-ID: <20240702-cleanup-ad7606-v3-2-57fd02a4e2aa@baylibre.com> (raw)
In-Reply-To: <20240702-cleanup-ad7606-v3-0-57fd02a4e2aa@baylibre.com>
Reword a few descriptions, and normalize the text width to 80 characters.
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Signed-off-by: Guillaume Stols <gstols@baylibre.com>
---
.../devicetree/bindings/iio/adc/adi,ad7606.yaml | 33 +++++++++++++---------
1 file changed, 20 insertions(+), 13 deletions(-)
diff --git a/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml b/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml
index 32caa9fc00e4..76fd6df5f9ca 100644
--- a/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml
+++ b/Documentation/devicetree/bindings/iio/adc/adi,ad7606.yaml
@@ -36,6 +36,9 @@ properties:
avcc-supply: true
interrupts:
+ description:
+ The BUSY pin falling edge indicates that the conversion is over, and thus
+ new data is available.
maxItems: 1
adi,conversion-start-gpios:
@@ -48,8 +51,9 @@ properties:
reset-gpios:
description:
Must be the device tree identifier of the RESET pin. If specified, it will
- be asserted during driver probe. As the line is active high, it should be
- marked GPIO_ACTIVE_HIGH.
+ be asserted during driver probe. On the AD7606x, as the line is active
+ high, it should be marked GPIO_ACTIVE_HIGH. On the AD7616, as the line is
+ active low, it should be marked GPIO_ACTIVE_LOW.
maxItems: 1
standby-gpios:
@@ -62,36 +66,39 @@ properties:
adi,first-data-gpios:
description:
- Must be the device tree identifier of the FRSTDATA pin. The FRSTDATA
+ Must be the device tree identifier of the FRSTDATA pin. The FRSTDATA
output indicates when the first channel, V1, is being read back on either
- the parallel, byte or serial interface. As the line is active high, it
+ the parallel, byte or serial interface. As the line is active high, it
should be marked GPIO_ACTIVE_HIGH.
maxItems: 1
adi,range-gpios:
description:
- Must be the device tree identifier of the RANGE pin. The polarity on this
+ Must be the device tree identifier of the RANGE pin. The state on this
pin determines the input range of the analog input channels. If this pin
is tied to a logic high, the analog input range is ±10V for all channels.
- If this pin is tied to a logic low, the analog input range is ±5V for all
- channels. As the line is active high, it should be marked
+ On the AD760X, if this pin is tied to a logic low, the analog input range
+ is ±5V for all channels. As the line is active high, it should be marked
GPIO_ACTIVE_HIGH.
maxItems: 1
adi,oversampling-ratio-gpios:
description:
Must be the device tree identifier of the over-sampling mode pins. As the
- line is active high, it should be marked GPIO_ACTIVE_HIGH.
+ line is active high, it should be marked GPIO_ACTIVE_HIGH. On the AD7606X
+ parts that support it, if all 3 pins are tied to a logic high, software
+ mode is enabled.
maxItems: 3
adi,sw-mode:
description:
- Software mode of operation, so far available only for ad7616 and ad7606b.
+ Software mode of operation, so far available only for AD7616 and AD7606B.
It is enabled when all three oversampling mode pins are connected to high
- level. The device is configured by the corresponding registers. If the
- adi,oversampling-ratio-gpios property is defined, then the driver will set
- the oversampling gpios to high. Otherwise, it is assumed that the pins are
- hardwired to VDD.
+ level for the AD7606B, or both the range selection are connected to high
+ level for the AD7616. The device is configured by the corresponding
+ registers. If the adi,oversampling-ratio-gpios property is defined, then
+ the driver will set the oversampling gpios to high. Otherwise, it is
+ assumed that the pins are hardwired to VDD.
type: boolean
required:
--
2.34.1
next prev parent reply other threads:[~2024-07-02 17:34 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-02 17:34 [PATCH v3 0/8] iio: adc: ad7606: Improvements Guillaume Stols
2024-07-02 17:34 ` [PATCH v3 1/8] dt-bindings: iio: adc: adi,ad7606: normalize textwidth Guillaume Stols
2024-07-02 17:34 ` Guillaume Stols [this message]
2024-07-02 17:34 ` [PATCH v3 3/8] dt-bindings: iio: adc: adi,ad7606: add supply properties Guillaume Stols
2024-07-02 17:34 ` [PATCH v3 4/8] dt-bindings: iio: adc: adi,ad7606: fix example Guillaume Stols
2024-07-02 17:34 ` [PATCH v3 5/8] dt-bindings: iio: adc: adi,ad7606: add conditions Guillaume Stols
2024-07-02 17:34 ` [PATCH v3 6/8] iio: adc: ad7606: fix oversampling gpio array Guillaume Stols
2024-07-03 11:08 ` Nuno Sá
2024-07-02 17:34 ` [PATCH v3 7/8] iio: adc: ad7606: fix standby gpio state to match the documentation Guillaume Stols
2024-07-03 11:09 ` Nuno Sá
2024-07-02 17:34 ` [PATCH v3 8/8] iio: adc: ad7606: switch mutexes to scoped_guard Guillaume Stols
2024-07-03 11:12 ` Nuno Sá
2024-07-06 12:56 ` Markus Elfring
2024-07-06 12:15 ` [PATCH v3 0/8] iio: adc: ad7606: Improvements Jonathan Cameron
2024-07-06 12:29 ` Konstantin Ryabitsev
2024-07-07 10:38 ` Jonathan Cameron
2024-07-07 11:03 ` 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=20240702-cleanup-ad7606-v3-2-57fd02a4e2aa@baylibre.com \
--to=gstols@baylibre.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=Michael.Hennerich@analog.com \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=dlechner@baylibre.com \
--cc=jic23@kernel.org \
--cc=jstephan@baylibre.com \
--cc=krzk+dt@kernel.org \
--cc=lars@metafoo.de \
--cc=linux-fbdev@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=robh@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox