[PATCH v4 6/6] Documentation: devlink: add devlink documentation for the etas_es58x driver
From: Vincent Mailhol
Date: Sat Nov 26 2022 - 11:23:28 EST
List all the version information reported by the etas_es58x
driver. Also, update MAINTAINERS with the newly created file.
Signed-off-by: Vincent Mailhol <mailhol.vincent@xxxxxxxxxx>
---
.../networking/devlink/etas_es58x.rst | 33 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 34 insertions(+)
create mode 100644 Documentation/networking/devlink/etas_es58x.rst
diff --git a/Documentation/networking/devlink/etas_es58x.rst b/Documentation/networking/devlink/etas_es58x.rst
new file mode 100644
index 000000000000..83f59713eed5
--- /dev/null
+++ b/Documentation/networking/devlink/etas_es58x.rst
@@ -0,0 +1,33 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==========================
+etas_es58x devlink support
+==========================
+
+This document describes the devlink features implemented by the
+``etas_es58x`` device driver.
+
+Info versions
+=============
+
+The ``etas_es58x`` driver reports the following versions
+
+.. list-table:: devlink info versions implemented
+ :widths: 5 5 90
+
+ * - Name
+ - Type
+ - Description
+ * - ``fw``
+ - running
+ - Version of firmware running on the device. Also available
+ through ``ethtool -i``.
+ * - ``bl``
+ - running
+ - Version of the bootloader running on the device.
+ * - ``board.rev``
+ - fixed
+ - The hardware revision of the device.
+ * - ``serial_number``
+ - fixed
+ - The USB serial number. Also available through ``lsusb -v``.
diff --git a/MAINTAINERS b/MAINTAINERS
index 61fe86968111..d95642683fc4 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7686,6 +7686,7 @@ ETAS ES58X CAN/USB DRIVER
M: Vincent Mailhol <mailhol.vincent@xxxxxxxxxx>
L: linux-can@xxxxxxxxxxxxxxx
S: Maintained
+F: Documentation/networking/devlink/etas_es58x.rst
F: drivers/net/can/usb/etas_es58x/
ETHERNET BRIDGE
--
2.37.4