linux-input.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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, linux-input@vger.kernel.org,
	jkosina@suse.cz
Subject: Re: [PATCH 1/3] IIO: Add iio magn_north ABI documentation
Date: Thu, 29 May 2014 17:46:47 +0100	[thread overview]
Message-ID: <53876477.7000503@kernel.org> (raw)
In-Reply-To: <1401311175-12784-2-git-send-email-reyad.attiyat@gmail.com>

On 28/05/14 22:06, Reyad Attiyat wrote:
> Update documentation for HID compass true/magnetic north sensor.
>
> Signed-off-by: Reyad Attiyat <reyad.attiyat@gmail.com>
> ---
>   Documentation/ABI/testing/sysfs-bus-iio | 76 +++++++++++++++++++++++++++++++++
>   1 file changed, 76 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 6e02c50..0341b2f 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -165,6 +165,10 @@ Description:
>   What:		/sys/bus/iio/devices/iio:deviceX/in_magn_x_raw
>   What:		/sys/bus/iio/devices/iio:deviceX/in_magn_y_raw
>   What:		/sys/bus/iio/devices/iio:deviceX/in_magn_z_raw
Hmm. The question to my mind is whether people would expect a simple north to give
them which direction north is?
Also is it actually relevant whether they find north from a magnetometer or some other method?
I wonder if we want to make these some sort of north referenced rotation?
in_rot_from_true_north_raw
in_rot_from_magnetic_north_raw

Technically it is possible to get some direction information from some GPS receivers or to
to maintain a knowledge of its location with good gyroscopes.

Ultimately userspace doesn't care about it.  When we were using the axial magnetic functions we
were measuring the field magnitude in that direction. As I understand it here it is just an angle?

