mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: Andy Shevchenko <andriy.shevchenko@intel.com>
Cc: "Gustavo Silva" <gustavograzs@gmail.com>,
	"Alex Lanzano" <lanzano.alex@gmail.com>,
	"David Lechner" <dlechner@baylibre.com>,
	"Nuno Sá" <nuno.sa@analog.com>,
	"Andy Shevchenko" <andy@kernel.org>,
	linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v6 2/2] iio: ABI: document accelerometer event attributes
Date: Sat, 27 Sep 2025 16:51:00 +0100	[thread overview]
Message-ID: <20250927165100.5a9d3136@jic23-huawei> (raw)
In-Reply-To: <aMp1orvA-SSSZeN2@smile.fi.intel.com>

On Wed, 17 Sep 2025 11:47:30 +0300
Andy Shevchenko <andriy.shevchenko@intel.com> wrote:

> On Tue, Sep 16, 2025 at 08:38:24PM -0300, Gustavo Silva wrote:
> > Add ABI documentation for accelerometer event-related sysfs attributes
> > exposed by the bmi270 driver. These include threshold, period, and
> > enable controls for adaptive magnitude (any-motion) and rate of change
> > (no-motion) event detection.  
> 
> ...
> 
> > What:		/sys/.../iio:deviceX/events/in_accel_y_roc_rising_en  
> 
> >  What:		/sys/.../iio:deviceX/events/in_accel_y_roc_falling_en
> >  What:		/sys/.../iio:deviceX/events/in_accel_z_roc_rising_en
> >  What:		/sys/.../iio:deviceX/events/in_accel_z_roc_falling_en
> > +What:		/sys/.../iio:deviceX/events/in_accel_x&y&z_roc_rising_en
> >  What:		/sys/.../iio:deviceX/events/in_anglvel_x_roc_rising_en
> >  What:		/sys/.../iio:deviceX/events/in_anglvel_x_roc_falling_en
> >  What:		/sys/.../iio:deviceX/events/in_anglvel_y_roc_rising_en  
> 
> > What:		/sys/.../events/in_accel_y_raw_thresh_rising_value  
> 
> >  What:		/sys/.../events/in_accel_y_raw_thresh_falling_value
> >  What:		/sys/.../events/in_accel_z_raw_thresh_rising_value
> >  What:		/sys/.../events/in_accel_z_raw_thresh_falling_value
> > +What:		/sys/.../events/in_accel_mag_adaptive_rising_value
> >  What:		/sys/.../events/in_anglvel_x_raw_thresh_rising_value
> >  What:		/sys/.../events/in_anglvel_x_raw_thresh_falling_value
> >  What:		/sys/.../events/in_anglvel_y_raw_thresh_rising_value  
> 
> > +What:		/sys/.../events/in_accel_roc_rising_value
> >  What:		/sys/.../events/in_accel_x_raw_roc_rising_value
> >  What:		/sys/.../events/in_accel_x_raw_roc_falling_value
> >  What:		/sys/.../events/in_accel_y_raw_roc_rising_value  
> 
> >  What:		/sys/.../events/in_accel_x_thresh_rising_period
> >  What:		/sys/.../events/in_accel_x_thresh_falling_period
> > +What:		/sys/.../events/in_accel_roc_rising_period
> >  What:		/sys/.../events/in_accel_x_roc_rising_period
> >  What:		/sys/.../events/in_accel_x_roc_falling_period
> >  What:		/sys/.../events/in_accel_y_thresh_rising_period  
> 
> With the given context (above and below) I'm not sure this is the best place of
> putting an attribute in the list. Perhaps something below will not disrupt the
> xyz structure (like mag cases)?

I took a look at the broader context and it was a bit tricky but I think this
is the best we can do to maintain current ordering (which is fuzzily defined at best).

At some point that whole doc needs a rethink wrt to how we break the different blocks
up and order the elements within them.

