From: Jonathan Cameron <jic23@kernel.org>
To: Lars-Peter Clausen <lars@metafoo.de>
Cc: linux-iio@vger.kernel.org, linux-doc@vger.kernel.org,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Jonathan Cameron <Jonathan.Cameron@huawei.com>,
Fabrice Gasnier <fabrice.gasnier@st.com>
Subject: Re: [RFC PATCH 2/7] iio:ABI docs: Avoid repitition of triggerX/sampling_frequency
Date: Sun, 7 Mar 2021 12:04:51 +0000 [thread overview]
Message-ID: <20210307120451.79e538fc@archlinux> (raw)
In-Reply-To: <c6fb25c0-1292-f5fa-c5c9-8e47d1061874@metafoo.de>
On Sun, 7 Mar 2021 10:40:18 +0100
Lars-Peter Clausen <lars@metafoo.de> wrote:
> On 1/17/21 4:38 PM, Jonathan Cameron wrote:
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> >
> > The timer-stm32 provided a little more specific information than the main
> > docs about the value of 0 corresponding to stopping sampling. Given that
> > this makes sense in general, move that statement over to the main docs
> > and drop the version in sysfs-bus-iio-timer-stm32
> >
> > Fixes
> > $ scripts/get_abi.pl validate
> > /sys/bus/iio/devices/triggerX/sampling_frequency is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:92 ./Documentation/ABI/testing/sysfs-bus-iio:45
> >
> > Cc: Fabrice Gasnier <fabrice.gasnier@st.com>
> > Reported-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > ---
> > Documentation/ABI/testing/sysfs-bus-iio | 2 ++
> > Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 | 8 --------
> > 2 files changed, 2 insertions(+), 8 deletions(-)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> > index d2dd9cc280f9..9b5ceb22363d 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-iio
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio
> > @@ -55,6 +55,8 @@ Description:
> > direct access interfaces, it may be found in any of the
> > relevant directories. If it affects all of the above
> > then it is to be found in the base device directory.
> > + Note a value 0 where supported, will correspond to sampling
> > + stopping.
>
> Hm, I don't like this. 0 should be an invalid value for the standard
> ABI. Enabling/disabling of the trigger should be controlled by whether
> there are any active trigger consumers.
>
> The stm32-timer-trigger implements a non-standard ABI and I think we
> need to document this explicitly. The driver does not have a set_state
> callback. So the frequency property is used to enable/disable the
> trigger, but as said above, for standard compliant triggers that should
> not be the case.
>
Good point. Ideally we'd also fix the stm32-timer-trigger to have
an explicit enable / disable (even if that works by setting the frequency
to 0 under the hook)
For now I've dropped the patch until this is resolved.
Thanks,
Jonathan
next prev parent reply other threads:[~2021-03-07 12:05 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-17 15:38 [RFC PATCH 0/7] IIO ABI documentation duplication fixes Jonathan Cameron
2021-01-17 15:38 ` [RFC PATCH 1/7] iio:ABI docs: Fix up duplicate *_calibbias_* documentation for icm42600 Jonathan Cameron
2021-02-21 16:05 ` Jonathan Cameron
2021-04-27 17:30 ` Jonathan Cameron
2021-01-17 15:38 ` [RFC PATCH 2/7] iio:ABI docs: Avoid repitition of triggerX/sampling_frequency Jonathan Cameron
2021-01-18 9:02 ` Fabrice Gasnier
2021-03-07 9:40 ` Lars-Peter Clausen
2021-03-07 12:04 ` Jonathan Cameron [this message]
2021-03-12 16:56 ` Fabrice Gasnier
2021-03-15 10:12 ` Jonathan Cameron
2021-01-17 15:38 ` [RFC PATCH 3/7] iio:ABI docs: Drop device specific docs for _powerdown for the adf4371 Jonathan Cameron
2021-04-27 17:33 ` Jonathan Cameron
2021-01-17 15:38 ` [RFC PATCH 4/7] iio:ABI docs: Fix issue around repeated definition of out_currentY_raw Jonathan Cameron
2021-04-27 17:35 ` Jonathan Cameron
2021-01-17 15:38 ` [RFC PATCH 5/7] iio:ABI docs: Combine sysfs-bus-iio-humidity-hdc2010/hdc100x into one file Jonathan Cameron
2021-01-17 23:12 ` Matt Ranostay
2021-02-21 16:08 ` Jonathan Cameron
2021-01-17 15:38 ` [RFC PATCH 6/7] iio:ABI docs: Combine the two instances of docs for sensor_sensitivity Jonathan Cameron
2021-01-17 23:11 ` Matt Ranostay
2021-01-17 15:38 ` [RFC PATCH 7/7] iio:ABI docs: Move specific description of out_altvoltageX_frequency to main docs Jonathan Cameron
2021-04-27 17:37 ` Jonathan Cameron
2021-02-21 16:12 ` [RFC PATCH 0/7] IIO ABI documentation duplication fixes 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=20210307120451.79e538fc@archlinux \
--to=jic23@kernel.org \
--cc=Jonathan.Cameron@huawei.com \
--cc=fabrice.gasnier@st.com \
--cc=lars@metafoo.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=mchehab+huawei@kernel.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).