From 50aec1e4c5bf1a9dd6329ac2d8d5d003c6601547 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 16 Feb 2025 12:13:36 +0100 Subject: [PATCH] Adding upstream version 1.16. Signed-off-by: Daniel Baumann --- .github/workflows/c-cpp.yml | 6 +- Documentation/nvme-admin-passthru.1 | 8 +- Documentation/nvme-admin-passthru.html | 2 +- Documentation/nvme-ana-log.1 | 4 +- Documentation/nvme-ana-log.html | 2 +- Documentation/nvme-attach-ns.1 | 4 +- Documentation/nvme-attach-ns.html | 23 +- ...vme-zns-id-ctrl.1 => nvme-boot-part-log.1} | 53 +- ...metry-log.html => nvme-boot-part-log.html} | 55 +- Documentation/nvme-boot-part-log.txt | 51 + Documentation/nvme-capacity-mgmt.1 | 8 +- Documentation/nvme-changed-ns-list-log.1 | 4 +- Documentation/nvme-changed-ns-list-log.html | 2 +- ...vme-ns-descs.1 => nvme-cmdset-ind-id-ns.1} | 59 +- ...d-ctrl.html => nvme-cmdset-ind-id-ns.html} | 80 +- Documentation/nvme-cmdset-ind-id-ns.txt | 86 + Documentation/nvme-compare.1 | 8 +- Documentation/nvme-connect-all.1 | 12 +- Documentation/nvme-connect-all.html | 23 +- Documentation/nvme-connect.1 | 21 +- Documentation/nvme-copy.1 | 4 +- Documentation/nvme-copy.html | 2 +- Documentation/nvme-create-ns.1 | 4 +- Documentation/nvme-create-ns.html | 2 +- Documentation/nvme-delete-ns.1 | 4 +- Documentation/nvme-delete-ns.html | 14 +- Documentation/nvme-dera-stat.1 | 4 +- Documentation/nvme-dera-stat.html | 30 +- Documentation/nvme-detach-ns.1 | 4 +- Documentation/nvme-detach-ns.html | 14 +- Documentation/nvme-device-self-test.1 | 4 +- Documentation/nvme-device-self-test.html | 2 +- Documentation/nvme-dir-receive.1 | 4 +- Documentation/nvme-dir-receive.html | 1951 ++++++++-------- Documentation/nvme-dir-send.1 | 4 +- Documentation/nvme-dir-send.html | 1977 +++++++++-------- Documentation/nvme-disconnect-all.1 | 4 +- Documentation/nvme-disconnect-all.html | 14 +- Documentation/nvme-disconnect.1 | 4 +- Documentation/nvme-disconnect.html | 2 +- Documentation/nvme-discover.1 | 27 +- Documentation/nvme-discover.html | 49 +- Documentation/nvme-dsm.1 | 4 +- Documentation/nvme-dsm.html | 14 +- Documentation/nvme-effects-log.1 | 4 +- Documentation/nvme-effects-log.html | 2 +- Documentation/nvme-endurance-event-agg-log.1 | 8 +- .../nvme-endurance-event-agg-log.html | 2 +- Documentation/nvme-endurance-log.1 | 4 +- Documentation/nvme-endurance-log.html | 2 +- Documentation/nvme-error-log.1 | 4 +- Documentation/nvme-error-log.html | 2 +- ...-name.1 => nvme-fid-support-effects-log.1} | 45 +- ...html => nvme-fid-support-effects-log.html} | 43 +- .../nvme-fid-support-effects-log.txt | 43 + Documentation/nvme-flush.1 | 4 +- Documentation/nvme-flush.html | 14 +- Documentation/nvme-format.1 | 4 +- Documentation/nvme-format.html | 2 +- Documentation/nvme-fw-commit.1 | 4 +- Documentation/nvme-fw-commit.html | 14 +- Documentation/nvme-fw-download.1 | 4 +- Documentation/nvme-fw-download.html | 2 +- Documentation/nvme-fw-log.1 | 4 +- Documentation/nvme-fw-log.html | 14 +- Documentation/nvme-gen-hostnqn.1 | 4 +- Documentation/nvme-gen-hostnqn.html | 14 +- Documentation/nvme-get-feature.1 | 8 +- Documentation/nvme-get-feature.html | 2 +- Documentation/nvme-get-lba-status.1 | 8 +- Documentation/nvme-get-lba-status.html | 2 +- Documentation/nvme-get-log.1 | 8 +- Documentation/nvme-get-ns-id.1 | 4 +- Documentation/nvme-get-ns-id.html | 2 +- Documentation/nvme-get-property.1 | 4 +- Documentation/nvme-get-property.html | 14 +- Documentation/nvme-help.1 | 4 +- Documentation/nvme-help.html | 2 +- Documentation/nvme-huawei-id-ctrl.1 | 4 +- Documentation/nvme-huawei-id-ctrl.html | 2 +- Documentation/nvme-huawei-list.1 | 4 +- Documentation/nvme-huawei-list.html | 14 +- Documentation/nvme-id-ctrl.1 | 4 +- Documentation/nvme-id-ctrl.html | 14 +- Documentation/nvme-id-domain.1 | 8 +- Documentation/nvme-id-iocs.1 | 8 +- Documentation/nvme-id-iocs.html | 2 +- Documentation/nvme-id-ns.1 | 4 +- Documentation/nvme-id-ns.html | 2 +- Documentation/nvme-id-nvmset.1 | 4 +- Documentation/nvme-id-nvmset.html | 2 +- Documentation/nvme-intel-id-ctrl.1 | 4 +- Documentation/nvme-intel-id-ctrl.html | 14 +- Documentation/nvme-intel-internal-log.1 | 4 +- Documentation/nvme-intel-internal-log.html | 40 +- Documentation/nvme-intel-lat-stats.1 | 4 +- Documentation/nvme-intel-lat-stats.html | 14 +- Documentation/nvme-intel-market-name.1 | 4 +- Documentation/nvme-intel-market-name.html | 14 +- Documentation/nvme-intel-smart-log-add.1 | 4 +- Documentation/nvme-intel-smart-log-add.html | 2 +- Documentation/nvme-intel-temp-stats.1 | 4 +- Documentation/nvme-intel-temp-stats.html | 2 +- Documentation/nvme-io-passthru.1 | 8 +- Documentation/nvme-io-passthru.html | 2 +- Documentation/nvme-lba-status-log.1 | 8 +- Documentation/nvme-lba-status-log.html | 2 +- Documentation/nvme-list-ctrl.1 | 10 +- Documentation/nvme-list-ctrl.html | 6 +- Documentation/nvme-list-ctrl.txt | 4 +- .../{nvme-list.1 => nvme-list-endgrp.1} | 28 +- ...vme-ana-log.html => nvme-list-endgrp.html} | 55 +- Documentation/nvme-list-endgrp.txt | 43 + Documentation/nvme-list-ns.1 | 8 +- Documentation/nvme-list-ns.html | 2 +- Documentation/nvme-list-subsys.1 | 4 +- Documentation/nvme-list-subsys.html | 14 +- Documentation/nvme-list.1 | 4 +- Documentation/nvme-list.html | 12 +- Documentation/nvme-lnvm-create.1 | 4 +- Documentation/nvme-lnvm-create.html | 2 +- Documentation/nvme-lnvm-diag-bbtbl.1 | 4 +- Documentation/nvme-lnvm-diag-bbtbl.html | 14 +- Documentation/nvme-lnvm-diag-set-bbtbl.1 | 4 +- Documentation/nvme-lnvm-diag-set-bbtbl.html | 2 +- Documentation/nvme-lnvm-factory.1 | 4 +- Documentation/nvme-lnvm-factory.html | 14 +- Documentation/nvme-lnvm-id-ns.1 | 4 +- Documentation/nvme-lnvm-id-ns.html | 2 +- Documentation/nvme-lnvm-info.1 | 4 +- Documentation/nvme-lnvm-info.html | 14 +- Documentation/nvme-lnvm-init.1 | 4 +- Documentation/nvme-lnvm-init.html | 14 +- Documentation/nvme-lnvm-list.1 | 4 +- Documentation/nvme-lnvm-list.html | 14 +- Documentation/nvme-lnvm-remove.1 | 4 +- Documentation/nvme-lnvm-remove.html | 14 +- Documentation/nvme-lockdown.1 | 75 + ...diag-set-bbtbl.html => nvme-lockdown.html} | 80 +- Documentation/nvme-lockdown.txt | 56 + Documentation/nvme-micron-clear-pcie-errors.1 | 4 +- .../nvme-micron-clear-pcie-errors.html | 20 +- Documentation/nvme-micron-internal-log.1 | 4 +- Documentation/nvme-micron-internal-log.html | 20 +- Documentation/nvme-micron-nand-stats.1 | 4 +- Documentation/nvme-micron-nand-stats.html | 20 +- Documentation/nvme-micron-pcie-stats.1 | 4 +- Documentation/nvme-micron-pcie-stats.html | 20 +- .../nvme-micron-selective-download.1 | 4 +- .../nvme-micron-selective-download.html | 22 +- Documentation/nvme-micron-smart-add-log.1 | 8 +- Documentation/nvme-micron-smart-add-log.html | 1630 +++++++------- Documentation/nvme-micron-temperature-stats.1 | 4 +- .../nvme-micron-temperature-stats.html | 20 +- Documentation/nvme-netapp-ontapdevices.1 | 4 +- Documentation/nvme-netapp-ontapdevices.html | 12 +- Documentation/nvme-netapp-smdevices.1 | 4 +- Documentation/nvme-netapp-smdevices.html | 2 +- Documentation/nvme-ns-descs.1 | 4 +- Documentation/nvme-ns-descs.html | 7 +- Documentation/nvme-ns-rescan.1 | 4 +- Documentation/nvme-ns-rescan.html | 2 +- Documentation/nvme-nvm-id-ctrl.1 | 8 +- Documentation/nvme-nvm-id-ctrl.html | 2 +- Documentation/nvme-persistent-event-log.1 | 8 +- Documentation/nvme-persistent-event-log.html | 2 +- Documentation/nvme-pred-lat-event-agg-log.1 | 8 +- .../nvme-pred-lat-event-agg-log.html | 2 +- Documentation/nvme-predictable-lat-log.1 | 8 +- Documentation/nvme-predictable-lat-log.html | 2 +- Documentation/nvme-primary-ctrl-caps.1 | 8 +- Documentation/nvme-primary-ctrl-caps.html | 2 +- Documentation/nvme-read.1 | 8 +- Documentation/nvme-reset.1 | 4 +- Documentation/nvme-reset.html | 2 +- Documentation/nvme-resv-acquire.1 | 4 +- Documentation/nvme-resv-acquire.html | 7 +- Documentation/nvme-resv-notif-log.1 | 8 +- Documentation/nvme-resv-notif-log.html | 2 +- Documentation/nvme-resv-register.1 | 4 +- Documentation/nvme-resv-register.html | 2 +- Documentation/nvme-resv-release.1 | 4 +- Documentation/nvme-resv-release.html | 2 +- Documentation/nvme-resv-report.1 | 4 +- Documentation/nvme-rpmb.1 | 8 +- Documentation/nvme-rpmb.html | 2 +- Documentation/nvme-sanitize-log.1 | 8 +- Documentation/nvme-sanitize-log.html | 2 +- Documentation/nvme-sanitize.1 | 4 +- Documentation/nvme-sanitize.html | 1807 +++++++-------- Documentation/nvme-security-recv.1 | 4 +- Documentation/nvme-security-recv.html | 2 +- Documentation/nvme-security-send.1 | 4 +- Documentation/nvme-security-send.html | 2 +- Documentation/nvme-self-test-log.1 | 8 +- Documentation/nvme-self-test-log.html | 2 +- Documentation/nvme-set-feature.1 | 8 +- Documentation/nvme-set-feature.html | 2 +- Documentation/nvme-set-property.1 | 4 +- Documentation/nvme-set-property.html | 2 +- Documentation/nvme-show-hostnqn.1 | 4 +- Documentation/nvme-show-hostnqn.html | 2 +- Documentation/nvme-show-regs.1 | 4 +- Documentation/nvme-show-regs.html | 2 +- Documentation/nvme-smart-log.1 | 4 +- Documentation/nvme-smart-log.html | 2 +- Documentation/nvme-subsystem-reset.1 | 4 +- Documentation/nvme-subsystem-reset.html | 14 +- ...nvme-list.1 => nvme-supported-log-pages.1} | 31 +- ...log.html => nvme-supported-log-pages.html} | 54 +- Documentation/nvme-supported-log-pages.txt | 44 + Documentation/nvme-telemetry-log.1 | 6 +- Documentation/nvme-telemetry-log.html | 8 +- Documentation/nvme-telemetry-log.txt | 6 +- ...me-toshiba-clear-pcie-correctable-errors.1 | 4 +- ...toshiba-clear-pcie-correctable-errors.html | 7 +- Documentation/nvme-toshiba-vs-internal-log.1 | 4 +- .../nvme-toshiba-vs-internal-log.html | 2 +- Documentation/nvme-toshiba-vs-smart-add-log.1 | 4 +- .../nvme-toshiba-vs-smart-add-log.html | 7 +- Documentation/nvme-transcend-badblock.1 | 4 +- Documentation/nvme-transcend-badblock.html | 2 +- Documentation/nvme-transcend-healthvalue.1 | 4 +- Documentation/nvme-transcend-healthvalue.html | 2 +- Documentation/nvme-verify.1 | 8 +- .../nvme-virtium-save-smart-to-vtview-log.1 | 4 +- ...nvme-virtium-save-smart-to-vtview-log.html | 2 +- Documentation/nvme-virtium-show-identify.1 | 4 +- Documentation/nvme-virtium-show-identify.html | 12 +- Documentation/nvme-wdc-cap-diag.1 | 4 +- Documentation/nvme-wdc-cap-diag.html | 12 +- Documentation/nvme-wdc-capabilities.1 | 4 +- Documentation/nvme-wdc-capabilities.html | 6 +- Documentation/nvme-wdc-clear-assert-dump.1 | 4 +- Documentation/nvme-wdc-clear-assert-dump.html | 2 +- .../nvme-wdc-clear-fw-activate-history.1 | 4 +- .../nvme-wdc-clear-fw-activate-history.html | 2 +- Documentation/nvme-wdc-clear-pcie-corr.1 | 71 - Documentation/nvme-wdc-clear-pcie-corr.html | 806 ------- .../nvme-wdc-clear-pcie-correctable-errors.1 | 4 +- ...vme-wdc-clear-pcie-correctable-errors.html | 12 +- .../nvme-wdc-cloud-SSD-plugin-version.1 | 8 +- .../nvme-wdc-cloud-SSD-plugin-version.html | 12 +- Documentation/nvme-wdc-drive-essentials.1 | 4 +- Documentation/nvme-wdc-drive-essentials.html | 2 +- Documentation/nvme-wdc-drive-log.1 | 4 +- Documentation/nvme-wdc-drive-log.html | 14 +- Documentation/nvme-wdc-drive-resize.1 | 4 +- Documentation/nvme-wdc-drive-resize.html | 12 +- Documentation/nvme-wdc-enc-get-log.1 | 4 +- Documentation/nvme-wdc-enc-get-log.html | 2 +- Documentation/nvme-wdc-get-crash-dump.1 | 4 +- Documentation/nvme-wdc-get-crash-dump.html | 14 +- Documentation/nvme-wdc-get-drive-status.1 | 4 +- Documentation/nvme-wdc-get-drive-status.html | 12 +- ...s.1 => nvme-wdc-get-latency-monitor-log.1} | 27 +- ... => nvme-wdc-get-latency-monitor-log.html} | 28 +- .../nvme-wdc-get-latency-monitor-log.txt | 42 + Documentation/nvme-wdc-get-pfail-dump.1 | 4 +- Documentation/nvme-wdc-get-pfail-dump.html | 14 +- Documentation/nvme-wdc-id-ctrl.1 | 4 +- Documentation/nvme-wdc-id-ctrl.html | 2 +- Documentation/nvme-wdc-log-page-directory.1 | 4 +- .../nvme-wdc-log-page-directory.html | 2 +- Documentation/nvme-wdc-namespace-resize.1 | 4 +- Documentation/nvme-wdc-namespace-resize.html | 12 +- Documentation/nvme-wdc-purge-monitor.1 | 4 +- Documentation/nvme-wdc-purge-monitor.html | 2 +- Documentation/nvme-wdc-purge.1 | 4 +- Documentation/nvme-wdc-purge.html | 14 +- Documentation/nvme-wdc-smart-add-log.1 | 496 ----- Documentation/nvme-wdc-smart-add-log.html | 1139 ---------- Documentation/nvme-wdc-vs-drive-info.1 | 4 +- Documentation/nvme-wdc-vs-drive-info.html | 12 +- .../nvme-wdc-vs-error-reason-identifier.1 | 4 +- .../nvme-wdc-vs-error-reason-identifier.html | 2 +- .../nvme-wdc-vs-fw-activate-history.1 | 4 +- .../nvme-wdc-vs-fw-activate-history.html | 2 +- Documentation/nvme-wdc-vs-internal-log.1 | 4 +- Documentation/nvme-wdc-vs-internal-log.html | 6 +- Documentation/nvme-wdc-vs-nand-stats.1 | 4 +- Documentation/nvme-wdc-vs-nand-stats.html | 2 +- Documentation/nvme-wdc-vs-smart-add-log.1 | 16 +- Documentation/nvme-wdc-vs-smart-add-log.html | 23 +- Documentation/nvme-wdc-vs-smart-add-log.txt | 14 +- .../nvme-wdc-vs-telemetry-controller-option.1 | 4 +- ...me-wdc-vs-telemetry-controller-option.html | 2 +- Documentation/nvme-wdc-vs-temperature-stats.1 | 4 +- .../nvme-wdc-vs-temperature-stats.html | 6 +- Documentation/nvme-write-uncor.1 | 4 +- Documentation/nvme-write-uncor.html | 14 +- Documentation/nvme-write-zeroes.1 | 8 +- Documentation/nvme-write.1 | 8 +- Documentation/nvme-zns-changed-zone-list.1 | 4 +- Documentation/nvme-zns-changed-zone-list.html | 2 +- Documentation/nvme-zns-close-zone.1 | 10 +- Documentation/nvme-zns-close-zone.html | 28 +- Documentation/nvme-zns-close-zone.txt | 7 +- Documentation/nvme-zns-finish-zone.1 | 10 +- Documentation/nvme-zns-finish-zone.html | 28 +- Documentation/nvme-zns-finish-zone.txt | 7 +- Documentation/nvme-zns-id-ctrl.1 | 4 +- Documentation/nvme-zns-id-ctrl.html | 2 +- Documentation/nvme-zns-id-ns.1 | 4 +- Documentation/nvme-zns-id-ns.html | 22 +- Documentation/nvme-zns-offline-zone.1 | 10 +- Documentation/nvme-zns-offline-zone.html | 28 +- Documentation/nvme-zns-offline-zone.txt | 7 +- Documentation/nvme-zns-open-zone.1 | 10 +- Documentation/nvme-zns-open-zone.html | 28 +- Documentation/nvme-zns-open-zone.txt | 7 +- Documentation/nvme-zns-report-zones.1 | 4 +- Documentation/nvme-zns-report-zones.html | 2 +- Documentation/nvme-zns-reset-zone.1 | 10 +- Documentation/nvme-zns-reset-zone.html | 28 +- Documentation/nvme-zns-reset-zone.txt | 9 +- Documentation/nvme-zns-set-zone-desc.1 | 10 +- Documentation/nvme-zns-set-zone-desc.html | 26 +- Documentation/nvme-zns-set-zone-desc.txt | 4 + Documentation/nvme-zns-zone-append.1 | 4 +- Documentation/nvme-zns-zone-append.html | 2 +- Documentation/nvme-zns-zone-mgmt-recv.1 | 4 +- Documentation/nvme-zns-zone-mgmt-recv.html | 2 +- Documentation/nvme-zns-zone-mgmt-send.1 | 16 +- Documentation/nvme-zns-zone-mgmt-send.html | 26 +- Documentation/nvme-zns-zone-mgmt-send.txt | 4 + Documentation/nvme.1 | 6 +- Documentation/nvme.html | 2 +- Makefile | 2 +- NVME-VERSION-GEN | 2 +- completions/_nvme | 82 +- completions/bash-nvme-completion.sh | 49 +- fabrics.c | 34 +- linux/nvme.h | 103 +- nvme-builtin.h | 6 + nvme-ioctl.c | 47 +- nvme-ioctl.h | 12 +- nvme-models.c | 36 +- nvme-print.c | 548 ++++- nvme-print.h | 11 + nvme.c | 512 ++++- nvme.h | 8 +- plugins/wdc/wdc-nvme.c | 445 +++- plugins/wdc/wdc-nvme.h | 3 +- plugins/zns/zns.c | 118 +- 345 files changed, 7594 insertions(+), 7512 deletions(-) copy Documentation/{nvme-zns-id-ctrl.1 => nvme-boot-part-log.1} (64%) copy Documentation/{nvme-telemetry-log.html => nvme-boot-part-log.html} (89%) create mode 100644 Documentation/nvme-boot-part-log.txt copy Documentation/{nvme-ns-descs.1 => nvme-cmdset-ind-id-ns.1} (61%) copy Documentation/{nvme-intel-id-ctrl.html => nvme-cmdset-ind-id-ns.html} (86%) create mode 100644 Documentation/nvme-cmdset-ind-id-ns.txt copy Documentation/{nvme-intel-market-name.1 => nvme-fid-support-effects-log.1} (66%) copy Documentation/{nvme-primary-ctrl-caps.html => nvme-fid-support-effects-log.html} (89%) create mode 100644 Documentation/nvme-fid-support-effects-log.txt copy Documentation/{nvme-list.1 => nvme-list-endgrp.1} (59%) copy Documentation/{nvme-ana-log.html => nvme-list-endgrp.html} (88%) create mode 100644 Documentation/nvme-list-endgrp.txt create mode 100644 Documentation/nvme-lockdown.1 copy Documentation/{nvme-lnvm-diag-set-bbtbl.html => nvme-lockdown.html} (86%) create mode 100644 Documentation/nvme-lockdown.txt copy Documentation/{nvme-list.1 => nvme-supported-log-pages.1} (58%) copy Documentation/{nvme-ana-log.html => nvme-supported-log-pages.html} (89%) create mode 100644 Documentation/nvme-supported-log-pages.txt delete mode 100644 Documentation/nvme-wdc-clear-pcie-corr.1 delete mode 100644 Documentation/nvme-wdc-clear-pcie-corr.html copy Documentation/{nvme-wdc-capabilities.1 => nvme-wdc-get-latency-monitor-log.1} (64%) copy Documentation/{nvme-wdc-log-page-directory.html => nvme-wdc-get-latency-monitor-log.html} (90%) create mode 100644 Documentation/nvme-wdc-get-latency-monitor-log.txt delete mode 100644 Documentation/nvme-wdc-smart-add-log.1 delete mode 100644 Documentation/nvme-wdc-smart-add-log.html diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml index d2f94e9..03471d7 100644 --- a/.github/workflows/c-cpp.yml +++ b/.github/workflows/c-cpp.yml @@ -1,10 +1,10 @@ -name: C/C++ CI +gname: C/C++ CI on: push: - branches: [ master ] + branches: [ master nvme-cli-monolithic ] pull_request: - branches: [ master ] + branches: [ master nvme-cli-monolithic ] jobs: build: diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index 8cf0095..fecabb4 100644 --- a/Documentation/nvme-admin-passthru.1 +++ b/Documentation/nvme-admin-passthru.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-admin-passthru -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 06/04/2021 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "06/04/2021" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index 63a7a10..064f852 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -998,7 +998,7 @@ Or if you want to save that structure to a file: diff --git a/Documentation/nvme-ana-log.1 b/Documentation/nvme-ana-log.1 index 5ba4cc3..70d8f4d 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ANA\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ANA\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ana-log.html b/Documentation/nvme-ana-log.html index 131205a..6a96f5f 100644 --- a/Documentation/nvme-ana-log.html +++ b/Documentation/nvme-ana-log.html @@ -812,7 +812,7 @@ Print the ANA log page in a human readable format: diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1 index 37f63a8..fb81080 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ATTACH\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ATTACH\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-attach-ns.html b/Documentation/nvme-attach-ns.html index 9415c01..1bfe53f 100644 --- a/Documentation/nvme-attach-ns.html +++ b/Documentation/nvme-attach-ns.html @@ -1,9 +1,10 @@ + - + nvme-attach-ns(1) - - - - -
-
-

