From 89a178ff0d050c59f0e5ac9357b9d329041753f4 Mon Sep 17 00:00:00 2001 From: Jeff Lien Date: Thu, 1 Oct 2020 14:17:40 -0500 Subject: [PATCH] [nvme-cli] Documentation files for new wdc plugin enclosure command --- Documentation/nvme-wdc-enc-get-log.1 | 104 +++ Documentation/nvme-wdc-enc-get-log.html | 835 ++++++++++++++++++++++++ Documentation/nvme-wdc-enc-get-log.txt | 54 ++ 3 files changed, 993 insertions(+) create mode 100644 Documentation/nvme-wdc-enc-get-log.1 create mode 100644 Documentation/nvme-wdc-enc-get-log.html create mode 100644 Documentation/nvme-wdc-enc-get-log.txt diff --git a/Documentation/nvme-wdc-enc-get-log.1 b/Documentation/nvme-wdc-enc-get-log.1 new file mode 100644 index 00000000..3842b430 --- /dev/null +++ b/Documentation/nvme-wdc-enc-get-log.1 @@ -0,0 +1,104 @@ +'\" t +.\" Title: nvme-wdc-enc-get-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/01/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-ENC\-GET\" "1" "10/01/2020" "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-enc-get-log \- Send NVMe WDC enc\-get\-log Vendor Unique Command, return result\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc enc\-get\-log\fR [\-\-log\-id=, \-l ] [\-\-output\-file=, \-o ] [\-\-transfer\-size=, \-s ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send a Vendor Unique WDC enc\-get\-log command and output the Enclosure logs\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0)\&. +.sp +The \-\-log\-id=, \-l parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.sp +On success it returns the enclosure log data, error code otherwise\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-file= +.RS 4 +Output file pathname +.RE +.PP +\-s , \-\-transfer\-size= +.RS 4 +Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192) +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc enc\-get\-log /dev/nvme0 \-l 0xd1 \-o d1_log\&.bin \-s 0x2000 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the enclosure log from the device based on the log id(0xd2) with default transfer size(0x1000) and saves to defined file in current directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc enc\-get\-log /dev/nvme0 \-l 0xd2 \-o d1_log\&.bin +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-enc-get-log.html b/Documentation/nvme-wdc-enc-get-log.html new file mode 100644 index 00000000..bbcd36de --- /dev/null +++ b/Documentation/nvme-wdc-enc-get-log.html @@ -0,0 +1,835 @@ + + + + + +nvme-wdc-enc-get-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc enc-get-log <device> [--log-id=<NUM>, -l <NUM>] [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a Vendor Unique WDC enc-get-log command and +output the Enclosure logs.

+

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

+

The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.

+

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

+

On success it returns the enclosure log data, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-o <FILE> +
+
+--output-file=<FILE> +
+
+

+ Output file pathname +

+
+
+-s <SIZE> +
+
+--transfer-size=<NUM> +
+
+

+ Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192) +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Gets the enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory: +

    +
    +
    +
    # nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -o d1_log.bin -s 0x2000
    +
    +
    • +
  • +

    +Gets the enclosure log from the device based on the log id(0xd2) with default transfer size(0x1000) and saves to defined file in current directory: +

    +
    +
    +
    # nvme wdc enc-get-log /dev/nvme0 -l 0xd2 -o d1_log.bin
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-enc-get-log.txt b/Documentation/nvme-wdc-enc-get-log.txt new file mode 100644 index 00000000..ae93a7ab --- /dev/null +++ b/Documentation/nvme-wdc-enc-get-log.txt @@ -0,0 +1,54 @@ +nvme-wdc-enc-get-log(1) +======================= + +NAME +---- +nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return result. + +SYNOPSIS +-------- +[verse] +'nvme wdc enc-get-log' [--log-id=, -l ] [--output-file=, -o ] [--transfer-size=, -s ] + +DESCRIPTION +----------- + +For the NVMe device given, send a Vendor Unique WDC enc-get-log command and +output the Enclosure logs. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0). + +The --log-id=, -l parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4. + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +On success it returns the enclosure log data, error code otherwise. + +OPTIONS +------- +-o :: +--output-file=:: + Output file pathname + +-s :: +--transfer-size=:: + Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192) + +EXAMPLES +-------- +* Gets the enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory: ++ +------------ +# nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -o d1_log.bin -s 0x2000 +------------ +* Gets the enclosure log from the device based on the log id(0xd2) with default transfer size(0x1000) and saves to defined file in current directory: ++ +------------ +# nvme wdc enc-get-log /dev/nvme0 -l 0xd2 -o d1_log.bin +------------ + +NVME +---- +Part of the nvme-user suite. -- 2.50.1