diff mbox series

[net-next,5/9] Documentation: mlx5: Update kernel documentation

Message ID 20190110102906.3751-6-saeedm@mellanox.com
State Deferred
Delegated to: David Miller
Headers show
Series [net-next,1/9] net/mlx5: Move all devlink related functions calls to devlink.c | expand

Commit Message

Saeed Mahameed Jan. 10, 2019, 10:29 a.m. UTC 
From: Feras Daoud <ferasda@mellanox.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@mellanox.com>
Signed-off-by: Saeed Mahameed <saeedm@mellanox.com>
---
 Documentation/networking/mlx5.rst | 39 +++++++++++++++++++++++++++++++
 MAINTAINERS                       |  1 +
 2 files changed, 40 insertions(+)
 create mode 100644 Documentation/networking/mlx5.rst
diff mbox series

Patch

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 7a9804a891fd..78b2cc7b26ab 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9676,6 +9676,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@mellanox.com>