Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: iio: ad4062: Add IIO Events support
Explains the IIO Events support.
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
authored by
Jorge Marques
and committed by
Jonathan Cameron
c894e058
23cc9228
+39
-2
+39
-2
Documentation/iio/ad4062.rst
+39
-2
Documentation/iio/ad4062.rst
···
26
26
The two programmable GPIOS are optional and have a role assigned if present in
27
27
the devicetree ``interrupt-names`` property:
28
28
29
+
- GP0: Is assigned the role of Threshold Either signal.
29
30
- GP1: Is assigned the role of Data Ready signal.
30
31
31
32
Device attributes
···
75
74
The interrupts are mapped through the ``interrupt-names`` and ``interrupts``
76
75
properties.
77
76
78
-
The ``interrupt-names`` ``gp1`` entry sets the role of Data Ready signal.
79
-
If it is not present, the driver fallback to enabling the same role as an
77
+
The ``interrupt-names`` ``gp0`` entry sets the role of Threshold signal, and
78
+
entry ``gp1`` the role of Data Ready signal.
79
+
80
+
If each is not present, the driver fallback to enabling the same role as an
80
81
I3C IBI.
81
82
82
83
Low-power mode
···
100
97
latency and internal timings, the sample rate is not configurable. The burst
101
98
averaging mode does impact the effective sample rate, since it increases the
102
99
internal timing to output a single sample.
100
+
101
+
Threshold events
102
+
================
103
+
104
+
The ADC supports a monitoring mode to raise threshold events. The driver
105
+
supports a single interrupt for both rising and falling readings.
106
+
107
+
The feature is enabled/disabled by setting ``thresh_either_en``. During monitor
108
+
mode, the device continuously operates in autonomous mode. Any register access
109
+
puts the device back in configuration mode, due to this, any access disables
110
+
monitor mode.
111
+
112
+
The following event attributes are available:
113
+
114
+
.. list-table:: Event attributes
115
+
:header-rows: 1
116
+
117
+
* - Attribute
118
+
- Description
119
+
* - ``sampling_frequency``
120
+
- Frequency used in the monitoring mode, sets the device internal sample
121
+
rate when the mode is activated.
122
+
* - ``sampling_frequency_available``
123
+
- List of available sample rates.
124
+
* - ``thresh_either_en``
125
+
- Enable monitoring mode.
126
+
* - ``thresh_falling_hysteresis``
127
+
- Set the hysteresis value for the minimum threshold.
128
+
* - ``thresh_falling_value``
129
+
- Set the minimum threshold value.
130
+
* - ``thresh_rising_hysteresis``
131
+
- Set the hysteresis value for the maximum threshold.
132
+
* - ``thresh_rising_value``
133
+
- Set the maximum threshold value.