SYNOPSIS

-
-
-
nvme dir-receive <device> [--namespace-id=<nsid> | -n <nsid>]
-                          [--data-len=<data-len> | -l <data-len>]
-                          [--dir-type=<dtype> | -D <dtype>]
-                          [--dir-spec=<dspec> | -S <dspec>]
-                          [--dir-oper=<doper> | -O <doper>]
-                          [--req-resource=<nsr> | -r <nsr>]
-                          [--human-readable | -H]
-                          [--raw-binary | -b]
-
-
-
-
-
-

DESCRIPTION

-
-

Submits an NVMe Directive Receive admin command and returns the applicable -results. This may be the combination of directive type, and operation, as -well as number of requested resource if specific operation needs it.

-

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 directive’s parameter structure (if applicable) is -returned in one of several ways depending on the option flags; the -structure may parsed by the program and printed in a readable format -if it is a known structure, displayed in hex, or the raw buffer may be -printed to stdout for another program to parse.

-
-
-
-

OPTIONS

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

- Retrieve the feature for the given nsid. This is optional and - most features do not use this value. -

-
-
--D <dtype> -
-
---dir-type=<dtype> -
-
-

- Directive type -

-
-
--S <dspec> -
-
---dir-spec=<dspec> -
-
-

- Directive specific -

