summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-cap-diag.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-wdc-cap-diag.txt')
-rw-r--r--Documentation/nvme-wdc-cap-diag.txt64
1 files changed, 64 insertions, 0 deletions
diff --git a/Documentation/nvme-wdc-cap-diag.txt b/Documentation/nvme-wdc-cap-diag.txt
new file mode 100644
index 0000000..bfcde9a
--- /dev/null
+++ b/Documentation/nvme-wdc-cap-diag.txt
@@ -0,0 +1,64 @@
+nvme-wdc-cap-diag(1)
+====================
+
+NAME
+----
+nvme-wdc-cap-diag - Retrieve WDC device's diagnostic log and save to file.
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc cap-diag' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, sends the WDC Vendor Unique Capture-Diagnostics
+request and saves the result to a file.
+
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+This will only work on WDC devices supporting this feature.
+Results for any other device are undefined.
+
+OPTIONS
+-------
+-o <FILE>::
+--output-file=<FILE>::
+ Output file; defaults to device serial number followed by "cap_diag" suffix
+
+-s <SIZE>::
+--transfer-size=<SIZE>::
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes
+
+EXAMPLES
+--------
+* Gets the capture diagnostics log from the device and saves to default file in current directory (e.g. STM00019F3F9cap_diag.bin):
++
+------------
+# nvme wdc cap-diag /dev/nvme0
+------------
+* Gets the capture diagnostics log from the device and saves to defined file in current directory (e.g. testSTM00019F3F9cap_diag.bin):
++
+------------
+# nvme wdc cap-diag /dev/nvme0 -o test
+------------
+* Gets the capture diagnostics log from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9cap_diag.bin):
++
+------------
+# nvme wdc cap-diag /dev/nvme0 -o /tmp/test
+------------
+* Gets the capture diagnostics log from the device transferring the data in 64k chunks and saves to default file in current directory (e.g. STM00019F3F9internal_fw_log.bin):
++
+------------
+# nvme wdc cap-diag /dev/nvme0 -s 0x10000
+------------
+* Gets the capture diagnostics log from the device transferring the data in 16k chunks and saves to default file in current directory (e.g. STM00019F3F9internal_fw_log.bin):
++
+------------
+# nvme wdc cap-diag /dev/nvme0 -s 16384
+------------
+
+NVME
+----
+Part of the nvme-user suite.