J
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_north_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_north_true_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_north_tilt_comp_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_north_true_tilt_comp_raw
>   KernelVersion:	2.6.35
>   Contact:	linux-iio@vger.kernel.org
>   Description:
> @@ -249,6 +253,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_magn_north_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_north_true_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_north_tilt_comp_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_magn_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
> @@ -436,6 +444,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_magn_north_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_thresh_falling_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_true_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_true_thresh_falling_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_tilt_comp_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_tilt_comp_thresh_falling_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_true_tilt_comp_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_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
> @@ -481,6 +497,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_magn_north_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_roc_falling_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_true_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_true_roc_falling_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_tilt_comp_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_tilt_comp_roc_falling_en
> +What:		/sys/.../iio:deviceX/events/in_magn_north_true_tilt_comp_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_magn_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
> @@ -527,6 +551,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_magn_north_raw_thresh_rising_value
> +What:		/sys/.../events/in_magn_north_raw_thresh_falling_value
> +What:		/sys/.../events/in_magn_north_true_raw_thresh_rising_value
> +What:		/sys/.../events/in_magn_north_true_raw_thresh_falling_value
> +What:		/sys/.../events/in_magn_north_tilt_comp_raw_thresh_rising_value
> +What:		/sys/.../events/in_magn_north_tilt_comp_raw_thresh_falling_value
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_raw_thresh_rising_value
> +What:		/sys/.../events/in_magn_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
> @@ -577,6 +609,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_magn_north_thresh_rising_hysteresis
> +What:		/sys/.../events/in_magn_north_thresh_falling_hysteresis
> +What:		/sys/.../events/in_magn_north_thresh_either_hysteresis
> +What:		/sys/.../events/in_magn_north_true_thresh_rising_hysteresis
> +What:		/sys/.../events/in_magn_north_true_thresh_falling_hysteresis
> +What:		/sys/.../events/in_magn_north_true_thresh_either_hysteresis
> +What:		/sys/.../events/in_magn_north_tilt_comp_thresh_rising_hysteresis
> +What:		/sys/.../events/in_magn_north_tilt_comp_thresh_falling_hysteresis
> +What:		/sys/.../events/in_magn_north_tilt_comp_thresh_either_hysteresis
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_thresh_rising_hysteresis
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_thresh_falling_hysteresis
> +What:		/sys/.../events/in_magn_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
> @@ -624,6 +668,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_magn_north_raw_roc_rising_value
> +What:		/sys/.../events/in_magn_north_raw_roc_falling_value
> +What:		/sys/.../events/in_magn_north_true_raw_roc_rising_value
> +What:		/sys/.../events/in_magn_north_true_raw_roc_falling_value
> +What:		/sys/.../events/in_magn_north_tilt_comp_raw_roc_rising_value
> +What:		/sys/.../events/in_magn_north_tilt_comp_raw_roc_falling_value
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_raw_roc_rising_value
> +What:		/sys/.../events/in_magn_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
> @@ -679,6 +731,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_magn_north_thresh_rising_period
> +What:		/sys/.../events/in_magn_north_thresh_falling_period
> +What:		/sys/.../events/in_magn_north_roc_rising_period
> +What:		/sys/.../events/in_magn_north_roc_falling_period
> +What:		/sys/.../events/in_magn_north_true_thresh_rising_period
> +What:		/sys/.../events/in_magn_north_true_thresh_falling_period
> +What:		/sys/.../events/in_magn_north_true_roc_rising_period
> +What:		/sys/.../events/in_magn_north_true_roc_falling_period
> +What:		/sys/.../events/in_magn_north_tilt_comp_thresh_rising_period
> +What:		/sys/.../events/in_magn_north_tilt_comp_thresh_falling_period
> +What:		/sys/.../events/in_magn_north_tilt_comp_roc_rising_period
> +What:		/sys/.../events/in_magn_north_tilt_comp_roc_falling_period
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_thresh_rising_period
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_thresh_falling_period
> +What:		/sys/.../events/in_magn_north_true_tilt_comp_roc_rising_period
> +What:		/sys/.../events/in_magn_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
> @@ -776,6 +844,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_magn_north_en
> +What:		/sys/.../iio:deviceX/scan_elements/in_magn_north_true_en
> +What:		/sys/.../iio:deviceX/scan_elements/in_magn_north_tilt_comp_en
> +What:		/sys/.../iio:deviceX/scan_elements/in_magn_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
> @@ -840,6 +912,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_magn_north_index
> +What:		/sys/.../iio:deviceX/scan_elements/in_magn_north_true_index
> +What:		/sys/.../iio:deviceX/scan_elements/in_magn_north_tilt_comp_index
> +What:		/sys/.../iio:deviceX/scan_elements/in_magn_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
>

  reply	other threads:[~2014-05-29 16:46 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-05-28 21:06 [PATCH 0/3] IIO: hid-sensor-magn-3d: Add support for compass north usage attribute Reyad Attiyat
2014-05-28 21:06 ` [PATCH 1/3] IIO: Add iio magn_north ABI documentation Reyad Attiyat
2014-05-29 16:46   ` Jonathan Cameron [this message]
     [not found]     ` <53876477.7000503-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2014-06-02 15:54       ` Srinivas Pandruvada
2014-05-28 21:06 ` [PATCH 2/3] IIO: Add iio_chan modifier for True/Magnetic North HID usages Reyad Attiyat
     [not found]   ` <1401311175-12784-3-git-send-email-reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-05-31 10:14     ` Jonathan Cameron
     [not found]       ` <5389AB89.9080305-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2014-06-02 19:54         ` Reyad Attiyat
2014-05-28 21:06 ` [PATCH 3/3] IO: hid-sensor-magn-3d: Add in support " Reyad Attiyat
2014-05-28 21:15   ` Reyad Attiyat
2014-05-28 21:25     ` Srinivas Pandruvada
2014-05-28 21:35       ` Reyad Attiyat
2014-05-28 21:56         ` Srinivas Pandruvada
     [not found]           ` <CA+BWVURydjyrnC9ec-POtn5A8gL7C93MH6pObcmmAqD4V=p0Zg@mail.gmail.com>
     [not found]             ` <CA+BWVURydjyrnC9ec-POtn5A8gL7C93MH6pObcmmAqD4V=p0Zg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2014-05-28 21:59               ` Fwd: " Reyad Attiyat

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=53876477.7000503@kernel.org \
    --to=jic23@kernel.org \
    --cc=jkosina@suse.cz \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-input@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).