nvme-cli: Add help text for wdc-plugin command vs-internal-log. Update help text...

Signed-off-by: Jeff Lien <jeff.lien@wdc.com>

diff --git a/Documentation/nvme-wdc-cap-diag.txt b/Documentation/nvme-wdc-cap-diag.txt
index f9d232d03f641eb6a7f717a435fc77bb245add34..9439eaa6806372facbc6ed170599f976e9bfae26 100644 (file)
--- a/Documentation/nvme-wdc-cap-diag.txt
+++ b/Documentation/nvme-wdc-cap-diag.txt
@@ -8,7 +8,7 @@ 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>]
+'nvme wdc cap-diag' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
 
 DESCRIPTION
 -----------
@@ -27,6 +27,10 @@ OPTIONS
 --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):
@@ -44,6 +48,16 @@ EXAMPLES
 ------------
 # 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
 ----

diff --git a/Documentation/nvme-wdc-vs-internal-log.txt b/Documentation/nvme-wdc-vs-internal-log.txt
new file mode 100644 (file)
index 0000000..8a04863
--- /dev/null
+++ b/Documentation/nvme-wdc-vs-internal-log.txt
@@ -0,0 +1,64 @@
+nvme-wdc-vs-internal-log(1)
+===========================
+
+NAME
+----
+nvme-wdc-vs-internal-log - Retrieve WDC device's internal firmware log and save to file.
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc vs-internal-log' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, sends the WDC Vendor Specific Internal Log 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 "_internal_fw_log_<date>_<time>.bin" suffix
+
+-s <SIZE>::
+--transfer-size=<SIZE>::
+    Transfer size; defaults to 0x10000 (65536 decimal) bytes
+
+EXAMPLES
+--------
+* Gets the internal firmware log from the device and saves to default file in current directory (e.g. STM00019F3F9_internal_fw_log_20171127_095704.bin):
++
+------------
+# nvme wdc vs-internal-log /dev/nvme0
+------------
+* Gets the internal firmware log from the device and saves to defined file in current directory (e.g. test.bin):
++
+------------
+# nvme wdc vs-internal-log /dev/nvme0 -o test.bin
+------------
+* Gets the internal firmware log from the device and saves to defined file with pathname (e.g. /tmp/test):
++
+------------
+# nvme wdc vs-internal-log /dev/nvme0 -o /tmp/test
+------------
+* Gets the internal firmware log from the device transferring the data in 64k chunks and saves to default file in current directory (e.g. STM00019F3F9_internal_fw_log_20171127_100754.bin):
++
+------------
+# nvme wdc vs-internal-log /dev/nvme0 -s 0x10000
+------------
+* Gets the internal firmware log from the device transferring the data in 16k chunks and saves to default file in current directory (e.g. STM00019F3F9_internal_fw_log_20171127_100950.bin):
++
+------------
+# nvme wdc vs-internal-log /dev/nvme0 -s 16384
+------------
+
+NVME
+----
+Part of the nvme-user suite.