| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-Id: <20200130225913.1671982-16-jacob.e.keller@intel.com>
Date: Thu, 30 Jan 2020 14:59:10 -0800
From: Jacob Keller <jacob.e.keller@...el.com>
To: netdev@...r.kernel.org
Cc: jiri@...nulli.us, valex@...lanox.com, linyunsheng@...wei.com,
lihong.yang@...el.com, Jacob Keller <jacob.e.keller@...el.com>
Subject: [PATCH 15/15] ice: add ice.rst devlink documentation file
Now that the ice driver has gained some devlink support, add
a driver-specific documentation file for it.
Signed-off-by: Jacob Keller <jacob.e.keller@...el.com>
---
Documentation/networking/devlink/ice.rst | 76 ++++++++++++++++++++++
Documentation/networking/devlink/index.rst | 1 +
2 files changed, 77 insertions(+)
create mode 100644 Documentation/networking/devlink/ice.rst
diff --git a/Documentation/networking/devlink/ice.rst b/Documentation/networking/devlink/ice.rst
new file mode 100644
index 000000000000..c27b49311afe
--- /dev/null
+++ b/Documentation/networking/devlink/ice.rst
@@ -0,0 +1,76 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===================
+ice devlink support
+===================
+
+This document describes the devlink features implemented by the ``ice``
+device driver.
+
+Info versions
+=============
+
+The ``ice`` driver reports the following versions
+
+.. list-table:: devlink info versions implemented
+ :widths: 5 5 90
+
+ * - Name
+ - Type
+ - Description
+ * - ``driver.version``
+ - fixed
+ - Device driver version as reported by ``ETHTOOL_GDRVINFO``
+ * - ``board.id``
+ - fixed
+ - The Product Board Assembly (PBA) identifier of the board
+ * - ``fw``
+ - running
+ - Combined flash version string as reported by ``ETHTOOL_GDRVINFO``
+ * - ``fw.mgmt``
+ - running
+ - 3-digit overall firmware version
+ * - ``fw.api``
+ - running
+ - 2-digit firmware API version
+ * - ``fw.build``
+ - running
+ - firmware build identifier
+ * - ``nvm.version``
+ - running
+ - NVM format version
+ * - ``nvm.oem``
+ - running
+ - Original Equipment Manufacturer (OEM) version information
+ * - ``nvm.eetrack``
+ - running
+ - Unique NVM EETRACK identifier
+
+
+Regions
+=======
+
+The ``ice`` driver enables access to the contents of the Shadow RAM portion
+of the flash chip via the ``shadow-ram`` region.
+
+Users can request an immediate capture of a snapshot via the
+``DEVLINK_CMD_REGION_TAKE_SNAPSHOT``
+
+.. code:: shell
+
+ $ devlink region snapshot pci/0000:01:00.0/shadow-ram
+ $ devlink region dump pci/0000:01:00.0/shadow-ram snapshot 1
+
+Directly reading a portion of the Shadow RAM without a snapshot is also
+supported
+
+.. code:: shell
+
+ $ devlink region dump pci/0000:01:00.0/shadow-ram
+ 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
+ 0000000000000010 0000 0000 ffff ff04 0029 8c00 0028 8cc8
+ 0000000000000020 0016 0bb8 0016 1720 0000 0000 c00f 3ffc
+ 0000000000000030 bada cce5 bada cce5 bada cce5 bada cce5
+
+ $ devlink region read pci/0000:01:00.0/shadow-ram address 0 length 16
+ 0000000000000000 0014 95dc 0014 9514 0035 1670 0034 db30
diff --git a/Documentation/networking/devlink/index.rst b/Documentation/networking/devlink/index.rst
index 087ff54d53fc..272509cd9215 100644
--- a/Documentation/networking/devlink/index.rst
+++ b/Documentation/networking/devlink/index.rst
@@ -32,6 +32,7 @@ parameters, info versions, and other features it supports.
bnxt
ionic
+ ice
mlx4
mlx5
mlxsw
--
2.25.0.rc1
Powered by blists - more mailing lists