-
-
--O <doper> -
-
---dir-oper=<doper> -
-
-

- Directive operation -

-
-
--r <nsr> -
-
---req-resource=<nsr> -
-
-

- Directive requested resource count -

-
-
-

+

-
- --- - - - - - - - - - - - - - - - - - - - - - - - - - -

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4–7

Reserved

-
-
-
--l <data-len> -
-
---data-len=<data-len> -
-
-

- The data length for the buffer returned for this feature. Most - known features do not use this value. The exception is LBA - Range Type -

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

- Print the raw receive buffer to stdout if the command returns - a structure. -

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

- Print the decoded receive buffer to stdout if the command returns - a structure. -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Identify directive type supported : -

    -
    -
    -
    # nvme dir-receive /dev/nvme0 --dir-type 0 --dir-oper 1 --human-readable
    -
    -
  • -
  • -

    -Get stream directive parameters : -

    -
    -
    -
    # nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 1 --human-readable
    -
    -
  • -
  • -

    -Allocate 3 streams for namespace 1 -

    -
    -
    -
    # nvme dir-receive /dev/nvme0n1 --dir-type 1 --dir-oper 3 --req-resource 3 --human-readable
    -
    -
  • -
  • -

    -Get streams directive status : -

    -
    -
    -
    # nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 2 --human-readable
    -
    -

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

    -
  • -
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-

