Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: iio: add documentation for ad3552r driver
Add documentation for ad3552r driver, needed to describe the high-speed
driver debugfs attributes and shows how the user may use them.
Signed-off-by: Angelo Dureghello <adureghello@baylibre.com>
Link: https://patch.msgid.link/20250409-wip-bl-ad3552r-fixes-v5-2-fb429c3a6515@baylibre.com
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
authored by
Angelo Dureghello
and committed by
Jonathan Cameron
ede84c45
02903563
+74
+72
Documentation/iio/ad3552r.rst
+72
Documentation/iio/ad3552r.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0-only
2
+
3
+
==============
4
+
AD3552R driver
5
+
==============
6
+
7
+
Device driver for Analog Devices Inc. AD35XXR series of DACs. The module name
8
+
is ``ad3552r``.
9
+
With the same module name, two different driver variants are available, the
10
+
``generic spi`` variant, to be used with any classic SPI controllers, and the
11
+
``hs`` (high speed) variant, for an ADI ``axi-dac`` (IP core) based controller
12
+
that allows to reach the maximum sample rate supported from the DACs, using the
13
+
DMA transfer and all the SPI lines available (D/QDSPI)..
14
+
The high speed driver variant is intended to be used with the ``adi-axi-dac``
15
+
backend support enabled, that is enabled by default when the driver is selected.
16
+
17
+
Supported devices
18
+
=================
19
+
20
+
* `AD3541R <https://www.analog.com/en/products/ad3541r.html>`_
21
+
* `AD3542R <https://www.analog.com/en/products/ad3542r.html>`_
22
+
* `AD3551R <https://www.analog.com/en/products/ad3551r.html>`_
23
+
* `AD3552R <https://www.analog.com/en/products/ad3552r.html>`_
24
+
25
+
Wiring connections
26
+
==================
27
+
28
+
Generic SPI
29
+
-----------
30
+
Use the classic SPI S_CLK/CS/SDO/SDI connection.
31
+
32
+
High speed (using axi-dac backend)
33
+
----------------------------------
34
+
35
+
::
36
+
37
+
.-----------------. .-------.
38
+
| |--- D/QSPI -----| |
39
+
| DAC IP CORE |--- SPI S_CLK --| DAC |
40
+
| |--- SPI CS -----| |
41
+
| |--- LDAC -------| |
42
+
| |--- RESET ------| |
43
+
|_________________| |_______|
44
+
45
+
46
+
High speed features
47
+
===================
48
+
49
+
Device attributes
50
+
-----------------
51
+
52
+
The following table shows the ad35xxr related device debug files, found in the
53
+
specific debugfs path ``/sys/kernel/debug/iio/iio:deviceX``.
54
+
55
+
+-----------------------+------------------------------------------------------+
56
+
| Debugfs device files | Description |
57
+
+-----------------------+------------------------------------------------------+
58
+
| data_source | The used data source, as |
59
+
| | ``normal``, ``ramp-16bit``, etc. |
60
+
+-----------------------+------------------------------------------------------+
61
+
| data_source_available | The available data sources. |
62
+
+-----------------------+------------------------------------------------------+
63
+
64
+
Usage examples
65
+
--------------
66
+
67
+
. code-block:: bash
68
+
root:/sys/bus/iio/devices/iio:device0# cat data_source
69
+
normal
70
+
root:/sys/bus/iio/devices/iio:device0# echo -n ramp-16bit > data_source
71
+
root:/sys/bus/iio/devices/iio:device0# cat data_source
72
+
ramp-16bit
+1
Documentation/iio/index.rst
+1
Documentation/iio/index.rst
+1
MAINTAINERS
+1
MAINTAINERS