linux-kernel - Re: [PATCH v3 3/3] iio:Documentation: Add documentation for hinge sensor channels

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20201207091818.GA23419@host>
Date:   Mon, 7 Dec 2020 17:18:18 +0800
From:   "Ye, Xiang" <xiang.ye@...el.com>
To:     Jonathan Cameron <jic23@...nel.org>
Cc:     jikos@...nel.org, srinivas.pandruvada@...ux.intel.com,
        linux-input@...r.kernel.org, linux-iio@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 3/3] iio:Documentation: Add documentation for hinge
 sensor channels

Hi Jonathan

Thanks for review and comments.

On Sat, Dec 05, 2020 at 04:05:40PM +0000, Jonathan Cameron wrote:
> On Thu,  3 Dec 2020 11:53:52 +0800
> Ye Xiang <xiang.ye@...el.com> wrote:
> 
> > Add channel description for hinge sensor, including channel label
> > attribute and raw data description.
> > 
> > Signed-off-by: Ye Xiang <xiang.ye@...el.com>
> > ---
> >  Documentation/ABI/testing/sysfs-bus-iio | 17 +++++++++++++++++
> >  1 file changed, 17 insertions(+)
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> > index df42bed09f25..82303b1bdff0 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-iio
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio
> > @@ -1802,3 +1802,20 @@ Contact:	linux-iio@...r.kernel.org
> >  Description:
> >  		Unscaled light intensity according to CIE 1931/DIN 5033 color space.
> >  		Units after application of scale are nano nanowatts per square meter.
> > +
> > +What:		/sys/bus/iio/devices/iio:deviceX/in_anglY_raw
> > +KernelVersion:	5.12
> > +Contact:	linux-iio@...r.kernel.org
> > +Description:
> > +		Angle of rotation for channel Y. Units after application of scale
> > +		and offset are radians.
> 
> This entry is already mostly in the doc around line 200, just without the index.
> Please just add the What: line to that block to reduce repetition.
> If you want to add... "Where present, Y indexes the channel." or something like
> that feel free.
When adding in_anglY_raw to in_angl_raw block, Should I update the KernelVersion form
4.17 to 5.12? Like blow:

What:		/sys/bus/iio/devices/iio:deviceX/in_angl_raw
What:		/sys/bus/iio/devices/iio:deviceX/in_anglY_raw
KernelVersion:	5.12
Contact:	linux-iio@...r.kernel.org
Description:
		Angle of rotation. Units after application of scale and offset
		are radians. Where present, Y indexes the channel.

> 
> 
> > +
> > +What:		/sys/bus/iio/devices/iio:deviceX/in_anglY_label
> > +KernelVersion:	5.12
> > +Contact:	linux-iio@...r.kernel.org
> > +Description:
> > +		Optional symbolic label for channel Y.
> > +		For Intel hid hinge sensor, the label values are:
> > +		hinge, keyboard, screen. It means the three channels
> > +		each correspond respectively to hinge angle, keyboard angle,
> > +		and screen angle.
> 
> Makes sense to keep this block separate given the additional info provided.
> Alternative would be to add it to the one with in_voltageY_label which would
> be odd given what follows!
Ok, Then I will keep the in_anglY_label block here. BTW, I didnot see in_voltageY_label
in sysfs-bus-iio in current kernel master branch.

> 
> Thanks,
> 
> Jonathan
> 
Thanks
Ye, Xiang
>