Documentation/iio/ade9000.rst

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

File Facts

System: Linux kernel
Corpus path: Documentation/iio/ade9000.rst
Extension: .rst
Size: 15901 bytes
Lines: 269
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.

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

Dependency Surface

No C-style include directives detected by the generator.

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

.. SPDX-License-Identifier: GPL-2.0

===============
ADE9000 driver
===============

This driver supports Analog Device's ADE9000 energy measurement IC on SPI bus.

1. Supported devices
====================

* `ADE9000 <https://www.analog.com/media/en/technical-documentation/data-sheets/ADE9000.pdf>`_

The ADE9000 is a highly accurate, fully integrated, multiphase energy and power
quality monitoring device. Superior analog performance and a digital signal
processing (DSP) core enable accurate energy monitoring over a wide dynamic
range. An integrated high end reference ensures low drift over temperature
with a combined drift of less than ±25 ppm/°C maximum for the entire channel
including a programmable gain amplifier (PGA) and an analog-to-digital
converter (ADC).

2. Device attributes
====================

Power and energy measurements are provided for voltage, current, active power,
reactive power, apparent power, and power factor across three phases.

Each IIO device has a device folder under ``/sys/bus/iio/devices/iio:deviceX``,
where X is the IIO index of the device. Under these folders reside a set of
device files, depending on the characteristics and features of the hardware
device in question. These files are consistently generalized and documented in
the IIO ABI documentation.

The following tables show the ADE9000 related device files, found in the
specific device folder path ``/sys/bus/iio/devices/iio:deviceX``.

+---------------------------------------------------+----------------------------------------------------------+
| Current measurement related device files          | Description                                              |
+---------------------------------------------------+----------------------------------------------------------+
| in_current[0-2]_raw                               | Raw current measurement for phases A, B, C.              |
+---------------------------------------------------+----------------------------------------------------------+
| in_current[0-2]_scale                             | Scale for current channels.                              |
+---------------------------------------------------+----------------------------------------------------------+
| in_current[0-2]_calibscale                        | Calibration gain for current channels (AIGAIN reg).      |
+---------------------------------------------------+----------------------------------------------------------+
| in_altcurrent[0-2]_rms_raw                        | RMS current measurement for phases A, B, C.              |
+---------------------------------------------------+----------------------------------------------------------+
| in_altcurrent[0-2]_rms_scale                      | Scale for RMS current channels.                          |
+---------------------------------------------------+----------------------------------------------------------+
| in_altcurrent[0-2]_rms_calibbias                  | RMS offset correction for current channels (IRMSOS reg). |
+---------------------------------------------------+----------------------------------------------------------+

+---------------------------------------------------+----------------------------------------------------------+
| Voltage measurement related device files          | Description                                              |
+---------------------------------------------------+----------------------------------------------------------+
| in_voltage[0-2]_raw                               | Raw voltage measurement for phases A, B, C.              |
+---------------------------------------------------+----------------------------------------------------------+
| in_voltage[0-2]_scale                             | Scale for voltage channels.                              |
+---------------------------------------------------+----------------------------------------------------------+
| in_voltage[0-2]_calibscale                        | Calibration gain for voltage channels (AVGAIN reg).      |
+---------------------------------------------------+----------------------------------------------------------+
| in_voltage[0-2]_frequency                         | Measured line frequency from instantaneous voltage.      |
+---------------------------------------------------+----------------------------------------------------------+
| in_altvoltage[0-2]_rms_raw                        | RMS voltage measurement for phases A, B, C.              |
+---------------------------------------------------+----------------------------------------------------------+
| in_altvoltage[0-2]_rms_scale                      | Scale for RMS voltage channels.                          |
+---------------------------------------------------+----------------------------------------------------------+
| in_altvoltage[0-2]_rms_calibbias                  | RMS offset correction for voltage channels (VRMSOS reg). |
+---------------------------------------------------+----------------------------------------------------------+

Annotation

Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

Implementation Notes

This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.