Linux IIO development
 help / color / mirror / Atom feed
From: Jorge Marques <jorge.marques@analog.com>
To: "Lars-Peter Clausen" <lars@metafoo.de>,
	"Michael Hennerich" <Michael.Hennerich@analog.com>,
	"Jonathan Cameron" <jic23@kernel.org>,
	"David Lechner" <dlechner@baylibre.com>,
	"Nuno Sá" <nuno.sa@analog.com>,
	"Andy Shevchenko" <andy@kernel.org>,
	"Rob Herring" <robh@kernel.org>,
	"Krzysztof Kozlowski" <krzk+dt@kernel.org>,
	"Conor Dooley" <conor+dt@kernel.org>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	"Bartosz Golaszewski" <brgl@bgdev.pl>
Cc: <linux-iio@vger.kernel.org>, <devicetree@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>, <linux-doc@vger.kernel.org>,
	<linux-gpio@vger.kernel.org>,
	Jorge Marques <jorge.marques@analog.com>
Subject: [PATCH v2 6/9] docs: iio: ad4062: Add IIO Events support
Date: Mon, 24 Nov 2025 10:18:05 +0100	[thread overview]
Message-ID: <20251124-staging-ad4062-v2-6-a375609afbb7@analog.com> (raw)
In-Reply-To: <20251124-staging-ad4062-v2-0-a375609afbb7@analog.com>

Explains the IIO Events support.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
---
 Documentation/iio/ad4062.rst | 42 +++++++++++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 3 deletions(-)

diff --git a/Documentation/iio/ad4062.rst b/Documentation/iio/ad4062.rst
index 9dda4eb782a02..5afec4d8c2ddb 100644
--- a/Documentation/iio/ad4062.rst
+++ b/Documentation/iio/ad4062.rst
@@ -26,6 +26,7 @@ at the end of the read command.
 The two programmable GPIOS are optional and have a role assigned if present in
 the devicetree ``interrupt-names`` property:
 
+- GP0: Is assigned the role of Threshold Either signal.
 - GP1: Is assigned the role of Data Ready signal.
 
 Device attributes
@@ -74,8 +75,10 @@ Interrupts
 The interrupts are mapped through the ``interrupt-names`` and ``interrupts``
 properties.
 
-The ``interrupt-names`` ``gp1`` entry sets the role of Data Ready signal.
-If it is not present, the driver fallback to enabling the same role as an
+The ``interrupt-names`` ``gp0`` entry sets the role of Threshold signal, and
+entry ``gp1`` the role of Data Ready signal.
+
+If each is not present, the driver fallback to enabling the same role as an
 I3C IBI.
 
 Low-power mode
@@ -98,10 +101,43 @@ latency and internal timings, the sample rate is not configurable. The burst
 averaging mode does impact the effective sample rate, since it increases the
 internal timing to output a single sample.
 
+Threshold events
+================
+
+The ADC supports a monitoring mode to raise threshold events. The driver
+supports a single interrupt for both rising and falling readings.
+
+The feature is enabled/disabled by setting ``thresh_either_en``. During monitor
+mode, the device continuously operates in autonomous mode. Any register access
+puts the device back in configuration mode, due to this, any access disables
+monitor mode.
+
+The following event attributes are available:
+
+.. list-table:: Event attributes
+   :header-rows: 1
+
+   * - Attribute
+     - Description
+   * - ``sampling_frequency``
+     - Frequency used in the monitoring mode, sets the device internal sample
+       rate when the mode is activated.
+   * - ``sampling_frequency_available``
+     - List of available sample rates.
+   * - ``thresh_either_en``
+     - Enable monitoring mode.
+   * - ``thresh_falling_hysteresis``
+     - Set the hysteresis value for the minimum threshold.
+   * - ``thresh_falling_value``
+     - Set the minimum threshold value.
+   * - ``thresh_rising_hysteresis``
+     - Set the hysteresis value for the maximum threshold.
+   * - ``thresh_rising_value``
+     - Set the maximum threshold value.
+
 Unimplemented features
 ======================
 
-- Monitor mode
 - Trigger mode
 - Averaging mode
 - General purpose output

-- 
2.51.1


  parent reply	other threads:[~2025-11-24  9:18 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-24  9:17 [PATCH v2 0/9] Add support for AD4062 device family Jorge Marques
2025-11-24  9:18 ` [PATCH v2 1/9] dt-bindings: iio: adc: Add adi,ad4062 Jorge Marques
2025-11-25  9:50   ` Krzysztof Kozlowski
2025-11-26 16:14     ` Jorge Marques
2025-11-24  9:18 ` [PATCH v2 2/9] docs: iio: New docs for ad4062 driver Jorge Marques
2025-11-24  9:18 ` [PATCH v2 3/9] iio: adc: Add support for ad4062 Jorge Marques
2025-11-24 10:20   ` Andy Shevchenko
2025-11-26 11:40     ` Jorge Marques
2025-11-27  8:58       ` Andy Shevchenko
2025-11-28 18:50         ` Jorge Marques
2025-11-28 19:25           ` Andy Shevchenko
2025-12-04 21:37             ` Jorge Marques
2025-12-04 22:23               ` Andy Shevchenko
2025-12-06 16:39       ` Jonathan Cameron
2025-11-24  9:18 ` [PATCH v2 4/9] docs: iio: ad4062: Add IIO Trigger support Jorge Marques
2025-11-24  9:18 ` [PATCH v2 5/9] iio: adc: " Jorge Marques
2025-11-24  9:36   ` Andy Shevchenko
2025-11-26 14:03     ` Jorge Marques
2025-11-24  9:18 ` Jorge Marques [this message]
2025-11-24  9:18 ` [PATCH v2 7/9] iio: adc: ad4062: Add IIO Events support Jorge Marques
2025-11-24 10:33   ` Andy Shevchenko
2025-11-26 15:00     ` Jorge Marques
2025-11-27  9:13       ` Andy Shevchenko
2025-12-04 21:37         ` Jorge Marques
2025-11-24  9:18 ` [PATCH v2 8/9] docs: iio: ad4062: Add GPIO Controller support Jorge Marques
2025-11-24  9:18 ` [PATCH v2 9/9] iio: adc: " Jorge Marques
2025-11-24  9:51   ` Linus Walleij
2025-11-24 10:40   ` Andy Shevchenko
2025-11-26 15:55     ` Jorge Marques
2025-11-27  9:20       ` Andy Shevchenko
2025-12-04 21:38         ` Jorge Marques
2025-12-04 22:21           ` Andy Shevchenko
2025-12-05 11:53             ` Jorge Marques
2025-12-05 12:02               ` Andy Shevchenko

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=20251124-staging-ad4062-v2-6-a375609afbb7@analog.com \
    --to=jorge.marques@analog.com \
    --cc=Michael.Hennerich@analog.com \
    --cc=andy@kernel.org \
    --cc=brgl@bgdev.pl \
    --cc=conor+dt@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=jic23@kernel.org \
    --cc=krzk+dt@kernel.org \
    --cc=lars@metafoo.de \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nuno.sa@analog.com \
    --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