diff mbox series

[v4,10/14] iio: document "serial_number" sysfs attribute

Message ID 20220415130005.85879-11-andrea.merello@gmail.com (mailing list archive)
State Changes Requested
Headers show
Series Add support for Bosch BNO055 IMU | expand

Commit Message

Andrea Merello April 15, 2022, 1 p.m. UTC
From: Andrea Merello <andrea.merello@iit.it>

This patch adds ABI documentation for the new "serial_number" sysfs
attribute. The first user is the bno055 IIO driver.

Signed-off-by: Andrea Merello <andrea.merello@iit.it>
---
 Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Lars-Peter Clausen April 19, 2022, 7:41 a.m. UTC | #1
On 4/15/22 15:00, Andrea Merello wrote:
> From: Andrea Merello <andrea.merello@iit.it>
>
> This patch adds ABI documentation for the new "serial_number" sysfs
> attribute. The first user is the bno055 IIO driver.
>
> Signed-off-by: Andrea Merello <andrea.merello@iit.it>
> ---
>   Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++
>   1 file changed, 7 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 2a6954ea1c71..3be613f64843 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -2048,3 +2048,10 @@ Contact:	linux-iio@vger.kernel.org
>   Description:
>   		Raw (unscaled) euler angles readings. Units after
>   		application of scale are deg.
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/serial_number

Can we make this `serialnumber`? IIO uses underscores to separate 
different parts of the name and to a machine (e.g. libiio) serial_number 
looks like a channel called serial with an attribute called number.


> +KernelVersion:	5.19
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		An example format is 16-bytes, 2-digits-per-byte, HEX-string
> +		representing the sensor unique ID number.
Jonathan Cameron April 24, 2022, 5:46 p.m. UTC | #2
On Tue, 19 Apr 2022 09:41:54 +0200
Lars-Peter Clausen <lars@metafoo.de> wrote:

> On 4/15/22 15:00, Andrea Merello wrote:
> > From: Andrea Merello <andrea.merello@iit.it>
> >
> > This patch adds ABI documentation for the new "serial_number" sysfs
> > attribute. The first user is the bno055 IIO driver.
> >
> > Signed-off-by: Andrea Merello <andrea.merello@iit.it>
> > ---
> >   Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++
> >   1 file changed, 7 insertions(+)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> > index 2a6954ea1c71..3be613f64843 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-iio
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio
> > @@ -2048,3 +2048,10 @@ Contact:	linux-iio@vger.kernel.org
> >   Description:
> >   		Raw (unscaled) euler angles readings. Units after
> >   		application of scale are deg.
> > +
> > +What:		/sys/bus/iio/devices/iio:deviceX/serial_number  
> 
> Can we make this `serialnumber`? IIO uses underscores to separate 
> different parts of the name and to a machine (e.g. libiio) serial_number 
> looks like a channel called serial with an attribute called number.

Works for me.

J
> 
> 
> > +KernelVersion:	5.19
> > +Contact:	linux-iio@vger.kernel.org
> > +Description:
> > +		An example format is 16-bytes, 2-digits-per-byte, HEX-string
> > +		representing the sensor unique ID number.  
> 
>
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 2a6954ea1c71..3be613f64843 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -2048,3 +2048,10 @@  Contact:	linux-iio@vger.kernel.org
 Description:
 		Raw (unscaled) euler angles readings. Units after
 		application of scale are deg.
+
+What:		/sys/bus/iio/devices/iio:deviceX/serial_number
+KernelVersion:	5.19
+Contact:	linux-iio@vger.kernel.org
+Description:
+		An example format is 16-bytes, 2-digits-per-byte, HEX-string
+		representing the sensor unique ID number.