| Message ID | 20210822184927.94673-4-jacopo@jmondi.org (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | iio: chemical: Add Senseair Sunrise CO2 sensor | expand |
On Sun, 22 Aug 2021 20:49:27 +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> > --- > .../sysfs-bus-iio-chemical-sunrise-co2 | 51 +++++++++++++++++++ > 1 file changed, 51 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..1a252f616652 > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 > @@ -0,0 +1,51 @@ > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_calibration_mode_available > +Date: August 2021 > +KernelVersion: > +Contact: Jacopo Mondi <jacopo@jmondi.org> > +Description: > + Reading returns the list of the possible calibration modes. > + Available options: > + - 'factory_calibration': Restore factory calibration > + - 'background_calibration': Calibration using target value > + > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_mode > +Date: August 2021 > +KernelVersion: > +Contact: Jacopo Mondi <jacopo@jmondi.org> > +Description: > + Reading returns the currently selected calibration mode. > + Writing sets the desired calibration mode to one of the values > + returned by 'in_concentration_calibration_mode_available' > + > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration > +Date: August 2021 > +KernelVersion: > +Contact: Jacopo Mondi <jacopo@jmondi.org> > +Description: > + Writing '1' triggers a calibration cycle according to the mode > + set int 'in_concentration_co2_calibration_mode'. Why not just have two attributes: in_concentration_co2_calibration_factory in_concentration_co2_calibration_background and have writing 1 to the appropriate one start that type of calibration? Feels like that would be a simpler interface. > + > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_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/in_concentration_co2_error_status Some of these are not 'technically' channels specific, so I'd argue this should be shared_by_all and hence error_status only. One day we will have a nice general way of reporting such errors, but that's not an IIO question as such so we can probably cope with this. > +Date: August 2021 > +KernelVersion: > +Contact: Jacopo Mondi <jacopo@jmondi.org> > +Description: > + Reading returns the current chip error status.
Hi Jonathan, On Sun, Aug 29, 2021 at 05:57:48PM +0100, Jonathan Cameron wrote: > On Sun, 22 Aug 2021 20:49:27 +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> > > --- > > .../sysfs-bus-iio-chemical-sunrise-co2 | 51 +++++++++++++++++++ > > 1 file changed, 51 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..1a252f616652 > > --- /dev/null > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 > > @@ -0,0 +1,51 @@ > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_calibration_mode_available > > +Date: August 2021 > > +KernelVersion: > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > +Description: > > + Reading returns the list of the possible calibration modes. > > + Available options: > > + - 'factory_calibration': Restore factory calibration > > + - 'background_calibration': Calibration using target value > > + > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_mode > > +Date: August 2021 > > +KernelVersion: > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > +Description: > > + Reading returns the currently selected calibration mode. > > + Writing sets the desired calibration mode to one of the values > > + returned by 'in_concentration_calibration_mode_available' > > + > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration > > +Date: August 2021 > > +KernelVersion: > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > +Description: > > + Writing '1' triggers a calibration cycle according to the mode > > + set int 'in_concentration_co2_calibration_mode'. > Why not just have two attributes: > > in_concentration_co2_calibration_factory > in_concentration_co2_calibration_background > and have writing 1 to the appropriate one start that type of calibration? > > Feels like that would be a simpler interface. Please see my reply in the driver's patch. With an ack to the fact the chip supports 5 calibration modes and we might end up with one attribute for each, I'll change. > > > + > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_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/in_concentration_co2_error_status > > Some of these are not 'technically' channels specific, so I'd argue this should be shared_by_all > and hence error_status only. You know, it's kind of a mixed bag of errors. I thought as most apply to calibration/concentration it made sense to have them separate, but I can change this to be shared indeed. > > One day we will have a nice general way of reporting such errors, but that's not an IIO question > as such so we can probably cope with this. > > > > +Date: August 2021 > > +KernelVersion: > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > +Description: > > + Reading returns the current chip error status. >
On Mon, 30 Aug 2021 18:24:11 +0200 Jacopo Mondi <jacopo@jmondi.org> wrote: > Hi Jonathan, > > On Sun, Aug 29, 2021 at 05:57:48PM +0100, Jonathan Cameron wrote: > > On Sun, 22 Aug 2021 20:49:27 +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> > > > --- > > > .../sysfs-bus-iio-chemical-sunrise-co2 | 51 +++++++++++++++++++ > > > 1 file changed, 51 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..1a252f616652 > > > --- /dev/null > > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 > > > @@ -0,0 +1,51 @@ > > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_calibration_mode_available > > > +Date: August 2021 > > > +KernelVersion: > > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > > +Description: > > > + Reading returns the list of the possible calibration modes. > > > + Available options: > > > + - 'factory_calibration': Restore factory calibration > > > + - 'background_calibration': Calibration using target value > > > + > > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_mode > > > +Date: August 2021 > > > +KernelVersion: > > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > > +Description: > > > + Reading returns the currently selected calibration mode. > > > + Writing sets the desired calibration mode to one of the values > > > + returned by 'in_concentration_calibration_mode_available' > > > + > > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration > > > +Date: August 2021 > > > +KernelVersion: > > > +Contact: Jacopo Mondi <jacopo@jmondi.org> > > > +Description: > > > + Writing '1' triggers a calibration cycle according to the mode > > > + set int 'in_concentration_co2_calibration_mode'. > > Why not just have two attributes: > > > > in_concentration_co2_calibration_factory > > in_concentration_co2_calibration_background > > and have writing 1 to the appropriate one start that type of calibration? > > > > Feels like that would be a simpler interface. > > Please see my reply in the driver's patch. > With an ack to the fact the chip supports 5 calibration modes and we > might end up with one attribute for each, I'll change. 5 attrs is fine. > > > > > > + > > > +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_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/in_concentration_co2_error_status > > > > Some of these are not 'technically' channels specific, so I'd argue this should be shared_by_all > > and hence error_status only. > > You know, it's kind of a mixed bag of errors. > > I thought as most apply to calibration/concentration it made sense to > have them separate, but I can change this to be shared indeed. It's obscure and custom so I don't really care. Up to you. > > > > > One day we will have a nice general way of reporting such errors, but that's not an IIO question > > as such so we can probably cope with this. > > > > > > > +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..1a252f616652 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2 @@ -0,0 +1,51 @@ +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_calibration_mode_available +Date: August 2021 +KernelVersion: +Contact: Jacopo Mondi <jacopo@jmondi.org> +Description: + Reading returns the list of the possible calibration modes. + Available options: + - 'factory_calibration': Restore factory calibration + - 'background_calibration': Calibration using target value + +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration_mode +Date: August 2021 +KernelVersion: +Contact: Jacopo Mondi <jacopo@jmondi.org> +Description: + Reading returns the currently selected calibration mode. + Writing sets the desired calibration mode to one of the values + returned by 'in_concentration_calibration_mode_available' + +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_co2_calibration +Date: August 2021 +KernelVersion: +Contact: Jacopo Mondi <jacopo@jmondi.org> +Description: + Writing '1' triggers a calibration cycle according to the mode + set int 'in_concentration_co2_calibration_mode'. + +What: /sys/bus/iio/devices/iio:deviceX/in_concentration_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/in_concentration_co2_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 | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-chemical-sunrise-co2