| Message ID | 20210903144828.497166-4-jacopo@jmondi.org (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | iio: chemical: Add Senseair Sunrise CO2 sensor | expand |
On Fri, 3 Sep 2021 16:48:28 +0200 Jacopo Mondi <jacopo@jmondi.org> wrote: > Add documentation for the sysfs attributes of the sunrise_co2 driver. > > Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> Nice but please fill in the version numbers with 5.16 Thanks, Jonathan > --- > .../sysfs-bus-iio-chemical-sunrise-co2 | 38 +++++++++++++++++++ > 1 file changed, 38 insertions(+) > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 > > 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 > index 000000000000..bbdbf9dd4818 > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 > @@ -0,0 +1,38 @@ > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_factory > +Date: August 2021 > +KernelVersion: > +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: > +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: Be an optimist and fill this in for v5! I'll never remember to do it. I'd be very surprised if we don't get this lined up for 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: > +Contact: Jacopo Mondi <jacopo@jmondi.org> > +Description: > + Reading returns the current chip error status.
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 index 000000000000..bbdbf9dd4818 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 @@ -0,0 +1,38 @@ +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_factory +Date: August 2021 +KernelVersion: +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: +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: +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: +Contact: Jacopo Mondi <jacopo@jmondi.org> +Description: + Reading returns the current chip error status.
Add documentation for the sysfs attributes of the sunrise_co2 driver. Signed-off-by: Jacopo Mondi <jacopo@jmondi.org> --- .../sysfs-bus-iio-chemical-sunrise-co2 | 38 +++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2