- - - + + + + + + +nvme-dir-receive(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme dir-receive <device> [--namespace-id=<nsid> | -n <nsid>]
+                          [--data-len=<data-len> | -l <data-len>]
+                          [--dir-type=<dtype> | -D <dtype>]
+                          [--dir-spec=<dspec> | -S <dspec>]
+                          [--dir-oper=<doper> | -O <doper>]
+                          [--req-resource=<nsr> | -r <nsr>]
+                          [--human-readable | -H]
+                          [--raw-binary | -b]
+
+
+
+
+
+

DESCRIPTION

+
+

Submits an NVMe Directive Receive admin command and returns the applicable +results. This may be the combination of directive type, and operation, as +well as number of requested resource if specific operation needs it.

+

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 directive’s parameter structure (if applicable) is +returned in one of several ways depending on the option flags; the +structure may parsed by the program and printed in a readable format +if it is a known structure, displayed in hex, or the raw buffer may be +printed to stdout for another program to parse.

+
+
+
+

OPTIONS

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

+ Retrieve the feature for the given nsid. This is optional and + most features do not use this value. +

+
+
+-D <dtype> +
+
+--dir-type=<dtype> +
+
+

+ Directive type +

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

+ Directive specific +

+
+
+-O <doper> +
+
+--dir-oper=<doper> +
+
+

+ Directive operation +

+
+
+-r <nsr> +
+
+--req-resource=<nsr> +
+
+

+ Directive requested resource count +

+
+
+

+

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

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4–7

Reserved

+
+
+
+-l <data-len> +
+
+--data-len=<data-len> +
+
+

+ The data length for the buffer returned for this feature. Most + known features do not use this value. The exception is LBA + Range Type +

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

+ Print the raw receive buffer to stdout if the command returns + a structure. +

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

+ Print the decoded receive buffer to stdout if the command returns + a structure. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Identify directive type supported : +

    +
    +
    +
    # nvme dir-receive /dev/nvme0 --dir-type 0 --dir-oper 1 --human-readable
    +
    +
  • +
  • +

    +Get stream directive parameters : +

    +
    +
    +
    # nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 1 --human-readable
    +
    +
  • +
  • +

    +Allocate 3 streams for namespace 1 +

    +
    +
    +
    # nvme dir-receive /dev/nvme0n1 --dir-type 1 --dir-oper 3 --req-resource 3 --human-readable
    +
    +
  • +
  • +

    +Get streams directive status : +

    +
    +
    +
    # nvme dir-receive /dev/nvme0 --dir-type 1 --dir-oper 2 --human-readable
    +
    +

    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-dir-send.1 b/Documentation/nvme-dir-send.1 index ebe17b3..fbc9a48 100644 --- a/Documentation/nvme-dir-send.1 +++ b/Documentation/nvme-dir-send.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dir-send .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-SEND" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-SEND" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dir-send.html b/Documentation/nvme-dir-send.html index 8132e5e..301be97 100644 --- a/Documentation/nvme-dir-send.html +++ b/Documentation/nvme-dir-send.html @@ -1,988 +1,989 @@ - - - - - -nvme-dir-send(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme dir-send <device> [--namespace-id=<nsid> | -n <nsid>]
-                          [--data-len=<data-len> | -l <data-len>]
-                          [--dir-type=<dtype> | -D <dtype>]
-                          [--dir-spec=<dspec> | -S <dspec>]
-                          [--dir-oper=<doper> | -O <doper>]
-                          [--endir=<endir> | -e <endir>]
-                          [--target-dir=<tdir> | -T <tdir>]
-                          [--human-readable | -H]
-                          [--raw-binary | -b]
-
-
-
-
-
-

DESCRIPTION

-
-

Submits an NVMe Directive Send admin command and returns the applicable -results. This may be the combination of directive type, and operation, as -well as target directive and its enable/disable status of the operation, -if specific operation needs it.

-

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 directive’s parameter structure (if applicable) is -returned in one of several ways depending on the option flags; the -structure may parsed by the program and printed in a readable format -if it is a known structure, displayed in hex, or the raw buffer may be -printed to stdout for another program to parse.

-
-
-
-

OPTIONS

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

- Retrieve the feature for the given nsid. This is optional and - most features do not use this value. -

-
-
--D <dtype> -
-
---dir-type=<dtype> -
-
-

- Directive type -

-
-
--S <dspec> -
-
---dir-spec=<dspec> -
-
-

- Directive specific -

-
-
--O <doper> -
-
---dir-oper=<doper> -
-
-

- Directive operation -

-
-
--T <tdir> -
-
---target-dir=<nsr> -
-
-

- Target directive of the operation -

-
-
--e <endir> -
-
---endir=<endir> -
-
-

- Target directive enable(1) or disable (0) operation -

-
-
-

+

-
- --- - - - - - - - - - - - - - - - - - - - - - - - - - -

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4–7

Reserved

-
-
-
--l <data-len> -
-
---data-len=<data-len> -
-
-

- The data length for the buffer returned for this feature. Most - known features do not use this value. The exception is LBA - Range Type -

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

- Print the raw receive buffer to stdout if the command returns - a structure. -

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

- Print the decoded receive buffer to stdout if the command returns - a structure. -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Enable streams directive : -

    -
    -
    -
    # nvme dir-send /dev/nvme0n1 --dir-type 0 --dir-oper 1 --target-dir 1 --endir 1
    -
    -
  • -
  • -

    -Disable streams directive : -

    -
    -
    -
    # nvme dir-send /dev/nvme0n1 --dir-type 0 --dir-oper 1 --target-dir 1 --endir 0
    -
    -
  • -
  • -

    -Release all allocated streams resource : -

    -
    -
    -
    # nvme dir-send /dev/nvme0n1 --dir-type 1 --dir-oper 2
    -
    -
  • -
  • -

    -Release stream ID 3 : -

    -
    -
    -
    # nvme dir-send /dev/nvme0 --dir-type 1 --dir-oper 1 --dir-spec 3
    -
    -

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

    -
  • -
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-

- - - + + + + + + +nvme-dir-send(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme dir-send <device> [--namespace-id=<nsid> | -n <nsid>]
+                          [--data-len=<data-len> | -l <data-len>]
+                          [--dir-type=<dtype> | -D <dtype>]
+                          [--dir-spec=<dspec> | -S <dspec>]
+                          [--dir-oper=<doper> | -O <doper>]
+                          [--endir=<endir> | -e <endir>]
+                          [--target-dir=<tdir> | -T <tdir>]
+                          [--human-readable | -H]
+                          [--raw-binary | -b]
+
+
+
+
+
+

DESCRIPTION

+
+

Submits an NVMe Directive Send admin command and returns the applicable +results. This may be the combination of directive type, and operation, as +well as target directive and its enable/disable status of the operation, +if specific operation needs it.

+

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 directive’s parameter structure (if applicable) is +returned in one of several ways depending on the option flags; the +structure may parsed by the program and printed in a readable format +if it is a known structure, displayed in hex, or the raw buffer may be +printed to stdout for another program to parse.

+
+
+
+

OPTIONS

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

+ Retrieve the feature for the given nsid. This is optional and + most features do not use this value. +

+
+
+-D <dtype> +
+
+--dir-type=<dtype> +
+
+

+ Directive type +

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

+ Directive specific +

+
+
+-O <doper> +
+
+--dir-oper=<doper> +
+
+

+ Directive operation +

+
+
+-T <tdir> +
+
+--target-dir=<nsr> +
+
+

+ Target directive of the operation +

+
+
+-e <endir> +
+
+--endir=<endir> +
+
+

+ Target directive enable(1) or disable (0) operation +

+
+
+

+

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

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4–7

Reserved

+
+
+
+-l <data-len> +
+
+--data-len=<data-len> +
+
+

+ The data length for the buffer returned for this feature. Most + known features do not use this value. The exception is LBA + Range Type +

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

+ Print the raw receive buffer to stdout if the command returns + a structure. +

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

+ Print the decoded receive buffer to stdout if the command returns + a structure. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Enable streams directive : +

    +
    +
    +
    # nvme dir-send /dev/nvme0n1 --dir-type 0 --dir-oper 1 --target-dir 1 --endir 1
    +
    +
  • +
  • +

    +Disable streams directive : +

    +
    +
    +
    # nvme dir-send /dev/nvme0n1 --dir-type 0 --dir-oper 1 --target-dir 1 --endir 0
    +
    +
  • +
  • +

    +Release all allocated streams resource : +

    +
    +
    +
    # nvme dir-send /dev/nvme0n1 --dir-type 1 --dir-oper 2
    +
    +
  • +
  • +

    +Release stream ID 3 : +

    +
    +
    +
    # nvme dir-send /dev/nvme0 --dir-type 1 --dir-oper 1 --dir-spec 3
    +
    +

    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-disconnect-all.1 b/Documentation/nvme-disconnect-all.1 index 2a9f033..d76a9d0 100644 --- a/Documentation/nvme-disconnect-all.1 +++ b/Documentation/nvme-disconnect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-disconnect-all .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DISCONNECT\-AL" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-DISCONNECT\-AL" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-disconnect-all.html b/Documentation/nvme-disconnect-all.html index 8e1d365..88fbf61 100644 --- a/Documentation/nvme-disconnect-all.html +++ b/Documentation/nvme-disconnect-all.html @@ -1,9 +1,10 @@ + - + nvme-disconnect-all(1) - - - - -
-
-

SYNOPSIS

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

DESCRIPTION

-
-

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

-

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

-

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

-

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

-
-
-
-

OPTIONS

-
-

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

-
-
-
-

EXAMPLES

-
-
    -
  • -

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

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

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

-
-
-
NVME
-
-

Part of the nvme-user suite

-
-
-
-

- - - + + + + + + +nvme-micron-smart-add-log(1) + + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

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

+

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

+

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

+

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

+
+
+
+

OPTIONS

+
+

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

+
+
+
+

EXAMPLES

+
+
    +
  • +

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

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

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

+
+
+
NVME
+
+

Part of the nvme-user suite

+
+
+
+

+ + + diff --git a/Documentation/nvme-micron-temperature-stats.1 b/Documentation/nvme-micron-temperature-stats.1 index 71297d1..95f798e 100644 --- a/Documentation/nvme-micron-temperature-stats.1 +++ b/Documentation/nvme-micron-temperature-stats.1 @@ -2,12 +2,12 @@ .\" 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 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-TEMPER" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-TEMPER" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-micron-temperature-stats.html b/Documentation/nvme-micron-temperature-stats.html index 6701cc2..0703737 100644 --- a/Documentation/nvme-micron-temperature-stats.html +++ b/Documentation/nvme-micron-temperature-stats.html @@ -732,18 +732,20 @@ asciidoc.install(); /*]]>*/ - +
-

NAME

-
-

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

-
-
-

SYNOPSIS

@@ -797,7 +799,7 @@ Retrieve temperature information diff --git a/Documentation/nvme-netapp-ontapdevices.1 b/Documentation/nvme-netapp-ontapdevices.1 index 7a0fdc0..c95830e 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-NETAPP\-ONTAPD" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-NETAPP\-ONTAPD" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-netapp-ontapdevices.html b/Documentation/nvme-netapp-ontapdevices.html index 29f4bda..3714ad9 100644 --- a/Documentation/nvme-netapp-ontapdevices.html +++ b/Documentation/nvme-netapp-ontapdevices.html @@ -1,9 +1,10 @@ + - + nvme-netapp-ontapdevices(1) - - - - -
-
-

SYNOPSIS

-
-
-
nvme sanitize <device> [--no-dealloc | -d]
-              [--oipbp | -i]
-              [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]
-              [--ause | -u]
-              [--sanact=<action> | -a <action>]
-              [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]
-
-
-
-
-
-

DESCRIPTION

-
-

For the NVMe device given, sends a Sanitize command and -provides the result.

-

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

-

On success it returns 0, error code otherwise.

-
-
-
-

OPTIONS

-
-
-
--d -
-
---no-delloc -
-
-

- No Deallocate After Sanitize: - If set, then the controller shall not deallocate any logical - blocks as a result of successfully completing the sanitize - operation. If cleared, then the controller should deallocate - logical blocks as a result of successfully completing the - sanitize operation. This bit shall be ignored if the Sanitize - Action field is set to 001b (i.e., Exit Failure Mode). -

-
-
--i -
-
---oipbp -
-
-

- Overwrite Invert Pattern Between Passes: - If set, then the Overwrite Pattern shall be inverted between - passes. If cleared, then the overwrite pattern shall not be - inverted between passes. This bit shall be ignored unless the - Sanitize Action field is set to 011b (i.e., Overwrite). -

-
-
--n <overwrite-pass-count> -
-
---owpass=<overwrite-pass-count> -
-
-

- Overwrite Pass Count: - This field specifies the number of overwrite passes (i.e., - how many times the media is to be overwritten) using the data - from the Overwrite Pattern field of this command. A value of 0 - specifies 16 overwrite passes. This field shall be ignored - unless the Sanitize Action field is set to 011b (i.e., Overwrite). -

-
-
--u -
-
---ause -
-
-

- Allow Unrestricted Sanitize Exit: - If set, then the sanitize operation is performed in unrestricted - completion mode. If cleared then the sanitize operation is - performed in restricted completion mode. This bit shall be ignored - if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode). -

-
-
--a <action> -
-
---sanact=<action> -
-
-

- Sanitize Action: - 000b - Reserved - 001b - Exit Failure Mode - 010b - Start a Block Erase sanitize operation - 011b - Start an Overwrite sanitize operation - 100b - Start a Crypto Erase sanitize operation -

-
-
--p <overwrite-pattern> -
-
---ovrpat=<overwrite-pattern> -
-
-

- Overwrite Pattern: - This field is ignored unless the Sanitize Action field in - Command Dword 10 is set to 011b (i.e., Overwrite). This field - specifies a 32-bit pattern that is used for the Overwrite - sanitize operation. -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Has the program issue Sanitize Command : -

    -
    -
    -
    # nvme sanitize /dev/nvme0n1 -a 0x02
    -# nvme sanitize /dev/nvme0n1 --sanact=0x01
    -
    -
  • -
-
-
-
-

NVME

-
-

Part of the nvme-user suite.

-
-
-
-

- - - + + + + + + +nvme-sanitize(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme sanitize <device> [--no-dealloc | -d]
+              [--oipbp | -i]
+              [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]
+              [--ause | -u]
+              [--sanact=<action> | -a <action>]
+              [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends a Sanitize command and +provides the result.

+

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

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-d +
+
+--no-delloc +
+
+

+ No Deallocate After Sanitize: + If set, then the controller shall not deallocate any logical + blocks as a result of successfully completing the sanitize + operation. If cleared, then the controller should deallocate + logical blocks as a result of successfully completing the + sanitize operation. This bit shall be ignored if the Sanitize + Action field is set to 001b (i.e., Exit Failure Mode). +

+
+
+-i +
+
+--oipbp +
+
+

+ Overwrite Invert Pattern Between Passes: + If set, then the Overwrite Pattern shall be inverted between + passes. If cleared, then the overwrite pattern shall not be + inverted between passes. This bit shall be ignored unless the + Sanitize Action field is set to 011b (i.e., Overwrite). +

+
+
+-n <overwrite-pass-count> +
+
+--owpass=<overwrite-pass-count> +
+
+

+ Overwrite Pass Count: + This field specifies the number of overwrite passes (i.e., + how many times the media is to be overwritten) using the data + from the Overwrite Pattern field of this command. A value of 0 + specifies 16 overwrite passes. This field shall be ignored + unless the Sanitize Action field is set to 011b (i.e., Overwrite). +

+
+
+-u +
+
+--ause +
+
+

+ Allow Unrestricted Sanitize Exit: + If set, then the sanitize operation is performed in unrestricted + completion mode. If cleared then the sanitize operation is + performed in restricted completion mode. This bit shall be ignored + if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode). +

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

+ Sanitize Action: + 000b - Reserved + 001b - Exit Failure Mode + 010b - Start a Block Erase sanitize operation + 011b - Start an Overwrite sanitize operation + 100b - Start a Crypto Erase sanitize operation +

+
+
+-p <overwrite-pattern> +
+
+--ovrpat=<overwrite-pattern> +
+
+

+ Overwrite Pattern: + This field is ignored unless the Sanitize Action field in + Command Dword 10 is set to 011b (i.e., Overwrite). This field + specifies a 32-bit pattern that is used for the Overwrite + sanitize operation. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue Sanitize Command : +

    +
    +
    +
    # nvme sanitize /dev/nvme0n1 -a 0x02
    +# nvme sanitize /dev/nvme0n1 --sanact=0x01
    +
    +
  • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+

+ + + diff --git a/Documentation/nvme-security-recv.1 b/Documentation/nvme-security-recv.1 index eef260a..3c17f75 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SECURITY\-RECV" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SECURITY\-RECV" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-security-recv.html b/Documentation/nvme-security-recv.html index 39e7ee2..1614c8f 100644 --- a/Documentation/nvme-security-recv.html +++ b/Documentation/nvme-security-recv.html @@ -886,7 +886,7 @@ controller reset occurs.

diff --git a/Documentation/nvme-security-send.1 b/Documentation/nvme-security-send.1 index 81e4854..5ee8dba 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SECURITY\-SEND" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SECURITY\-SEND" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-security-send.html b/Documentation/nvme-security-send.html index 4ffa0d6..6df7879 100644 --- a/Documentation/nvme-security-send.html +++ b/Documentation/nvme-security-send.html @@ -872,7 +872,7 @@ Receive command is Security Protocol field dependent as defined in SPC-4.

diff --git a/Documentation/nvme-self-test-log.1 b/Documentation/nvme-self-test-log.1 index e00e289..8296aad 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://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 01/23/2021 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SELF\-TEST\-LO" "1" "01/23/2021" "NVMe" "NVMe Manual" +.TH "NVME\-SELF\-TEST\-LO" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-self-test-log.html b/Documentation/nvme-self-test-log.html index 3b24a26..f90c8ee 100644 --- a/Documentation/nvme-self-test-log.html +++ b/Documentation/nvme-self-test-log.html @@ -847,7 +847,7 @@ Get the self-test-log and print it in a json format: diff --git a/Documentation/nvme-set-feature.1 b/Documentation/nvme-set-feature.1 index 57e8c08..f37ef0b 100644 --- a/Documentation/nvme-set-feature.1 +++ b/Documentation/nvme-set-feature.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-set-feature -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 05/16/2021 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SET\-FEATURE" "1" "05/16/2021" "NVMe" "NVMe Manual" +.TH "NVME\-SET\-FEATURE" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-set-feature.html b/Documentation/nvme-set-feature.html index b5bf779..56c31f1 100644 --- a/Documentation/nvme-set-feature.html +++ b/Documentation/nvme-set-feature.html @@ -899,7 +899,7 @@ Sets the host id to the ascii string. diff --git a/Documentation/nvme-set-property.1 b/Documentation/nvme-set-property.1 index 276c101..83fb20a 100644 --- a/Documentation/nvme-set-property.1 +++ b/Documentation/nvme-set-property.1 @@ -2,12 +2,12 @@ .\" Title: nvme-set-property .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SET\-PROPERTY" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SET\-PROPERTY" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-set-property.html b/Documentation/nvme-set-property.html index 41b06e2..5da9a9e 100644 --- a/Documentation/nvme-set-property.html +++ b/Documentation/nvme-set-property.html @@ -805,7 +805,7 @@ nvme-set-property(1) Manual Page diff --git a/Documentation/nvme-show-hostnqn.1 b/Documentation/nvme-show-hostnqn.1 index 944d170..c9ad4fd 100644 --- a/Documentation/nvme-show-hostnqn.1 +++ b/Documentation/nvme-show-hostnqn.1 @@ -2,12 +2,12 @@ .\" Title: nvme-show-hostnqn .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SHOW\-HOSTNQN" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SHOW\-HOSTNQN" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-show-hostnqn.html b/Documentation/nvme-show-hostnqn.html index b459d0a..49ccd32 100644 --- a/Documentation/nvme-show-hostnqn.html +++ b/Documentation/nvme-show-hostnqn.html @@ -785,7 +785,7 @@ this will show the systemd-generated host NQN for the system.

diff --git a/Documentation/nvme-show-regs.1 b/Documentation/nvme-show-regs.1 index 3e8a76f..02e571f 100644 --- a/Documentation/nvme-show-regs.1 +++ b/Documentation/nvme-show-regs.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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-show-regs.html b/Documentation/nvme-show-regs.html index 1b56c47..74f43fb 100644 --- a/Documentation/nvme-show-regs.html +++ b/Documentation/nvme-show-regs.html @@ -848,7 +848,7 @@ in a json format: diff --git a/Documentation/nvme-smart-log.1 b/Documentation/nvme-smart-log.1 index 85ca8b9..4b2a3e3 100644 --- a/Documentation/nvme-smart-log.1 +++ b/Documentation/nvme-smart-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-smart-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SMART\-LOG" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SMART\-LOG" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-smart-log.html b/Documentation/nvme-smart-log.html index f1eae8a..f105d5b 100644 --- a/Documentation/nvme-smart-log.html +++ b/Documentation/nvme-smart-log.html @@ -850,7 +850,7 @@ Print the raw SMART log to a file: diff --git a/Documentation/nvme-subsystem-reset.1 b/Documentation/nvme-subsystem-reset.1 index 83db99f..544f467 100644 --- a/Documentation/nvme-subsystem-reset.1 +++ b/Documentation/nvme-subsystem-reset.1 @@ -2,12 +2,12 @@ .\" Title: nvme-subsystem-reset .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SUBSYSTEM\-RES" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-SUBSYSTEM\-RES" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-subsystem-reset.html b/Documentation/nvme-subsystem-reset.html index cd0dcc3..facfcb6 100644 --- a/Documentation/nvme-subsystem-reset.html +++ b/Documentation/nvme-subsystem-reset.html @@ -1,9 +1,10 @@ + - + nvme-subsystem-reset(1) - - - - -
-
-

SYNOPSIS

-
-
-
nvme wdc clear-pcie-corr <device>
-
-
-
-
-
-

DESCRIPTION

-
-

For the NVMe device given, sends the wdc vendor unique clear pcie -correctable errors command.

-

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

-

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

-
-
-
-

OPTIONS

-
-

None

-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Clears the PCIe Correctable Error Count field returned in the smart-log-add command: -

    -
    -
    -
    # nvme wdc clear-pcie-corr /dev/nvme0
    -
    -
  • -
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-

- - - diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 b/Documentation/nvme-wdc-clear-pcie-correctable-errors.1 index f819679..7d3e090 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLEAR\-PC" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLEAR\-PC" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-clear-pcie-correctable-errors.html b/Documentation/nvme-wdc-clear-pcie-correctable-errors.html index 37929c6..2b4b49c 100644 --- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.html +++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.html @@ -1,9 +1,10 @@ + - + nvme-wdc-clear-pcie-correctable-errors(1) - - - - -
-
-

SYNOPSIS

-
-
-
nvme wdc smart-add-log <device> [--interval=<NUM>, -i <NUM>] [--output-format=<normal|json> -o <normal|json>]
-
-
-
-
-
-

DESCRIPTION

-
-

For the NVMe device given, send a Vendor Unique WDC smart-add-log command and -provide the additional smart log. The --interval option will return performance -statistics from the specified reporting interval.

-

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

-

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

-

On success it returns 0, error code otherwise.

-
-
-
-

OPTIONS

-
-
-
--i <NUM> -
-
---interval=<NUM> -
-
-

- Return the statistics from specific interval, defaults to 14 -

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

- Set the reporting format to normal, or - json. Only one output format can be used at a time. - Default is normal. -

-
-
-

Valid Interval values and description :-

-
- --- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Value Description

1

Most recent five (5) minute accumulated set.

2-12

Previous five (5) minute accumulated sets.

13

The accumulated total of sets 1 through 12 that contain the previous hour of -accumulated statistics.

14

The statistical set accumulated since power-up.

15

The statistical set accumulated during the entire lifetime of the device.

-
-
-
-
-

CA Log Page Data Output Explanation

-
-
- --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Description

Physical NAND bytes written.

The number of bytes written to NAND. 16 bytes - hi/lo

Physical NAND bytes read

The number of bytes read from NAND. 16 bytes - hi/lo

Bad NAND Block Count

Raw and normalized count of the number of NAND blocks that have been -retired after the drives manufacturing tests (i.e. grown back blocks). -2 bytes normalized, 6 bytes raw count

Uncorrectable Read Error Count

Total count of NAND reads that were not correctable by read retries, all -levels of ECC, or XOR (as applicable). 8 bytes

Soft ECC Error Count

Total count of NAND reads that were not correctable by read retries, or -first-level ECC. 8 bytes

SSD End to End Detection Count

A count of the detected errors by the SSD end to end error correction which -includes DRAM, SRAM, or other storage element ECC/CRC protection mechanism (not -NAND ECC). 4 bytes

SSD End to End Correction Count

A count of the corrected errors by the SSD end to end error correction which -includes DRAM, SRAM, or other storage element ECC/CRC protection mechanism (not -NAND ECC). 4 bytes

System Data % Used

A normalized cumulative count of the number of erase cycles per block since -leaving the factory for the system (FW and metadata) area. Starts at 0 and -increments. 100 indicates that the estimated endurance has been consumed.

User Data Max Erase Count

The maximum erase count across all NAND blocks in the drive. 4 bytes

User Data Min Erase Count

The minimum erase count across all NAND blocks in the drive. 4 bytes

Refresh Count

A count of the number of blocks that have been re-allocated due to -background operations only. 8 bytes

Program Fail Count

Raw and normalized count of total program failures. Normalized count -starts at 100 and shows the percent of remaining allowable failures. -2 bytes normalized, 6 bytes raw count

User Data Erase Fail Count

Raw and normalized count of total erase failures in the user area. -Normalized count starts at 100 and shows the percent of remaining -allowable failures. 2 bytes normalized, 6 bytes raw count

System Area Erase Fail Count

Raw and normalized count of total erase failures in the system area. -Normalized count starts at 100 and shows the percent of remaining -allowable failures. 2 bytes normalized, 6 bytes raw count

Thermal Throttling Status

The current status of thermal throttling (enabled or disabled). -2 bytes

Thermal Throttling Count

A count of the number of thermal throttling events. 2 bytes

PCIe Correctable Error Count

Summation counter of all PCIe correctable errors (Bad TLP, Bad -DLLP, Receiver error, Replay timeouts, Replay rollovers). 8 bytes

-
-
-
-
-

C1 Log Page Data Output Explanation

-
-
- --- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Field Description

Host Read Commands

Number of host read commands received during the reporting period.

Host Read Blocks

Number of 512-byte blocks requested during the reporting period.

Average Read Size

Average Read size is calculated using (Host Read Blocks/Host Read Commands).

Host Read Cache Hit Commands

Number of host read commands that serviced entirely from the on-board read -cache during the reporting period. No access to the NAND flash memory was required. -This count is only updated if the entire command was serviced from the cache memory.

Host Read Cache Hit Percentage

Percentage of host read commands satisfied from the cache.

Host Read Cache Hit Blocks

Number of 512-byte blocks of data that have been returned for Host Read Cache Hit -Commands during the reporting period. This count is only updated with the blocks -returned for host read commands that were serviced entirely from cache memory.

Average Read Cache Hit Size

Average size of read commands satisfied from the cache.

Host Read Commands Stalled

Number of host read commands that were stalled due to a lack of resources within -the SSD during the reporting period (NAND flash command queue full, low cache page count, -cache page contention, etc.). Commands are not considered stalled if the only reason for -the delay was waiting for the data to be physically read from the NAND flash. It is normal -to expect this count to equal zero on heavily utilized systems.

Host Read Commands Stalled Percentage

Percentage of read commands that were stalled. If the figure is consistently high, -then consideration should be given to spreading the data across multiple SSDs.

Host Write Commands

Number of host write commands received during the reporting period.

Host Write Blocks

Number of 512-byte blocks written during the reporting period.

Average Write Size

Average Write size calculated using (Host Write Blocks/Host Write Commands).

Host Write Odd Start Commands

Number of host write commands that started on a non-aligned boundary during -the reporting period. The size of the boundary alignment is normally 4K; therefore -this returns the number of commands that started on a non-4K aligned boundary. -The SSD requires slightly more time to process non-aligned write commands than it -does to process aligned write commands.

Host Write Odd Start Commands Percentage

Percentage of host write commands that started on a non-aligned boundary. If this -figure is equal to or near 100%, and the NAND Read Before Write value is also high, -then the user should investigate the possibility of offsetting the file system. For -Microsoft Windows systems, the user can use Diskpart. For Unix-based operating systems, -there is normally a method whereby file system partitions can be placed where required.

Host Write Odd End Commands

Number of host write commands that ended on a non-aligned boundary during the -reporting period. The size of the boundary alignment is normally 4K; therefore this -returns the number of commands that ended on a non-4K aligned boundary.

Host Write Odd End Commands Percentage

Percentage of host write commands that ended on a non-aligned boundary.

Host Write Commands Stalled

Number of host write commands that were stalled due to a lack of resources within the -SSD during the reporting period. The most likely cause is that the write data was being -received faster than it could be saved to the NAND flash memory. If there was a large -volume of read commands being processed simultaneously, then other causes might include -the NAND flash command queue being full, low cache page count, or cache page contention, etc. -It is normal to expect this count to be non-zero on heavily utilized systems.

Host Write Commands Stalled Percentage

Percentage of write commands that were stalled. If the figure is consistently high, then -consideration should be given to spreading the data across multiple SSDs.

NAND Read Commands

Number of read commands issued to the NAND devices during the reporting period. -This figure will normally be much higher than the host read commands figure, as the data -needed to satisfy a single host read command may be spread across several NAND flash devices.

NAND Read Blocks

Number of 512-byte blocks requested from NAND flash devices during the reporting period. -This figure would normally be about the same as the host read blocks figure

Average NAND Read Size

Average size of NAND read commands.

NAND Write Commands

Number of write commands issued to the NAND devices during the reporting period. -There is no real correlation between the number of host write commands issued and the -number of NAND Write Commands.

NAND Write Blocks

Number of 512-byte blocks written to the NAND flash devices during the reporting period. -This figure would normally be about the same as the host write blocks figure.

Average NAND Write Size

Average size of NAND write commands. This figure should never be greater than 128K, as -this is the maximum size write that is ever issued to a NAND device.

NAND Read Before Write

This is the number of read before write operations that were required to process -non-aligned host write commands during the reporting period. See Host Write Odd Start -Commands and Host Write Odd End Commands. NAND Read Before Write operations have -a detrimental effect on the overall performance of the device.

-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Has the program issue WDC smart-add-log Vendor Unique Command with default interval (14) : -

    -
    -
    -
    # nvme wdc smart-add-log /dev/nvme0
    -
    -
  • -
-
-
-
-

NVME

-
-

Part of the nvme-user suite.

-
-
-
-

- - - diff --git a/Documentation/nvme-wdc-vs-drive-info.1 b/Documentation/nvme-wdc-vs-drive-info.1 index 9ca8396..98ef2a8 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: 10/20/2020 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-DRIVE" "1" "10/20/2020" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-DRIVE" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-vs-drive-info.html b/Documentation/nvme-wdc-vs-drive-info.html index 0013ea6..9993637 100644 --- a/Documentation/nvme-wdc-vs-drive-info.html +++ b/Documentation/nvme-wdc-vs-drive-info.html @@ -1,9 +1,10 @@ + - + nvme-wdc-vs-drive-info(1)