2022-11-30 18:06:33

by Vincent MAILHOL

[permalink] [raw]
Subject: [PATCH v5 7/7] Documentation: devlink: add devlink documentation for the etas_es58x driver

List all the version information reported by the etas_es58x driver
through devlink. Also, update MAINTAINERS with the newly created file.

Signed-off-by: Vincent Mailhol <[email protected]>
---
.../networking/devlink/etas_es58x.rst | 36 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 37 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..9893e57b625a
--- /dev/null
+++ b/Documentation/networking/devlink/etas_es58x.rst
@@ -0,0 +1,36 @@
+.. 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 the firmware running on the device. Also available
+ through ``ethtool -i`` as the first member of the
+ ``firmware-version``.
+ * - ``bl``
+ - running
+ - Version of the bootloader running on the device. Also available
+ through ``ethtool -i`` as the second member of the
+ ``firmware-version``.
+ * - ``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 955c1be1efb2..71f4f8776779 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7682,6 +7682,7 @@ ETAS ES58X CAN/USB DRIVER
M: Vincent Mailhol <[email protected]>
L: [email protected]
S: Maintained
+F: Documentation/networking/devlink/etas_es58x.rst
F: drivers/net/can/usb/etas_es58x/

ETHERNET BRIDGE
--
2.37.4


2022-12-02 13:20:51

by Marc Kleine-Budde

[permalink] [raw]
Subject: Re: [PATCH v5 7/7] Documentation: devlink: add devlink documentation for the etas_es58x driver

On 01.12.2022 02:46:58, Vincent Mailhol wrote:
> List all the version information reported by the etas_es58x driver
> through devlink. Also, update MAINTAINERS with the newly created file.
>
> Signed-off-by: Vincent Mailhol <[email protected]>
> ---
> .../networking/devlink/etas_es58x.rst | 36 +++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 37 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..9893e57b625a
> --- /dev/null
> +++ b/Documentation/networking/devlink/etas_es58x.rst
> @@ -0,0 +1,36 @@
> +.. 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 the firmware running on the device. Also available
> + through ``ethtool -i`` as the first member of the
> + ``firmware-version``.
> + * - ``bl``
^^
fw.bootloader?

Fixed that up while applying.

Marc

--
Pengutronix e.K. | Marc Kleine-Budde |
Embedded Linux | https://www.pengutronix.de |
Vertretung West/Dortmund | Phone: +49-231-2826-924 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |


Attachments:
(No filename) (1.81 kB)
signature.asc (499.00 B)
Download all attachments

2022-12-02 13:40:38

by Vincent MAILHOL

[permalink] [raw]
Subject: Re: [PATCH v5 7/7] Documentation: devlink: add devlink documentation for the etas_es58x driver

On Fri 2 Dec. 2022 at 21:49, Marc Kleine-Budde <[email protected]> wrote:
> On 01.12.2022 02:46:58, Vincent Mailhol wrote:
> > List all the version information reported by the etas_es58x driver
> > through devlink. Also, update MAINTAINERS with the newly created file.
> >
> > Signed-off-by: Vincent Mailhol <[email protected]>
> > ---
> > .../networking/devlink/etas_es58x.rst | 36 +++++++++++++++++++
> > MAINTAINERS | 1 +
> > 2 files changed, 37 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..9893e57b625a
> > --- /dev/null
> > +++ b/Documentation/networking/devlink/etas_es58x.rst
> > @@ -0,0 +1,36 @@
> > +.. 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 the firmware running on the device. Also available
> > + through ``ethtool -i`` as the first member of the
> > + ``firmware-version``.
> > + * - ``bl``
> ^^
> fw.bootloader?
>
> Fixed that up while applying.

Thanks for catching this. "fw" was the name in v4. "fw.bootloader" is
indeed correct.


Yours sincerely,
Vincent Mailhol