From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.5 required=3.0 tests=BAYES_00,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_2 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 471EEC432BE for ; Sun, 29 Aug 2021 16:54:39 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 2893260F39 for ; Sun, 29 Aug 2021 16:54:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230497AbhH2Qza (ORCPT ); Sun, 29 Aug 2021 12:55:30 -0400 Received: from mail.kernel.org ([198.145.29.99]:51884 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229838AbhH2Qza (ORCPT ); Sun, 29 Aug 2021 12:55:30 -0400 Received: from jic23-huawei (cpc108967-cmbg20-2-0-cust86.5-4.cable.virginm.net [81.101.6.87]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id D41D860F23; Sun, 29 Aug 2021 16:54:35 +0000 (UTC) Date: Sun, 29 Aug 2021 17:57:48 +0100 From: Jonathan Cameron To: Jacopo Mondi Cc: Lars-Peter Clausen , Andy Shevchenko , Matt Ranostay , Magnus Damm , linux-iio@vger.kernel.org Subject: Re: [PATCH v3 3/3] iio: ABI: docs: Document Senseair Sunrise ABI Message-ID: <20210829175748.6c4e9a20@jic23-huawei> In-Reply-To: <20210822184927.94673-4-jacopo@jmondi.org> References: <20210822184927.94673-1-jacopo@jmondi.org> <20210822184927.94673-4-jacopo@jmondi.org> X-Mailer: Claws Mail 4.0.0 (GTK+ 3.24.30; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org On Sun, 22 Aug 2021 20:49:27 +0200 Jacopo Mondi wrote: > Add documentation for the sysfs attributes of the sunrise_co2 driver. > > Signed-off-by: Jacopo Mondi > --- > .../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 > +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 > +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 > +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 > +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 > +Description: > + Reading returns the current chip error status.