summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-micron-pcie-stats.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-micron-pcie-stats.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/nvme-micron-pcie-stats.txt b/Documentation/nvme-micron-pcie-stats.txt
new file mode 100644
index 0000000..f58257a
--- /dev/null
+++ b/Documentation/nvme-micron-pcie-stats.txt
@@ -0,0 +1,40 @@
+nvme-micron-pcie-stats(1)
+=========================
+
+NAME
+----
+nvme-micron-pcie-stats - Retrieves pcie error statistics for given micron device
+
+SYNOPSIS
+--------
+[verse]
+'nvme micron vs-pcie-stats' <device>
+
+DESCRIPTION
+-----------
+This command prints pcie correctable and uncorrectable error information for the
+given micron device.
+
+The <device> parameter is mandatory and may be either the NVMe
+character device (ex: /dev/nvme0), or a namespace block device (ex:
+/dev/nvme0n1).
+
+This will only work on Micron devices devices of model numbers 54XX. Support for
+new devices may be added subsequently.
+
+OPTIONS
+-------
+None
+
+EXAMPLES
+--------
+* Retrieve PCIe error information
++
+------------
+# nvme micron vs-pcie-stats /dev/nvme0
+
+------------
+
+NVME
+----
+Part of the nvme-user suite