diff mbox series

[v2,2/2] doc: iio: ad4695: document buffered read

Message ID 20240813-iio-adc-ad4695-buffered-read-v2-2-9bb19fc1924b@baylibre.com (mailing list archive)
State Accepted
Headers show
Series iio: adc: ad4695: implement triggered buffer | expand

Commit Message

David Lechner Aug. 13, 2024, 5:26 p.m. UTC
Update the ad4695 documentation to say that buffered reads are
supported. Since there are 4 possible modes of reading conversion data,
it is useful to know which one is actually being used, namely the
advanced sequencer mode.

Signed-off-by: David Lechner <dlechner@baylibre.com>
---

v2 changes:
* Drop paragraph about temperature channel since it is no longer
  applicable.
---
 Documentation/iio/ad4695.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/iio/ad4695.rst b/Documentation/iio/ad4695.rst
index a33e573d61d6..7612596bb6e9 100644
--- a/Documentation/iio/ad4695.rst
+++ b/Documentation/iio/ad4695.rst
@@ -147,9 +147,16 @@  Unimplemented features
 ----------------------
 
 - Additional wiring modes
-- Buffered reads
 - Threshold events
 - Oversampling
 - Gain/offset calibration
 - GPIO support
 - CRC support
+
+Device buffers
+==============
+
+This driver supports hardware triggered buffers. This uses the "advanced
+sequencer" feature of the chip to trigger a burst of conversions.
+
+Also see :doc:`iio_devbuf` for more general information.