From mboxrd@z Thu Jan 1 00:00:00 1970 From: jeff.lien@wdc.com (Jeff Lien) Date: Tue, 28 Nov 2017 08:29:55 -0600 Subject: [PATCH 2/2] NVMe-CLI : WDC-Plugin Documentation for Updated Smart Log Command Message-ID: <20171128142955.9747-1-jeff.lien@wdc.com> Signed-off-by: Jeff Lien --- ...dc-smart-log-add.1 => nvme-wdc-smart-add-log.1} | 168 +++++++++++++++++++-- ...rt-log-add.html => nvme-wdc-smart-add-log.html} | 140 +++++++++++++++-- ...mart-log-add.txt => nvme-wdc-smart-add-log.txt} | 94 +++++++++++- 3 files changed, 371 insertions(+), 31 deletions(-) rename Documentation/{nvme-wdc-smart-log-add.1 => nvme-wdc-smart-add-log.1} (69%) rename Documentation/{nvme-wdc-smart-log-add.html => nvme-wdc-smart-add-log.html} (79%) rename Documentation/{nvme-wdc-smart-log-add.txt => nvme-wdc-smart-add-log.txt} (68%) diff --git a/Documentation/nvme-wdc-smart-log-add.1 b/Documentation/nvme-wdc-smart-add-log.1 similarity index 69% rename from Documentation/nvme-wdc-smart-log-add.1 rename to Documentation/nvme-wdc-smart-add-log.1 index 52dcdd8..fade670 100644 --- a/Documentation/nvme-wdc-smart-log-add.1 +++ b/Documentation/nvme-wdc-smart-add-log.1 @@ -1,13 +1,13 @@ '\" t -.\" Title: nvme-wdc-smart-log-add -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Title: nvme-wdc-smart-add-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 .\" Date: 11/27/2017 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-SMART\-LO" "1" "11/27/2017" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-SMART\-AD" "1" "11/27/2017" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,15 +28,15 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -nvme-wdc-smart-log-add \- Send NVMe WDC smart\-log\-add Vendor Unique Command, return result +nvme-wdc-smart-add-log \- Send NVMe WDC smart\-add\-log Vendor Unique Command, return result .SH "SYNOPSIS" .sp .nf -\fInvme wdc smart\-log\-add\fR [\-\-interval=, \-i ] [\-\-output\-format= \-o ] +\fInvme wdc smart\-add\-log\fR [\-\-interval=, \-i ] [\-\-output\-format= \-o ] .fi .SH "DESCRIPTION" .sp -For the NVMe device given, send a Vendor Unique WDC smart\-log\-add command and provide the additional smart log\&. The \-\-interval option will return performance statistics from the specified reporting interval\&. +For the NVMe device given, send a Vendor Unique WDC smart\-add\-log command and provide the additional smart log\&. The \-\-interval option will return performance statistics from the specified reporting interval\&. .sp The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0)\&. .sp @@ -109,7 +109,155 @@ The statistical set accumulated during the entire lifetime of the device\&. T} .TE .sp 1 -.SH "OUTPUT EXPLANATION" +.SH "CA LOG PAGE DATA OUTPUT EXPLANATION" +.TS +allbox tab(:); +ltB ltB. +T{ +Field +T}:T{ +Description +T} +.T& +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +\fBPhysical NAND bytes written\&.\fR +T}:T{ +.sp +The number of bytes written to NAND\&. 16 bytes \- hi/lo +T} +T{ +.sp +\fBPhysical NAND bytes read\fR +T}:T{ +.sp +The number of bytes read from NAND\&. 16 bytes \- hi/lo +T} +T{ +.sp +\fBBad NAND Block Count\fR +T}:T{ +.sp +Raw and normalized count of the number of NAND blocks that have been retired after the drives manufacturing tests (i\&.e\&. grown back blocks)\&. 2 bytes normalized, 6 bytes raw count +T} +T{ +.sp +\fBUncorrectable Read Error Count\fR +T}:T{ +.sp +Total count of NAND reads that were not correctable by read retries, all levels of ECC, or XOR (as applicable)\&. 8 bytes +T} +T{ +.sp +\fBSoft ECC Error Count\fR +T}:T{ +.sp +Total count of NAND reads that were not correctable by read retries, or first\-level ECC\&. 8 bytes +T} +T{ +.sp +\fBSSD End to End Detection Count\fR +T}:T{ +.sp +A count of the detected errors by the SSD end to end error correction which includes DRAM, SRAM, or other storage element ECC/CRC protection mechanism (not NAND ECC)\&. 4 bytes +T} +T{ +.sp +\fBSSD End to End Correction Count\fR +T}:T{ +.sp +A count of the corrected errors by the SSD end to end error correction which includes DRAM, SRAM, or other storage element ECC/CRC protection mechanism (not NAND ECC)\&. 4 bytes +T} +T{ +.sp +\fBSystem Data % Used\fR +T}:T{ +.sp +A normalized cumulative count of the number of erase cycles per block since leaving the factory for the system (FW and metadata) area\&. Starts at 0 and increments\&. 100 indicates that the estimated endurance has been consumed\&. +T} +T{ +.sp +\fBUser Data Max Erase Count\fR +T}:T{ +.sp +The maximum erase count across all NAND blocks in the drive\&. 4 bytes +T} +T{ +.sp +\fBUser Data Min Erase Count\fR +T}:T{ +.sp +The minimum erase count across all NAND blocks in the drive\&. 4 bytes +T} +T{ +.sp +\fBRefresh Count\fR +T}:T{ +.sp +A count of the number of blocks that have been re\-allocated due to background operations only\&. 8 bytes +T} +T{ +.sp +\fBProgram Fail Count\fR +T}:T{ +.sp +Raw and normalized count of total program failures\&. Normalized count starts at 100 and shows the percent of remaining allowable failures\&. 2 bytes normalized, 6 bytes raw count +T} +T{ +.sp +\fBUser Data Erase Fail Count\fR +T}:T{ +.sp +Raw and normalized count of total erase failures in the user area\&. Normalized count starts at 100 and shows the percent of remaining allowable failures\&. 2 bytes normalized, 6 bytes raw count +T} +T{ +.sp +\fBSystem Area Erase Fail Count\fR +T}:T{ +.sp +Raw and normalized count of total erase failures in the system area\&. Normalized count starts at 100 and shows the percent of remaining allowable failures\&. 2 bytes normalized, 6 bytes raw count +T} +T{ +.sp +\fBThermal Throttling Status\fR +T}:T{ +.sp +The current status of thermal throttling (enabled or disabled)\&. 2 bytes +T} +T{ +.sp +\fBThermal Throttling Count\fR +T}:T{ +.sp +A count of the number of thermal throttling events\&. 2 bytes +T} +T{ +.sp +\fBPCIe Correctable Error Count\fR +T}:T{ +.sp +Summation counter of all PCIe correctable errors (Bad TLP, Bad DLLP, Receiver error, Replay timeouts, Replay rollovers)\&. 8 bytes +T} +.TE +.sp 1 +.SH "C1 LOG PAGE DATA OUTPUT EXPLANATION" .TS allbox tab(:); ltB ltB. @@ -331,13 +479,13 @@ T} .sp -1 .IP \(bu 2.3 .\} -Has the program issue WDC smart\-log\-add Vendor Unique Command with default interval (14) : +Has the program issue WDC smart\-add\-log Vendor Unique Command with default interval (14) : .sp .if n \{\ .RS 4 .\} .nf -# nvme wdc smart\-log\-add /dev/nvme0 +# nvme wdc smart\-add\-log /dev/nvme0 .fi .if n \{\ .RE diff --git a/Documentation/nvme-wdc-smart-log-add.html b/Documentation/nvme-wdc-smart-add-log.html similarity index 79% rename from Documentation/nvme-wdc-smart-log-add.html rename to Documentation/nvme-wdc-smart-add-log.html index 9698063..9d06a09 100644 --- a/Documentation/nvme-wdc-smart-log-add.html +++ b/Documentation/nvme-wdc-smart-add-log.html @@ -1,10 +1,11 @@ + - -nvme-wdc-smart-log-add(1) + +nvme-wdc-smart-add-log(1)