From bc300ddac3343c0f5442b585efe39da4fcc7c895 Mon Sep 17 00:00:00 2001 From: Jeff Lien Date: Wed, 5 Feb 2020 14:40:25 -0600 Subject: [PATCH] Add help text files for wdc log-page-directory and namespace-resize commands. --- Documentation/nvme-wdc-log-page-directory.1 | 79 ++ .../nvme-wdc-log-page-directory.html | 819 +++++++++++++++++ Documentation/nvme-wdc-namespace-resize.1 | 115 +++ Documentation/nvme-wdc-namespace-resize.html | 841 ++++++++++++++++++ Documentation/nvme-wdc-namespace-resize.txt | 56 ++ 5 files changed, 1910 insertions(+) create mode 100644 Documentation/nvme-wdc-log-page-directory.1 create mode 100644 Documentation/nvme-wdc-log-page-directory.html create mode 100644 Documentation/nvme-wdc-namespace-resize.1 create mode 100644 Documentation/nvme-wdc-namespace-resize.html create mode 100644 Documentation/nvme-wdc-namespace-resize.txt diff --git a/Documentation/nvme-wdc-log-page-directory.1 b/Documentation/nvme-wdc-log-page-directory.1 new file mode 100644 index 0000000..84ed6e7 --- /dev/null +++ b/Documentation/nvme-wdc-log-page-directory.1 @@ -0,0 +1,79 @@ +'\" t +.\" Title: nvme-wdc-log-page-directory +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 02/04/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-LOG\-PAGE" "1" "02/04/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-log-page-directory \- Retrieves the list of Log IDs supported by the drive +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc log\-page\-directory\fR [\-\-output\-format= \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, retrieves the log page directory which contains the list of log page IDs supported by the drive\&. The \-\-output\-format option will format the output as specified\&. +.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\&. Results for any other device are undefined\&. +.sp +On success it returns the log page directory information, error code otherwise\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. The default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +WDC log\-page\-directory example command : +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc log\-page\-directory /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-log-page-directory.html b/Documentation/nvme-wdc-log-page-directory.html new file mode 100644 index 0000000..2bca3ee --- /dev/null +++ b/Documentation/nvme-wdc-log-page-directory.html @@ -0,0 +1,819 @@ + + + + + + +nvme-wdc-log-page-directory(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc log-page-directory <device> [--output-format=<normal|json|binary> -o <normal|json|binary>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, retrieves the log page directory which contains the list of +log page IDs supported by the drive. The --output-format option will format the output as +specified.

+

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. +Results for any other device are undefined.

+

On success it returns the log page directory information, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-o <format> +
+
+--output-format=<format> +
+
+

+ Set the reporting format to normal, json, or binary. Only one output format + can be used at a time. The default is normal. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +WDC log-page-directory example command : +

    +
    +
    +
    # nvme wdc log-page-directory /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-namespace-resize.1 b/Documentation/nvme-wdc-namespace-resize.1 new file mode 100644 index 0000000..aa48d9c --- /dev/null +++ b/Documentation/nvme-wdc-namespace-resize.1 @@ -0,0 +1,115 @@ +'\" t +.\" Title: nvme-wdc-namespace-resize +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 02/04/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-NAMESPACE" "1" "02/04/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-namespace-resize \- Resizes the device\*(Aqs namespace\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc namespace\-resize\fR [\-\-nsid=, \-n ] [\-\-op_option=, \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported by the device\&. +.sp +The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Namespace ID; ID of the namespace to resize +.RE +.PP +\-o , \-\-op\-option= +.RS 4 +Overprovisioning Option; defaults to 0xF +.sp +.if n \{\ +.RS 4 +.\} +.nf +Valid Values: +0x1 \- 7% of Original TNVMCAP reported value +0x2 \- 28% of Original TNVMCAP reported value +0x3 \- 50% of Original TNVMCAP reported value +0xF \- 0% of Original TNVMCAP reported value (original config) +All other values \- reserved +.fi +.if n \{\ +.RE +.\} +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Resizes namespace 1 to 50% of the orginal TNVMCAP reported value: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc namespace\-resize /dev/nvme0 \-n 1 \-o 3 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Resizes namespace 2 to 7% of the orginal TNVMCAP reported value: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc namespace\-resize /dev/nvme0 \-\-namespace\-id=2 \-\-op\-option=1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-namespace-resize.html b/Documentation/nvme-wdc-namespace-resize.html new file mode 100644 index 0000000..efebe9e --- /dev/null +++ b/Documentation/nvme-wdc-namespace-resize.html @@ -0,0 +1,841 @@ + + + + + +nvme-wdc-namespace-resize(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc namespace-resize <device> [--nsid=<NAMSPACE ID>, -n <NAMSPACE ID>] [--op_option=<OP OPTION>, -o <OP OPTION>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported +by the device.

+

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

+

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

+
+
+
+

OPTIONS

+
+
+
+-n <NAMSPACE ID> +
+
+--namespace-id=<NAMSPACE_ID> +
+
+

+ Namespace ID; ID of the namespace to resize +

+
+
+-o <OP OPTION> +
+
+--op-option=<OP OPTION> +
+
+

+ Overprovisioning Option; defaults to 0xF +

+
+
+
Valid Values:
+0x1 - 7% of Original TNVMCAP reported value
+0x2 - 28% of Original TNVMCAP reported value
+0x3 - 50% of Original TNVMCAP reported value
+0xF - 0% of Original TNVMCAP reported value (original config)
+All other values - reserved
+
+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Resizes namespace 1 to 50% of the orginal TNVMCAP reported value: +

    +
    +
    +
    # nvme wdc namespace-resize /dev/nvme0 -n 1 -o 3
    +
    +
    • +
  • +

    +Resizes namespace 2 to 7% of the orginal TNVMCAP reported value: +

    +
    +
    +
    # nvme wdc namespace-resize /dev/nvme0 --namespace-id=2 --op-option=1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-namespace-resize.txt b/Documentation/nvme-wdc-namespace-resize.txt new file mode 100644 index 0000000..288430f --- /dev/null +++ b/Documentation/nvme-wdc-namespace-resize.txt @@ -0,0 +1,56 @@ +nvme-wdc-namespace-resize(1) +============================ + +NAME +---- +nvme-wdc-namespace-resize - Resizes the device's namespace. + +SYNOPSIS +-------- +[verse] +'nvme wdc namespace-resize' [--nsid=, -n ] [--op_option=, -o ] + +DESCRIPTION +----------- + +For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported +by the device. + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +OPTIONS +------- +-n :: +--namespace-id=:: + Namespace ID; ID of the namespace to resize + +-o :: +--op-option=:: + Overprovisioning Option; defaults to 0xF + + Valid Values: + 0x1 - 7% of Original TNVMCAP reported value + 0x2 - 28% of Original TNVMCAP reported value + 0x3 - 50% of Original TNVMCAP reported value + 0xF - 0% of Original TNVMCAP reported value (original config) + All other values - reserved + +EXAMPLES +-------- +* Resizes namespace 1 to 50% of the orginal TNVMCAP reported value: ++ +------------ +# nvme wdc namespace-resize /dev/nvme0 -n 1 -o 3 +------------ +* Resizes namespace 2 to 7% of the orginal TNVMCAP reported value: ++ +------------ +# nvme wdc namespace-resize /dev/nvme0 --namespace-id=2 --op-option=1 +------------ + +NVME +---- +Part of the nvme-user suite. -- 2.49.0