With this change, series applied to the testing branch of iio.git.
That will be rebased on rc1 once available and then become the togreg branch.

thanks,

Jonathan



diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 89b4740dcfa1..352ab7b8476c 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -926,6 +926,7 @@ What:               /sys/.../iio:deviceX/events/in_accel_y_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_accel_y_roc_falling_en
 What:          /sys/.../iio:deviceX/events/in_accel_z_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_accel_z_roc_falling_en
+What:          /sys/.../iio:deviceX/events/in_accel_x&y&z_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_anglvel_x_roc_rising_en
 What:          /sys/.../iio:deviceX/events/in_anglvel_x_roc_falling_en
 What:          /sys/.../iio:deviceX/events/in_anglvel_y_roc_rising_en
@@ -1001,6 +1002,7 @@ Description:
                to the raw signal, allowing slow tracking to resume and the
                adaptive threshold event detection to function as expected.
 
+What:          /sys/.../events/in_accel_mag_adaptive_rising_value
 What:          /sys/.../events/in_accel_thresh_rising_value
 What:          /sys/.../events/in_accel_thresh_falling_value
 What:          /sys/.../events/in_accel_x_raw_thresh_rising_value
@@ -1147,6 +1149,7 @@ Description:
                will get activated once in_voltage0_raw goes above 1200 and will become
                deactivated again once the value falls below 1150.
 
+What:          /sys/.../events/in_accel_roc_rising_value
 What:          /sys/.../events/in_accel_x_raw_roc_rising_value
 What:          /sys/.../events/in_accel_x_raw_roc_falling_value
 What:          /sys/.../events/in_accel_y_raw_roc_rising_value
@@ -1193,6 +1196,8 @@ Description:
                value is in raw device units or in processed units (as _raw
                and _input do on sysfs direct channel read attributes).
 
+What:          /sys/.../events/in_accel_mag_adaptive_rising_period
+What:          /sys/.../events/in_accel_roc_rising_period
 What:          /sys/.../events/in_accel_x_thresh_rising_period
 What:          /sys/.../events/in_accel_x_thresh_falling_period
 What:          /sys/.../events/in_accel_x_roc_rising_period
@@ -1362,6 +1367,15 @@ Description:
                number or direction is not specified, applies to all channels of
                this type.
 
+What:          /sys/.../iio:deviceX/events/in_accel_x_mag_adaptive_rising_en

t

> 
> > What:		/sys/.../events/in_accel_z_thresh_rising_period  
> 
> >  What:		/sys/.../events/in_accel_z_thresh_falling_period
> >  What:		/sys/.../events/in_accel_z_roc_rising_period
> >  What:		/sys/.../events/in_accel_z_roc_falling_period
> > +What:		/sys/.../events/in_accel_mag_adaptive_rising_period
> >  What:		/sys/.../events/in_anglvel_x_thresh_rising_period
> >  What:		/sys/.../events/in_anglvel_x_thresh_falling_period
> >  What:		/sys/.../events/in_anglvel_x_roc_rising_period  
> 


      reply	other threads:[~2025-09-27 15:51 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-16 23:38 [PATCH v6 0/2] BMI270: Add support for step counter and motion events Gustavo Silva
2025-09-16 23:38 ` [PATCH v6 1/2] iio: imu: bmi270: add support for " Gustavo Silva
2025-09-16 23:38 ` [PATCH v6 2/2] iio: ABI: document accelerometer event attributes Gustavo Silva
2025-09-17  8:47   ` Andy Shevchenko
2025-09-27 15:51     ` Jonathan Cameron [this message]

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=20250927165100.5a9d3136@jic23-huawei \
    --to=jic23@kernel.org \
    --cc=andriy.shevchenko@intel.com \
    --cc=andy@kernel.org \
    --cc=dlechner@baylibre.com \
    --cc=gustavograzs@gmail.com \
    --cc=lanzano.alex@gmail.com \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nuno.sa@analog.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

all inboxes | Powered by JetHome®