aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking/devlink/mlx4.rst
diff options
context:
space:
mode:
authorJacob Keller <jacob.e.keller@intel.com>2020-01-09 14:46:20 -0800
committerDavid S. Miller <davem@davemloft.net>2020-01-10 17:07:00 -0800
commit0b0f945f54584621f4f91da701909f8e78c9eb69 (patch)
tree0aee0eff76460c704084b0411f96d5185e1b4a7a /Documentation/networking/devlink/mlx4.rst
parentdevlink: add a driver-specific file for the qed driver (diff)
downloadlinux-dev-0b0f945f54584621f4f91da701909f8e78c9eb69.tar.xz
linux-dev-0b0f945f54584621f4f91da701909f8e78c9eb69.zip
devlink: add a file documenting devlink regions
Also document the regions created by the mlx4 driver. This is currently the only in-tree driver that creates devlink region snapshots. Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> Cc: Tariq Toukan <tariqt@mellanox.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to '')
-rw-r--r--Documentation/networking/devlink/mlx4.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/networking/devlink/mlx4.rst b/Documentation/networking/devlink/mlx4.rst
index 4fa5c2b51c52..7b2d17ea5471 100644
--- a/Documentation/networking/devlink/mlx4.rst
+++ b/Documentation/networking/devlink/mlx4.rst
@@ -41,3 +41,16 @@ parameters.
- Enable using the 4k UAR.
The ``mlx4`` driver supports reloading via ``DEVLINK_CMD_RELOAD``
+
+Regions
+=======
+
+The ``mlx4`` driver supports dumping the firmware PCI crspace and health
+buffer during a critical firmware issue.
+
+In case a firmware command times out, firmware getting stuck, or a non zero
+value on the catastrophic buffer, a snapshot will be taken by the driver.
+
+The ``cr-space`` region will contain the firmware PCI crspace contents. The
+``fw-health`` region will contain the device firmware's health buffer.
+Snapshots for both of these regions are taken on the same event triggers.