Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

iio: documentation: Document scd4x calibration use

Add entries from Documentation/ABI/testing/sysfs-bus-iio-scd30
to Documentation/ABI/testing/sysfs-bus-iio. The attributes of the scd4x
and scd30 are common.

Remove Documentation/ABI/testing/sysfs-bus-iio-scd30.

Signed-off-by: Roan van Dijk <roan@protonic.nl>
Link: https://lore.kernel.org/r/20211008101706.755942-5-roan@protonic.nl
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

authored by

Roan van Dijk and committed by
Jonathan Cameron
d6fa1406 49d22b69

+41 -34
+41
Documentation/ABI/testing/sysfs-bus-iio
··· 1958 1958 Specify the percent for light sensor relative to the channel 1959 1959 absolute value that a data field should change before an event 1960 1960 is generated. Units are a percentage of the prior reading. 1961 + 1962 + What: /sys/bus/iio/devices/iio:deviceX/calibration_auto_enable 1963 + Date: June 2020 1964 + KernelVersion: 5.8 1965 + Contact: linux-iio@vger.kernel.org 1966 + Description: 1967 + Some sensors have the ability to apply auto calibration at 1968 + runtime. For example, it may be necessary to compensate for 1969 + contaminant build-up in a measurement chamber or optical 1970 + element deterioration that would otherwise lead to sensor drift. 1971 + 1972 + Writing 1 or 0 to this attribute will respectively activate or 1973 + deactivate this auto calibration function. 1974 + 1975 + Upon reading, the current status is returned. 1976 + 1977 + What: /sys/bus/iio/devices/iio:deviceX/calibration_forced_value 1978 + Date: June 2020 1979 + KernelVersion: 5.8 1980 + Contact: linux-iio@vger.kernel.org 1981 + Description: 1982 + Some sensors have the ability to apply a manual calibration using 1983 + a known measurement value, perhaps obtained from an external 1984 + reference device. 1985 + 1986 + Writing a value to this function will force such a calibration 1987 + change. For the scd30 the value should be from the range 1988 + [400 1 2000]. 1989 + 1990 + Note for the scd30 that a valid value may only be obtained once 1991 + it is has been written. Until then any read back of this value 1992 + should be ignored. As for the scd4x an error will be returned 1993 + immediately if the manual calibration has failed. 1994 + 1995 + What: /sys/bus/iio/devices/iio:deviceX/calibration_forced_value_available 1996 + KernelVersion: 5.15 1997 + Contact: linux-iio@vger.kernel.org 1998 + Description: 1999 + Available range for the forced calibration value, expressed as: 2000 + 2001 + - a range specified as "[min step max]"
-34
Documentation/ABI/testing/sysfs-bus-iio-scd30
··· 1 - What: /sys/bus/iio/devices/iio:deviceX/calibration_auto_enable 2 - Date: June 2020 3 - KernelVersion: 5.8 4 - Contact: linux-iio@vger.kernel.org 5 - Description: 6 - Contaminants build-up in the measurement chamber or optical 7 - elements deterioration leads to sensor drift. 8 - 9 - One can compensate for sensor drift by using automatic self 10 - calibration procedure (asc). 11 - 12 - Writing 1 or 0 to this attribute will respectively activate or 13 - deactivate asc. 14 - 15 - Upon reading current asc status is returned. 16 - 17 - What: /sys/bus/iio/devices/iio:deviceX/calibration_forced_value 18 - Date: June 2020 19 - KernelVersion: 5.8 20 - Contact: linux-iio@vger.kernel.org 21 - Description: 22 - Contaminants build-up in the measurement chamber or optical 23 - elements deterioration leads to sensor drift. 24 - 25 - One can compensate for sensor drift by using forced 26 - recalibration (frc). This is useful in case there's known 27 - co2 reference available nearby the sensor. 28 - 29 - Picking value from the range [400 1 2000] and writing it to the 30 - sensor will set frc. 31 - 32 - Upon reading current frc value is returned. Note that after 33 - power cycling default value (i.e 400) is returned even though 34 - internally sensor had recalibrated itself.