From 5b7ddc4bd2dcdde201ffa2681ede9a0a029bad96 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 2 Jul 2021 22:47:46 +0200 Subject: Adding upstream version 1.14. Signed-off-by: Daniel Baumann --- Documentation/cmds-main.txt | 35 +- Documentation/nvme-admin-passthru.1 | 4 +- Documentation/nvme-ana-log.1 | 4 +- Documentation/nvme-attach-ns.1 | 4 +- Documentation/nvme-changed-ns-list-log.1 | 4 +- Documentation/nvme-compare.1 | 4 +- Documentation/nvme-connect-all.1 | 14 +- Documentation/nvme-connect-all.html | 10 +- Documentation/nvme-connect-all.txt | 5 +- Documentation/nvme-connect.1 | 10 +- Documentation/nvme-connect.html | 8 +- Documentation/nvme-connect.txt | 1 + Documentation/nvme-copy.1 | 141 +++ Documentation/nvme-copy.html | 989 +++++++++++++++ Documentation/nvme-copy.txt | 111 ++ Documentation/nvme-create-ns.1 | 10 +- Documentation/nvme-create-ns.html | 27 +- Documentation/nvme-create-ns.txt | 6 + Documentation/nvme-delete-ns.1 | 4 +- Documentation/nvme-dera-stat.1 | 4 +- Documentation/nvme-detach-ns.1 | 4 +- Documentation/nvme-device-self-test.1 | 4 +- Documentation/nvme-dir-receive.1 | 4 +- Documentation/nvme-dir-send.1 | 4 +- Documentation/nvme-disconnect-all.1 | 4 +- Documentation/nvme-disconnect.1 | 4 +- Documentation/nvme-discover.1 | 10 +- Documentation/nvme-discover.html | 8 +- Documentation/nvme-discover.txt | 13 + Documentation/nvme-dsm.1 | 4 +- Documentation/nvme-effects-log.1 | 4 +- Documentation/nvme-endurance-event-agg-log.1 | 112 ++ Documentation/nvme-endurance-event-agg-log.html | 858 +++++++++++++ Documentation/nvme-endurance-event-agg-log.txt | 66 + Documentation/nvme-endurance-log.1 | 4 +- Documentation/nvme-endurance-log.html | 2 +- Documentation/nvme-error-log.1 | 4 +- Documentation/nvme-flush.1 | 4 +- Documentation/nvme-format.1 | 4 +- Documentation/nvme-fw-commit.1 | 4 +- Documentation/nvme-fw-download.1 | 4 +- Documentation/nvme-fw-log.1 | 4 +- Documentation/nvme-gen-hostnqn.1 | 4 +- Documentation/nvme-get-feature.1 | 4 +- Documentation/nvme-get-log.1 | 4 +- Documentation/nvme-get-ns-id.1 | 4 +- Documentation/nvme-get-ns-id.html | 14 +- Documentation/nvme-get-property.1 | 4 +- Documentation/nvme-help.1 | 4 +- Documentation/nvme-huawei-id-ctrl.1 | 4 +- Documentation/nvme-huawei-list.1 | 4 +- Documentation/nvme-id-ctrl.1 | 4 +- Documentation/nvme-id-iocs.1 | 72 ++ Documentation/nvme-id-iocs.html | 817 +++++++++++++ Documentation/nvme-id-iocs.txt | 39 + Documentation/nvme-id-ns.1 | 4 +- Documentation/nvme-id-nvmset.1 | 4 +- Documentation/nvme-intel-id-ctrl.1 | 4 +- Documentation/nvme-intel-internal-log.1 | 4 +- Documentation/nvme-intel-lat-stats.1 | 4 +- Documentation/nvme-intel-market-name.1 | 4 +- Documentation/nvme-intel-smart-log-add.1 | 4 +- Documentation/nvme-intel-temp-stats.1 | 4 +- Documentation/nvme-intel-temp-stats.html | 14 +- Documentation/nvme-io-passthru.1 | 4 +- Documentation/nvme-lba-status-log.1 | 105 ++ Documentation/nvme-lba-status-log.html | 838 +++++++++++++ Documentation/nvme-lba-status-log.txt | 54 + Documentation/nvme-list-ctrl.1 | 4 +- Documentation/nvme-list-ns.1 | 10 +- Documentation/nvme-list-ns.html | 20 +- Documentation/nvme-list-ns.txt | 6 + Documentation/nvme-list-subsys.1 | 4 +- Documentation/nvme-list.1 | 4 +- Documentation/nvme-lnvm-create.1 | 4 +- Documentation/nvme-lnvm-diag-bbtbl.1 | 4 +- Documentation/nvme-lnvm-diag-set-bbtbl.1 | 4 +- Documentation/nvme-lnvm-factory.1 | 4 +- Documentation/nvme-lnvm-id-ns.1 | 4 +- Documentation/nvme-lnvm-info.1 | 4 +- Documentation/nvme-lnvm-init.1 | 4 +- Documentation/nvme-lnvm-list.1 | 4 +- Documentation/nvme-lnvm-remove.1 | 4 +- Documentation/nvme-micron-clear-pcie-errors.1 | 71 ++ Documentation/nvme-micron-clear-pcie-errors.html | 803 +++++++++++++ Documentation/nvme-micron-clear-pcie-errors.txt | 39 + Documentation/nvme-micron-internal-log.1 | 74 ++ Documentation/nvme-micron-internal-log.html | 818 +++++++++++++ Documentation/nvme-micron-internal-log.txt | 43 + Documentation/nvme-micron-nand-stats.1 | 71 ++ Documentation/nvme-micron-nand-stats.html | 804 +++++++++++++ Documentation/nvme-micron-nand-stats.txt | 40 + Documentation/nvme-micron-pcie-stats.1 | 71 ++ Documentation/nvme-micron-pcie-stats.html | 804 +++++++++++++ Documentation/nvme-micron-pcie-stats.txt | 40 + Documentation/nvme-micron-selective-download.1 | 139 +++ Documentation/nvme-micron-selective-download.html | 874 ++++++++++++++ Documentation/nvme-micron-selective-download.txt | 63 + Documentation/nvme-micron-temperature-stats.1 | 71 ++ Documentation/nvme-micron-temperature-stats.html | 804 +++++++++++++ Documentation/nvme-micron-temperature-stats.txt | 40 + Documentation/nvme-netapp-ontapdevices.1 | 4 +- Documentation/nvme-netapp-smdevices.1 | 4 +- Documentation/nvme-ns-descs.1 | 4 +- Documentation/nvme-ns-rescan.1 | 4 +- Documentation/nvme-ns-rescan.html | 1256 +++++++++++++------- Documentation/nvme-nvm-id-ctrl.1 | 98 ++ Documentation/nvme-nvm-id-ctrl.html | 828 +++++++++++++ Documentation/nvme-nvm-id-ctrl.txt | 49 + Documentation/nvme-persistent-event-log.1 | 118 ++ Documentation/nvme-persistent-event-log.html | 874 ++++++++++++++ Documentation/nvme-persistent-event-log.txt | 76 ++ Documentation/nvme-pred-lat-event-agg-log.1 | 117 ++ Documentation/nvme-pred-lat-event-agg-log.html | 870 ++++++++++++++ Documentation/nvme-pred-lat-event-agg-log.txt | 72 ++ Documentation/nvme-predictable-lat-log.1 | 112 ++ Documentation/nvme-predictable-lat-log.html | 857 +++++++++++++ Documentation/nvme-predictable-lat-log.txt | 66 + Documentation/nvme-read.1 | 4 +- Documentation/nvme-reset.1 | 4 +- Documentation/nvme-resv-acquire.1 | 6 +- Documentation/nvme-resv-acquire.html | 2 +- Documentation/nvme-resv-acquire.txt | 2 +- Documentation/nvme-resv-notif-log.1 | 98 ++ Documentation/nvme-resv-notif-log.html | 829 +++++++++++++ Documentation/nvme-resv-notif-log.txt | 51 + Documentation/nvme-resv-register.1 | 4 +- Documentation/nvme-resv-release.1 | 6 +- Documentation/nvme-resv-release.html | 2 +- Documentation/nvme-resv-release.txt | 2 +- Documentation/nvme-resv-report.1 | 4 +- Documentation/nvme-resv-report.html | 7 +- Documentation/nvme-rpmb.1 | 326 +++++ Documentation/nvme-rpmb.html | 1008 ++++++++++++++++ Documentation/nvme-rpmb.txt | 150 +++ Documentation/nvme-sanitize-log.1 | 15 +- Documentation/nvme-sanitize-log.html | 15 +- Documentation/nvme-sanitize-log.txt | 6 +- Documentation/nvme-sanitize.1 | 4 +- Documentation/nvme-security-recv.1 | 4 +- Documentation/nvme-security-send.1 | 4 +- Documentation/nvme-self-test-log.1 | 16 +- Documentation/nvme-self-test-log.html | 30 +- Documentation/nvme-self-test-log.txt | 9 +- Documentation/nvme-set-feature.1 | 4 +- Documentation/nvme-set-property.1 | 4 +- Documentation/nvme-show-hostnqn.1 | 4 +- Documentation/nvme-show-regs.1 | 4 +- Documentation/nvme-smart-log.1 | 4 +- Documentation/nvme-smart-log.html | 14 +- Documentation/nvme-subsystem-reset.1 | 4 +- Documentation/nvme-telemetry-log.1 | 4 +- .../nvme-toshiba-clear-pcie-correctable-errors.1 | 4 +- Documentation/nvme-toshiba-vs-internal-log.1 | 4 +- Documentation/nvme-toshiba-vs-smart-add-log.1 | 4 +- Documentation/nvme-transcend-badblock.1 | 4 +- Documentation/nvme-transcend-healthvalue.1 | 4 +- .../nvme-virtium-save-smart-to-vtview-log.1 | 4 +- Documentation/nvme-virtium-show-identify.1 | 4 +- Documentation/nvme-wdc-cap-diag.1 | 4 +- Documentation/nvme-wdc-capabilities.1 | 68 ++ Documentation/nvme-wdc-capabilities.html | 796 +++++++++++++ Documentation/nvme-wdc-capabilities.txt | 32 + Documentation/nvme-wdc-clear-assert-dump.1 | 4 +- Documentation/nvme-wdc-clear-fw-activate-history.1 | 4 +- .../nvme-wdc-clear-pcie-correctable-errors.1 | 4 +- Documentation/nvme-wdc-cloud-SSD-plugin-version.1 | 68 ++ .../nvme-wdc-cloud-SSD-plugin-version.html | 793 ++++++++++++ .../nvme-wdc-cloud-SSD-plugin-version.txt | 33 + Documentation/nvme-wdc-drive-essentials.1 | 4 +- Documentation/nvme-wdc-drive-log.1 | 4 +- Documentation/nvme-wdc-drive-resize.1 | 4 +- Documentation/nvme-wdc-enc-get-log.1 | 104 ++ Documentation/nvme-wdc-enc-get-log.html | 839 +++++++++++++ Documentation/nvme-wdc-enc-get-log.txt | 54 + Documentation/nvme-wdc-get-crash-dump.1 | 4 +- Documentation/nvme-wdc-get-drive-status.1 | 4 +- Documentation/nvme-wdc-get-pfail-dump.1 | 4 +- Documentation/nvme-wdc-id-ctrl.1 | 4 +- Documentation/nvme-wdc-log-page-directory.1 | 4 +- Documentation/nvme-wdc-namespace-resize.1 | 4 +- Documentation/nvme-wdc-purge-monitor.1 | 4 +- Documentation/nvme-wdc-purge.1 | 4 +- Documentation/nvme-wdc-vs-drive-info.1 | 4 +- .../nvme-wdc-vs-error-reason-identifier.1 | 4 +- Documentation/nvme-wdc-vs-fw-activate-history.1 | 4 +- Documentation/nvme-wdc-vs-internal-log.1 | 6 +- Documentation/nvme-wdc-vs-internal-log.html | 8 +- Documentation/nvme-wdc-vs-internal-log.txt | 30 +- Documentation/nvme-wdc-vs-nand-stats.1 | 4 +- Documentation/nvme-wdc-vs-nand-stats.html | 12 +- Documentation/nvme-wdc-vs-smart-add-log.1 | 421 +------ Documentation/nvme-wdc-vs-smart-add-log.html | 335 +----- Documentation/nvme-wdc-vs-smart-add-log.txt | 226 +--- .../nvme-wdc-vs-telemetry-controller-option.1 | 4 +- Documentation/nvme-wdc-vs-temperature-stats.1 | 179 +++ Documentation/nvme-wdc-vs-temperature-stats.html | 864 ++++++++++++++ Documentation/nvme-wdc-vs-temperature-stats.txt | 78 ++ Documentation/nvme-write-uncor.1 | 4 +- Documentation/nvme-write-zeroes.1 | 4 +- Documentation/nvme-write.1 | 4 +- Documentation/nvme-zns-changed-zone-list.1 | 105 ++ Documentation/nvme-zns-changed-zone-list.html | 840 +++++++++++++ Documentation/nvme-zns-changed-zone-list.txt | 54 + Documentation/nvme-zns-close-zone.1 | 84 ++ Documentation/nvme-zns-close-zone.html | 841 +++++++++++++ Documentation/nvme-zns-close-zone.txt | 49 + Documentation/nvme-zns-finish-zone.1 | 84 ++ Documentation/nvme-zns-finish-zone.html | 842 +++++++++++++ Documentation/nvme-zns-finish-zone.txt | 50 + Documentation/nvme-zns-id-ctrl.1 | 98 ++ Documentation/nvme-zns-id-ctrl.html | 828 +++++++++++++ Documentation/nvme-zns-id-ctrl.txt | 50 + Documentation/nvme-zns-id-ns.1 | 110 ++ Documentation/nvme-zns-id-ns.html | 854 +++++++++++++ Documentation/nvme-zns-id-ns.txt | 62 + Documentation/nvme-zns-offline-zone.1 | 84 ++ Documentation/nvme-zns-offline-zone.html | 841 +++++++++++++ Documentation/nvme-zns-offline-zone.txt | 49 + Documentation/nvme-zns-open-zone.1 | 84 ++ Documentation/nvme-zns-open-zone.html | 841 +++++++++++++ Documentation/nvme-zns-open-zone.txt | 49 + Documentation/nvme-zns-report-zones.1 | 198 +++ Documentation/nvme-zns-report-zones.html | 964 +++++++++++++++ Documentation/nvme-zns-report-zones.txt | 102 ++ Documentation/nvme-zns-reset-zone.1 | 84 ++ Documentation/nvme-zns-reset-zone.html | 842 +++++++++++++ Documentation/nvme-zns-reset-zone.txt | 50 + Documentation/nvme-zns-set-zone-desc.1 | 82 ++ Documentation/nvme-zns-set-zone-desc.html | 842 +++++++++++++ Documentation/nvme-zns-set-zone-desc.txt | 50 + Documentation/nvme-zns-zone-append.1 | 133 +++ Documentation/nvme-zns-zone-append.html | 947 +++++++++++++++ Documentation/nvme-zns-zone-append.txt | 96 ++ Documentation/nvme-zns-zone-mgmt-recv.1 | 121 ++ Documentation/nvme-zns-zone-mgmt-recv.html | 889 ++++++++++++++ Documentation/nvme-zns-zone-mgmt-recv.txt | 78 ++ Documentation/nvme-zns-zone-mgmt-send.1 | 126 ++ Documentation/nvme-zns-zone-mgmt-send.html | 899 ++++++++++++++ Documentation/nvme-zns-zone-mgmt-send.txt | 77 ++ Documentation/nvme.1 | 63 +- Documentation/nvme.html | 92 +- 242 files changed, 35455 insertions(+), 1606 deletions(-) create mode 100644 Documentation/nvme-copy.1 create mode 100644 Documentation/nvme-copy.html create mode 100644 Documentation/nvme-copy.txt create mode 100644 Documentation/nvme-endurance-event-agg-log.1 create mode 100644 Documentation/nvme-endurance-event-agg-log.html create mode 100644 Documentation/nvme-endurance-event-agg-log.txt create mode 100644 Documentation/nvme-id-iocs.1 create mode 100644 Documentation/nvme-id-iocs.html create mode 100644 Documentation/nvme-id-iocs.txt create mode 100644 Documentation/nvme-lba-status-log.1 create mode 100644 Documentation/nvme-lba-status-log.html create mode 100644 Documentation/nvme-lba-status-log.txt create mode 100644 Documentation/nvme-micron-clear-pcie-errors.1 create mode 100644 Documentation/nvme-micron-clear-pcie-errors.html create mode 100644 Documentation/nvme-micron-clear-pcie-errors.txt create mode 100644 Documentation/nvme-micron-internal-log.1 create mode 100644 Documentation/nvme-micron-internal-log.html create mode 100644 Documentation/nvme-micron-internal-log.txt create mode 100644 Documentation/nvme-micron-nand-stats.1 create mode 100644 Documentation/nvme-micron-nand-stats.html create mode 100644 Documentation/nvme-micron-nand-stats.txt create mode 100644 Documentation/nvme-micron-pcie-stats.1 create mode 100644 Documentation/nvme-micron-pcie-stats.html create mode 100644 Documentation/nvme-micron-pcie-stats.txt create mode 100644 Documentation/nvme-micron-selective-download.1 create mode 100644 Documentation/nvme-micron-selective-download.html create mode 100644 Documentation/nvme-micron-selective-download.txt create mode 100644 Documentation/nvme-micron-temperature-stats.1 create mode 100644 Documentation/nvme-micron-temperature-stats.html create mode 100644 Documentation/nvme-micron-temperature-stats.txt create mode 100644 Documentation/nvme-nvm-id-ctrl.1 create mode 100644 Documentation/nvme-nvm-id-ctrl.html create mode 100644 Documentation/nvme-nvm-id-ctrl.txt create mode 100644 Documentation/nvme-persistent-event-log.1 create mode 100644 Documentation/nvme-persistent-event-log.html create mode 100644 Documentation/nvme-persistent-event-log.txt create mode 100644 Documentation/nvme-pred-lat-event-agg-log.1 create mode 100644 Documentation/nvme-pred-lat-event-agg-log.html create mode 100644 Documentation/nvme-pred-lat-event-agg-log.txt create mode 100644 Documentation/nvme-predictable-lat-log.1 create mode 100644 Documentation/nvme-predictable-lat-log.html create mode 100644 Documentation/nvme-predictable-lat-log.txt create mode 100644 Documentation/nvme-resv-notif-log.1 create mode 100644 Documentation/nvme-resv-notif-log.html create mode 100644 Documentation/nvme-resv-notif-log.txt create mode 100644 Documentation/nvme-rpmb.1 create mode 100644 Documentation/nvme-rpmb.html create mode 100644 Documentation/nvme-rpmb.txt create mode 100644 Documentation/nvme-wdc-capabilities.1 create mode 100644 Documentation/nvme-wdc-capabilities.html create mode 100644 Documentation/nvme-wdc-capabilities.txt create mode 100644 Documentation/nvme-wdc-cloud-SSD-plugin-version.1 create mode 100644 Documentation/nvme-wdc-cloud-SSD-plugin-version.html create mode 100644 Documentation/nvme-wdc-cloud-SSD-plugin-version.txt 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 create mode 100644 Documentation/nvme-wdc-vs-temperature-stats.1 create mode 100644 Documentation/nvme-wdc-vs-temperature-stats.html create mode 100644 Documentation/nvme-wdc-vs-temperature-stats.txt create mode 100644 Documentation/nvme-zns-changed-zone-list.1 create mode 100644 Documentation/nvme-zns-changed-zone-list.html create mode 100644 Documentation/nvme-zns-changed-zone-list.txt create mode 100644 Documentation/nvme-zns-close-zone.1 create mode 100644 Documentation/nvme-zns-close-zone.html create mode 100644 Documentation/nvme-zns-close-zone.txt create mode 100644 Documentation/nvme-zns-finish-zone.1 create mode 100644 Documentation/nvme-zns-finish-zone.html create mode 100644 Documentation/nvme-zns-finish-zone.txt create mode 100644 Documentation/nvme-zns-id-ctrl.1 create mode 100644 Documentation/nvme-zns-id-ctrl.html create mode 100644 Documentation/nvme-zns-id-ctrl.txt create mode 100644 Documentation/nvme-zns-id-ns.1 create mode 100644 Documentation/nvme-zns-id-ns.html create mode 100644 Documentation/nvme-zns-id-ns.txt create mode 100644 Documentation/nvme-zns-offline-zone.1 create mode 100644 Documentation/nvme-zns-offline-zone.html create mode 100644 Documentation/nvme-zns-offline-zone.txt create mode 100644 Documentation/nvme-zns-open-zone.1 create mode 100644 Documentation/nvme-zns-open-zone.html create mode 100644 Documentation/nvme-zns-open-zone.txt create mode 100644 Documentation/nvme-zns-report-zones.1 create mode 100644 Documentation/nvme-zns-report-zones.html create mode 100644 Documentation/nvme-zns-report-zones.txt create mode 100644 Documentation/nvme-zns-reset-zone.1 create mode 100644 Documentation/nvme-zns-reset-zone.html create mode 100644 Documentation/nvme-zns-reset-zone.txt create mode 100644 Documentation/nvme-zns-set-zone-desc.1 create mode 100644 Documentation/nvme-zns-set-zone-desc.html create mode 100644 Documentation/nvme-zns-set-zone-desc.txt create mode 100644 Documentation/nvme-zns-zone-append.1 create mode 100644 Documentation/nvme-zns-zone-append.html create mode 100644 Documentation/nvme-zns-zone-append.txt create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.1 create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.html create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.txt create mode 100644 Documentation/nvme-zns-zone-mgmt-send.1 create mode 100644 Documentation/nvme-zns-zone-mgmt-send.html create mode 100644 Documentation/nvme-zns-zone-mgmt-send.txt (limited to 'Documentation') diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt index 824ca69..46df03d 100644 --- a/Documentation/cmds-main.txt +++ b/Documentation/cmds-main.txt @@ -17,7 +17,10 @@ linknvme:nvme-format[1]:: Format namespace(s) linknvme:nvme-fw-activate[1]:: - F/W Activate + F/W Activate (in old version < 1.2) + +linknvme:nvme-fw-commit[1]:: + F/W Commit (in > 1.2) linknvme:nvme-fw-download[1]:: F/W Download @@ -34,15 +37,24 @@ linknvme:nvme-get-log[1]:: linknvme:nvme-telemetry-log[1]:: Telemetry Host-Initiated Log +linknvme:nvme-changed-ns-list-log[1]:: + Retrieve Changed Namespace List Log + linknvme:nvme-smart-log[1]:: Retrieve Smart Log +linknvme:nvme-ana-log[1]:: + Retreive ANA(Asymmetric Namespace Access) Log + linknvme:nvme-endurance-log[1]:: Retrieve endurance Log linknvme:nvme-effects-log[1]:: Retrieve effects Log +linknvme:nvme-self-test-log[1]:: + Retrieve Device Self-test Log + linknvme:nvme-get-ns-id[1]:: Retrieve namespace identifier @@ -55,6 +67,12 @@ linknvme:nvme-id-ctrl[1]:: linknvme:nvme-id-ns[1]:: Identify Namespace +linknvme:nvme-id-nvmset[1]:: + Identify NVM Set List + +linknvme:nvme-id-iocs[1]:: + Identify I/O Command Set + linknvme:nvme-create-ns[1]:: Create a new namespace @@ -82,6 +100,15 @@ linknvme:nvme-list[1]:: linknvme:nvme-list-ctrl[1]:: List controller in NVMe subsystem +linknvme:nvme-list-subsys[1]:: + List NVMe subsystems + +linknvme:nvme-reset[1]:: + Reset a NVMe controller + +linknvme:nvme-device-self-test[1]:: + Issue Device Self-test Command + linknvme:nvme-read[1]:: Issue IO Read Command @@ -112,6 +139,12 @@ linknvme:nvme-security-recv[1]:: linknvme:nvme-security-send[1]:: Security Send +linknvme:nvme-dsm[1]:: + Issue Data Set Management Command + +linknvme:nvme-copy[1]:: + Issue Simple Copy Command + linknvme:nvme-set-feature[1]:: Set Feature diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index f6d247f..286709f 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -2,12 +2,12 @@ .\" Title: nvme-admin-passthru .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ana-log.1 b/Documentation/nvme-ana-log.1 index 862f42d..5ba4cc3 100644 --- a/Documentation/nvme-ana-log.1 +++ b/Documentation/nvme-ana-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ana-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ANA\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ANA\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index 0af22ae..37f63a8 100644 --- a/Documentation/nvme-attach-ns.1 +++ b/Documentation/nvme-attach-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-attach-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ATTACH\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ATTACH\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-changed-ns-list-log.1 b/Documentation/nvme-changed-ns-list-log.1 index 13dda55..97372fd 100644 --- a/Documentation/nvme-changed-ns-list-log.1 +++ b/Documentation/nvme-changed-ns-list-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-changed-ns-list-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CHANGED\-NS\-L" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CHANGED\-NS\-L" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1 index 0f1c6ff..0638190 100644 --- a/Documentation/nvme-compare.1 +++ b/Documentation/nvme-compare.1 @@ -2,12 +2,12 @@ .\" Title: nvme-compare .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-COMPARE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-COMPARE" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index f829935..a53a017 100644 --- a/Documentation/nvme-connect-all.1 +++ b/Documentation/nvme-connect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect-all .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/29/2020 +.\" Date: 01/20/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT\-ALL" "1" "04/29/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT\-ALL" "1" "01/20/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -51,7 +51,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&. [\-\-queue\-size=<#> | \-Q <#>] [\-\-matching | \-m] [\-\-persistent | \-p] - [\-\-quiet | \-q] + [\-\-quiet | \-S] .fi .SH "DESCRIPTION" .sp @@ -72,6 +72,7 @@ allbox tab(:); lt lt lt lt lt lt +lt lt lt lt. T{ Value @@ -90,6 +91,11 @@ T}:T{ The network fabric is a Fibre Channel network\&. T} T{ +tcp +T}:T{ +The network fabric is a TCP/IP network\&. +T} +T{ loop T}:T{ Connect to a NVMe over Fabrics target on the local host @@ -187,7 +193,7 @@ If a traddr was specified on the command line or in the configuration file, only Don\(cqt remove the discovery controller after retrieving the discovery log page\&. .RE .PP -\-q, \-\-quiet +\-S, \-\-quiet .RS 4 Suppress error messages\&. .RE diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html index b5f22f7..f779c7b 100644 --- a/Documentation/nvme-connect-all.html +++ b/Documentation/nvme-connect-all.html @@ -768,7 +768,7 @@ nvme-connect-all(1) Manual Page [--queue-size=<#> | -Q <#>] [--matching | -m] [--persistent | -p] - [--quiet | -q] + [--quiet | -S]
@@ -825,6 +825,10 @@ cellspacing="0" cellpadding="4">

