devlink: add documentation for ionic device driver
authorJacob Keller <jacob.e.keller@intel.com>
Thu, 9 Jan 2020 22:46:21 +0000 (14:46 -0800)
committerDavid S. Miller <davem@davemloft.net>
Sat, 11 Jan 2020 01:07:00 +0000 (17:07 -0800)
The IONIC device driver allocates a devlink and reports versions. Add
documentation for this driver.

Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Cc: Shannon Nelson <snelson@pensando.io>
Acked-by: Shannon Nelson <snelson@pensandi.io>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/devlink/index.rst
Documentation/networking/devlink/ionic.rst [new file with mode: 0644]

index 3d351be..ce0ee56 100644 (file)
@@ -30,6 +30,7 @@ parameters, info versions, and other features it supports.
    :maxdepth: 1
 
    bnxt
+   ionic
    mlx4
    mlx5
    mlxsw
diff --git a/Documentation/networking/devlink/ionic.rst b/Documentation/networking/devlink/ionic.rst
new file mode 100644 (file)
index 0000000..48da9c9
--- /dev/null
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=====================
+ionic devlink support
+=====================
+
+This document describes the devlink features implemented by the ``ionic``
+device driver.
+
+Info versions
+=============
+
+The ``ionic`` 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
+   * - ``asic.id``
+     - fixed
+     - The ASIC type for this device
+   * - ``asic.rev``
+     - fixed
+     - The revision of the ASIC for this device