[NVMe-CLI] Update documentation for telemetry data retrieval to

vs-internal-log wdc plugin command.

diff --git a/Documentation/nvme-wdc-vs-internal-log.txt b/Documentation/nvme-wdc-vs-internal-log.txt
index f7280f12bb9c307b08d3d639d5013f4693371108..eaeb21e798fa9626d279a6ff5c3c61f09c7c451f 100644 (file)
--- a/Documentation/nvme-wdc-vs-internal-log.txt
+++ b/Documentation/nvme-wdc-vs-internal-log.txt
@@ -9,7 +9,8 @@ SYNOPSIS
 --------
 [verse]
 'nvme wdc vs-internal-log' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>] 
-    [--data-area=<DATA AREA>, -d <DATA_AREA>] [--file-size=<FILE SIZE>, -f <FILE SIZE>] [--offset=<OFFSET>, -t <OFFSET>]
+    [--data-area=<DATA AREA>, -d <DATA_AREA>] [--file-size=<FILE SIZE>, -f <FILE SIZE>] [--offset=<OFFSET>, -e <OFFSET>]
+    [--type=<TYPE>, -t <type>] [--verbose, -v]
 
 DESCRIPTION
 -----------
@@ -35,7 +36,7 @@ OPTIONS
 -d <DATA AREA>::
 --data-area=<DATA AREA>::
     DUI data area to retrieve.  The DUI data areas from 1 to <DATA AREA> will be retrieved.  This parameter 
-    is currently only supported on the SN340 device.  
+    is currently only supported on the SN340, SN640, and SN840 devices.  
     
 -f <FILE SIZE>::
 --file-size=<FILE SIZE>::
@@ -43,12 +44,23 @@ OPTIONS
     retrieve the data in several smaller files of the passed in size.  This parameter is currently only 
     supported on the SN340 device.    
 
--t <OFFSET>::
+-e <OFFSET>::
 --offset=<OFFSET>::        
        Specifies the data offset at which to start retrieving the data.  This parameter is used in combination
        with the file size parameter to retrieve the data in several smaller files.  This parameter is currently 
     only supported on the SN340 device.      
 
+-t <TYPE>::
+--type=<TYPE>::        
+       Specifies the telemetry type - NONE, HOST, or CONTROLLER.  This parameter is used to get either the host
+       generated or controller initiated telemetry log page.  If not specified or none is specified, the command
+    will return the default E6 log data.  This parameter is currently only supported on the SN640 and SN840
+    devices.       
+
+-v <VERBOSE>::
+--verbose=<VERBOSE>::        
+       Provides additional debug messages for certain drives.                                                    
+
 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):
@@ -83,6 +95,16 @@ EXAMPLES
 # nvme wdc vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x1000000 -o /tmp/sn340_dui_data_2.bin
 # nvme wdc vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x2000000 -o /tmp/sn340_dui_data_3.bin
 ------------
+* Gets the host telemetry log page to data area 3 from the device and stores it in file host-telem-log-da3.bin:
++
+------------
+# nvme wdc vs-internal-log /dev/nvme1 -t host -o host-telem-log-da3.bin -d 3
+------------
+* Gets the controller telemetry log page to data area 3 from the device and stores it in file ctlr-telem-log-da3.bin: 
++
+------------
+# nvme wdc vs-internal-log /dev/nvme1 -t controller -o ctlr-telem-log-da3.bin -d 3
+------------
 
 NVME
 ----