Re: [PATCH 3/4] iio: Add ABI documentation for proximity

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 02/05/14 16:54, Peter Meerwald wrote:
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 <pmeerw@xxxxxxxxxx>
Again this is documented in the staging docs.  I'd argue that the _input
form should be used if we are in meters, otherwise if scale free (like it
almost always is) then it should be the _raw form.

Still we can always evolve the docs!

Applied to the togreg branch of iio.git

Thanks,

J
---
  Documentation/ABI/testing/sysfs-bus-iio | 10 ++++++++++
  1 file changed, 10 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index a9757dc..ed202b3 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -895,6 +895,16 @@ 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:	linux-iio@xxxxxxxxxxxxxxx
+Description:
+		Unit-less proximity measurement indicating that some
+		object is near the sensor, usually be observing
+		reflectivity of infrared or ultrasound emitted.
+
  What:		/sys/.../iio:deviceX/in_illuminanceY_input
  What:		/sys/.../iio:deviceX/in_illuminanceY_raw
  What:		/sys/.../iio:deviceX/in_illuminanceY_mean_raw


--
To unsubscribe from this list: send the line "unsubscribe linux-iio" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Input]     [Linux Kernel]     [Linux SCSI]     [X.org]

  Powered by Linux