From 589986012c4b3ab68e299a2eadca18f90080113b Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 14 Jul 2022 20:28:04 +0200 Subject: Merging upstream version 2.0. Signed-off-by: Daniel Baumann --- .github/workflows/c-cpp.yml | 18 - .github/workflows/meson.yml | 27 + .gitignore | 13 +- .gitmodules | 0 Documentation/Makefile | 265 -- Documentation/cmd-plugins.txt | 200 + Documentation/cmds-main.txt | 104 +- Documentation/meson.build | 257 ++ Documentation/nvme-admin-passthru.1 | 4 +- Documentation/nvme-admin-passthru.html | 6 +- Documentation/nvme-ana-log.1 | 4 +- Documentation/nvme-ana-log.html | 6 +- Documentation/nvme-attach-ns.1 | 4 +- Documentation/nvme-attach-ns.html | 6 +- Documentation/nvme-boot-part-log.1 | 4 +- Documentation/nvme-boot-part-log.html | 6 +- Documentation/nvme-capacity-mgmt.1 | 4 +- Documentation/nvme-capacity-mgmt.html | 15 +- Documentation/nvme-changed-ns-list-log.1 | 4 +- Documentation/nvme-changed-ns-list-log.html | 6 +- Documentation/nvme-check-dhchap-key.1 | 51 + Documentation/nvme-check-dhchap-key.html | 800 ++++ Documentation/nvme-check-dhchap-key.txt | 31 + Documentation/nvme-check-tls-key.txt | 31 + Documentation/nvme-cmdset-ind-id-ns.1 | 4 +- Documentation/nvme-cmdset-ind-id-ns.html | 14 +- Documentation/nvme-compare.1 | 12 +- Documentation/nvme-compare.html | 24 +- Documentation/nvme-compare.txt | 12 +- Documentation/nvme-config.txt | 210 + Documentation/nvme-connect-all.1 | 31 +- Documentation/nvme-connect-all.html | 68 +- Documentation/nvme-connect-all.txt | 38 +- Documentation/nvme-connect.1 | 35 +- Documentation/nvme-connect.html | 98 +- Documentation/nvme-connect.txt | 35 +- Documentation/nvme-copy.1 | 4 +- Documentation/nvme-copy.html | 6 +- Documentation/nvme-create-ns.1 | 10 +- Documentation/nvme-create-ns.html | 18 +- Documentation/nvme-create-ns.txt | 5 + Documentation/nvme-delete-ns.1 | 4 +- Documentation/nvme-delete-ns.html | 6 +- Documentation/nvme-dera-stat.1 | 4 +- Documentation/nvme-dera-stat.html | 6 +- Documentation/nvme-detach-ns.1 | 4 +- Documentation/nvme-detach-ns.html | 6 +- Documentation/nvme-device-self-test.1 | 4 +- Documentation/nvme-device-self-test.html | 6 +- Documentation/nvme-dim.1 | 113 + Documentation/nvme-dim.html | 870 ++++ Documentation/nvme-dim.txt | 75 + Documentation/nvme-dir-receive.1 | 4 +- Documentation/nvme-dir-receive.html | 6 +- Documentation/nvme-dir-send.1 | 4 +- Documentation/nvme-dir-send.html | 6 +- Documentation/nvme-disconnect-all.1 | 4 +- Documentation/nvme-disconnect-all.html | 6 +- Documentation/nvme-disconnect.1 | 4 +- Documentation/nvme-disconnect.html | 6 +- Documentation/nvme-discover.1 | 31 +- Documentation/nvme-discover.html | 63 +- Documentation/nvme-discover.txt | 35 +- Documentation/nvme-dsm.1 | 4 +- Documentation/nvme-dsm.html | 6 +- Documentation/nvme-effects-log.1 | 4 +- Documentation/nvme-effects-log.html | 6 +- Documentation/nvme-endurance-event-agg-log.1 | 4 +- Documentation/nvme-endurance-event-agg-log.html | 6 +- Documentation/nvme-endurance-log.1 | 4 +- Documentation/nvme-endurance-log.html | 6 +- Documentation/nvme-error-log.1 | 4 +- Documentation/nvme-error-log.html | 6 +- Documentation/nvme-fid-support-effects-log.1 | 4 +- Documentation/nvme-fid-support-effects-log.html | 6 +- Documentation/nvme-flush.1 | 4 +- Documentation/nvme-flush.html | 6 +- Documentation/nvme-format.1 | 8 +- Documentation/nvme-format.html | 11 +- Documentation/nvme-format.txt | 3 +- Documentation/nvme-fw-commit.1 | 4 +- Documentation/nvme-fw-commit.html | 6 +- Documentation/nvme-fw-download.1 | 4 +- Documentation/nvme-fw-download.html | 6 +- Documentation/nvme-fw-log.1 | 4 +- Documentation/nvme-fw-log.html | 6 +- Documentation/nvme-gen-dhchap-key.1 | 69 + Documentation/nvme-gen-dhchap-key.html | 842 ++++ Documentation/nvme-gen-dhchap-key.txt | 52 + Documentation/nvme-gen-hostnqn.1 | 4 +- Documentation/nvme-gen-hostnqn.html | 6 +- Documentation/nvme-gen-tls-key.txt | 40 + Documentation/nvme-get-feature.1 | 4 +- Documentation/nvme-get-feature.html | 6 +- Documentation/nvme-get-lba-status.1 | 4 +- Documentation/nvme-get-lba-status.html | 6 +- Documentation/nvme-get-log.1 | 26 +- Documentation/nvme-get-log.html | 35 +- Documentation/nvme-get-log.txt | 29 +- Documentation/nvme-get-ns-id.1 | 4 +- Documentation/nvme-get-ns-id.html | 6 +- Documentation/nvme-get-property.1 | 4 +- Documentation/nvme-get-property.html | 6 +- Documentation/nvme-help.1 | 4 +- Documentation/nvme-help.html | 6 +- Documentation/nvme-huawei-id-ctrl.1 | 4 +- Documentation/nvme-huawei-id-ctrl.html | 6 +- Documentation/nvme-huawei-list.1 | 4 +- Documentation/nvme-huawei-list.html | 6 +- Documentation/nvme-id-ctrl.1 | 4 +- Documentation/nvme-id-ctrl.html | 6 +- Documentation/nvme-id-domain.1 | 4 +- Documentation/nvme-id-domain.html | 6 +- Documentation/nvme-id-iocs.1 | 4 +- Documentation/nvme-id-iocs.html | 6 +- Documentation/nvme-id-ns-lba-format.1 | 172 + Documentation/nvme-id-ns-lba-format.html | 901 ++++ Documentation/nvme-id-ns-lba-format.txt | 102 + Documentation/nvme-id-ns.1 | 8 +- Documentation/nvme-id-ns.html | 11 +- Documentation/nvme-id-ns.txt | 3 +- Documentation/nvme-id-nvmset.1 | 4 +- Documentation/nvme-id-nvmset.html | 6 +- Documentation/nvme-intel-id-ctrl.1 | 4 +- Documentation/nvme-intel-id-ctrl.html | 6 +- Documentation/nvme-intel-internal-log.1 | 4 +- Documentation/nvme-intel-internal-log.html | 6 +- Documentation/nvme-intel-lat-stats.1 | 4 +- Documentation/nvme-intel-lat-stats.html | 6 +- Documentation/nvme-intel-market-name.1 | 4 +- Documentation/nvme-intel-market-name.html | 6 +- Documentation/nvme-intel-smart-log-add.1 | 4 +- Documentation/nvme-intel-smart-log-add.html | 6 +- Documentation/nvme-intel-temp-stats.1 | 4 +- Documentation/nvme-intel-temp-stats.html | 6 +- Documentation/nvme-io-passthru.1 | 12 +- Documentation/nvme-io-passthru.html | 26 +- Documentation/nvme-io-passthru.txt | 13 +- Documentation/nvme-lba-status-log.1 | 4 +- Documentation/nvme-lba-status-log.html | 6 +- Documentation/nvme-list-ctrl.1 | 4 +- Documentation/nvme-list-ctrl.html | 6 +- Documentation/nvme-list-endgrp.1 | 4 +- Documentation/nvme-list-endgrp.html | 6 +- Documentation/nvme-list-ns.1 | 4 +- Documentation/nvme-list-ns.html | 6 +- Documentation/nvme-list-subsys.1 | 4 +- Documentation/nvme-list-subsys.html | 6 +- Documentation/nvme-list.1 | 4 +- Documentation/nvme-list.html | 6 +- Documentation/nvme-lnvm-create.1 | 100 - Documentation/nvme-lnvm-create.html | 865 ---- Documentation/nvme-lnvm-create.txt | 60 - Documentation/nvme-lnvm-diag-bbtbl.1 | 117 - Documentation/nvme-lnvm-diag-bbtbl.html | 868 ---- Documentation/nvme-lnvm-diag-bbtbl.txt | 65 - Documentation/nvme-lnvm-diag-set-bbtbl.1 | 99 - Documentation/nvme-lnvm-diag-set-bbtbl.html | 869 ---- Documentation/nvme-lnvm-diag-set-bbtbl.txt | 63 - Documentation/nvme-lnvm-factory.1 | 109 - Documentation/nvme-lnvm-factory.html | 861 ---- Documentation/nvme-lnvm-factory.txt | 54 - Documentation/nvme-lnvm-id-ns.1 | 88 - Documentation/nvme-lnvm-id-ns.html | 850 ---- Documentation/nvme-lnvm-id-ns.txt | 49 - Documentation/nvme-lnvm-info.1 | 48 - Documentation/nvme-lnvm-info.html | 790 ---- Documentation/nvme-lnvm-info.txt | 27 - Documentation/nvme-lnvm-init.1 | 97 - Documentation/nvme-lnvm-init.html | 837 ---- Documentation/nvme-lnvm-init.txt | 44 - Documentation/nvme-lnvm-list.1 | 48 - Documentation/nvme-lnvm-list.html | 790 ---- Documentation/nvme-lnvm-list.txt | 27 - Documentation/nvme-lnvm-remove.1 | 53 - Documentation/nvme-lnvm-remove.html | 804 ---- Documentation/nvme-lnvm-remove.txt | 32 - Documentation/nvme-lockdown.1 | 4 +- Documentation/nvme-lockdown.html | 6 +- Documentation/nvme-media-unit-stat-log.1 | 67 + Documentation/nvme-media-unit-stat-log.html | 831 ++++ Documentation/nvme-media-unit-stat-log.txt | 47 + Documentation/nvme-mi-cmd-support-effects-log.1 | 64 + Documentation/nvme-mi-cmd-support-effects-log.html | 822 ++++ Documentation/nvme-mi-cmd-support-effects-log.txt | 45 + Documentation/nvme-micron-clear-pcie-errors.1 | 4 +- Documentation/nvme-micron-clear-pcie-errors.html | 6 +- Documentation/nvme-micron-internal-log.1 | 4 +- Documentation/nvme-micron-internal-log.html | 6 +- Documentation/nvme-micron-nand-stats.1 | 4 +- Documentation/nvme-micron-nand-stats.html | 6 +- Documentation/nvme-micron-pcie-stats.1 | 4 +- Documentation/nvme-micron-pcie-stats.html | 6 +- Documentation/nvme-micron-selective-download.1 | 4 +- Documentation/nvme-micron-selective-download.html | 6 +- Documentation/nvme-micron-smart-add-log.1 | 4 +- Documentation/nvme-micron-smart-add-log.html | 6 +- Documentation/nvme-micron-temperature-stats.1 | 4 +- Documentation/nvme-micron-temperature-stats.html | 6 +- Documentation/nvme-netapp-ontapdevices.1 | 4 +- Documentation/nvme-netapp-ontapdevices.html | 6 +- Documentation/nvme-netapp-smdevices.1 | 4 +- Documentation/nvme-netapp-smdevices.html | 6 +- Documentation/nvme-ns-descs.1 | 4 +- Documentation/nvme-ns-descs.html | 6 +- Documentation/nvme-ns-rescan.1 | 4 +- Documentation/nvme-ns-rescan.html | 6 +- Documentation/nvme-nvm-id-ctrl.1 | 4 +- Documentation/nvme-nvm-id-ctrl.html | 6 +- Documentation/nvme-nvm-id-ns-lba-format.1 | 117 + Documentation/nvme-nvm-id-ns-lba-format.html | 863 ++++ Documentation/nvme-nvm-id-ns-lba-format.txt | 67 + Documentation/nvme-nvm-id-ns.1 | 162 + Documentation/nvme-nvm-id-ns.html | 881 ++++ Documentation/nvme-nvm-id-ns.txt | 83 + Documentation/nvme-ocp-latency-monitor-log.1 | 79 + Documentation/nvme-ocp-latency-monitor-log.html | 818 ++++ Documentation/nvme-ocp-latency-monitor-log.txt | 44 + Documentation/nvme-ocp-smart-add-log.1 | 79 + Documentation/nvme-ocp-smart-add-log.html | 819 ++++ Documentation/nvme-ocp-smart-add-log.txt | 44 + Documentation/nvme-persistent-event-log.1 | 4 +- Documentation/nvme-persistent-event-log.html | 6 +- Documentation/nvme-pred-lat-event-agg-log.1 | 4 +- Documentation/nvme-pred-lat-event-agg-log.html | 6 +- Documentation/nvme-predictable-lat-log.1 | 4 +- Documentation/nvme-predictable-lat-log.html | 6 +- Documentation/nvme-primary-ctrl-caps.1 | 4 +- Documentation/nvme-primary-ctrl-caps.html | 6 +- Documentation/nvme-read.1 | 12 +- Documentation/nvme-read.html | 24 +- Documentation/nvme-read.txt | 11 +- Documentation/nvme-reset.1 | 4 +- Documentation/nvme-reset.html | 6 +- Documentation/nvme-resv-acquire.1 | 4 +- Documentation/nvme-resv-acquire.html | 6 +- Documentation/nvme-resv-notif-log.1 | 4 +- Documentation/nvme-resv-notif-log.html | 6 +- Documentation/nvme-resv-register.1 | 4 +- Documentation/nvme-resv-register.html | 6 +- Documentation/nvme-resv-release.1 | 4 +- Documentation/nvme-resv-release.html | 6 +- Documentation/nvme-resv-report.1 | 11 +- Documentation/nvme-resv-report.html | 14 +- Documentation/nvme-resv-report.txt | 8 +- Documentation/nvme-rpmb.1 | 4 +- Documentation/nvme-rpmb.html | 6 +- Documentation/nvme-sanitize-log.1 | 4 +- Documentation/nvme-sanitize-log.html | 6 +- Documentation/nvme-sanitize.1 | 10 +- Documentation/nvme-sanitize.html | 18 +- Documentation/nvme-sanitize.txt | 5 + Documentation/nvme-security-recv.1 | 4 +- Documentation/nvme-security-recv.html | 6 +- Documentation/nvme-security-send.1 | 4 +- Documentation/nvme-security-send.html | 6 +- Documentation/nvme-self-test-log.1 | 4 +- Documentation/nvme-self-test-log.html | 6 +- Documentation/nvme-set-feature.1 | 4 +- Documentation/nvme-set-feature.html | 6 +- Documentation/nvme-set-property.1 | 4 +- Documentation/nvme-set-property.html | 6 +- Documentation/nvme-show-hostnqn.1 | 4 +- Documentation/nvme-show-hostnqn.html | 6 +- Documentation/nvme-show-hostnqn.txt | 2 +- Documentation/nvme-show-regs.1 | 4 +- Documentation/nvme-show-regs.html | 6 +- Documentation/nvme-smart-log.1 | 4 +- Documentation/nvme-smart-log.html | 6 +- Documentation/nvme-subsystem-reset.1 | 4 +- Documentation/nvme-subsystem-reset.html | 6 +- Documentation/nvme-supported-cap-config-log.txt | 49 + Documentation/nvme-supported-log-pages.1 | 4 +- Documentation/nvme-supported-log-pages.html | 6 +- Documentation/nvme-telemetry-log.1 | 4 +- Documentation/nvme-telemetry-log.html | 6 +- .../nvme-toshiba-clear-pcie-correctable-errors.1 | 4 +- ...nvme-toshiba-clear-pcie-correctable-errors.html | 6 +- Documentation/nvme-toshiba-vs-internal-log.1 | 4 +- Documentation/nvme-toshiba-vs-internal-log.html | 6 +- Documentation/nvme-toshiba-vs-smart-add-log.1 | 4 +- Documentation/nvme-toshiba-vs-smart-add-log.html | 6 +- Documentation/nvme-transcend-badblock.1 | 4 +- Documentation/nvme-transcend-badblock.html | 6 +- Documentation/nvme-transcend-healthvalue.1 | 4 +- Documentation/nvme-transcend-healthvalue.html | 6 +- Documentation/nvme-verify.1 | 4 +- Documentation/nvme-verify.html | 6 +- .../nvme-virtium-save-smart-to-vtview-log.1 | 4 +- .../nvme-virtium-save-smart-to-vtview-log.html | 6 +- Documentation/nvme-virtium-show-identify.1 | 4 +- Documentation/nvme-virtium-show-identify.html | 6 +- Documentation/nvme-wdc-cap-diag.1 | 4 +- Documentation/nvme-wdc-cap-diag.html | 6 +- 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 | 6 +- Documentation/nvme-wdc-clear-fw-activate-history.1 | 4 +- .../nvme-wdc-clear-fw-activate-history.html | 6 +- Documentation/nvme-wdc-clear-pcie-corr.1 | 71 + Documentation/nvme-wdc-clear-pcie-corr.html | 806 ++++ .../nvme-wdc-clear-pcie-correctable-errors.1 | 4 +- .../nvme-wdc-clear-pcie-correctable-errors.html | 6 +- Documentation/nvme-wdc-cloud-SSD-plugin-version.1 | 4 +- .../nvme-wdc-cloud-SSD-plugin-version.html | 6 +- Documentation/nvme-wdc-drive-essentials.1 | 4 +- Documentation/nvme-wdc-drive-essentials.html | 6 +- Documentation/nvme-wdc-drive-log.1 | 4 +- Documentation/nvme-wdc-drive-log.html | 6 +- Documentation/nvme-wdc-drive-resize.1 | 4 +- Documentation/nvme-wdc-drive-resize.html | 6 +- Documentation/nvme-wdc-enc-get-log.1 | 4 +- Documentation/nvme-wdc-enc-get-log.html | 6 +- Documentation/nvme-wdc-get-crash-dump.1 | 4 +- Documentation/nvme-wdc-get-crash-dump.html | 6 +- Documentation/nvme-wdc-get-dev-capabilities-log.1 | 79 + .../nvme-wdc-get-dev-capabilities-log.html | 823 ++++ .../nvme-wdc-get-dev-capabilities-log.txt | 48 + Documentation/nvme-wdc-get-drive-status.1 | 4 +- Documentation/nvme-wdc-get-drive-status.html | 6 +- Documentation/nvme-wdc-get-error-recovery-log.1 | 79 + Documentation/nvme-wdc-get-error-recovery-log.html | 823 ++++ Documentation/nvme-wdc-get-error-recovery-log.txt | 48 + Documentation/nvme-wdc-get-latency-monitor-log.1 | 4 +- .../nvme-wdc-get-latency-monitor-log.html | 6 +- Documentation/nvme-wdc-get-pfail-dump.1 | 4 +- Documentation/nvme-wdc-get-pfail-dump.html | 6 +- Documentation/nvme-wdc-get-unsupported-reqs-log.1 | 79 + .../nvme-wdc-get-unsupported-reqs-log.html | 823 ++++ .../nvme-wdc-get-unsupported-reqs-log.txt | 48 + Documentation/nvme-wdc-id-ctrl.1 | 4 +- Documentation/nvme-wdc-id-ctrl.html | 6 +- Documentation/nvme-wdc-log-page-directory.1 | 4 +- Documentation/nvme-wdc-log-page-directory.html | 6 +- Documentation/nvme-wdc-namespace-resize.1 | 4 +- Documentation/nvme-wdc-namespace-resize.html | 6 +- Documentation/nvme-wdc-purge-monitor.1 | 4 +- Documentation/nvme-wdc-purge-monitor.html | 6 +- Documentation/nvme-wdc-purge.1 | 4 +- Documentation/nvme-wdc-purge.html | 6 +- 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 | 6 +- .../nvme-wdc-vs-error-reason-identifier.1 | 4 +- .../nvme-wdc-vs-error-reason-identifier.html | 6 +- Documentation/nvme-wdc-vs-fw-activate-history.1 | 4 +- Documentation/nvme-wdc-vs-fw-activate-history.html | 6 +- 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 | 6 +- Documentation/nvme-wdc-vs-smart-add-log.1 | 4 +- Documentation/nvme-wdc-vs-smart-add-log.html | 6 +- .../nvme-wdc-vs-telemetry-controller-option.1 | 4 +- .../nvme-wdc-vs-telemetry-controller-option.html | 6 +- Documentation/nvme-wdc-vs-temperature-stats.1 | 4 +- Documentation/nvme-wdc-vs-temperature-stats.html | 6 +- Documentation/nvme-write-uncor.1 | 10 +- Documentation/nvme-write-uncor.html | 18 +- Documentation/nvme-write-uncor.txt | 5 + Documentation/nvme-write-zeroes.1 | 10 +- Documentation/nvme-write-zeroes.html | 18 +- Documentation/nvme-write-zeroes.txt | 5 + Documentation/nvme-write.1 | 12 +- Documentation/nvme-write.html | 24 +- Documentation/nvme-write.txt | 11 +- Documentation/nvme-zns-changed-zone-list.1 | 4 +- Documentation/nvme-zns-changed-zone-list.html | 6 +- Documentation/nvme-zns-close-zone.1 | 4 +- Documentation/nvme-zns-close-zone.html | 14 +- Documentation/nvme-zns-finish-zone.1 | 4 +- Documentation/nvme-zns-finish-zone.html | 14 +- Documentation/nvme-zns-id-ctrl.1 | 4 +- Documentation/nvme-zns-id-ctrl.html | 6 +- Documentation/nvme-zns-id-ns.1 | 6 +- Documentation/nvme-zns-id-ns.html | 16 +- Documentation/nvme-zns-id-ns.txt | 2 +- Documentation/nvme-zns-offline-zone.1 | 4 +- Documentation/nvme-zns-offline-zone.html | 14 +- Documentation/nvme-zns-open-zone.1 | 16 +- Documentation/nvme-zns-open-zone.html | 32 +- Documentation/nvme-zns-open-zone.txt | 13 +- Documentation/nvme-zns-report-zones.1 | 4 +- Documentation/nvme-zns-report-zones.html | 6 +- Documentation/nvme-zns-reset-zone.1 | 4 +- Documentation/nvme-zns-reset-zone.html | 14 +- Documentation/nvme-zns-set-zone-desc.1 | 10 +- Documentation/nvme-zns-set-zone-desc.html | 26 +- Documentation/nvme-zns-set-zone-desc.txt | 5 + Documentation/nvme-zns-zone-append.1 | 4 +- Documentation/nvme-zns-zone-append.html | 6 +- Documentation/nvme-zns-zone-mgmt-recv.1 | 4 +- Documentation/nvme-zns-zone-mgmt-recv.html | 6 +- Documentation/nvme-zns-zone-mgmt-send.1 | 14 +- Documentation/nvme-zns-zone-mgmt-send.html | 30 +- Documentation/nvme-zns-zone-mgmt-send.txt | 9 +- Documentation/nvme-zns-zrwa-flush-zone.1 | 84 + Documentation/nvme-zns-zrwa-flush-zone.html | 842 ++++ Documentation/nvme-zns-zrwa-flush-zone.txt | 50 + Documentation/nvme.1 | 512 ++- Documentation/nvme.html | 821 +++- Documentation/nvme.txt | 5 + Makefile | 285 +- NVME-VERSION-GEN | 42 - README.md | 60 +- ccan/ccan/build_assert/LICENSE | 1 + ccan/ccan/build_assert/_info | 49 + ccan/ccan/build_assert/build_assert.h | 40 + ccan/ccan/check_type/LICENSE | 1 + ccan/ccan/check_type/_info | 33 + ccan/ccan/check_type/check_type.h | 64 + ccan/ccan/container_of/LICENSE | 1 + ccan/ccan/container_of/_info | 65 + ccan/ccan/container_of/container_of.h | 145 + ccan/ccan/endian/LICENSE | 1 + ccan/ccan/endian/_info | 55 + ccan/ccan/endian/endian.h | 363 ++ ccan/ccan/list/LICENSE | 1 + ccan/ccan/list/_info | 72 + ccan/ccan/list/list.c | 43 + ccan/ccan/list/list.h | 842 ++++ ccan/ccan/str/LICENSE | 1 + ccan/ccan/str/_info | 52 + ccan/ccan/str/debug.c | 108 + ccan/ccan/str/str.c | 13 + ccan/ccan/str/str.h | 228 + ccan/ccan/str/str_debug.h | 30 + ccan/licenses/BSD-MIT | 17 + ccan/licenses/CC0 | 28 + ccan/meson.build | 10 + common.h | 25 +- completions/_nvme | 87 +- completions/bash-nvme-completion.sh | 119 +- fabrics.c | 2646 ++++------- fabrics.h | 64 +- linux/lightnvm.h | 174 - linux/nvme.h | 2013 -------- linux/nvme_ioctl.h | 75 - meson.build | 276 ++ meson_options.txt | 8 + nvme-builtin.h | 14 +- nvme-filters.c | 104 - nvme-ioctl.c | 1157 ----- nvme-ioctl.h | 193 - nvme-lightnvm.c | 700 --- nvme-lightnvm.h | 329 -- nvme-print.c | 3567 ++++++++------- nvme-print.h | 96 +- nvme-rpmb.c | 78 +- nvme-status.c | 190 - nvme-status.h | 14 - nvme-topology.c | 801 ---- nvme.c | 4826 +++++++++++++------- nvme.control.in | 4 +- nvme.h | 105 +- nvme.spec.in | 55 +- .../dracut-conf/70-nvmf-autoconnect.conf.in | 2 +- .../systemd/nvmefc-boot-connections.service | 10 - .../systemd/nvmefc-boot-connections.service.in | 10 + nvmf-autoconnect/systemd/nvmf-autoconnect.service | 13 - .../systemd/nvmf-autoconnect.service.in | 13 + nvmf-autoconnect/systemd/nvmf-connect.target | 2 - nvmf-autoconnect/systemd/nvmf-connect.target.in | 2 + nvmf-autoconnect/systemd/nvmf-connect@.service | 14 - nvmf-autoconnect/systemd/nvmf-connect@.service.in | 14 + .../udev-rules/70-nvmf-autoconnect.rules | 19 - .../udev-rules/70-nvmf-autoconnect.rules.in | 19 + .../udev-rules/71-nvmf-iopolicy-netapp.rules | 3 - .../udev-rules/71-nvmf-iopolicy-netapp.rules.in | 3 + plugin.c | 32 +- plugins/amzn/amzn-nvme.c | 8 +- plugins/dera/dera-nvme.c | 17 +- plugins/huawei/huawei-nvme.c | 22 +- plugins/intel/intel-nvme.c | 238 +- plugins/lnvm/lnvm-nvme.c | 436 -- plugins/lnvm/lnvm-nvme.h | 27 - plugins/memblaze/memblaze-nvme.c | 225 +- plugins/meson.build | 21 + plugins/micron/micron-nvme.c | 688 ++- plugins/micron/micron-nvme.h | 7 +- plugins/netapp/netapp-nvme.c | 67 +- plugins/nvidia/nvidia-nvme.c | 8 +- plugins/ocp/ocp-nvme.c | 788 ++++ plugins/ocp/ocp-nvme.h | 25 + plugins/scaleflux/sfx-nvme.c | 78 +- plugins/seagate/seagate-nvme.c | 140 +- plugins/shannon/shannon-nvme.c | 73 +- plugins/shannon/shannon-nvme.h | 8 +- plugins/toshiba/toshiba-nvme.c | 40 +- plugins/transcend/transcend-nvme.c | 10 +- plugins/virtium/virtium-nvme.c | 29 +- plugins/wdc/wdc-nvme.c | 2499 ++++++---- plugins/wdc/wdc-nvme.h | 5 +- plugins/ymtc/ymtc-nvme.c | 18 +- plugins/zns/zns.c | 461 +- plugins/zns/zns.h | 29 +- scripts/gen-hostnqn.sh | 29 +- subprojects/json-c.wrap | 12 + subprojects/libnvme.wrap | 6 + subprojects/zlib.wrap | 12 + tests/Makefile | 48 - tests/README | 32 +- tests/meson.build | 79 + tests/nvme_attach_detach_ns_test.py | 1 + tests/nvme_copy_test.py | 60 + tests/nvme_create_max_ns_test.py | 4 +- tests/nvme_dsm_test.py | 57 + tests/nvme_format_test.py | 7 +- tests/nvme_fw_log_test.py | 3 +- tests/nvme_get_features_test.py | 1 + tests/nvme_get_lba_status_test.py | 71 + tests/nvme_id_ns_test.py | 3 +- tests/nvme_lba_status_log_test.py | 60 + tests/nvme_read_write_test.py | 2 + tests/nvme_smart_log_test.py | 4 +- tests/nvme_test.py | 34 +- tests/nvme_test_io.py | 1 + tests/nvme_test_logger.py | 1 + tests/nvme_verify_test.py | 56 + tests/nvme_writezeros_test.py | 2 + tests/run_py_linters.py | 123 + update-docs.sh | 10 + util/argconfig.c | 22 +- util/argconfig.h | 8 +- util/base64.c | 105 + util/base64.h | 7 + util/json.h | 1 + util/log.c | 90 - util/log.h | 34 - util/meson.build | 8 + util/parser.c | 46 +- 533 files changed, 34086 insertions(+), 23506 deletions(-) delete mode 100644 .github/workflows/c-cpp.yml create mode 100644 .github/workflows/meson.yml create mode 100644 .gitmodules delete mode 100644 Documentation/Makefile create mode 100644 Documentation/cmd-plugins.txt create mode 100644 Documentation/meson.build create mode 100644 Documentation/nvme-check-dhchap-key.1 create mode 100644 Documentation/nvme-check-dhchap-key.html create mode 100644 Documentation/nvme-check-dhchap-key.txt create mode 100644 Documentation/nvme-check-tls-key.txt create mode 100644 Documentation/nvme-config.txt create mode 100644 Documentation/nvme-dim.1 create mode 100644 Documentation/nvme-dim.html create mode 100644 Documentation/nvme-dim.txt create mode 100644 Documentation/nvme-gen-dhchap-key.1 create mode 100644 Documentation/nvme-gen-dhchap-key.html create mode 100644 Documentation/nvme-gen-dhchap-key.txt create mode 100644 Documentation/nvme-gen-tls-key.txt create mode 100644 Documentation/nvme-id-ns-lba-format.1 create mode 100644 Documentation/nvme-id-ns-lba-format.html create mode 100644 Documentation/nvme-id-ns-lba-format.txt delete mode 100644 Documentation/nvme-lnvm-create.1 delete mode 100644 Documentation/nvme-lnvm-create.html delete mode 100644 Documentation/nvme-lnvm-create.txt delete mode 100644 Documentation/nvme-lnvm-diag-bbtbl.1 delete mode 100644 Documentation/nvme-lnvm-diag-bbtbl.html delete mode 100644 Documentation/nvme-lnvm-diag-bbtbl.txt delete mode 100644 Documentation/nvme-lnvm-diag-set-bbtbl.1 delete mode 100644 Documentation/nvme-lnvm-diag-set-bbtbl.html delete mode 100644 Documentation/nvme-lnvm-diag-set-bbtbl.txt delete mode 100644 Documentation/nvme-lnvm-factory.1 delete mode 100644 Documentation/nvme-lnvm-factory.html delete mode 100644 Documentation/nvme-lnvm-factory.txt delete mode 100644 Documentation/nvme-lnvm-id-ns.1 delete mode 100644 Documentation/nvme-lnvm-id-ns.html delete mode 100644 Documentation/nvme-lnvm-id-ns.txt delete mode 100644 Documentation/nvme-lnvm-info.1 delete mode 100644 Documentation/nvme-lnvm-info.html delete mode 100644 Documentation/nvme-lnvm-info.txt delete mode 100644 Documentation/nvme-lnvm-init.1 delete mode 100644 Documentation/nvme-lnvm-init.html delete mode 100644 Documentation/nvme-lnvm-init.txt delete mode 100644 Documentation/nvme-lnvm-list.1 delete mode 100644 Documentation/nvme-lnvm-list.html delete mode 100644 Documentation/nvme-lnvm-list.txt delete mode 100644 Documentation/nvme-lnvm-remove.1 delete mode 100644 Documentation/nvme-lnvm-remove.html delete mode 100644 Documentation/nvme-lnvm-remove.txt create mode 100644 Documentation/nvme-media-unit-stat-log.1 create mode 100644 Documentation/nvme-media-unit-stat-log.html create mode 100644 Documentation/nvme-media-unit-stat-log.txt create mode 100644 Documentation/nvme-mi-cmd-support-effects-log.1 create mode 100644 Documentation/nvme-mi-cmd-support-effects-log.html create mode 100644 Documentation/nvme-mi-cmd-support-effects-log.txt create mode 100644 Documentation/nvme-nvm-id-ns-lba-format.1 create mode 100644 Documentation/nvme-nvm-id-ns-lba-format.html create mode 100644 Documentation/nvme-nvm-id-ns-lba-format.txt create mode 100644 Documentation/nvme-nvm-id-ns.1 create mode 100644 Documentation/nvme-nvm-id-ns.html create mode 100644 Documentation/nvme-nvm-id-ns.txt create mode 100644 Documentation/nvme-ocp-latency-monitor-log.1 create mode 100644 Documentation/nvme-ocp-latency-monitor-log.html create mode 100644 Documentation/nvme-ocp-latency-monitor-log.txt create mode 100644 Documentation/nvme-ocp-smart-add-log.1 create mode 100644 Documentation/nvme-ocp-smart-add-log.html create mode 100644 Documentation/nvme-ocp-smart-add-log.txt create mode 100644 Documentation/nvme-supported-cap-config-log.txt create mode 100644 Documentation/nvme-wdc-clear-pcie-corr.1 create mode 100644 Documentation/nvme-wdc-clear-pcie-corr.html create mode 100644 Documentation/nvme-wdc-get-dev-capabilities-log.1 create mode 100644 Documentation/nvme-wdc-get-dev-capabilities-log.html create mode 100644 Documentation/nvme-wdc-get-dev-capabilities-log.txt create mode 100644 Documentation/nvme-wdc-get-error-recovery-log.1 create mode 100644 Documentation/nvme-wdc-get-error-recovery-log.html create mode 100644 Documentation/nvme-wdc-get-error-recovery-log.txt create mode 100644 Documentation/nvme-wdc-get-unsupported-reqs-log.1 create mode 100644 Documentation/nvme-wdc-get-unsupported-reqs-log.html create mode 100644 Documentation/nvme-wdc-get-unsupported-reqs-log.txt create mode 100644 Documentation/nvme-wdc-smart-add-log.1 create mode 100644 Documentation/nvme-wdc-smart-add-log.html create mode 100644 Documentation/nvme-zns-zrwa-flush-zone.1 create mode 100644 Documentation/nvme-zns-zrwa-flush-zone.html create mode 100644 Documentation/nvme-zns-zrwa-flush-zone.txt delete mode 100755 NVME-VERSION-GEN create mode 120000 ccan/ccan/build_assert/LICENSE create mode 100644 ccan/ccan/build_assert/_info create mode 100644 ccan/ccan/build_assert/build_assert.h create mode 120000 ccan/ccan/check_type/LICENSE create mode 100644 ccan/ccan/check_type/_info create mode 100644 ccan/ccan/check_type/check_type.h create mode 120000 ccan/ccan/container_of/LICENSE create mode 100644 ccan/ccan/container_of/_info create mode 100644 ccan/ccan/container_of/container_of.h create mode 120000 ccan/ccan/endian/LICENSE create mode 100644 ccan/ccan/endian/_info create mode 100644 ccan/ccan/endian/endian.h create mode 120000 ccan/ccan/list/LICENSE create mode 100644 ccan/ccan/list/_info create mode 100644 ccan/ccan/list/list.c create mode 100644 ccan/ccan/list/list.h create mode 120000 ccan/ccan/str/LICENSE create mode 100644 ccan/ccan/str/_info create mode 100644 ccan/ccan/str/debug.c create mode 100644 ccan/ccan/str/str.c create mode 100644 ccan/ccan/str/str.h create mode 100644 ccan/ccan/str/str_debug.h create mode 100644 ccan/licenses/BSD-MIT create mode 100644 ccan/licenses/CC0 create mode 100644 ccan/meson.build delete mode 100644 linux/lightnvm.h delete mode 100644 linux/nvme.h delete mode 100644 linux/nvme_ioctl.h create mode 100644 meson.build create mode 100644 meson_options.txt delete mode 100644 nvme-filters.c delete mode 100644 nvme-ioctl.c delete mode 100644 nvme-ioctl.h delete mode 100644 nvme-lightnvm.c delete mode 100644 nvme-lightnvm.h mode change 100755 => 100644 nvme-print.c delete mode 100644 nvme-status.c delete mode 100644 nvme-status.h delete mode 100644 nvme-topology.c delete mode 100644 nvmf-autoconnect/systemd/nvmefc-boot-connections.service create mode 100644 nvmf-autoconnect/systemd/nvmefc-boot-connections.service.in delete mode 100644 nvmf-autoconnect/systemd/nvmf-autoconnect.service create mode 100644 nvmf-autoconnect/systemd/nvmf-autoconnect.service.in delete mode 100644 nvmf-autoconnect/systemd/nvmf-connect.target create mode 100644 nvmf-autoconnect/systemd/nvmf-connect.target.in delete mode 100644 nvmf-autoconnect/systemd/nvmf-connect@.service create mode 100644 nvmf-autoconnect/systemd/nvmf-connect@.service.in delete mode 100644 nvmf-autoconnect/udev-rules/70-nvmf-autoconnect.rules create mode 100644 nvmf-autoconnect/udev-rules/70-nvmf-autoconnect.rules.in delete mode 100644 nvmf-autoconnect/udev-rules/71-nvmf-iopolicy-netapp.rules create mode 100644 nvmf-autoconnect/udev-rules/71-nvmf-iopolicy-netapp.rules.in delete mode 100644 plugins/lnvm/lnvm-nvme.c delete mode 100644 plugins/lnvm/lnvm-nvme.h create mode 100644 plugins/meson.build create mode 100644 plugins/ocp/ocp-nvme.c create mode 100644 plugins/ocp/ocp-nvme.h create mode 100644 subprojects/json-c.wrap create mode 100644 subprojects/libnvme.wrap create mode 100644 subprojects/zlib.wrap delete mode 100644 tests/Makefile create mode 100644 tests/meson.build create mode 100644 tests/nvme_copy_test.py create mode 100644 tests/nvme_dsm_test.py create mode 100644 tests/nvme_get_lba_status_test.py create mode 100644 tests/nvme_lba_status_log_test.py create mode 100644 tests/nvme_verify_test.py create mode 100644 tests/run_py_linters.py create mode 100755 update-docs.sh create mode 100644 util/base64.c create mode 100644 util/base64.h delete mode 100644 util/log.c delete mode 100644 util/log.h create mode 100644 util/meson.build diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml deleted file mode 100644 index 03471d7..0000000 --- a/.github/workflows/c-cpp.yml +++ /dev/null @@ -1,18 +0,0 @@ -gname: C/C++ CI - -on: - push: - branches: [ master nvme-cli-monolithic ] - pull_request: - branches: [ master nvme-cli-monolithic ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: make - run: sudo apt-get install gcc-10-powerpc* && make clean && make && make clean && make LD=powerpc64le-linux-gnu-ld CC=powerpc64le-linux-gnu-gcc-10 CFLAGS='-O2 -g -Wall -Wformat-security -Werror -m64 -mcpu=power8 -mtune=power8 -I -I/usr/powerpc64-linux-gnu/include/' - diff --git a/.github/workflows/meson.yml b/.github/workflows/meson.yml new file mode 100644 index 0000000..0d6350f --- /dev/null +++ b/.github/workflows/meson.yml @@ -0,0 +1,27 @@ +name: nvme-cli meson CI + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + + workflow_dispatch: + +jobs: + meson-build: + runs-on: ubuntu-latest + + steps: + - name: install libraries + run: sudo apt-get install libjson-c-dev libhugetlbfs-dev + - uses: actions/checkout@v2 + - uses: actions/setup-python@v1 + # - name: install python dependencies + # run: | + # python -m pip install --upgrade pip + # pip install nose nose2 + - uses: BSFishy/meson-build@v1.0.3 + with: + setup-options: --werror + action: build diff --git a/.gitignore b/.gitignore index 8e5ae00..0745eff 100644 --- a/.gitignore +++ b/.gitignore @@ -4,18 +4,15 @@ a.out *.o *~ *.swp -NVME-VERSION-FILE -nvme.spec nvme-*.tar.gz -version -cscope.* +subprojects/* +!subprojects/*.wrap -/debian/files -/debian/nvme-cli.debhelper.log -/debian/nvme-cli.substvars -/debian/nvme-cli +cscope.* tests/__pycache__ tests/nvmetests tests/*.pyc + +.build \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..e69de29 diff --git a/Documentation/Makefile b/Documentation/Makefile deleted file mode 100644 index 9edae99..0000000 --- a/Documentation/Makefile +++ /dev/null @@ -1,265 +0,0 @@ -# Guard against environment variables -MAN1_TXT = -TECH_DOCS = -ARTICLES = -SP_ARTICLES = - -MAN1_TXT += $(filter-out \ - $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \ - $(wildcard nvme-*.txt)) -MAN1_TXT += nvme.txt -MAN_TXT = $(MAN1_TXT) -MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT)) -MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT)) - -DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML) - -API_DOCS = -SP_ARTICLES += $(API_DOCS) -SP_ARTICLES += $(TECH_DOCS) - -ifneq ($(findstring $(MAKEFLAGS),s),s) -ifndef V - QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@; - QUIET_XMLTO = @echo ' ' XMLTO $@; - QUIET_DB2TEXI = @echo ' ' DB2TEXI $@; - QUIET_MAKEINFO = @echo ' ' MAKEINFO $@; - QUIET_DBLATEX = @echo ' ' DBLATEX $@; - QUIET_XSLTPROC = @echo ' ' XSLTPROC $@; - QUIET_GEN = @echo ' ' GEN $@; - QUIET_LINT = @echo ' ' LINT $@; - QUIET_STDERR = 2> /dev/null - QUIET_SUBDIR0 = +@subdir= - QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \ - $(MAKE) $(PRINT_DIR) -C $$subdir - export V -endif -endif - -DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT)) - -ASCIIDOC = asciidoc -ASCIIDOC_EXTRA = -ASCIIDOC_DOCBOOK = docbook -ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) -TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK) -MANPAGE_XSL = manpage-normal.xsl -XMLTO = xmlto -XMLTO_EXTRA = --skip-validation -INSTALL ?= install -RM ?= rm -f -MAN_REPO = ../../nvme-manpages - -ASCIIDOC_HTML = xhtml11 -ASCIIDOC_CONF = -f asciidoc.conf - -ifdef USE_ASCIIDOCTOR -ASCIIDOC = asciidoctor -ASCIIDOC_CONF = -ASCIIDOC_HTML = xhtml5 -ASCIIDOC_DOCBOOK = docbook5 -ASCIIDOC_EXTRA += -acompat-mode -ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions -ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;' -ASCIIDOC_EXTRA += -amansource='NVMe' -ASCIIDOC_EXTRA += -amanmanual='NVMe Manual' -endif - -ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF) -TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML) - -MAKEINFO = makeinfo -INSTALL_INFO = install-info -DOCBOOK2X_TEXI = docbook2x-texi -DBLATEX = dblatex -ASCIIDOC_DBLATEX_DIR = /etc/asciidoc/dblatex -ifndef PERL_PATH - PERL_PATH = /usr/bin/perl -endif - -ifdef DOCBOOK_XSL_172 -MANPAGE_XSL = manpage-1.72.xsl -else - ifndef ASCIIDOC_ROFF - endif -endif -ifdef MAN_BOLD_LITERAL -XMLTO_EXTRA += -m manpage-bold-literal.xsl -endif -ifdef DOCBOOK_SUPPRESS_SP -XMLTO_EXTRA += -m manpage-suppress-sp.xsl -endif - -ifndef MAN_BASE_URL -MAN_BASE_URL = file://$(htmldir)/ -endif -XMLTO_EXTRA += - -ifdef GNU_ROFF -XMLTO_EXTRA += -endif - -SHELL_PATH ?= $(SHELL) -# Shell quote; -SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH)) - -ifdef DEFAULT_PAGER -DEFAULT_PAGER_SQ = $(subst ','\'',$(DEFAULT_PAGER)) -endif - -ifdef DEFAULT_EDITOR -DEFAULT_EDITOR_SQ = $(subst ','\'',$(DEFAULT_EDITOR)) -endif - -QUIET_SUBDIR0 = +$(MAKE) -C # space to separate -C and subdir -QUIET_SUBDIR1 = - -ifneq ($(findstring $(MAKEFLAGS),w),w) -PRINT_DIR = --no-print-directory -else # "make -w" -NO_SUBDIR = : -endif - -DESTDIR = -PREFIX ?= /usr/local - -all: man html - -html: $(DOC_HTML) - -man: man1 -man1: $(DOC_MAN1) - -install-no-build: - $(INSTALL) -d -m 755 $(DESTDIR)$(PREFIX)/share/man/man1 - $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(PREFIX)/share/man/man1 - -install: install-man - -install-man: man - $(INSTALL) -d -m 755 $(DESTDIR)$(PREFIX)/share/man/man1 - $(INSTALL) -m 644 $(DOC_MAN1) $(DESTDIR)$(PREFIX)/share/man/man1 - -docdep_prereqs = \ - cmd-list.made $(cmds_txt) - -doc.dep : $(docdep_prereqs) $(wildcard *.txt) build-docdep.perl - $(QUIET_GEN)$(RM) $@+ $@ && \ - $(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \ - mv $@+ $@ - --include doc.dep - -cmds_txt = cmds-ancillaryinterrogators.txt \ - cmds-ancillarymanipulators.txt \ - cmds-mainporcelain.txt \ - cmds-plumbinginterrogators.txt \ - cmds-plumbingmanipulators.txt \ - cmds-synchingrepositories.txt \ - cmds-synchelpers.txt \ - cmds-purehelpers.txt \ - cmds-foreignscminterface.txt - -$(cmds_txt): cmd-list.made - -cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT) - $(QUIET_GEN)$(RM) $@ && \ - $(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \ - date >$@ - -clean: - $(RM) *.xml *.xml+ *.html+ - $(RM) *.texi *.texi+ *.texi++ nvme.info nvmeman.info - $(RM) *.pdf - $(RM) howto-index.txt howto/*.html doc.dep - $(RM) technical/*.html technical/api-index.txt - $(RM) $(cmds_txt) *.made - $(RM) manpage-base-url.xsl - $(RM) *~ - -clobber: clean - $(RM) *.html *.1 - -%.1 : %.xml - $(QUIET_XMLTO)$(RM) $@ && \ - $(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $< - -%.xml : %.txt - $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ - $(TXT_TO_XML) -d manpage -o $@+ $< && \ - mv $@+ $@ - -user-manual.xml: user-manual.txt user-manual.conf - $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ - $(TXT_TO_XML) -d article -o $@+ $< && \ - mv $@+ $@ - -technical/api-index.txt: technical/api-index-skel.txt \ - technical/api-index.sh $(patsubst %,%.txt,$(API_DOCS)) - $(QUIET_GEN)cd technical && '$(SHELL_PATH_SQ)' ./api-index.sh - -XSLT = docbook.xsl -XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css - -nvme.info: user-manual.texi - $(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi - -user-manual.texi: user-manual.xml - $(QUIET_DB2TEXI)$(RM) $@+ $@ && \ - $(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \ - $(PERL_PATH) fix-texi.perl <$@++ >$@+ && \ - rm $@++ && \ - mv $@+ $@ - -user-manual.pdf: user-manual.xml - $(QUIET_DBLATEX)$(RM) $@+ $@ && \ - $(DBLATEX) -o $@+ -p $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.xsl -s $(ASCIIDOC_DBLATEX_DIR)/asciidoc-dblatex.sty $< && \ - mv $@+ $@ - -nvmeman.texi: $(MAN_XML) cat-texi.perl - $(QUIET_DB2TEXI)$(RM) $@+ $@ && \ - ($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \ - --to-stdout $(xml) &&) true) > $@++ && \ - $(PERL_PATH) cat-texi.perl $@ <$@++ >$@+ && \ - rm $@++ && \ - mv $@+ $@ - -nvmeman.info: nvmeman.texi - $(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi - -$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml - $(QUIET_DB2TEXI)$(RM) $@+ $@ && \ - $(DOCBOOK2X_TEXI) --to-stdout $*.xml >$@+ && \ - mv $@+ $@ - -howto-index.txt: howto-index.sh $(wildcard howto/*.txt) - $(QUIET_GEN)$(RM) $@+ $@ && \ - '$(SHELL_PATH_SQ)' ./howto-index.sh $(sort $(wildcard howto/*.txt)) >$@+ && \ - mv $@+ $@ - -WEBDOC_DEST = /pub/software/scm/nvme/docs - -$(MAN_HTML): %.html : %.txt - $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \ - $(TXT_TO_HTML) -d manpage -o $@+ $< && \ - mv $@+ $@ - -quick-install: quick-install-man - -$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt - $(QUIET_ASCIIDOC)$(TXT_TO_HTML) $*.txt - -install-webdoc : html - '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(WEBDOC_DEST) - -require-manrepo:: - @if test ! -d $(MAN_REPO); \ - then echo "nvme-manpages repository must exist at $(MAN_REPO)"; exit 1; fi - -quick-install-man: require-manrepo - '$(SHELL_PATH_SQ)' ./install-doc-quick.sh $(MAN_REPO) $(DESTDIR)$(mandir) - -print-man1: - @for i in $(MAN1_TXT); do echo $$i; done - -.PHONY: FORCE diff --git a/Documentation/cmd-plugins.txt b/Documentation/cmd-plugins.txt new file mode 100644 index 0000000..4e66cf1 --- /dev/null +++ b/Documentation/cmd-plugins.txt @@ -0,0 +1,200 @@ +linknvme:nvme-intel-id-ctrl[1]:: + Intel - NVMe Identify Controller + +linknvme:nvme-intel-internal-log[1]:: + Retrieve Intel device's internal log and save to file + +linknvme:nvme-intel-lat-stats[1]:: + Retrieve NVMe Identify Controller, return result and structure + +linknvme:nvme-intel-market-name[1]:: + Intel vendor specific marketing name log page + +linknvme:nvme-intel-smart-log-add[1]:: + NVMe Intel Additional SMART log page + +linknvme:nvme-intel-temp-stats[1]:: + NVMe Intel Additional SMART log page for temp stats + +linknvme:nvme-huawei-id-ctrl[1]:: + NVMe huawei Identify Controller + +linknvme:nvme-huawei-list[1]:: + List all recognized Huawei NVMe devices + +linknvme:nvme-dera-stat[1]:: + NVMe Dera Device status and Additional SMART log page request + +linknvme:nvme-micron-clear-pcie-errors[1]:: + Clears correctable PCIe correctable errors of given Micron device + +linknvme:nvme-micron-internal-log[1]:: + Retrieve Micron device's internal logs and save to given zip file + +linknvme:nvme-micron-nand-stats[1]:: + Retrieves NAND statistics of given micron device + +linknvme:nvme-micron-pcie-stats[1]:: + Retrieves pcie error statistics for given micron device + +linknvme:nvme-micron-selective-download[1]:: + Performs selective firmware download + +linknvme:nvme-micron-smart-add-log[1]:: + Retrieves NAND statistics + +linknvme:nvme-micron-temperature-stats[1]:: + Retrieves temperature information of given micron device + +linknvme:nvme-netapp-ontapdevices[1]:: + Display information about ONTAP devices + +linknvme:nvme-netapp-smdevices[1]:: + Display information for each NVMe path to an E-Series volume + +linknvme:nvme-toshiba-clear-pcie-correctable-errors[1]:: + Reset the PCIe correctable errors count to zero + +linknvme:nvme-toshiba-vs-internal-log[1]:: + Retrieve a Toshiba device's vendor specific internal log + +linknvme:nvme-toshiba-vs-smart-add-log[1]:: + Retrieve a Toshiba device's vendor specific extended SMART log page + +linknvme:nvme-transcend-badblock[1]:: + Retrieve Transcend NVMe device's bad blocks + +linknvme:nvme-transcend-healthvalue[1]:: + Use NVMe SMART table to analyse the health value of Transcend device + +linknvme:nvme-virtium-show-identify[1]:: + Show a complete detail of identify device information in json format + +linknvme:nvme-virtium-save-smart-to-vtview-log[1]:: + Periodically save smart attributes into a log file + +linknvme:nvme-wdc-cap-diag[1]:: + Retrieve WDC device's diagnostic log and save to file + +linknvme:nvme-wdc-capabilities[1]:: + Display WDC plugin command capabilities + +linknvme:nvme-wdc-clear-assert-dump[1]:: + Clears the assert dump (if present) + +linknvme:nvme-wdc-clear-fw-activate-history[1]:: + Clears the firmware activate history table + +linknvme:nvme-wdc-clear-pcie-corr[1]:: + Clears the pcie correctable errors field + +linknvme:nvme-wdc-clear-pcie-correctable-errors[1]:: + Clears the pcie correctable errors returned in the smart-log-add command + +linknvme:nvme-wdc-cloud-SSD-plugin-version[1]:: + Display WDC plugin Cloud SSD Plugin Version + +linknvme:nvme-wdc-drive-essentials[1]:: + Retrieve WDC device's drive essentials bin files + +linknvme:nvme-wdc-drive-log[1]:: + Retrieve WDC device's drive log and save to file + +linknvme:nvme-wdc-drive-resize[1]:: + Send NVMe WDC Resize Vendor Unique Command + +linknvme:nvme-wdc-enc-get-log[1]:: + Send NVMe WDC enc-get-log Vendor Unique Command + +linknvme:nvme-wdc-get-crash-dump[1]:: + Retrieve WDC device's crash dump + +linknvme:nvme-wdc-get-drive-status[1]:: + Send the NVMe WDC get-drive-status command + +linknvme:nvme-wdc-get-latency-monitor-log[1]:: + Display latency monitor log page data in human readable format + +linknvme:nvme-wdc-get-pfail-dump[1]:: + Retrieve WDC device's pfail crash dump + +linknvme:nvme-wdc-id-ctrl[1]:: + Send NVMe Identify Controller, return result and structure + +linknvme:nvme-wdc-log-page-directory[1]:: + Retrieves the list of Log IDs supported by the drive + +linknvme:nvme-wdc-namespace-resize[1]:: + Resizes the device's namespace + +linknvme:nvme-wdc-purge-monitor[1]:: + Send NVMe WDC Purge-Monitor Vendor Unique Command + +linknvme:nvme-wdc-purge[1]:: + Send NVMe WDC Purge Vendor Unique Command + +linknvme:nvme-wdc-smart-add-log[1]:: + Send NVMe WDC smart add log Vendor Unique Command + +linknvme:nvme-wdc-vs-drive-info[1]:: + Send the NVMe WDC vs-drive-info command + +linknvme:nvme-wdc-vs-error-reason-identifier[1]:: + Retrieve WDC device's telemetry log error reason identifier field + +linknvme:nvme-wdc-vs-fw-activate-history[1]:: + Execute NVMe WDC vs-fw-activate-history Vendor Unique Command + +linknvme:nvme-wdc-vs-internal-log[1]:: + Retrieve WDC device's internal firmware log and save to file + +linknvme:nvme-wdc-vs-nand-stats[1]:: + Send NVMe WDC vs-nand-stats Vendor Unique Command + +linknvme:nvme-wdc-vs-telemetry-controller-option[1]:: + Disable/Enable the controller initiated option of the telemetry log page + +linknvme:nvme-wdc-vs-temperature-stats[1]:: + Display temperature-related statistics + +linknvme:nvme-zns-changed-zone-list[1]:: + Retrieve Changed Zone log for the given device + +linknvme:nvme-zns-close-zone[1]:: + Closes one or all zones + +linknvme:nvme-zns-finish-zone[1]:: + Finishes one or all zones + +linknvme:nvme-zns-id-ctrl[1]:: + Send NVMe Zoned Command Set Identify Controller + +linknvme:nvme-zns-id-ns[1]:: + Send NVMe Zoned Command Set Identify Namespace + +linknvme:nvme-zns-offline-zone[1]:: + Offlines one or all zones + +linknvme:nvme-zns-open-zone[1]:: + Opens one or all zones + +linknvme:nvme-zns-report-zones[1]:: + Retrieve and display the Report Zones data structure + +linknvme:nvme-zns-reset-zone[1]:: + Resets one or all zones + +linknvme:nvme-zns-set-zone-desc[1]:: + Set extended descriptor data for a zone + +linknvme:nvme-zns-zone-append[1]:: + Send an NVMe write command, provide results + +linknvme:nvme-zns-zone-mgmt-recv[1]:: + Zone Management Receive command + +linknvme:nvme-zns-zone-mgmt-send[1]:: + Zone Management Send command + +linknvme:nvme-zns-zrwa-flush-zone[1]:: + Flush LBAs associated with a ZRWA to a zone diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt index 46df03d..ab8ee3b 100644 --- a/Documentation/cmds-main.txt +++ b/Documentation/cmds-main.txt @@ -10,7 +10,7 @@ linknvme:nvme-error-log[1]:: linknvme:nvme-flush[1]:: Submit flush -linknvme:nvme-dms[1]:: +linknvme:nvme-dsm[1]:: Submit Data Set Management linknvme:nvme-format[1]:: @@ -160,6 +160,9 @@ linknvme:nvme-connect-all[1]:: linknvme:nvme-connect[1]:: Connect to an NVMe-over-Fabrics subsystem +linknvme:nvme-dim[1]:: + Send Discovery Information Management command to a Discovery Controller + linknvme:nvme-disconnect[1]:: Disconnect from an NVMe-over-Fabrics subsystem @@ -168,3 +171,102 @@ linknvme:nvme-disconnect-all[1]:: linknvme:nvme-get-property[1]:: Reads and shows NVMe-over-Fabrics controller property + +linknvme:nvme-media-unit-stat-log[1]:: + Retrieve and show the configuration and wear of media units + +linknvme:nvme-supported-cap-config-log[1]:: + Retrieve and show the list of Supported Capacity Configuration Descriptors + +linknvme:nvme-boot-part-log[1]:: + Retrieve Boot Partition Log + +linknvme:nvme-capacity-mgmt[1]:: + Capacity Management Command + +linknvme:nvme-check-dhchap-key[1]:: + Generate NVMeoF DH-HMAC-CHAP host key + +linknvme:nvme-check-tls-key[1]:: + Validate NVMeoF TLS PSK + +linknvme:nvme-cmdset-ind-id-ns[1]:: + I/O Command Set Independent Identify Namespace + +linknvme:nvme-endurance-event-agg-log[1]:: + Retrieve Endurance Group Event Aggregate Log + +linknvme:nvme-fid-support-effects-log[1]:: + Retrieve FID Support and Effects log + +linknvme:nvme-gen-dhchap-key[1]:: + Generate NVMeoF DH-HMAC-CHAP host key + +linknvme:nvme-gen-hostnqn[1]:: + Generate NVMeoF host NQN + +linknvme:nvme-gen-tls-key[1]:: + Generate NVMeoF TLS PSK + +linknvme:nvme-get-lba-status[1]:: + Get LBA Status command + +linknvme:nvme-id-domain[1]:: + NVMe Identify Domain List + +linknvme:nvme-id-ns-lba-format[1]:: + NVMe Identify Namespace for the specified LBA Format index + +linknvme:nvme-lba-status-log[1]:: + Retrieve LBA Status Information Log + +linknvme:nvme-list-endgrp[1]:: + NVMe Identify Endurance Group List + +linknvme:nvme-ns-rescan[1]:: + Rescans the NVME namespaces + +linknvme:nvme-nvm-id-ctrl[1]:: + NVMe Identify Controller NVM Command Set + +linknvme:nvme-nvm-id-ns[1]:: + NVMe Identify Namespace NVM Command Set + +linknvme:nvme-nvm-id-ns-lba-format[1]:: + NVMe Identify Namespace NVM Command Set for the specified LBA Format index + +linknvme:nvme-persistent-event-log[1]:: + Retrieve Presistent Event Log + +linknvme:nvme-predictable-lat-log[1]:: + Retrieve Predictable Latency per Nvmset Log + +linknvme:nvme-pred-lat-event-agg-log[1]:: + Retrieve Predictable Latency Event Aggregate Log + +linknvme:nvme-primary-ctrl-caps[1]:: + NVMe Identify Primary Controller Capabilities + +linknvme:nvme-reset[1]:: + Resets the controller + +linknvme:nvme-rpmb[1]:: + Replay Protection Memory Block commands + +linknvme:nvme-sanitize-log[1]:: + Retrieve sanitize log + +linknvme:nvme-set-property[1]:: + Set a property and show the resulting value + +linknvme:nvme-show-hostnqn[1]:: + Show NVMeoF host NQN + +linknvme:nvme-subsystem-reset[1]:: + Resets the subsystem + +linknvme:nvme-supported-log-pages[1]:: + Retrieve the Supported Log pages details + +linknvme:nvme-verify[1]:: + verify command diff --git a/Documentation/meson.build b/Documentation/meson.build new file mode 100644 index 0000000..a12eec4 --- /dev/null +++ b/Documentation/meson.build @@ -0,0 +1,257 @@ +adoc_sources = [ + 'nvme', + 'nvme-admin-passthru', + 'nvme-ana-log', + 'nvme-attach-ns', + 'nvme-boot-part-log', + 'nvme-capacity-mgmt', + 'nvme-changed-ns-list-log', + 'nvme-cmdset-ind-id-ns', + 'nvme-compare', + 'nvme-connect', + 'nvme-connect-all', + 'nvme-copy', + 'nvme-create-ns', + 'nvme-delete-ns', + 'nvme-dera-stat', + 'nvme-detach-ns', + 'nvme-device-self-test', + 'nvme-dim', + 'nvme-dir-receive', + 'nvme-dir-send', + 'nvme-disconnect', + 'nvme-disconnect-all', + 'nvme-discover', + 'nvme-dsm', + 'nvme-effects-log', + 'nvme-endurance-event-agg-log', + 'nvme-endurance-log', + 'nvme-error-log', + 'nvme-fid-support-effects-log', + 'nvme-mi-cmd-support-effects-log', + 'nvme-flush', + 'nvme-format', + 'nvme-fw-commit', + 'nvme-fw-download', + 'nvme-fw-log', + 'nvme-gen-hostnqn', + 'nvme-get-feature', + 'nvme-get-lba-status', + 'nvme-get-log', + 'nvme-get-ns-id', + 'nvme-get-property', + 'nvme-help', + 'nvme-huawei-id-ctrl', + 'nvme-huawei-list', + 'nvme-id-ctrl', + 'nvme-id-domain', + 'nvme-id-iocs', + 'nvme-id-ns', + 'nvme-id-nvmset', + 'nvme-intel-id-ctrl', + 'nvme-intel-internal-log', + 'nvme-intel-lat-stats', + 'nvme-intel-market-name', + 'nvme-intel-smart-log-add', + 'nvme-intel-temp-stats', + 'nvme-io-passthru', + 'nvme-lba-status-log', + 'nvme-list', + 'nvme-list-ctrl', + 'nvme-list-endgrp', + 'nvme-list-ns', + 'nvme-list-subsys', + 'nvme-lockdown', + 'nvme-micron-clear-pcie-errors', + 'nvme-micron-internal-log', + 'nvme-micron-nand-stats', + 'nvme-micron-pcie-stats', + 'nvme-micron-selective-download', + 'nvme-micron-smart-add-log', + 'nvme-micron-temperature-stats', + 'nvme-netapp-ontapdevices', + 'nvme-netapp-smdevices', + 'nvme-ns-descs', + 'nvme-ns-rescan', + 'nvme-nvm-id-ctrl', + 'nvme-ocp-latency-monitor-log', + 'nvme-ocp-smart-add-log', + 'nvme-persistent-event-log', + 'nvme-pred-lat-event-agg-log', + 'nvme-predictable-lat-log', + 'nvme-primary-ctrl-caps', + 'nvme-read', + 'nvme-reset', + 'nvme-resv-acquire', + 'nvme-resv-notif-log', + 'nvme-resv-register', + 'nvme-resv-release', + 'nvme-resv-report', + 'nvme-rpmb', + 'nvme-sanitize', + 'nvme-sanitize-log', + 'nvme-security-recv', + 'nvme-security-send', + 'nvme-self-test-log', + 'nvme-set-feature', + 'nvme-set-property', + 'nvme-show-hostnqn', + 'nvme-show-regs', + 'nvme-smart-log', + 'nvme-subsystem-reset', + 'nvme-supported-log-pages', + 'nvme-telemetry-log', + 'nvme-toshiba-clear-pcie-correctable-errors', + 'nvme-toshiba-vs-internal-log', + 'nvme-toshiba-vs-smart-add-log', + 'nvme-transcend-badblock', + 'nvme-transcend-healthvalue', + 'nvme-verify', + 'nvme-virtium-save-smart-to-vtview-log', + 'nvme-virtium-show-identify', + 'nvme-wdc-cap-diag', + 'nvme-wdc-capabilities', + 'nvme-wdc-clear-assert-dump', + 'nvme-wdc-clear-fw-activate-history', + 'nvme-wdc-clear-pcie-correctable-errors', + 'nvme-wdc-cloud-SSD-plugin-version', + 'nvme-wdc-drive-essentials', + 'nvme-wdc-drive-log', + 'nvme-wdc-drive-resize', + 'nvme-wdc-enc-get-log', + 'nvme-wdc-get-crash-dump', + 'nvme-wdc-get-dev-capabilities-log', + 'nvme-wdc-get-drive-status', + 'nvme-wdc-get-error-recovery-log', + 'nvme-wdc-get-latency-monitor-log', + 'nvme-wdc-get-pfail-dump', + 'nvme-wdc-get-unsupported-reqs-log', + 'nvme-wdc-id-ctrl', + 'nvme-wdc-log-page-directory', + 'nvme-wdc-namespace-resize', + 'nvme-wdc-purge', + 'nvme-wdc-purge-monitor', + 'nvme-wdc-vs-drive-info', + 'nvme-wdc-vs-error-reason-identifier', + 'nvme-wdc-vs-fw-activate-history', + 'nvme-wdc-vs-internal-log', + 'nvme-wdc-vs-nand-stats', + 'nvme-wdc-vs-smart-add-log', + 'nvme-wdc-vs-telemetry-controller-option', + 'nvme-wdc-vs-temperature-stats', + 'nvme-write', + 'nvme-write-uncor', + 'nvme-write-zeroes', + 'nvme-zns-changed-zone-list', + 'nvme-zns-close-zone', + 'nvme-zns-finish-zone', + 'nvme-zns-id-ctrl', + 'nvme-zns-id-ns', + 'nvme-zns-offline-zone', + 'nvme-zns-open-zone', + 'nvme-zns-report-zones', + 'nvme-zns-reset-zone', + 'nvme-zns-set-zone-desc', + 'nvme-zns-zone-append', + 'nvme-zns-zone-mgmt-recv', + 'nvme-zns-zone-mgmt-send', +] + +adoc_includes = [ + 'cmd-plugins.txt', + 'cmds-main.txt', +] + +want_docs = get_option('docs') +want_docs_build = get_option('docs-build') +if want_docs != 'false' + mandir = join_paths(get_option('mandir'), 'man1') + htmldir = join_paths(get_option('htmldir'), 'nvme') + + asciidoctor = find_program('asciidoc', required : false) + if want_docs_build and asciidoctor.found() + # Build documentation before installing + + foreach file : adoc_includes + configure_file( + input: file, + output: file, + copy: true) + endforeach + + # man pages + if want_docs == 'all' or want_docs == 'man' + xmlto = find_program('xmlto', required: false) + if xmlto.found() + foreach adoc : adoc_sources + input = adoc + '.txt' + subst = configure_file( + input: adoc + '.txt', + output: adoc + '.msubst', + configuration: substs) + xml = custom_target( + adoc.underscorify() + '_xml', + input: subst, + output: '@BASENAME@.xml', + command: [asciidoctor, + '-f', files('asciidoc.conf'), + '-b', 'docbook', + '-d', 'manpage', + '-o', '@OUTPUT@', + '@INPUT@'], + ) + custom_target( + adoc.underscorify() + '_man', + input: xml, + output: '@BASENAME@.1', + command: [xmlto, + '-m', files('manpage-normal.xsl'), + '-o', '@OUTDIR@', + '--skip-validation', + 'man', + '@INPUT@'], + install: true, + install_dir: mandir) + endforeach + endif + endif + + # html + if want_docs == 'all' or want_docs == 'html' + foreach adoc : adoc_sources + input = adoc + '.txt' + subst = configure_file( + input: adoc + '.txt', + output: adoc + '.hsubst', + configuration: substs) + custom_target( + adoc.underscorify() + '_html', + input: subst, + output: '@BASENAME@.html', + command: [asciidoctor, + '-f', files('asciidoc.conf'), + '-b', 'xhtml11', + '-d', 'manpage', + '-o', '@OUTPUT@', + '@INPUT@'], + install: true, + install_dir: htmldir) + endforeach + endif + + else + # asciidoctor not found, install pre compiled documetationx + + foreach adoc : adoc_sources + if want_docs == 'all' or want_docs == 'man' + man = files(adoc + '.1') + install_data(man, install_dir: mandir) + endif + if want_docs == 'all' or want_docs == 'html' + html = files(adoc + '.html') + install_data(html, install_dir: htmldir) + endif + endforeach + + endif +endif diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index fecabb4..1beb822 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index 064f852..b6b7675 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -4,7 +4,7 @@ - + nvme-admin-passthru(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme check-dhchap-key [--key=<key> ]
+
+
+
+
+
+

DESCRIPTION

+
+

Checks if the key is a valid DH-HMAC-CHAP host key of the form: +DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: +and prints it to stdout.

+
+
+
+

OPTIONS

+
+
+
+-k <key> +
+
+--key=<key> +
+
+

+ Key to be checked. +

+
+
+
+
+
+

EXAMPLES

+
+

No Examples

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-check-dhchap-key.txt b/Documentation/nvme-check-dhchap-key.txt new file mode 100644 index 0000000..9cfa1f7 --- /dev/null +++ b/Documentation/nvme-check-dhchap-key.txt @@ -0,0 +1,31 @@ +nvme-check-dhchap-key(1) +======================== + +NAME +---- +nvme-check-dhchap-key - Check a generated host DH-HMAC-CHAP key + +SYNOPSIS +-------- +[verse] +'nvme check-dhchap-key' [--key= ] + +DESCRIPTION +----------- +Checks if the key is a valid DH-HMAC-CHAP host key of the form: +DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: +and prints it to stdout. + +OPTIONS +------- +-k :: +--key=:: + Key to be checked. + +EXAMPLES +-------- +No Examples + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-check-tls-key.txt b/Documentation/nvme-check-tls-key.txt new file mode 100644 index 0000000..9ef6679 --- /dev/null +++ b/Documentation/nvme-check-tls-key.txt @@ -0,0 +1,31 @@ +nvme-check-tls-key(1) +======================== + +NAME +---- +nvme-check-tls-key - Check a generated NVMe TLS PSK + +SYNOPSIS +-------- +[verse] +'nvme check-tls-key' [--key= ] + +DESCRIPTION +----------- +Checks if the key is a valid NVMe TLS PSK in the PSK interchange format +NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ: + + +OPTIONS +------- +-k :: +--key=:: + Key to be checked. + +EXAMPLES +-------- +No Examples + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-cmdset-ind-id-ns.1 b/Documentation/nvme-cmdset-ind-id-ns.1 index 95f110b..fa6ce8d 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.1 +++ b/Documentation/nvme-cmdset-ind-id-ns.1 @@ -2,12 +2,12 @@ .\" Title: nvme-cmdset-ind-id-ns .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CMDSET\-IND\-I" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-CMDSET\-IND\-I" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-cmdset-ind-id-ns.html b/Documentation/nvme-cmdset-ind-id-ns.html index 55c5bfc..b3e3ee2 100644 --- a/Documentation/nvme-cmdset-ind-id-ns.html +++ b/Documentation/nvme-cmdset-ind-id-ns.html @@ -1,9 +1,10 @@ + - + nvme-cmdset-ind-id-ns(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme dim
+                [--task=<task>     | -t <task>]
+                [--nqn=<nqn>       | -n <nqn>]
+                [--device=<device> | -d <device>]
+
+
+
+
+
+

DESCRIPTION

+
+

Send Discovery Information Management (DIM) command to one or more Discovery +Controllers. The DIM command allows performing two types of tasks: register or +deregister.

+

The DIM command is used to explicitly register with Discovery Controllers (DC), +especially with Central Discovery Controllers (CDC). CDCs maintain a database (DB) +of all the Hosts and Storage Susbsystems in a network. The register task is used +to add a host to the CDC’s DB. The deregister task is used to remove a host from +the CDC’s DB.

+

During a register operation the host will send mandatory information such as the +Host’s NQN and ID, as well as the Host’s hostname and the Operating System’s +version that it is running on. There is also an optional Host Symbolic Name +that can be registered with the CDC.

+

This command can only be applied to existing DC connections previously created +with the nvme-discover(1) command using the --persistent option.

+
+
+
+

OPTIONS

+
+
+
+-t <task> +
+
+--task <task> +
+
+

+ The task to perform: "register" or "deregister". +

+
+
+-n <subnqn> +
+
+--nqn <nqn> +
+
+

+ The DIM command will be sent to the Discovery Controller (DC) matching this + NQN. A list of comma-separated NQNs can be supplied to apply the command to + more than one DC. +

+
+
+-d <device> +
+
+--device <device> +
+
+

+ The DIM command will be sent to the Discovery Controllers (DC) associated + with this NVMe device handle. A list of comma-separated device handles can + be supplied to apply the command to more than one DC. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Register with the Central Discovery Controller (CDC) named +nqn.1988-11.com.dell:SFSS:1:20220118125153e8: +

    +
    +
    +
    # nvme dim --task=register --nqn=nqn.1988-11.com.dell:SFSS:1:20220118125153e8
    +
    +
    • +
  • +

    +Deregister from Central Discovery Controller (CDC) associated with nvme4 +

    +
    +
    +
    # nvme dim --task=deregister --device=nvme4
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-discover(1)

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-dim.txt b/Documentation/nvme-dim.txt new file mode 100644 index 0000000..805c7ff --- /dev/null +++ b/Documentation/nvme-dim.txt @@ -0,0 +1,75 @@ +nvme-dim(1) +=========== + +NAME +---- +nvme-dim - Send Discovery Information Management command to one or more Discovery Controllers. + +SYNOPSIS +-------- +[verse] +'nvme dim' + [--task= | -t ] + [--nqn= | -n ] + [--device= | -d ] + +DESCRIPTION +----------- +Send Discovery Information Management (DIM) command to one or more Discovery +Controllers. The DIM command allows performing two types of tasks: register or +deregister. + +The DIM command is used to explicitly register with Discovery Controllers (DC), +especially with Central Discovery Controllers (CDC). CDCs maintain a database (DB) +of all the Hosts and Storage Susbsystems in a network. The register task is used +to add a host to the CDC's DB. The deregister task is used to remove a host from +the CDC's DB. + +During a register operation the host will send mandatory information such as the +Host's NQN and ID, as well as the Host's hostname and the Operating System's +version that it is running on. There is also an optional Host Symbolic Name +that can be registered with the CDC. + +This command can only be applied to existing DC connections previously created +with the nvme-discover(1) command using the --persistent option. + +OPTIONS +------- +-t :: +--task :: + The task to perform: "register" or "deregister". + +-n :: +--nqn :: + The DIM command will be sent to the Discovery Controller (DC) matching this + NQN. A list of comma-separated NQNs can be supplied to apply the command to + more than one DC. + +-d :: +--device :: + The DIM command will be sent to the Discovery Controllers (DC) associated + with this NVMe device handle. A list of comma-separated device handles can + be supplied to apply the command to more than one DC. + +EXAMPLES +-------- +* Register with the Central Discovery Controller (CDC) named +nqn.1988-11.com.dell:SFSS:1:20220118125153e8: ++ +------------ +# nvme dim --task=register --nqn=nqn.1988-11.com.dell:SFSS:1:20220118125153e8 +------------ + +* Deregister from Central Discovery Controller (CDC) associated with nvme4 ++ +------------ +# nvme dim --task=deregister --device=nvme4 +------------ + +SEE ALSO +-------- +nvme-discover(1) + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-dir-receive.1 b/Documentation/nvme-dir-receive.1 index e6ce68c..b8a1af4 100644 --- a/Documentation/nvme-dir-receive.1 +++ b/Documentation/nvme-dir-receive.1 @@ -2,12 +2,12 @@ .\" Title: nvme-dir-receive .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-DIR\-RECEIVE" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-DIR\-RECEIVE" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-dir-receive.html b/Documentation/nvme-dir-receive.html index a84c72d..c978644 100644 --- a/Documentation/nvme-dir-receive.html +++ b/Documentation/nvme-dir-receive.html @@ -4,7 +4,7 @@ - + nvme-dir-receive(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme gen-dhchap-key [--hmac=<hmac-id> | -h <hmac-id>]
+                      [--secret=<secret> | -s <secret> ]
+                      [--key-length=<len> | -l <len> ]
+                      [--nqn=<host-nqn> | -n <host-nqn> ]
+
+
+
+
+
+

DESCRIPTION

+
+

Generate a base64-encoded DH-HMAC-CHAP host key in the form: +DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: +and prints it to stdout.

+
+
+
+

OPTIONS

+
+
+
+-h <hmac-id> +
+
+--hmac=<hmac-id> +
+
+

+ Select a HMAC algorithm to use. Possible values are: + 0 - No HMAC algorithm + 1 - SHA-256 + 2 - SHA-384 + 3 - SHA-512 +

+
+
+-s <secret> +
+
+--secret=<secret> +
+
+

+ Secret value (in hexadecimal) to be used for the key. If none are + provided a random value is used. +

+
+
+-l <len> +
+
+--key-length=<len> +
+
+

+ Length of the resulting key. Possible values are 32, 48, or 64. +

+
+
+-n <hostnqn> +
+
+--nqn=<hostnqn> +
+
+

+ Host-NQN to be used for the transformation. This parameter is only + valid if a non-zero HMAC function has been specified. +

+
+
+
+
+
+

EXAMPLES

+
+

No Examples

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-gen-dhchap-key.txt b/Documentation/nvme-gen-dhchap-key.txt new file mode 100644 index 0000000..79e8ed5 --- /dev/null +++ b/Documentation/nvme-gen-dhchap-key.txt @@ -0,0 +1,52 @@ +nvme-gen-dhchap-key(1) +====================== + +NAME +---- +nvme-gen-dhchap-key - Generate a host DH-HMAC-CHAP key + +SYNOPSIS +-------- +[verse] +'nvme gen-dhchap-key' [--hmac= | -h ] + [--secret= | -s ] + [--key-length= | -l ] + [--nqn= | -n ] + +DESCRIPTION +----------- +Generate a base64-encoded DH-HMAC-CHAP host key in the form: +DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: +and prints it to stdout. + +OPTIONS +------- +-h :: +--hmac=:: + Select a HMAC algorithm to use. Possible values are: + 0 - No HMAC algorithm + 1 - SHA-256 + 2 - SHA-384 + 3 - SHA-512 + +-s :: +--secret=:: + Secret value (in hexadecimal) to be used for the key. If none are + provided a random value is used. + +-l :: +--key-length=:: + Length of the resulting key. Possible values are 32, 48, or 64. + +-n :: +--nqn=:: + Host-NQN to be used for the transformation. This parameter is only + valid if a non-zero HMAC function has been specified. + +EXAMPLES +-------- +No Examples + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-gen-hostnqn.1 b/Documentation/nvme-gen-hostnqn.1 index 9aee601..79a586f 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-GEN\-HOSTNQN" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-GEN\-HOSTNQN" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-gen-hostnqn.html b/Documentation/nvme-gen-hostnqn.html index 2b43185..1e06595 100644 --- a/Documentation/nvme-gen-hostnqn.html +++ b/Documentation/nvme-gen-hostnqn.html @@ -4,7 +4,7 @@ - + nvme-gen-hostnqn(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme id-ns <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
+                    [--lba-format-index=<lba_format_index> | -i <lba_format_index>]
+                        [-v | --verbose]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends an identify namespace for +the specified LBA Format index command and provides the result +that is include capability field only and returned structure.

+

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

+

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

+
+
+
+

OPTIONS

+
+
+
+-U <uuid-index> +
+
+--uuid-index=<uuid-index> +
+
+

+ UUID Index of the feature +

+
+
+-i <lba_format_index> +
+
+--lba-format-index=<lba_format_index> +
+
+

+ This field specifies the index into the LBA Format list identifying + the LBA Format capabilities that are to be returned +

+
+
+-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 id-ns-lba-format /dev/nvme0n1 -i 0
    +
    +
    • +
  • +

    +Have the program return the raw structure in binary: +

    +
    +
    +
    # nvme id-ns-lba-format /dev/nvme0n1 -i 0 -o binary > id_ns.raw
+# nvme id-ns-lba-format /dev/nvme0n1 -i 0 --output-format=binary > id_ns.raw
    +
    +

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

    +
    • +
  • +

    +Alternatively you may want to send the data to another program that +can parse the raw buffer. +

    +
    +
    +
    # nvme id-ns-lba-format /dev/nvme0n1 -i 0 --raw-binary | nvme_parse_id_ns
    +
    +

    The parse program in the above example can be a program that shows the +structure in a way you like. The following program is such an example +that will parse it and can accept the output through a pipe, '|', +as shown in the above example, or you can 'cat' a saved output buffer +to it.

    +
    • +
+
+
+
/* File: nvme_parse_id_ns_lba_format.c */
+
+#include <linux/nvme.h>
+#include <stdio.h>
+#include <unistd.h>
+
+int main(int argc, char **argv)
+{
+        unsigned char buf[sizeof(struct nvme_id_ns)];
+        struct nvme_id_ns *ns = (struct nvme_id_ns *)buf;
+
+        if (read(STDIN_FILENO, buf, sizeof(buf)))
+                return 1;
+
+        printf("nsze : %#llx\n", ns->nlbaf);
+        printf("ncap : %#llx\n", ns->mc);
+        return 0;
+}
+
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-id-ns-lba-format.txt b/Documentation/nvme-id-ns-lba-format.txt new file mode 100644 index 0000000..32df2f6 --- /dev/null +++ b/Documentation/nvme-id-ns-lba-format.txt @@ -0,0 +1,102 @@ +nvme-id-ns-lba-format(1) +======================== + +NAME +---- +nvme-id-ns-lba-format - Send NVMe Identify Namespace for the specified LBA Format index, display structure + +SYNOPSIS +-------- +[verse] +'nvme id-ns' [--uuid-index= | -U ] + [--lba-format-index= | -i ] + [-v | --verbose] + [--output-format= | -o ] + +DESCRIPTION +----------- +For the NVMe device given, sends an identify namespace for +the specified LBA Format index command and provides the result +that is include capability field only and returned structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout. + +OPTIONS +------- +-U :: +--uuid-index=:: + UUID Index of the feature + +-i :: +--lba-format-index=:: + This field specifies the index into the LBA Format list identifying + the LBA Format capabilities that are to be returned + +-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 id-ns-lba-format /dev/nvme0n1 -i 0 +------------ ++ +* Have the program return the raw structure in binary: ++ +------------ +# nvme id-ns-lba-format /dev/nvme0n1 -i 0 -o binary > id_ns.raw +# nvme id-ns-lba-format /dev/nvme0n1 -i 0 --output-format=binary > id_ns.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +* Alternatively you may want to send the data to another program that +can parse the raw buffer. ++ +------------ +# nvme id-ns-lba-format /dev/nvme0n1 -i 0 --raw-binary | nvme_parse_id_ns +------------ ++ +The parse program in the above example can be a program that shows the +structure in a way you like. The following program is such an example +that will parse it and can accept the output through a pipe, `'|'`, +as shown in the above example, or you can `'cat'` a saved output buffer +to it. +------------ +/* File: nvme_parse_id_ns_lba_format.c */ + +#include +#include +#include + +int main(int argc, char **argv) +{ + unsigned char buf[sizeof(struct nvme_id_ns)]; + struct nvme_id_ns *ns = (struct nvme_id_ns *)buf; + + if (read(STDIN_FILENO, buf, sizeof(buf))) + return 1; + + printf("nsze : %#llx\n", ns->nlbaf); + printf("ncap : %#llx\n", ns->mc); + return 0; +} +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-id-ns.1 b/Documentation/nvme-id-ns.1 index 3104be3..97e8962 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,7 +33,7 @@ nvme-id-ns \- Send NVMe Identify Namespace, return result and structure .sp .nf \fInvme id\-ns\fR [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary] - [\-\-namespace\-id= | \-n ] [\-f | \-\-force] + [\-\-namespace\-id= | \-n ] [\-\-force] [\-\-human\-readable | \-H] [\-\-output\-format= | \-o ] .fi @@ -51,7 +51,7 @@ On success, the structure may be returned in one of several ways depending on th Retrieve the identify namespace structure for the given nsid\&. This is required for the character devices, or overrides the block nsid if given\&. .RE .PP -\-f, \-\-force +\-\-force .RS 4 Request controller return the identify namespace structure even if the namespace is not attached to the controller\&. This is valid only for controllers at or newer than revision 1\&.2\&. Controllers at revision lower than this may interpret the command incorrectly\&. .RE diff --git a/Documentation/nvme-id-ns.html b/Documentation/nvme-id-ns.html index 8213e5e..55ce45a 100644 --- a/Documentation/nvme-id-ns.html +++ b/Documentation/nvme-id-ns.html @@ -4,7 +4,7 @@ - + nvme-id-ns(1) - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-create [--device-name=<DEVICE> | -d <DEVICE>]
-                        [--target-name=<TARGET> | -n <TARGET>]
-                        [--target-type=<TARGETTYPE> | -t <TARGETTYPE>]
-                        [--lun-begin <NUM> | -b <NUM>]
-                        [--lun-end <NUM> | -e <NUM>]
-
-
-
-
-
-

DESCRIPTION

-
-

Instantiate a target on top of a LightNVM enabled device. This exposes the -physical for the user to use.

-

The target name is the name of which the media is exposed as in -/dev/<targetname>

-

The target type is the target to be instantiated. Typically pblk or rrpc.

-

LUN begin and end defines the range of LUNs to use for a target instantiation.

-
-
-
-

OPTIONS

-
-
-
---device-name=<DEVICE> -
-
--d <DEVICE> -
-
-

- Device name to initialize. -

-
-
---target-name=<TARGET> -
-
--n <TARGET> -
-
-

- Target name of the device to initialize. For example: target0. -

-
-
---target-type=<TARGETTYPE> -
-
--t <TARGETTYPE> -
-
-

- Target type of the device to use. For example: pblk -

-
-
---lun-begin <NUM> -
-
--b <NUM> -
-
-

- Begin LUN id offset to use for target -

-
-
---lun-end <NUM> -
-
--e <NUM> -
-
-

- End LUN id offset to use for target -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Initialize nvme0n1 with pblk target with 64 LUNs. -

    -
    • -
-
-
-
# nvme lnvm-create -d nvme0n1 -t pblk -n target0 -b 0 -e 63
-
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-create.txt b/Documentation/nvme-lnvm-create.txt deleted file mode 100644 index 3c9109d..0000000 --- a/Documentation/nvme-lnvm-create.txt +++ /dev/null @@ -1,60 +0,0 @@ -nvme-lnvm-create(1) -=================== - -NAME ----- -nvme-lnvm-create - Instantiate a target on top of a LightNVM enabled device - -SYNOPSIS --------- -[verse] -'nvme lnvm-create' [--device-name= | -d ] - [--target-name= | -n ] - [--target-type= | -t ] - [--lun-begin | -b ] - [--lun-end | -e ] - -DESCRIPTION ------------ -Instantiate a target on top of a LightNVM enabled device. This exposes the -physical for the user to use. - -The target name is the name of which the media is exposed as in -/dev/ - -The target type is the target to be instantiated. Typically pblk or rrpc. - -LUN begin and end defines the range of LUNs to use for a target instantiation. - -OPTIONS -------- ---device-name=:: --d :: - Device name to initialize. - ---target-name=:: --n :: - Target name of the device to initialize. For example: target0. - ---target-type=:: --t :: - Target type of the device to use. For example: pblk - ---lun-begin :: --b :: - Begin LUN id offset to use for target - ---lun-end :: --e :: - End LUN id offset to use for target - -EXAMPLES --------- -* Initialize nvme0n1 with pblk target with 64 LUNs. ------------- -# nvme lnvm-create -d nvme0n1 -t pblk -n target0 -b 0 -e 63 ------------- - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-diag-bbtbl.1 b/Documentation/nvme-lnvm-diag-bbtbl.1 deleted file mode 100644 index 4afe42f..0000000 --- a/Documentation/nvme-lnvm-diag-bbtbl.1 +++ /dev/null @@ -1,117 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-diag-bbtbl -.\" 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\-LNVM\-DIAG\-BB" "1" "11/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-lnvm-diag-bbtbl \- Diagnose the bad block table -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-diag\-bbtbl\fR [\-\-namespace\-id= | \-n ] - [\-\-channel\-id= | \-c ] - [\-\-lun\-id= | \-l ] - [\-\-raw\-binary | \-b] -.fi -.SH "DESCRIPTION" -.sp -Retrieve the bad block table for a given channel and lun\&. -.sp -The statistics will be shown in the default case, and the actual output bad block information can be retrieved when \-\-raw\-binary is passed\&. -.sp -The raw binary output follows this format: -.sp -Channel 0, LUN0 (Dual plane flash) -.sp -Byte 0 \(-> Plane 0, Block 0 Byte 1 \(-> Plane 1, Block 0 Byte 2 \(-> Plane 0, Block 1 \&... -.SH "OPTIONS" -.PP -\-\-namespace\-id=, \-n -.RS 4 -Namespace id to use -.RE -.PP -\-\-channel\-id=, \-c -.RS 4 -Channel id -.RE -.PP -\-\-lun\-id=, \-l -.RS 4 -LUN id -.RE -.PP -\-\-raw\-binary, \-b -.RS 4 -Returns the bad block table in binary form without statistics\&. -.RE -.SH "EXAMPLES" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Retrieve bad block table statistics for physical device nvme0, channel 0, and lun 0: -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-diag\-bbtbl /dev/nvme0 \-c 0 \-n 0 -.fi -.if n \{\ -.RE -.\} -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Display the bad block table in raw form without statistics for same query: -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-diag\-bbtbl /dev/nvme0 \-c 0 \-n 0 \-b | hexdump -.fi -.if n \{\ -.RE -.\} -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-diag-bbtbl.html b/Documentation/nvme-lnvm-diag-bbtbl.html deleted file mode 100644 index be2f05a..0000000 --- a/Documentation/nvme-lnvm-diag-bbtbl.html +++ /dev/null @@ -1,868 +0,0 @@ - - - - - - -nvme-lnvm-diag-bbtbl(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-diag-bbtbl [--namespace-id=<NUM> | -n <NUM>]
-                        [--channel-id=<CHID> | -c <CHID>]
-                        [--lun-id=<LUNID> | -l <LUNID>]
-                        [--raw-binary | -b]
-
-
-
-
-
-

DESCRIPTION

-
-

Retrieve the bad block table for a given channel and lun.

-

The statistics will be shown in the default case, and the actual output bad -block information can be retrieved when --raw-binary is passed.

-

The raw binary output follows this format:

-

Channel 0, LUN0 (Dual plane flash)

-

Byte 0 → Plane 0, Block 0 -Byte 1 → Plane 1, Block 0 -Byte 2 → Plane 0, Block 1 -…

-
-
-
-

OPTIONS

-
-
-
---namespace-id=<NUM> -
-
--n <NUM> -
-
-

- Namespace id to use -

-
-
---channel-id=<NUM> -
-
--c -
-
-

- Channel id -

-
-
---lun-id=<NUM> -
-
--l -
-
-

- LUN id -

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

- Returns the bad block table in binary form without statistics. -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Retrieve bad block table statistics for physical device nvme0, channel 0, and -lun 0: -

    -
    • -
-
-
-
# nvme lnvm-diag-bbtbl /dev/nvme0 -c 0 -n 0
-
-
    -
  • -

    -Display the bad block table in raw form without statistics for same query: -

    -
    • -
-
-
-
# nvme lnvm-diag-bbtbl /dev/nvme0 -c 0 -n 0 -b | hexdump
-
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-diag-bbtbl.txt b/Documentation/nvme-lnvm-diag-bbtbl.txt deleted file mode 100644 index 7324807..0000000 --- a/Documentation/nvme-lnvm-diag-bbtbl.txt +++ /dev/null @@ -1,65 +0,0 @@ -nvme-lnvm-diag-bbtbl(1) -======================= - -NAME ----- -nvme-lnvm-diag-bbtbl - Diagnose the bad block table - -SYNOPSIS --------- -[verse] -'nvme lnvm-diag-bbtbl' [--namespace-id= | -n ] - [--channel-id= | -c ] - [--lun-id= | -l ] - [--raw-binary | -b] - -DESCRIPTION ------------ -Retrieve the bad block table for a given channel and lun. - -The statistics will be shown in the default case, and the actual output bad -block information can be retrieved when --raw-binary is passed. - -The raw binary output follows this format: - -Channel 0, LUN0 (Dual plane flash) - -Byte 0 -> Plane 0, Block 0 -Byte 1 -> Plane 1, Block 0 -Byte 2 -> Plane 0, Block 1 -... - -OPTIONS -------- ---namespace-id=:: --n :: - Namespace id to use - ---channel-id=:: --c:: - Channel id - ---lun-id=:: --l:: - LUN id - ---raw-binary:: --b:: - Returns the bad block table in binary form without statistics. - -EXAMPLES --------- -* Retrieve bad block table statistics for physical device nvme0, channel 0, and -lun 0: ------------- -# nvme lnvm-diag-bbtbl /dev/nvme0 -c 0 -n 0 ------------- - -* Display the bad block table in raw form without statistics for same query: ------------- -# nvme lnvm-diag-bbtbl /dev/nvme0 -c 0 -n 0 -b | hexdump ------------- - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.1 b/Documentation/nvme-lnvm-diag-set-bbtbl.1 deleted file mode 100644 index d46ee65..0000000 --- a/Documentation/nvme-lnvm-diag-set-bbtbl.1 +++ /dev/null @@ -1,99 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-diag-set-bbtbl -.\" 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\-LNVM\-DIAG\-SE" "1" "11/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-lnvm-diag-set-bbtbl \- Set a block state in the bad block table -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-diag\-set\-bbtbl\fR [\-\-namespace\-id= | \-n ] - [\-\-channel\-id= | \-c ] - [\-\-lun\-id= | \-l ] - [\-\-plane\-id= | \-p ] - [\-\-block\-id= | \-b ] - [\-\-value= | \-v ] -.fi -.SH "DESCRIPTION" -.sp -Set the bad block table for a given channel, lun, plane and block with value v\&. -.sp -For each block available, the status byte is read as follows: -.sp -0: Good block 1: Bad block 2: Grown bad block 4: Device reserved block 8: Host\-side reserved block 16: Media managed reserved block -.SH "OPTIONS" -.PP -\-\-namespace\-id=, \-n -.RS 4 -Namespace id to use -.RE -.PP -\-\-channel\-id, \-c -.RS 4 -Channel id -.RE -.PP -\-\-lun\-id, \-l -.RS 4 -LUN id -.RE -.PP -\-\-plane\-id, \-p -.RS 4 -Plane id -.RE -.PP -\-\-block\-id, \-b -.RS 4 -Block id -.RE -.SH "EXAMPLES" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad) on physical device /dev/nvme0 -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-diag\-set\-bbtbl /dev/nvme0 \-c 0 \-l 0 \-p 0 \-b 10 \-v 2 -.fi -.if n \{\ -.RE -.\} -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.html b/Documentation/nvme-lnvm-diag-set-bbtbl.html deleted file mode 100644 index b8e5943..0000000 --- a/Documentation/nvme-lnvm-diag-set-bbtbl.html +++ /dev/null @@ -1,869 +0,0 @@ - - - - - - -nvme-lnvm-diag-set-bbtbl(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-diag-set-bbtbl [--namespace-id=<NUM> | -n <NUM>]
-                        [--channel-id=<CHID> | -c <CHID>]
-                        [--lun-id=<LUNID> | -l <LUNID>]
-                        [--plane-id=<PLANEID> | -p <PLANEID>]
-                        [--block-id=<BLKID> | -b <BLKID>]
-                        [--value=<NUM> | -v <NUM>]
-
-
-
-
-
-

DESCRIPTION

-
-

Set the bad block table for a given channel, lun, plane and block with value v.

-

For each block available, the status byte is read as follows:

-

0: Good block -1: Bad block -2: Grown bad block -4: Device reserved block -8: Host-side reserved block -16: Media managed reserved block

-
-
-
-

OPTIONS

-
-
-
---namespace-id=<NUM> -
-
--n <NUM> -
-
-

- Namespace id to use -

-
-
---channel-id -
-
--c -
-
-

- Channel id -

-
-
---lun-id -
-
--l -
-
-

- LUN id -

-
-
---plane-id -
-
--p -
-
-

- Plane id -

-
-
---block-id -
-
--b -
-
-

- Block id -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad) - on physical device /dev/nvme0 -

    -
    • -
-
-
-
# nvme lnvm-diag-set-bbtbl /dev/nvme0 -c 0 -l 0 -p 0 -b 10 -v 2
-
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-diag-set-bbtbl.txt b/Documentation/nvme-lnvm-diag-set-bbtbl.txt deleted file mode 100644 index f5dd004..0000000 --- a/Documentation/nvme-lnvm-diag-set-bbtbl.txt +++ /dev/null @@ -1,63 +0,0 @@ -nvme-lnvm-diag-set-bbtbl(1) -=========================== - -NAME ----- -nvme-lnvm-diag-set-bbtbl - Set a block state in the bad block table - -SYNOPSIS --------- -[verse] -'nvme lnvm-diag-set-bbtbl' [--namespace-id= | -n ] - [--channel-id= | -c ] - [--lun-id= | -l ] - [--plane-id= | -p ] - [--block-id= | -b ] - [--value= | -v ] - -DESCRIPTION ------------ -Set the bad block table for a given channel, lun, plane and block with value v. - -For each block available, the status byte is read as follows: - -0: Good block -1: Bad block -2: Grown bad block -4: Device reserved block -8: Host-side reserved block -16: Media managed reserved block - -OPTIONS -------- ---namespace-id=:: --n :: - Namespace id to use - ---channel-id:: --c:: - Channel id - ---lun-id:: --l:: - LUN id - ---plane-id:: --p:: - Plane id - ---block-id:: --b:: - Block id - -EXAMPLES --------- -* Set channel 0, lun 0, plane 0, block 10 to bad block value 2 (grown bad) - on physical device /dev/nvme0 ------------- -# nvme lnvm-diag-set-bbtbl /dev/nvme0 -c 0 -l 0 -p 0 -b 10 -v 2 ------------- - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-factory.1 b/Documentation/nvme-lnvm-factory.1 deleted file mode 100644 index c95396c..0000000 --- a/Documentation/nvme-lnvm-factory.1 +++ /dev/null @@ -1,109 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-factory -.\" 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\-LNVM\-FACTORY" "1" "11/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-lnvm-factory \- Factory reset a LightNVM device -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-factory\fR [\-\-device\-name= | \-d ] - [\-\-erase\-only\-marked | \-e] - [\-\-clear\-host\-side\-blks | \-s] - [\-\-clear\-bb\-blks | \-b] -.fi -.SH "DESCRIPTION" -.sp -Instantiate a target on top of a LightNVM enabled device\&. This exposes the physical for the user to use\&. -.SH "OPTIONS" -.PP -\-\-device\-name=, \-d -.RS 4 -Device name to factory initialize -.RE -.PP -\-\-erase\-only\-marked, \-e -.RS 4 -Erases only blocks that are marked in the bad block list -.RE -.PP -\-\-clear\-host\-side\-blks, \-s -.RS 4 -Remove host\-side bad block marks\&. This clear the media manager registration -.RE -.PP -\-\-clear\-bb\-blks, \-b -.RS 4 -Removes the grown bad block marks\&. Allowing them to be rediscovered\&. -.RE -.SH "EXAMPLES" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Factory reset of device nvme0n1 -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-factory \-d nvme0n1 -.fi -.if n \{\ -.RE -.\} -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Complete factory reset of device nvme0n1 -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-factory \-d nvme0n1 \-s \-b -.fi -.if n \{\ -.RE -.\} -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-factory.html b/Documentation/nvme-lnvm-factory.html deleted file mode 100644 index 44a3b1c..0000000 --- a/Documentation/nvme-lnvm-factory.html +++ /dev/null @@ -1,861 +0,0 @@ - - - - - - -nvme-lnvm-factory(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-factory [--device-name=<DEVICE> | -d <DEVICE>]
-                        [--erase-only-marked | -e]
-                        [--clear-host-side-blks | -s]
-                        [--clear-bb-blks | -b]
-
-
-
-
-
-

DESCRIPTION

-
-

Instantiate a target on top of a LightNVM enabled device. This exposes the -physical for the user to use.

-
-
-
-

OPTIONS

-
-
-
---device-name=<DEVICE> -
-
--d <DEVICE> -
-
-

- Device name to factory initialize -

-
-
---erase-only-marked -
-
--e -
-
-

- Erases only blocks that are marked in the bad block list -

-
-
---clear-host-side-blks -
-
--s -
-
-

- Remove host-side bad block marks. This clear the media manager - registration -

-
-
---clear-bb-blks -
-
--b -
-
-

- Removes the grown bad block marks. Allowing them to be rediscovered. -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Factory reset of device nvme0n1 -

    -
    • -
-
-
-
# nvme lnvm-factory -d nvme0n1
-
-
    -
  • -

    -Complete factory reset of device nvme0n1 -

    -
    • -
-
-
-
# nvme lnvm-factory -d nvme0n1 -s -b
-
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-factory.txt b/Documentation/nvme-lnvm-factory.txt deleted file mode 100644 index baa7a69..0000000 --- a/Documentation/nvme-lnvm-factory.txt +++ /dev/null @@ -1,54 +0,0 @@ -nvme-lnvm-factory(1) -==================== - -NAME ----- -nvme-lnvm-factory - Factory reset a LightNVM device - -SYNOPSIS --------- -[verse] -'nvme lnvm-factory' [--device-name= | -d ] - [--erase-only-marked | -e] - [--clear-host-side-blks | -s] - [--clear-bb-blks | -b] - -DESCRIPTION ------------ -Instantiate a target on top of a LightNVM enabled device. This exposes the -physical for the user to use. - -OPTIONS -------- ---device-name=:: --d :: - Device name to factory initialize - ---erase-only-marked:: --e:: - Erases only blocks that are marked in the bad block list - ---clear-host-side-blks:: --s:: - Remove host-side bad block marks. This clear the media manager - registration - ---clear-bb-blks:: --b:: - Removes the grown bad block marks. Allowing them to be rediscovered. - -EXAMPLES --------- -* Factory reset of device nvme0n1 ------------- -# nvme lnvm-factory -d nvme0n1 ------------- - -* Complete factory reset of device nvme0n1 ------------- -# nvme lnvm-factory -d nvme0n1 -s -b ------------- - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-id-ns.1 b/Documentation/nvme-lnvm-id-ns.1 deleted file mode 100644 index 32e7029..0000000 --- a/Documentation/nvme-lnvm-id-ns.1 +++ /dev/null @@ -1,88 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-id-ns -.\" 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\-LNVM\-ID\-NS" "1" "11/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-lnvm-id-ns \- Identify Geometry for LightNVM NVMe device -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-id\-ns\fR [\-\-namespace\-id= | \-n ] - [\-\-force | \-f] - [\-\-raw\-binary | \-b] - [\-\-human\-readable | \-H] -.fi -.SH "DESCRIPTION" -.sp -Send an Identify Geometry command to the given LightNVM device, returns properties of the specified namespace in either human\-readable or binary format\&. -.SH "OPTIONS" -.PP -\-\-namespace\-id=, \-n -.RS 4 -Retrieve the geometry from the selected namespace\&. -.RE -.PP -\-\-force, \-f -.RS 4 -Try to read the data and assume it is a LightNVM device -.RE -.PP -\-\-raw\-binary, \-b -.RS 4 -Output the raw output -.RE -.PP -\-\-human\-readable, \-H -.RS 4 -Output the status in human readable format -.RE -.SH "EXAMPLES" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Retrieve the geometry from nvme0 -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-id\-ns /dev/nvme0 \-n 1 -.fi -.if n \{\ -.RE -.\} -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-id-ns.html b/Documentation/nvme-lnvm-id-ns.html deleted file mode 100644 index b8898b6..0000000 --- a/Documentation/nvme-lnvm-id-ns.html +++ /dev/null @@ -1,850 +0,0 @@ - - - - - - -nvme-lnvm-id-ns(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-id-ns <device> [--namespace-id=<nsid> | -n <nsid>]
-                        [--force | -f]
-                        [--raw-binary | -b]
-                        [--human-readable | -H]
-
-
-
-
-
-

DESCRIPTION

-
-

Send an Identify Geometry command to the given LightNVM device, returns -properties of the specified namespace in either human-readable or binary -format.

-
-
-
-

OPTIONS

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

- Retrieve the geometry from the selected namespace. -

-
-
---force -
-
--f -
-
-

- Try to read the data and assume it is a LightNVM device -

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

- Output the raw output -

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

- Output the status in human readable format -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Retrieve the geometry from nvme0 -

    -
    • -
-
-
-
# nvme lnvm-id-ns /dev/nvme0 -n 1
-
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-id-ns.txt b/Documentation/nvme-lnvm-id-ns.txt deleted file mode 100644 index 1a3565f..0000000 --- a/Documentation/nvme-lnvm-id-ns.txt +++ /dev/null @@ -1,49 +0,0 @@ -nvme-lnvm-id-ns(1) -================== - -NAME ----- -nvme-lnvm-id-ns - Identify Geometry for LightNVM NVMe device - -SYNOPSIS --------- -[verse] -'nvme lnvm-id-ns' [--namespace-id= | -n ] - [--force | -f] - [--raw-binary | -b] - [--human-readable | -H] - -DESCRIPTION ------------ -Send an Identify Geometry command to the given LightNVM device, returns -properties of the specified namespace in either human-readable or binary -format. - -OPTIONS -------- ---namespace-id=:: --n :: - Retrieve the geometry from the selected namespace. - ---force:: --f:: - Try to read the data and assume it is a LightNVM device - ---raw-binary:: --b:: - Output the raw output - ---human-readable:: --H:: - Output the status in human readable format - -EXAMPLES --------- -* Retrieve the geometry from nvme0 ------------- -# nvme lnvm-id-ns /dev/nvme0 -n 1 ------------- - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-info.1 b/Documentation/nvme-lnvm-info.1 deleted file mode 100644 index 80a0288..0000000 --- a/Documentation/nvme-lnvm-info.1 +++ /dev/null @@ -1,48 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-info -.\" 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\-LNVM\-INFO" "1" "11/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-lnvm-info \- Show general information and registered target types with LightNVM -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-info\fR -.fi -.SH "DESCRIPTION" -.sp -Show general information and registered target types with LightNVM\&. -.SH "OPTIONS" -.sp -No options yet\&. -.SH "EXAMPLES" -.sp -No examples yet\&. -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-info.html b/Documentation/nvme-lnvm-info.html deleted file mode 100644 index 1cee911..0000000 --- a/Documentation/nvme-lnvm-info.html +++ /dev/null @@ -1,790 +0,0 @@ - - - - - - -nvme-lnvm-info(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-info
-
-
-
-
-
-

DESCRIPTION

-
-

Show general information and registered target types with LightNVM.

-
-
-
-

OPTIONS

-
-

No options yet.

-
-
-
-

EXAMPLES

-
-

No examples yet.

-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-info.txt b/Documentation/nvme-lnvm-info.txt deleted file mode 100644 index e755c9c..0000000 --- a/Documentation/nvme-lnvm-info.txt +++ /dev/null @@ -1,27 +0,0 @@ -nvme-lnvm-info(1) -================= - -NAME ----- -nvme-lnvm-info - Show general information and registered target types with LightNVM - -SYNOPSIS --------- -[verse] -'nvme lnvm-info' - -DESCRIPTION ------------ -Show general information and registered target types with LightNVM. - -OPTIONS -------- -No options yet. - -EXAMPLES --------- -No examples yet. - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-init.1 b/Documentation/nvme-lnvm-init.1 deleted file mode 100644 index a6eff88..0000000 --- a/Documentation/nvme-lnvm-init.1 +++ /dev/null @@ -1,97 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-init -.\" 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\-LNVM\-INIT" "1" "11/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-lnvm-init \- Initialize LightNVM device with media manager -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-init\fR [\-\-device\-name= | \-d ] - [\-\-mediamgr\-name | \-m] -.fi -.SH "DESCRIPTION" -.sp -Initialize LightNVM device\&. A LightNVM/Open\-Channel SSD must have a media manager associated before it can be exposed to the user\&. The default is to initialize the general media manager on top of the device\&. -.SH "OPTIONS" -.PP -\-\-device\-name=, \-d -.RS 4 -Device name to initialize\&. -.RE -.PP -\-\-mediamgr\-name=, \-m -.RS 4 -Media Manager name to use for initialization\&. -.RE -.SH "EXAMPLES" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Initialize nvme0n1 -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-init \-d nvme0n1 -.fi -.if n \{\ -.RE -.\} -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Initialize nvme0n1 with gennvm media manager (default media manager) -.RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -# nvme lnvm\-init \-d nvme0n1 \-m gennvm -.fi -.if n \{\ -.RE -.\} -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-init.html b/Documentation/nvme-lnvm-init.html deleted file mode 100644 index d1bee83..0000000 --- a/Documentation/nvme-lnvm-init.html +++ /dev/null @@ -1,837 +0,0 @@ - - - - - - -nvme-lnvm-init(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-init [--device-name=<DEVICE> | -d <DEVICE>]
-                        [--mediamgr-name | -m]
-
-
-
-
-
-

DESCRIPTION

-
-

Initialize LightNVM device. A LightNVM/Open-Channel SSD must have a media -manager associated before it can be exposed to the user. The default is to -initialize the general media manager on top of the device.

-
-
-
-

OPTIONS

-
-
-
---device-name=<DEVICE> -
-
--d <DEVICE> -
-
-

- Device name to initialize. -

-
-
---mediamgr-name=<MediaMgr> -
-
--m <MediaMgr> -
-
-

- Media Manager name to use for initialization. -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -

    -Initialize nvme0n1 -

    -
    • -
-
-
-
# nvme lnvm-init -d nvme0n1
-
-
    -
  • -

    -Initialize nvme0n1 with gennvm media manager (default media manager) -

    -
    • -
-
-
-
# nvme lnvm-init -d nvme0n1 -m gennvm
-
-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-init.txt b/Documentation/nvme-lnvm-init.txt deleted file mode 100644 index 0d922a9..0000000 --- a/Documentation/nvme-lnvm-init.txt +++ /dev/null @@ -1,44 +0,0 @@ -nvme-lnvm-init(1) -================= - -NAME ----- -nvme-lnvm-init - Initialize LightNVM device with media manager - -SYNOPSIS --------- -[verse] -'nvme lnvm-init' [--device-name= | -d ] - [--mediamgr-name | -m] - -DESCRIPTION ------------ -Initialize LightNVM device. A LightNVM/Open-Channel SSD must have a media -manager associated before it can be exposed to the user. The default is to -initialize the general media manager on top of the device. - -OPTIONS -------- ---device-name=:: --d :: - Device name to initialize. - ---mediamgr-name=:: --m :: - Media Manager name to use for initialization. - -EXAMPLES --------- -* Initialize nvme0n1 ------------- -# nvme lnvm-init -d nvme0n1 ------------- - -* Initialize nvme0n1 with gennvm media manager (default media manager) ------------- -# nvme lnvm-init -d nvme0n1 -m gennvm ------------- - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-list.1 b/Documentation/nvme-lnvm-list.1 deleted file mode 100644 index 33eaa44..0000000 --- a/Documentation/nvme-lnvm-list.1 +++ /dev/null @@ -1,48 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-list -.\" 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\-LNVM\-LIST" "1" "11/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-lnvm-list \- List all recognized LightNVM NVMe devices -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-list\fR -.fi -.SH "DESCRIPTION" -.sp -List all registered LightNVM devices\&. -.SH "OPTIONS" -.sp -No options yet\&. -.SH "EXAMPLES" -.sp -No examples yet\&. -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-list.html b/Documentation/nvme-lnvm-list.html deleted file mode 100644 index 3126af7..0000000 --- a/Documentation/nvme-lnvm-list.html +++ /dev/null @@ -1,790 +0,0 @@ - - - - - - -nvme-lnvm-list(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-list
-
-
-
-
-
-

DESCRIPTION

-
-

List all registered LightNVM devices.

-
-
-
-

OPTIONS

-
-

No options yet.

-
-
-
-

EXAMPLES

-
-

No examples yet.

-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-list.txt b/Documentation/nvme-lnvm-list.txt deleted file mode 100644 index 959f6b9..0000000 --- a/Documentation/nvme-lnvm-list.txt +++ /dev/null @@ -1,27 +0,0 @@ -nvme-lnvm-list(1) -================= - -NAME ----- -nvme-lnvm-list - List all recognized LightNVM NVMe devices - -SYNOPSIS --------- -[verse] -'nvme lnvm-list' - -DESCRIPTION ------------ -List all registered LightNVM devices. - -OPTIONS -------- -No options yet. - -EXAMPLES --------- -No examples yet. - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lnvm-remove.1 b/Documentation/nvme-lnvm-remove.1 deleted file mode 100644 index 8b6bb76..0000000 --- a/Documentation/nvme-lnvm-remove.1 +++ /dev/null @@ -1,53 +0,0 @@ -'\" t -.\" Title: nvme-lnvm-remove -.\" 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\-LNVM\-REMOVE" "1" "11/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-lnvm-remove \- Remove an initialized LightNVM target\&. -.SH "SYNOPSIS" -.sp -.nf -\fInvme lnvm\-remove\fR [\-\-target\-name= | \-n ] -.fi -.SH "DESCRIPTION" -.sp -Remove an initialized target\&. -.sp -The target name is the name of which the media is exposed as in /dev/ -.SH "OPTIONS" -.PP -\-\-target\-name=, \-n -.RS 4 -Target name of the device to initialize\&. For example: target0\&. -.RE -.SH "EXAMPLES" -.sp -None yet -.SH "NVME" -.sp -Part of the nvme\-user suite diff --git a/Documentation/nvme-lnvm-remove.html b/Documentation/nvme-lnvm-remove.html deleted file mode 100644 index ac8530e..0000000 --- a/Documentation/nvme-lnvm-remove.html +++ /dev/null @@ -1,804 +0,0 @@ - - - - - - -nvme-lnvm-remove(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme lnvm-remove [--target-name=<TARGET> | -n <TARGET>]
-
-
-
-
-
-

DESCRIPTION

-
-

Remove an initialized target.

-

The target name is the name of which the media is exposed as in -/dev/<TARGET>

-
-
-
-

OPTIONS

-
-
-
---target-name=<TARGET> -
-
--n <TARGET> -
-
-

- Target name of the device to initialize. For example: target0. -

-
-
-
-
-
-

EXAMPLES

-
-

None yet

-
-
-
-

NVME

-
-

Part of the nvme-user suite

-
-
-
-
- - - diff --git a/Documentation/nvme-lnvm-remove.txt b/Documentation/nvme-lnvm-remove.txt deleted file mode 100644 index f5cdd6e..0000000 --- a/Documentation/nvme-lnvm-remove.txt +++ /dev/null @@ -1,32 +0,0 @@ -nvme-lnvm-remove(1) -=================== - -NAME ----- -nvme-lnvm-remove - Remove an initialized LightNVM target. - -SYNOPSIS --------- -[verse] -'nvme lnvm-remove' [--target-name= | -n ] - -DESCRIPTION ------------ -Remove an initialized target. - -The target name is the name of which the media is exposed as in -/dev/ - -OPTIONS -------- ---target-name=:: --n :: - Target name of the device to initialize. For example: target0. - -EXAMPLES --------- -None yet - -NVME ----- -Part of the nvme-user suite diff --git a/Documentation/nvme-lockdown.1 b/Documentation/nvme-lockdown.1 index dcf7c22..79754d0 100644 --- a/Documentation/nvme-lockdown.1 +++ b/Documentation/nvme-lockdown.1 @@ -2,12 +2,12 @@ .\" Title: nvme-lockdown .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-LOCKDOWN" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-LOCKDOWN" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-lockdown.html b/Documentation/nvme-lockdown.html index cb2e86c..7fd48c1 100644 --- a/Documentation/nvme-lockdown.html +++ b/Documentation/nvme-lockdown.html @@ -4,7 +4,7 @@ - + nvme-lockdown(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme supported-log-pages <device> [--output-format=<fmt> | -o <fmt>]
+                            [-b | --raw-binary]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe supportd log pages details from an NVMe device and provides +the returned structure.

+

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

+

On success, the returned supportd log pages log structure will be printed +for each command that is supported.

+
+
+
+

OPTIONS

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

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

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

+ This option will get the data in raw binary format. +

+
+
+ -d +
+
+ --dom-id +
+
+

+ This option is to get the domain ID. +

+
+
+
+
+
+

EXAMPLES

+
+

No examples provided yet.

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + \ No newline at end of file diff --git a/Documentation/nvme-media-unit-stat-log.txt b/Documentation/nvme-media-unit-stat-log.txt new file mode 100644 index 0000000..427b77c --- /dev/null +++ b/Documentation/nvme-media-unit-stat-log.txt @@ -0,0 +1,47 @@ +nvme-media-unit-stat-log(1) +=========================== + +NAME +---- +nvme-media-unit-stat-log - Send NVMe Media unit status Log pages +request, returns result and log. + +SYNOPSIS +-------- +[verse] +'nvme media-unit-stat-log' [--dom-id | -d ] + [--output-format= | -o ] + [--raw-binary | -b] + +DESCRIPTION +----------- +Retrieves the NVMe Media unit status log pages details from +an NVMe device and provides the returned structure. + +The parameter is mandatory and should be the NVMe character +device (ex: /dev/nvme0). + +On success, the returned Media unit status log pages log structure will be printed. + +OPTIONS +------- + +-o :: +--output-format=:: + This option will set the reporting format to normal, json, or binary. + Only one output format can be used at a time. + +-d:: +--dom-id:: + To get the domain ID. +-b:: +--raw-binary:: + To show raw binary data. + +EXAMPLES +-------- +No examples provided yet. + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-mi-cmd-support-effects-log.1 b/Documentation/nvme-mi-cmd-support-effects-log.1 new file mode 100644 index 0000000..c15184d --- /dev/null +++ b/Documentation/nvme-mi-cmd-support-effects-log.1 @@ -0,0 +1,64 @@ +'\" t +.\" Title: nvme-mi-cmd-support-effects-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 04/08/2022 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-MI\-CMD\-SUPPO" "1" "04/08/2022" "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-mi-cmd-support-effects-log \- Send NVMe MI Command Support and Effects log, returns results and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme\-mi\-cmd\-support\-effects\-log\fR [\-o | \-\-output\-format=] + [\-H | \-\-human\-readable] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends an MI Command Support and Effects log (id 13h) and provides the result and returned log structure\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.PP +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. +.RE +.SH "EXAMPLES" +.sp +nvme mi\-cmd\-support\-effects\-log /dev/nvme0 \-H +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-mi-cmd-support-effects-log.html b/Documentation/nvme-mi-cmd-support-effects-log.html new file mode 100644 index 0000000..1afb0c0 --- /dev/null +++ b/Documentation/nvme-mi-cmd-support-effects-log.html @@ -0,0 +1,822 @@ + + + + + + +nvme-mi-cmd-support-effects-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme-mi-cmd-support-effects-log <device> [-o <fmt> | --output-format=<fmt>]
+                                        [-H | --human-readable]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends an MI Command Support and Effects log (id 13h) +and provides the result and returned log structure.

+

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

+

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

+
+
+
+

OPTIONS

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

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

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

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

+
+
+
+
+
+

EXAMPLES

+
+

nvme mi-cmd-support-effects-log /dev/nvme0 -H

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-mi-cmd-support-effects-log.txt b/Documentation/nvme-mi-cmd-support-effects-log.txt new file mode 100644 index 0000000..67b8355 --- /dev/null +++ b/Documentation/nvme-mi-cmd-support-effects-log.txt @@ -0,0 +1,45 @@ +nvme-mi-cmd-support-effects-log(1) +================================== + +NAME +---- +nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log, + returns results and structure + +SYNOPSIS +-------- +[verse] +'nvme-mi-cmd-support-effects-log' [-o | --output-format=] + [-H | --human-readable] + +DESCRIPTION +----------- +For the NVMe device given, sends an MI Command Support and Effects log (id 13h) +and provides the result and returned log structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +-H:: +--human-readable:: + This option will parse and format many of the bit fields + into human-readable formats. + +EXAMPLES +-------- +nvme mi-cmd-support-effects-log /dev/nvme0 -H + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-micron-clear-pcie-errors.1 b/Documentation/nvme-micron-clear-pcie-errors.1 index 7da8234..b99290e 100644 --- a/Documentation/nvme-micron-clear-pcie-errors.1 +++ b/Documentation/nvme-micron-clear-pcie-errors.1 @@ -2,12 +2,12 @@ .\" Title: nvme-micron-clear-pcie-errors .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-MICRON\-CLEAR\" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-MICRON\-CLEAR\" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-micron-clear-pcie-errors.html b/Documentation/nvme-micron-clear-pcie-errors.html index 3f958f4..be146ad 100644 --- a/Documentation/nvme-micron-clear-pcie-errors.html +++ b/Documentation/nvme-micron-clear-pcie-errors.html @@ -4,7 +4,7 @@ - + nvme-micron-clear-pcie-errors(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme nvm-id-ns-lba-format <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
+                        [--lba-format-index=<lba_format_index> | -i <lba_format_index>]
+                        [-v | --verbose]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Identify NVM Command Set specific Namespace data structure for the specified +LBA format index for the NVM Command Set specified in the CSI field.

+

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

+

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

+
+
+
+

OPTIONS

+
+
+
+-U <uuid-index> +
+
+--uuid-index=<uuid-index> +
+
+

+ UUID Index of the feature +

+
+
+-i <lba_format_index> +
+
+--lba-format-index=<lba_format_index> +
+
+

+ This field specifies the index into the LBA Format list identifying + the LBA Format capabilities that are to be returned +

+
+
+-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 nvm-id-ns-lba-format /dev/nvme0n1 -i 0
    +
    +
    • +
  • +

    +Have the program return the raw structure in binary: +

    +
    +
    +
    # nvme nvm-id-ns-lba-format /dev/nvme0 -i 0 -o binary > nvm_id_ns.raw
+# nvme nvm-id-ns-lba-format /dev/nvme0n1 -i 0 --output-format=binary > nvm_id_ns.raw
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-nvm-id-ns-lba-format.txt b/Documentation/nvme-nvm-id-ns-lba-format.txt new file mode 100644 index 0000000..638e2fb --- /dev/null +++ b/Documentation/nvme-nvm-id-ns-lba-format.txt @@ -0,0 +1,67 @@ +nvme-nvm-id-ns-lba-format(1) +============================ + +NAME +---- +nvme-nvm-id-ns-lba-format - Send NVMe Identify NVM Command Set specific +Namespace data structure for specified LBA format, display structure + +SYNOPSIS +-------- +[verse] +'nvme nvm-id-ns-lba-format' [--uuid-index= | -U ] + [--lba-format-index= | -i ] + [-v | --verbose] + [--output-format= | -o ] + +DESCRIPTION +----------- +Identify NVM Command Set specific Namespace data structure for the specified +LBA format index for the NVM Command Set specified in the CSI field. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout. + +OPTIONS +------- +-U :: +--uuid-index=:: + UUID Index of the feature + +-i :: +--lba-format-index=:: + This field specifies the index into the LBA Format list identifying + the LBA Format capabilities that are to be returned + +-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 nvm-id-ns-lba-format /dev/nvme0n1 -i 0 +------------ ++ +* Have the program return the raw structure in binary: ++ +------------ +# nvme nvm-id-ns-lba-format /dev/nvme0 -i 0 -o binary > nvm_id_ns.raw +# nvme nvm-id-ns-lba-format /dev/nvme0n1 -i 0 --output-format=binary > nvm_id_ns.raw +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-nvm-id-ns.1 b/Documentation/nvme-nvm-id-ns.1 new file mode 100644 index 0000000..fde30b7 --- /dev/null +++ b/Documentation/nvme-nvm-id-ns.1 @@ -0,0 +1,162 @@ +'\" t +.\" Title: nvme-nvm-id-ns +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 01/07/2022 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-NVM\-ID\-NS" "1" "01/07/2022" "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-ns \- Send NVMe Identify NVM Command Set specific Namespace data structure, display structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme nvm\-id\-ns\fR [\-\-uuid\-index= | \-U ] + [\-\-namespace\-id= | \-n ] + [\-v | \-\-verbose] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Identify NVM Command Set specific Namespace data structure for the specified NSID for the NVM Command Set specified in the CSI field\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. +.SH "OPTIONS" +.PP +\-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 +\-U , \-\-uuid\-index= +.RS 4 +UUID Index of the feature +.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 nvm\-id\-ns /dev/nvme0n1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +If using the character device or overriding namespace id: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme nvm\-id\-ns /dev/nvme0 \-n 1 +# nvme nvm\-id\-ns /dev/nvme0n1 \-n 1 +# nvme nvm\-id\-ns /dev/nvme0 \-\-namespace\-id=1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Have the program return the raw structure in binary: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme nvm\-id\-ns /dev/nvme0n1 \-o binary > id_ns\&.raw +# nvme nvm\-id\-ns /dev/nvme0n1 \-\-output\-format=binary > id_ns\&.raw +.fi +.if n \{\ +.RE +.\} +.sp +It is probably a bad idea to not redirect stdout when using this mode\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Alternatively you may want to send the data to another program that can parse the raw buffer\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +NVME +.fi +.if n \{\ +.RE +.\} +.RE +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-nvm-id-ns.html b/Documentation/nvme-nvm-id-ns.html new file mode 100644 index 0000000..82645dc --- /dev/null +++ b/Documentation/nvme-nvm-id-ns.html @@ -0,0 +1,881 @@ + + + + + +nvme-nvm-id-ns(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme nvm-id-ns <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
+                        [--namespace-id=<NUM> | -n <NUM>]
+                        [-v | --verbose]
+                        [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Identify NVM Command Set specific Namespace data structure for the specified +NSID for the NVM Command Set specified in the CSI field.

+

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

+

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

+
+
+
+

OPTIONS

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

+
+
+-U <uuid-index> +
+
+--uuid-index=<uuid-index> +
+
+

+ UUID Index of the feature +

+
+
+-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 nvm-id-ns /dev/nvme0n1
    +
    +
    • +
  • +

    +If using the character device or overriding namespace id: +

    +
    +
    +
    # nvme nvm-id-ns /dev/nvme0 -n 1
+# nvme nvm-id-ns /dev/nvme0n1 -n 1
+# nvme nvm-id-ns /dev/nvme0 --namespace-id=1
    +
    +
    • +
  • +

    +Have the program return the raw structure in binary: +

    +
    +
    +
    # nvme nvm-id-ns /dev/nvme0n1 -o binary > id_ns.raw
+# nvme nvm-id-ns /dev/nvme0n1 --output-format=binary > id_ns.raw
    +
    +

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

    +
    • +
  • +

    +Alternatively you may want to send the data to another program that +can parse the raw buffer. +

    +
    +
    +
    NVME
    +
    +
    • +
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-nvm-id-ns.txt b/Documentation/nvme-nvm-id-ns.txt new file mode 100644 index 0000000..dfbbfaa --- /dev/null +++ b/Documentation/nvme-nvm-id-ns.txt @@ -0,0 +1,83 @@ +nvme-nvm-id-ns(1) +================= + +NAME +---- +nvme-nvm-id-ns - Send NVMe Identify NVM Command Set specific Namespace data structure, display structure + +SYNOPSIS +-------- +[verse] +'nvme nvm-id-ns' [--uuid-index= | -U ] + [--namespace-id= | -n ] + [-v | --verbose] + [--output-format= | -o ] + +DESCRIPTION +----------- +Identify NVM Command Set specific Namespace data structure for the specified +NSID for the NVM Command Set specified in the CSI field. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the structure may be returned in one of several ways depending +on the option flags; the structure may be parsed by the program or the +raw buffer may be printed to stdout. + +OPTIONS +------- +-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. + +-U :: +--uuid-index=:: + UUID Index of the feature + +-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 nvm-id-ns /dev/nvme0n1 +------------ ++ + +* If using the character device or overriding namespace id: ++ +------------ +# nvme nvm-id-ns /dev/nvme0 -n 1 +# nvme nvm-id-ns /dev/nvme0n1 -n 1 +# nvme nvm-id-ns /dev/nvme0 --namespace-id=1 +------------ ++ +* Have the program return the raw structure in binary: ++ +------------ +# nvme nvm-id-ns /dev/nvme0n1 -o binary > id_ns.raw +# nvme nvm-id-ns /dev/nvme0n1 --output-format=binary > id_ns.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +* Alternatively you may want to send the data to another program that +can parse the raw buffer. ++ +------------ + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-ocp-latency-monitor-log.1 b/Documentation/nvme-ocp-latency-monitor-log.1 new file mode 100644 index 0000000..9c38abd --- /dev/null +++ b/Documentation/nvme-ocp-latency-monitor-log.1 @@ -0,0 +1,79 @@ +'\" t +.\" Title: nvme-ocp-latency-monitor-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 04/08/2022 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-LATENCY\-" "1" "04/08/2022" "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-ocp-latency-monitor-log \- Display latency monitor log page data in human readable format +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp latency\-monitor\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, latency monitor log page data\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&. +.sp +This will only work on OCP compliant devices supporting this log page\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. The default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Displays the get latency monitor log for the device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp latency\-monitor\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-latency-monitor-log.html b/Documentation/nvme-ocp-latency-monitor-log.html new file mode 100644 index 0000000..b3c21d7 --- /dev/null +++ b/Documentation/nvme-ocp-latency-monitor-log.html @@ -0,0 +1,818 @@ + + + + + + +nvme-ocp-latency-monitor-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp latency-monitor-log <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, latency monitor log page data.

+

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

+

This will only work on OCP compliant devices supporting this log page. +Results for any other device are undefined.

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Displays the get latency monitor log for the device: +

    +
    +
    +
    # nvme ocp latency-monitor-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-latency-monitor-log.txt b/Documentation/nvme-ocp-latency-monitor-log.txt new file mode 100644 index 0000000..66f760c --- /dev/null +++ b/Documentation/nvme-ocp-latency-monitor-log.txt @@ -0,0 +1,44 @@ +nvme-ocp-latency-monitor-log(1) +=============================== + +NAME +---- +nvme-ocp-latency-monitor-log - Display latency monitor log page data in human +readable format + +SYNOPSIS +-------- +[verse] +'nvme ocp latency-monitor-log' [--output-format= | -o ] + +DESCRIPTION +----------- + +For the NVMe device given, latency monitor log page data. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this log page. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format + can be used at a time. The default is normal. + +EXAMPLES +-------- +* Displays the get latency monitor log for the device: ++ +------------ +# nvme ocp latency-monitor-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-smart-add-log.1 b/Documentation/nvme-ocp-smart-add-log.1 new file mode 100644 index 0000000..3127edc --- /dev/null +++ b/Documentation/nvme-ocp-smart-add-log.1 @@ -0,0 +1,79 @@ +'\" t +.\" Title: nvme-ocp-smart-add-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 04/08/2022 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-SMART\-AD" "1" "04/08/2022" "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-ocp-smart-add-log \- Retrieves Extended SMART information of given OCP compliant device +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp smart\-add\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send a smart\-add\-log command and provide the additional smart log\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&. +.sp +This will only work on OCP compliant devices supporting this feature\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. The default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue a smart\-add\-log command to retrieve the 0xC0 log page\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp smart\-add\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-smart-add-log.html b/Documentation/nvme-ocp-smart-add-log.html new file mode 100644 index 0000000..baba251 --- /dev/null +++ b/Documentation/nvme-ocp-smart-add-log.html @@ -0,0 +1,819 @@ + + + + + + +nvme-ocp-smart-add-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp smart-add-log <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a smart-add-log command and +provide the additional smart log.

+

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

+

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

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a smart-add-log command to retrieve the 0xC0 log page. +

    +
    +
    +
    # nvme ocp smart-add-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-smart-add-log.txt b/Documentation/nvme-ocp-smart-add-log.txt new file mode 100644 index 0000000..3a25822 --- /dev/null +++ b/Documentation/nvme-ocp-smart-add-log.txt @@ -0,0 +1,44 @@ +nvme-ocp-smart-add-log(1) +========================= + +NAME +---- +nvme-ocp-smart-add-log - Retrieves Extended SMART information of given OCP +compliant device + +SYNOPSIS +-------- +[verse] +'nvme ocp smart-add-log' [--output-format= | -o ] + +DESCRIPTION +----------- +For the NVMe device given, send a smart-add-log command and +provide the additional smart log. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format + can be used at a time. The default is normal. + +EXAMPLES +-------- +* Has the program issue a smart-add-log command to retrieve the 0xC0 log page. ++ +------------ +# nvme ocp smart-add-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-persistent-event-log.1 b/Documentation/nvme-persistent-event-log.1 index 653b657..de68633 100644 --- a/Documentation/nvme-persistent-event-log.1 +++ b/Documentation/nvme-persistent-event-log.1 @@ -2,12 +2,12 @@ .\" Title: persistent-event-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "PERSISTENT\-EVENT\-L" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "PERSISTENT\-EVENT\-L" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-persistent-event-log.html b/Documentation/nvme-persistent-event-log.html index 3f89c8e..cf519c5 100644 --- a/Documentation/nvme-persistent-event-log.html +++ b/Documentation/nvme-persistent-event-log.html @@ -4,7 +4,7 @@ - + persistent-event-log(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 7d3e090..50225e9 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLEAR\-PC" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-CLEAR\-PC" "1" "04/08/2022" "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 2b4b49c..4aa66ab 100644 --- a/Documentation/nvme-wdc-clear-pcie-correctable-errors.html +++ b/Documentation/nvme-wdc-clear-pcie-correctable-errors.html @@ -4,7 +4,7 @@ - + nvme-wdc-clear-pcie-correctable-errors(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc get-dev-capabilities-log <device> [--output-format=<normal|json>
+-o <normal|json>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a WDC plugin get-dev-capabilities-log command +and output the device capabilities log data. The --output-format option will +format the output as specified.

+

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

+

On success it returns the parsed device capabilities log page data, error +code otherwise.

+
+
+
+

OPTIONS

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC get-dev-capabilities-log plugin command : +

    +
    +
    +
    # nvme wdc get-dev-capabilities-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.txt b/Documentation/nvme-wdc-get-dev-capabilities-log.txt new file mode 100644 index 0000000..0621881 --- /dev/null +++ b/Documentation/nvme-wdc-get-dev-capabilities-log.txt @@ -0,0 +1,48 @@ +nvme-wdc-get-dev-capabilities-log(1) +==================================== + +NAME +---- +nvme-wdc-get-dev-capabilities-log - Send NVMe WDC get-dev-capabilities-log + plugin command, return parsed log output + +SYNOPSIS +-------- +[verse] +'nvme wdc get-dev-capabilities-log' [--output-format= +-o ] + +DESCRIPTION +----------- +For the NVMe device given, send a WDC plugin get-dev-capabilities-log command +and output the device capabilities log data. The --output-format option will +format the output as specified. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this log page. +Results for any other device are undefined. + +On success it returns the parsed device capabilities log page data, error +code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', or + 'json'. Only one output format can be used at a time. + Default is normal. + +EXAMPLES +-------- +* Has the program issue WDC get-dev-capabilities-log plugin command : ++ +------------ +# nvme wdc get-dev-capabilities-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-wdc-get-drive-status.1 b/Documentation/nvme-wdc-get-drive-status.1 index 0ce71ba..3c64d66 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-DRIV" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-DRIV" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-get-drive-status.html b/Documentation/nvme-wdc-get-drive-status.html index ee340f2..041aade 100644 --- a/Documentation/nvme-wdc-get-drive-status.html +++ b/Documentation/nvme-wdc-get-drive-status.html @@ -4,7 +4,7 @@ - + nvme-wdc-get-drive-status(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc get-error-recovery-log <device> [--output-format=<normal|json>
+-o <normal|json>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a WDC plugin get-error-recovery-log command +and output the error recovery log data. The --output-format option will format +the output as specified.

+

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

+

On success it returns the parsed error recovery log page data, error +code otherwise.

+
+
+
+

OPTIONS

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC get-error-recovery-log plugin command : +

    +
    +
    +
    # nvme wdc get-error-recovery-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-get-error-recovery-log.txt b/Documentation/nvme-wdc-get-error-recovery-log.txt new file mode 100644 index 0000000..2ad3605 --- /dev/null +++ b/Documentation/nvme-wdc-get-error-recovery-log.txt @@ -0,0 +1,48 @@ +nvme-wdc-get-error-recovery-log(1) +================================== + +NAME +---- +nvme-wdc-get-error-recovery-log - Send NVMe WDC get-error-recovery-log plugin + command, return parsed log output + +SYNOPSIS +-------- +[verse] +'nvme wdc get-error-recovery-log' [--output-format= +-o ] + +DESCRIPTION +----------- +For the NVMe device given, send a WDC plugin get-error-recovery-log command +and output the error recovery log data. The --output-format option will format +the output as specified. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this log page. +Results for any other device are undefined. + +On success it returns the parsed error recovery log page data, error +code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', or + 'json'. Only one output format can be used at a time. + Default is normal. + +EXAMPLES +-------- +* Has the program issue WDC get-error-recovery-log plugin command : ++ +------------ +# nvme wdc get-error-recovery-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.1 b/Documentation/nvme-wdc-get-latency-monitor-log.1 index 24903c5..4853add 100644 --- a/Documentation/nvme-wdc-get-latency-monitor-log.1 +++ b/Documentation/nvme-wdc-get-latency-monitor-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-wdc-get-latency-monitor-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-GET\-LATE" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-GET\-LATE" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.html b/Documentation/nvme-wdc-get-latency-monitor-log.html index 0c86989..fa91b8f 100644 --- a/Documentation/nvme-wdc-get-latency-monitor-log.html +++ b/Documentation/nvme-wdc-get-latency-monitor-log.html @@ -4,7 +4,7 @@ - + nvme-wdc-get-latency-monitor-log(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc get-unsupported-reqs-log <device> [--output-format=<normal|json>
+-o <normal|json>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a WDC plugin get-unsupported-reqs-log command +and output the unsupported requirements log data. The --output-format option +will format the output as specified.

+

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

+

On success it returns the parsed unsupported requirements log page data, error +code otherwise.

+
+
+
+

OPTIONS

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC get-unsupported-reqs-log plugin command : +

    +
    +
    +
    # nvme wdc get-unsupported-reqs-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-get-unsupported-reqs-log.txt b/Documentation/nvme-wdc-get-unsupported-reqs-log.txt new file mode 100644 index 0000000..f028665 --- /dev/null +++ b/Documentation/nvme-wdc-get-unsupported-reqs-log.txt @@ -0,0 +1,48 @@ +nvme-wdc-get-unsupported-reqs-log(1) +==================================== + +NAME +---- +nvme-wdc-get-unsupported-reqs-log - Send NVMe WDC get-unsupported-reqs-log + plugin command, return parsed log output + +SYNOPSIS +-------- +[verse] +'nvme wdc get-unsupported-reqs-log' [--output-format= +-o ] + +DESCRIPTION +----------- +For the NVMe device given, send a WDC plugin get-unsupported-reqs-log command +and output the unsupported requirements log data. The --output-format option +will format the output as specified. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this log page. +Results for any other device are undefined. + +On success it returns the parsed unsupported requirements log page data, error +code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', or + 'json'. Only one output format can be used at a time. + Default is normal. + +EXAMPLES +-------- +* Has the program issue WDC get-unsupported-reqs-log plugin command : ++ +------------ +# nvme wdc get-unsupported-reqs-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-wdc-id-ctrl.1 b/Documentation/nvme-wdc-id-ctrl.1 index 7c176a7..bdb99e3 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-ID\-CTRL" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-ID\-CTRL" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-wdc-id-ctrl.html b/Documentation/nvme-wdc-id-ctrl.html index 3acde0a..f0ef3e8 100644 --- a/Documentation/nvme-wdc-id-ctrl.html +++ b/Documentation/nvme-wdc-id-ctrl.html @@ -4,7 +4,7 @@ - + nvme-wdc-id-ctrl(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 98ef2a8..638188c 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: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-VS\-DRIVE" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME\-WDC\-VS\-DRIVE" "1" "04/08/2022" "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 9993637..afb487a 100644 --- a/Documentation/nvme-wdc-vs-drive-info.html +++ b/Documentation/nvme-wdc-vs-drive-info.html @@ -4,7 +4,7 @@ - + nvme-wdc-vs-drive-info(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme zns zrwa-flush-zone <device> [--namespace-id=<NUM> | -n <NUM>]
+                                    [--lba=<LBA> | -l <LBA>]
+                                    [--timeout=<timeout> | -t <timeout> ]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, issues the Zone Management Send command with the +"flush Zone" action. This will flush the zone that is opened as +zone random write area.

+

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

+
+
+-l <lba> +
+
+--lba=<lba> +
+
+

+ The LBA to flush up to. +

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

+ Override default timeout value. In milliseconds. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +flush the first zwra of first zone for zrwacg(15) on namespace 1: +

    +
    +
    +
    # nvme zns zrwa-flush-zone /dev/nvme0 -n 1 -l 15
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of nvme-cli

+
+
+
+
+ + + diff --git a/Documentation/nvme-zns-zrwa-flush-zone.txt b/Documentation/nvme-zns-zrwa-flush-zone.txt new file mode 100644 index 0000000..19e7926 --- /dev/null +++ b/Documentation/nvme-zns-zrwa-flush-zone.txt @@ -0,0 +1,50 @@ +nvme-zns-zrwa-flush-zone(1) +=========================== + +NAME +---- +nvme-zns-zrwa-flush-zone - Flush LBAs associated with a ZRWA to a zone + +SYNOPSIS +-------- +[verse] +'nvme zns zrwa-flush-zone' [--namespace-id= | -n ] + [--lba= | -l ] + [--timeout= | -t ] + +DESCRIPTION +----------- +For the NVMe device given, issues the Zone Management Send command with the +"flush Zone" action. This will flush the zone that is opened as +zone random write area. + +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. + +-l :: +--lba=:: + The LBA to flush up to. + +-t :: +--timeout=:: + Override default timeout value. In milliseconds. + +EXAMPLES +-------- +* flush the first zwra of first zone for zrwacg(15) on namespace 1: ++ +------------ +# nvme zns zrwa-flush-zone /dev/nvme0 -n 1 -l 15 +------------ + +NVME +---- +Part of nvme-cli diff --git a/Documentation/nvme.1 b/Documentation/nvme.1 index f1593d9..6162752 100644 --- a/Documentation/nvme.1 +++ b/Documentation/nvme.1 @@ -2,12 +2,12 @@ .\" Title: nvme .\" Author: [see the "Authors" section] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 11/11/2021 +.\" Date: 04/08/2022 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME" "1" "11/11/2021" "NVMe" "NVMe Manual" +.TH "NVME" "1" "04/08/2022" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -73,7 +73,7 @@ Retrieve error logs Submit flush .RE .PP -\fBnvme-dms\fR(1) +\fBnvme-dsm\fR(1) .RS 4 Submit Data Set Management .RE @@ -323,6 +323,11 @@ Discover and connect to all NVMe\-over\-Fabrics subsystems Connect to an NVMe\-over\-Fabrics subsystem .RE .PP +\fBnvme-dim\fR(1) +.RS 4 +Send Discovery Information Management command to a Discovery Controller +.RE +.PP \fBnvme-disconnect\fR(1) .RS 4 Disconnect from an NVMe\-over\-Fabrics subsystem @@ -337,6 +342,507 @@ Disconnect from all NVMe\-over\-Fabrics subsystems .RS 4 Reads and shows NVMe\-over\-Fabrics controller property .RE +.PP +\fBnvme-media-unit-stat-log\fR(1) +.RS 4 +Retrieve and show the configuration and wear of media units +.RE +.PP +\fBnvme-supported-cap-config-log\fR(1) +.RS 4 +Retrieve and show the list of Supported Capacity Configuration Descriptors +.RE +.PP +\fBnvme-boot-part-log\fR(1) +.RS 4 +Retrieve Boot Partition Log +.RE +.PP +\fBnvme-capacity-mgmt\fR(1) +.RS 4 +Capacity Management Command +.RE +.PP +\fBnvme-check-dhchap-key\fR(1) +.RS 4 +Generate NVMeoF DH\-HMAC\-CHAP host key +.RE +.PP +\fBnvme-check-tls-key\fR(1) +.RS 4 +Validate NVMeoF TLS PSK +.RE +.PP +\fBnvme-cmdset-ind-id-ns\fR(1) +.RS 4 +I/O Command Set Independent Identify Namespace +.RE +.PP +\fBnvme-endurance-event-agg-log\fR(1) +.RS 4 +Retrieve Endurance Group Event Aggregate Log +.RE +.PP +\fBnvme-fid-support-effects-log\fR(1) +.RS 4 +Retrieve FID Support and Effects log +.RE +.PP +\fBnvme-gen-dhchap-key\fR(1) +.RS 4 +Generate NVMeoF DH\-HMAC\-CHAP host key +.RE +.PP +\fBnvme-gen-hostnqn\fR(1) +.RS 4 +Generate NVMeoF host NQN +.RE +.PP +\fBnvme-gen-tls-key\fR(1) +.RS 4 +Generate NVMeoF TLS PSK +.RE +.PP +\fBnvme-get-lba-status\fR(1) +.RS 4 +Get LBA Status command +.RE +.PP +\fBnvme-id-domain\fR(1) +.RS 4 +NVMe Identify Domain List +.RE +.PP +\fBnvme-id-ns-lba-format\fR(1) +.RS 4 +NVMe Identify Namespace for the specified LBA Format index +.RE +.PP +\fBnvme-lba-status-log\fR(1) +.RS 4 +Retrieve LBA Status Information Log +.RE +.PP +\fBnvme-list-endgrp\fR(1) +.RS 4 +NVMe Identify Endurance Group List +.RE +.PP +\fBnvme-ns-rescan\fR(1) +.RS 4 +Rescans the NVME namespaces +.RE +.PP +\fBnvme-nvm-id-ctrl\fR(1) +.RS 4 +NVMe Identify Controller NVM Command Set +.RE +.PP +\fBnvme-nvm-id-ns\fR(1) +.RS 4 +NVMe Identify Namespace NVM Command Set +.RE +.PP +\fBnvme-nvm-id-ns-lba-format\fR(1) +.RS 4 +NVMe Identify Namespace NVM Command Set for the specified LBA Format index +.RE +.PP +\fBnvme-persistent-event-log\fR(1) +.RS 4 +Retrieve Presistent Event Log +.RE +.PP +\fBnvme-predictable-lat-log\fR(1) +.RS 4 +Retrieve Predictable Latency per Nvmset Log +.RE +.PP +\fBnvme-pred-lat-event-agg-log\fR(1) +.RS 4 +Retrieve Predictable Latency Event Aggregate Log +.RE +.PP +\fBnvme-primary-ctrl-caps\fR(1) +.RS 4 +NVMe Identify Primary Controller Capabilities +.RE +.PP +\fBnvme-reset\fR(1) +.RS 4 +Resets the controller +.RE +.PP +\fBnvme-rpmb\fR(1) +.RS 4 +Replay Protection Memory Block commands +.RE +.PP +\fBnvme-sanitize-log\fR(1) +.RS 4 +Retrieve sanitize log +.RE +.PP +\fBnvme-set-property\fR(1) +.RS 4 +Set a property and show the resulting value +.RE +.PP +\fBnvme-show-hostnqn\fR(1) +.RS 4 +Show NVMeoF host NQN +.RE +.PP +\fBnvme-subsystem-reset\fR(1) +.RS 4 +Resets the subsystem +.RE +.PP +\fBnvme-supported-log-pages\fR(1) +.RS 4 +Retrieve the Supported Log pages details +.RE +.PP +\fBnvme-verify\fR(1) +.RS 4 +verify command +.RE +.SS "Plugins/Vendor extension commands" +.PP +\fBnvme-intel-id-ctrl\fR(1) +.RS 4 +Intel \- NVMe Identify Controller +.RE +.PP +\fBnvme-intel-internal-log\fR(1) +.RS 4 +Retrieve Intel device\(cqs internal log and save to file +.RE +.PP +\fBnvme-intel-lat-stats\fR(1) +.RS 4 +Retrieve NVMe Identify Controller, return result and structure +.RE +.PP +\fBnvme-intel-market-name\fR(1) +.RS 4 +Intel vendor specific marketing name log page +.RE +.PP +\fBnvme-intel-smart-log-add\fR(1) +.RS 4 +NVMe Intel Additional SMART log page +.RE +.PP +\fBnvme-intel-temp-stats\fR(1) +.RS 4 +NVMe Intel Additional SMART log page for temp stats +.RE +.PP +\fBnvme-huawei-id-ctrl\fR(1) +.RS 4 +NVMe huawei Identify Controller +.RE +.PP +\fBnvme-huawei-list\fR(1) +.RS 4 +List all recognized Huawei NVMe devices +.RE +.PP +\fBnvme-dera-stat\fR(1) +.RS 4 +NVMe Dera Device status and Additional SMART log page request +.RE +.PP +\fBnvme-micron-clear-pcie-errors\fR(1) +.RS 4 +Clears correctable PCIe correctable errors of given Micron device +.RE +.PP +\fBnvme-micron-internal-log\fR(1) +.RS 4 +Retrieve Micron device\(cqs internal logs and save to given zip file +.RE +.PP +\fBnvme-micron-nand-stats\fR(1) +.RS 4 +Retrieves NAND statistics of given micron device +.RE +.PP +\fBnvme-micron-pcie-stats\fR(1) +.RS 4 +Retrieves pcie error statistics for given micron device +.RE +.PP +\fBnvme-micron-selective-download\fR(1) +.RS 4 +Performs selective firmware download +.RE +.PP +\fBnvme-micron-smart-add-log\fR(1) +.RS 4 +Retrieves NAND statistics +.RE +.PP +\fBnvme-micron-temperature-stats\fR(1) +.RS 4 +Retrieves temperature information of given micron device +.RE +.PP +\fBnvme-netapp-ontapdevices\fR(1) +.RS 4 +Display information about ONTAP devices +.RE +.PP +\fBnvme-netapp-smdevices\fR(1) +.RS 4 +Display information for each NVMe path to an E\-Series volume +.RE +.PP +\fBnvme-toshiba-clear-pcie-correctable-errors\fR(1) +.RS 4 +Reset the PCIe correctable errors count to zero +.RE +.PP +\fBnvme-toshiba-vs-internal-log\fR(1) +.RS 4 +Retrieve a Toshiba device\(cqs vendor specific internal log +.RE +.PP +\fBnvme-toshiba-vs-smart-add-log\fR(1) +.RS 4 +Retrieve a Toshiba device\(cqs vendor specific extended SMART log page +.RE +.PP +\fBnvme-transcend-badblock\fR(1) +.RS 4 +Retrieve Transcend NVMe device\(cqs bad blocks +.RE +.PP +\fBnvme-transcend-healthvalue\fR(1) +.RS 4 +Use NVMe SMART table to analyse the health value of Transcend device +.RE +.PP +\fBnvme-virtium-show-identify\fR(1) +.RS 4 +Show a complete detail of identify device information in json format +.RE +.PP +\fBnvme-virtium-save-smart-to-vtview-log\fR(1) +.RS 4 +Periodically save smart attributes into a log file +.RE +.PP +\fBnvme-wdc-cap-diag\fR(1) +.RS 4 +Retrieve WDC device\(cqs diagnostic log and save to file +.RE +.PP +\fBnvme-wdc-capabilities\fR(1) +.RS 4 +Display WDC plugin command capabilities +.RE +.PP +\fBnvme-wdc-clear-assert-dump\fR(1) +.RS 4 +Clears the assert dump (if present) +.RE +.PP +\fBnvme-wdc-clear-fw-activate-history\fR(1) +.RS 4 +Clears the firmware activate history table +.RE +.PP +\fBnvme-wdc-clear-pcie-corr\fR(1) +.RS 4 +Clears the pcie correctable errors field +.RE +.PP +\fBnvme-wdc-clear-pcie-correctable-errors\fR(1) +.RS 4 +Clears the pcie correctable errors returned in the smart\-log\-add command +.RE +.PP +\fBnvme-wdc-cloud-SSD-plugin-version\fR(1) +.RS 4 +Display WDC plugin Cloud SSD Plugin Version +.RE +.PP +\fBnvme-wdc-drive-essentials\fR(1) +.RS 4 +Retrieve WDC device\(cqs drive essentials bin files +.RE +.PP +\fBnvme-wdc-drive-log\fR(1) +.RS 4 +Retrieve WDC device\(cqs drive log and save to file +.RE +.PP +\fBnvme-wdc-drive-resize\fR(1) +.RS 4 +Send NVMe WDC Resize Vendor Unique Command +.RE +.PP +\fBnvme-wdc-enc-get-log\fR(1) +.RS 4 +Send NVMe WDC enc\-get\-log Vendor Unique Command +.RE +.PP +\fBnvme-wdc-get-crash-dump\fR(1) +.RS 4 +Retrieve WDC device\(cqs crash dump +.RE +.PP +\fBnvme-wdc-get-drive-status\fR(1) +.RS 4 +Send the NVMe WDC get\-drive\-status command +.RE +.PP +\fBnvme-wdc-get-latency-monitor-log\fR(1) +.RS 4 +Display latency monitor log page data in human readable format +.RE +.PP +\fBnvme-wdc-get-pfail-dump\fR(1) +.RS 4 +Retrieve WDC device\(cqs pfail crash dump +.RE +.PP +\fBnvme-wdc-id-ctrl\fR(1) +.RS 4 +Send NVMe Identify Controller, return result and structure +.RE +.PP +\fBnvme-wdc-log-page-directory\fR(1) +.RS 4 +Retrieves the list of Log IDs supported by the drive +.RE +.PP +\fBnvme-wdc-namespace-resize\fR(1) +.RS 4 +Resizes the device\(cqs namespace +.RE +.PP +\fBnvme-wdc-purge-monitor\fR(1) +.RS 4 +Send NVMe WDC Purge\-Monitor Vendor Unique Command +.RE +.PP +\fBnvme-wdc-purge\fR(1) +.RS 4 +Send NVMe WDC Purge Vendor Unique Command +.RE +.PP +\fBnvme-wdc-smart-add-log\fR(1) +.RS 4 +Send NVMe WDC smart add log Vendor Unique Command +.RE +.PP +\fBnvme-wdc-vs-drive-info\fR(1) +.RS 4 +Send the NVMe WDC vs\-drive\-info command +.RE +.PP +\fBnvme-wdc-vs-error-reason-identifier\fR(1) +.RS 4 +Retrieve WDC device\(cqs telemetry log error reason identifier field +.RE +.PP +\fBnvme-wdc-vs-fw-activate-history\fR(1) +.RS 4 +Execute NVMe WDC vs\-fw\-activate\-history Vendor Unique Command +.RE +.PP +\fBnvme-wdc-vs-internal-log\fR(1) +.RS 4 +Retrieve WDC device\(cqs internal firmware log and save to file +.RE +.PP +\fBnvme-wdc-vs-nand-stats\fR(1) +.RS 4 +Send NVMe WDC vs\-nand\-stats Vendor Unique Command +.RE +.PP +\fBnvme-wdc-vs-telemetry-controller-option\fR(1) +.RS 4 +Disable/Enable the controller initiated option of the telemetry log page +.RE +.PP +\fBnvme-wdc-vs-temperature-stats\fR(1) +.RS 4 +Display temperature\-related statistics +.RE +.PP +\fBnvme-zns-changed-zone-list\fR(1) +.RS 4 +Retrieve Changed Zone log for the given device +.RE +.PP +\fBnvme-zns-close-zone\fR(1) +.RS 4 +Closes one or all zones +.RE +.PP +\fBnvme-zns-finish-zone\fR(1) +.RS 4 +Finishes one or all zones +.RE +.PP +\fBnvme-zns-id-ctrl\fR(1) +.RS 4 +Send NVMe Zoned Command Set Identify Controller +.RE +.PP +\fBnvme-zns-id-ns\fR(1) +.RS 4 +Send NVMe Zoned Command Set Identify Namespace +.RE +.PP +\fBnvme-zns-offline-zone\fR(1) +.RS 4 +Offlines one or all zones +.RE +.PP +\fBnvme-zns-open-zone\fR(1) +.RS 4 +Opens one or all zones +.RE +.PP +\fBnvme-zns-report-zones\fR(1) +.RS 4 +Retrieve and display the Report Zones data structure +.RE +.PP +\fBnvme-zns-reset-zone\fR(1) +.RS 4 +Resets one or all zones +.RE +.PP +\fBnvme-zns-set-zone-desc\fR(1) +.RS 4 +Set extended descriptor data for a zone +.RE +.PP +\fBnvme-zns-zone-append\fR(1) +.RS 4 +Send an NVMe write command, provide results +.RE +.PP +\fBnvme-zns-zone-mgmt-recv\fR(1) +.RS 4 +Zone Management Receive command +.RE +.PP +\fBnvme-zns-zone-mgmt-send\fR(1) +.RS 4 +Zone Management Send command +.RE +.PP +\fBnvme-zns-zrwa-flush-zone\fR(1) +.RS 4 +Flush LBAs associated with a ZRWA to a zone +.RE .SH "FURTHER DOCUMENTATION" .sp See the freely available references on the \m[blue]\fBOfficial NVM\-Express Site\fR\m[]\&\s-2\u[1]\d\s+2\&. diff --git a/Documentation/nvme.html b/Documentation/nvme.html index 1d0f2b0..a11eb90 100644 --- a/Documentation/nvme.html +++ b/Documentation/nvme.html @@ -4,7 +4,7 @@ - + nvme(1)