linux-kernel - Re: [PATCH v5 2/3] Documentation: ABI: added filter mode doc in sysfs-bus-iio

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

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZuR4IE-mwhL27ZG0@smile.fi.intel.com>
Date: Fri, 13 Sep 2024 20:36:32 +0300
From: Andy Shevchenko <andy.shevchenko@...il.com>
To: "Nechita, Ramona" <Ramona.Nechita@...log.com>
Cc: Jonathan Cameron <jic23@...nel.org>,
	Lars-Peter Clausen <lars@...afoo.de>,
	"Tanislav, Cosmin" <Cosmin.Tanislav@...log.com>,
	"Hennerich, Michael" <Michael.Hennerich@...log.com>,
	Rob Herring <robh@...nel.org>,
	Krzysztof Kozlowski <krzk+dt@...nel.org>,
	Conor Dooley <conor+dt@...nel.org>, "Sa, Nuno" <Nuno.Sa@...log.com>,
	David Lechner <dlechner@...libre.com>,
	"Schmitt, Marcelo" <Marcelo.Schmitt@...log.com>,
	Olivier Moysan <olivier.moysan@...s.st.com>,
	Dumitru Ceclan <mitrutzceclan@...il.com>,
	Matteo Martelli <matteomartelli3@...il.com>,
	João Paulo Gonçalves <joao.goncalves@...adex.com>,
	Alisa-Dariana Roman <alisadariana@...il.com>,
	Mike Looijmans <mike.looijmans@...ic.nl>,
	"linux-iio@...r.kernel.org" <linux-iio@...r.kernel.org>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	"devicetree@...r.kernel.org" <devicetree@...r.kernel.org>
Subject: Re: [PATCH v5 2/3] Documentation: ABI: added filter mode doc in
 sysfs-bus-iio

On Fri, Sep 13, 2024 at 02:06:48PM +0000, Nechita, Ramona wrote:
> >>
> >> The filter mode / filter type property is used for ad4130 and ad7779
> >> drivers, therefore the ABI doc file for ad4130 was removed, merging
> >> both of them in the sysfs-bus-iio.

...

> >> +What:          /sys/bus/iio/devices/iio:deviceX/filter_type_available
> >> +What:          /sys/bus/iio/devices/iio:deviceX/in_voltage-voltage_filter_mode_available
> >> +KernelVersion: 6.1
> >
> >I believe I have already commented on this. The commit message keeps silent about version changes. Why?
> 
> I mentioned it in the cover-letter, since the attributes of two devices were
> merged, and one of them was available in 6.1 ad the other in 6.2, it felt
> appropriate to leave it as 6.1.
> I was wondering if this is ok or if it should be kept as 6.2. Should this be
> mentioned in the commit message as well?

Please, mention in the commit message.

> >> +Contact:       linux-iio@...r.kernel.org
> >> +Description:
> >> +               Reading returns a list with the possible filter modes. Options
> >> +               for the attribute:
> >> +                       * "sinc3"       - The digital sinc3 filter. Moderate 1st conversion time.
> >> +                   Good noise performance.
> >> +                       * "sinc4"       - Sinc 4. Excellent noise performance. Long
> >> +                       1st conversion time.
> >> +                       * "sinc5"       - The digital sinc5 filter. Excellent noise performance
> >> +                       * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion
> >> +                   time.
> >> +                       * "sinc3+rej60" - Sinc3 + 60Hz rejection.
> >> +                       * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion
> >> +                   time.
> >> +                       * "sinc3+pf1"   - Sinc3 + device specific Post Filter 1.
> >> +                       * "sinc3+pf2"   - Sinc3 + device specific Post Filter 2.
> >> +                       * "sinc3+pf3"   - Sinc3 + device specific Post Filter 3.
> >> +                       * "sinc3+pf4"   - Sinc3 + device specific Post Filter 4.
> >
> >Also, the original file was more verbose for the complex cases, like
> >"sinc3+pfX", why has this been changed?
> 
> Since this is a more generic file I was advised to leave out specific
> details, should I include them just as they were in the original file?

I would leave the examples for the mentioned chip in the parentheses. But it's
up to Jonathan, I have no such device anyway, so personally I'm not affected
:-)

-- 
With Best Regards,
Andy Shevchenko