2022-02-17 18:23:40

by Andrea Merello

Subject: [v3 09/13] iio: document "serial_number" sysfs attribute

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 <[email protected]>
---
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 1b8d77577608..224585f00147 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -2017,3 +2017,10 @@ Contact: [email protected]
Description:
Raw (unscaled) euler angles readings. Units after
application of scale are deg.
+
+What: /sys/bus/iio/devices/iio:deviceX/serial_number
+KernelVersion: 5.17
+Contact: [email protected]
+Description:
+ 16-bytes, 2-digits-per-byte, HEX-string representing the sensor
+ unique ID number.
--
2.17.1

2022-02-21 09:19:39

by Jonathan Cameron

Subject: Re: [v3 09/13] iio: document "serial_number" sysfs attribute

On Thu, 17 Feb 2022 17:27:06 +0100
Andrea Merello <[email protected]> wrote:

> 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 <[email protected]>
> ---
> 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 1b8d77577608..224585f00147 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -2017,3 +2017,10 @@ Contact: [email protected]
> Description:
> Raw (unscaled) euler angles readings. Units after
> application of scale are deg.
> +
> +What: /sys/bus/iio/devices/iio:deviceX/serial_number
> +KernelVersion: 5.17
> +Contact: [email protected]
> +Description:
> + 16-bytes, 2-digits-per-byte, HEX-string representing the sensor
> + unique ID number.
This might prove too restrictive for other devices but I guess we can update
the help text when they come along. Maybe relax this to

An example format is 16-bytes, 2-digits-per-byte ....

then we avoid having to update it later when a different format comes along.