Skip to content

Commit 4e7e996

Browse files
dlechnunojsa
authored andcommitted
doc: iio: ad7944: describe offload support
Add a section to the ad7944 documentation describing how to use the driver with SPI offloading. Signed-off-by: David Lechner <dlechner@baylibre.com> Link: https://patch.msgid.link/20250207-dlech-mainline-spi-engine-offload-2-v8-12-e48a489be48c@baylibre.com Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
1 parent 992522a commit 4e7e996

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

Documentation/iio/ad7944.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ CS mode, 3-wire, without busy indicator
4646
To select this mode in the device tree, set the ``adi,spi-mode`` property to
4747
``"single"`` and omit the ``cnv-gpios`` property.
4848

49+
This is the only wiring configuration supported when using `SPI offload support`_.
50+
4951
CS mode, 4-wire, without busy indicator
5052
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5153

@@ -106,7 +108,6 @@ Unimplemented features
106108
----------------------
107109

108110
- ``BUSY`` indication
109-
- ``TURBO`` mode
110111

111112

112113
Device attributes
@@ -147,6 +148,27 @@ AD7986 is a fully-differential ADC and has the following attributes:
147148
In "chain" mode, additional chips will appear as additional voltage input
148149
channels, e.g. ``in_voltage2-voltage3_raw``.
149150

151+
SPI offload support
152+
===================
153+
154+
To be able to achieve the maximum sample rate, the driver can be used with the
155+
`AXI SPI Engine`_ to provide SPI offload support.
156+
157+
.. _AXI SPI Engine: http://analogdevicesinc.github.io/hdl/projects/pulsar_adc/index.html
158+
159+
When SPI offload is being used, some attributes will be different.
160+
161+
* ``trigger`` directory is removed.
162+
* ``in_voltage0_sampling_frequency`` attribute is added for setting the sample
163+
rate.
164+
* ``in_voltage0_sampling_frequency_available`` attribute is added for querying
165+
the max sample rate.
166+
* ``timestamp`` channel is removed.
167+
* Buffer data format may be different compared to when offload is not used,
168+
e.g. the ``in_voltage0_type`` attribute.
169+
170+
If the ``turbo-gpios`` property is present in the device tree, the driver will
171+
turn on TURBO during buffered reads and turn it off otherwise.
150172

151173
Device buffers
152174
==============

0 commit comments

Comments
 (0)