diff mbox series

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

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

Commit Message

Andrea Merello Feb. 17, 2022, 4:27 p.m. UTC
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

Jonathan Cameron Feb. 19, 2022, 4:52 p.m. UTC | #1
On Thu, 17 Feb 2022 17:27:06 +0100
Andrea Merello <andrea.merello@gmail.com> 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 <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 1b8d77577608..224585f00147 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -2017,3 +2017,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.17
> +Contact:	linux-iio@vger.kernel.org
> +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.
diff mbox series

Patch

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:	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.17
+Contact:	linux-iio@vger.kernel.org
+Description:
+		16-bytes, 2-digits-per-byte, HEX-string representing the sensor
+		unique ID number.