From: Jacob Keller <jacob.e.keller@intel.com>
Date: Thu, 9 Jan 2020 22:46:21 +0000 (-0800)
Subject: devlink: add documentation for ionic device driver
X-Git-Tag: Ubuntu-5.13.0-19.19~6812^2~114^2~4
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=cf4cb322d75253e38a41ec77d493a56c7a6648ab;p=mirror_ubuntu-jammy-kernel.git

devlink: add documentation for ionic device driver

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>
---

diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index 3d351beedb0a..ce0ee563d83a 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -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
index 000000000000..48da9c92d584
--- /dev/null
+++ b/Documentation/networking/devlink/ionic.rst
@@ -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