Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: iio: New docs for ad4062 driver
This adds a new page to document how to use the ad4062 ADC driver.
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
1b1ddab0
9e6c7656
+88
+86
Documentation/iio/ad4062.rst
+86
Documentation/iio/ad4062.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0-only
2
+
3
+
=============
4
+
AD4062 driver
5
+
=============
6
+
7
+
ADC driver for Analog Devices Inc. AD4060/AD4062 devices. The module name is
8
+
``ad4062``.
9
+
10
+
Supported devices
11
+
=================
12
+
13
+
The following chips are supported by this driver:
14
+
15
+
* `AD4060 <https://www.analog.com/AD4060>`_
16
+
* `AD4062 <https://www.analog.com/AD4062>`_
17
+
18
+
Wiring modes
19
+
============
20
+
21
+
The ADC is interfaced through an I3C bus, and contains two programmable GPIOs.
22
+
23
+
The ADC convert-start happens on the SDA rising edge of the I3C stop (P) bit
24
+
at the end of the read command.
25
+
26
+
The two programmable GPIOS are optional and have a role assigned if present in
27
+
the devicetree ``interrupt-names`` property:
28
+
29
+
- GP1: Is assigned the role of Data Ready signal.
30
+
31
+
Device attributes
32
+
=================
33
+
34
+
The ADC contains only one channel with following attributes:
35
+
36
+
.. list-table:: Channel attributes
37
+
:header-rows: 1
38
+
39
+
* - Attribute
40
+
- Description
41
+
* - ``in_voltage_calibscale``
42
+
- Sets the gain scaling factor that the hardware applies to the sample,
43
+
to compensate for system gain error.
44
+
* - ``in_voltage_oversampling_ratio``
45
+
- Sets device's burst averaging mode to over sample using the
46
+
internal sample rate. Value 1 disable the burst averaging mode.
47
+
* - ``in_voltage_oversampling_ratio_available``
48
+
- List of available oversampling values.
49
+
* - ``in_voltage_raw``
50
+
- Returns the raw ADC voltage value.
51
+
* - ``in_voltage_scale``
52
+
- Returns the channel scale in reference to the reference voltage
53
+
``ref-supply`` or ``vdd-supply`` if the former not present.
54
+
55
+
Also contain the following device attributes:
56
+
57
+
.. list-table:: Device attributes
58
+
:header-rows: 1
59
+
60
+
* - Attribute
61
+
- Description
62
+
* - ``sampling_frequency``
63
+
- Sets the duration of a single scan, used in the burst averaging mode.
64
+
The duration is described by ``(n_avg - 1) / fosc + tconv``, where
65
+
``n_avg`` is the oversampling ratio, ``fosc`` is the internal sample
66
+
rate and ``tconv`` is the ADC conversion time.
67
+
* - ``sampling_frequency_available``
68
+
- Lists the available sampling frequencies, computed on the current
69
+
oversampling ratio. If the ratio is 1, the frequency is ``1/tconv``.
70
+
71
+
Interrupts
72
+
==========
73
+
74
+
The interrupts are mapped through the ``interrupt-names`` and ``interrupts``
75
+
properties.
76
+
77
+
The ``interrupt-names`` ``gp1`` entry sets the role of Data Ready signal.
78
+
If it is not present, the driver fallback to enabling the same role as an
79
+
I3C IBI.
80
+
81
+
Low-power mode
82
+
==============
83
+
84
+
The device enters low-power mode on idle to save power. Enabling an event puts
85
+
the device out of the low-power since the ADC autonomously samples to assert
86
+
the event condition.
+1
Documentation/iio/index.rst
+1
Documentation/iio/index.rst
+1
MAINTAINERS
+1
MAINTAINERS
···
1438
1438
S: Supported
1439
1439
W: https://ez.analog.com/linux-software-drivers
1440
1440
F: Documentation/devicetree/bindings/iio/adc/adi,ad4062.yaml
1441
+
F: Documentation/iio/ad4062.rst
1441
1442
1442
1443
ANALOG DEVICES INC AD4080 DRIVER
1443
1444
M: Antoniu Miclaus <antoniu.miclaus@analog.com>