iio: Add ABI documentation for proximity
Jonathan Cameron
maintainerPATCH 1/1 iio: Add ABI documentation for proximity
From: Peter Meerwald <[email protected]>
has been in use for a long time, but never documented proximity is unit-less, except otherwise stated, see e.g. the as3935 driver where it is meter
Signed-off-by Peter Meerwald <[email protected]>
Signed-off-by Jonathan Cameron <[email protected]>
--- Documentation/ABI/testing/sysfs-bus-iio | 13 +++++++++++++ 1 file changed, 13 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +13 -0
@@ -895,6 +895,19 @@ Description: on-chip EEPROM. After power-up or chip reset the device will automatically load the saved configuration. +What: /sys/.../iio:deviceX/in_proximity_raw +What: /sys/.../iio:deviceX/in_proximity_input +What: /sys/.../iio:deviceX/in_proximityY_raw +KernelVersion: 3.4 +Contact: [email protected] +Description: + Proximity measurement indicating that some + object is near the sensor, usually be observing + reflectivity of infrared or ultrasound emitted. + Often these sensors are unit less and as such conversion + to SI units is not possible. Where it is, the units should + be meters. + What: /sys/.../iio:deviceX/in_illuminanceY_input What: /sys/.../iio:deviceX/in_illuminanceY_raw What: /sys/.../iio:deviceX/in_illuminanceY_mean_raw
Signature · 1 line
1.9.2
Jonathan Cameron
maintainerQuoted 8 lines · Jonathan Cameron
From: Peter Meerwald <[email protected]>
has been in use for a long time, but never documented proximity is unit-less, except otherwise stated, see e.g. the as3935 driver where it is meter
Signed-off-by Peter Meerwald <[email protected]>Signed-off-by Jonathan Cameron <[email protected]>
I'm going to assume no one minds the changes that I made to Peter's original patch. Applied to the togreg branch of iio.git
Thanks,
Jonathan
Quoted 29 lines
--- Documentation/ABI/testing/sysfs-bus-iio | 13 +++++++++++++ 1 file changed, 13 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +13
-0@@ -895,6 +895,19 @@ Description: on-chip EEPROM. After power-up or chip reset the device will automatically load the saved configuration. +What: /sys/.../iio:deviceX/in_proximity_raw +What: /sys/.../iio:deviceX/in_proximity_input +What: /sys/.../iio:deviceX/in_proximityY_raw +KernelVersion: 3.4 +Contact: [email protected] +Description: + Proximity measurement indicating that some + object is near the sensor, usually be observing + reflectivity of infrared or ultrasound emitted. + Often these sensors are unit less and as such conversion + to SI units is not possible. Where it is, the units should + be meters. + What: /sys/.../iio:deviceX/in_illuminanceY_input What: /sys/.../iio:deviceX/in_illuminanceY_raw What: /sys/.../iio:deviceX/in_illuminanceY_mean_raw