iio: ABI: docs: Document Senseair Sunrise ABI
authorJacopo Mondi <jacopo@jmondi.org>
Mon, 20 Sep 2021 13:54:11 +0000 (15:54 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Tue, 19 Oct 2021 07:27:31 +0000 (08:27 +0100)
Add documentation for the sysfs attributes of the sunrise_co2 driver.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
Link: https://lore.kernel.org/r/20210920135413.140310-3-jacopo+renesas@jmondi.org
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2
new file mode 100644 (file)
index 0000000..ee7aeb1
--- /dev/null
@@ -0,0 +1,38 @@
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_factory
+Date:          August 2021
+KernelVersion: 5.16
+Contact:       Jacopo Mondi <jacopo@jmondi.org>
+Description:
+               Writing '1' triggers a 'Factory' calibration cycle.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_background
+Date:          August 2021
+KernelVersion: 5.16
+Contact:       Jacopo Mondi <jacopo@jmondi.org>
+Description:
+               Writing '1' triggers a 'Background' calibration cycle.
+
+What:          /sys/bus/iio/devices/iio:deviceX/error_status_available
+Date:          August 2021
+KernelVersion: 5.16
+Contact:       Jacopo Mondi <jacopo@jmondi.org>
+Description:
+               Reading returns the list of possible chip error status.
+               Available options are:
+               - 'error_fatal': Analog front-end initialization error
+               - 'error_i2c': Read/write to non-existing register
+               - 'error_algorithm': Corrupted parameters
+               - 'error_calibration': Calibration has failed
+               - 'error_self_diagnostic': Internal interface failure
+               - 'error_out_of_range': Measured concentration out of scale
+               - 'error_memory': Error during memory operations
+               - 'error_no_measurement': Cleared at first measurement
+               - 'error_low_voltage': Sensor regulated voltage too low
+               - 'error_measurement_timeout': Unable to complete measurement
+
+What:          /sys/bus/iio/devices/iio:deviceX/error_status
+Date:          August 2021
+KernelVersion: 5.16
+Contact:       Jacopo Mondi <jacopo@jmondi.org>
+Description:
+               Reading returns the current chip error status.