| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <20201108165621.4d0da3f4@archlinux>
Date: Sun, 8 Nov 2020 16:56:21 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Fabrice Gasnier <fabrice.gasnier@...com>,
Linux Doc Mailing List <linux-doc@...r.kernel.org>,
"Gautham R. Shenoy" <ego@...ux.vnet.ibm.com>,
"Jason A. Donenfeld" <Jason@...c4.com>,
Javier González <javier@...igon.com>,
Jonathan Corbet <corbet@....net>,
"Martin K. Petersen" <martin.petersen@...cle.com>,
"Rafael J. Wysocki" <rjw@...ysocki.net>,
Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
Alexandre Belloni <alexandre.belloni@...tlin.com>,
Alexandre Torgue <alexandre.torgue@...com>,
Andrew Donnellan <ajd@...ux.ibm.com>,
Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
Baolin Wang <baolin.wang7@...il.com>,
Benson Leung <bleung@...omium.org>,
Boris Ostrovsky <boris.ostrovsky@...cle.com>,
Bruno Meneguele <bmeneg@...hat.com>,
Chunyan Zhang <zhang.lyra@...il.com>,
Dan Murphy <dmurphy@...com>,
Dan Williams <dan.j.williams@...el.com>,
Enric Balletbo i Serra <enric.balletbo@...labora.com>,
Felipe Balbi <balbi@...nel.org>,
Frederic Barrat <fbarrat@...ux.ibm.com>,
Guenter Roeck <groeck@...omium.org>,
Hanjun Guo <guohanjun@...wei.com>,
Heikki Krogerus <heikki.krogerus@...ux.intel.com>,
Jens Axboe <axboe@...nel.dk>,
Johannes Thumshirn <johannes.thumshirn@....com>,
Juergen Gross <jgross@...e.com>,
Konstantin Khlebnikov <koct9i@...il.com>,
Kranthi Kuntala <kranthi.kuntala@...el.com>,
Lakshmi Ramasubramanian <nramas@...ux.microsoft.com>,
Lars-Peter Clausen <lars@...afoo.de>,
Len Brown <lenb@...nel.org>,
Leonid Maksymchuk <leonmaxx@...il.com>,
Ludovic Desroches <ludovic.desroches@...rochip.com>,
Mario Limonciello <mario.limonciello@...l.com>,
Mark Gross <mgross@...ux.intel.com>,
Maxime Coquelin <mcoquelin.stm32@...il.com>,
Michael Ellerman <mpe@...erman.id.au>,
Mika Westerberg <mika.westerberg@...ux.intel.com>,
Mike Kravetz <mike.kravetz@...cle.com>,
Mimi Zohar <zohar@...ux.ibm.com>,
Nayna Jain <nayna@...ux.ibm.com>,
Nicolas Ferre <nicolas.ferre@...rochip.com>,
Niklas Cassel <niklas.cassel@....com>,
Oded Gabbay <oded.gabbay@...il.com>,
Oleh Kravchenko <oleg@....org.ua>,
Orson Zhai <orsonzhai@...il.com>, Pavel Machek <pavel@....cz>,
Pawan Gupta <pawan.kumar.gupta@...ux.intel.com>,
Peter Meerwald-Stadler <pmeerw@...erw.net>,
Peter Rosin <peda@...ntia.se>, Petr Mladek <pmladek@...e.com>,
Philippe Bergheaud <felix@...ux.ibm.com>,
Richard Cochran <richardcochran@...il.com>,
Sebastian Reichel <sre@...nel.org>,
Sergey Senozhatsky <sergey.senozhatsky@...il.com>,
Stefano Stabellini <sstabellini@...nel.org>,
Thinh Nguyen <Thinh.Nguyen@...opsys.com>,
Thomas Gleixner <tglx@...utronix.de>,
Tom Rix <trix@...hat.com>,
Vaibhav Jain <vaibhav@...ux.ibm.com>,
Vineela Tummalapalli <vineela.tummalapalli@...el.com>,
Vishal Verma <vishal.l.verma@...el.com>,
linux-acpi@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
linux-mm@...ck.org, linux-pm@...r.kernel.org,
linux-stm32@...md-mailman.stormreply.com,
linux-usb@...r.kernel.org, linuxppc-dev@...ts.ozlabs.org,
netdev@...r.kernel.org, xen-devel@...ts.xenproject.org,
Jonathan Cameron <Jonathan.Cameron@...wei.com>
Subject: Re: [PATCH v2 20/39] docs: ABI: testing: make the files compatible
with ReST output
On Mon, 2 Nov 2020 15:42:50 +0100
Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:
> Em Mon, 2 Nov 2020 13:46:41 +0100
> Greg Kroah-Hartman <gregkh@...uxfoundation.org> escreveu:
>
> > On Mon, Nov 02, 2020 at 12:04:36PM +0100, Fabrice Gasnier wrote:
> > > On 10/30/20 11:09 AM, Mauro Carvalho Chehab wrote:
> > > > Em Fri, 30 Oct 2020 10:19:12 +0100
> > > > Fabrice Gasnier <fabrice.gasnier@...com> escreveu:
> > > >
> > > >> Hi Mauro,
> > > >>
> > > >> [...]
> > > >>
> > > >>>
> > > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> > > >>> +KernelVersion: 4.12
> > > >>> +Contact: benjamin.gaignard@...com
> > > >>> +Description:
> > > >>> + Reading returns the list possible quadrature modes.
> > > >>> +
> > > >>> +What: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> > > >>> +KernelVersion: 4.12
> > > >>> +Contact: benjamin.gaignard@...com
> > > >>> +Description:
> > > >>> + Configure the device counter quadrature modes:
> > > >>> +
> > > >>> + channel_A:
> > > >>> + Encoder A input servers as the count input and B as
> > > >>> + the UP/DOWN direction control input.
> > > >>> +
> > > >>> + channel_B:
> > > >>> + Encoder B input serves as the count input and A as
> > > >>> + the UP/DOWN direction control input.
> > > >>> +
> > > >>> + quadrature:
> > > >>> + Encoder A and B inputs are mixed to get direction
> > > >>> + and count with a scale of 0.25.
> > > >>> +
> > > >>
> > > >
> > > > Hi Fabrice,
> > > >
> > > >> I just noticed that since Jonathan question in v1.
> > > >>
> > > >> Above ABI has been moved in the past as discussed in [1]. You can take a
> > > >> look at:
> > > >> b299d00 IIO: stm32: Remove quadrature related functions from trigger driver
> > > >>
> > > >> Could you please remove the above chunk ?
> > > >>
> > > >> With that, for the stm32 part:
> > > >> Acked-by: Fabrice Gasnier <fabrice.gasnier@...com>
> > > >
> > > >
> > > > Hmm... probably those were re-introduced due to a rebase. This
> > > > series were originally written about 1,5 years ago.
> > > >
> > > > I'll drop those hunks.
> > >
> > > Hi Mauro, Greg,
> > >
> > > I just figured out this patch has been applied with above hunk.
> > >
> > > This should be dropped: is there a fix on its way already ?
> > > (I may have missed it)
> >
> > Can you send a fix for just this hunk?
>
> Hmm...
>
> $ git grep /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:What: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
>
> Even re-doing the changes from
> changeset b299d00420e2 ("IIO: stm32: Remove quadrature related functions from trigger driver")
> at Documentation/ABI/testing/sysfs-bus-iio-timer-stm32, there's still
> a third duplicate of some of those, as reported by the script:
>
> $ ./scripts/get_abi.pl validate 2>&1|grep quadra
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
>
> As in_count_quadrature_mode_available is also defined at:
> Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2
>
> The best here seems to have a patch that will also drop the other
> duplication of this, probably moving in_count_quadrature_mode_available
> to a generic node probably placing it inside
> Documentation/ABI/testing/sysfs-bus-iio.
In this particular case it may be valid to do that, but it's not in
general without loosing information - see below.
>
> Comments?
>
> Thanks,
> Mauro
>
> PS.: the IIO subsystem is the one that currently has more duplicated
> ABI entries:
That was intentional. Often these provide more information on the
ABI for a particular device than is present in the base ABI doc.
A bit like when we have additional description for dt binding properties
for a particular device, even though they are standard properties.
Often a standard property allows for more values than the specific
one for a particular device. There can also be obscuring coupling
between sysfs attributes due to hardware restrictions that we would
like to provide some explanatory info on.
I suppose we could add all this information to the parent doc but
that is pretty ugly and will make that doc very nasty to read.
Jonathan
>
> $ ./scripts/get_abi.pl validate 2>&1|grep iio
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:0 Documentation/ABI/testing/sysfs-bus-iio:394
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:1 Documentation/ABI/testing/sysfs-bus-iio:395
> Warning: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:2 Documentation/ABI/testing/sysfs-bus-iio:396
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:3 Documentation/ABI/testing/sysfs-bus-iio:397
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:4 Documentation/ABI/testing/sysfs-bus-iio:398
> Warning: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-icm42600:5 Documentation/ABI/testing/sysfs-bus-iio:399
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_preset is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:100 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:0
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:117 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:14
> Warning: /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available is defined 3 times: Documentation/ABI/testing/sysfs-bus-iio-counter-104-quad-8:2 Documentation/ABI/testing/sysfs-bus-iio-timer-stm32:111 Documentation/ABI/testing/sysfs-bus-iio-lptimer-stm32:8
> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:0 Documentation/ABI/testing/sysfs-bus-iio:599
> Warning: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_powerdown is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4371:36 Documentation/ABI/testing/sysfs-bus-iio:588
> Warning: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als:43 Documentation/ABI/testing/sysfs-bus-iio-health-afe440x:38
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:0 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:0
> Warning: /sys/bus/iio/devices/iio:deviceX/out_current_heater_raw_available is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc2010:1 Documentation/ABI/testing/sysfs-bus-iio-humidity-hdc100x:1
> Warning: /sys/bus/iio/devices/iio:deviceX/sensor_sensitivity is defined 2 times: Documentation/ABI/testing/sysfs-bus-iio-distance-srf08:0 Documentation/ABI/testing/sysfs-bus-iio-proximity-as3935:8
> Warning: /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
Powered by blists - more mailing lists