netdev - [PATCH net-next 15/27] Documentation: mlx5: Update kernel documentation

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

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <1547737521-29888-16-git-send-email-eranbe@mellanox.com>
Date:   Thu, 17 Jan 2019 17:05:09 +0200
From:   Eran Ben Elisha <eranbe@...lanox.com>
To:     netdev@...r.kernel.org, Jiri Pirko <jiri@...lanox.com>,
        "David S. Miller" <davem@...emloft.net>,
        Ariel Almog <ariela@...lanox.com>,
        Aya Levin <ayal@...lanox.com>,
        Eran Ben Elisha <eranbe@...lanox.com>,
        Moshe Shemesh <moshe@...lanox.com>
Cc:     Feras Daoud <ferasda@...lanox.com>,
        Saeed Mahameed <saeedm@...lanox.com>
Subject: [PATCH net-next 15/27] Documentation: mlx5: Update kernel documentation

From: Feras Daoud <ferasda@...lanox.com>

Initial kernel documentation for mlx5 core driver.
This change includes also documentation for the new devlink region
param : DEVLINK_PARAM_GENERIC_ID_REGION_SNAPSHOT.

Signed-off-by: Feras Daoud <ferasda@...lanox.com>
Signed-off-by: Saeed Mahameed <saeedm@...lanox.com>
---
 Documentation/networking/mlx5.rst | 39 +++++++++++++++++++++++++++++++
 MAINTAINERS                       |  1 +
 2 files changed, 40 insertions(+)
 create mode 100644 Documentation/networking/mlx5.rst

diff --git a/Documentation/networking/mlx5.rst b/Documentation/networking/mlx5.rst
new file mode 100644
index 000000000000..4c44996d2132
--- /dev/null
+++ b/Documentation/networking/mlx5.rst
@@ -0,0 +1,39 @@
+.. SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
+
+Linux* Base Driver for Mellanox Core VPI Network Connection
+===========================================================
+
+Copyright (c) 2018, Mellanox Technologies inc.
+
+Contents
+========
+
+- Command Line Parameters
+
+Command Line Parameters
+=======================
+
+Devlink tool
+------------
+The driver utilizes the devlink device configuration tool for setting driver
+configuration, as well as displaying device attributes.
+
+:Devlink supported parameters:
+
+- DEVLINK_PARAM_GENERIC_ID_REGION_SNAPSHOT:
+
+      - This parameter enables capturing region snapshot of the crspace during critical errors.
+      - The default value of this parameter is disabled.
+
+      - Example:
+         devlink region show
+            List available address regions and snapshot.
+
+         devlink region del pci/0000:00:05.0/cr-space snapshot 1
+            Delete snapshot id 1 from cr-space address region from device pci/0000:00:05.0.
+
+         devlink region dump pci/0000:00:05.0/cr-space snapshot 1
+            Dump the snapshot taken from cr-space address region with ID 1
+
+         devlink region read pci/0000:00:05.0/cr-space snapshot 1 address 0x10 legth 16
+            Read from address 0x10, 16 Bytes of snapshot ID 1 taken from cr-space address region
diff --git a/MAINTAINERS b/MAINTAINERS
index 4d04cebb4a71..d886bef6f06a 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9743,6 +9743,7 @@ Q:	http://patchwork.ozlabs.org/project/netdev/list/
 S:	Supported
 F:	drivers/net/ethernet/mellanox/mlx5/core/
 F:	include/linux/mlx5/
+F:	Documentation/networking/mlx5.rst
 
 MELLANOX MLX5 IB driver
 M:	Leon Romanovsky <leonro@...lanox.com>
-- 
2.17.1