lkml.org 
[lkml]   [2014]   [Jun]   [21]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v3 1/3] iio: documentation: Added documentation for rotation from north usage attributes
On 16/06/14 23:30, Reyad Attiyat wrote:
> Added documentation for the sysfs attributes added by the rotation from north
> usage attributes.
>
> Signed-off-by: Reyad Attiyat <reyad.attiyat@gmail.com>
Nearly there, but I'd prefer a slight reorganization of the docs. See below.
> ---
> Documentation/ABI/testing/sysfs-bus-iio | 79 ++++++++++++++++++++++++++++++++-
> 1 file changed, 78 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index a9757dc..2837fd9 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -260,6 +260,10 @@ What: /sys/bus/iio/devices/iio:deviceX/in_magn_scale
> What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_scale
> What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_scale
> What: /sys/bus/iio/devices/iio:deviceX/in_magn_z_scale
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_scale
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_scale
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_tilt_comp_scale
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_tilt_comp_scale
> What: /sys/bus/iio/devices/iio:deviceX/in_pressureY_scale
> What: /sys/bus/iio/devices/iio:deviceX/in_pressure_scale
> KernelVersion: 2.6.35
> @@ -447,6 +451,14 @@ What: /sys/.../iio:deviceX/events/in_magn_y_thresh_rising_en
> What: /sys/.../iio:deviceX/events/in_magn_y_thresh_falling_en
> What: /sys/.../iio:deviceX/events/in_magn_z_thresh_rising_en
> What: /sys/.../iio:deviceX/events/in_magn_z_thresh_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_thresh_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_thresh_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_thresh_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_thresh_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_thresh_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_thresh_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_tilt_comp_thresh_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_tilt_comp_thresh_falling_en
> What: /sys/.../iio:deviceX/events/in_voltageY_supply_thresh_rising_en
> What: /sys/.../iio:deviceX/events/in_voltageY_supply_thresh_falling_en
> What: /sys/.../iio:deviceX/events/in_voltageY_thresh_rising_en
> @@ -492,6 +504,14 @@ What: /sys/.../iio:deviceX/events/in_magn_y_roc_rising_en
> What: /sys/.../iio:deviceX/events/in_magn_y_roc_falling_en
> What: /sys/.../iio:deviceX/events/in_magn_z_roc_rising_en
> What: /sys/.../iio:deviceX/events/in_magn_z_roc_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_roc_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_roc_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_roc_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_roc_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_roc_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_magnetic_tilt_comp_roc_falling_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_tilt_comp_roc_rising_en
> +What: /sys/.../iio:deviceX/events/in_rot_from_north_true_tilt_comp_roc_falling_en
> What: /sys/.../iio:deviceX/events/in_voltageY_supply_roc_rising_en
> What: /sys/.../iio:deviceX/events/in_voltageY_supply_roc_falling_en
> What: /sys/.../iio:deviceX/events/in_voltageY_roc_rising_en
> @@ -538,6 +558,14 @@ What: /sys/.../events/in_magn_y_raw_thresh_rising_value
> What: /sys/.../events/in_magn_y_raw_thresh_falling_value
> What: /sys/.../events/in_magn_z_raw_thresh_rising_value
> What: /sys/.../events/in_magn_z_raw_thresh_falling_value
> +What: /sys/.../events/in_rot_from_north_magnetic_raw_thresh_rising_value
> +What: /sys/.../events/in_rot_from_north_magnetic_raw_thresh_falling_value
> +What: /sys/.../events/in_rot_from_north_true_raw_thresh_rising_value
> +What: /sys/.../events/in_rot_from_north_true_raw_thresh_falling_value
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_raw_thresh_rising_value
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_raw_thresh_falling_value
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_raw_thresh_rising_value
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_raw_thresh_falling_value
> What: /sys/.../events/in_voltageY_supply_raw_thresh_rising_value
> What: /sys/.../events/in_voltageY_supply_raw_thresh_falling_value
> What: /sys/.../events/in_voltageY_raw_thresh_rising_value
> @@ -588,6 +616,18 @@ What: /sys/.../events/in_magn_y_thresh_either_hysteresis
> What: /sys/.../events/in_magn_z_thresh_rising_hysteresis
> What: /sys/.../events/in_magn_z_thresh_falling_hysteresis
> What: /sys/.../events/in_magn_z_thresh_either_hysteresis
> +What: /sys/.../events/in_rot_from_north_magnetic_thresh_rising_hysteresis
> +What: /sys/.../events/in_rot_from_north_magnetic_thresh_falling_hysteresis
> +What: /sys/.../events/in_rot_from_north_magnetic_thresh_either_hysteresis
> +What: /sys/.../events/in_rot_from_north_true_thresh_rising_hysteresis
> +What: /sys/.../events/in_rot_from_north_true_thresh_falling_hysteresis
> +What: /sys/.../events/in_rot_from_north_true_thresh_either_hysteresis
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_thresh_rising_hysteresis
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_thresh_falling_hysteresis
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_thresh_either_hysteresis
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_thresh_rising_hysteresis
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_thresh_falling_hysteresis
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_thresh_either_hysteresis
> What: /sys/.../events/in_voltageY_thresh_rising_hysteresis
> What: /sys/.../events/in_voltageY_thresh_falling_hysteresis
> What: /sys/.../events/in_voltageY_thresh_either_hysteresis
> @@ -635,6 +675,14 @@ What: /sys/.../events/in_magn_y_raw_roc_rising_value
> What: /sys/.../events/in_magn_y_raw_roc_falling_value
> What: /sys/.../events/in_magn_z_raw_roc_rising_value
> What: /sys/.../events/in_magn_z_raw_roc_falling_value
> +What: /sys/.../events/in_rot_from_north_magnetic_raw_roc_rising_value
> +What: /sys/.../events/in_rot_from_north_magnetic_raw_roc_falling_value
> +What: /sys/.../events/in_rot_from_north_true_raw_roc_rising_value
> +What: /sys/.../events/in_rot_from_north_true_raw_roc_falling_value
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_raw_roc_rising_value
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_raw_roc_falling_value
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_raw_roc_rising_value
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_raw_roc_falling_value
> What: /sys/.../events/in_voltageY_supply_raw_roc_rising_value
> What: /sys/.../events/in_voltageY_supply_raw_roc_falling_value
> What: /sys/.../events/in_voltageY_raw_roc_rising_value
> @@ -690,6 +738,22 @@ What: /sys/.../events/in_magn_z_thresh_rising_period
> What: /sys/.../events/in_magn_z_thresh_falling_period
> What: /sys/.../events/in_magn_z_roc_rising_period
> What: /sys/.../events/in_magn_z_roc_falling_period
> +What: /sys/.../events/in_rot_from_north_magnetic_thresh_rising_period
> +What: /sys/.../events/in_rot_from_north_magnetic_thresh_falling_period
> +What: /sys/.../events/in_rot_from_north_magnetic_roc_rising_period
> +What: /sys/.../events/in_rot_from_north_magnetic_roc_falling_period
> +What: /sys/.../events/in_rot_from_north_true_thresh_rising_period
> +What: /sys/.../events/in_rot_from_north_true_thresh_falling_period
> +What: /sys/.../events/in_rot_from_north_true_roc_rising_period
> +What: /sys/.../events/in_rot_from_north_true_roc_falling_period
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_thresh_rising_period
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_thresh_falling_period
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_roc_rising_period
> +What: /sys/.../events/in_rot_from_north_magnetic_tilt_comp_roc_falling_period
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_thresh_rising_period
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_thresh_falling_period
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_roc_rising_period
> +What: /sys/.../events/in_rot_from_north_true_tilt_comp_roc_falling_period
> What: /sys/.../events/in_voltageY_supply_thresh_rising_period
> What: /sys/.../events/in_voltageY_supply_thresh_falling_period
> What: /sys/.../events/in_voltageY_supply_roc_rising_period
> @@ -787,6 +851,10 @@ What: /sys/.../iio:deviceX/scan_elements/in_anglvel_z_en
> What: /sys/.../iio:deviceX/scan_elements/in_magn_x_en
> What: /sys/.../iio:deviceX/scan_elements/in_magn_y_en
> What: /sys/.../iio:deviceX/scan_elements/in_magn_z_en
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_en
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_en
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_en
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_en
> What: /sys/.../iio:deviceX/scan_elements/in_timestamp_en
> What: /sys/.../iio:deviceX/scan_elements/in_voltageY_supply_en
> What: /sys/.../iio:deviceX/scan_elements/in_voltageY_en
> @@ -853,6 +921,10 @@ What: /sys/.../iio:deviceX/scan_elements/in_anglvel_z_index
> What: /sys/.../iio:deviceX/scan_elements/in_magn_x_index
> What: /sys/.../iio:deviceX/scan_elements/in_magn_y_index
> What: /sys/.../iio:deviceX/scan_elements/in_magn_z_index
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_index
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_index
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_index
> +What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_index
> What: /sys/.../iio:deviceX/scan_elements/in_incli_x_index
> What: /sys/.../iio:deviceX/scan_elements/in_incli_y_index
> What: /sys/.../iio:deviceX/scan_elements/in_timestamp_index
> @@ -926,10 +998,15 @@ Description:
> seconds.
>
> What: /sys/bus/iio/devices/iio:deviceX/in_rot_quaternion_raw
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_raw
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_raw
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_magnetic_tilt_comp_raw
> +What: /sys/bus/iio/devices/iio:deviceX/in_rot_from_north_true_tilt_comp_raw
> KernelVersion: 3.15
> Contact: linux-iio@vger.kernel.org
> Description:
> Raw value of quaternion components using a format
> x y z w. Here x, y, and z component represents the axis about
> which a rotation will occur and w component represents the
> - amount of rotation.
> + amount of rotation. Raw value of rotation from true/magnetic
> + north measured with or without compensation from tilt sensors
>
Don't combine it with the quaternion description. It just adds confusion. Please give these
_raw entries their own section in the docs.



\
 
 \ /
  Last update: 2014-06-21 13:01    [W:0.056 / U:9.656 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site