From fb32fdeba1f428a3f6c30c8951e82f2a2eec23a8 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 12 Aug 2021 14:01:09 +0200 Subject: Merging upstream version 1.15. Signed-off-by: Daniel Baumann --- Documentation/nvme-admin-passthru.1 | 14 +- Documentation/nvme-admin-passthru.html | 26 +- Documentation/nvme-admin-passthru.txt | 5 + Documentation/nvme-capacity-mgmt.1 | 71 ++ Documentation/nvme-capacity-mgmt.html | 845 +++++++++++++++++++++++ Documentation/nvme-capacity-mgmt.txt | 54 ++ Documentation/nvme-compare.1 | 14 +- Documentation/nvme-compare.html | 27 +- Documentation/nvme-compare.txt | 6 + Documentation/nvme-connect-all.txt | 10 +- Documentation/nvme-connect.txt | 17 +- Documentation/nvme-discover.txt | 20 +- Documentation/nvme-get-feature.1 | 26 +- Documentation/nvme-get-feature.html | 33 +- Documentation/nvme-get-feature.txt | 9 + Documentation/nvme-get-lba-status.1 | 134 ++++ Documentation/nvme-get-lba-status.html | 903 +++++++++++++++++++++++++ Documentation/nvme-get-lba-status.txt | 82 +++ Documentation/nvme-get-log.1 | 40 +- Documentation/nvme-get-log.html | 53 +- Documentation/nvme-get-log.txt | 30 +- Documentation/nvme-id-domain.1 | 62 ++ Documentation/nvme-id-domain.html | 819 +++++++++++++++++++++++ Documentation/nvme-id-domain.txt | 40 ++ Documentation/nvme-id-iocs.1 | 43 +- Documentation/nvme-id-iocs.html | 38 +- Documentation/nvme-id-iocs.txt | 17 +- Documentation/nvme-io-passthru.1 | 14 +- Documentation/nvme-io-passthru.html | 21 +- Documentation/nvme-io-passthru.txt | 5 + Documentation/nvme-list-ctrl.1 | 18 +- Documentation/nvme-list-ctrl.html | 28 +- Documentation/nvme-list-ctrl.txt | 7 +- Documentation/nvme-list-ns.1 | 59 +- Documentation/nvme-list-ns.html | 37 +- Documentation/nvme-list-ns.txt | 19 +- Documentation/nvme-micron-smart-add-log.1 | 87 +++ Documentation/nvme-micron-smart-add-log.html | 815 +++++++++++++++++++++++ Documentation/nvme-micron-smart-add-log.txt | 54 ++ Documentation/nvme-primary-ctrl-caps.1 | 104 +++ Documentation/nvme-primary-ctrl-caps.html | 842 +++++++++++++++++++++++ Documentation/nvme-primary-ctrl-caps.txt | 53 ++ Documentation/nvme-read.1 | 14 +- Documentation/nvme-read.html | 17 +- Documentation/nvme-read.txt | 6 + Documentation/nvme-resv-register.1 | 2 +- Documentation/nvme-resv-register.html | 2 +- Documentation/nvme-resv-register.txt | 2 +- Documentation/nvme-set-feature.1 | 16 +- Documentation/nvme-set-feature.html | 27 +- Documentation/nvme-set-feature.txt | 7 + Documentation/nvme-verify.1 | 151 +++++ Documentation/nvme-verify.html | 961 +++++++++++++++++++++++++++ Documentation/nvme-verify.txt | 93 +++ Documentation/nvme-write-zeroes.1 | 34 +- Documentation/nvme-write-zeroes.html | 49 +- Documentation/nvme-write-zeroes.txt | 13 +- Documentation/nvme-write.1 | 14 +- Documentation/nvme-write.html | 17 +- Documentation/nvme-write.txt | 6 + Documentation/nvme-zns-close-zone.1 | 12 +- Documentation/nvme-zns-finish-zone.1 | 12 +- Documentation/nvme-zns-offline-zone.1 | 12 +- Documentation/nvme-zns-open-zone.1 | 12 +- Documentation/nvme-zns-reset-zone.1 | 10 +- Documentation/nvme-zns-set-zone-desc.1 | 10 +- Documentation/nvme-zns-zone-mgmt-send.1 | 16 +- 67 files changed, 6945 insertions(+), 171 deletions(-) create mode 100644 Documentation/nvme-capacity-mgmt.1 create mode 100644 Documentation/nvme-capacity-mgmt.html create mode 100644 Documentation/nvme-capacity-mgmt.txt create mode 100644 Documentation/nvme-get-lba-status.1 create mode 100644 Documentation/nvme-get-lba-status.html create mode 100644 Documentation/nvme-get-lba-status.txt create mode 100644 Documentation/nvme-id-domain.1 create mode 100644 Documentation/nvme-id-domain.html create mode 100644 Documentation/nvme-id-domain.txt create mode 100644 Documentation/nvme-micron-smart-add-log.1 create mode 100644 Documentation/nvme-micron-smart-add-log.html create mode 100644 Documentation/nvme-micron-smart-add-log.txt create mode 100644 Documentation/nvme-primary-ctrl-caps.1 create mode 100644 Documentation/nvme-primary-ctrl-caps.html create mode 100644 Documentation/nvme-primary-ctrl-caps.txt create mode 100644 Documentation/nvme-verify.1 create mode 100644 Documentation/nvme-verify.html create mode 100644 Documentation/nvme-verify.txt (limited to 'Documentation') diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index 286709f..8cf0095 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-admin-passthru -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 06/04/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "06/04/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,6 +46,7 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b] [\-\-prefill= | \-p ] + [\-\-latency | \-T] .fi .SH "DESCRIPTION" .sp @@ -123,6 +124,11 @@ Print the raw returned buffer to stdout if the command returns a structure\&. .RS 4 Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may be useful if the data you are writing is shorter than the required buffer, and you need to pad it with a known value\&. It may also be useful if you need to confirm if a device is overwriting a buffer for a data\-in command\&. .RE +.PP +\-T, \-\-latency +.RS 4 +Print out the latency the IOCTL took (in us)\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index 4a113ba..63a7a10 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -1,9 +1,10 @@ + - + nvme-admin-passthru(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme capacity-mgmt <device> [--operation=<operation> | -o <operation>]
+                        [--element-id=<element-id> | -i <element-id>]
+                        [--cap-lower=<cap-lower> | -l <cap-lower>]
+                        [--cap-upper=<cap-upper> | -u <cap-upper>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends a capacity management command to configure/create/delete +the Endurance Groups or NVM Sets with the requested operation and element_id. On success, +if the Operation is Create Endurance group or NVM Set, CQE CDW0 contains Created element +identifier else CQE CDW0 is reserved.

+

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

+
+
+
+

OPTIONS

+
+
+
+-o <operation> +
+
+--operation=<operation> +
+
+

+ Operation to be performed by the controller +

+
+
+-i <element-id> +
+
+--element-id=<element-id> +
+
+

+ Value specific to the value of the Operation field. +

+
+
+-l <cap-lower> +
+
+--cap-lower=<cap-lower> +
+
+

+ Least significant 32 bits of the capacity in bytes of the Endurance Group or + NVM Set to be created +

+
+
+-u <cap-upper> +
+
+--cap-upper=<cap-upper> +
+
+

+ Most significant 32 bits of the capacity in bytes of the Endurance Group or + NVM Set to be created +

+
+
+
+
+
+

EXAMPLES

+
+

No examples provided yet.

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-capacity-mgmt.txt b/Documentation/nvme-capacity-mgmt.txt new file mode 100644 index 0000000..96274cf --- /dev/null +++ b/Documentation/nvme-capacity-mgmt.txt @@ -0,0 +1,54 @@ +nvme-capacity-mgmt(1) +===================== + +NAME +---- +nvme-capacity-mgmt - Send capacity management command to configure/create/delete + Endurance Groups or NVM Sets, returns results. + +SYNOPSIS +-------- +[verse] +'nvme capacity-mgmt' [--operation= | -o ] + [--element-id= | -i ] + [--cap-lower= | -l ] + [--cap-upper= | -u ] + +DESCRIPTION +----------- +For the NVMe device given, sends a capacity management command to +configure/create/delete the Endurance Groups or NVM Sets with the requested +operation and element_id. On success, if the Operation is Create Endurance +group or NVM Set, CQE CDW0 contains Created element identifier else CQE CDW0 is +reserved. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--operation=:: + Operation to be performed by the controller + +-i :: +--element-id=:: + Value specific to the value of the Operation field. + +-l :: +--cap-lower=:: + Least significant 32 bits of the capacity in bytes of the Endurance Group or + NVM Set to be created + +-u :: +--cap-upper=:: + Most significant 32 bits of the capacity in bytes of the Endurance Group or + NVM Set to be created + +EXAMPLES +-------- +No examples provided yet. + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index 0638190..ada1790 100644 --- a/Documentation/nvme-compare.1 +++ b/Documentation/nvme-compare.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-compare -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 07/09/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "07/09/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -50,6 +50,7 @@ nvme-compare \- Send an NVMe Compare command, provide results [\-\-show\-command | \-v] [\-\-dry\-run | \-w] [\-\-latency | \-t] + [\-\-storage\-tag\-check | \-C ] .fi .SH "DESCRIPTION" .sp @@ -202,6 +203,11 @@ be set\&. Otherwise \-\-dry\-run option will be .RS 4 Print out the latency the IOCTL took (in us)\&. .RE +.PP +\-\-storage\-tag\-check=, \-C +.RS 4 +This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. diff --git a/Documentation/nvme-compare.html b/Documentation/nvme-compare.html index e3b6857..0c13e32 100644 --- a/Documentation/nvme-compare.html +++ b/Documentation/nvme-compare.html @@ -1,9 +1,10 @@ + - + nvme-compare(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme get-lba-status <device> [--namespace-id=<nsid> | -n <nsid>]
+                    [--start-lba=<slba> | -s <slba>]
+                    [--max-dw=<max-dw> | -m <max-dw>]
+                    [--action=<action-type> | -a <action-type>]
+                    [--range-len=<range-len> | -l <range-len>]
+                    [--timeout=<timeout> | -t <timeout> ]
+                   [--output-format=<format> | -o <format>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send an nvme Get LBA Status admin command +and provides the results.

+

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

+

On success, the returned get lba data structure may be returned in one of +several ways depending on the option flags; the structure may parsed by +the program and printed in a readable format or the raw buffer may be +printed to stdout for another program to parse.

+
+
+
+

OPTIONS

+
+
+
+-n <nsid> +
+
+--namespace-id=<nsid> +
+
+

+ Send the Get LBA Status command for the specified nsid. This can be + used to override the default value for either character device + (unspecified) or the block device (result from NVME_IOCTL_ID). +

+
+
+-s <slba> +
+
+--start-lba=<slba> +
+
+

+ Starting LBA(SLBA) in 64-bit address of the first logical block addressed +

+
+
+-m <max-dw> +
+
+--max-dw=<max-dw> +
+
+

+ Maximum Number of Dwords(MNDW) specifies maximum number of dwords to return +

+
+
+-a <action-type> +
+
+--action=<action-type> +
+
+

+ Action Type(ATYPE) specifies the mechanism it uses in determining the LBA Status Descriptors. +

+
+
+-l <range-len> +
+
+--range-len=<range-len> +
+
+

+ Range Length(RL) specifies the length of the range of contiguous LBAs beginning at SLBA +

+
+
+-t <timeout> +
+
+--timeout=<timeout> +
+
+

+ Override default timeout value. In milliseconds. +

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Get the LBA Status of the device using all defaults: +

    +
    +
    +
    # nvme get-lba-status /dev/nvme0n1
    +
    +
    • +
  • +

    +Get LBA Status of the namespace 1 from SLBA 10 for the max Dwords of 0x1000 +

    +
    +
    +
    # nvme get-lba-status /dev/nvme0 --namespace-id=1 --start-lba=10 --max-dw=0x1000
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-get-lba-status.txt b/Documentation/nvme-get-lba-status.txt new file mode 100644 index 0000000..157dc41 --- /dev/null +++ b/Documentation/nvme-get-lba-status.txt @@ -0,0 +1,82 @@ +nvme-get-lba-status(1) +====================== + +NAME +---- +nvme-get-lba-status - Get LBA Status from NVMe device + +SYNOPSIS +-------- +[verse] +'nvme get-lba-status' [--namespace-id= | -n ] + [--start-lba= | -s ] + [--max-dw= | -m ] + [--action= | -a ] + [--range-len= | -l ] + [--timeout= | -t ] + [--output-format= | -o ] + +DESCRIPTION +----------- +For the NVMe device given, send an nvme Get LBA Status admin command +and provides the results. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the returned get lba data structure may be returned in one of +several ways depending on the option flags; the structure may parsed by +the program and printed in a readable format or the raw buffer may be +printed to stdout for another program to parse. + +OPTIONS +------- +-n :: +--namespace-id=:: + Send the Get LBA Status command for the specified nsid. This can be + used to override the default value for either character device + (unspecified) or the block device (result from NVME_IOCTL_ID). + +-s :: +--start-lba=:: + Starting LBA(SLBA) in 64-bit address of the first logical block addressed + +-m :: +--max-dw=:: + Maximum Number of Dwords(MNDW) specifies maximum number of dwords to return + +-a :: +--action=:: + Action Type(ATYPE) specifies the mechanism it uses in determining the LBA Status Descriptors. + +-l :: +--range-len=:: + Range Length(RL) specifies the length of the range of contiguous LBAs beginning at SLBA + +-t :: +--timeout=:: + Override default timeout value. In milliseconds. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Get the LBA Status of the device using all defaults: ++ +------------ +# nvme get-lba-status /dev/nvme0n1 +------------ ++ + +* Get LBA Status of the namespace 1 from SLBA 10 for the max Dwords of 0x1000 ++ +------------ +# nvme get-lba-status /dev/nvme0 --namespace-id=1 --start-lba=10 --max-dw=0x1000 +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-get-log.1 b/Documentation/nvme-get-log.1 index 98f81a8..ccc5ab8 100644 --- a/Documentation/nvme-get-log.1 +++ b/Documentation/nvme-get-log.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-get-log -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 06/12/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-LOG" "1" "06/12/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,13 +33,16 @@ nvme-get-log \- Retrieves a log page from an NVMe device .sp .nf \fInvme get\-log\fR [\-\-log\-id= | \-i ] - [\-\-log\-len= | \-l ] - [\-\-aen= | \-a ] - [\-\-namespace\-id= | \-n ] - [\-\-raw\-binary | \-b] - [\-\-lpo= | \-o ] - [\-\-lsp= | \-s ] - [\-\-rae | \-r] + [\-\-log\-len= | \-l ] + [\-\-aen= | \-a ] + [\-\-namespace\-id= | \-n ] + [\-\-raw\-binary | \-b] + [\-\-lpo= | \-o ] + [\-\-lsp= | \-s ] + [\-\-lsi= | \-S ] + [\-\-rae | \-r] + [\-\-csi= | \-y ] + [\-\-ot | \-O] .fi .SH "DESCRIPTION" .sp @@ -85,10 +88,25 @@ The log page offset specifies the location within a log page to start returning The log specified field of LID\&. .RE .PP +\-S , \-\-lsi= +.RS 4 +The log specified field of Log Specific Identifier\&. +.RE +.PP \-r, \-\-rae .RS 4 Retain an Asynchronous Event\&. .RE +.PP +\-y , \-\-csi= +.RS 4 +This field specifies the identifier of command set\&. if not issued, NVM Command Set will be selected\&. +.RE +.PP +\-O, \-\-ot +.RS 4 +Offset Type +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-get-log.html b/Documentation/nvme-get-log.html index 9aa20e0..53af505 100644 --- a/Documentation/nvme-get-log.html +++ b/Documentation/nvme-get-log.html @@ -750,13 +750,16 @@ nvme-get-log(1) Manual Page 
nvme get-log <device> [--log-id=<log-id> | -i <log-id>]
-                      [--log-len=<log-len> | -l <log-len>]
-                      [--aen=<aen> | -a <aen>]
-                      [--namespace-id=<nsid> | -n <nsid>]
-                      [--raw-binary | -b]
-                      [--lpo=<offset> | -o <offset>]
-                      [--lsp=<field> | -s <field>]
-                      [--rae | -r]
+ [--log-len=<log-len> | -l <log-len>] + [--aen=<aen> | -a <aen>] + [--namespace-id=<nsid> | -n <nsid>] + [--raw-binary | -b] + [--lpo=<offset> | -o <offset>] + [--lsp=<field> | -s <field>] + [--lsi=<field> | -S <field>] + [--rae | -r] + [--csi=<command_set_identifier> | -y <command_set_identifier>] + [--ot | -O]
@@ -864,6 +867,17 @@ program to parse.

+-S <field> +
+
+--lsi=<field> +
+
+

+ The log specified field of Log Specific Identifier. +

+
+
-r
@@ -874,6 +888,29 @@ program to parse.

Retain an Asynchronous Event.

+
+-y <command_set_identifier> +
+
+--csi=<command_set_identifier> +
+
+

+ This field specifies the identifier of command set. + if not issued, NVM Command Set will be selected. +

+
+
+-O +
+
+--ot +
+
+

+ Offset Type +

+
@@ -918,7 +955,7 @@ Have the program return the raw log page in binary: diff --git a/Documentation/nvme-get-log.txt b/Documentation/nvme-get-log.txt index 1d49e28..d371f5d 100644 --- a/Documentation/nvme-get-log.txt +++ b/Documentation/nvme-get-log.txt @@ -9,13 +9,16 @@ SYNOPSIS -------- [verse] 'nvme get-log' [--log-id= | -i ] - [--log-len= | -l ] - [--aen= | -a ] - [--namespace-id= | -n ] - [--raw-binary | -b] - [--lpo= | -o ] - [--lsp= | -s ] - [--rae | -r] + [--log-len= | -l ] + [--aen= | -a ] + [--namespace-id= | -n ] + [--raw-binary | -b] + [--lpo= | -o ] + [--lsp= | -s ] + [--lsi= | -S ] + [--rae | -r] + [--csi= | -y ] + [--ot | -O] DESCRIPTION ----------- @@ -68,10 +71,23 @@ OPTIONS --lsp=:: The log specified field of LID. +-S :: +--lsi=:: + The log specified field of Log Specific Identifier. + -r:: --rae:: Retain an Asynchronous Event. +-y :: +--csi=:: + This field specifies the identifier of command set. + if not issued, NVM Command Set will be selected. + +-O:: +--ot:: + Offset Type + EXAMPLES -------- * Get 512 bytes from log page 2 diff --git a/Documentation/nvme-id-domain.1 b/Documentation/nvme-id-domain.1 new file mode 100644 index 0000000..ddd9c3f --- /dev/null +++ b/Documentation/nvme-id-domain.1 @@ -0,0 +1,62 @@ +'\" t +.\" Title: nvme-id-domain +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 07/20/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ID\-DOMAIN" "1" "07/20/2021" "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-id-domain \- Send NVMe Identify Domain List, return result and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme id\-domain\fR [\-\-dom\-id= | \-d ] + [\-o | \-\-output\-format=] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send an identify command and return the domian list data structure\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-d , \-\-dom\-id= +.RS 4 +Retrieve the identify domain list data structure for the given domain id\&. If this value is not given, domain id will be 0xffff\&. +.RE +.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\&. +.RE +.SH "EXAMPLES" +.sp +No examples yet\&. +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-id-domain.html b/Documentation/nvme-id-domain.html new file mode 100644 index 0000000..067cef0 --- /dev/null +++ b/Documentation/nvme-id-domain.html @@ -0,0 +1,819 @@ + + + + + + +nvme-id-domain(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme id-domain <device> [--dom-id=<domian_id> | -d <domian_id>]
+                        [-o <fmt> | --output-format=<fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send an identify command and return the domian list +data structure.

+

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

+
+
+
+

OPTIONS

+
+
+
+-d <domian_id> +
+
+--dom-id=<domian_id> +
+
+

+ Retrieve the identify domain list data structure for the given + domain id. If this value is not given, domain id will be 0xffff. +

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

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

+
+
+
+
+
+

EXAMPLES

+
+

No examples yet.

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-id-domain.txt b/Documentation/nvme-id-domain.txt new file mode 100644 index 0000000..be7b81a --- /dev/null +++ b/Documentation/nvme-id-domain.txt @@ -0,0 +1,40 @@ +nvme-id-domain(1) +================= + +NAME +---- +nvme-id-domain - Send NVMe Identify Domain List, return result and structure + +SYNOPSIS +-------- +[verse] +'nvme id-domain' [--dom-id= | -d ] + [-o | --output-format=] + +DESCRIPTION +----------- +For the NVMe device given, send an identify command and return the domian list +data structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-d :: +--dom-id=:: + Retrieve the identify domain list data structure for the given + domain id. If this value is not given, domain id will be 0xffff. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +No examples yet. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-id-iocs.1 b/Documentation/nvme-id-iocs.1 index f79b4de..2320de3 100644 --- a/Documentation/nvme-id-iocs.1 +++ b/Documentation/nvme-id-iocs.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-id-iocs -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 05/28/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-IOCS" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-IOCS" "1" "05/28/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,6 +33,7 @@ nvme-id-iocs \- Send NVMe Identify I/O Command Set, return result and structure .sp .nf \fInvme id\-iocs\fR [\-\-controller\-id= | \-c ] + [\-o | \-\-output\-format=] .fi .SH "DESCRIPTION" .sp @@ -45,6 +46,19 @@ The parameter is mandatory and may be either the NVMe character device .RS 4 Retrieve the identify I/O Command set data structure for the given cntid\&. If this value is not given, cntid will be 0xffff\&. .RE +.PP +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.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\&. +.RE .SH "EXAMPLES" .sp .RS 4 @@ -67,6 +81,27 @@ Have the program interpret the returned buffer and display the known fields in a .RE .\} .RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +show the fields in human readable format +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme id\-iocs /dev/nvme0 \-H +.fi +.if n \{\ +.RE +.\} +.RE .SH "NVME" .sp Part of the nvme\-user suite diff --git a/Documentation/nvme-id-iocs.html b/Documentation/nvme-id-iocs.html index 6bc983f..159f306 100644 --- a/Documentation/nvme-id-iocs.html +++ b/Documentation/nvme-id-iocs.html @@ -749,7 +749,8 @@ nvme-id-iocs(1) Manual Page

SYNOPSIS

-
nvme id-iocs <device> [--controller-id=<cntid> | -c <cntid>]
+
nvme id-iocs <device> [--controller-id=<cntid> | -c <cntid>]
+                        [-o <fmt> | --output-format=<fmt>]
@@ -779,6 +780,30 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

+
+-H +
+
+--human-readable +
+
+

+ This option will parse and format many of the bit fields + into human-readable formats. +

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

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

+
@@ -796,6 +821,15 @@ fields in a human readable format: 
# nvme id-iocs /dev/nvme0
+
  • +

    +show the fields in human readable format +

    +
    +
    +
    # nvme id-iocs /dev/nvme0 -H
    +
    +
    • @@ -810,7 +844,7 @@ fields in a human readable format: diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt index 9e53207..a35217e 100644 --- a/Documentation/nvme-id-iocs.txt +++ b/Documentation/nvme-id-iocs.txt @@ -9,6 +9,7 @@ SYNOPSIS -------- [verse] 'nvme id-iocs' [--controller-id= | -c ] + [-o | --output-format=] DESCRIPTION ----------- @@ -24,6 +25,15 @@ OPTIONS --controller-id=:: Retrieve the identify I/O Command set data structure for the given cntid. If this value is not given, cntid will be 0xffff. +-H:: +--human-readable:: + This option will parse and format many of the bit fields + into human-readable formats. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. EXAMPLES -------- @@ -33,7 +43,12 @@ fields in a human readable format: ------------ # nvme id-iocs /dev/nvme0 ------------ - ++ +* show the fields in human readable format ++ +------------ +# nvme id-iocs /dev/nvme0 -H +------------ NVME ---- Part of the nvme-user suite diff --git a/Documentation/nvme-io-passthru.1 b/Documentation/nvme-io-passthru.1 index b5e4322..ad913cc 100644 --- a/Documentation/nvme-io-passthru.1 +++ b/Documentation/nvme-io-passthru.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-io-passthru -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 06/04/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-IO\-PASSTHRU" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-IO\-PASSTHRU" "1" "06/04/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -47,6 +47,7 @@ nvme-io-passthru \- Submit an arbitrary io command, return results [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b] [\-\-prefill= | \-p ] + [\-\-latency | \-T] .fi .SH "DESCRIPTION" .sp @@ -125,6 +126,11 @@ Print the raw returned buffer to stdout if the command returns data or a structu .RS 4 Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may be useful if the data you are writing is shorter than the required buffer, and you need to pad it with a known value\&. It may also be useful if you need to confirm if a device is overwriting a buffer on a data\-in command\&. .RE +.PP +\-T, \-\-latency +.RS 4 +Print out the latency the IOCTL took (in us)\&. +.RE .SH "EXAMPLES" .sp nvme io\-passthru /dev/nvme0n1 \-\-opcode=2 \-\-namespace\-id=1 \-\-data\-len=4096 \-\-read \-\-cdw10=0 \-\-cdw11=0 \-\-cdw12=0x70000 \-\-raw\-binary diff --git a/Documentation/nvme-io-passthru.html b/Documentation/nvme-io-passthru.html index 96b9e1e..8463c5f 100644 --- a/Documentation/nvme-io-passthru.html +++ b/Documentation/nvme-io-passthru.html @@ -1,9 +1,10 @@ + - + nvme-io-passthru(1) + + + + +
    +
    +

    SYNOPSIS

    +
    +
    +
    nvme micron vs-smart-add-log <device>  -f <json|normal>
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +

    This command prints NAND information (Total bytes written, Bad block count and +Erase failures etc) for the given micron device if its of 2200 model controller. +For OCP complaint controllers this command print extended SMART health data +along with NAND information (if available)

    +

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

    +

    The -f option controls the displayed output data format based on the option +value. If the option value is json (which is enabled by default), output data +is printed in JSON format. If option value is normal the output is displayed +in non-JSON format.

    +

    This will only work on Micron devices devices of model numbers 54XX and OCP +complaint controllers. Support for new devices may be added subsequently.

    +
    +
    +
    +

    OPTIONS

    +
    +

    -f <json|normal> controls the format of displayed output.

    +
    +
    +
    +

    EXAMPLES

    +
    +
      +
    • +

      +Retrieve NAND/extended SMART data and display in json format +

      +
      +
      +
      # nvme micron vs-nand-stats /dev/nvme0
+
+* Retrieve NAND/extended SMART data and display in non-json format
++
      +
      +
      • +
    +

    # nvme micron vs-nand-stats /dev/nvme0 -f normal

    +
    +
    +
    NVME
    +
    +

    Part of the nvme-user suite

    +
    +
    +
    +
    + + + diff --git a/Documentation/nvme-micron-smart-add-log.txt b/Documentation/nvme-micron-smart-add-log.txt new file mode 100644 index 0000000..1fd74ba --- /dev/null +++ b/Documentation/nvme-micron-smart-add-log.txt @@ -0,0 +1,54 @@ +nvme-micron-smart-add-log(1) +============================ + +NAME +---- +nvme-micron-smart-add-log - Retrieves NAND statistics (2200 model drives) +or Extended SMART information (OCP complaint models) of given micron device + +SYNOPSIS +-------- +[verse] +'nvme micron vs-smart-add-log' -f + +DESCRIPTION +----------- +This command prints NAND information (Total bytes written, Bad block count and +Erase failures etc) for the given micron device if its of 2200 model controller. +For OCP complaint controllers this command print extended SMART health data +along with NAND information (if available) + +The parameter is mandatory and may be either the NVMe +character device (ex: /dev/nvme0), or a namespace block device (ex: +/dev/nvme0n1). + +The '-f' option controls the displayed output data format based on the option +value. If the option value is 'json' (which is enabled by default), output data +is printed in JSON format. If option value is 'normal' the output is displayed +in non-JSON format. + +This will only work on Micron devices devices of model numbers 54XX and OCP +complaint controllers. Support for new devices may be added subsequently. + +OPTIONS +------- +-f controls the format of displayed output. + + +EXAMPLES +-------- +* Retrieve NAND/extended SMART data and display in json format ++ +------------ +# nvme micron vs-nand-stats /dev/nvme0 + +* Retrieve NAND/extended SMART data and display in non-json format ++ +------------ +# nvme micron vs-nand-stats /dev/nvme0 -f normal + +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-primary-ctrl-caps.1 b/Documentation/nvme-primary-ctrl-caps.1 new file mode 100644 index 0000000..cdf7529 --- /dev/null +++ b/Documentation/nvme-primary-ctrl-caps.1 @@ -0,0 +1,104 @@ +'\" t +.\" Title: nvme-primary-ctrl-caps +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 05/11/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-PRIMARY\-CTRL\" "1" "05/11/2021" "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-primary-ctrl-caps \- Send identify Primary Controller Caps, return result and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme primary\-ctrl\-caps\fR [\-o | \-\-output\-format=] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends an identify primary Controller caps command and provides the result and returned structure\&. +.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 +On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. +.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\&. +.RE +.PP +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Get Primary Ctrl Caps of the device in default format +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme primary\-ctrl\-caps /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program interpret the returned buffer and display the known fields in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme primary\-ctrl\-caps /dev/nvme0 \-\-human\-readbale +# nvme primary\-ctrl\-caps /dev/nvme0 \-H +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-primary-ctrl-caps.html b/Documentation/nvme-primary-ctrl-caps.html new file mode 100644 index 0000000..3cae1a2 --- /dev/null +++ b/Documentation/nvme-primary-ctrl-caps.html @@ -0,0 +1,842 @@ + + + + + + +nvme-primary-ctrl-caps(1) + + + + + +
    +
    +

    SYNOPSIS

    +
    +
    +
    nvme primary-ctrl-caps <device> [-o <format> | --output-format=<format>]
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +

    For the NVMe device given, sends an identify primary Controller caps command and +provides the result and returned structure.

    +

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

    +

    On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout.

    +
    +
    +
    +

    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. +

    +
    +
    +-H +
    +
    +--human-readable +
    +
    +

    + This option will parse and format many of the bit fields + into human-readable formats. +

    +
    +
    +
    +
    +
    +

    EXAMPLES

    +
    +
      +
    • +

      +Get Primary Ctrl Caps of the device in default format +

      +
      +
      +
      # nvme primary-ctrl-caps /dev/nvme0
      +
      +
      • +
    • +

      +Has the program interpret the returned buffer and display the known +fields in a human readable format: +

      +
      +
      +
      # nvme primary-ctrl-caps /dev/nvme0 --human-readbale
+# nvme primary-ctrl-caps /dev/nvme0 -H
      +
      +
      • +
    +
    +
    +
    +

    NVME

    +
    +

    Part of the nvme-user suite

    +
    +
    +
    +
    + + + diff --git a/Documentation/nvme-primary-ctrl-caps.txt b/Documentation/nvme-primary-ctrl-caps.txt new file mode 100644 index 0000000..e17093f --- /dev/null +++ b/Documentation/nvme-primary-ctrl-caps.txt @@ -0,0 +1,53 @@ +nvme-primary-ctrl-caps(1) +========================= + +NAME +---- +nvme-primary-ctrl-caps - Send identify Primary Controller Caps, return result and structure + +SYNOPSIS +-------- +[verse] +'nvme primary-ctrl-caps' [-o | --output-format=] + +DESCRIPTION +----------- +For the NVMe device given, sends an identify primary Controller caps command and +provides the result and returned structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +-H:: +--human-readable:: + This option will parse and format many of the bit fields + into human-readable formats. + +EXAMPLES +-------- +* Get Primary Ctrl Caps of the device in default format ++ +------------ +# nvme primary-ctrl-caps /dev/nvme0 +------------ +* Has the program interpret the returned buffer and display the known +fields in a human readable format: ++ +------------ +# nvme primary-ctrl-caps /dev/nvme0 --human-readbale +# nvme primary-ctrl-caps /dev/nvme0 -H +------------ +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index 7ba8d6a..303fc05 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-read -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 07/09/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "07/09/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -50,6 +50,7 @@ nvme-read \- Send an NVMe Read command, provide results [\-\-show\-command | \-v] [\-\-dry\-run | \-w] [\-\-latency | \-t] + [\-\-storage\-tag\-check | \-C ] .fi .SH "DESCRIPTION" .sp @@ -178,6 +179,11 @@ be set\&. Otherwise \-\-dry\-run option will be .RS 4 Print out the latency the IOCTL took (in us)\&. .RE +.PP +\-\-storage\-tag\-check=, \-C +.RS 4 +This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. diff --git a/Documentation/nvme-read.html b/Documentation/nvme-read.html index fdc1606..d61580c 100644 --- a/Documentation/nvme-read.html +++ b/Documentation/nvme-read.html @@ -766,7 +766,8 @@ nvme-read(1) Manual Page [--dsm=<dsm> | -D <dsm>] [--show-command | -v] [--dry-run | -w] - [--latency | -t] + [--latency | -t] + [--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
    @@ -1013,6 +1014,18 @@ metadata is passes.

    Print out the latency the IOCTL took (in us).

    +
    +--storage-tag-check=<storage-tag-check> +
    +
    +-C <storage-tag-check> +
    +
    +

    + This bit specifies the Storage Tag field shall be checked as part of end-to-end + data protection processing. +

    +
    @@ -1033,7 +1046,7 @@ metadata is passes.

    diff --git a/Documentation/nvme-read.txt b/Documentation/nvme-read.txt index 55a701c..58902e7 100644 --- a/Documentation/nvme-read.txt +++ b/Documentation/nvme-read.txt @@ -26,6 +26,7 @@ SYNOPSIS [--show-command | -v] [--dry-run | -w] [--latency | -t] + [--storage-tag-check | -C ] DESCRIPTION ----------- @@ -128,6 +129,11 @@ metadata is passes. --latency:: Print out the latency the IOCTL took (in us). +--storage-tag-check=:: +-C :: + This bit specifies the Storage Tag field shall be checked as part of end-to-end + data protection processing. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-resv-register.1 b/Documentation/nvme-resv-register.1 index 48b391f..3d9a869 100644 --- a/Documentation/nvme-resv-register.1 +++ b/Documentation/nvme-resv-register.1 @@ -98,7 +98,7 @@ T} .sp 1 .RE .PP -\-a , \-\-rrega= +\-r , \-\-rrega= .RS 4 Reservation Register Action: This field specifies the registration action that is performed by the command\&. .TS diff --git a/Documentation/nvme-resv-register.html b/Documentation/nvme-resv-register.html index a17f869..15bec28 100644 --- a/Documentation/nvme-resv-register.html +++ b/Documentation/nvme-resv-register.html @@ -861,7 +861,7 @@ a power loss.

    --a <rrega> +-r <rrega>
    --rrega=<rrega> diff --git a/Documentation/nvme-resv-register.txt b/Documentation/nvme-resv-register.txt index 076e979..e0553f4 100644 --- a/Documentation/nvme-resv-register.txt +++ b/Documentation/nvme-resv-register.txt @@ -62,7 +62,7 @@ are cleared on a power on. a power loss. |================= --a :: +-r :: --rrega=:: Reservation Register Action: This field specifies the registration action that is performed by the command. diff --git a/Documentation/nvme-set-feature.1 b/Documentation/nvme-set-feature.1 index 913df38..57e8c08 100644 --- a/Documentation/nvme-set-feature.1 +++ b/Documentation/nvme-set-feature.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-set-feature -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 05/16/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SET\-FEATURE" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SET\-FEATURE" "1" "05/16/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,6 +34,7 @@ nvme-set-feature \- Sets an NVMe feature, returns applicable results .nf \fInvme set\-feature\fR [\-\-namespace\-id= | \-n ] [\-\-feature\-id= | \-f ] [\-\-value= | \-v ] + [\-\-uuid\-index= | \-U ] [\-\-data\-len= | \-l ] [\-\-data= | \-d ] [\-\-save| \-s] @@ -76,6 +77,11 @@ The value for command dword 11, the value you want to set the feature to\&. .RS 4 Save the attribute so that it persists through all power states and resets\&. .RE +.PP +\-U , \-\-uuid\-index= +.RS 4 +UUID Index of the feature +.RE .SH "EXAMPLES" .sp .RS 4 @@ -118,6 +124,8 @@ Sets the host id to the ascii string\&. .if n \{\ .RE .\} +.sp +nvme set\-feature /dev/nvme0 \-f 0x81 \-l 8 \-U 0x1 .RE .SH "NVME" .sp diff --git a/Documentation/nvme-set-feature.html b/Documentation/nvme-set-feature.html index b813b91..b5bf779 100644 --- a/Documentation/nvme-set-feature.html +++ b/Documentation/nvme-set-feature.html @@ -1,9 +1,10 @@ + - + nvme-set-feature(1) + + + + +
    +
    +

    SYNOPSIS

    +
    +
    +
    nvme-verify <device> [--namespace-id=<nsid> | -n <nsid>]
+            [--start-block=<slba> | -s <slba>]
+            [--block-count=<nlb> | -c <nlb>]
+            [--limited-retry | -l]
+            [--force-unit-access | -f]
+            [--prinfo=<prinfo> | -p <prinfo>]
+            [--ref-tag=<reftag> | -r <reftag>]
+            [--app-tag-mask=<appmask> | -m <appmask>]
+            [--app-tag=<apptag> | -a <apptag>]
+            [--storage-tag<storage-tag> | -S <storage-tag>]
+            [--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
    +
    +
    +
    +
    +
    +

    DESCRIPTION

    +
    +

    The Verify command verifies the integrity of the stored information by +reading data and metadata.

    +
    +
    +
    +

    OPTIONS

    +
    +
    +
    +--namespace-id=<nsid> +
    +
    +-n <nsid> +
    +
    +

    + Namespace ID use in the command. +

    +
    +
    +--start-block=<slba> +
    +
    +-s <slba> +
    +
    +

    + Start block address. +

    +
    +
    +--block-count=<nlb> +
    +
    +-c <nlb> +
    +
    +

    + Number of logical blocks to Verify. +

    +
    +
    +--limited-retry +
    +
    +-l +
    +
    +

    + Sets the limited retry flag. +

    +
    +
    +--force-unit-access +
    +
    +-f +
    +
    +

    + Set the force-unit access flag. +

    +
    +
    +--prinfo=<prinfo> +
    +
    +-p <prinfo> +
    +
    +

    + Protection Information field definition. +

    +
    + +++ + + + + + + + + + + + + + + + + + + + + + + + + + +

    Bit

    Description

    3

    PRACT: Protection Information Action. When set to 1, PI is stripped/inserted +on read/write when the block format’s metadata size is 8. When set to 0, +metadata is passes.

    2:0

    PRCHK: Protection Information Check:

    2

    Set to 1 enables checking the guard tag

    1

    Set to 1 enables checking the application tag

    0

    Set to 1 enables checking the reference tag

    +
    +
    +
    +--ref-tag=<reftag> +
    +
    +-r <reftag> +
    +
    +

    + Optional reftag when used with protection information. +

    +
    +
    +--app-tag-mask=<appmask> +
    +
    +-m <appmask> +
    +
    +

    + Optional application tag mask when used with protection information. +

    +
    +
    +--app-tag=<apptag> +
    +
    +-a <apptag> +
    +
    +

    + Optional application tag when used with protection information. +

    +
    +
    +--storage-tag=<storage-tag> +
    +
    +-S <storage-tag> +
    +
    +

    + Variable Sized Expected Logical Block Storage Tag(ELBST) and Expected Logical + Block Reference Tag (ELBRT), CDW2 and CDW3 (00:47) bits. +

    +
    +
    +--storage-tag-check=<storage-tag-check> +
    +
    +-C <storage-tag-check> +
    +
    +

    + This bit specifies the Storage Tag field shall be checked as part of Verify operation. +

    +
    +
    +
    +
    +
    +

    EXAMPLES

    +
    +

    No examples yet.

    +
    +
    +
    +

    NVME

    +
    +

    Part of the nvme-user suite

    +
    +
    +
    +
    + + + diff --git a/Documentation/nvme-verify.txt b/Documentation/nvme-verify.txt new file mode 100644 index 0000000..3dc2fc7 --- /dev/null +++ b/Documentation/nvme-verify.txt @@ -0,0 +1,93 @@ +nvme-verify(1) +============== + +NAME +---- +nvme-verify - Send an NVMe Verify command, return results + +SYNOPSIS +-------- +[verse] +'nvme-verify' [--namespace-id= | -n ] + [--start-block= | -s ] + [--block-count= | -c ] + [--limited-retry | -l] + [--force-unit-access | -f] + [--prinfo= | -p ] + [--ref-tag= | -r ] + [--app-tag-mask= | -m ] + [--app-tag= | -a ] + [--storage-tag | -S ] + [--storage-tag-check | -C ] + +DESCRIPTION +----------- +The Verify command verifies the integrity of the stored information by +reading data and metadata. + +OPTIONS +------- +--namespace-id=:: +-n :: + Namespace ID use in the command. + +--start-block=:: +-s :: + Start block address. + +--block-count=:: +-c :: + Number of logical blocks to Verify. + +--limited-retry:: +-l:: + Sets the limited retry flag. + +--force-unit-access:: +-f:: + Set the force-unit access flag. + +--prinfo=:: +-p :: + Protection Information field definition. ++ +[] +|================= +|Bit|Description +|3|PRACT: Protection Information Action. When set to 1, PI is stripped/inserted +on read/write when the block format's metadata size is 8. When set to 0, +metadata is passes. +|2:0|PRCHK: Protection Information Check: +|2|Set to 1 enables checking the guard tag +|1|Set to 1 enables checking the application tag +|0|Set to 1 enables checking the reference tag +|================= + +--ref-tag=:: +-r :: + Optional reftag when used with protection information. + +--app-tag-mask=:: +-m :: + Optional application tag mask when used with protection information. + +--app-tag=:: +-a :: + Optional application tag when used with protection information. + +--storage-tag=:: +-S :: + Variable Sized Expected Logical Block Storage Tag(ELBST) and Expected Logical + Block Reference Tag (ELBRT), CDW2 and CDW3 (00:47) bits. + +--storage-tag-check=:: +-C :: + This bit specifies the Storage Tag field shall be checked as part of Verify operation. + +EXAMPLES +-------- +No examples yet. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-write-zeroes.1 b/Documentation/nvme-write-zeroes.1 index d32e3ca..d7f06bb 100644 --- a/Documentation/nvme-write-zeroes.1 +++ b/Documentation/nvme-write-zeroes.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-zeroes -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 07/09/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ZEROES" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ZEROES" "1" "07/09/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -42,6 +42,8 @@ nvme-write-zeroes \- Send an NVMe write zeroes command, return results [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f] [\-\-namespace\-id= | \-n ] + [\-\-storage\-tag | \-S ] + [\-\-storage\-tag\-check | \-C ] .fi .SH "DESCRIPTION" .sp @@ -137,19 +139,19 @@ Set the force\-unit access flag\&. .RS 4 Namespace ID use in the command\&. .RE -.sp -EXAMPLES EXAMPLES -.sp -.if n \{\ +.PP +\-\-storage\-tag=, \-n .RS 4 -.\} -.nf -No examples yet\&. - -NVME -.fi -.if n \{\ +Variable Sized Expected Logical Block Storage Tag(ELBST) and Expected Logical Block Reference Tag (ELBRT), CDW2 and CDW3 (00:47) bits\&. .RE -.\} +.PP +\-\-storage\-tag\-check=, \-C +.RS 4 +This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&. +.RE +.SH "EXAMPLES" +.sp +No examples yet\&. +.SH "NVME" .sp Part of the nvme\-user suite diff --git a/Documentation/nvme-write-zeroes.html b/Documentation/nvme-write-zeroes.html index f3a3838..0912800 100644 --- a/Documentation/nvme-write-zeroes.html +++ b/Documentation/nvme-write-zeroes.html @@ -758,7 +758,9 @@ nvme-zeroes(1) Manual Page [--deac | -d] [--limited-retry | -l] [--force-unit-access | -f] - [--namespace-id=<nsid> | -n <nsid>] + [--namespace-id=<nsid> | -n <nsid>] + [--storage-tag<storage-tag> | -S <storage-tag>] + [--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
    @@ -920,15 +922,42 @@ metadata is passes.

    Namespace ID use in the command.

    +
    +--storage-tag=<storage-tag> +
    +
    +-n <storage-tag> +
    +
    +

    + Variable Sized Expected Logical Block Storage Tag(ELBST) and Expected Logical + Block Reference Tag (ELBRT), CDW2 and CDW3 (00:47) bits. +

    +
    +
    +--storage-tag-check=<storage-tag-check> +
    +
    +-C <storage-tag-check> +
    +
    +

    + This bit specifies the Storage Tag field shall be checked as part of end-to-end + data protection processing. +

    +
    -

    EXAMPLES -EXAMPLES

    -
    -
    -
    No examples yet.
-
-NVME
    -
    + + +
    +

    EXAMPLES

    +
    +

    No examples yet.

    +
    +
    +
    +

    NVME

    +

    Part of the nvme-user suite

    @@ -937,7 +966,7 @@ NVME diff --git a/Documentation/nvme-write-zeroes.txt b/Documentation/nvme-write-zeroes.txt index 02adee1..34fec9d 100644 --- a/Documentation/nvme-write-zeroes.txt +++ b/Documentation/nvme-write-zeroes.txt @@ -18,6 +18,8 @@ SYNOPSIS [--limited-retry | -l] [--force-unit-access | -f] [--namespace-id= | -n ] + [--storage-tag | -S ] + [--storage-tag-check | -C ] DESCRIPTION ----------- @@ -77,7 +79,16 @@ metadata is passes. -n :: Namespace ID use in the command. -EXAMPLES +--storage-tag=:: +-n :: + Variable Sized Expected Logical Block Storage Tag(ELBST) and Expected Logical + Block Reference Tag (ELBRT), CDW2 and CDW3 (00:47) bits. + +--storage-tag-check=:: +-C :: + This bit specifies the Storage Tag field shall be checked as part of end-to-end + data protection processing. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-write.1 b/Documentation/nvme-write.1 index 727ac03..b8e49e5 100644 --- a/Documentation/nvme-write.1 +++ b/Documentation/nvme-write.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-write -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 07/09/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WRITE" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-WRITE" "1" "07/09/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -50,6 +50,7 @@ nvme-write \- Send an NVMe write command, provide results [\-\-show\-command | \-v] [\-\-dry\-run | \-w] [\-\-latency | \-t] + [\-\-storage\-tag\-check | \-C ] .fi .SH "DESCRIPTION" .sp @@ -188,6 +189,11 @@ be set\&. Otherwise \-\-dry\-run option will be .RS 4 Print out the latency the IOCTL took (in us)\&. .RE +.PP +\-\-storage\-tag\-check=, \-C +.RS 4 +This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. diff --git a/Documentation/nvme-write.html b/Documentation/nvme-write.html index b59de9d..57dccc3 100644 --- a/Documentation/nvme-write.html +++ b/Documentation/nvme-write.html @@ -766,7 +766,8 @@ nvme-write(1) Manual Page [--dsm=<dsm> | -D <dsm>] [--show-command | -v] [--dry-run | -w] - [--latency | -t] + [--latency | -t] + [--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
    @@ -1035,6 +1036,18 @@ metadata is passes.

    Print out the latency the IOCTL took (in us).

    +
    +--storage-tag-check=<storage-tag-check> +
    +
    +-C <storage-tag-check> +
    +
    +

    + This bit specifies the Storage Tag field shall be checked as part of end-to-end + data protection processing. +

    +
    @@ -1055,7 +1068,7 @@ metadata is passes.

    diff --git a/Documentation/nvme-write.txt b/Documentation/nvme-write.txt index 2074f52..c48e6ae 100644 --- a/Documentation/nvme-write.txt +++ b/Documentation/nvme-write.txt @@ -26,6 +26,7 @@ SYNOPSIS [--show-command | -v] [--dry-run | -w] [--latency | -t] + [--storage-tag-check | -C ] DESCRIPTION ----------- @@ -136,6 +137,11 @@ metadata is passes. --latency:: Print out the latency the IOCTL took (in us). +--storage-tag-check=:: +-C :: + This bit specifies the Storage Tag field shall be checked as part of end-to-end + data protection processing. + EXAMPLES -------- No examples yet. diff --git a/Documentation/nvme-zns-close-zone.1 b/Documentation/nvme-zns-close-zone.1 index d9624c1..5f80a39 100644 --- a/Documentation/nvme-zns-close-zone.1 +++ b/Documentation/nvme-zns-close-zone.1 @@ -32,9 +32,10 @@ nvme-zns-close-zone \- Closes one or all zones .SH "SYNOPSIS" .sp .nf -\fInvme zns close\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-select\-all | \-a] +\fInvme zns close\-zone\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -57,6 +58,11 @@ The starting LBA of the zone to close\&. .RS 4 Select all zones for this action .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-zns-finish-zone.1 b/Documentation/nvme-zns-finish-zone.1 index 764c683..b34801f 100644 --- a/Documentation/nvme-zns-finish-zone.1 +++ b/Documentation/nvme-zns-finish-zone.1 @@ -32,9 +32,10 @@ nvme-zns-finish-zone \- Finishes one or all zones .SH "SYNOPSIS" .sp .nf -\fInvme zns finish\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-select\-all | \-a] +\fInvme zns finish\-zone\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -57,6 +58,11 @@ The starting LBA of the zone to finish\&. .RS 4 Select all zones for this action\&. .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-zns-offline-zone.1 b/Documentation/nvme-zns-offline-zone.1 index 9d2d083..2e6c178 100644 --- a/Documentation/nvme-zns-offline-zone.1 +++ b/Documentation/nvme-zns-offline-zone.1 @@ -32,9 +32,10 @@ nvme-zns-offline-zone \- Offlines one or all zones .SH "SYNOPSIS" .sp .nf -\fInvme zns offline\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-select\-all | \-a] +\fInvme zns offline\-zone\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -57,6 +58,11 @@ The starting LBA of the zone to offline\&. .RS 4 Select all zones for this action .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-zns-open-zone.1 b/Documentation/nvme-zns-open-zone.1 index 8ea78f2..4120942 100644 --- a/Documentation/nvme-zns-open-zone.1 +++ b/Documentation/nvme-zns-open-zone.1 @@ -32,9 +32,10 @@ nvme-zns-open-zone \- Opens one or all zones .SH "SYNOPSIS" .sp .nf -\fInvme zns open\-zone nvme zns id\-ctrl\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-select\-all | \-a] +\fInvme zns open\-zone\fR [\-\-namespace\-id= | \-n ] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -57,6 +58,11 @@ The starting LBA of the zone to open\&. .RS 4 Select all zones for this action .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-zns-reset-zone.1 b/Documentation/nvme-zns-reset-zone.1 index b02d042..7452e8b 100644 --- a/Documentation/nvme-zns-reset-zone.1 +++ b/Documentation/nvme-zns-reset-zone.1 @@ -33,8 +33,9 @@ nvme-zns-reset-zone \- Resets one or all zones .sp .nf \fInvme zns reset\-zone\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba= | \-s ] - [\-\-select\-all | \-a] + [\-\-start\-lba= | \-s ] + [\-\-select\-all | \-a] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -57,6 +58,11 @@ The starting LBA of the zone to reset\&. .RS 4 Select all zones for this action .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-zns-set-zone-desc.1 b/Documentation/nvme-zns-set-zone-desc.1 index a33b06a..7b9a52a 100644 --- a/Documentation/nvme-zns-set-zone-desc.1 +++ b/Documentation/nvme-zns-set-zone-desc.1 @@ -33,8 +33,9 @@ nvme-zns-set-zone-desc \- Set extended descriptor data for a zone .sp .nf \fInvme zns setzone\-desc\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba=, \-s ] - [\-data=, \-d ] + [\-\-start\-lba=, \-s ] + [\-data=, \-d ] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -55,6 +56,11 @@ The starting LBA of the zone to manage send\&. .RS 4 Optional file for data (default stdin) .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-zns-zone-mgmt-send.1 b/Documentation/nvme-zns-zone-mgmt-send.1 index f74d8a3..5b58bbc 100644 --- a/Documentation/nvme-zns-zone-mgmt-send.1 +++ b/Documentation/nvme-zns-zone-mgmt-send.1 @@ -33,11 +33,12 @@ nvme-zns-zone-mgmt-send \- Zone Management Send command .sp .nf \fInvme zns zone\-mgmt\-send\fR [\-\-namespace\-id= | \-n ] - [\-\-start\-lba=, \-s ] - [\-\-select\-all, \-a] - [\-\-zsa=, \-z ] - [\-\-data\-len=, \-l ] - [\-data=, \-d ] + [\-\-start\-lba=, \-s ] + [\-\-select\-all, \-a] + [\-\-zsa=, \-z ] + [\-\-data\-len=, \-l ] + [\-data=, \-d ] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -78,6 +79,11 @@ Buffer length if data required .RS 4 Optional file for data (default stdin) .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 -- cgit v1.2.3