From: Jeff Lien <jeff.lien@wdc.com>
Date: Fri, 30 Aug 2019 15:53:24 +0000 (-0500)
Subject: [NVMe-CLI] Add updated documentation for additional parameters to specify file size
X-Git-Tag: v1.10~79^2~7
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=4f47351e57f85ce3ad5d0bb54f3423aef803734c;p=users%2Fhch%2Fnvme-cli.git

[NVMe-CLI] Add updated documentation for additional parameters to specify file size
  in vs-internal-log command.
---

diff --git a/Documentation/nvme-wdc-vs-internal-log.txt b/Documentation/nvme-wdc-vs-internal-log.txt
index 8a04863..f7280f1 100644
--- a/Documentation/nvme-wdc-vs-internal-log.txt
+++ b/Documentation/nvme-wdc-vs-internal-log.txt
@@ -8,7 +8,8 @@ nvme-wdc-vs-internal-log - Retrieve WDC device's internal firmware log and save
 SYNOPSIS
 --------
 [verse]
-'nvme wdc vs-internal-log' <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+'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>]
 
 DESCRIPTION
 -----------
@@ -31,6 +32,23 @@ OPTIONS
 --transfer-size=<SIZE>::
     Transfer size; defaults to 0x10000 (65536 decimal) bytes
 
+-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.  
+    
+-f <FILE SIZE>::
+--file-size=<FILE SIZE>::
+    Specifies the desired size of the data file starting at the passed in offset.  This allows the user to 
+    retrieve the data in several smaller files of the passed in size.  This parameter is currently only 
+    supported on the SN340 device.    
+
+-t <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.      
+
 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):
@@ -58,6 +76,13 @@ EXAMPLES
 ------------
 # nvme wdc vs-internal-log /dev/nvme0 -s 16384
 ------------
+* Gets the internal firmware log up to data area 3 from the device in 3 files of 0x1000000 bytes:
++
+------------
+# nvme wdc vs-internal-log /dev/nvme0 -d 3 -f 0x1000000 -t 0x0000000 -o /tmp/sn340_dui_data_1.bin
+# 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
+------------
 
 NVME
 ----