From: Jonathan Cameron <jic23@kernel.org>
To: Reyad Attiyat <reyad.attiyat@gmail.com>,
linux-kernel@vger.kernel.org, linux-iio@vger.kernel.org,
srinivas.pandruvada@linux.intel.com
Subject: Re: [PATCH v3 1/3] iio: documentation: Added documentation for rotation from north usage attributes
Date: Sat, 21 Jun 2014 11:57:07 +0100 [thread overview]
Message-ID: <53A56503.4000803@kernel.org> (raw)
In-Reply-To: <1402957803-5154-2-git-send-email-reyad.attiyat@gmail.com>
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.
next prev parent reply other threads:[~2014-06-21 10:55 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-06-16 22:30 [PATCH v3 0/3] IIO: Add support for rotation from north usage attributes Reyad Attiyat
2014-06-16 22:30 ` [PATCH v3 1/3] iio: documentation: Added documentation " Reyad Attiyat
2014-06-21 10:57 ` Jonathan Cameron [this message]
2014-06-16 22:30 ` [PATCH v3 2/3] iio: types: Added support " Reyad Attiyat
2014-06-16 22:30 ` [PATCH v3 3/3] iio: hid-sensor-magn-3d: Add " Reyad Attiyat
2014-06-21 11:19 ` Jonathan Cameron
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=53A56503.4000803@kernel.org \
--to=jic23@kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=reyad.attiyat@gmail.com \
--cc=srinivas.pandruvada@linux.intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.