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

iio: ina2xx: add ABI documentation entry sysfs-bus-iio-ina2xx-adc

Documentation for attributes:

* in_allow_async_readout
* in_shunt_resistor

Signed-off-by: Marc Titinger <mtitinger@baylibre.com>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>

authored by

Marc Titinger and committed by
Jonathan Cameron
6e17c98a 75e1a3a7

+24
+24
Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
··· 1 + What: /sys/bus/iio/devices/iio:deviceX/in_allow_async_readout 2 + Date: December 2015 3 + KernelVersion: 4.4 4 + Contact: linux-iio@vger.kernel.org 5 + Description: 6 + By default (value '0'), the capture thread checks for the Conversion 7 + Ready Flag to being set prior to committing a new value to the sample 8 + buffer. This synchronizes the in-chip conversion rate with the 9 + in-driver readout rate at the cost of an additional register read. 10 + 11 + Writing '1' will remove the polling for the Conversion Ready Flags to 12 + save the additional i2c transaction, which will improve the bandwidth 13 + available for reading data. However, samples can be occasionally skipped 14 + or repeated, depending on the beat between the capture and conversion 15 + rates. 16 + 17 + What: /sys/bus/iio/devices/iio:deviceX/in_shunt_resistor 18 + Date: December 2015 19 + KernelVersion: 4.4 20 + Contact: linux-iio@vger.kernel.org 21 + Description: 22 + The value of the shunt resistor may be known only at runtime fom an 23 + eeprom content read by a client application. This attribute allows to 24 + set its value in ohms.