linux-input.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
To: Reyad Attiyat
	<reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	linux-iio-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	srinivas.pandruvada-VuQAYsv1563Yd54FQh9/CA@public.gmane.org,
	linux-input-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	jkosina-AlSwsSmVLrQ@public.gmane.org
Subject: Re: [PATCHv2 1/3] IIO: Documentation: Add north attribute to ABI docs
Date: Mon, 09 Jun 2014 18:50:51 +0100	[thread overview]
Message-ID: <5395F3FB.6020204@kernel.org> (raw)
In-Reply-To: <1401750890-31854-2-git-send-email-reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>

On 03/06/14 00:14, Reyad Attiyat wrote:
> Updated ABI documentation to inculde compass north usages.
>
> Signed-off-by: Reyad Attiyat <reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
Amazing how many lines of documentation two small additions can make!

Anyhow, I'm keener on having these as as modifiers on a rotation rather than
there own type.

in_rot_from_north_magnetic_raw and friends (as per your suggestion elsewhere).

Otherwise, whilst obvious, perhaps a line or two in the main _raw attribute
description to state the obvious and say what this is...


J

> ---
>   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..251c2bb 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
> +What:		/sys/bus/iio/devices/iio:deviceX/in_north_magnetic_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/in_north_true_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/in_north_magnetic_tilt_comp_raw
> +What:		/sys/bus/iio/devices/iio:deviceX/in_north_true_tilt_comp_raw
>   KernelVersion:	2.6.35
>   Contact:	linux-iio-u79uwXL29TY76Z2rM5mHXA@public.gmane.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_north_magnetic_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_north_true_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_north_magnetic_tilt_comp_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_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_north_magnetic_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_north_magnetic_thresh_falling_en
> +What:		/sys/.../iio:deviceX/events/in_north_true_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_north_true_thresh_falling_en
> +What:		/sys/.../iio:deviceX/events/in_north_magnetic_tilt_comp_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_north_magnetic_tilt_comp_thresh_falling_en
> +What:		/sys/.../iio:deviceX/events/in_north_true_tilt_comp_thresh_rising_en
> +What:		/sys/.../iio:deviceX/events/in_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_north_magnetic_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_north_magnetic_roc_falling_en
> +What:		/sys/.../iio:deviceX/events/in_north_true_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_north_true_roc_falling_en
> +What:		/sys/.../iio:deviceX/events/in_north_magnetic_tilt_comp_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_north_magnetic_tilt_comp_roc_falling_en
> +What:		/sys/.../iio:deviceX/events/in_north_true_tilt_comp_roc_rising_en
> +What:		/sys/.../iio:deviceX/events/in_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_north_magnetic_raw_thresh_rising_value
> +What:		/sys/.../events/in_north_magnetic_raw_thresh_falling_value
> +What:		/sys/.../events/in_north_true_raw_thresh_rising_value
> +What:		/sys/.../events/in_north_true_raw_thresh_falling_value
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_raw_thresh_rising_value
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_raw_thresh_falling_value
> +What:		/sys/.../events/in_north_true_tilt_comp_raw_thresh_rising_value
> +What:		/sys/.../events/in_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_north_magnetic_thresh_rising_hysteresis
> +What:		/sys/.../events/in_north_magnetic_thresh_falling_hysteresis
> +What:		/sys/.../events/in_north_magnetic_thresh_either_hysteresis
> +What:		/sys/.../events/in_north_true_thresh_rising_hysteresis
> +What:		/sys/.../events/in_north_true_thresh_falling_hysteresis
> +What:		/sys/.../events/in_north_true_thresh_either_hysteresis
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_thresh_rising_hysteresis
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_thresh_falling_hysteresis
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_thresh_either_hysteresis
> +What:		/sys/.../events/in_north_true_tilt_comp_thresh_rising_hysteresis
> +What:		/sys/.../events/in_north_true_tilt_comp_thresh_falling_hysteresis
> +What:		/sys/.../events/in_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_north_magnetic_raw_roc_rising_value
> +What:		/sys/.../events/in_north_magnetic_raw_roc_falling_value
> +What:		/sys/.../events/in_north_true_raw_roc_rising_value
> +What:		/sys/.../events/in_north_true_raw_roc_falling_value
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_raw_roc_rising_value
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_raw_roc_falling_value
> +What:		/sys/.../events/in_north_true_tilt_comp_raw_roc_rising_value
> +What:		/sys/.../events/in_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_north_magnetic_thresh_rising_period
> +What:		/sys/.../events/in_north_magnetic_thresh_falling_period
> +What:		/sys/.../events/in_north_magnetic_roc_rising_period
> +What:		/sys/.../events/in_north_magnetic_roc_falling_period
> +What:		/sys/.../events/in_north_true_thresh_rising_period
> +What:		/sys/.../events/in_north_true_thresh_falling_period
> +What:		/sys/.../events/in_north_true_roc_rising_period
> +What:		/sys/.../events/in_north_true_roc_falling_period
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_thresh_rising_period
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_thresh_falling_period
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_roc_rising_period
> +What:		/sys/.../events/in_north_magnetic_tilt_comp_roc_falling_period
> +What:		/sys/.../events/in_north_true_tilt_comp_thresh_rising_period
> +What:		/sys/.../events/in_north_true_tilt_comp_thresh_falling_period
> +What:		/sys/.../events/in_north_true_tilt_comp_roc_rising_period
> +What:		/sys/.../events/in_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_north_magnetic_en
> +What:		/sys/.../iio:deviceX/scan_elements/in_north_true_en
> +What:		/sys/.../iio:deviceX/scan_elements/in_north_magnetic_tilt_comp_en
> +What:		/sys/.../iio:deviceX/scan_elements/in_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_north_magnetic_index
> +What:		/sys/.../iio:deviceX/scan_elements/in_north_true_index
> +What:		/sys/.../iio:deviceX/scan_elements/in_north_magnetic_tilt_comp_index
> +What:		/sys/.../iio:deviceX/scan_elements/in_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
>

  parent reply	other threads:[~2014-06-09 17:50 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-02 23:14 [PATCHv2 0/3] IIO: Add support for compass north usage attribute Reyad Attiyat
     [not found] ` <1401750890-31854-1-git-send-email-reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-06-02 23:14   ` [PATCHv2 1/3] IIO: Documentation: Add north attribute to ABI docs Reyad Attiyat
     [not found]     ` <1401750890-31854-2-git-send-email-reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-06-09 17:50       ` Jonathan Cameron [this message]
2014-06-02 23:14   ` [PATCHv2 2/3] IIO: Add iio_chan modifier for True/Magnetic North HID usages Reyad Attiyat
2014-06-09 17:51     ` Jonathan Cameron
     [not found]       ` <5395F424.4070407-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
2014-06-09 17:52         ` Jonathan Cameron
2014-06-02 23:14 ` [PATCHv2 3/3] IIO: hid-sensor-magn-3d: Add in support " Reyad Attiyat
     [not found]   ` <1401750890-31854-4-git-send-email-reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2014-06-03 17:43     ` Srinivas Pandruvada
     [not found]       ` <538E092F.9040004-VuQAYsv1563Yd54FQh9/CA@public.gmane.org>
2014-06-04 15:23         ` Reyad Attiyat
2014-06-04 15:42           ` Srinivas Pandruvada
2014-06-09 17:47             ` Jonathan Cameron
2014-06-09 17:43         ` Jonathan Cameron
2014-06-09 19:55     ` 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=5395F3FB.6020204@kernel.org \
    --to=jic23-dgejt+ai2ygdnm+yrofe0a@public.gmane.org \
    --cc=jkosina-AlSwsSmVLrQ@public.gmane.org \
    --cc=linux-iio-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-input-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=reyad.attiyat-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    --cc=srinivas.pandruvada-VuQAYsv1563Yd54FQh9/CA@public.gmane.org \
    /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).