Documentation/iio/ad4062.rst

Source file repositories/reference/linux-study-clean/Documentation/iio/ad4062.rst

File Facts

System
Linux kernel
Corpus path
Documentation/iio/ad4062.rst
Extension
.rst
Size
5108 bytes
Lines
149
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

.. SPDX-License-Identifier: GPL-2.0-only

=============
AD4062 driver
=============

ADC driver for Analog Devices Inc. AD4060/AD4062 devices. The module name is
``ad4062``.

Supported devices
=================

The following chips are supported by this driver:

* `AD4060 <https://www.analog.com/AD4060>`_
* `AD4062 <https://www.analog.com/AD4062>`_

Wiring modes
============

The ADC is interfaced through an I3C bus, and contains two programmable GPIOs.

The ADC convert-start happens on the SDA rising edge of the I3C stop (P) bit
at the end of the read command.

The two programmable GPIOS are optional and have a role assigned if present in
the devicetree ``interrupt-names`` property:

- GP0: Is assigned the role of Threshold Either signal.
- GP1: Is assigned the role of Data Ready signal.

If the property ``gpio-controller`` is present in the devicetree, then the GPO
not present in the ``interrupt-names`` is exposed as a GPO.

Device attributes
=================

The ADC contains only one channel with following attributes:

.. list-table:: Channel attributes
   :header-rows: 1

   * - Attribute
     - Description
   * - ``in_voltage_calibscale``
     - Sets the gain scaling factor that the hardware applies to the sample,
       to compensate for system gain error.
   * - ``in_voltage_oversampling_ratio``
     - Sets device's burst averaging mode to over sample using the
       internal sample rate. Value 1 disable the burst averaging mode.
   * - ``in_voltage_oversampling_ratio_available``
     - List of available oversampling values.
   * - ``in_voltage_raw``
     - Returns the raw ADC voltage value.
   * - ``in_voltage_scale``
     - Returns the channel scale in reference to the reference voltage
       ``ref-supply`` or ``vdd-supply`` if the former not present.

Also contain the following device attributes:

.. list-table:: Device attributes
   :header-rows: 1

   * - Attribute
     - Description
   * - ``sampling_frequency``
     - Sets the duration of a single scan, used in the burst averaging mode.
       The duration is described by ``(n_avg - 1) / fosc + tconv``, where
       ``n_avg`` is the oversampling ratio, ``fosc`` is the internal sample
       rate and ``tconv`` is the ADC conversion time.

Annotation

Implementation Notes