iio: document pitch, yaw, roll modifiers
authorAndrea Merello <andrea.merello@iit.it>
Wed, 7 Sep 2022 13:21:56 +0000 (15:21 +0200)
committerJonathan Cameron <Jonathan.Cameron@huawei.com>
Wed, 21 Sep 2022 17:42:55 +0000 (18:42 +0100)
Introduce ABI documentation for new modifiers used for reporting rotations
expressed as euler angles (i.e. yaw, pitch, roll).

It looks like we have some unit inconsistency along various IIO modifiers:
it seems that incli is in deg, angl is in radians and rot isn't documented,
but at least the adis16209 driver has rot in deg.

Here we use deg (so angl is the only one using radians).

Signed-off-by: Andrea Merello <andrea.merello@iit.it>
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
Link: https://lore.kernel.org/r/20220907132205.28021-6-andrea.merello@iit.it
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Documentation/ABI/testing/sysfs-bus-iio

index 3f2a92891f16086b8e5046284fef77c38b7bf19e..c79b3fde76687ff0404c39c864c662e40629dab4 100644 (file)
@@ -2146,3 +2146,12 @@ Contact: linux-iio@vger.kernel.org
 Description:
                Lists all available time values between upper peak to lower
                peak. Units in seconds.
+
+What:          /sys/bus/iio/devices/iio:deviceX/in_rot_yaw_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_rot_pitch_raw
+What:          /sys/bus/iio/devices/iio:deviceX/in_rot_roll_raw
+KernelVersion: 6.1
+Contact:       linux-iio@vger.kernel.org
+Description:
+               Raw (unscaled) euler angles readings. Units after
+               application of scale are deg.