From 637bc018eae7c48fac2e7355f96295dc1d5ffbf3 Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Wed, 30 Jan 2019 13:29:08 -0700 Subject: [PATCH] Add new docs to repository Signed-off-by: Keith Busch --- Documentation/nvme-wdc-clear-assert-dump.1 | 71 ++ Documentation/nvme-wdc-clear-assert-dump.html | 801 +++++++++++++++++ Documentation/nvme-wdc-drive-resize.1 | 76 ++ Documentation/nvme-wdc-drive-resize.html | 813 +++++++++++++++++ Documentation/nvme-wdc-get-drive-status.1 | 122 +++ Documentation/nvme-wdc-get-drive-status.html | 839 ++++++++++++++++++ 6 files changed, 2722 insertions(+) create mode 100644 Documentation/nvme-wdc-clear-assert-dump.1 create mode 100644 Documentation/nvme-wdc-clear-assert-dump.html create mode 100644 Documentation/nvme-wdc-drive-resize.1 create mode 100644 Documentation/nvme-wdc-drive-resize.html create mode 100644 Documentation/nvme-wdc-get-drive-status.1 create mode 100644 Documentation/nvme-wdc-get-drive-status.html diff --git a/Documentation/nvme-wdc-clear-assert-dump.1 b/Documentation/nvme-wdc-clear-assert-dump.1 new file mode 100644 index 00000000..6751b40f --- /dev/null +++ b/Documentation/nvme-wdc-clear-assert-dump.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: nvme-wdc-clear-assert-dump +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 01/29/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-CLEAR\-AS" "1" "01/29/2019" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-clear-assert-dump \- Clears the assert dump (if present)\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc clear\-assert\-dump\fR +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the wdc vendor unique clear assert dump command\&. +.sp +The parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. The command will not be executed on devices that don\(cqt support it\&. +.SH "OPTIONS" +.sp +None +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Clears the assert dump (if present): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc clear\-assert\-dump /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-wdc-clear-assert-dump.html b/Documentation/nvme-wdc-clear-assert-dump.html new file mode 100644 index 00000000..57a68c9b --- /dev/null +++ b/Documentation/nvme-wdc-clear-assert-dump.html @@ -0,0 +1,801 @@ + + + + + +nvme-wdc-clear-assert-dump(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc clear-assert-dump <device>
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the wdc vendor unique clear assert +dump command.

+

The <device> parameter is mandatory and must be the NVMe character +device (ex: /dev/nvme0).

+

This will only work on WDC devices supporting this feature. +The command will not be executed on devices that don’t support it.

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Clears the assert dump (if present): +

    +
    +
    +
    # nvme wdc clear-assert-dump /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-drive-resize.1 b/Documentation/nvme-wdc-drive-resize.1 new file mode 100644 index 00000000..204dc03b --- /dev/null +++ b/Documentation/nvme-wdc-drive-resize.1 @@ -0,0 +1,76 @@ +'\" t +.\" Title: nvme-wdc-drive-resize +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 01/29/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-DRIVE\-RE" "1" "01/29/2019" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-drive-resize \- Send NVMe WDC Resize Vendor Unique Command, return result\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc drive\-resize\fR [\-\-size= | \-s ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends a Vendor Unique WDC Resize command\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OPTIONS" +.PP +\-s , \-\-size= +.RS 4 +The new size (in GB) to resize the drive to\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue WDC Resize Vendor Unique Command : +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc drive\-resize /dev/nvme0n1 \-\-size=100 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-drive-resize.html b/Documentation/nvme-wdc-drive-resize.html new file mode 100644 index 00000000..5fc393f7 --- /dev/null +++ b/Documentation/nvme-wdc-drive-resize.html @@ -0,0 +1,813 @@ + + + + + +nvme-wdc-drive-resize(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc drive-resize <device> [--size=<sz> | -s <sz>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends a Vendor Unique WDC Resize command.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+

This will only work on WDC devices supporting this feature. +Results for any other device are undefined.

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-s <sz> +
+
+--size=<sz> +
+
+

+ The new size (in GB) to resize the drive to. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC Resize Vendor Unique Command : +

    +
    +
    +
    # nvme wdc drive-resize /dev/nvme0n1 --size=100
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-get-drive-status.1 b/Documentation/nvme-wdc-get-drive-status.1 new file mode 100644 index 00000000..e89ce3ea --- /dev/null +++ b/Documentation/nvme-wdc-get-drive-status.1 @@ -0,0 +1,122 @@ +'\" t +.\" Title: nvme-wdc-get-drive-status +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 01/29/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-GET\-DRIV" "1" "01/29/2019" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-get-drive-status \- Send the NVMe WDC get\-drive\-status command, return result +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc get\-drive\-status\fR +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send the unique WDC get\-drive\-status command and provide the additional drive status information\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OUTPUT EXPLANATION" +.TS +allbox tab(:); +ltB ltB. +T{ +Field +T}:T{ +Description +T} +.T& +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +.sp +\fBPercent Life Used\&.\fR +T}:T{ +.sp +The percentage of drive function used\&. +T} +T{ +.sp +\fBEOL (End of Life) Status\fR +T}:T{ +.sp +The 3 possible states are : Normal, Read Only, or End of Life\&. +T} +T{ +.sp +\fBAssert Dump Status\fR +T}:T{ +.sp +The 2 possible states are : Present or Not Present\&. +T} +T{ +.sp +\fBThermal Throttling Status\fR +T}:T{ +.sp +The 3 possible states are : Off, On, or Unavaiable\&. +T} +T{ +.sp +\fBFormat Corrupt Reason\fR +T}:T{ +.sp +The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason\&. +T} +.TE +.sp 1 +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue WDC get\-drive\-status command : +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc get\-drive\-status /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-get-drive-status.html b/Documentation/nvme-wdc-get-drive-status.html new file mode 100644 index 00000000..53d65e18 --- /dev/null +++ b/Documentation/nvme-wdc-get-drive-status.html @@ -0,0 +1,839 @@ + + + + + +nvme-wdc-get-drive-status(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc get-drive-status <device>
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send the unique WDC get-drive-status command and +provide the additional drive status information.

+

The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0).

+

This will only work on WDC devices supporting this feature. +Results for any other device are undefined.

+

On success it returns 0, error code otherwise.

+
+
+
+

Output Explanation

+
+
+ +++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Field Description

Percent Life Used.

The percentage of drive function used.

EOL (End of Life) Status

The 3 possible states are : Normal, Read Only, or End of Life.

Assert Dump Status

The 2 possible states are : Present or Not Present.

Thermal Throttling Status

The 3 possible states are : Off, On, or Unavaiable.

Format Corrupt Reason

The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.

+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC get-drive-status command : +

    +
    +
    +
    # nvme wdc get-drive-status /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + -- 2.50.1