WIP The network fabric is a Fibre Channel network.

+

tcp

+

The network fabric is a TCP/IP network.

+ +

loop

Connect to a NVMe over Fabrics target on the local host

@@ -1044,7 +1048,7 @@ cellspacing="0" cellpadding="4">

--q +-S
--quiet @@ -1111,7 +1115,7 @@ nvme-connect(1)

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index 63d3c8f..820dd6c 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -27,7 +27,7 @@ SYNOPSIS [--queue-size=<#> | -Q <#>] [--matching | -m] [--persistent | -p] - [--quiet | -q] + [--quiet | -S] DESCRIPTION ----------- @@ -58,6 +58,7 @@ OPTIONS |Value|Definition |rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc) |fc |*WIP* The network fabric is a Fibre Channel network. +|tcp |The network fabric is a TCP/IP network. |loop|Connect to a NVMe over Fabrics target on the local host |================= @@ -153,7 +154,7 @@ OPTIONS Don't remove the discovery controller after retrieving the discovery log page. --q:: +-S:: --quiet:: Suppress error messages. diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index 9170d01..64d18bb 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -65,6 +65,7 @@ allbox tab(:); lt lt lt lt lt lt +lt lt lt lt. T{ Value @@ -83,6 +84,11 @@ T}:T{ The network fabric is a Fibre Channel network\&. T} T{ +tcp +T}:T{ +The network fabric is a TCP/IP network\&. +T} +T{ loop T}:T{ Connect to a NVMe over Fabrics target on the local host diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html index 3387333..1f523dc 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -4,7 +4,7 @@ - + nvme-connect(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme-copy <device> [--sdlba=<sdlba> | -d <sdlba>]
+                        [--blocks=<nlb-list,> | -b <nlb-list,>]
+                        [--slbs=<slbas,> | -s <slbas,>]
+                        [--limited-retry | -l]
+                        [--force-unit-access | -f]
+                        [--prinfow=<prinfow> | -p <prinfow>]
+                        [--prinfor=<prinfor> | -P <prinfor>]
+                        [--ref-tag=<reftag> | -r <reftag>]
+                        [--expected-ref-tags=<reftag,> | -R <reftag,>]
+                        [--app-tag=<apptag> | -a <apptag>]
+                        [--expected-app-tags=<apptag,> | -A <apptag,>]
+                        [--app-mask=<appmask> | -m <appmask>]
+                        [--expected-app-masks=<appmask,> | -M <appmask,>]
+                        [--dir-type=<type> | -T <type>]
+                        [--dir-spec=<spec> | -S <spec>]
+                        [--format=<entry-format> | -F <entry-format>]
+
+
+
+
+
+

DESCRIPTION

+
+

The Copy command is used by the host to copy data from one or more source +logical block ranges to a single consecutive destination logical block range.

+
+
+
+

OPTIONS

+
+
+
+--sdlba=<sdlba> +
+
+-d <sdlba> +
+
+

+ 64-bit addr of first destination logical block +

+
+
+--blocks=<nlb-list,> +
+
+-b <nlb-list,> +
+
+

+ Comma separated list of the number of blocks in each range +

+
+
+--slbs=<slbas,> +
+
+-s <slbas,> +
+
+

+ Comma separated list of the starting blocks in each range +

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

+ Sets the limited retry flag. +

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

+ Set the force-unit access flag. +

+
+
+--prinfow=<prinfow> +
+
+-p <prinfow> +
+
+

+ Protection Information field write definition. +

+
+
+--prinfor=<prinfor> +
+
+-P <prinfor> +
+
+

+ Protection Information field read definition. +

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

+ initial lba reference tag. +

+
+
+--expected-ref-tags=<reftag,> +
+
+-R <reftag,> +
+
+

+ expected lba reference tags (comma-separated list). +

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

+ lba app tag +

+
+
+--expected-app-tags=<apptag,> +
+
+-A <apptag,> +
+
+

+ expected lba app tags (comma-separated list) +

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

+ lba tag mask +

+
+
+--expected-app-masks=<appmask,> +
+
+-M <appmask,> +
+
+

+ expected lba tag masks (comma-separated list) +

+
+
+--dir-type=<type> +
+
+-T <type> +
+
+

+ Optional directive type. The nvme-cli only enforces the value + be in the defined range for the directive type, though the NVMe + specifcation (1.3a) defines only one directive, 01h, for write + stream idenfiers. +

+
+
+--dir-spec=<spec> +
+
+-S <spec> +
+
+

+ Optional field for directive specifics. When used with + write streams, this value is defined to be the write stream + identifier. The nvme-cli will not validate the stream requested + is within the controller’s capabilities. +

+
+
+--format=<entry-format> +
+
+-F <entry-format> +
+
+

+ source range entry format +

+
+
+
+
+
+

EXAMPLES

+
+

No examples yet.

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-copy.txt b/Documentation/nvme-copy.txt new file mode 100644 index 0000000..d6452ec --- /dev/null +++ b/Documentation/nvme-copy.txt @@ -0,0 +1,111 @@ +nvme-copy(1) +============ + +NAME +---- +nvme-copy - Send an NVMe Simple Copy command, provide results + +SYNOPSIS +-------- +[verse] +'nvme-copy' [--sdlba= | -d ] + [--blocks= | -b ] + [--slbs= | -s ] + [--limited-retry | -l] + [--force-unit-access | -f] + [--prinfow= | -p ] + [--prinfor= | -P ] + [--ref-tag= | -r ] + [--expected-ref-tags= | -R ] + [--app-tag= | -a ] + [--expected-app-tags= | -A ] + [--app-mask= | -m ] + [--expected-app-masks= | -M ] + [--dir-type= | -T ] + [--dir-spec= | -S ] + [--format= | -F ] + +DESCRIPTION +----------- +The Copy command is used by the host to copy data from one or more source +logical block ranges to a single consecutive destination logical block range. + +OPTIONS +------- +--sdlba=:: +-d :: + 64-bit addr of first destination logical block + +--blocks=:: +-b :: + Comma separated list of the number of blocks in each range + +--slbs=:: +-s :: + Comma separated list of the starting blocks in each range + +--limited-retry:: +-l:: + Sets the limited retry flag. + +--force-unit-access:: +-f:: + Set the force-unit access flag. + +--prinfow=:: +-p :: + Protection Information field write definition. + +--prinfor=:: +-P :: + Protection Information field read definition. + +--ref-tag=:: +-r :: + initial lba reference tag. + +--expected-ref-tags=:: +-R :: + expected lba reference tags (comma-separated list). + +--app-tag=:: +-a :: + lba app tag + +--expected-app-tags=:: +-A :: + expected lba app tags (comma-separated list) + +--app-mask=:: +-m :: + lba tag mask + +--expected-app-masks=:: +-M :: + expected lba tag masks (comma-separated list) + +--dir-type=:: +-T :: + Optional directive type. The nvme-cli only enforces the value + be in the defined range for the directive type, though the NVMe + specifcation (1.3a) defines only one directive, 01h, for write + stream idenfiers. + +--dir-spec=:: +-S :: + Optional field for directive specifics. When used with + write streams, this value is defined to be the write stream + identifier. The nvme-cli will not validate the stream requested + is within the controller's capabilities. + +--format=:: +-F :: + source range entry format + +EXAMPLES +-------- +No examples yet. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-create-ns.1 b/Documentation/nvme-create-ns.1 index 7f358c1..7a61f79 100644 --- a/Documentation/nvme-create-ns.1 +++ b/Documentation/nvme-create-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-create-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CREATE\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-CREATE\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,6 +39,7 @@ nvme-create-ns \- Send NVMe Namespace management command to create namespace, re [\-\-nmic= | \-m ] [\-\-anagrp\-id= | \-a ] [\-\-nvmset\-id= | \-i ] + [\-\-csi= | \-y ] [\-\-block\-size= | \-b ] [\-\-timeout= | \-t ] DESCRIPTION @@ -90,6 +91,11 @@ ANA Gorup Identifier\&. If this value is 0h specifies that the controller determ This field specifies the identifier of the NVM Set\&. .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 \-b, \-\-block\-size .RS 4 Target block size the new namespace should be formatted as\&. Potential FLBAS values will be values will be scanned and the lowest numbered will be selected for the create\-ns operation\&. Conflicts with \-\-flbas argument\&. diff --git a/Documentation/nvme-create-ns.html b/Documentation/nvme-create-ns.html index 1ecc66e..6d31241 100644 --- a/Documentation/nvme-create-ns.html +++ b/Documentation/nvme-create-ns.html @@ -1,9 +1,10 @@ + - + nvme-create-ns(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme endurance-event-agg-log <device> [--log-entries=<log_entries> | -e <log_entries>]
+                        [--rae | -r] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe Endurance Event Aggregate log page from an NVMe device and +provides the 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 returned endurance event agg log 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, the raw buffer may be +printed to stdout for another program to parse, or reported in json format.

+
+
+
+

OPTIONS

+
+
+
+-e <log_entries> +
+
+--log-entries=<log_entries> +
+
+

+ Retrieve the Endurance Group Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device’s + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.15. The maximum number of log entries supported is 2044 + for the device. +

+
+
+-r +
+
+--rae +
+
+

+ Retain an Asynchronous Event. +

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

+
+
    +
  • +

    +Print the Endurance log page in a human readable format: +

    +
    +
    +
    # nvme endurance-event-agg-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the raw Endurance log to a file: +

    +
    +
    +
    # nvme endurance-event-agg-log /dev/nvme0 --output=binary > endurance_event_agg_log.raw
    +
    +

    It is probably a bad idea to not redirect stdout when using this mode.

    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-endurance-event-agg-log.txt b/Documentation/nvme-endurance-event-agg-log.txt new file mode 100644 index 0000000..69701e3 --- /dev/null +++ b/Documentation/nvme-endurance-event-agg-log.txt @@ -0,0 +1,66 @@ +nvme-endurance-event-agg-log(1) +=============================== + +NAME +---- +nvme-endurance-event-agg-log - Send NVMe Endurance log page request, returns result and log + +SYNOPSIS +-------- +[verse] +'nvme endurance-event-agg-log' [--log-entries= | -e ] + [--rae | -r] [--raw-binary | -b] + [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the NVMe Endurance Event Aggregate log page from an NVMe device and +provides the 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 returned endurance event agg log 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, the raw buffer may be +printed to stdout for another program to parse, or reported in json format. + +OPTIONS +------- +-e :: +--log-entries=:: + Retrieve the Endurance Group Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device's + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.15. The maximum number of log entries supported is 2044 + for the device. + +-r:: +--rae:: + Retain an Asynchronous Event. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Print the Endurance log page in a human readable format: ++ +------------ +# nvme endurance-event-agg-log /dev/nvme0 +------------ ++ + +* Print the raw Endurance log to a file: ++ +------------ +# nvme endurance-event-agg-log /dev/nvme0 --output=binary > endurance_event_agg_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-endurance-log.1 b/Documentation/nvme-endurance-log.1 index 067a7a3..5e3170d 100644 --- a/Documentation/nvme-endurance-log.1 +++ b/Documentation/nvme-endurance-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-endurance-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ENDURANCE\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ENDURANCE\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-endurance-log.html b/Documentation/nvme-endurance-log.html index 42fe267..809edee 100644 --- a/Documentation/nvme-endurance-log.html +++ b/Documentation/nvme-endurance-log.html @@ -834,7 +834,7 @@ Print the raw Endurance log to a file: diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1 index e116ad4..4428aee 100644 --- a/Documentation/nvme-error-log.1 +++ b/Documentation/nvme-error-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-error-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ERROR\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ERROR\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-flush.1 b/Documentation/nvme-flush.1 index 3c4ddeb..1ee4223 100644 --- a/Documentation/nvme-flush.1 +++ b/Documentation/nvme-flush.1 @@ -2,12 +2,12 @@ .\" Title: nvme-flush .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FLUSH" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FLUSH" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-format.1 b/Documentation/nvme-format.1 index b47c53e..dad63a6 100644 --- a/Documentation/nvme-format.1 +++ b/Documentation/nvme-format.1 @@ -2,12 +2,12 @@ .\" Title: nvme-format .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FORMAT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FORMAT" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-fw-commit.1 b/Documentation/nvme-fw-commit.1 index 2a965a7..178e546 100644 --- a/Documentation/nvme-fw-commit.1 +++ b/Documentation/nvme-fw-commit.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-commit .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-COMMIT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-COMMIT" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-fw-download.1 b/Documentation/nvme-fw-download.1 index 0fd360b..d1126da 100644 --- a/Documentation/nvme-fw-download.1 +++ b/Documentation/nvme-fw-download.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-download .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-DOWNLOAD" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-DOWNLOAD" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-fw-log.1 b/Documentation/nvme-fw-log.1 index f96bcdc..1d1da08 100644 --- a/Documentation/nvme-fw-log.1 +++ b/Documentation/nvme-fw-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-fw-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-FW\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-FW\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-gen-hostnqn.1 b/Documentation/nvme-gen-hostnqn.1 index 255dcca..9074dcb 100644 --- a/Documentation/nvme-gen-hostnqn.1 +++ b/Documentation/nvme-gen-hostnqn.1 @@ -2,12 +2,12 @@ .\" Title: nvme-gen-hostnqn .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GEN\-HOSTNQN" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GEN\-HOSTNQN" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-feature.1 b/Documentation/nvme-get-feature.1 index 1bc451f..399d1d2 100644 --- a/Documentation/nvme-get-feature.1 +++ b/Documentation/nvme-get-feature.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-feature .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-FEATURE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-FEATURE" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-log.1 b/Documentation/nvme-get-log.1 index 742a791..98f81a8 100644 --- a/Documentation/nvme-get-log.1 +++ b/Documentation/nvme-get-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-ns-id.1 b/Documentation/nvme-get-ns-id.1 index f7e69e4..6987f3f 100644 --- a/Documentation/nvme-get-ns-id.1 +++ b/Documentation/nvme-get-ns-id.1 @@ -2,12 +2,12 @@ .\" Title: nvme-get-ns-id .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GET\-NS\-ID" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-GET\-NS\-ID" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-get-ns-id.html b/Documentation/nvme-get-ns-id.html index bd02929..6fd2329 100644 --- a/Documentation/nvme-get-ns-id.html +++ b/Documentation/nvme-get-ns-id.html @@ -1,9 +1,10 @@ + - + nvme-get-ns-id(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme id-iocs <device> [--controller-id=<cntid> | -c <cntid>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send an identify command and return the Identify I/O +Command Set 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

+
+
+
+-c <cntid> +
+
+--controller-id=<cntid> +
+
+

+ Retrieve the identify I/O Command set data structure for the given + cntid. If this value is not given, cntid will be 0xffff. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

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

    +
    +
    +
    # nvme id-iocs /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt new file mode 100644 index 0000000..9e53207 --- /dev/null +++ b/Documentation/nvme-id-iocs.txt @@ -0,0 +1,39 @@ +nvme-id-iocs(1) +=============== + +NAME +---- +nvme-id-iocs - Send NVMe Identify I/O Command Set, return result and structure + +SYNOPSIS +-------- +[verse] +'nvme id-iocs' [--controller-id= | -c ] + +DESCRIPTION +----------- +For the NVMe device given, send an identify command and return the Identify I/O +Command Set 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 +------- +-c :: +--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. + +EXAMPLES +-------- +* Have the program interpret the returned buffer and display the known +fields in a human readable format: ++ +------------ +# nvme id-iocs /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-id-ns.1 b/Documentation/nvme-id-ns.1 index 55094c9..de73c08 100644 --- a/Documentation/nvme-id-ns.1 +++ b/Documentation/nvme-id-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-id-nvmset.1 b/Documentation/nvme-id-nvmset.1 index bcec988..f29f45a 100644 --- a/Documentation/nvme-id-nvmset.1 +++ b/Documentation/nvme-id-nvmset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-nvmset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NVMSET" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NVMSET" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-id-ctrl.1 b/Documentation/nvme-intel-id-ctrl.1 index 9e90231..4605de0 100644 --- a/Documentation/nvme-intel-id-ctrl.1 +++ b/Documentation/nvme-intel-id-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-id-ctrl .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-ID\-CTR" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-ID\-CTR" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-internal-log.1 b/Documentation/nvme-intel-internal-log.1 index fdefc66..22e193d 100644 --- a/Documentation/nvme-intel-internal-log.1 +++ b/Documentation/nvme-intel-internal-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-internal-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-INTERNA" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-INTERNA" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-lat-stats.1 b/Documentation/nvme-intel-lat-stats.1 index a936e9a..577c625 100644 --- a/Documentation/nvme-intel-lat-stats.1 +++ b/Documentation/nvme-intel-lat-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-lat-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-LAT\-ST" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-LAT\-ST" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-market-name.1 b/Documentation/nvme-intel-market-name.1 index a19a844..92e2d3e 100644 --- a/Documentation/nvme-intel-market-name.1 +++ b/Documentation/nvme-intel-market-name.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-market-name .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-MARKET\" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-MARKET\" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-smart-log-add.1 b/Documentation/nvme-intel-smart-log-add.1 index 94eac80..de28a8e 100644 --- a/Documentation/nvme-intel-smart-log-add.1 +++ b/Documentation/nvme-intel-smart-log-add.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-smart-log-add .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-SMART\-" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-SMART\-" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-temp-stats.1 b/Documentation/nvme-intel-temp-stats.1 index aaab8fa..90cb356 100644 --- a/Documentation/nvme-intel-temp-stats.1 +++ b/Documentation/nvme-intel-temp-stats.1 @@ -2,12 +2,12 @@ .\" Title: nvme-intel-temp-stats .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-INTEL\-TEMP\-S" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-INTEL\-TEMP\-S" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-intel-temp-stats.html b/Documentation/nvme-intel-temp-stats.html index 2005af0..b97b8b4 100644 --- a/Documentation/nvme-intel-temp-stats.html +++ b/Documentation/nvme-intel-temp-stats.html @@ -1,9 +1,10 @@ + - + nvme-intel-temp-stats(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme lba-status-log <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe LBA Status Log Page from an NVMe device and provides +the 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 returned LBA Status Log Page 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

+
+
+
+-r +
+
+--rae +
+
+

+ Retain an Asynchronous Event. +

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

+
+
    +
  • +

    +Print the LBA Status Log page in a normal readable format: +

    +
    +
    +
    # nvme lba-status-log /dev/nvme0
    +
    +
    • +
  • +

    +Show the output in json format +

    +
    +
    +
    # nvme lba-status-log /dev/nvme0 -o json
++
+
+NVME
    +
    +
    • +
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-lba-status-log.txt b/Documentation/nvme-lba-status-log.txt new file mode 100644 index 0000000..0d888f7 --- /dev/null +++ b/Documentation/nvme-lba-status-log.txt @@ -0,0 +1,54 @@ +nvme-lba-status-log(1) +====================== + +NAME +---- +nvme-lba-status-log - Send LBA Status Log Page request returns result and log + +SYNOPSIS +-------- +[verse] +'nvme lba-status-log' [--rae | -r] [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the NVMe LBA Status Log Page from an NVMe device and provides +the 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 returned LBA Status Log Page 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 +------- +-r:: +--rae:: + Retain an Asynchronous Event. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. + Only one output format can be used at a time. + +EXAMPLES +-------- +* Print the LBA Status Log page in a normal readable format: ++ +------------ +# nvme lba-status-log /dev/nvme0 +------------ ++ + +* Show the output in json format ++ +------------ +# nvme lba-status-log /dev/nvme0 -o json ++ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-list-ctrl.1 b/Documentation/nvme-list-ctrl.1 index 516f1e8..ce64471 100644 --- a/Documentation/nvme-list-ctrl.1 +++ b/Documentation/nvme-list-ctrl.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-list-ns.1 b/Documentation/nvme-list-ns.1 index 3297d39..084eb3e 100644 --- a/Documentation/nvme-list-ns.1 +++ b/Documentation/nvme-list-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,6 +33,7 @@ nvme-list-ns \- Send NVMe Identify List Namespaces, return result and structure .sp .nf \fInvme list\-ns\fR [\-\-namespace\-id= | \-n ] + [\-\-csi= | \-y ] [\-\-all | \-a] .fi .SH "DESCRIPTION" @@ -49,6 +50,11 @@ On success, the namespace array is printed for each index and nsid for a valid n Retrieve the identify list structure starting with the given nsid\&. .RE .PP +\-y , \-\-csi= +.RS 4 +If this value is given, retrieve the identify list structure associated with the speicified I/O command set\&. +.RE +.PP \-a, \-\-all .RS 4 Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive\&. diff --git a/Documentation/nvme-list-ns.html b/Documentation/nvme-list-ns.html index 45737bb..f88f3e8 100644 --- a/Documentation/nvme-list-ns.html +++ b/Documentation/nvme-list-ns.html @@ -1,9 +1,10 @@ + - + nvme-id-ns(1) + + + + +
+
+

NAME

+
+

nvme-micron-clear-pcie-errors - Clears correctable PCIe correctable errors of given Micron device

+
+
+
+

SYNOPSIS

+
+
+
nvme micron clear-pcie-correctable-errors <device>
+
+
+
+
+
+

DESCRIPTION

+
+

This command clears corretable pcie errors for the specified Micron device.

+

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 Micron devices devices of model numbers 54XX. Support for new +devices may be added subsequently.

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve NAND statistics information +

    +
    +
    +
    # nvme micron clear-pcie-correctable-errors /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-micron-clear-pcie-errors.txt b/Documentation/nvme-micron-clear-pcie-errors.txt new file mode 100644 index 0000000..d3afccf --- /dev/null +++ b/Documentation/nvme-micron-clear-pcie-errors.txt @@ -0,0 +1,39 @@ +nvme-micron-clear-pcie-errors(1) +=============================== + +NAME +---- +nvme-micron-clear-pcie-errors - Clears correctable PCIe correctable errors of given Micron device + +SYNOPSIS +-------- +[verse] +'nvme micron clear-pcie-correctable-errors' + +DESCRIPTION +----------- +This command clears corretable pcie errors for the specified Micron device. + +The 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 Micron devices devices of model numbers 54XX. Support for new +devices may be added subsequently. + +OPTIONS +------- +None + +EXAMPLES +-------- +* Retrieve NAND statistics information ++ +------------ +# nvme micron clear-pcie-correctable-errors /dev/nvme0 + +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-micron-internal-log.1 b/Documentation/nvme-micron-internal-log.1 new file mode 100644 index 0000000..4fb909d --- /dev/null +++ b/Documentation/nvme-micron-internal-log.1 @@ -0,0 +1,74 @@ +'\" t +.\" Title: nvme-micron-internal-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/20/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-MICRON\-INTERN" "1" "10/20/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-micron-internal-log \- Retrieve Micron device\*(Aqs internal logs and save to given zip file\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme micron vs\-internal\-log\fR [\-\-package=, \-p ] +.fi +.SH "DESCRIPTION" +.sp +For the given NVMe device, sends the Micron vendor specific device commands to retrieve various logs (in binary format) and compresses them and saves into speficied zip file\&. These vendor unique logs can be analysed with Micron Technical support team for any device specific issues +.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 Micron devices devices of model numbers 9200 and 54XX\&. Support for new devices may be added subsequently\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.PP +\-l , \-\-package= +.RS 4 +name of the file (with \&.zip extension) to save the device logs +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the logs from the device and saves to micron_logs\&.zip file +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron vs\-internal\-log /dev/nvme0 \-\-package=micron_logs\&.zip +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-micron-internal-log.html b/Documentation/nvme-micron-internal-log.html new file mode 100644 index 0000000..324092d --- /dev/null +++ b/Documentation/nvme-micron-internal-log.html @@ -0,0 +1,818 @@ + + + + + + +nvme-micron-internal-log(1) + + + + + +
+
+

NAME

+
+

nvme-micron-internal-log - Retrieve Micron device’s internal logs and save to given zip file.

+
+
+
+

SYNOPSIS

+
+
+
nvme micron vs-internal-log <device> [--package=<FILE>, -p <FILE>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the given NVMe device, sends the Micron vendor specific device commands to retrieve +various logs (in binary format) and compresses them and saves into speficied zip file. +These vendor unique logs can be analysed with Micron Technical support team for any device +specific issues

+

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 Micron devices devices of model numbers 9200 and 54XX. Support +for new devices may be added subsequently. Results for any other device are undefined.

+
+
+
+

OPTIONS

+
+
+
+-l <FILE> +
+
+--package=<FILE> +
+
+

+ name of the file (with .zip extension) to save the device logs +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Gets the logs from the device and saves to micron_logs.zip file +

    +
    +
    +
    # nvme micron vs-internal-log /dev/nvme0 --package=micron_logs.zip
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-micron-internal-log.txt b/Documentation/nvme-micron-internal-log.txt new file mode 100644 index 0000000..66fb90f --- /dev/null +++ b/Documentation/nvme-micron-internal-log.txt @@ -0,0 +1,43 @@ +nvme-micron-internal-log(1) +========================== + +NAME +---- +nvme-micron-internal-log - Retrieve Micron device's internal logs and save to given zip file. + +SYNOPSIS +-------- +[verse] +'nvme micron vs-internal-log' [--package=, -p ] + +DESCRIPTION +----------- +For the given NVMe device, sends the Micron vendor specific device commands to retrieve +various logs (in binary format) and compresses them and saves into speficied zip file. +These vendor unique logs can be analysed with Micron Technical support team for any device +specific issues + +The 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 Micron devices devices of model numbers 9200 and 54XX. Support +for new devices may be added subsequently. Results for any other device are undefined. + +OPTIONS +------- +-l :: +--package=:: + name of the file (with .zip extension) to save the device logs + +EXAMPLES +-------- +* Gets the logs from the device and saves to micron_logs.zip file ++ +------------ +# nvme micron vs-internal-log /dev/nvme0 --package=micron_logs.zip + +------------ +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-micron-nand-stats.1 b/Documentation/nvme-micron-nand-stats.1 new file mode 100644 index 0000000..313e7d2 --- /dev/null +++ b/Documentation/nvme-micron-nand-stats.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: nvme-micron-nand-stats +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/20/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-MICRON\-NAND\-" "1" "10/20/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-micron-nand-stats \- Retrieves NAND statistics of given micron device +.SH "SYNOPSIS" +.sp +.nf +\fInvme micron vs\-nand\-stats\fR +.fi +.SH "DESCRIPTION" +.sp +This command prints NAND information (Total bytes written, Bad block count and Erase failures etc) for the given micron device\&. +.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 Micron devices devices of model numbers 54XX\&. Support for new devices may be added subsequently\&. +.SH "OPTIONS" +.sp +None +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve NAND statistics information +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron vs\-nand\-stats /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-micron-nand-stats.html b/Documentation/nvme-micron-nand-stats.html new file mode 100644 index 0000000..175dfd3 --- /dev/null +++ b/Documentation/nvme-micron-nand-stats.html @@ -0,0 +1,804 @@ + + + + + + +nvme-micron-nand-stats(1) + + + + + +
+
+

NAME

+
+

nvme-micron-nand-stats - Retrieves NAND statistics of given micron device

+
+
+
+

SYNOPSIS

+
+
+
nvme micron vs-nand-stats <device>
+
+
+
+
+
+

DESCRIPTION

+
+

This command prints NAND information (Total bytes written, Bad block count and +Erase failures etc) for the given micron device.

+

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 Micron devices devices of model numbers 54XX. Support for +new devices may be added subsequently.

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve NAND statistics information +

    +
    +
    +
    # nvme micron vs-nand-stats /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-micron-nand-stats.txt b/Documentation/nvme-micron-nand-stats.txt new file mode 100644 index 0000000..68e211e --- /dev/null +++ b/Documentation/nvme-micron-nand-stats.txt @@ -0,0 +1,40 @@ +nvme-micron-nand-stats(1) +========================= + +NAME +---- +nvme-micron-nand-stats - Retrieves NAND statistics of given micron device + +SYNOPSIS +-------- +[verse] +'nvme micron vs-nand-stats' + +DESCRIPTION +----------- +This command prints NAND information (Total bytes written, Bad block count and +Erase failures etc) for the given micron device. + +The 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 Micron devices devices of model numbers 54XX. Support for +new devices may be added subsequently. + +OPTIONS +------- +None + +EXAMPLES +-------- +* Retrieve NAND statistics information ++ +------------ +# nvme micron vs-nand-stats /dev/nvme0 + +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-micron-pcie-stats.1 b/Documentation/nvme-micron-pcie-stats.1 new file mode 100644 index 0000000..3070c7e --- /dev/null +++ b/Documentation/nvme-micron-pcie-stats.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: nvme-micron-pcie-stats +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/20/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-MICRON\-PCIE\-" "1" "10/20/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-micron-pcie-stats \- Retrieves pcie error statistics for given micron device +.SH "SYNOPSIS" +.sp +.nf +\fInvme micron vs\-pcie\-stats\fR +.fi +.SH "DESCRIPTION" +.sp +This command prints pcie correctable and uncorrectable error information for the given micron device\&. +.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 Micron devices devices of model numbers 54XX\&. Support for new devices may be added subsequently\&. +.SH "OPTIONS" +.sp +None +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve PCIe error information +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron vs\-pcie\-stats /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-micron-pcie-stats.html b/Documentation/nvme-micron-pcie-stats.html new file mode 100644 index 0000000..c27f4bb --- /dev/null +++ b/Documentation/nvme-micron-pcie-stats.html @@ -0,0 +1,804 @@ + + + + + + +nvme-micron-pcie-stats(1) + + + + + +
+
+

NAME

+
+

nvme-micron-pcie-stats - Retrieves pcie error statistics for given micron device

+
+
+
+

SYNOPSIS

+
+
+
nvme micron vs-pcie-stats <device>
+
+
+
+
+
+

DESCRIPTION

+
+

This command prints pcie correctable and uncorrectable error information for the +given micron device.

+

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 Micron devices devices of model numbers 54XX. Support for +new devices may be added subsequently.

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve PCIe error information +

    +
    +
    +
    # nvme micron vs-pcie-stats /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-micron-pcie-stats.txt b/Documentation/nvme-micron-pcie-stats.txt new file mode 100644 index 0000000..f58257a --- /dev/null +++ b/Documentation/nvme-micron-pcie-stats.txt @@ -0,0 +1,40 @@ +nvme-micron-pcie-stats(1) +========================= + +NAME +---- +nvme-micron-pcie-stats - Retrieves pcie error statistics for given micron device + +SYNOPSIS +-------- +[verse] +'nvme micron vs-pcie-stats' + +DESCRIPTION +----------- +This command prints pcie correctable and uncorrectable error information for the +given micron device. + +The 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 Micron devices devices of model numbers 54XX. Support for +new devices may be added subsequently. + +OPTIONS +------- +None + +EXAMPLES +-------- +* Retrieve PCIe error information ++ +------------ +# nvme micron vs-pcie-stats /dev/nvme0 + +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-micron-selective-download.1 b/Documentation/nvme-micron-selective-download.1 new file mode 100644 index 0000000..fd521b5 --- /dev/null +++ b/Documentation/nvme-micron-selective-download.1 @@ -0,0 +1,139 @@ +'\" t +.\" Title: nvme-micron-selective-download +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/20/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-MICRON\-SELECT" "1" "10/20/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-micron-selective-download \- Performs selective firmware download that allows user to select which firmware binary to update for 9200 devices\&. This requires power cycle once the update completes\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme micron selective\-download\fR [\-\-fw=, \-f ] [\-\-select=, \-s ] +.fi +.SH "DESCRIPTION" +.sp +This command uses micron vendor specific nvme commands to download given firmware image to the specified 9200 device to update selected or all portions of firmware image\&. +.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 Micron devices devices of model number 9200\&. Support for new devices may be added subsequently\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.PP +\-f , \-\-fw= +.RS 4 +name of the firmware image file +.RE +.PP +\-s , \-\-select= +.RS 4 +flag that has following values +.RE +.PP +OOB +.RS 4 +This updates the OOB and main firmware\en" +.RE +.PP +EEP +.RS 4 +This updates the eeprom and main firmware\en" +.RE +.PP +ALL +.RS 4 +This updates the eeprom, OOB, and main firmware"; +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Update OOB and main firmware +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron selective\-download /dev/nvme0 \-\-fw=firmware_bin \-\-select=OOB +# nvme micron selective\-download /dev/nvme0 \-f firmware_bin \-s OOB +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Update OOB and main firmware +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron selective\-download /dev/nvme0 \-\-fw=firmware_bin \-\-select=EEP +# nvme micron selective\-download /dev/nvme0 \-f firmware_bin \-\-s EEP +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Update eeprom, OOB and main firmware +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron selective\-download /dev/nvme0 \-\-fw=firmware_bin \-\-select=ALL +# nvme micron selective\-download /dev/nvme0 \-f firmware_bin \-\-s ALL +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-micron-selective-download.html b/Documentation/nvme-micron-selective-download.html new file mode 100644 index 0000000..7281f48 --- /dev/null +++ b/Documentation/nvme-micron-selective-download.html @@ -0,0 +1,874 @@ + + + + + + +nvme-micron-selective-download(1) + + + + + +
+
+

NAME

+
+

nvme-micron-selective-download - Performs selective firmware download that allows user +to select which firmware binary to update for 9200 devices. This requires power cycle +once the update completes.

+
+
+
+

SYNOPSIS

+
+
+
nvme micron selective-download <device> [--fw=<FILE>, -f <FILE>] [--select=<flag>, -s <flag>]
+
+
+
+
+
+

DESCRIPTION

+
+

This command uses micron vendor specific nvme commands to download given firmware image to the +specified 9200 device to update selected or all portions of firmware image.

+

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 Micron devices devices of model number 9200. Support for new devices +may be added subsequently. Results for any other device are undefined.

+
+
+
+

OPTIONS

+
+
+
+-f <FILE> +
+
+--fw=<FILE> +
+
+

+ name of the firmware image file +

+
+
+-s <flag> +
+
+--select=<flag> +
+
+

+ flag that has following values +

+
+
+OOB +
+
+

+This updates the OOB and main firmware\n" +

+
+
+EEP +
+
+

+This updates the eeprom and main firmware\n" +

+
+
+ALL +
+
+

+This updates the eeprom, OOB, and main firmware"; +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Update OOB and main firmware +

    +
    +
    +
    # nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=OOB
+# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB
    +
    +
    • +
  • +

    +Update OOB and main firmware +

    +
    +
    +
    # nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=EEP
+# nvme micron selective-download /dev/nvme0 -f firmware_bin --s EEP
    +
    +
    • +
  • +

    +Update eeprom, OOB and main firmware +

    +
    +
    +
    # nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=ALL
+# nvme micron selective-download /dev/nvme0 -f firmware_bin --s ALL
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-micron-selective-download.txt b/Documentation/nvme-micron-selective-download.txt new file mode 100644 index 0000000..5fb11d7 --- /dev/null +++ b/Documentation/nvme-micron-selective-download.txt @@ -0,0 +1,63 @@ +nvme-micron-selective-download(1) +================================= + +NAME +---- +nvme-micron-selective-download - Performs selective firmware download that allows user +to select which firmware binary to update for 9200 devices. This requires power cycle +once the update completes. + +SYNOPSIS +-------- +[verse] +'nvme micron selective-download' [--fw=, -f ] [--select=, -s ] + +DESCRIPTION +----------- +This command uses micron vendor specific nvme commands to download given firmware image to the +specified 9200 device to update selected or all portions of firmware image. + +The 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 Micron devices devices of model number 9200. Support for new devices +may be added subsequently. Results for any other device are undefined. + +OPTIONS +------- +-f :: +--fw=:: + name of the firmware image file +-s :: +--select=:: + flag that has following values + OOB:: This updates the OOB and main firmware\n" + EEP:: This updates the eeprom and main firmware\n" + ALL:: This updates the eeprom, OOB, and main firmware"; + +EXAMPLES +-------- +* Update OOB and main firmware ++ +------------ +# nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=OOB +# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB + +------------ +* Update OOB and main firmware ++ +------------ +# nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=EEP +# nvme micron selective-download /dev/nvme0 -f firmware_bin --s EEP +------------ +* Update eeprom, OOB and main firmware ++ +------------ +# nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=ALL +# nvme micron selective-download /dev/nvme0 -f firmware_bin --s ALL +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-micron-temperature-stats.1 b/Documentation/nvme-micron-temperature-stats.1 new file mode 100644 index 0000000..71297d1 --- /dev/null +++ b/Documentation/nvme-micron-temperature-stats.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: nvme-micron-temperarature-stats +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/20/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-MICRON\-TEMPER" "1" "10/20/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-micron-temperature-stats \- Retrieves temperature information of given micron device +.SH "SYNOPSIS" +.sp +.nf +\fInvme micron vs\-temperature\-stats\fR +.fi +.SH "DESCRIPTION" +.sp +This command prints temperature information (composite temperature and number of active temperature sensors) for the given micron device\&. +.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 Micron devices devices of model numbers 54XX\&. Support for new devices may be added subsequently\&. +.SH "OPTIONS" +.sp +None +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve temperature information +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme micron vs\-temperature\-stats /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-micron-temperature-stats.html b/Documentation/nvme-micron-temperature-stats.html new file mode 100644 index 0000000..6701cc2 --- /dev/null +++ b/Documentation/nvme-micron-temperature-stats.html @@ -0,0 +1,804 @@ + + + + + + +nvme-micron-temperarature-stats(1) + + + + + +
+
+

NAME

+
+

nvme-micron-temperature-stats - Retrieves temperature information of given micron device

+
+
+
+

SYNOPSIS

+
+
+
nvme micron vs-temperature-stats <device>
+
+
+
+
+
+

DESCRIPTION

+
+

This command prints temperature information (composite temperature and number of active +temperature sensors) for the given micron device.

+

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 Micron devices devices of model numbers 54XX. Support for new +devices may be added subsequently.

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve temperature information +

    +
    +
    +
    # nvme micron vs-temperature-stats /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-micron-temperature-stats.txt b/Documentation/nvme-micron-temperature-stats.txt new file mode 100644 index 0000000..43061c0 --- /dev/null +++ b/Documentation/nvme-micron-temperature-stats.txt @@ -0,0 +1,40 @@ +nvme-micron-temperarature-stats(1) +================================== + +NAME +---- +nvme-micron-temperature-stats - Retrieves temperature information of given micron device + +SYNOPSIS +-------- +[verse] +'nvme micron vs-temperature-stats' + +DESCRIPTION +----------- +This command prints temperature information (composite temperature and number of active +temperature sensors) for the given micron device. + +The 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 Micron devices devices of model numbers 54XX. Support for new +devices may be added subsequently. + +OPTIONS +------- +None + +EXAMPLES +-------- +* Retrieve temperature information ++ +------------ +# nvme micron vs-temperature-stats /dev/nvme0 + +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-netapp-ontapdevices.1 b/Documentation/nvme-netapp-ontapdevices.1 index 83bc5cb..7a0fdc0 100644 --- a/Documentation/nvme-netapp-ontapdevices.1 +++ b/Documentation/nvme-netapp-ontapdevices.1 @@ -2,12 +2,12 @@ .\" Title: nvme-netapp-ontapdevices .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NETAPP\-ONTAPD" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-NETAPP\-ONTAPD" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-netapp-smdevices.1 b/Documentation/nvme-netapp-smdevices.1 index 78622ea..b0d052a 100644 --- a/Documentation/nvme-netapp-smdevices.1 +++ b/Documentation/nvme-netapp-smdevices.1 @@ -2,12 +2,12 @@ .\" Title: nvme-netapp-smdevices .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NETAPP\-SMDEVI" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-NETAPP\-SMDEVI" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ns-descs.1 b/Documentation/nvme-ns-descs.1 index cddc126..907a081 100644 --- a/Documentation/nvme-ns-descs.1 +++ b/Documentation/nvme-ns-descs.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ns-descs .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NS\-DESCS" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-NS\-DESCS" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ns-rescan.1 b/Documentation/nvme-ns-rescan.1 index 5fcf6e8..8be4772 100644 --- a/Documentation/nvme-ns-rescan.1 +++ b/Documentation/nvme-ns-rescan.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ns-rescan .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NS\-RESCAN" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-NS\-RESCAN" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ns-rescan.html b/Documentation/nvme-ns-rescan.html index f4b0346..5e94762 100644 --- a/Documentation/nvme-ns-rescan.html +++ b/Documentation/nvme-ns-rescan.html @@ -1,455 +1,801 @@ - - - - - -nvme-ns-rescan(1) - - - - -

SYNOPSIS

-
-
-
nvme ns-rescan <device>
-
-
-
-

DESCRIPTION

-
-

Requests NVMe controller rescans the namespaces. The <device> param is mandatory and must -be an NVMe character device (ex: /dev/nvme0).

-
-

OPTIONS

-
-

None

-
-

EXAMPLES

-
-
    -
  • -

    -Rescans the nvme namespaces. -

    -
    -
    -
    # nvme ns-rescan /dev/nvme0
    -
    -
    • -
-
-

NVME

-
-

Part of the nvme-user suite

-
- - - + + + + + + +nvme-ns-rescan(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ns-rescan <device>
+
+
+
+
+
+

DESCRIPTION

+
+

Requests NVMe controller rescans the namespaces. The <device> param is mandatory and must +be an NVMe character device (ex: /dev/nvme0).

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Rescans the nvme namespaces. +

    +
    +
    +
    # nvme ns-rescan /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-nvm-id-ctrl.1 b/Documentation/nvme-nvm-id-ctrl.1 new file mode 100644 index 0000000..4d1c634 --- /dev/null +++ b/Documentation/nvme-nvm-id-ctrl.1 @@ -0,0 +1,98 @@ +'\" t +.\" Title: nvme-nvm-id-ctrl +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 02/18/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-NVM\-ID\-CTRL" "1" "02/18/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-nvm-id-ctrl \- Send NVMe Identify Controller, return NVM command set structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme nvm\-id\-ctrl\fR [\-o | \-\-output\-format=] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the NVM command set\(cqs identify controller 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 data structure returned by the device will be decoded and displayed in one of several ways\&. +.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 +.SH "EXAMPLES" +.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 nvm\-id\-ctrl /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 +.\} +Show the output in json format +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme nvm\-id\-ctrl /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of nvme\-cli diff --git a/Documentation/nvme-nvm-id-ctrl.html b/Documentation/nvme-nvm-id-ctrl.html new file mode 100644 index 0000000..fa08be0 --- /dev/null +++ b/Documentation/nvme-nvm-id-ctrl.html @@ -0,0 +1,828 @@ + + + + + + +nvme-nvm-id-ctrl(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme nvm-id-ctrl <device> [-o <fmt> | --output-format=<fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the NVM command set’s identify controller +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 data structure returned by the device will be decoded and +displayed in one of several ways.

+
+
+
+

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

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

    +
    +
    +
    # nvme nvm-id-ctrl /dev/nvme0
    +
    +
    • +
  • +

    +Show the output in json format +

    +
    +
    +
    # nvme nvm-id-ctrl /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-nvm-id-ctrl.txt b/Documentation/nvme-nvm-id-ctrl.txt new file mode 100644 index 0000000..fb4a237 --- /dev/null +++ b/Documentation/nvme-nvm-id-ctrl.txt @@ -0,0 +1,49 @@ +nvme-nvm-id-ctrl(1) +=================== + +NAME +---- +nvme-nvm-id-ctrl - Send NVMe Identify Controller, return NVM command set structure + +SYNOPSIS +-------- +[verse] +'nvme nvm-id-ctrl' [-o | --output-format=] + +DESCRIPTION +----------- +For the NVMe device given, sends the NVM command set's identify controller +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 data structure returned by the device will be decoded and +displayed in one of several ways. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Has the program interpret the returned buffer and display the known +fields in a human readable format: ++ +------------ +# nvme nvm-id-ctrl /dev/nvme0 +------------ ++ + +* Show the output in json format ++ +------------ +# nvme nvm-id-ctrl /dev/nvme0 -o json +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme-persistent-event-log.1 b/Documentation/nvme-persistent-event-log.1 new file mode 100644 index 0000000..5d74346 --- /dev/null +++ b/Documentation/nvme-persistent-event-log.1 @@ -0,0 +1,118 @@ +'\" t +.\" Title: persistent-event-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 01/11/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "PERSISTENT\-EVENT\-L" "1" "01/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-persistent-event-log \- Send NVMe persistent event log page request, returns result and log +.SH "SYNOPSIS" +.sp +.nf +\fInvme persistent\-event\-log\fR [\-\-action= | \-a ] + [\-\-log\-len= | \-l ] + [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the NVMe persistent event log page from an NVMe device and provides the 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 returned persistent event log 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\&. +.SH "OPTIONS" +.PP +\-a , \-\-action= +.RS 4 +While try to retrieve this log action the controller shall take during processing this persistent log page command\&. This mandatory field, based on the value issued it may Read Log Data, Establish Context and Read Log Data or Release Context can occur\&. For More details see NVM Express 1\&.4 Spec\&. Section 5\&.14\&.1\&.13 Persistent Event Log (Log Identifier 0Dh) +.RE +.PP +\-l , \-\-log\-len= +.RS 4 +Allocates a buffer of bytes size and requests this many bytes be returned in the constructed NVMe command\&. This param is mandatory\&. If given is 0 and action is 0, it will read the Total Log Length(TLL) of the page\&. +.RE +.PP +\-b, \-\-raw\-binary +.RS 4 +Print the raw persistent event log buffer to stdout\&. +.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 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the persistent event log page in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme persistent\-event\-log /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 +.\} +Print the raw persistent event log to a file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme persistent\-event\-log /dev/nvme0 \-\-raw\-binary > persistent_log\&.raw +.fi +.if n \{\ +.RE +.\} +.sp +It is probably a bad idea to not redirect stdout when using this mode\&. +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-persistent-event-log.html b/Documentation/nvme-persistent-event-log.html new file mode 100644 index 0000000..44a6499 --- /dev/null +++ b/Documentation/nvme-persistent-event-log.html @@ -0,0 +1,874 @@ + + + + + + +persistent-event-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme persistent-event-log <device> [--action=<action> | -a <action>]
+            [--log-len=<log-len> | -l <log-len>]
+            [--raw-binary | -b]
+            [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe persistent event log page from an NVMe device +and provides the 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 returned persistent event log 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

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

+ While try to retrieve this log action the controller shall take + during processing this persistent log page command. This mandatory + field, based on the value issued it may Read Log Data, Establish + Context and Read Log Data or Release Context can occur. For More + details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent + Event Log (Log Identifier 0Dh) +

+
+
+-l <log-len> +
+
+--log-len=<log-len> +
+
+

+ Allocates a buffer of <log-len> bytes size and requests this + many bytes be returned in the constructed NVMe command. This + param is mandatory. If <log-len> given is 0 and action is 0, + it will read the Total Log Length(TLL) of the page. +

+
+
+-b +
+
+--raw-binary +
+
+

+ Print the raw persistent event log buffer to stdout. +

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

+
+
    +
  • +

    +Print the persistent event log page in a human readable format: +

    +
    +
    +
    # nvme persistent-event-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the raw persistent event log to a file: +

    +
    +
    +
    # nvme persistent-event-log /dev/nvme0 --raw-binary > persistent_log.raw
    +
    +

    It is probably a bad idea to not redirect stdout when using this mode.

    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-persistent-event-log.txt b/Documentation/nvme-persistent-event-log.txt new file mode 100644 index 0000000..833491f --- /dev/null +++ b/Documentation/nvme-persistent-event-log.txt @@ -0,0 +1,76 @@ +persistent-event-log(1) +======================= + +NAME +---- +nvme-persistent-event-log - Send NVMe persistent event log page request, +returns result and log + +SYNOPSIS +-------- +[verse] +'nvme persistent-event-log' [--action= | -a ] + [--log-len= | -l ] + [--raw-binary | -b] + [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the NVMe persistent event log page from an NVMe device +and provides the 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 returned persistent event log 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 +------- +-a :: +--action=:: + While try to retrieve this log action the controller shall take + during processing this persistent log page command. This mandatory + field, based on the value issued it may Read Log Data, Establish + Context and Read Log Data or Release Context can occur. For More + details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent + Event Log (Log Identifier 0Dh) + +-l :: +--log-len=:: + Allocates a buffer of bytes size and requests this + many bytes be returned in the constructed NVMe command. This + param is mandatory. If given is 0 and action is 0, + it will read the Total Log Length(TLL) of the page. + +-b:: +--raw-binary:: + Print the raw persistent event log buffer to stdout. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. + Only one output format can be used at a time. + +EXAMPLES +-------- +* Print the persistent event log page in a human readable format: ++ +------------ +# nvme persistent-event-log /dev/nvme0 +------------ ++ + +* Print the raw persistent event log to a file: ++ +------------ +# nvme persistent-event-log /dev/nvme0 --raw-binary > persistent_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-pred-lat-event-agg-log.1 b/Documentation/nvme-pred-lat-event-agg-log.1 new file mode 100644 index 0000000..69785cb --- /dev/null +++ b/Documentation/nvme-pred-lat-event-agg-log.1 @@ -0,0 +1,117 @@ +'\" t +.\" Title: nvme-pred-lat-event-agg-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 01/12/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-PRED\-LAT\-EVE" "1" "01/12/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-pred-lat-event-agg-log \- Send Predictable Latency Event Aggregate Log Page request, returns result and log +.SH "SYNOPSIS" +.sp +.nf +\fInvme pred\-lat\-event\-agg\-log\fR [\-\-log\-entries= | \-e ] + [\-\-rae | \-r] [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the NVMe Predictable Latency Event Aggregate Log Page from an NVMe device and provides the 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 returned Predictable Latency Event Aggregate Log Page structure may be returned in one ofseveral 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\&. +.SH "OPTIONS" +.PP +\-e , \-\-log\-entries= +.RS 4 +Retrieve the Predictable Latency Event Aggregate Log pending entries\&. This argument is mandatory and its success may depend on the device\(cqs statistics to provide this log For More details see NVM Express 1\&.4 Spec\&. Section 5\&.14\&.1\&.11\&. The maximum number of log entries supported is 2044 for the device\&. +.RE +.PP +\-r, \-\-rae +.RS 4 +Retain an Asynchronous Event\&. +.RE +.PP +\-b, \-\-raw\-binary +.RS 4 +Print the raw Predectible Latency Event Aggregate log buffer to stdout\&. +.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 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the Predictable Latency Event Aggregate Log page in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme pred\-lat\-event\-agg\-log /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 +.\} +Print the raw Predectible Latency Event Aggregate log to a file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme pred\-lat\-event\-agg\-log /dev/nvme0 \-\-raw\-binary > pred_lat_agg_log\&.raw +.fi +.if n \{\ +.RE +.\} +.sp +It is probably a bad idea to not redirect stdout when using this mode\&. +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-pred-lat-event-agg-log.html b/Documentation/nvme-pred-lat-event-agg-log.html new file mode 100644 index 0000000..42c370f --- /dev/null +++ b/Documentation/nvme-pred-lat-event-agg-log.html @@ -0,0 +1,870 @@ + + + + + + +nvme-pred-lat-event-agg-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme pred-lat-event-agg-log <device> [--log-entries=<log_entries> | -e <log_entries>]
+                        [--rae | -r] [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe Predictable Latency Event Aggregate Log Page from an +NVMe device and provides the 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 returned Predictable Latency Event Aggregate Log +Page structure may be returned in one ofseveral 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

+
+
+
+-e <log_entries> +
+
+--log-entries=<log_entries> +
+
+

+ Retrieve the Predictable Latency Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device’s + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.11. The maximum number of log entries supported is 2044 + for the device. +

+
+
+-r +
+
+--rae +
+
+

+ Retain an Asynchronous Event. +

+
+
+-b +
+
+--raw-binary +
+
+

+ Print the raw Predectible Latency Event Aggregate log buffer to stdout. +

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

+
+
    +
  • +

    +Print the Predictable Latency Event Aggregate Log page in a human readable format: +

    +
    +
    +
    # nvme pred-lat-event-agg-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the raw Predectible Latency Event Aggregate log to a file: +

    +
    +
    +
    # nvme pred-lat-event-agg-log /dev/nvme0 --raw-binary > pred_lat_agg_log.raw
    +
    +

    It is probably a bad idea to not redirect stdout when using this mode.

    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-pred-lat-event-agg-log.txt b/Documentation/nvme-pred-lat-event-agg-log.txt new file mode 100644 index 0000000..d7d998b --- /dev/null +++ b/Documentation/nvme-pred-lat-event-agg-log.txt @@ -0,0 +1,72 @@ +nvme-pred-lat-event-agg-log(1) +============================== + +NAME +---- +nvme-pred-lat-event-agg-log - Send Predictable Latency Event Aggregate Log +Page request, returns result and log + +SYNOPSIS +-------- +[verse] +'nvme pred-lat-event-agg-log' [--log-entries= | -e ] + [--rae | -r] [--raw-binary | -b] + [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the NVMe Predictable Latency Event Aggregate Log Page from an +NVMe device and provides the 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 returned Predictable Latency Event Aggregate Log +Page structure may be returned in one ofseveral 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 +------- +-e :: +--log-entries=:: + Retrieve the Predictable Latency Event Aggregate Log pending entries. + This argument is mandatory and its success may depend on the device's + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.11. The maximum number of log entries supported is 2044 + for the device. + +-r:: +--rae:: + Retain an Asynchronous Event. + +-b:: +--raw-binary:: + Print the raw Predectible Latency Event Aggregate log buffer to stdout. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. + Only one output format can be used at a time. + +EXAMPLES +-------- +* Print the Predictable Latency Event Aggregate Log page in a human readable format: ++ +------------ +# nvme pred-lat-event-agg-log /dev/nvme0 +------------ ++ + +* Print the raw Predectible Latency Event Aggregate log to a file: ++ +------------ +# nvme pred-lat-event-agg-log /dev/nvme0 --raw-binary > pred_lat_agg_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-predictable-lat-log.1 b/Documentation/nvme-predictable-lat-log.1 new file mode 100644 index 0000000..41dd16c --- /dev/null +++ b/Documentation/nvme-predictable-lat-log.1 @@ -0,0 +1,112 @@ +'\" t +.\" Title: nvme-predictable-lat-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 01/13/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-PREDICTABLE\-L" "1" "01/13/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-predictable-lat-log \- Send Predectible latency per NVM set log page request, returns result and log +.SH "SYNOPSIS" +.sp +.nf +\fInvme predictable\-lat\-log\fR [\-\-nvmset\-id= | \-i ] + [\-\-raw\-binary | \-b] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the NVMe Predectible latency per NVM set log page from an NVMe device and provides the 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 returned Predectible latency per NVM set log structure may be returned in one ofseveral 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\&. +.SH "OPTIONS" +.PP +\-i , \-\-nvmset\-id= +.RS 4 +Retrieve the Predectible latency per NVM set log for the given nvmset id\&. This argument is mandatory and its success may depend on the device\(cqs statistics to provide this log For More details see NVM Express 1\&.4 Spec\&. Section 5\&.14\&.1\&.10\&. The default nvmset id to use is 1 for the device\&. +.RE +.PP +\-b, \-\-raw\-binary +.RS 4 +Print the raw Predectible latency per NVM set log buffer to stdout\&. +.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 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the Predectible latency per NVM set log page in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme predictable\-lat\-log /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 +.\} +Print the raw Predectible latency per NVM set log to a file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme predictable\-lat\-log /dev/nvme0 \-\-raw\-binary > nvmset_log\&.raw +.fi +.if n \{\ +.RE +.\} +.sp +It is probably a bad idea to not redirect stdout when using this mode\&. +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-predictable-lat-log.html b/Documentation/nvme-predictable-lat-log.html new file mode 100644 index 0000000..42dfda8 --- /dev/null +++ b/Documentation/nvme-predictable-lat-log.html @@ -0,0 +1,857 @@ + + + + + + +nvme-predictable-lat-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme predictable-lat-log <device> [--nvmset-id=<nvmset_id> | -i <nvmset_id>]
+                        [--raw-binary | -b]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe Predectible latency per NVM set log page from an NVMe device +and provides the 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 returned Predectible latency per NVM set log structure +may be returned in one ofseveral 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

+
+
+
+-i <nvmset_id> +
+
+--nvmset-id=<nvmset_id> +
+
+

+ Retrieve the Predectible latency per NVM set log for the given nvmset id. + This argument is mandatory and its success may depend on the device’s + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.10. The default nvmset id to use is 1 for the device. +

+
+
+-b +
+
+--raw-binary +
+
+

+ Print the raw Predectible latency per NVM set log buffer to stdout. +

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

+
+
    +
  • +

    +Print the Predectible latency per NVM set log page in a human readable format: +

    +
    +
    +
    # nvme predictable-lat-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the raw Predectible latency per NVM set log to a file: +

    +
    +
    +
    # nvme predictable-lat-log /dev/nvme0 --raw-binary > nvmset_log.raw
    +
    +

    It is probably a bad idea to not redirect stdout when using this mode.

    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-predictable-lat-log.txt b/Documentation/nvme-predictable-lat-log.txt new file mode 100644 index 0000000..b4d7335 --- /dev/null +++ b/Documentation/nvme-predictable-lat-log.txt @@ -0,0 +1,66 @@ +nvme-predictable-lat-log(1) +=========================== + +NAME +---- +nvme-predictable-lat-log - Send Predectible latency per NVM set log page request, +returns result and log + +SYNOPSIS +-------- +[verse] +'nvme predictable-lat-log' [--nvmset-id= | -i ] + [--raw-binary | -b] + [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the NVMe Predectible latency per NVM set log page from an NVMe device +and provides the 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 returned Predectible latency per NVM set log structure +may be returned in one ofseveral 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 +------- +-i :: +--nvmset-id=:: + Retrieve the Predectible latency per NVM set log for the given nvmset id. + This argument is mandatory and its success may depend on the device's + statistics to provide this log For More details see NVM Express 1.4 Spec. + Section 5.14.1.10. The default nvmset id to use is 1 for the device. + +-b:: +--raw-binary:: + Print the raw Predectible latency per NVM set log buffer to stdout. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Print the Predectible latency per NVM set log page in a human readable format: ++ +------------ +# nvme predictable-lat-log /dev/nvme0 +------------ ++ + +* Print the raw Predectible latency per NVM set log to a file: ++ +------------ +# nvme predictable-lat-log /dev/nvme0 --raw-binary > nvmset_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-read.1 b/Documentation/nvme-read.1 index ae7faf6..7ba8d6a 100644 --- a/Documentation/nvme-read.1 +++ b/Documentation/nvme-read.1 @@ -2,12 +2,12 @@ .\" Title: nvme-read .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-READ" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-READ" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-reset.1 b/Documentation/nvme-reset.1 index 7b8f3de..3d153e2 100644 --- a/Documentation/nvme-reset.1 +++ b/Documentation/nvme-reset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-reset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESET" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESET" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-acquire.1 b/Documentation/nvme-resv-acquire.1 index f96d127..1088479 100644 --- a/Documentation/nvme-resv-acquire.1 +++ b/Documentation/nvme-resv-acquire.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-acquire .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-ACQUIRE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-ACQUIRE" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -59,7 +59,7 @@ Current Reservation Key: The field specifies the current reservation key associa Preempt Reservation Key: If the Reservation Acquire Action is set to 001b (i\&.e\&., Preempt) or 010b (i\&.e\&., Preempt and Abort), then this field specifies the reservation key to be unregistered from the namespace\&. For all other Reservation Acquire Action values, this field is reserved\&. .RE .PP -\-t , \-\-rtyep= +\-t , \-\-rtype= .RS 4 Reservation Type: This field specifies the type of reservation to be created\&. .TS diff --git a/Documentation/nvme-resv-acquire.html b/Documentation/nvme-resv-acquire.html index 17b3d94..fabd8fd 100644 --- a/Documentation/nvme-resv-acquire.html +++ b/Documentation/nvme-resv-acquire.html @@ -815,7 +815,7 @@ reservation held on a namespace.

-t <rtype>
---rtyep=<rtype> +--rtype=<rtype>

diff --git a/Documentation/nvme-resv-acquire.txt b/Documentation/nvme-resv-acquire.txt index 41cbf8f..1b6e110 100644 --- a/Documentation/nvme-resv-acquire.txt +++ b/Documentation/nvme-resv-acquire.txt @@ -44,7 +44,7 @@ OPTIONS this field is reserved. -t :: ---rtyep=:: +--rtype=:: Reservation Type: This field specifies the type of reservation to be created. + diff --git a/Documentation/nvme-resv-notif-log.1 b/Documentation/nvme-resv-notif-log.1 new file mode 100644 index 0000000..ec0aca2 --- /dev/null +++ b/Documentation/nvme-resv-notif-log.1 @@ -0,0 +1,98 @@ +'\" t +.\" Title: nvme-resv-notif-log +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 03/09/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-RESV\-NOTIF\-L" "1" "03/09/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-resv-notif-log \- Send NVMe Reservation Notification log page request, return result and log +.SH "SYNOPSIS" +.sp +.nf +\fInvme resv\-notif\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves NVMe Reservation Notification log page from an NVMe device and provides the 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 returned Reservation Notification log 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\&. +.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 +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Get the Reservation Notification log and print it in a human readable format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme resv\-notif\-log /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 +.\} +Print the output in json format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme resv\-notif\-log /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-resv-notif-log.html b/Documentation/nvme-resv-notif-log.html new file mode 100644 index 0000000..ebac7e1 --- /dev/null +++ b/Documentation/nvme-resv-notif-log.html @@ -0,0 +1,829 @@ + + + + + + +nvme-resv-notif-log(1) + + + + +

+
+
+

SYNOPSIS

+
+
+
nvme resv-notif-log <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves NVMe Reservation Notification log page from an NVMe device and +provides the 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 returned Reservation Notification log 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

+
+
+
+-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 Reservation Notification log and print it in a human readable format: +

    +
    +
    +
    # nvme resv-notif-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the output in json format: +

    +
    +
    +
    # nvme resv-notif-log /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-resv-notif-log.txt b/Documentation/nvme-resv-notif-log.txt new file mode 100644 index 0000000..a9c5cdd --- /dev/null +++ b/Documentation/nvme-resv-notif-log.txt @@ -0,0 +1,51 @@ +nvme-resv-notif-log(1) +====================== + +NAME +---- +nvme-resv-notif-log - Send NVMe Reservation Notification log page request, + return result and log + +SYNOPSIS +-------- +[verse] +'nvme resv-notif-log' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves NVMe Reservation Notification log page from an NVMe device and +provides the 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 returned Reservation Notification log 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 +------- +-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 Reservation Notification log and print it in a human readable format: ++ +------------ +# nvme resv-notif-log /dev/nvme0 +------------ ++ + +* Print the output in json format: ++ +------------ +# nvme resv-notif-log /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-resv-register.1 b/Documentation/nvme-resv-register.1 index 4a50513..48b391f 100644 --- a/Documentation/nvme-resv-register.1 +++ b/Documentation/nvme-resv-register.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-register .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REGISTER" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REGISTER" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-release.1 b/Documentation/nvme-resv-release.1 index 1817e51..5ade7f5 100644 --- a/Documentation/nvme-resv-release.1 +++ b/Documentation/nvme-resv-release.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-release .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-RELEASE" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-RELEASE" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -53,7 +53,7 @@ Override the nsid field\&. If using the admin character device, this parameter i Current Reservation Key: If the Reservation Register Action is 001b (i\&.e\&., Unregister Reservation Key) or 010b (i\&.e\&., Replace Reservation Key), then this field contains the current reservation key associated with the host\&. For all other Reservation Register Action values, this field is reserved\&. The controller ignores the value of this field when the Ignore Existing Key (IEKEY) bit is set to \(oq1\(cq\&. .RE .PP -\-t , \-\-rtyep= +\-t , \-\-rtype= .RS 4 Reservation Type: This field specifies the type of reservation to be created\&. .TS diff --git a/Documentation/nvme-resv-release.html b/Documentation/nvme-resv-release.html index 884dc78..094c89a 100644 --- a/Documentation/nvme-resv-release.html +++ b/Documentation/nvme-resv-release.html @@ -802,7 +802,7 @@ held on a namespace.

-t <rtype>
---rtyep=<rtype> +--rtype=<rtype>

diff --git a/Documentation/nvme-resv-release.txt b/Documentation/nvme-resv-release.txt index a6a895e..6eb0b43 100644 --- a/Documentation/nvme-resv-release.txt +++ b/Documentation/nvme-resv-release.txt @@ -37,7 +37,7 @@ OPTIONS bit is set to ‘1’. -t :: ---rtyep=:: +--rtype=:: Reservation Type: This field specifies the type of reservation to be created. + diff --git a/Documentation/nvme-resv-report.1 b/Documentation/nvme-resv-report.1 index 7242f3a..f9f1fa8 100644 --- a/Documentation/nvme-resv-report.1 +++ b/Documentation/nvme-resv-report.1 @@ -2,12 +2,12 @@ .\" Title: nvme-resv-report .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Date: 10/20/2020 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-RESV\-REPORT" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-RESV\-REPORT" "1" "10/20/2020" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-resv-report.html b/Documentation/nvme-resv-report.html index d34e6da..83655ae 100644 --- a/Documentation/nvme-resv-report.html +++ b/Documentation/nvme-resv-report.html @@ -1,9 +1,10 @@ + - + nvme-resv-report(1) + + + +

+
+
+

SYNOPSIS

+
+
+
nvme rpmb <device> [--cmd=<command> | -c <command>]
+                    [--msgfile=<data-file> | -f <data-file>]
+                    [--keyfile=<key-file> | -g <key-file>]
+                    [--key=<key> | -k <key>]
+                    [--msg=<data> | -d <data>]
+                    [--address=<offset> | -o <offset>]
+                    [--blocks=<512 byte sectors> | -b <sectors> ]
+                    [--target=<target-id> | -t <id> ]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send an nvme rpmb command and provide the results.

+

The <device> parameter is mandatory and NVMe character device (ex: /dev/nvme0) +must be specified. If the given device supports RPMB targets, command given +with --cmd or -c option shall be sent to the controller. If given NVMe device +doesn’t support RPMB targets, a message indicating the same shall be printed +along with controller register values related RPMB.

+
+
+
+

OPTIONS

+
+
+
+-c <command> +
+
+--cmd=<command> +
+
+

+ RPMB command to be sent to the device. It can be one of the following +

+
+
+
info          - print information regarding supported RPMB targets and
+                access and total sizes. No further arguments are required
+
+
+
+
program-key   - program 'key' specified with -k option or key read from
+                file specified with --keyfile option to the specified
+                RPMB target given with --target or -t options. As per
+                spec, this is one time action which can't be undone.
+
+
+
+
read-couter   - Read 'write counter' of specified RPMB target. The
+                counter value read is printed onto STDOUT
+
+
+
+
read-config   - Read 512 bytes of device configuration block data of
+                specified RPMB target of the NVMe device. The data read
+                is written to input file specified with --msgfile or -f
+                option.
+write-config  - Write 512 byes of device configuration block data
+                from file specified by --msgfile or -f options to the
+                RPMB target specified with --target or -t options.
+
+
+
+
read-data     - Supports authenticated data reading from specified
+                RPMB target (--target or -t option) at given offset
+                specified with --address or -o option, using key
+                specified using --keyfile or -k options. --blocks or
+                -o option should be given to read the amount of data
+                to be read in 512 byte blocks.
+
+
+
+
write-data    - Supports authenticated data writting to specified RPMB
+                target (--target or -t option) at given offset
+                specified with --address or -o option, using key
+                specified using --keyfile or -k options. --blocks or
+                -o option should be given to indicate amount of data
+                to be written in 512 byte blocks.
+
+
+
+
For data transfer (read/write) commands, if the specified size is not
+within the total size supported by a target, the request is failed
+nvme-rpmb without sending it to device. RPMB target 0 is used as the
+default target if --target or -t is not specified. 0x0 is used as the
+default address if no -address or -o option is specified,
+
+
+
+-t <target> +
+
+--target=<target> +
+
+

+ RPMB target id. This should be one of the supported RPMB targets as + reported by info command. If nothing is given, default of 0 is used + as RPMB target. +

+
+
+-k <key> +
+
+--key=<key> +
+
+-g <key-file> +
+
+--keyfile=<key-file> +
+
+

+ Authentication key to be used for read/write commands. This should have + been already programmed by program-key command for given target. Key + can be specified on command line using --key or -k options. Key can + also be specified using file argument specified with --keyfile or -g + options. +

+
+
+-f <data-file> +
+
+--msgfile=<data-file> +
+
+

+ Name of the file to be used for data transfer commands (read or write). + For read command, if an existing file is specified, it will be appended. +

+
+
+-d <data> +
+
+--msg=<data> +
+
+

+ These options provide the data on the command line itself. +

+
+
+-o <offset> +
+
+--address=<offset> +
+
+

+ The address (in 512 byte sector offset from 0) to be used for data + trasnfer commands (read or write) for a specified RPMB target. +

+
+
+-b +
+
+--blocks=<sectors> +
+
+

+ The size in 512 byte sectors to be used for data trasnfer commands + (read or write) for a specified RPMB target. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print RPMB support information of an NVMe device +

    +
    +
    +
    # nvme rpmb /dev/nvme0 --cmd=info
    +
    +
    • +
  • +

    +Program SecreteKey as authentication key for target 1 +

    +
    +
    +
    # nvme rpmb /dev/nvme0 --cmd=program-key -key='SecretKey' --target=1
    +
    +
    • +
  • +

    +Read current write counter of RPMB target 0 +

    +
    +
    +
    # nvme rpmb /dev/nvme0 --cmd=read-counter --target=0
    +
    +
    • +
  • +

    +Read configuration data block of target 2 into config.bin file +

    +
    +
    +
    # nvme rpmb /dev/nvme0 --cmd=read-config --target=2 -f config.bin
    +
    +
    • +
  • +

    +Write 200 blocks of (512 bytes) from input.bin onto target 0 +

    +
    +
    +
    # nvme rpmb /dev/nvme0 -c write-data -t 0 -f input.bin -b 200 -k 'SecreteKey'
    +
    +
    • +
  • +

    +Read 200 blocks of (512 bytes) from target 2, at offset 0x100 and save the +

    +
    • +
  • +

    +data onto output.bin +

    +
    +
    +
    # nvme rpmb /dev/nvme0 -c read-data -t 2 -f out.bin -b 200 -o 0x100
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-rpmb.txt b/Documentation/nvme-rpmb.txt new file mode 100644 index 0000000..f9b371a --- /dev/null +++ b/Documentation/nvme-rpmb.txt @@ -0,0 +1,150 @@ +nvme-rpmb(1) +============== + +NAME +---- +nvme-rpmb - Send RPMB commands to an NVMe device + +SYNOPSIS +-------- +[verse] +'nvme rpmb' [--cmd= | -c ] + [--msgfile= | -f ] + [--keyfile= | -g ] + [--key= | -k ] + [--msg= | -d ] + [--address= | -o ] + [--blocks=<512 byte sectors> | -b ] + [--target= | -t ] + +DESCRIPTION +----------- +For the NVMe device given, send an nvme rpmb command and provide the results. + +The parameter is mandatory and NVMe character device (ex: /dev/nvme0) +must be specified. If the given device supports RPMB targets, command given +with --cmd or -c option shall be sent to the controller. If given NVMe device +doesn't support RPMB targets, a message indicating the same shall be printed +along with controller register values related RPMB. + +OPTIONS +------- +-c :: +--cmd=:: + RPMB command to be sent to the device. It can be one of the following + + info - print information regarding supported RPMB targets and + access and total sizes. No further arguments are required + + program-key - program 'key' specified with -k option or key read from + file specified with --keyfile option to the specified + RPMB target given with --target or -t options. As per + spec, this is one time action which can't be undone. + + read-couter - Read 'write counter' of specified RPMB target. The + counter value read is printed onto STDOUT + + read-config - Read 512 bytes of device configuration block data of + specified RPMB target of the NVMe device. The data read + is written to input file specified with --msgfile or -f + option. + write-config - Write 512 byes of device configuration block data + from file specified by --msgfile or -f options to the + RPMB target specified with --target or -t options. + + read-data - Supports authenticated data reading from specified + RPMB target (--target or -t option) at given offset + specified with --address or -o option, using key + specified using --keyfile or -k options. --blocks or + -o option should be given to read the amount of data + to be read in 512 byte blocks. + + write-data - Supports authenticated data writting to specified RPMB + target (--target or -t option) at given offset + specified with --address or -o option, using key + specified using --keyfile or -k options. --blocks or + -o option should be given to indicate amount of data + to be written in 512 byte blocks. + + For data transfer (read/write) commands, if the specified size is not + within the total size supported by a target, the request is failed + nvme-rpmb without sending it to device. RPMB target 0 is used as the + default target if --target or -t is not specified. 0x0 is used as the + default address if no -address or -o option is specified, + +-t :: +--target=:: + RPMB target id. This should be one of the supported RPMB targets as + reported by 'info' command. If nothing is given, default of 0 is used + as RPMB target. + +-k :: +--key=:: +-g :: +--keyfile=:: + Authentication key to be used for read/write commands. This should have + been already programmed by 'program-key' command for given target. Key + can be specified on command line using --key or -k options. Key can + also be specified using file argument specified with --keyfile or -g + options. + +-f :: +--msgfile=:: + Name of the file to be used for data transfer commands (read or write). + For read command, if an existing file is specified, it will be appended. + +-d :: +--msg=:: + These options provide the data on the command line itself. +-o :: +--address=:: + The address (in 512 byte sector offset from 0) to be used for data + trasnfer commands (read or write) for a specified RPMB target. +-b:: +--blocks=:: + The size in 512 byte sectors to be used for data trasnfer commands + (read or write) for a specified RPMB target. + +EXAMPLES +-------- +* Print RPMB support information of an NVMe device ++ +----------- +# nvme rpmb /dev/nvme0 --cmd=info +----------- ++ +* Program 'SecreteKey' as authentication key for target 1 ++ +------------ +# nvme rpmb /dev/nvme0 --cmd=program-key -key='SecretKey' --target=1 +------------ ++ +* Read current write counter of RPMB target 0 ++ +------------ +# nvme rpmb /dev/nvme0 --cmd=read-counter --target=0 +------------ ++ +* Read configuration data block of target 2 into config.bin file ++ +------------ +# nvme rpmb /dev/nvme0 --cmd=read-config --target=2 -f config.bin +------------ ++ +* Write 200 blocks of (512 bytes) from input.bin onto target 0 ++ +------------ +# nvme rpmb /dev/nvme0 -c write-data -t 0 -f input.bin -b 200 -k 'SecreteKey' +------------ ++ +* Read 200 blocks of (512 bytes) from target 2, at offset 0x100 and save the +* data onto output.bin ++ +------------ +# nvme rpmb /dev/nvme0 -c read-data -t 2 -f out.bin -b 200 -o 0x100 +------------ + +NVME +---- +Part of the nvme-user suite + diff --git a/Documentation/nvme-sanitize-log.1 b/Documentation/nvme-sanitize-log.1 index 72787c7..1163e2d 100644 --- a/Documentation/nvme-sanitize-log.1 +++ b/Documentation/nvme-sanitize-log.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-sanitize-log -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 04/24/2020 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 04/05/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SANITIZE\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SANITIZE\-LOG" "1" "04/05/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nvme-sanitize-log \- Send NVMe sanitize\-log Command, return result .SH "SYNOPSIS" .sp .nf -\fInvme sanitize\-log\fR [\-\-output\-format= | \-o ] +\fInvme sanitize\-log\fR [\-\-rae | \-r] [\-\-output\-format= | \-o ] [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b] .fi @@ -100,6 +100,11 @@ Sanitize Progress \- percentage complete On success it returns 0, error code otherwise\&. .SH "OPTIONS" .PP +\-r, \-\-rae +.RS 4 +Retain an Asynchronous Event\&. +.RE +.PP \-o , \-\-output\-format= .RS 4 Set the reporting format to diff --git a/Documentation/nvme-sanitize-log.html b/Documentation/nvme-sanitize-log.html index d369a10..63c8db6 100644 --- a/Documentation/nvme-sanitize-log.html +++ b/Documentation/nvme-sanitize-log.html @@ -749,7 +749,7 @@ nvme-sanitize-log(1) Manual Page

SYNOPSIS

-
nvme sanitize-log <device> [--output-format=<fmt> | -o <fmt>]
+
nvme sanitize-log <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
                              [--human-readable | -H]
                              [--raw-binary | -b]

 

@@ -816,6 +816,17 @@ If cleared to 0, then non-volatile storage in the NVM subsystem has been written
 

 

 

+-r
+

+

+--rae
+

+

+

+        Retain an Asynchronous Event.
+

+

+

 -o <format>
 

 

@@ -881,7 +892,7 @@ Has the program issue Sanitize-log Command :
 
 
diff --git a/Documentation/nvme-sanitize-log.txt b/Documentation/nvme-sanitize-log.txt
index 3c3b73e..3c2d43e 100644
--- a/Documentation/nvme-sanitize-log.txt
+++ b/Documentation/nvme-sanitize-log.txt
@@ -8,7 +8,7 @@ nvme-sanitize-log - Send NVMe sanitize-log Command, return result
 SYNOPSIS
 --------
 [verse]
-'nvme sanitize-log'  [--output-format= | -o ]
+'nvme sanitize-log'  [--rae | -r] [--output-format= | -o ]
 			     [--human-readable | -H]
 			     [--raw-binary | -b]
 
@@ -54,6 +54,10 @@ On success it returns 0, error code otherwise.
 
 OPTIONS
 -------
+-r::
+--rae::
+	Retain an Asynchronous Event.
+
 -o ::
 --output-format=::
               Set the reporting format to 'normal', 'json', or
diff --git a/Documentation/nvme-sanitize.1 b/Documentation/nvme-sanitize.1
index 85d2bd4..709992e 100644
--- a/Documentation/nvme-sanitize.1
+++ b/Documentation/nvme-sanitize.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-sanitize
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-SANITIZE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-SANITIZE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-security-recv.1 b/Documentation/nvme-security-recv.1
index df47abb..eef260a 100644
--- a/Documentation/nvme-security-recv.1
+++ b/Documentation/nvme-security-recv.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-security-recv
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-SECURITY\-RECV" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-SECURITY\-RECV" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-security-send.1 b/Documentation/nvme-security-send.1
index 919464c..81e4854 100644
--- a/Documentation/nvme-security-send.1
+++ b/Documentation/nvme-security-send.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-security-send
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-SECURITY\-SEND" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-SECURITY\-SEND" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-self-test-log.1 b/Documentation/nvme-self-test-log.1
index caff6ff..e00e289 100644
--- a/Documentation/nvme-self-test-log.1
+++ b/Documentation/nvme-self-test-log.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-self-test-log
-.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
-.\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 
+.\"      Date: 01/23/2021
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-SELF\-TEST\-LO" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-SELF\-TEST\-LO" "1" "01/23/2021" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,7 +32,8 @@ nvme-self-test-log \- Retrieve the log information initited by device\-self\-tes
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme self\-test\fR\-log  [\-\-output\-format= | \-o ]
+\fInvme self\-test\fR\-log  [\-\-log\-entries= | \-e ]
+                    [\-\-output\-format= | \-o ]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -45,6 +46,11 @@ On success, the returned log structure may be returned in one of several ways de
 By default the log is printed out in the normal readable format\&.
 .SH "OPTION"
 .PP
+\-e , \-\-log\-entries=
+.RS 4
+Specifies how many DST log entries the program should request from the device\&. This must be at least one, and shouldn\(cqt exceed the 20 entries\&. Defaults to 20 DST log entries\&.
+.RE
+.PP
 \-o , \-\-output\-format=
 .RS 4
 Set the reporting format to
diff --git a/Documentation/nvme-self-test-log.html b/Documentation/nvme-self-test-log.html
index 7f02a76..3b24a26 100644
--- a/Documentation/nvme-self-test-log.html
+++ b/Documentation/nvme-self-test-log.html
@@ -1,9 +1,10 @@
+
 
 
 
 
-
+
 nvme-self-test-log(1)
 
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme wdc capabilities <device>

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, displays list of commands and support status.

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

+
On success it returns 0, error code otherwise.

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Displays the capabilities for the device:
+
    
+
    
+
    
+
    # nvme wdc capabilities /dev/nvme0
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of the nvme-user suite.

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-wdc-capabilities.txt b/Documentation/nvme-wdc-capabilities.txt
new file mode 100644
index 0000000..859bb5f
--- /dev/null
+++ b/Documentation/nvme-wdc-capabilities.txt
@@ -0,0 +1,32 @@
+nvme-wdc-capabilities(1)
+========================
+
+NAME
+----
+nvme-wdc-capabilities - Display WDC plugin command capabilities
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc capabilities'  
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, displays list of commands and support status.
+
+The  parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+EXAMPLES
+--------
+* Displays the capabilities for the device:
++
+------------
+# nvme wdc capabilities /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
diff --git a/Documentation/nvme-wdc-clear-assert-dump.1 b/Documentation/nvme-wdc-clear-assert-dump.1
index 1f1569e..85e7dca 100644
--- a/Documentation/nvme-wdc-clear-assert-dump.1
+++ b/Documentation/nvme-wdc-clear-assert-dump.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-clear-assert-dump
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-CLEAR\-AS" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-AS" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.1 b/Documentation/nvme-wdc-clear-fw-activate-history.1
index 0a0a999..3dd36b2 100644
--- a/Documentation/nvme-wdc-clear-fw-activate-history.1
+++ b/Documentation/nvme-wdc-clear-fw-activate-history.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-clear-fw-activate-history
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-CLEAR\-FW" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-FW" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 b/Documentation/nvme-wdc-clear-pcie-correctable-errors.1
index 1f45364..f819679 100644
--- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.1
+++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-clear-pcie-correctable-errors
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-CLEAR\-PC" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-PC" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-cloud-SSD-plugin-version.1 b/Documentation/nvme-wdc-cloud-SSD-plugin-version.1
new file mode 100644
index 0000000..3ac3bc1
--- /dev/null
+++ b/Documentation/nvme-wdc-cloud-SSD-plugin-version.1
@@ -0,0 +1,68 @@
+'\" t
+.\"     Title: nvme-wdc-cloud-SSD-plugin-version
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.78.1 
+.\"      Date: 03/01/2021
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-WDC\-CLOUD\-SS" "1" "03/01/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-wdc-cloud-SSD-plugin-version \- Display WDC plugin Cloud SSD Plugin Version
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme wdc cloud\-SSD\-plugin\-version\fR 
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, this command displays the current Cloud SSD Plugin Version (if supported by the device)\&.
+.sp
+The  parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
+.sp
+On success it returns 0, error code otherwise\&.
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Displays the cloud ssd plugin version for the device:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme wdc cloud\-SSD\-plugin\-version /dev/nvme0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of the nvme\-user suite\&.
diff --git a/Documentation/nvme-wdc-cloud-SSD-plugin-version.html b/Documentation/nvme-wdc-cloud-SSD-plugin-version.html
new file mode 100644
index 0000000..dd686f8
--- /dev/null
+++ b/Documentation/nvme-wdc-cloud-SSD-plugin-version.html
@@ -0,0 +1,793 @@
+
+
+
+
+
+nvme-wdc-cloud-SSD-plugin-version(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme wdc cloud-SSD-plugin-version <device>

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, this command displays the current Cloud SSD
+Plugin Version (if supported by the device).

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

+
On success it returns 0, error code otherwise.

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Displays the cloud ssd plugin version for the device:
+
    
+
    
+
    
+
    # nvme wdc cloud-SSD-plugin-version /dev/nvme0
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of the nvme-user suite.

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-wdc-cloud-SSD-plugin-version.txt b/Documentation/nvme-wdc-cloud-SSD-plugin-version.txt
new file mode 100644
index 0000000..3fed5cd
--- /dev/null
+++ b/Documentation/nvme-wdc-cloud-SSD-plugin-version.txt
@@ -0,0 +1,33 @@
+nvme-wdc-cloud-SSD-plugin-version(1)
+====================================
+
+NAME
+----
+nvme-wdc-cloud-SSD-plugin-version - Display WDC plugin Cloud SSD Plugin Version
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc cloud-SSD-plugin-version'  
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, this command displays the current Cloud SSD 
+Plugin Version (if supported by the device).
+
+The  parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+EXAMPLES
+--------
+* Displays the cloud ssd plugin version for the device:
++
+------------
+# nvme wdc cloud-SSD-plugin-version /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
diff --git a/Documentation/nvme-wdc-drive-essentials.1 b/Documentation/nvme-wdc-drive-essentials.1
index e0a2902..e6e1b57 100644
--- a/Documentation/nvme-wdc-drive-essentials.1
+++ b/Documentation/nvme-wdc-drive-essentials.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-drive-essentials
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-DRIVE\-ES" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-DRIVE\-ES" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-drive-log.1 b/Documentation/nvme-wdc-drive-log.1
index 4ce6955..5ed478b 100644
--- a/Documentation/nvme-wdc-drive-log.1
+++ b/Documentation/nvme-wdc-drive-log.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-drive-log
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-DRIVE\-LO" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-DRIVE\-LO" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-drive-resize.1 b/Documentation/nvme-wdc-drive-resize.1
index 0949d70..6bd64f4 100644
--- a/Documentation/nvme-wdc-drive-resize.1
+++ b/Documentation/nvme-wdc-drive-resize.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-drive-resize
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-DRIVE\-RE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-DRIVE\-RE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-enc-get-log.1 b/Documentation/nvme-wdc-enc-get-log.1
new file mode 100644
index 0000000..69a4f3e
--- /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://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-WDC\-ENC\-GET\" "1" "10/20/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 0000000..b806f3a
--- /dev/null
+++ b/Documentation/nvme-wdc-enc-get-log.html
@@ -0,0 +1,839 @@
+
+
+
+
+
+
+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 0000000..ae93a7a
--- /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.
diff --git a/Documentation/nvme-wdc-get-crash-dump.1 b/Documentation/nvme-wdc-get-crash-dump.1
index 152643f..8e6a880 100644
--- a/Documentation/nvme-wdc-get-crash-dump.1
+++ b/Documentation/nvme-wdc-get-crash-dump.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-get-crash-dump
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-GET\-CRAS" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-CRAS" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-get-drive-status.1 b/Documentation/nvme-wdc-get-drive-status.1
index b19520d..f360e85 100644
--- a/Documentation/nvme-wdc-get-drive-status.1
+++ b/Documentation/nvme-wdc-get-drive-status.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-get-drive-status
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-GET\-DRIV" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-DRIV" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-get-pfail-dump.1 b/Documentation/nvme-wdc-get-pfail-dump.1
index 230ce79..a96febd 100644
--- a/Documentation/nvme-wdc-get-pfail-dump.1
+++ b/Documentation/nvme-wdc-get-pfail-dump.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-get-pfail-dump
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-GET\-PFAI" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-PFAI" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-id-ctrl.1 b/Documentation/nvme-wdc-id-ctrl.1
index 220d953..71aaa71 100644
--- a/Documentation/nvme-wdc-id-ctrl.1
+++ b/Documentation/nvme-wdc-id-ctrl.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-id-ctrl
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-ID\-CTRL" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-ID\-CTRL" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-log-page-directory.1 b/Documentation/nvme-wdc-log-page-directory.1
index 0d407ba..611f65e 100644
--- a/Documentation/nvme-wdc-log-page-directory.1
+++ b/Documentation/nvme-wdc-log-page-directory.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-log-page-directory
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-LOG\-PAGE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-LOG\-PAGE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-namespace-resize.1 b/Documentation/nvme-wdc-namespace-resize.1
index ea0235a..c159d2b 100644
--- a/Documentation/nvme-wdc-namespace-resize.1
+++ b/Documentation/nvme-wdc-namespace-resize.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-namespace-resize
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-NAMESPACE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-NAMESPACE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-purge-monitor.1 b/Documentation/nvme-wdc-purge-monitor.1
index 3df192a..ffb7fd8 100644
--- a/Documentation/nvme-wdc-purge-monitor.1
+++ b/Documentation/nvme-wdc-purge-monitor.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-purge-monitor
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-PURGE\-MO" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-PURGE\-MO" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-purge.1 b/Documentation/nvme-wdc-purge.1
index 748f78d..506714a 100644
--- a/Documentation/nvme-wdc-purge.1
+++ b/Documentation/nvme-wdc-purge.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-purge
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-PURGE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-PURGE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-vs-drive-info.1 b/Documentation/nvme-wdc-vs-drive-info.1
index 4f5dd1c..9ca8396 100644
--- a/Documentation/nvme-wdc-vs-drive-info.1
+++ b/Documentation/nvme-wdc-vs-drive-info.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-vs-drive-info
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-VS\-DRIVE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-DRIVE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-vs-error-reason-identifier.1 b/Documentation/nvme-wdc-vs-error-reason-identifier.1
index 2770ce3..e8779bf 100644
--- a/Documentation/nvme-wdc-vs-error-reason-identifier.1
+++ b/Documentation/nvme-wdc-vs-error-reason-identifier.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-vs-error-reason-identifier
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-VS\-ERROR" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-ERROR" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-vs-fw-activate-history.1 b/Documentation/nvme-wdc-vs-fw-activate-history.1
index 25ce40a..696acf8 100644
--- a/Documentation/nvme-wdc-vs-fw-activate-history.1
+++ b/Documentation/nvme-wdc-vs-fw-activate-history.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-vs-fw-activate-history
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-VS\-FW\-A" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-FW\-A" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-wdc-vs-internal-log.1 b/Documentation/nvme-wdc-vs-internal-log.1
index abb6e94..441777d 100644
--- a/Documentation/nvme-wdc-vs-internal-log.1
+++ b/Documentation/nvme-wdc-vs-internal-log.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-vs-internal-log
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-VS\-INTER" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-INTER" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -57,7 +57,7 @@ Transfer size; defaults to 0x10000 (65536 decimal) bytes
 .PP
 \-d , \-\-data\-area=
 .RS 4
-DUI data area to retrieve\&. The DUI data areas from 1 to  will be retrieved\&. This parameter is currently only supported on the SN340, SN640, and SN840 devices\&.
+DUI data area to retrieve\&. The DUI data areas from 1 to  will be retrieved\&. This parameter is currently only supported on the SN340, SN640, SN730, and SN840 devices\&.
 .RE
 .PP
 \-f , \-\-file\-size=
diff --git a/Documentation/nvme-wdc-vs-internal-log.html b/Documentation/nvme-wdc-vs-internal-log.html
index d07be0e..8919541 100644
--- a/Documentation/nvme-wdc-vs-internal-log.html
+++ b/Documentation/nvme-wdc-vs-internal-log.html
@@ -4,7 +4,7 @@
 
 
 
-
+
 nvme-wdc-vs-internal-log(1)
 
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme wdc vs-temperature-stats <device>

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, displays temperature statistics.

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

+
Expected status and description :-

+

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



Statistic Description
The current composite temperature
device temperature
Warning Composite TEMPerature threshold
temp of overheating
Critical Composite TEMPerature threshold
temp of critical overheating
Device Initiated Thermal Throttling support status
0 = unsupported, 1 = supported
Host Controlled Thermal Management support
0 = unsupported, 1 = supported
Thermal Management Temperature 1 (Light throttle)
temp to start light throttle
Thermal Management Temperature 1 Transition Counter
# times switched into light throttle
Thermal Management Temperature 1 Total Time
# seconds spent in light throttle
Thermal Management Temperature 2 (Heavy throttle)
temp to start heavy throttle
Thermal Management Temperature 2 Transition Counter
# times switched into heavy throttle
Thermal Management Temperature 2 Total Time
# seconds spent in heavy throttle
Thermal Shutdown Threshold
temp of device shutdown

+

+
On success it returns 0, error code otherwise.

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Displays the temperature stats for the device:
+
    
+
    
+
    
+
    # nvme wdc vs-temperature-stats /dev/nvme0
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of the nvme-user suite.

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-wdc-vs-temperature-stats.txt b/Documentation/nvme-wdc-vs-temperature-stats.txt
new file mode 100644
index 0000000..1d000e3
--- /dev/null
+++ b/Documentation/nvme-wdc-vs-temperature-stats.txt
@@ -0,0 +1,78 @@
+nvme-wdc-vs-temperature-stats(1)
+================================
+
+NAME
+----
+nvme-wdc-vs-temperature-stats - Display temperature-related statistics
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc vs-temperature-stats'  
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, displays temperature statistics.
+
+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.
+
+Expected status and description :-
+
+[cols="2*", options="header"]
+|===
+|Statistic |Description
+
+|The current composite temperature
+|device temperature
+
+|Warning Composite TEMPerature threshold
+|temp of overheating
+
+|Critical Composite TEMPerature threshold
+|temp of critical overheating
+
+|Device Initiated Thermal Throttling support status
+|0 = unsupported, 1 = supported
+
+|Host Controlled Thermal Management support
+|0 = unsupported, 1 = supported
+
+|Thermal Management Temperature 1 (Light throttle)
+|temp to start light throttle
+
+|Thermal Management Temperature 1 Transition Counter
+|# times switched into light throttle
+
+|Thermal Management Temperature 1 Total Time
+|# seconds spent in light throttle
+
+|Thermal Management Temperature 2 (Heavy throttle)
+|temp to start heavy throttle
+
+|Thermal Management Temperature 2 Transition Counter
+|# times switched into heavy throttle
+
+|Thermal Management Temperature 2 Total Time
+|# seconds spent in heavy throttle
+
+|Thermal Shutdown Threshold
+|temp of device shutdown
+|===
+
+On success it returns 0, error code otherwise.
+
+EXAMPLES
+--------
+* Displays the temperature stats for the device:
++
+------------
+# nvme wdc vs-temperature-stats /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
diff --git a/Documentation/nvme-write-uncor.1 b/Documentation/nvme-write-uncor.1
index 2cc5c88..93e7511 100644
--- a/Documentation/nvme-write-uncor.1
+++ b/Documentation/nvme-write-uncor.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-uncor
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-UNCOR" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-UNCOR" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-write-zeroes.1 b/Documentation/nvme-write-zeroes.1
index c1a5b52..d32e3ca 100644
--- a/Documentation/nvme-write-zeroes.1
+++ b/Documentation/nvme-write-zeroes.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-zeroes
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ZEROES" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-ZEROES" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-write.1 b/Documentation/nvme-write.1
index 5e9101a..727ac03 100644
--- a/Documentation/nvme-write.1
+++ b/Documentation/nvme-write.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-write
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\"      Date: 10/20/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WRITE" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WRITE" "1" "10/20/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
diff --git a/Documentation/nvme-zns-changed-zone-list.1 b/Documentation/nvme-zns-changed-zone-list.1
new file mode 100644
index 0000000..c4a96ba
--- /dev/null
+++ b/Documentation/nvme-zns-changed-zone-list.1
@@ -0,0 +1,105 @@
+'\" t
+.\"     Title: nvme-zns-changed-zone-list
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-CHANGED\-" "1" "10/20/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-zns-changed-zone-list \- Retrieve Changed Zone log for the given device
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns changed\-zone\-list\fR  [\-o  | \-\-output\-format=]
+                                      [\-\-namespace\-id= | \-n ]
+                                      [\-\-rae | \-r]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, requests the namespace\(cqs changed zoned list log 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 returned list may be decoded and displayed in one of several ways\&.
+.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
+\-r, \-\-rae
+.RS 4
+Retain an Asynchronous Event\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Get the changed zone list log for namespace 1
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns changed\-zone\-list /dev/nvme0 \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Show the output in json format
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns changed\-zone\-list /dev/nvme0 \-o json \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-changed-zone-list.html b/Documentation/nvme-zns-changed-zone-list.html
new file mode 100644
index 0000000..977c1d6
--- /dev/null
+++ b/Documentation/nvme-zns-changed-zone-list.html
@@ -0,0 +1,840 @@
+
+
+
+
+
+
+nvme-zns-changed-zone-list(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns changed-zone-list <device> [-o <fmt> | --output-format=<fmt>]
+                                      [--namespace-id=<NUM> | -n <NUM>]
+                                      [--rae | -r]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, requests the namespace’s changed zoned list log
+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 returned list may be decoded and displayed in one of several
+ways.

+

+

+

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

+

+

+-r
+

+

+--rae
+

+

+

+        Retain an Asynchronous Event.
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Get the changed zone list log for namespace 1
+
    
+
    
+
    
+
    # nvme zns changed-zone-list /dev/nvme0 -n 1
    
+
    
+
    • 
+
  • 
+
    
+Show the output in json format
+
    
+
    
+
    
+
    # nvme zns changed-zone-list /dev/nvme0 -o json -n 1
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-changed-zone-list.txt b/Documentation/nvme-zns-changed-zone-list.txt
new file mode 100644
index 0000000..9626c05
--- /dev/null
+++ b/Documentation/nvme-zns-changed-zone-list.txt
@@ -0,0 +1,54 @@
+nvme-zns-changed-zone-list(1)
+=============================
+
+NAME
+----
+nvme-zns-changed-zone-list - Retrieve Changed Zone log for the given device
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns changed-zone-list'  [-o  | --output-format=]
+				      [--namespace-id= | -n ]
+				      [--rae | -r]
+
+DESCRIPTION
+-----------
+For the NVMe device given, requests the namespace's changed zoned list log
+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 returned list may be decoded and displayed in one of several
+ways.
+
+OPTIONS
+-------
+-o ::
+--output-format=::
+              Set the reporting format to 'normal', 'json', or
+              'binary'. Only one output format can be used at a time.
+
+-r::
+--rae::
+	Retain an Asynchronous Event.
+
+EXAMPLES
+--------
+* Get the changed zone list log for namespace 1
++
+------------
+# nvme zns changed-zone-list /dev/nvme0 -n 1
+------------
++
+
+* Show the output in json format
++
+------------
+# nvme zns changed-zone-list /dev/nvme0 -o json -n 1
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-close-zone.1 b/Documentation/nvme-zns-close-zone.1
new file mode 100644
index 0000000..d9624c1
--- /dev/null
+++ b/Documentation/nvme-zns-close-zone.1
@@ -0,0 +1,84 @@
+'\" t
+.\"     Title: nvme-zns-close-zone
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-CLOSE\-ZO" "1" "10/20/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-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]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the "Close Zone" action\&. This will transition the zone to the closed state\&.
+.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
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to close\&.
+.RE
+.PP
+\-a, \-\-select\-all
+.RS 4
+Select all zones for this action
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Close all zones on namespace 1:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns close\-zone /dev/nvme0 \-a \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-close-zone.html b/Documentation/nvme-zns-close-zone.html
new file mode 100644
index 0000000..d2e297a
--- /dev/null
+++ b/Documentation/nvme-zns-close-zone.html
@@ -0,0 +1,841 @@
+
+
+
+
+
+
+nvme-zns-close-zone(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns close-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+"Close Zone" action. This will transition the zone to the closed state.

+
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

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to close.
+

+

+

+-a
+

+

+--select-all
+

+

+

+        Select all zones for this action
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Close all zones on namespace 1:
+
    
+
    
+
    
+
    # nvme zns close-zone /dev/nvme0 -a -n 1
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-close-zone.txt b/Documentation/nvme-zns-close-zone.txt
new file mode 100644
index 0000000..7b47bf0
--- /dev/null
+++ b/Documentation/nvme-zns-close-zone.txt
@@ -0,0 +1,49 @@
+nvme-zns-close-zone(1)
+======================
+
+NAME
+----
+nvme-zns-close-zone - Closes one or all zones
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns close-zone nvme zns id-ctrl'  [--namespace-id= | -n ]
+						[--start-lba= | -s ]
+						[--select-all | -a]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+"Close Zone" action. This will transition the zone to the closed state.
+
+The  parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to close. 
+
+-a::
+--select-all::
+	Select all zones for this action
+
+EXAMPLES
+--------
+* Close all zones on namespace 1:
++
+------------
+# nvme zns close-zone /dev/nvme0 -a -n 1
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-finish-zone.1 b/Documentation/nvme-zns-finish-zone.1
new file mode 100644
index 0000000..764c683
--- /dev/null
+++ b/Documentation/nvme-zns-finish-zone.1
@@ -0,0 +1,84 @@
+'\" t
+.\"     Title: nvme-zns-finish-zone
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-FINISH\-Z" "1" "10/20/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-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]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the "Finish Zone" action\&. This will transition the zone to the full state on success\&.
+.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
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to finish\&.
+.RE
+.PP
+\-a, \-\-select\-all
+.RS 4
+Select all zones for this action\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Finish all zones on namespace 1:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns finish\-zone /dev/nvme0 \-a \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-finish-zone.html b/Documentation/nvme-zns-finish-zone.html
new file mode 100644
index 0000000..36b833f
--- /dev/null
+++ b/Documentation/nvme-zns-finish-zone.html
@@ -0,0 +1,842 @@
+
+
+
+
+
+
+nvme-zns-finish-zone(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns finish-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+"Finish Zone" action. This will transition the zone to the full state on
+success.

+
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

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to finish.
+

+

+

+-a
+

+

+--select-all
+

+

+

+        Select all zones for this action.
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Finish all zones on namespace 1:
+
    
+
    
+
    
+
    # nvme zns finish-zone /dev/nvme0 -a -n 1
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-finish-zone.txt b/Documentation/nvme-zns-finish-zone.txt
new file mode 100644
index 0000000..9a9a2f0
--- /dev/null
+++ b/Documentation/nvme-zns-finish-zone.txt
@@ -0,0 +1,50 @@
+nvme-zns-finish-zone(1)
+=======================
+
+NAME
+----
+nvme-zns-finish-zone - Finishes one or all zones
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns finish-zone nvme zns id-ctrl'  [--namespace-id= | -n ]
+						[--start-lba= | -s ]
+						[--select-all | -a]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+"Finish Zone" action. This will transition the zone to the full state on
+success.
+
+The  parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to finish. 
+
+-a::
+--select-all::
+	Select all zones for this action.
+
+EXAMPLES
+--------
+* Finish all zones on namespace 1:
++
+------------
+# nvme zns finish-zone /dev/nvme0 -a -n 1
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-id-ctrl.1 b/Documentation/nvme-zns-id-ctrl.1
new file mode 100644
index 0000000..7b444c5
--- /dev/null
+++ b/Documentation/nvme-zns-id-ctrl.1
@@ -0,0 +1,98 @@
+'\" t
+.\"     Title: nvme-zns-id-ctrl
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-ID\-CTRL" "1" "10/20/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-zns-id-ctrl \- Send NVMe Zoned Command Set Identify Controller, return result and structure
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns id\-ctrl\fR  [\-o  | \-\-output\-format=]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, sends the zoned command set\(cqs identify controller 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 data structure returned by the device will be decoded and displayed in one of several ways\&.
+.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
+.SH "EXAMPLES"
+.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 zns id\-ctrl /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
+.\}
+Show the output in json format
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns id\-ctrl /dev/nvme0 \-o json
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-id-ctrl.html b/Documentation/nvme-zns-id-ctrl.html
new file mode 100644
index 0000000..cc892a5
--- /dev/null
+++ b/Documentation/nvme-zns-id-ctrl.html
@@ -0,0 +1,828 @@
+
+
+
+
+
+
+nvme-zns-id-ctrl(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns id-ctrl <device> [-o <fmt> | --output-format=<fmt>]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, sends the zoned command set’s identify controller
+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 data structure returned by the device will be decoded and
+displayed in one of several ways.

+

+

+

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

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Has the program interpret the returned buffer and display the known
+fields in a human readable format:
+
    
+
    
+
    
+
    # nvme zns id-ctrl /dev/nvme0
    
+
    
+
    • 
+
  • 
+
    
+Show the output in json format
+
    
+
    
+
    
+
    # nvme zns id-ctrl /dev/nvme0 -o json
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-id-ctrl.txt b/Documentation/nvme-zns-id-ctrl.txt
new file mode 100644
index 0000000..e7bd5ba
--- /dev/null
+++ b/Documentation/nvme-zns-id-ctrl.txt
@@ -0,0 +1,50 @@
+nvme-zns-id-ctrl(1)
+===================
+
+NAME
+----
+nvme-zns-id-ctrl - Send NVMe Zoned Command Set Identify Controller, return
+                   result and structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns id-ctrl'  [-o  | --output-format=]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the zoned command set's identify controller
+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 data structure returned by the device will be decoded and
+displayed in one of several ways. 
+
+OPTIONS
+-------
+-o ::
+--output-format=::
+              Set the reporting format to 'normal', 'json', or
+              'binary'. Only one output format can be used at a time.
+
+EXAMPLES
+--------
+* Has the program interpret the returned buffer and display the known
+fields in a human readable format:
++
+------------
+# nvme zns id-ctrl /dev/nvme0
+------------
++
+
+* Show the output in json format
++
+------------
+# nvme zns id-ctrl /dev/nvme0 -o json
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-id-ns.1 b/Documentation/nvme-zns-id-ns.1
new file mode 100644
index 0000000..979bea5
--- /dev/null
+++ b/Documentation/nvme-zns-id-ns.1
@@ -0,0 +1,110 @@
+'\" t
+.\"     Title: nvme-zns-id-ns
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-ID\-NS" "1" "10/20/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-zns-id-ns \- Send NVMe Zoned Command Set Identify Controller, return result and structure
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns id\-ns\fR   [\-\-namespace\-id= | \-n ]
+                             [\-o  | \-\-output\-format=]
+                             [\-v | \-\-verbose]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, sends the zoned command set\(cqs identify namepsace 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 data structure returned by the device will be decoded and displayed in one of several ways\&.
+.SH "OPTIONS"
+.PP
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.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
+.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 zns id\-ns /dev/nvme0 \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Show the output in json format with extra details
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns id\-ns /dev/nvme0 \-o json \-v
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-id-ns.html b/Documentation/nvme-zns-id-ns.html
new file mode 100644
index 0000000..45393db
--- /dev/null
+++ b/Documentation/nvme-zns-id-ns.html
@@ -0,0 +1,854 @@
+
+
+
+
+
+
+nvme-zns-id-ctrl(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns id-ctrl <device>  [--namespace-id=<NUM> | -n <NUM>]
+                             [-o <fmt> | --output-format=<fmt>]
+                             [-v | --verbose]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, sends the zoned command set’s identify namepsace
+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 data structure returned by the device will be decoded and
+displayed in one of several ways.

+

+

+

+
OPTIONS

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-v
+

+

+--verbose
+

+

+

+        Increase the information detail in the output.
+

+

+

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

+

+
    
+
  • 
+
    
+Has the program interpret the returned buffer and display the known
+fields in a human readable format:
+
    
+
    
+
    
+
    # nvme zns id-ns /dev/nvme0 -n 1
    
+
    
+
    • 
+
  • 
+
    
+Show the output in json format with extra details
+
    
+
    
+
    
+
    # nvme zns id-ctrl /dev/nvme0 -o json -v
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-id-ns.txt b/Documentation/nvme-zns-id-ns.txt
new file mode 100644
index 0000000..a95d975
--- /dev/null
+++ b/Documentation/nvme-zns-id-ns.txt
@@ -0,0 +1,62 @@
+nvme-zns-id-ns(1)
+=================
+
+NAME
+----
+nvme-zns-id-ns - Send NVMe Zoned Command Set Identify Controller, return
+                   result and structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns id-ns'   [--namespace-id= | -n ]
+			     [-o  | --output-format=]
+			     [-v | --verbose]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the zoned command set's identify namepsace
+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 data structure returned by the device will be decoded and
+displayed in one of several ways. 
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+-o ::
+--output-format=::
+              Set the reporting format to 'normal', 'json', or
+              'binary'. Only one output format can be used at a time.
+
+EXAMPLES
+--------
+* Has the program interpret the returned buffer and display the known
+fields in a human readable format:
++
+------------
+# nvme zns id-ns /dev/nvme0 -n 1
+------------
++
+
+* Show the output in json format with extra details
++
+------------
+# nvme zns id-ns /dev/nvme0 -o json -v
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-offline-zone.1 b/Documentation/nvme-zns-offline-zone.1
new file mode 100644
index 0000000..9d2d083
--- /dev/null
+++ b/Documentation/nvme-zns-offline-zone.1
@@ -0,0 +1,84 @@
+'\" t
+.\"     Title: nvme-zns-offline-zone
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-OFFLINE\-" "1" "10/20/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-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]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the "Offline Zone" action\&. This will transition the zone to the offlined state\&.
+.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
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to offline\&.
+.RE
+.PP
+\-a, \-\-select\-all
+.RS 4
+Select all zones for this action
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Offline all zones on namespace 1:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns offline\-zone /dev/nvme0 \-a \-n 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-offline-zone.html b/Documentation/nvme-zns-offline-zone.html
new file mode 100644
index 0000000..ae2da7f
--- /dev/null
+++ b/Documentation/nvme-zns-offline-zone.html
@@ -0,0 +1,841 @@
+
+
+
+
+
+
+nvme-zns-offline-zone(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns offline-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+"Offline Zone" action. This will transition the zone to the offlined state.

+
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

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to offline.
+

+

+

+-a
+

+

+--select-all
+

+

+

+        Select all zones for this action
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Offline all zones on namespace 1:
+
    
+
    
+
    
+
    # nvme zns offline-zone /dev/nvme0 -a -n 1
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-offline-zone.txt b/Documentation/nvme-zns-offline-zone.txt
new file mode 100644
index 0000000..0a35235
--- /dev/null
+++ b/Documentation/nvme-zns-offline-zone.txt
@@ -0,0 +1,49 @@
+nvme-zns-offline-zone(1)
+========================
+
+NAME
+----
+nvme-zns-offline-zone - Offlines one or all zones
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns offline-zone nvme zns id-ctrl'  [--namespace-id= | -n ]
+						[--start-lba= | -s ]
+						[--select-all | -a]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+"Offline Zone" action. This will transition the zone to the offlined state.
+
+The  parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to offline. 
+
+-a::
+--select-all::
+	Select all zones for this action
+
+EXAMPLES
+--------
+* Offline all zones on namespace 1:
++
+------------
+# nvme zns offline-zone /dev/nvme0 -a -n 1
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-open-zone.1 b/Documentation/nvme-zns-open-zone.1
new file mode 100644
index 0000000..8ea78f2
--- /dev/null
+++ b/Documentation/nvme-zns-open-zone.1
@@ -0,0 +1,84 @@
+'\" t
+.\"     Title: nvme-zns-open-zone
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-OPEN\-ZON" "1" "10/20/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-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]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the "Open Zone" action\&. This will transition the zone to the opened state\&.
+.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
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to open\&.
+.RE
+.PP
+\-a, \-\-select\-all
+.RS 4
+Select all zones for this action
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Open the first zone on namespace 1:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns open\-zone /dev/nvme0 \-n 1 \-s 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-open-zone.html b/Documentation/nvme-zns-open-zone.html
new file mode 100644
index 0000000..5a648b2
--- /dev/null
+++ b/Documentation/nvme-zns-open-zone.html
@@ -0,0 +1,841 @@
+
+
+
+
+
+
+nvme-zns-open-zone(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns open-zone nvme zns id-ctrl <device> [--namespace-id=<NUM> | -n <NUM>]
+                                                [--start-lba=<LBA> | -s <LBA>]
+                                                [--select-all | -a]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+"Open Zone" action. This will transition the zone to the opened state.

+
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

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to open.
+

+

+

+-a
+

+

+--select-all
+

+

+

+        Select all zones for this action
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Open the first zone on namespace 1:
+
    
+
    
+
    
+
    # nvme zns open-zone /dev/nvme0 -n 1 -s 0
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-open-zone.txt b/Documentation/nvme-zns-open-zone.txt
new file mode 100644
index 0000000..23acf1c
--- /dev/null
+++ b/Documentation/nvme-zns-open-zone.txt
@@ -0,0 +1,49 @@
+nvme-zns-open-zone(1)
+======================
+
+NAME
+----
+nvme-zns-open-zone - Opens one or all zones
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns open-zone nvme zns id-ctrl'  [--namespace-id= | -n ]
+						[--start-lba= | -s ]
+						[--select-all | -a]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+"Open Zone" action. This will transition the zone to the opened state.
+
+The  parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to open. 
+
+-a::
+--select-all::
+	Select all zones for this action
+
+EXAMPLES
+--------
+* Open the first zone on namespace 1:
++
+------------
+# nvme zns open-zone /dev/nvme0 -n 1 -s 0
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-report-zones.1 b/Documentation/nvme-zns-report-zones.1
new file mode 100644
index 0000000..a1ec86e
--- /dev/null
+++ b/Documentation/nvme-zns-report-zones.1
@@ -0,0 +1,198 @@
+'\" t
+.\"     Title: nvme-zns-report-zones
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-REPORT\-Z" "1" "10/20/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-zns-report-zones \- Retrieve and display the Report Zones data structure
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns report\-zones\fR  [\-\-namespace\-id= | \-n ]
+                                 [\-\-start\-lba= | \-s ]
+                                 [\-\-descs= | \-d ]
+                                 [\-\-state= | \-S ]
+                                 [\-\-extended | \-e]
+                                 [\-\-partial | \-p]
+                                 [\-\-verbose | \-v]
+                                 [\-\-output\-format= | \-o ]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, sends the Zone Management Receive command with the Zone Receive Action set to either Report Zones or Extended Report Zones, depending on the \fIextended\fR option\&.
+.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 data structure returned by the device will be decoded and displayed in one of several ways\&.
+.SH "OPTIONS"
+.PP
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to begin the report
+.RE
+.PP
+\-d , \-\-descs=
+.RS 4
+The number of descriptors to request in the report\&.
+.RE
+.PP
+\-S , \-\-state=
+.RS 4
+The state of zones to request in the report\&. Known values include:
+.TS
+allbox tab(:);
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt
+lt lt.
+T{
+Value
+T}:T{
+Definition
+T}
+T{
+0
+T}:T{
+List all zones (default)
+T}
+T{
+1
+T}:T{
+Empty State
+T}
+T{
+2
+T}:T{
+Implicitly Opened State
+T}
+T{
+3
+T}:T{
+Explicitly Opened State
+T}
+T{
+4
+T}:T{
+Closed State
+T}
+T{
+5
+T}:T{
+Full State
+T}
+T{
+6
+T}:T{
+Read Only State
+T}
+T{
+7
+T}:T{
+Offline State
+T}
+.TE
+.sp 1
+.RE
+.PP
+\-e, \-\-extended
+.RS 4
+Request to use the Extended Report Zones option\&. The extended data is not decoded\&.
+.RE
+.PP
+\-p, \-\-partial
+.RS 4
+If set, the device will return the number of zones that match the state rather than the number of zones returned in the report\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.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
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Has the program interpret the report for 16 zones, and display the known fields in a human readable format:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns report\-zones /dev/nvme0 \-n 1 \-d 16
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Show the output in json format with extra details
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns report\-zones /dev/nvme0 \-n 1 \-d 16 \-o json
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-report-zones.html b/Documentation/nvme-zns-report-zones.html
new file mode 100644
index 0000000..fbdde5c
--- /dev/null
+++ b/Documentation/nvme-zns-report-zones.html
@@ -0,0 +1,964 @@
+
+
+
+
+
+
+nvme-zns-report-zones(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns report-zones <device> [--namespace-id=<NUM> | -n <NUM>]
+                                 [--start-lba=<IONUM> | -s <IONUM>]
+                                 [--descs=<NUM> | -d <NUM>]
+                                 [--state=<NUM> | -S <NUM>]
+                                 [--extended | -e]
+                                 [--partial | -p]
+                                 [--verbose | -v]
+                                 [--output-format=<FMT> | -o <FMT>]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, sends the Zone Management Receive command with the
+Zone Receive Action set to either Report Zones or Extended Report Zones,
+depending on the extended option.

+
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 data structure returned by the device will be decoded and
+displayed in one of several ways.

+

+

+

+
OPTIONS

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to begin the report
+

+

+

+-d <NUM>
+

+

+--descs=<NUM>
+

+

+

+        The number of descriptors to request in the report.
+

+

+

+-S <NUM>
+

+

+--state=<NUM>
+

+

+

+        The state of zones to request in the report. Known values include:
+

+

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



Value
Definition
0
List all zones (default)
1
Empty State
2
Implicitly Opened State
3
Explicitly Opened State
4
Closed State
5
Full State
6
Read Only State
7
Offline State

+

+

+

+-e
+

+

+--extended
+

+

+

+        Request to use the Extended Report Zones option. The extended data is
+        not decoded.
+

+

+

+-p
+

+

+--partial
+

+

+

+        If set, the device will return the number of zones that match the state
+        rather than the number of zones returned in the report.
+

+

+

+-v
+

+

+--verbose
+

+

+

+        Increase the information detail in the output.
+

+

+

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

+

+
    
+
  • 
+
    
+Has the program interpret the report for 16 zones, and display the known
+fields in a human readable format:
+
    
+
    
+
    
+
    # nvme zns report-zones /dev/nvme0 -n 1 -d 16
    
+
    
+
    • 
+
  • 
+
    
+Show the output in json format with extra details
+
    
+
    
+
    
+
    # nvme zns report-zones /dev/nvme0 -n 1 -d 16 -o json
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-report-zones.txt b/Documentation/nvme-zns-report-zones.txt
new file mode 100644
index 0000000..35d5eda
--- /dev/null
+++ b/Documentation/nvme-zns-report-zones.txt
@@ -0,0 +1,102 @@
+nvme-zns-report-zones(1)
+========================
+
+NAME
+----
+nvme-zns-report-zones - Retrieve and display the Report Zones data structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns report-zones'  [--namespace-id= | -n ]
+				 [--start-lba= | -s ]
+				 [--descs= | -d ]
+				 [--state= | -S ]
+				 [--extended | -e]
+				 [--partial | -p]
+				 [--verbose | -v]
+				 [--output-format= | -o ]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the Zone Management Receive command with the
+Zone Receive Action set to either Report Zones or Extended Report Zones,
+depending on the 'extended' option.
+
+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 data structure returned by the device will be decoded and
+displayed in one of several ways. 
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to begin the report
+
+-d ::
+--descs=::
+	The number of descriptors to request in the report.
+
+-S ::
+--state=::
+	The state of zones to request in the report. Known values include:
++
+[]
+|=================
+|Value|Definition
+|0|List all zones (default)
+|1|Empty State
+|2|Implicitly Opened State
+|3|Explicitly Opened State
+|4|Closed State
+|5|Full State
+|6|Read Only State
+|7|Offline State
+|=================
+
+-e::
+--extended::
+	Request to use the Extended Report Zones option. The extended data is
+	not decoded.
+
+-p::
+--partial::
+	If set, the device will return the number of zones that match the state
+	rather than the number of zones returned in the report.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+-o ::
+--output-format=::
+              Set the reporting format to 'normal', 'json', or
+              'binary'. Only one output format can be used at a time.
+
+EXAMPLES
+--------
+* Has the program interpret the report for 16 zones, and display the known
+fields in a human readable format:
++
+------------
+# nvme zns report-zones /dev/nvme0 -n 1 -d 16
+------------
++
+
+* Show the output in json format with extra details
++
+------------
+# nvme zns report-zones /dev/nvme0 -n 1 -d 16 -o json
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-reset-zone.1 b/Documentation/nvme-zns-reset-zone.1
new file mode 100644
index 0000000..b02d042
--- /dev/null
+++ b/Documentation/nvme-zns-reset-zone.1
@@ -0,0 +1,84 @@
+'\" t
+.\"     Title: nvme-zns-reset-zone
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-RESET\-ZO" "1" "10/20/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-zns-reset-zone \- Resets one or all zones
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns reset\-zone\fR  [\-\-namespace\-id= | \-n ]
+                               [\-\-start\-lba= | \-s ]
+                               [\-\-select\-all | \-a]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the "Reset Zone" action\&. This will transition the zone to the empty state, setting the write pointer for each zone back to the beginning on success\&.
+.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
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to reset\&.
+.RE
+.PP
+\-a, \-\-select\-all
+.RS 4
+Select all zones for this action
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Reset the first zone on namespace 1:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns reset\-zone /dev/nvme0 \-n 1 \-s 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-reset-zone.html b/Documentation/nvme-zns-reset-zone.html
new file mode 100644
index 0000000..46545b2
--- /dev/null
+++ b/Documentation/nvme-zns-reset-zone.html
@@ -0,0 +1,842 @@
+
+
+
+
+
+
+nvme-zns-reset-zone(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns reset-zone <device> [--namespace-id=<NUM> | -n <NUM>]
+                               [--start-lba=<LBA> | -s <LBA>]
+                               [--select-all | -a]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+"Reset Zone" action. This will transition the zone to the empty state, setting
+the write pointer for each zone back to the beginning on success.

+
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

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to reset.
+

+

+

+-a
+

+

+--select-all
+

+

+

+        Select all zones for this action
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Reset the first zone on namespace 1:
+
    
+
    
+
    
+
    # nvme zns reset-zone /dev/nvme0 -n 1 -s 0
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-reset-zone.txt b/Documentation/nvme-zns-reset-zone.txt
new file mode 100644
index 0000000..a04fd66
--- /dev/null
+++ b/Documentation/nvme-zns-reset-zone.txt
@@ -0,0 +1,50 @@
+nvme-zns-reset-zone(1)
+======================
+
+NAME
+----
+nvme-zns-reset-zone - Resets one or all zones
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns reset-zone'  [--namespace-id= | -n ]
+			       [--start-lba= | -s ]
+			       [--select-all | -a]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+"Reset Zone" action. This will transition the zone to the empty state, setting
+the write pointer for each zone back to the beginning on success.
+
+The  parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to reset. 
+
+-a::
+--select-all::
+	Select all zones for this action
+
+EXAMPLES
+--------
+* Reset the first zone on namespace 1:
++
+------------
+# nvme zns reset-zone /dev/nvme0 -n 1 -s 0
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-set-zone-desc.1 b/Documentation/nvme-zns-set-zone-desc.1
new file mode 100644
index 0000000..a33b06a
--- /dev/null
+++ b/Documentation/nvme-zns-set-zone-desc.1
@@ -0,0 +1,82 @@
+'\" t
+.\"     Title: nvme-zns-set-zone-desc
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-SET\-ZONE" "1" "10/20/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-zns-set-zone-desc \- Set extended descriptor data for a zone
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns setzone\-desc\fR  [\-\-namespace\-id= | \-n ]
+                                 [\-\-start\-lba=, \-s ]
+                                 [\-data=, \-d ]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the Set Zone Descriptor Extenions action\&. The input will default to stdin\&. Alternatively, the data may come from a file that can be specified\&. The data length will automatically be calculated from the zns identify namesapce\&.
+.SH "OPTIONS"
+.PP
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to manage send\&.
+.RE
+.PP
+\-d 
+.RS 4
+Optional file for data (default stdin)
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Write "hello world" into the zone descriptor for namespace 1\(cqs first zone (requires device supports a large enough zone extended data)
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# echo "hello world" | nvme zns set\-zone\-desc /dev/nvme0 \-n 1 \-s 0
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-set-zone-desc.html b/Documentation/nvme-zns-set-zone-desc.html
new file mode 100644
index 0000000..b69be1f
--- /dev/null
+++ b/Documentation/nvme-zns-set-zone-desc.html
@@ -0,0 +1,842 @@
+
+
+
+
+
+
+nvme-zns-set-zone-desc(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns setzone-desc <device> [--namespace-id=<NUM> | -n <NUM>]
+                                 [--start-lba=<IONUM>, -s <IONUM>]
+                                 [-data=<FILE>, -d <FILE>]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+Set Zone Descriptor Extenions action. The input will default to stdin.
+Alternatively, the data may come from a file that can be specified. The data
+length will automatically be calculated from the zns identify namesapce.

+

+

+

+
OPTIONS

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to manage send.
+

+

+

+-d <FILE
+

+

+-data=<FILE>
+

+

+

+        Optional file for data (default stdin)
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Write "hello world" into the zone descriptor for namespace 1’s first zone
+  (requires device supports a large enough zone extended data)
+
    
+
    
+
    
+
    # echo "hello world" | nvme zns set-zone-desc /dev/nvme0 -n 1 -s 0
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-set-zone-desc.txt b/Documentation/nvme-zns-set-zone-desc.txt
new file mode 100644
index 0000000..5df3ecb
--- /dev/null
+++ b/Documentation/nvme-zns-set-zone-desc.txt
@@ -0,0 +1,50 @@
+nvme-zns-set-zone-desc(1)
+=========================
+
+NAME
+----
+nvme-zns-set-zone-desc - Set extended descriptor data for a zone
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns setzone-desc'  [--namespace-id= | -n ]
+				 [--start-lba=, -s ]
+				 [-data=, -d ]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+Set Zone Descriptor Extenions action. The input will default to stdin.
+Alternatively, the data may come from a file that can be specified. The data
+length will automatically be calculated from the zns identify namesapce.
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to manage send.
+
+-d ::
+	Optional file for data (default stdin)
+
+
+EXAMPLES
+--------
+* Write "hello world" into the zone descriptor for namespace 1's first zone
+  (requires device supports a large enough zone extended data) 
++
+------------
+# echo "hello world" | nvme zns set-zone-desc /dev/nvme0 -n 1 -s 0
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-zone-append.1 b/Documentation/nvme-zns-zone-append.1
new file mode 100644
index 0000000..494e265
--- /dev/null
+++ b/Documentation/nvme-zns-zone-append.1
@@ -0,0 +1,133 @@
+'\" t
+.\"     Title: nvme-zns-zone-append
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-ZONE\-APP" "1" "10/20/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-zns-zone-append \- Send an NVMe write command, provide results
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme\-zns\-zone\-append\fR  [\-\-namespace\-id= | \-n ]
+                                [\-\-zslba= | \-s ]
+                                [\-\-data\-size= | \-z ]
+                                [\-\-metadata\-size= | \-y ]
+                                [\-\-data= | \-d ]
+                                [\-\-metadata= | \-M ]
+                                [\-\-limited\-retry | \-l]
+                                [\-\-force\-unit\-access | \-f]
+                                [\-\-ref\-tag= | \-r ]
+                                [\-\-app\-tag\-mask= | \-m ]
+                                [\-\-app\-tag= | \-a ]
+                                [\-\-prinfo= | \-p ]
+.fi
+.SH "DESCRIPTION"
+.sp
+The zone append command writes the logical blocks specified by the command to the medium from the data data buffer provided\&. Will use stdin by default if you don\(cqt provide a file\&.
+.sp
+On sucess, the program will report the LBA that was assigned to the data for the append operation\&.
+.SH "OPTIONS"
+.PP
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-zslba=, \-z , \-\-data\-size=
+.RS 4
+Size of data, in bytes\&.
+.RE
+.PP
+\-y , \-\-metadata\-size=
+.RS 4
+Size of metadata in bytes\&.
+.RE
+.PP
+\-d , \-\-data=
+.RS 4
+Data file providing the data to write\&. If none provided, contents are sent from STDIN\&.
+.RE
+.PP
+\-M , \-\-metadata=
+.RS 4
+Metadata file, if necessary\&.
+.RE
+.PP
+\-l, \-\-limited\-retry
+.RS 4
+Sets the limited retry flag\&.
+.RE
+.PP
+\-f, \-\-force\-unit\-access
+.RS 4
+Set the force\-unit access flag\&.
+.RE
+.PP
+\-r , \-\-ref\-tag=
+.RS 4
+Optional reftag when used with protection information\&.
+.RE
+.PP
+\-m , \-\-app\-tag\-mask=
+.RS 4
+Optional application tag mask when used with protection information\&.
+.RE
+.PP
+\-a , \-\-app\-tag=
+.RS 4
+Optional application tag when used with protection information\&.
+.RE
+.PP
+\-p , \-\-prinfo=
+.RS 4
+Protection Information field definition\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Append the data "hello world" into 4k worth of blocks into the zone starting at block 0 for namespace 1:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# echo "hello world" | nvme zns zone\-append /dev/nvme0 \-n 1 \-s 0 \-z 4k
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of the nvme\-user suite
diff --git a/Documentation/nvme-zns-zone-append.html b/Documentation/nvme-zns-zone-append.html
new file mode 100644
index 0000000..5acc06a
--- /dev/null
+++ b/Documentation/nvme-zns-zone-append.html
@@ -0,0 +1,947 @@
+
+
+
+
+
+
+nvme-zns-zone-append(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme-zns-zone-append <device> [--namespace-id=<NUM> | -n <NUM>]
+                                [--zslba=<IONUM> | -s <IONUM>]
+                                [--data-size=<IONUM> | -z <IONUM>]
+                                [--metadata-size=<IONUM> | -y <IONUM>]
+                                [--data=<FILE> | -d <FILE>]
+                                [--metadata=<FILE> | -M <FILE>]
+                                [--limited-retry | -l]
+                                [--force-unit-access | -f]
+                                [--ref-tag=<NUM> | -r <NUM>]
+                                [--app-tag-mask=<NUM> | -m <NUM>]
+                                [--app-tag=<NUM> | -a <NUM>]
+                                [--prinfo=<NUM> | -p <NUM>]

+

+

+

+

+

+
DESCRIPTION

+

+
The zone append command writes the logical blocks specified by the command to
+the medium from the data data buffer provided. Will use stdin by default
+if you don’t provide a file.

+
On sucess, the program will report the LBA that was assigned to the data for
+the append operation.

+

+

+

+
OPTIONS

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <IONUM>
+

+

+--zslba=<IONUM>
+

+

+-z <IONUM>
+

+

+--data-size=<IONUM>
+

+

+

+        Size of data, in bytes.
+

+

+

+-y <IONUM>
+

+

+--metadata-size=<IONUM>
+

+

+

+        Size of metadata in bytes.
+

+

+

+-d <FILE>
+

+

+--data=<FILE>
+

+

+

+        Data file providing the data to write. If none provided, contents are
+        sent from STDIN.
+

+

+

+-M <FILE>
+

+

+--metadata=<FILE>
+

+

+

+        Metadata file, if necessary.
+

+

+

+-l
+

+

+--limited-retry
+

+

+

+        Sets the limited retry flag.
+

+

+

+-f
+

+

+--force-unit-access
+

+

+

+        Set the force-unit access flag.
+

+

+

+-r <NUM>
+

+

+--ref-tag=<NUM>
+

+

+

+        Optional reftag when used with protection information.
+

+

+

+-m <NUM>
+

+

+--app-tag-mask=<NUM>
+

+

+

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

+

+

+-a <NUM>
+

+

+--app-tag=<NUM>
+

+

+

+        Optional application tag when used with protection information.
+

+

+

+-p <NUM>
+

+

+--prinfo=<NUM>
+

+

+

+        Protection Information field definition.
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Append the data "hello world" into 4k worth of blocks into the zone starting
+  at block 0 for namespace 1:
+
    
+
    
+
    
+
    # echo "hello world" | nvme zns zone-append /dev/nvme0 -n 1 -s 0 -z 4k
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of the nvme-user suite

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-zone-append.txt b/Documentation/nvme-zns-zone-append.txt
new file mode 100644
index 0000000..37242a5
--- /dev/null
+++ b/Documentation/nvme-zns-zone-append.txt
@@ -0,0 +1,96 @@
+nvme-zns-zone-append(1)
+=======================
+
+NAME
+----
+nvme-zns-zone-append - Send an NVMe write command, provide results
+
+SYNOPSIS
+--------
+[verse]
+'nvme-zns-zone-append'  [--namespace-id= | -n ]
+				[--zslba= | -s ]
+				[--data-size= | -z ]
+				[--metadata-size= | -y ]
+				[--data= | -d ]
+				[--metadata= | -M ]
+				[--limited-retry | -l]
+				[--force-unit-access | -f]
+				[--ref-tag= | -r ]
+				[--app-tag-mask= | -m ]
+				[--app-tag= | -a ]
+				[--prinfo= | -p ]
+
+DESCRIPTION
+-----------
+The zone append command writes the logical blocks specified by the command to
+the medium from the data data buffer provided. Will use stdin by default
+if you don't provide a file.
+
+On sucess, the program will report the LBA that was assigned to the data for
+the append operation.
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--zslba=::
+
+-z ::
+--data-size=::
+	Size of data, in bytes.
+
+-y ::
+--metadata-size=::
+	Size of metadata in bytes.
+
+-d ::
+--data=::
+	Data file providing the data to write. If none provided, contents are
+	sent from STDIN.
+
+-M ::
+--metadata=::
+	Metadata file, if necessary.
+
+-l::
+--limited-retry::
+	Sets the limited retry flag.
+
+-f::
+--force-unit-access::
+	Set the force-unit access flag.
+
+-r ::
+--ref-tag=::
+	Optional reftag when used with protection information.
+
+-m ::
+--app-tag-mask=::
+	Optional application tag mask when used with protection information.
+
+-a ::
+--app-tag=::
+	Optional application tag when used with protection information.
+
+-p ::
+--prinfo=::
+	Protection Information field definition.
+
+EXAMPLES
+--------
+* Append the data "hello world" into 4k worth of blocks into the zone starting
+  at block 0 for namespace 1:
++
+------------
+# echo "hello world" | nvme zns zone-append /dev/nvme0 -n 1 -s 0 -z 4k
+------------
+
+NVME
+----
+Part of the nvme-user suite
diff --git a/Documentation/nvme-zns-zone-mgmt-recv.1 b/Documentation/nvme-zns-zone-mgmt-recv.1
new file mode 100644
index 0000000..26feb54
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-recv.1
@@ -0,0 +1,121 @@
+'\" t
+.\"     Title: nvme-zns-zone-mgmt-recv
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-ZONE\-MGM" "1" "10/20/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-zns-zone-mgmt-recv \- Zone Management Receive command
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns zone\-mgmt\-recv\fR  [\-\-namespace\-id= | \-n ]
+                                   [\-\-start\-lba= | \-s ]
+                                   [\-\-data\-len=, \-l ]
+                                   [\-\-zra=, \-z ]
+                                   [\-\-zrasf=, \-a ]
+                                   [\-\-zra\-spec\-feat, \-f]
+                                   [\-\-output\-format=, \-o ]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Receive command with the requested receive action and additional action specific parameters\&. This is the generic interface provided for forward compatibility as new actions are created that this program isn\(cqt aware of at the time of its development\&. As such, this is a generic command that does not do any additional decoding for specific types of data received\&. This will only report the data as a hex dump, or binary\&.
+.SH "OPTIONS"
+.PP
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to manage receive\&.
+.RE
+.sp
+\-\-data\-len= \-l  Received data buffer length
+.PP
+\-z , \-\-zra=
+.RS 4
+Zone Receive Action
+.RE
+.sp
+\-a  \-\-zrasf= Zone Receive Action Specific field
+.PP
+\-f, \-\-zra\-spec\-feat
+.RS 4
+Enable Zone Receive Action Specific features
+.RE
+.PP
+\-o , \-\-output\-format=
+.RS 4
+Output format: normal|json|binary
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Hex dump of a report all zones
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns zone\-mgmt\-recv /dev/nvme0 \-n 1 \-s 0 \-z 0 \-a 0 \-l 4k
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Binary dump of a report all zones
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns zone\-mgmt\-recv /dev/nvme0 \-n 1 \-s 0 \-z 0 \-a 0 \-o \-l 4k binary > report\&.out
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-zone-mgmt-recv.html b/Documentation/nvme-zns-zone-mgmt-recv.html
new file mode 100644
index 0000000..74d6a8d
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-recv.html
@@ -0,0 +1,889 @@
+
+
+
+
+
+
+nvme-zns-zone-mgmt-recv(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns zone-mgmt-recv <device> [--namespace-id=<NUM> | -n <NUM>]
+                                   [--start-lba=<LBA> | -s <LBA>]
+                                   [--data-len=<IONUM>, -l <IONUM>]
+                                   [--zra=<NUM>, -z <NUM>]
+                                   [--zrasf=<NUM>, -a <NUM>]
+                                   [--zra-spec-feat, -f]
+                                   [--output-format=<FMT>, -o <FMT>]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Receive command with the
+requested receive action and additional action specific parameters. This is the
+generic interface provided for forward compatibility as new actions are created
+that this program isn’t aware of at the time of its development. As such, this
+is a generic command that does not do any additional decoding for specific
+types of data received. This will only report the data as a hex dump, or
+binary.

+

+

+

+
OPTIONS

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to manage receive.
+

+

+

+
--data-len=<NUM>
+-l <NUM>
+        Received data buffer length

+

+

+-z <NUM>
+

+

+--zra=<NUM>
+

+

+

+        Zone Receive Action
+

+

+

+
-a <NUM>
+--zrasf=<NUM>
+        Zone Receive Action Specific field

+

+

+-f
+

+

+--zra-spec-feat
+

+

+

+        Enable Zone Receive Action Specific features
+

+

+

+-o <FMT>
+

+

+--output-format=<FMT>
+

+

+

+        Output format: normal|json|binary
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Hex dump of a report all zones
+
    
+
    
+
    
+
    # nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -l 4k
    
+
    
+
    • 
+
  • 
+
    
+Binary dump of a report all zones
+
    
+
    
+
    
+
    # nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -o -l 4k binary > report.out
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-zone-mgmt-recv.txt b/Documentation/nvme-zns-zone-mgmt-recv.txt
new file mode 100644
index 0000000..07cd98e
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-recv.txt
@@ -0,0 +1,78 @@
+nvme-zns-zone-mgmt-recv(1)
+==========================
+
+NAME
+----
+nvme-zns-zone-mgmt-recv - Zone Management Receive command
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns zone-mgmt-recv'  [--namespace-id= | -n ]
+				   [--start-lba= | -s ]
+				   [--data-len=, -l ]
+				   [--zra=, -z ]
+				   [--zrasf=, -a ]
+				   [--zra-spec-feat, -f]
+				   [--output-format=, -o ]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Receive command with the
+requested receive action and additional action specific parameters. This is the
+generic interface provided for forward compatibility as new actions are created
+that this program isn't aware of at the time of its development. As such, this
+is a generic command that does not do any additional decoding for specific
+types of data received. This will only report the data as a hex dump, or
+binary. 
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to manage receive.
+
+--data-len=
+-l 
+	Received data buffer length
+
+-z ::
+--zra=::
+	Zone Receive Action
+
+-a 
+--zrasf=
+	Zone Receive Action Specific field
+
+-f::
+--zra-spec-feat::
+	Enable Zone Receive Action Specific features
+
+-o ::
+--output-format=::
+	Output format: normal|json|binary
+
+EXAMPLES
+--------
+* Hex dump of a report all zones
++
+------------
+# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -l 4k
+------------
++
+
+* Binary dump of a report all zones
++
+------------
+# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -o -l 4k binary > report.out
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme-zns-zone-mgmt-send.1 b/Documentation/nvme-zns-zone-mgmt-send.1
new file mode 100644
index 0000000..f74d8a3
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-send.1
@@ -0,0 +1,126 @@
+'\" t
+.\"     Title: nvme-zns-zone-mgmt-send
+.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot 
+.\"      Date: 10/20/2020
+.\"    Manual: NVMe Manual
+.\"    Source: NVMe
+.\"  Language: English
+.\"
+.TH "NVME\-ZNS\-ZONE\-MGM" "1" "10/20/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-zns-zone-mgmt-send \- Zone Management Send command
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme zns zone\-mgmt\-send\fR  [\-\-namespace\-id= | \-n ]
+                                   [\-\-start\-lba=, \-s ]
+                                   [\-\-select\-all, \-a]
+                                   [\-\-zsa=, \-z ]
+                                   [\-\-data\-len=, \-l ]
+                                   [\-data=, \-d ]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, issues the Zone Management Send command with the requested send action\&. If the send requires additional data, you may specify the data length\&. If data is required, the input will default to stdin\&. Alternatively, the data may come from a file that can be specified\&.
+.SH "OPTIONS"
+.PP
+\-n , \-\-namespace\-id=
+.RS 4
+Use the provided namespace id for the command\&. If not provided, the namespace id of the block device will be used\&. If the command is issued to a non\-block device, the parameter is required\&.
+.RE
+.PP
+\-s , \-\-start\-lba=
+.RS 4
+The starting LBA of the zone to manage send\&.
+.RE
+.PP
+\-l , \-\-data\-len=
+.RS 4
+Send data buffer length
+.RE
+.PP
+\-\-select\-all, \-a
+.RS 4
+Send command to all zones
+.RE
+.PP
+\-z , \-\-zsa=
+.RS 4
+Zone send action\&.
+.RE
+.PP
+\-l , \-\-data\-len=
+.RS 4
+Buffer length if data required
+.RE
+.PP
+\-d 
+.RS 4
+Optional file for data (default stdin)
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Send a zone management command with action set to 1 (close zone) to namespace 1\(cqs first zone:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme zns zone\-mgmt\-send /dev/nvme0 \-n 1 \-s 0 \-z 1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Write "hello world" into the zone descriptor for namespace 1\(cqs first zone (requires device supports a large enough zone extended data)
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# echo "hello world" | nvme zns zone\-mgmt\-send /dev/nvme0 \-n 1 \-s 0 \-z 0x10
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of nvme\-cli
diff --git a/Documentation/nvme-zns-zone-mgmt-send.html b/Documentation/nvme-zns-zone-mgmt-send.html
new file mode 100644
index 0000000..6305707
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-send.html
@@ -0,0 +1,899 @@
+
+
+
+
+
+
+nvme-zns-zone-mgmt-send(1)
+
+
+
+
+
+

+

+
SYNOPSIS

+

+

+
nvme zns zone-mgmt-send <device> [--namespace-id=<NUM> | -n <NUM>]
+                                   [--start-lba=<IONUM>, -s <IONUM>]
+                                   [--select-all, -a]
+                                   [--zsa=<NUM>, -z <NUM>]
+                                   [--data-len=<IONUM>, -l <IONUM>]
+                                   [-data=<FILE>, -d <FILE>]

+

+

+

+

+

+
DESCRIPTION

+

+
For the NVMe device given, issues the Zone Management Send command with the
+requested send action. If the send requires additional data, you may specify
+the data length. If data is required, the input will default to stdin.
+Alternatively, the data may come from a file that can be specified.

+

+

+

+
OPTIONS

+

+

+

+-n <NUM>
+

+

+--namespace-id=<NUM>
+

+

+

+        Use the provided namespace id for the command. If not provided, the
+        namespace id of the block device will be used. If the command is issued
+        to a non-block device, the parameter is required.
+

+

+

+-s <lba>
+

+

+--start-lba=<lba>
+

+

+

+        The starting LBA of the zone to manage send.
+

+

+

+-l <NUM>
+

+

+--data-len=<NUM>
+

+

+

+        Send data buffer length
+

+

+

+--select-all
+

+

+-a
+

+

+

+        Send command to all zones
+

+

+

+-z <NUM>
+

+

+--zsa=<NUM>
+

+

+

+        Zone send action.
+

+

+

+-l <IONUM>
+

+

+--data-len=<IONUM>
+

+

+

+        Buffer length if data required
+

+

+

+-d <FILE
+

+

+-data=<FILE>
+

+

+

+        Optional file for data (default stdin)
+

+

+

+

+

+

+
EXAMPLES

+

+
    
+
  • 
+
    
+Send a zone management command with action set to 1 (close zone) to namespace
+  1’s first zone:
+
    
+
    
+
    
+
    # nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 1
    
+
    
+
    • 
+
  • 
+
    
+Write "hello world" into the zone descriptor for namespace 1’s first zone
+  (requires device supports a large enough zone extended data)
+
    
+
    
+
    
+
    # echo "hello world" | nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 0x10
    
+
    
+
    • 
+

+

+

+

+
NVME

+

+
Part of nvme-cli

+

+

+

+

+
+
+
diff --git a/Documentation/nvme-zns-zone-mgmt-send.txt b/Documentation/nvme-zns-zone-mgmt-send.txt
new file mode 100644
index 0000000..e33b9a5
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-send.txt
@@ -0,0 +1,77 @@
+nvme-zns-zone-mgmt-send(1)
+==========================
+
+NAME
+----
+nvme-zns-zone-mgmt-send - Zone Management Send command
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns zone-mgmt-send'  [--namespace-id= | -n ]
+				   [--start-lba=, -s ]
+				   [--select-all, -a]
+				   [--zsa=, -z ]
+				   [--data-len=, -l ]
+				   [-data=, -d ]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Send command with the
+requested send action. If the send requires additional data, you may specify
+the data length. If data is required, the input will default to stdin.
+Alternatively, the data may come from a file that can be specified.
+
+OPTIONS
+-------
+-n ::
+--namespace-id=::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s ::
+--start-lba=::
+	The starting LBA of the zone to manage send.
+
+-l ::
+--data-len=::
+	Send data buffer length
+
+--select-all::
+-a::
+	Send command to all zones
+
+-z ::
+--zsa=::
+	Zone send action.
+
+-l ::
+--data-len=::
+	Buffer length if data required
+
+-d ::
+	Optional file for data (default stdin)
+
+
+EXAMPLES
+--------
+* Send a zone management command with action set to 1 (close zone) to namespace
+  1's first zone:
++
+------------
+# nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 1
+------------
++
+
+* Write "hello world" into the zone descriptor for namespace 1's first zone
+  (requires device supports a large enough zone extended data) 
++
+------------
+# echo "hello world" | nvme zns zone-mgmt-send /dev/nvme0 -n 1 -s 0 -z 0x10
+------------
+
+NVME
+----
+Part of nvme-cli
diff --git a/Documentation/nvme.1 b/Documentation/nvme.1
index 55dbfc8..295f5d1 100644
--- a/Documentation/nvme.1
+++ b/Documentation/nvme.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme
 .\"    Author: [see the "Authors" section]
-.\" Generator: DocBook XSL Stylesheets vsnapshot 
-.\"      Date: 04/24/2020
+.\" Generator: DocBook XSL Stylesheets v1.79.1 
+.\"      Date: 12/01/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME" "1" "04/24/2020" "NVMe" "NVMe Manual"
+.TH "NVME" "1" "12/01/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -85,7 +85,12 @@ Format namespace(s)
 .PP
 \fBnvme-fw-activate\fR(1)
 .RS 4
-F/W Activate
+F/W Activate (in old version < 1\&.2)
+.RE
+.PP
+\fBnvme-fw-commit\fR(1)
+.RS 4
+F/W Commit (in > 1\&.2)
 .RE
 .PP
 \fBnvme-fw-download\fR(1)
@@ -113,11 +118,21 @@ Generic Get Log
 Telemetry Host\-Initiated Log
 .RE
 .PP
+\fBnvme-changed-ns-list-log\fR(1)
+.RS 4
+Retrieve Changed Namespace List Log
+.RE
+.PP
 \fBnvme-smart-log\fR(1)
 .RS 4
 Retrieve Smart Log
 .RE
 .PP
+\fBnvme-ana-log\fR(1)
+.RS 4
+Retreive ANA(Asymmetric Namespace Access) Log
+.RE
+.PP
 \fBnvme-endurance-log\fR(1)
 .RS 4
 Retrieve endurance Log
@@ -128,6 +143,11 @@ Retrieve endurance Log
 Retrieve effects Log
 .RE
 .PP
+\fBnvme-self-test-log\fR(1)
+.RS 4
+Retrieve Device Self\-test Log
+.RE
+.PP
 \fBnvme-get-ns-id\fR(1)
 .RS 4
 Retrieve namespace identifier
@@ -148,6 +168,16 @@ Identify Controller
 Identify Namespace
 .RE
 .PP
+\fBnvme-id-nvmset\fR(1)
+.RS 4
+Identify NVM Set List
+.RE
+.PP
+\fBnvme-id-iocs\fR(1)
+.RS 4
+Identify I/O Command Set
+.RE
+.PP
 \fBnvme-create-ns\fR(1)
 .RS 4
 Create a new namespace
@@ -193,6 +223,21 @@ List all nvme controllers
 List controller in NVMe subsystem
 .RE
 .PP
+\fBnvme-list-subsys\fR(1)
+.RS 4
+List NVMe subsystems
+.RE
+.PP
+\fBnvme-reset\fR(1)
+.RS 4
+Reset a NVMe controller
+.RE
+.PP
+\fBnvme-device-self-test\fR(1)
+.RS 4
+Issue Device Self\-test Command
+.RE
+.PP
 \fBnvme-read\fR(1)
 .RS 4
 Issue IO Read Command
@@ -243,6 +288,16 @@ Security Receive
 Security Send
 .RE
 .PP
+\fBnvme-dsm\fR(1)
+.RS 4
+Issue Data Set Management Command
+.RE
+.PP
+\fBnvme-copy\fR(1)
+.RS 4
+Issue Simple Copy Command
+.RE
+.PP
 \fBnvme-set-feature\fR(1)
 .RS 4
 Set Feature
diff --git a/Documentation/nvme.html b/Documentation/nvme.html
index 5f9856c..6153179 100644
--- a/Documentation/nvme.html
+++ b/Documentation/nvme.html
@@ -839,7 +839,15 @@ available, run "nvme help".

 
 

 

-        F/W Activate
+        F/W Activate (in old version < 1.2)
+

+

+

+nvme-fw-commit(1)
+

+

+

+        F/W Commit (in > 1.2)
 

 

 

@@ -883,6 +891,14 @@ available, run "nvme help".
+nvme-changed-ns-list-log(1) +
+
+

+ Retrieve Changed Namespace List Log +

+
+
nvme-smart-log(1)
@@ -891,6 +907,14 @@ available, run "nvme help".

+nvme-ana-log(1) +
+
+

+ Retreive ANA(Asymmetric Namespace Access) Log +

+
+
nvme-endurance-log(1)
@@ -907,6 +931,14 @@ available, run "nvme help".

+nvme-self-test-log(1) +
+
+

+ Retrieve Device Self-test Log +

+
+
nvme-get-ns-id(1)
@@ -939,6 +971,22 @@ available, run "nvme help".

+nvme-id-nvmset(1) +
+
+

+ Identify NVM Set List +

+
+
+nvme-id-iocs(1) +
+
+

+ Identify I/O Command Set +

+
+
nvme-create-ns(1)
@@ -1011,6 +1059,30 @@ available, run "nvme help".

+nvme-list-subsys(1) +
+
+

+ List NVMe subsystems +

+
+
+nvme-reset(1) +
+
+

+ Reset a NVMe controller +

+
+
+nvme-device-self-test(1) +
+
+

+ Issue Device Self-test Command +

+
+
nvme-read(1)
@@ -1091,6 +1163,22 @@ available, run "nvme help".

+nvme-dsm(1) +
+
+

+ Issue Data Set Management Command +

+
+
+nvme-copy(1) +
+
+

+ Issue Simple Copy Command +

+
+
nvme-set-feature(1)
@@ -1190,7 +1278,7 @@ NVM-Express Site.

-- cgit v1.2.3