diff --git a/.checkpatch.conf b/.checkpatch.conf new file mode 100644 index 0000000000..aacb98219b --- /dev/null +++ b/.checkpatch.conf @@ -0,0 +1,24 @@ +# Checkpatch options. +# REF: https://docs.kernel.org/dev-tools/checkpatch.html + +# This isn't actually a Linux kernel tree +--no-tree + +--max-line-length=100 + +--ignore EMAIL_SUBJECT + +# FILE_PATH_CHANGES reports this kind of message: +# "added, moved or deleted file(s), does MAINTAINERS need updating?" +--ignore FILE_PATH_CHANGES + + +# Commit messages might contain a Gerrit Change-Id. +--ignore GERRIT_CHANGE_ID + +# Do not check the format of commit messages, as Gerrit's merge commits do not +# preserve it. +--ignore GIT_COMMIT_ID + +# Avoid "Does not appear to be a unified-diff format patch" message +--ignore NOT_UNIFIED_DIFF diff --git a/.github/workflows/appimage.yml b/.github/workflows/appimage.yml index c8205ef8c9..9768c70c9d 100644 --- a/.github/workflows/appimage.yml +++ b/.github/workflows/appimage.yml @@ -14,9 +14,16 @@ jobs: name: build AppImage runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: fixup permissions + env: + GITHUB_WORKSPACE: ${{ github.workspace }} + run: | + git config --global --add safe.directory "${GITHUB_WORKSPACE}" - name: build run: | scripts/build.sh appimage @@ -36,11 +43,10 @@ jobs: needs: build-appimage if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'linux-nvme/nvme-cli' }} steps: - - name: Download artifact - uses: dawidd6/action-download-artifact@v6 + - uses: actions/download-artifact@v4 with: - workflow: ${{ github.event.workflow_run.workflow_id }} - workflow_conclusion: success + name: AppImage + path: AppImage - name: FTP Deployer uses: sand4rt/ftp-deployer@v1.8 with: diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 78ae0cad70..a52f129c24 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ jobs: compiler: [gcc, clang] buildtype: [debug, release] container: - image: ghcr.io/igaw/linux-nvme/debian.python:latest + image: ghcr.io/linux-nvme/debian.python:latest steps: - uses: actions/checkout@v4 - name: build @@ -43,10 +43,16 @@ jobs: - uses: actions/checkout@v4 - name: enable foreign arch uses: dbhi/qus/action@main + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} - name: compile and run unit tests - uses: mosteo-actions/docker-run@v1 + uses: mosteo-actions/docker-run@v2 with: - image: ghcr.io/igaw/linux-nvme/ubuntu-cross-${{ matrix.arch }}:latest + image: ghcr.io/linux-nvme/ubuntu-cross-${{ matrix.arch }}:latest guest-dir: /build host-dir: ${{ github.workspace }} command: | @@ -65,7 +71,7 @@ jobs: name: fallback shared libraries runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest if: github.ref == 'refs/heads/master' steps: - uses: actions/checkout@v4 @@ -83,7 +89,7 @@ jobs: name: muon minimal static runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build @@ -94,7 +100,7 @@ jobs: name: make static runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build @@ -105,7 +111,7 @@ jobs: name: build libnvme and nvme-cli separately runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian:latest + image: ghcr.io/linux-nvme/debian:latest steps: - uses: actions/checkout@v4 - name: build diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml index 875ed6d6d2..a743d03816 100644 --- a/.github/workflows/coverage.yml +++ b/.github/workflows/coverage.yml @@ -11,12 +11,13 @@ jobs: name: code coverage runs-on: ubuntu-latest container: - image: ghcr.io/igaw/linux-nvme/debian.python:latest + image: ghcr.io/linux-nvme/debian.python:latest steps: - uses: actions/checkout@v4 - name: build run: | scripts/build.sh coverage - - uses: codecov/codecov-action@v4 + - uses: codecov/codecov-action@v5 with: - fail_ci_if_error: false + token: ${{ secrets.CODECOV_TOKEN }} + fail_ci_if_error: true diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000000..465bb260ca --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,26 @@ +--- +name: docs + +on: + push: + branches: [master] + paths: + - Documentation/** + pull_request: + branches: [master] + paths: + - Documentation/** + + workflow_dispatch: + +jobs: + build-docs: + name: build documentation + runs-on: ubuntu-latest + container: + image: ghcr.io/linux-nvme/debian:latest + steps: + - uses: actions/checkout@v4 + - name: build + run: | + scripts/build.sh docs diff --git a/.github/workflows/run-nightly-tests.yml b/.github/workflows/run-nightly-tests.yml new file mode 100644 index 0000000000..e8ac232ad6 --- /dev/null +++ b/.github/workflows/run-nightly-tests.yml @@ -0,0 +1,72 @@ +--- +name: run-nightly-tests + +on: + workflow_dispatch: + schedule: + - cron: '0 01 * * *' + +jobs: + nightly-tests: + runs-on: nvme-nvm + container: + image: ghcr.io/linux-nvme/debian.python:latest + #Expose all devices to the container through the `privileged` flag. + # + #BDEV0 is an environment variable of the self-hosted runner instance + #that contains a valid nvme ctrl name which is capable of the nvm + #command set. + options: '--privileged -v "/dev":"/dev":z -e BDEV0' + steps: + - name: Output kernel version + run: | + uname -a + - uses: actions/checkout@v4 + - name: Install dependencies + run: | + PIPX_BIN_DIR=/usr/local/bin pipx install nose2 --force + - name: Build and install nvme-cli + run: | + scripts/build.sh -b release -c gcc + - name: Overwrite test config + run: | + CONTROLLER=$(echo /dev/${BDEV0} | sed 's/n[0-9]*$//') + cat > tests/config.json << EOF + { + "controller" : "$CONTROLLER", + "ns1": "/dev/${BDEV0}", + "log_dir": "tests/nvmetests/", + "nvme_bin": "$(pwd)/.build-ci/nvme" + } + EOF + cat tests/config.json + - name: Run on device tests + run: | + nose2 --verbose --start-dir tests \ + nvme_attach_detach_ns_test \ + nvme_compare_test \ + nvme_copy_test \ + nvme_create_max_ns_test \ + nvme_ctrl_reset_test \ + nvme_dsm_test \ + nvme_error_log_test \ + nvme_flush_test \ + nvme_format_test \ + nvme_fw_log_test \ + nvme_get_features_test \ + nvme_get_lba_status_test \ + nvme_id_ctrl_test \ + nvme_id_ns_test \ + nvme_lba_status_log_test \ + nvme_read_write_test \ + nvme_smart_log_test \ + nvme_verify_test \ + nvme_writeuncor_test \ + nvme_writezeros_test + - name: Upload logs + uses: actions/upload-artifact@v4 + if: always() + with: + name: nvme-cli-test-logs + path: | + ./tests/nvmetests/**/*.log diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cde852734e..df0e8e5ed0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,28 @@ Please feel free to use the github forums to ask for comments & questions on your code before submitting a pull request. The NVMe CLI project uses the common *fork and merge* workflow used by most GitHub-hosted projects. +#### Commit conventions + +The project follows the Linux kernel mailing list workflow, +thus commit messages should be structured like this: +``` +: + + + +Signed-off-by: My Name/alias +``` + +Example: + +``` +doc: added commit conventions to contribution guidelines + +Show new contributors the project's commit guidelines + +Signed-off-by: John Doe +``` + ### Bug Reports Bugs for the NVM Library project are tracked in our [GitHub Issues Database](https://github.com/linux-nvme/nvme-cli/issues). diff --git a/Documentation/cmd-plugins.txt b/Documentation/cmd-plugins.txt index f767603932..ee774088c1 100644 --- a/Documentation/cmd-plugins.txt +++ b/Documentation/cmd-plugins.txt @@ -46,6 +46,9 @@ linknvme:nvme-micron-smart-add-log[1]:: linknvme:nvme-micron-temperature-stats[1]:: Retrieves temperature information of given micron device +linknvme:nvme-ocp-internal-log[1]:: + Retrieves and parses OCP Telemetry DA1 and DA2 logs. + linknvme:nvme-netapp-ontapdevices[1]:: Display information about ONTAP devices @@ -201,3 +204,39 @@ linknvme:nvme-zns-zrwa-flush-zone[1]:: linknvme:nvme-inspur-nvme-vendor-log[1]:: NVMe Inspur Device Vendor log page request + +linknvme:nvme-dapustor-smart-log-add[1]:: + NVMe DapuStor Additional SMART log page + +linknvme:nvme-solidigm-id-ctrl[1]:: + Solidigm - NVMe Identify Controller + +linknvme:nvme-solidigm-smart-log-add[1]:: + Retrieve Solidigm SMART Log + +linknvme:nvme-solidigm-vs-internal-log[1]:: + Retrieve Debug log binaries + +linknvme:nvme-solidigm-garbage-collect-log[1]:: + Retrieve Garbage Collection Log + +linknvme:nvme-solidigm-market-log[1]:: + Retrieve Market Log + +linknvme:nvme-solidigm-latency-tracking-log[1]:: + Enable/Retrieve Latency tracking Log + +linknvme:nvme-solidigm-parse-telemetry-log[1]:: + Parse Telemetry Log binary + +linknvme:nvme-solidigm-log-page-directory[1]:: + Retrieve log page directory + +linknvme:nvme-solidigm-temp-stats[1]:: + Retrieve Temperature Statistics log + +linknvme:nvme-solidigm-vs-drive-info[1]:: + Retrieve drive information + +linknvme:nvme-solidigm-workload-tracker[1]:: + Real Time capture Workload Tracker samples diff --git a/Documentation/meson.build b/Documentation/meson.build index 4dc551c95e..e81db8c902 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -14,6 +14,7 @@ adoc_sources = [ 'nvme-connect-all', 'nvme-copy', 'nvme-create-ns', + 'nvme-dapustor-smart-log-add', 'nvme-delete-ns', 'nvme-dera-stat', 'nvme-detach-ns', @@ -29,15 +30,15 @@ adoc_sources = [ 'nvme-endurance-event-agg-log', 'nvme-endurance-log', 'nvme-error-log', - 'nvme-fid-support-effects-log', - 'nvme-mi-cmd-support-effects-log', 'nvme-fdp-configs', - 'nvme-fdp-usage', - 'nvme-fdp-stats', 'nvme-fdp-events', + 'nvme-fdp-feature', + 'nvme-fdp-set-events', + 'nvme-fdp-stats', 'nvme-fdp-status', 'nvme-fdp-update', - 'nvme-fdp-set-events', + 'nvme-fdp-usage', + 'nvme-fid-support-effects-log', 'nvme-flush', 'nvme-format', 'nvme-fw-commit', @@ -57,6 +58,7 @@ adoc_sources = [ 'nvme-id-iocs', 'nvme-id-ns', 'nvme-id-nvmset', + 'nvme-inspur-nvme-vendor-log', 'nvme-intel-id-ctrl', 'nvme-intel-internal-log', 'nvme-intel-lat-stats', @@ -73,6 +75,7 @@ adoc_sources = [ 'nvme-list-ns', 'nvme-list-subsys', 'nvme-lockdown', + 'nvme-mi-cmd-support-effects-log', 'nvme-micron-clear-pcie-errors', 'nvme-micron-internal-log', 'nvme-micron-nand-stats', @@ -84,11 +87,9 @@ adoc_sources = [ 'nvme-netapp-smdevices', 'nvme-ns-descs', 'nvme-ns-rescan', + 'nvme-nvm-id-ctrl', 'nvme-nvme-mi-recv', 'nvme-nvme-mi-send', - 'nvme-nvm-id-ctrl', - 'nvme-ocp-latency-monitor-log', - 'nvme-ocp-smart-add-log', 'nvme-ocp-clear-fw-activate-history', 'nvme-ocp-clear-pcie-correctable-error-counters', 'nvme-ocp-device-capability-log', @@ -97,12 +98,15 @@ adoc_sources = [ 'nvme-ocp-get-dssd-async-event-config', 'nvme-ocp-get-dssd-power-state-feature', 'nvme-ocp-get-plp-health-check-interval', + 'nvme-ocp-latency-monitor-log', 'nvme-ocp-set-dssd-async-event-config', 'nvme-ocp-set-dssd-power-state-feature', 'nvme-ocp-set-plp-health-check-interval', 'nvme-ocp-set-telemetry-profile', + 'nvme-ocp-smart-add-log', 'nvme-ocp-telemetry-string-log-page', - 'nvme-ocp-unsupported-reqs-log-pages', + 'nvme-ocp-unsupported-reqs-log', + 'nvme-ocp-internal-log', 'nvme-persistent-event-log', 'nvme-pred-lat-event-agg-log', 'nvme-predictable-lat-log', @@ -117,20 +121,20 @@ adoc_sources = [ 'nvme-rpmb', 'nvme-sanitize', 'nvme-sanitize-log', + 'nvme-seagate-clear-fw-activate-history', 'nvme-seagate-clear-pcie-correctable-errors', + 'nvme-seagate-cloud-SSD-plugin-version', 'nvme-seagate-get-ctrl-tele', 'nvme-seagate-get-host-tele', 'nvme-seagate-help', 'nvme-seagate-plugin-version', 'nvme-seagate-version', + 'nvme-seagate-vs-fw-activate-history', 'nvme-seagate-vs-internal-log', 'nvme-seagate-vs-log-page-sup', 'nvme-seagate-vs-pcie-stats', 'nvme-seagate-vs-smart-add-log', 'nvme-seagate-vs-temperature-stats', - 'nvme-seagate-cloud-SSD-plugin-version', - 'nvme-seagate-vs-fw-activate-history', - 'nvme-seagate-clear-fw-activate-history', 'nvme-security-recv', 'nvme-security-send', 'nvme-self-test-log', @@ -140,9 +144,26 @@ adoc_sources = [ 'nvme-show-regs', 'nvme-show-topology', 'nvme-smart-log', + 'nvme-solidigm-clear-fw-activate-history', + 'nvme-solidigm-clear-pcie-correctable-errors', + 'nvme-solidigm-cloud-SSDplugin-version', + 'nvme-solidigm-garbage-collect-log', + 'nvme-solidigm-id-ctrl', + 'nvme-solidigm-latency-tracking-log', + 'nvme-solidigm-log-page-directory', + 'nvme-solidigm-market-log', + 'nvme-solidigm-parse-telemetry-log', + 'nvme-solidigm-smart-log-add', + 'nvme-solidigm-temp-stats', + 'nvme-solidigm-vs-drive-info', + 'nvme-solidigm-vs-fw-activate-history', + 'nvme-solidigm-vs-internal-log', + 'nvme-solidigm-vs-smart-add-log', + 'nvme-solidigm-workload-tracker', 'nvme-subsystem-reset', 'nvme-supported-log-pages', 'nvme-telemetry-log', + 'nvme-tls-key', 'nvme-toshiba-clear-pcie-correctable-errors', 'nvme-toshiba-vs-internal-log', 'nvme-toshiba-vs-smart-add-log', @@ -156,8 +177,8 @@ adoc_sources = [ 'nvme-wdc-clear-assert-dump', 'nvme-wdc-clear-fw-activate-history', 'nvme-wdc-clear-pcie-correctable-errors', - 'nvme-wdc-cloud-boot-SSD-version', 'nvme-wdc-cloud-SSD-plugin-version', + 'nvme-wdc-cloud-boot-SSD-version', 'nvme-wdc-drive-essentials', 'nvme-wdc-drive-log', 'nvme-wdc-drive-resize', @@ -201,7 +222,6 @@ adoc_sources = [ 'nvme-zns-zone-append', 'nvme-zns-zone-mgmt-recv', 'nvme-zns-zone-mgmt-send', - 'nvme-inspur-nvme-vendor-log', ] adoc_includes = [ diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1 index dfdc6d501a..25576c9c16 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: 05/03/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ADMIN\-PASSTHR" "1" "05/03/2024" "NVMe" "NVMe Manual" +.TH "NVME\-ADMIN\-PASSTHR" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -43,7 +43,7 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results [\-\-metadata\-len= | \-m ] [\-\-input\-file= | \-i ] [\-\-read | \-r] [\-\-write | \-w] - [\-\-timeout= | \-t ] + [\-\-timeout= | \-t ] [\-\-show\-command | \-s] [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b] @@ -146,6 +146,11 @@ or .RS 4 Increase the information detail in the output\&. .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp .RS 4 diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html index 9b0e6fec53..1ae7d893d4 100644 --- a/Documentation/nvme-admin-passthru.html +++ b/Documentation/nvme-admin-passthru.html @@ -4,7 +4,7 @@ - + nvme-admin-passthru(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme dapustor smart-log-add <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--raw-binary | -b] [--json | -j]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the NVMe DapuStor Additional SMART log page from the device and +provides the returned structure.

+

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

+

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

+
+
+
+

OPTIONS

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

+ Retrieve the Additional SMART log for the given nsid. This is + optional and its success may depend on the device’s capabilities + to provide this log on a per-namespace basis (see the NVMe + Identify Controller for this capability). The default nsid to + use is 0xffffffff for the device global SMART log. +

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

+ Print the raw DapuStor Additional SMART log buffer to stdout. +

+
+
+-j +
+
+--json +
+
+

+ Dump output in json format. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the DapuStor Additional SMART log page in a human readable format: +

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

    +Print the raw DapuStor Additional SMART log to a file: +

    +
    +
    +
    # nvme dapustor smart-log-add /dev/nvme0 --raw-binary > smart_log.raw
    +
    +

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

    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-dapustor-smart-log-add.txt b/Documentation/nvme-dapustor-smart-log-add.txt new file mode 100644 index 0000000000..0c67a21dc4 --- /dev/null +++ b/Documentation/nvme-dapustor-smart-log-add.txt @@ -0,0 +1,65 @@ +nvme-dapustor-smart-log-add(1) +============================== + +NAME +---- +nvme-dapustor-smart-log-add - Send NVMe DapuStor Additional SMART log page request, +returns result and log + +SYNOPSIS +-------- +[verse] +'nvme dapustor smart-log-add' [--namespace-id= | -n ] + [--raw-binary | -b] [--json | -j] + +DESCRIPTION +----------- +Retrieves the NVMe DapuStor Additional SMART log page from the device and +provides the returned structure. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +On success, the returned smart log structure may be returned in one of +several ways depending on the option flags; the structure may parsed by +the program and printed in a readable format or the raw buffer may be +printed to stdout for another program to parse. + +OPTIONS +------- +-n :: +--namespace-id=:: + Retrieve the Additional SMART log for the given nsid. This is + optional and its success may depend on the device's capabilities + to provide this log on a per-namespace basis (see the NVMe + Identify Controller for this capability). The default nsid to + use is 0xffffffff for the device global SMART log. + +-b:: +--raw-binary:: + Print the raw DapuStor Additional SMART log buffer to stdout. + +-j:: +--json:: + Dump output in json format. + +EXAMPLES +-------- +* Print the DapuStor Additional SMART log page in a human readable format: ++ +------------ +# nvme dapustor smart-log-add /dev/nvme0 +------------ ++ + +* Print the raw DapuStor Additional SMART log to a file: ++ +------------ +# nvme dapustor smart-log-add /dev/nvme0 --raw-binary > smart_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite diff --git a/Documentation/nvme-delete-ns.1 b/Documentation/nvme-delete-ns.1 index 15451d1e03..7ac1853295 100644 --- a/Documentation/nvme-delete-ns.1 +++ b/Documentation/nvme-delete-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: 05/03/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "05/03/2024" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,6 +34,7 @@ nvme-delete-ns \- Send NVMe Namespace Management delete namespace command, retur .nf \fInvme delete\-ns\fR [\-\-namespace\-id= | \-n ] [\-\-output\-format= | \-o ] [\-\-verbose | \-v] + [\-\-timeout= | \-t ] .fi .SH "DESCRIPTION" .sp @@ -60,6 +61,11 @@ or .RS 4 Increase the information detail in the output\&. .RE +.PP +\-t , \-\-timeout= +.RS 4 +Override default timeout value 120,000\&. In milliseconds\&. +.RE .SH "EXAMPLES" .sp No examples yet\&. diff --git a/Documentation/nvme-delete-ns.html b/Documentation/nvme-delete-ns.html index abc5c6f1db..6ee087b68a 100644 --- a/Documentation/nvme-delete-ns.html +++ b/Documentation/nvme-delete-ns.html @@ -4,7 +4,7 @@ - + nvme-id-ns(1) + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, retrieves OCP Device Capability Log Page

+

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 <fmt> +
+
+--output-format=<fmt> +
+
+

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a device-capability-log command to retrieve the 0xC4 log page. +

    +
    +
    +
    # nvme ocp device-capability-log /dev/nvme0 -o normal
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.1 b/Documentation/nvme-ocp-eol-plp-failure-mode.1 index 6ff639e99f..fa40b2f718 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.1 +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-eol-plp-failure-mode .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 05/03/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-EOL\-PLP\" "1" "05/03/2024" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-EOL\-PLP\" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -34,7 +34,7 @@ nvme-ocp-eol-plp-failure-mode \- Define and print EOL or PLP circuitry failure m .nf \fInvme ocp eol\-plp\-failure\-mode\fR [\-\-mode= | \-m ] [\-\-no\-uuid | \-n] [\-\-save | \-s] - [\-\-sel=] + [\-\-sel=] .fi .SH "DESCRIPTION" .sp diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.html b/Documentation/nvme-ocp-eol-plp-failure-mode.html index f99cfd1eb3..4757eb3d72 100644 --- a/Documentation/nvme-ocp-eol-plp-failure-mode.html +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.html @@ -4,7 +4,7 @@ - + nvme-ocp-eol-plp-failure-mode(1) + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, retrieves OCP Error Recovery Log Page

+

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 <fmt> +
+
+--output-format=<fmt> +
+
+

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a error-recovery-log command to retrieve the 0xC1 log page. +

    +
    +
    +
    # nvme ocp error-recovery-log /dev/nvme0 -o normal
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-get-dssd-async-event-config.1 b/Documentation/nvme-ocp-get-dssd-async-event-config.1 new file mode 100644 index 0000000000..46668a13ab --- /dev/null +++ b/Documentation/nvme-ocp-get-dssd-async-event-config.1 @@ -0,0 +1,116 @@ +'\" t +.\" Title: nvme-ocp-get-dssd-async-event-config +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-GET\-DSSD" "1" "10/31/2024" "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-get-dssd-async-event-config \- Get dssd\-async\-event\-config value +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp get\-dssd\-async\-event\-config\fR [\-\-sel=] +.fi +.SH "DESCRIPTION" +.sp +Get dssd\-async\-event\-config\&. +.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 +\-s +.RS 4 +Select (SEL): This field specifies which value of the attributes to return in the provided data: +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +Select +T}:T{ +Description +T} +T{ +0 +T}:T{ +Current +T} +T{ +1 +T}:T{ +Default +T} +T{ +2 +T}:T{ +Saved +T} +T{ +3 +T}:T{ +Supported capabilities +T} +T{ +4\-7 +T}:T{ +Reserved +T} +.TE +.sp 1 +.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 get\-dssd\-async\-event\-config to retrieve the saved 0xC9 get features\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp get\-dssd\-async\-event\-config /dev/nvme0 \-s 2 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-get-dssd-async-event-config.html b/Documentation/nvme-ocp-get-dssd-async-event-config.html new file mode 100644 index 0000000000..9386e3d75e --- /dev/null +++ b/Documentation/nvme-ocp-get-dssd-async-event-config.html @@ -0,0 +1,853 @@ + + + + + + +nvme-ocp-get-dssd-async-event-config(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp get-dssd-async-event-config <device> [--sel=<select> | -s <select>]
+
+
+
+
+
+

DESCRIPTION

+
+

Get dssd-async-event-config.

+

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

+
+
+
+-s <select> +
+
+--sel=<select> +
+
+

+ Select (SEL): This field specifies which value of the attributes + to return in the provided data: +

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

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4-7

Reserved

+
+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a get-dssd-async-event-config to retrieve the saved 0xC9 get features. +

    +
    +
    +
    # nvme ocp get-dssd-async-event-config /dev/nvme0 -s 2
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-get-dssd-power-state-feature.1 b/Documentation/nvme-ocp-get-dssd-power-state-feature.1 new file mode 100644 index 0000000000..45c2b92591 --- /dev/null +++ b/Documentation/nvme-ocp-get-dssd-power-state-feature.1 @@ -0,0 +1,149 @@ +'\" t +.\" Title: get-dssd-power-state-feature +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "GET\-DSSD\-POWER\-ST" "1" "10/31/2024" "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-get-dssd-power-state-feature \- Get DSSD Power State +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp get\-dssd\-power\-state\-feature\fR + [\-\-sel=] [\-\-all | \-a] + [\-\-no\-uuid | \-n] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, retrieves OCP DSSD Power State\&. Passing \-\-all calls NVMe Get Feature three times, returning all three of the Current, Default, and Saved values\&. +.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 +\-S +.RS 4 +Select (SEL): This field specifies which value of the attributes to return in the provided data: +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +Select +T}:T{ +Description +T} +T{ +0 +T}:T{ +Current +T} +T{ +1 +T}:T{ +Default +T} +T{ +2 +T}:T{ +Saved +T} +T{ +3 +T}:T{ +Supported capabilities +T} +T{ +4\-7 +T}:T{ +Reserved +T} +.TE +.sp 1 +.RE +.PP +\-a, \-\-all +.RS 4 +Print out all 3 values at once \- Current DSSD Power State, Default DSSD Power State, and Saved DSSD Power State +.RE +.PP +\-n, \-\-no\-uuid +.RS 4 +Do not try to automatically detect UUID index for this command (required for old OCP 1\&.0 support) +.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 get\-dssd\-power\-state\-feature command to get the Curent DSSD Power State in watts\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp get\-dssd\-power\-state\-feature /dev/nvme0 \-S 0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue a get\-dssd\-power\-state\-feature command to get all three DSSD Power States in watts\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp get\-dssd\-power\-state\-feature /dev/nvme0 \-a +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-get-dssd-power-state-feature.html b/Documentation/nvme-ocp-get-dssd-power-state-feature.html new file mode 100644 index 0000000000..4569ce204a --- /dev/null +++ b/Documentation/nvme-ocp-get-dssd-power-state-feature.html @@ -0,0 +1,890 @@ + + + + + + +get-dssd-power-state-feature(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp get-dssd-power-state-feature <device>
+                        [--sel=<select> | -S <select>] [--all | -a]
+                        [--no-uuid | -n]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, retrieves OCP DSSD Power State. +Passing --all calls NVMe Get Feature three times, returning all three of +the Current, Default, and Saved values.

+

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

+
+
+
+-S <select> +
+
+--sel=<select> +
+
+

+ Select (SEL): This field specifies which value of the attributes + to return in the provided data: +

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

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4-7

Reserved

+
+
+
+-a +
+
+--all +
+
+

+ Print out all 3 values at once - Current DSSD Power State, + Default DSSD Power State, and Saved DSSD Power State +

+
+
+-n +
+
+--no-uuid +
+
+

+ Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a get-dssd-power-state-feature command to get the Curent DSSD Power State in watts. +

    +
    +
    +
    # nvme ocp get-dssd-power-state-feature /dev/nvme0 -S 0
    +
    +
    • +
  • +

    +Has the program issue a get-dssd-power-state-feature command to get all three DSSD Power States in watts. +

    +
    +
    +
    # nvme ocp get-dssd-power-state-feature /dev/nvme0 -a
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-get-error-injection.txt b/Documentation/nvme-ocp-get-error-injection.txt new file mode 100644 index 0000000000..8061e497bf --- /dev/null +++ b/Documentation/nvme-ocp-get-error-injection.txt @@ -0,0 +1,57 @@ +nvme-ocp-get-error-injection(1) +=============================== + +NAME +---- +nvme-ocp-get-error-injection - Return set of error injection + +SYNOPSIS +-------- +[verse] +'nvme ocp get-error-injection' [--no-uuid | -n] + [--sel=] + +DESCRIPTION +----------- +Return set of error injection. + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +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 +------- +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) + +-s :: + Select (SEL): This field specifies which value of the attributes + to return in the provided data: ++ +[] +|================== +|Select|Description +|0|Current +|1|Default +|2|Saved +|3|Supported capabilities +|4-7|Reserved +|================== + +EXAMPLES +-------- +* Has the program issue a get-error-injection to retrieve the 0xC0 get features. ++ +------------ +# nvme ocp get-error-injection /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-get-plp-health-check-interval.1 b/Documentation/nvme-ocp-get-plp-health-check-interval.1 new file mode 100644 index 0000000000..3a050c3dda --- /dev/null +++ b/Documentation/nvme-ocp-get-plp-health-check-interval.1 @@ -0,0 +1,116 @@ +'\" t +.\" Title: nvme-ocp-get-plp-health-check-interval +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-GET\-PLP\" "1" "10/31/2024" "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-get-plp-health-check-interval \- Define and print plp\-health\-check\-interval value +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp get\-plp\-health\-check\-interval\fR [\-\-sel=] +.fi +.SH "DESCRIPTION" +.sp +Define plp\-health\-check\-interval\&. No argument prints current mode\&. +.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 +\-s +.RS 4 +Select (SEL): This field specifies which value of the attributes to return in the provided data: +.TS +allbox tab(:); +lt lt +lt lt +lt lt +lt lt +lt lt +lt lt. +T{ +Select +T}:T{ +Description +T} +T{ +0 +T}:T{ +Current +T} +T{ +1 +T}:T{ +Default +T} +T{ +2 +T}:T{ +Saved +T} +T{ +3 +T}:T{ +Supported capabilities +T} +T{ +4\-7 +T}:T{ +Reserved +T} +.TE +.sp 1 +.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 get\-plp\-health\-check\-interval to retrieve the 0xC6 get features\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp get\-plp\-health\-check\-interval /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-get-plp-health-check-interval.html b/Documentation/nvme-ocp-get-plp-health-check-interval.html new file mode 100644 index 0000000000..7f04901625 --- /dev/null +++ b/Documentation/nvme-ocp-get-plp-health-check-interval.html @@ -0,0 +1,854 @@ + + + + + + +nvme-ocp-get-plp-health-check-interval(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp get-plp-health-check-interval <device> [--sel=<select> | -s <select>]
+
+
+
+
+
+

DESCRIPTION

+
+

Define plp-health-check-interval. +No argument prints current mode.

+

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

+
+
+
+-s <select> +
+
+--sel=<select> +
+
+

+ Select (SEL): This field specifies which value of the attributes + to return in the provided data: +

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

Select

Description

0

Current

1

Default

2

Saved

3

Supported capabilities

4-7

Reserved

+
+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a get-plp-health-check-interval to retrieve the 0xC6 get features. +

    +
    +
    +
    # nvme ocp get-plp-health-check-interval /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-hardware-component-log.txt b/Documentation/nvme-ocp-hardware-component-log.txt new file mode 100644 index 0000000000..02ddd78457 --- /dev/null +++ b/Documentation/nvme-ocp-hardware-component-log.txt @@ -0,0 +1,85 @@ +nvme-ocp-hardware-component-log(1) +================================== + +NAME +---- +nvme-ocp-hardware-component-log - retrieve hardware component log + +SYNOPSIS +-------- +[verse] +'nvme ocp hardware-component-log' [--comp-id= | -i ] + [--list | -l] [--verbose | -v] + [--output-format= | -o ] [--timeout=] + +DESCRIPTION +----------- +Retrieve hardware component log. + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +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 +------- +-i :: +--comp-id=:: + component identifier ++ +[] +|================= +|Value|Definition +|0x0000| Reserved +|0x0001 \| 'asic'| Controller ASIC component +|0x0002 \| 'nand'| NAND Component +|0x0003 \| 'dram'| DRAM Component +|0x0004 \| 'pmic'| PMIC Component +|0x0005 \| 'pcb'| PCB Component +|0x0006 \| 'cap'| capacitor component +|0x0007 \| 'reg'| registor component +|0x0008 \| 'case'| case component +|0x0009 \| 'sn'| Device Serial Number +|0x000A \| 'country'| Country of Origin +|0x000B \| 'hw-rev'| Global Device Hardware Revision +|0x000C-0x7FFF| Reserved +|0x8000 \| 'vendor'| Vendor Unique Component +|0x8001-0xFFFF| Vendor Unique Component +|================= + +-l:: +--list:: + list component descriptions + +-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. + +-t :: +--timeout=:: + Override default timeout value. In milliseconds. + +EXAMPLES +-------- +* Has the program issue a ocp hardware-component-log ++ +------------ +# nvme ocp hardware-component-log /dev/nvme0 +------------ + +* Has the program issue a ocp hardware-component-log with asic component list ++ +------------ +# nvme ocp hardware-component-log /dev/nvme0 -i asic -l +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-internal-log.1 b/Documentation/nvme-ocp-internal-log.1 new file mode 100644 index 0000000000..e0bd8d962d --- /dev/null +++ b/Documentation/nvme-ocp-internal-log.1 @@ -0,0 +1,177 @@ +'\" t +.\" Title: nvme-ocp-internal-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-INTERNAL\" "1" "10/31/2024" "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-internal-log \- Conditionally retrieves 07h Telemetry Host\-Initiated log, C9h OCP Strings Log from an NVMe device or from user\-specified file path\&. Takes retrieved logs and decodes into human\-readable output format specified by user\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp internal\-log\fR + [\-\-telemetry\-log= | \-l ] + [\-\-string\-log= | \-s ] + [\-\-output\-file= | \-o ] + [\-\-output\-format= | \-f ] + [\-\-data\-area= | \-a ] + [\-\-telemetry\-type= | \-t ] +.fi +.SH "DESCRIPTION" +.sp +Conditionally retrieves 07h Telemetry Host\-Initiated log, C9h OCP Strings Log from an NVMe device or from user\-specified file path\&. Takes retrieved logs and decodes (or) parses into human\-readable output format specified by user\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +This will only work on 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 +\-l , \-\-telemetry\-log= +.RS 4 +File name to existing Telemetry Host\-Initiated raw binary data to be used\&. If no path is specified, a live retrieval of payload on will be performed\&. +.RE +.PP +\-s , \-\-string\-log= +.RS 4 +File name to existing OCP String Log raw binary data to be used\&. If no path is specified, a live retrieval of payload on will be performed\&. +.RE +.PP +\-o , \-\-output\-file= +.RS 4 +Filepath name to where human\-readable output data will be saved to\&. +.RE +.PP +\-f , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR\&. Only one output format can be used at a time, the default value is +\fIjson\fR\&. +.RE +.PP +\-a , \-\-data\-area= +.RS 4 +Retrieves the specific data area requested\&. Valid inputs are 1,2\&. If this option is not specified, the default value is 1\&. +.RE +.PP +\-t , \-\-telemetry\-type= +.RS 4 +If set to 1, controller shall capture the Telemetry Host\-Initiated data representing the internal state of the controller at the time the associated Get Log Page command is processed\&. If cleared to 0, controller shall not update this data\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve in both OCP String Log and Telemetry Host\-Initiated Log from device\&. Decode default data\-area(s) in default format and output to console\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp internal\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve Telemetry Host\-Initiated data, reads in the OCP String Log locally\&. Decode default data\-area(s) in default format\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp internal\-log /dev/nvme0 \-\-string\-log=ocp_string_log\&.bin + \-\-output\-file=output_file\&.json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve OCP String Log, reads in the Telemetry Host\-Initiated Log locally\&. Decode data\-areas 1 and 2, and output in json format\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp internal\-log /dev/nvme0 \-\-telemetry\-log=host_telemetry\&.bin + \-\-output\-format=json \-\-output\-file=output_file\&.json \-\-data\-area=2 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Reads in both OCP String Log and Telemetry Host\-Initiated Log locally\&. Decode data\-areas 1 and 2, and output in normal text format\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp internal\-log /dev/nvme0 \-\-string\-log=ocp_string_log\&.bin + \-\-telemetry\-log=host_telemetry\&.bin \-\-output\-format=normal + \-\-output\-file=output_file\&.txt \-\-data\-area=2 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-ocp-internal-log.html b/Documentation/nvme-ocp-internal-log.html new file mode 100644 index 0000000000..08a0ff0fc4 --- /dev/null +++ b/Documentation/nvme-ocp-internal-log.html @@ -0,0 +1,925 @@ + + + + + + +nvme-ocp-internal-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp internal-log <device>
+                        [--telemetry-log=<file> | -l <file>]
+                        [--string-log=<file> | -s <file>]
+                        [--output-file=<file> | -o <file>]
+                        [--output-format=<fmt> | -f <fmt>]
+                        [--data-area=<da> | -a <da>]
+                        [--telemetry-type=<type> | -t <type>]
+
+
+
+
+
+

DESCRIPTION

+
+

Conditionally retrieves 07h Telemetry Host-Initiated log, C9h OCP Strings Log +from an NVMe device or from user-specified file path. Takes retrieved logs and +decodes (or) parses into human-readable output format specified by user.

+

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 OCP compliant devices supporting this feature. +Results for any other device are undefined.

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-l <file> +
+
+--telemetry-log=<file> +
+
+

+ File name to existing Telemetry Host-Initiated raw binary data to be used. + If no path is specified, a live retrieval of payload on <device> will be + performed. +

+
+
+-s <file> +
+
+--string-log=<file> +
+
+

+ File name to existing OCP String Log raw binary data to be used. If no path + is specified, a live retrieval of payload on <device> will be + performed. +

+
+
+-o <file> +
+
+--output-file=<file> +
+
+

+ Filepath name to where human-readable output data will be saved to. +

+
+
+-f <fmt> +
+
+--output-format=<fmt> +
+
+

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

+
+
+-a <da> +
+
+--data-area=<da> +
+
+

+ Retrieves the specific data area requested. Valid inputs are 1,2. If this + option is not specified, the default value is 1. +

+
+
+-t <type> +
+
+--telemetry-type=<type> +
+
+

+ If set to 1, controller shall capture the Telemetry Host-Initiated data + representing the internal state of the controller at the time the associated + Get Log Page command is processed. If cleared to 0, controller shall not + update this data. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve in both OCP String Log and Telemetry Host-Initiated Log from +device. Decode default data-area(s) in default format and output to console. +

    +
    +
    +
    # nvme ocp internal-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve Telemetry Host-Initiated data, reads in the OCP String Log locally. +Decode default data-area(s) in default format. +

    +
    +
    +
    # nvme ocp internal-log /dev/nvme0 --string-log=ocp_string_log.bin
+ --output-file=output_file.json
    +
    +
    • +
  • +

    +Retrieve OCP String Log, reads in the Telemetry Host-Initiated Log locally. +Decode data-areas 1 and 2, and output in json format. +

    +
    +
    +
    # nvme ocp internal-log /dev/nvme0 --telemetry-log=host_telemetry.bin
+ --output-format=json --output-file=output_file.json --data-area=2
    +
    +
    • +
  • +

    +Reads in both OCP String Log and Telemetry Host-Initiated Log locally. +Decode data-areas 1 and 2, and output in normal text format. +

    +
    +
    +
    # nvme ocp internal-log /dev/nvme0 --string-log=ocp_string_log.bin
+ --telemetry-log=host_telemetry.bin --output-format=normal
+ --output-file=output_file.txt --data-area=2
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-internal-log.txt b/Documentation/nvme-ocp-internal-log.txt new file mode 100644 index 0000000000..26d78ac351 --- /dev/null +++ b/Documentation/nvme-ocp-internal-log.txt @@ -0,0 +1,110 @@ +nvme-ocp-internal-log(1) +======================== + +NAME +---- +nvme-ocp-internal-log - Conditionally retrieves 07h Telemetry Host-Initiated +log, C9h OCP Strings Log from an NVMe device or from user-specified file path. +Takes retrieved logs and decodes into human-readable output format specified by +user. + +SYNOPSIS +-------- +[verse] +'nvme ocp internal-log' + [--telemetry-log= | -l ] + [--string-log= | -s ] + [--output-file= | -o ] + [--output-format= | -f ] + [--data-area= | -a ] + [--telemetry-type= | -t ] + +DESCRIPTION +----------- +Conditionally retrieves 07h Telemetry Host-Initiated log, C9h OCP Strings Log +from an NVMe device or from user-specified file path. Takes retrieved logs and +decodes (or) parses into human-readable output format specified by user. + +The parameter is mandatory and may be either the NVMe +character device (ex: /dev/nvme0), or a namespace block device (ex: +/dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-l :: +--telemetry-log=:: + File name to existing Telemetry Host-Initiated raw binary data to be used. + If no path is specified, a live retrieval of payload on will be + performed. + +-s :: +--string-log=:: + File name to existing OCP String Log raw binary data to be used. If no path + is specified, a live retrieval of payload on will be + performed. + +-o :: +--output-file=:: + Filepath name to where human-readable output data will be saved to. + +-f :: +--output-format=:: + Set the reporting format to 'normal', 'json'. Only one output format can be + used at a time, the default value is 'json'. + +-a :: +--data-area=:: + Retrieves the specific data area requested. Valid inputs are 1,2. If this + option is not specified, the default value is 1. + +-t :: +--telemetry-type=:: + Set the telemetry type to 'host', 'host0', 'host1' or 'controller'. + If set to host1, controller shall capture the Telemetry Host-Initiated data + representing the internal state of the controller at the time the associated + Get Log Page command is processed. If set to host0, controller shall not + update this data. + +EXAMPLES +-------- + +* Retrieve in both OCP String Log and Telemetry Host-Initiated Log from +device. Decode default data-area(s) in default format and output to console. ++ +---------------------------------- +# nvme ocp internal-log /dev/nvme0 +---------------------------------- + +* Retrieve Telemetry Host-Initiated data, reads in the OCP String Log locally. +Decode default data-area(s) in default format. ++ +-------------------------------------------------------------------- +# nvme ocp internal-log /dev/nvme0 --string-log=ocp_string_log.bin + --output-file=output_file.json +-------------------------------------------------------------------- + +* Retrieve OCP String Log, reads in the Telemetry Host-Initiated Log locally. +Decode data-areas 1 and 2, and output in json format. ++ +--------------------------------------------------------------------- +# nvme ocp internal-log /dev/nvme0 --telemetry-log=host_telemetry.bin + --output-format=json --output-file=output_file.json --data-area=2 +--------------------------------------------------------------------- + +* Reads in both OCP String Log and Telemetry Host-Initiated Log locally. +Decode data-areas 1 and 2, and output in normal text format. ++ +------------------------------------------------------------------ +# nvme ocp internal-log /dev/nvme0 --string-log=ocp_string_log.bin + --telemetry-log=host_telemetry.bin --output-format=normal + --output-file=output_file.txt --data-area=2 +------------------------------------------------------------------ + +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 index 1433343419..7da8390f8f 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.1 +++ b/Documentation/nvme-ocp-latency-monitor-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-latency-monitor-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 05/03/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-LATENCY\-" "1" "05/03/2024" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-LATENCY\-" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ocp-latency-monitor-log.html b/Documentation/nvme-ocp-latency-monitor-log.html index 94dd5c1a3b..03c2436ee5 100644 --- a/Documentation/nvme-ocp-latency-monitor-log.html +++ b/Documentation/nvme-ocp-latency-monitor-log.html @@ -4,7 +4,7 @@ - + nvme-ocp-latency-monitor-log(1) + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp set-dssd-async-event-config <device> [--enable-panic-notices | -e] [--save | -s]
+
+
+
+
+
+

DESCRIPTION

+
+

Set DSSD asynchronous event configuration

+

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

+
+
+
+-e +
+
+--enable-panic-notices +
+
+

+ Set enable panic notices [0] +

+
+
+-s +
+
+--save +
+
+

+ Save the attribute so that it persists through all power states and resets. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a set-dssd-async-event-config to enable panic notices, +persisting through power states. +

    +
    +
    +
    # nvme ocp set-dssd-async-event-config /dev/nvme0 -e -s
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.1 b/Documentation/nvme-ocp-set-dssd-power-state-feature.1 new file mode 100644 index 0000000000..a297fe0de4 --- /dev/null +++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.1 @@ -0,0 +1,78 @@ +'\" t +.\" Title: set-dssd-power-state-feature +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "SET\-DSSD\-POWER\-ST" "1" "10/31/2024" "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-set-dssd-power-state-feature \- Set DSSD Power State +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp set\-dssd\-power\-state\-feature\fR + [\-\-power\-state= | \-p ] [\-\-no\-uuid | \-n] + [\-\-save | \-s] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, retrieves OCP DSSD Power state Feature +.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 +\-p , \-\-power\-state= +.RS 4 +DSSD Power State to set in watts\&. +.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 set\-dssd\-power\-state\-feature command to set DSSD Power State to set in watts\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp set\-dssd\-power\-state\-feature /dev/nvme0 \-p \-s \-n +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.html b/Documentation/nvme-ocp-set-dssd-power-state-feature.html new file mode 100644 index 0000000000..28c1918fe1 --- /dev/null +++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.html @@ -0,0 +1,819 @@ + + + + + + +set-dssd-power-state-feature(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp set-dssd-power-state-feature <device>
+                        [--power-state=<fmt> | -p <fmt>] [--no-uuid | -n]
+                        [--save | -s]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, retrieves OCP DSSD Power state Feature

+

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

+
+
+
+-p <fmt> +
+
+--power-state=<fmt> +
+
+

+ DSSD Power State to set in watts. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a set-dssd-power-state-feature command to set DSSD Power State to set in watts. +

    +
    +
    +
    # nvme ocp set-dssd-power-state-feature /dev/nvme0 -p <value> -s <value> -n <value>
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-set-error-injection.txt b/Documentation/nvme-ocp-set-error-injection.txt new file mode 100644 index 0000000000..ee8fcf58e8 --- /dev/null +++ b/Documentation/nvme-ocp-set-error-injection.txt @@ -0,0 +1,79 @@ +nvme-ocp-set-error-injection(1) +=============================== + +NAME +---- +nvme-ocp-set-error-injection - Inject error conditions + +SYNOPSIS +-------- +[verse] +'nvme ocp set-error-injection' [--data= | -d ] + [--number= | -n ] [--no-uuid | -N] + [--type= | -t ] [--nrtdp= | -r ] + [--verbose | -v] [--output-format= | -o ] + [--timeout=] + +DESCRIPTION +----------- +Inject error conditions. + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +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 +------- +-d :: +--data=:: + Error injection data structure entries + +-n :: +--number=:: + Number of valid error injection data entries + +-N:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) + +-t :: +--type=:: + Error injection type + +-r :: +--nrtdp=:: + Number of reads to trigger device panic + +-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. + +--timeout=:: + Override default timeout value. In milliseconds. + +EXAMPLES +-------- +* Has the program issue a set-error-injection with the 2 entries data file. ++ +------------ +# nvme ocp set-error-injection /dev/nvme0 -d data.bin -n 2 +------------ + +* Has the program issue a set-error-injection with the 5 reads trigger NAND hang. ++ +------------ +# nvme ocp set-error-injection /dev/nvme0 -t 2 -r 5 +------------ + +NVME +---- +Part of the nvme-user suite. diff --git a/Documentation/nvme-ocp-set-plp-health-check-interval.1 b/Documentation/nvme-ocp-set-plp-health-check-interval.1 new file mode 100644 index 0000000000..ed41415f27 --- /dev/null +++ b/Documentation/nvme-ocp-set-plp-health-check-interval.1 @@ -0,0 +1,86 @@ +'\" t +.\" Title: nvme-ocp-set-plp-health-check-interval +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-SET\-PLP\" "1" "10/31/2024" "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-set-plp-health-check-interval \- Define and set PLP health check interval +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp set\-plp\-health\-check\-interval\fR [\-\-plp_health_interval= | \-p ] [\-\-save | \-s] [\-\-no\-uuid | \-n] +.fi +.SH "DESCRIPTION" +.sp +Define Set PLP health check interval\&. No argument prints current mode\&. +.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 +\-p , \-\-plp_health_interval= +.RS 4 +Set the plp health check interval [31:16] +.RE +.PP +\-n, \-\-no\-uuid +.RS 4 +Do not try to automatically detect UUID index for this command (required for old OCP 1\&.0 support) +.RE +.PP +\-s, \-\-save +.RS 4 +Save the attribute so that it persists through all power states and resets\&. +.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 set\-plp\-health\-check\-interval to retrieve the 0xC6 set features\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp eol\-plp\-failure\-mode /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-set-plp-health-check-interval.html b/Documentation/nvme-ocp-set-plp-health-check-interval.html new file mode 100644 index 0000000000..39ff461d19 --- /dev/null +++ b/Documentation/nvme-ocp-set-plp-health-check-interval.html @@ -0,0 +1,841 @@ + + + + + + +nvme-ocp-set-plp-health-check-interval(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp set-plp-health-check-interval <device> [--plp_health_interval=<plp_health_interval> | -p <plp_health_interval>] [--save | -s] [--no-uuid | -n]
+
+
+
+
+
+

DESCRIPTION

+
+

Define Set PLP health check interval. +No argument prints current mode.

+

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

+
+
+
+-p <plp_health_interval> +
+
+--plp_health_interval=<plp_health_interval> +
+
+

+ Set the plp health check interval [31:16] +

+
+
+-n +
+
+--no-uuid +
+
+

+ Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) +

+
+
+-s +
+
+--save +
+
+

+ Save the attribute so that it persists through all power states and resets. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a set-plp-health-check-interval to retrieve the 0xC6 set features. +

    +
    +
    +
    # nvme ocp eol-plp-failure-mode /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-set-telemetry-profile.1 b/Documentation/nvme-ocp-set-telemetry-profile.1 new file mode 100644 index 0000000000..db59df46cb --- /dev/null +++ b/Documentation/nvme-ocp-set-telemetry-profile.1 @@ -0,0 +1,77 @@ +'\" t +.\" Title: nvme-ocp-set-telemetry-profile +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-SET\-TELE" "1" "10/31/2024" "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-set-telemetry-profile \- Set Telemetry Profile +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp set\-telemetry\-profile\fR + [\-\-telemetry\-profile\-select= | \-t ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sets the OCP Set Telemetry Profile Feature +.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 +\-t , \-\-tps= +.RS 4 +Telemetry Profile Select\&. The device shall collect debug data per the specified profile number\&. +.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 set\-telemetry\-profile command to use profile five\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp set\-telemetry\-profile /dev/nvme0 \-t 5 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-set-telemetry-profile.html b/Documentation/nvme-ocp-set-telemetry-profile.html new file mode 100644 index 0000000000..3d57fec091 --- /dev/null +++ b/Documentation/nvme-ocp-set-telemetry-profile.html @@ -0,0 +1,819 @@ + + + + + + +nvme-ocp-set-telemetry-profile(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme ocp set-telemetry-profile <device>
+                        [--telemetry-profile-select=<tps> | -t <tps>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sets the OCP Set Telemetry Profile Feature

+

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

+
+
+
+-t <tps> +
+
+--tps=<tps> +
+
+

+ Telemetry Profile Select. The device shall collect debug data per the + specified profile number. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a set-telemetry-profile command to use profile five. +

    +
    +
    +
    # nvme ocp set-telemetry-profile /dev/nvme0 -t 5
    +
    +
    • +
+
+
+
+

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 index 354718cbe5..296ff1ec7f 100644 --- a/Documentation/nvme-ocp-smart-add-log.1 +++ b/Documentation/nvme-ocp-smart-add-log.1 @@ -2,12 +2,12 @@ .\" Title: nvme-ocp-smart-add-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 05/03/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-OCP\-SMART\-AD" "1" "05/03/2024" "NVMe" "NVMe Manual" +.TH "NVME\-OCP\-SMART\-AD" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-ocp-smart-add-log.html b/Documentation/nvme-ocp-smart-add-log.html index 73c7a1470b..05d6663471 100644 --- a/Documentation/nvme-ocp-smart-add-log.html +++ b/Documentation/nvme-ocp-smart-add-log.html @@ -4,7 +4,7 @@ - + nvme-ocp-smart-add-log(1) + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, send a tcg-configuration-log command and +provide the tcg configuration 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 <fmt> +
+
+--output-format=<fmt> +
+
+

+ 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 tcg-configuration-log command to retrieve the 0xC7 log page. +

    +
    +
    +
    # nvme ocp tcg-configuration-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-telemetry-string-log-page.1 b/Documentation/nvme-ocp-telemetry-string-log-page.1 new file mode 100644 index 0000000000..758534e7c0 --- /dev/null +++ b/Documentation/nvme-ocp-telemetry-string-log-page.1 @@ -0,0 +1,76 @@ +'\" t +.\" Title: nvme-ocp-telemetry-string-log-page +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-TELEMETRY" "1" "10/31/2024" "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-telemetry-string-log-page \- Retrieve OCP Telemetry String Log page +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp telemetry\-str\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, Retrieve OCP Telemetry String Log page +.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 +This option will set the reporting format to normal, json, or binary\&. 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 issue a telemetry\-string\-log command to get the log page data from bin file\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp telemetry\-string\-log /dev/nvme0n1 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-ocp-telemetry-string-log-page.html b/Documentation/nvme-ocp-telemetry-string-log-page.html new file mode 100644 index 0000000000..5aa0615bb4 --- /dev/null +++ b/Documentation/nvme-ocp-telemetry-string-log-page.html @@ -0,0 +1,818 @@ + + + + + + +nvme-ocp-telemetry-string-log-page(1) + + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, Retrieve OCP Telemetry String Log page

+

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 <fmt> +
+
+--output-format=<fmt> +
+
+

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a telemetry-string-log command to get the log page data from bin file. +

    +
    +
    +
    # nvme ocp telemetry-string-log /dev/nvme0n1
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-unsupported-reqs-log-pages.html b/Documentation/nvme-ocp-unsupported-reqs-log-pages.html new file mode 100644 index 0000000000..ccf7dd82bb --- /dev/null +++ b/Documentation/nvme-ocp-unsupported-reqs-log-pages.html @@ -0,0 +1,819 @@ + + + + + + +nvme-ocp-unsupported-reqs-log(1) + + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, send a unsupported-reqs-log command and +provide the unsupported requirements log page.

+

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 <fmt> +
+
+--output-format=<fmt> +
+
+

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a unsupported-reqs-log command to retrieve the 0xC5 log page. +

    +
    +
    +
    # nvme ocp unsupported-reqs-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-unsupported-reqs-log.1 b/Documentation/nvme-ocp-unsupported-reqs-log.1 new file mode 100644 index 0000000000..01923a1d65 --- /dev/null +++ b/Documentation/nvme-ocp-unsupported-reqs-log.1 @@ -0,0 +1,76 @@ +'\" t +.\" Title: nvme-ocp-unsupported-reqs-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-OCP\-UNSUPPORT" "1" "10/31/2024" "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-unsupported-reqs-log \- Retrieves unsupported requirements log page of given OCP compliant device +.SH "SYNOPSIS" +.sp +.nf +\fInvme ocp unsupported\-reqs\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send a unsupported\-reqs\-log command and provide the unsupported requirements log page\&. +.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 +This option will set the reporting format to normal, json, or binary\&. 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 issue a unsupported\-reqs\-log command to retrieve the 0xC5 log page\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ocp unsupported\-reqs\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-ocp-unsupported-reqs-log.html b/Documentation/nvme-ocp-unsupported-reqs-log.html new file mode 100644 index 0000000000..b65c7336de --- /dev/null +++ b/Documentation/nvme-ocp-unsupported-reqs-log.html @@ -0,0 +1,819 @@ + + + + + + +nvme-ocp-unsupported-reqs-log(1) + + + + + +
+
+

SYNOPSIS

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

DESCRIPTION

+
+

For the NVMe device given, send a unsupported-reqs-log command and +provide the unsupported requirements log page.

+

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 <fmt> +
+
+--output-format=<fmt> +
+
+

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue a unsupported-reqs-log command to retrieve the 0xC5 log page. +

    +
    +
    +
    # nvme ocp unsupported-reqs-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt b/Documentation/nvme-ocp-unsupported-reqs-log.txt similarity index 100% rename from Documentation/nvme-ocp-unsupported-reqs-log-pages.txt rename to Documentation/nvme-ocp-unsupported-reqs-log.txt diff --git a/Documentation/nvme-persistent-event-log.1 b/Documentation/nvme-persistent-event-log.1 index 035efcf591..e9c02988fb 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: 05/03/2024 +.\" Date: 10/31/2024 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "PERSISTENT\-EVENT\-L" "1" "05/03/2024" "NVMe" "NVMe Manual" +.TH "PERSISTENT\-EVENT\-L" "1" "10/31/2024" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/Documentation/nvme-persistent-event-log.html b/Documentation/nvme-persistent-event-log.html index 5059770e53..a54207c8fb 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 solidigm clear-fw-activate-history <device> [--no-uuid | -n]
+
+
+
+
+
+

DESCRIPTION

+
+

This command is a redirect to the OCP plugin’s clear firmware update history log command. +For detailed usage and options, please refer to the documentation for nvme ocp clear-fw-activate-history.

+

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

+
+
+
+

OPTIONS

+
+
+
+-n +
+
+--no-uuid +
+
+

+ Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Clear the firmware update history log for the device: +

    +
    +
    +
    # nvme solidigm clear-fw-activate-history /dev/nvme0
    +
    +
    • +
  • +

    +Clear the firmware update history log for an OCP 1.0 device: +

    +
    +
    +
    # nvme solidigm clear-fw-activate-history /dev/nvme0 --no-uuid
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-ocp-clear-fw-activate-history(1)

+
+
+
+

NVME

+
+

Part of the nvme-cli suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-clear-fw-activate-history.txt b/Documentation/nvme-solidigm-clear-fw-activate-history.txt new file mode 100644 index 0000000000..ac74728b24 --- /dev/null +++ b/Documentation/nvme-solidigm-clear-fw-activate-history.txt @@ -0,0 +1,48 @@ +nvme-solidigm-clear-fw-activate-history(1) +========================================== + +NAME +---- +nvme-solidigm-clear-fw-activate-history - Clear firmware update history log + +SYNOPSIS +-------- +[verse] +'nvme solidigm clear-fw-activate-history' [--no-uuid | -n] + +DESCRIPTION +----------- +This command is a redirect to the OCP plugin's clear firmware update history log command. +For detailed usage and options, please refer to the documentation for 'nvme ocp clear-fw-activate-history'. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) + +EXAMPLES +-------- +* Clear the firmware update history log for the device: ++ +------------ +# nvme solidigm clear-fw-activate-history /dev/nvme0 +------------ + +* Clear the firmware update history log for an OCP 1.0 device: ++ +------------ +# nvme solidigm clear-fw-activate-history /dev/nvme0 --no-uuid +------------ + +SEE ALSO +-------- +nvme-ocp-clear-fw-activate-history(1) + +NVME +---- +Part of the nvme-cli suite. diff --git a/Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 new file mode 100644 index 0000000000..809547685b --- /dev/null +++ b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-clear-pcie-correctable-errors +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-CLEA" "1" "10/31/2024" "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-solidigm-clear-pcie-correctable-errors \- Clear PCIe Correctable Error Counters +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm clear\-pcie\-correctable\-errors\fR [\-\-no\-uuid | \-n] +.fi +.SH "DESCRIPTION" +.sp +This command is a redirect to the OCP plugin\(cqs clear PCIe correctable error counters command\&. For detailed usage and options, please refer to the documentation for \fInvme ocp clear\-pcie\-correctable\-error\-counters\fR\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n, \-\-no\-uuid +.RS 4 +Do not try to automatically detect UUID index for this command (required for old OCP 1\&.0 support)\&. This option is necessary for devices that do not support OCP 2\&.0 or NVMe 1\&.4\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Clear PCIe Correctable Error Counters for the device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm clear\-pcie\-correctable\-errors /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Clear PCIe Correctable Error Counters for an OCP 1\&.0 device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm clear\-pcie\-correctable\-errors /dev/nvme0 \-\-no\-uuid +.fi +.if n \{\ +.RE +.\} +.RE +.SH "SEE ALSO" +.sp +nvme\-ocp\-clear\-pcie\-correctable\-error\-counters(1) +.SH "NVME" +.sp +Part of the nvme\-cli suite\&. diff --git a/Documentation/nvme-solidigm-clear-pcie-correctable-errors.html b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.html new file mode 100644 index 0000000000..8c30f7ee6a --- /dev/null +++ b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.html @@ -0,0 +1,832 @@ + + + + + + +nvme-solidigm-clear-pcie-correctable-errors(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm clear-pcie-correctable-errors <device> [--no-uuid | -n]
+
+
+
+
+
+

DESCRIPTION

+
+

This command is a redirect to the OCP plugin’s clear PCIe correctable error counters command. +For detailed usage and options, please refer to the documentation for nvme ocp clear-pcie-correctable-error-counters.

+

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

+
+
+
+

OPTIONS

+
+
+
+-n +
+
+--no-uuid +
+
+

+ Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support). This option is necessary for devices that do not + support OCP 2.0 or NVMe 1.4. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Clear PCIe Correctable Error Counters for the device: +

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

    +Clear PCIe Correctable Error Counters for an OCP 1.0 device: +

    +
    +
    +
    # nvme solidigm clear-pcie-correctable-errors /dev/nvme0 --no-uuid
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-ocp-clear-pcie-correctable-error-counters(1)

+
+
+
+

NVME

+
+

Part of the nvme-cli suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt new file mode 100644 index 0000000000..3f5883d890 --- /dev/null +++ b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt @@ -0,0 +1,49 @@ +nvme-solidigm-clear-pcie-correctable-errors(1) +============================================== + +NAME +---- +nvme-solidigm-clear-pcie-correctable-errors - Clear PCIe Correctable Error Counters + +SYNOPSIS +-------- +[verse] +'nvme solidigm clear-pcie-correctable-errors' [--no-uuid | -n] + +DESCRIPTION +----------- +This command is a redirect to the OCP plugin's clear PCIe correctable error counters command. +For detailed usage and options, please refer to the documentation for 'nvme ocp clear-pcie-correctable-error-counters'. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support). This option is necessary for devices that do not + support OCP 2.0 or NVMe 1.4. + +EXAMPLES +-------- +* Clear PCIe Correctable Error Counters for the device: ++ +------------ +# nvme solidigm clear-pcie-correctable-errors /dev/nvme0 +------------ + +* Clear PCIe Correctable Error Counters for an OCP 1.0 device: ++ +------------ +# nvme solidigm clear-pcie-correctable-errors /dev/nvme0 --no-uuid +------------ + +SEE ALSO +-------- +nvme-ocp-clear-pcie-correctable-error-counters(1) + +NVME +---- +Part of the nvme-cli suite. diff --git a/Documentation/nvme-solidigm-cloud-SSDplugin-version.1 b/Documentation/nvme-solidigm-cloud-SSDplugin-version.1 new file mode 100644 index 0000000000..2c4ee66f7b --- /dev/null +++ b/Documentation/nvme-solidigm-cloud-SSDplugin-version.1 @@ -0,0 +1,64 @@ +'\" t +.\" Title: nvme-solidigm-cloud-SSDplugin-version +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-CLOU" "1" "10/31/2024" "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-solidigm-cloud-SSDplugin-version \- Prints plug\-in OCP version +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm cloud\-SSDplugin\-version\fR +.fi +.SH "DESCRIPTION" +.sp +Displays the OCP (Open Compute Project) version of the Solidigm cloud SSD plugin\&. +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Display the OCP plugin version: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm cloud\-SSDplugin\-version +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-cloud-SSDplugin-version.html b/Documentation/nvme-solidigm-cloud-SSDplugin-version.html new file mode 100644 index 0000000000..eef281a26a --- /dev/null +++ b/Documentation/nvme-solidigm-cloud-SSDplugin-version.html @@ -0,0 +1,794 @@ + + + + + + +nvme-solidigm-cloud-SSDplugin-version(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm cloud-SSDplugin-version
+
+
+
+
+
+

DESCRIPTION

+
+

Displays the OCP (Open Compute Project) version of the Solidigm cloud SSD plugin.

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Display the OCP plugin version: +

    +
    +
    +
    # nvme solidigm cloud-SSDplugin-version
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt b/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt new file mode 100644 index 0000000000..5d17e47486 --- /dev/null +++ b/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt @@ -0,0 +1,29 @@ +nvme-solidigm-cloud-SSDplugin-version(1) +======================================== + +NAME +---- +nvme-solidigm-cloud-SSDplugin-version - Prints plug-in OCP version + +SYNOPSIS +-------- +[verse] +'nvme solidigm cloud-SSDplugin-version' + +DESCRIPTION +----------- +Displays the OCP (Open Compute Project) version of the Solidigm cloud SSD plugin. + +EXAMPLES +-------- +* Display the OCP plugin version: ++ +------------ +# nvme solidigm cloud-SSDplugin-version +------------ + +NVME +---- +Part of the nvme-user suite + + diff --git a/Documentation/nvme-solidigm-garbage-collect-log.1 b/Documentation/nvme-solidigm-garbage-collect-log.1 new file mode 100644 index 0000000000..637bf963c9 --- /dev/null +++ b/Documentation/nvme-solidigm-garbage-collect-log.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-garbage-collect-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-GARB" "1" "10/31/2024" "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-solidigm-garbage-collect-log \- Retrieve Garbage Collection Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm garbage\-collect\-log\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the Solidigm vendor\-specific garbage collection log for the given NVMe device\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the garbage collection log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm garbage\-collect\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the garbage collection log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm garbage\-collect\-log /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-garbage-collect-log.html b/Documentation/nvme-solidigm-garbage-collect-log.html new file mode 100644 index 0000000000..7c2ae05e98 --- /dev/null +++ b/Documentation/nvme-solidigm-garbage-collect-log.html @@ -0,0 +1,825 @@ + + + + + + +nvme-solidigm-garbage-collect-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm garbage-collect-log <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the Solidigm vendor-specific garbage collection log +for the given NVMe device.

+

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

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the garbage collection log: +

    +
    +
    +
    # nvme solidigm garbage-collect-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the garbage collection log in JSON format: +

    +
    +
    +
    # nvme solidigm garbage-collect-log /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-garbage-collect-log.txt b/Documentation/nvme-solidigm-garbage-collect-log.txt new file mode 100644 index 0000000000..77e1be3d80 --- /dev/null +++ b/Documentation/nvme-solidigm-garbage-collect-log.txt @@ -0,0 +1,44 @@ +nvme-solidigm-garbage-collect-log(1) +==================================== + +NAME +---- +nvme-solidigm-garbage-collect-log - Retrieve Garbage Collection Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm garbage-collect-log' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves and displays the Solidigm vendor-specific garbage collection log +for the given NVMe device. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. Only one + output format can be used at a time. + +EXAMPLES +-------- +* Retrieve and display the garbage collection log: ++ +------------ +# nvme solidigm garbage-collect-log /dev/nvme0 +------------ + +* Retrieve the garbage collection log in JSON format: ++ +------------ +# nvme solidigm garbage-collect-log /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-id-ctrl.1 b/Documentation/nvme-solidigm-id-ctrl.1 new file mode 100644 index 0000000000..f5e90920d5 --- /dev/null +++ b/Documentation/nvme-solidigm-id-ctrl.1 @@ -0,0 +1,161 @@ +'\" t +.\" Title: nvme-solidigm-id-ctrl +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-ID\-" "1" "10/31/2024" "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-solidigm-id-ctrl \- Send NVMe Identify Controller, return result and structure +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm id\-ctrl\fR [\-\-raw\-binary | \-b] [\-\-vendor\-specific | \-V] + [\-\-output\-format= | \-o ] [\-\-human\-readable | \-H] + [\-\-verbose | \-v] [\-\-timeout= | \-t ] +.fi +.SH "DESCRIPTION" +.sp +This command is a Solidigm\-specific extension of the NVMe Identify Controller command\&. It sends an NVMe Identify Controller command to the specified device and provides the result and returned structure\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +This command includes all options available in the generic nvme id\-ctrl command, including: \- \-\-raw\-binary or \-b \- \-\-vendor\-specific or \-V \- \-\-output\-format= or \-o \- \-\-human\-readable or \-H \- \-\-verbose or \-v \- \-\-timeout= or \-t +.sp +For detailed usage and options, please refer to the documentation for \fInvme id\-ctrl\fR\&. +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Send the Identify Controller command and interpret the output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the raw output to stdout: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-\-raw\-binary +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the output in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Display the vendor\-specific fields: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-\-vendor\-specific +# nvme solidigm id\-ctrl /dev/nvme0 \-V +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Use human\-readable output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm id\-ctrl /dev/nvme0 \-\-human\-readable +# nvme solidigm id\-ctrl /dev/nvme0 \-H +.fi +.if n \{\ +.RE +.\} +.RE +.SH "SEE ALSO" +.sp +nvme\-id\-ctrl(1) +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-id-ctrl.html b/Documentation/nvme-solidigm-id-ctrl.html new file mode 100644 index 0000000000..b6e657fc90 --- /dev/null +++ b/Documentation/nvme-solidigm-id-ctrl.html @@ -0,0 +1,852 @@ + + + + + + +nvme-solidigm-id-ctrl(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm id-ctrl <device> [--raw-binary | -b] [--vendor-specific | -V]
+                              [--output-format=<fmt> | -o <fmt>] [--human-readable | -H]
+                              [--verbose | -v] [--timeout=<seconds> | -t <seconds>]
+
+
+
+
+
+

DESCRIPTION

+
+

This command is a Solidigm-specific extension of the NVMe Identify Controller command. +It sends an NVMe Identify Controller command to the specified device and provides the result +and returned structure.

+

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

+

This command includes all options available in the generic nvme id-ctrl command, including: +- --raw-binary or -b +- --vendor-specific or -V +- --output-format=<fmt> or -o <fmt> +- --human-readable or -H +- --verbose or -v +- --timeout=<seconds> or -t <seconds>

+

For detailed usage and options, please refer to the documentation for nvme id-ctrl.

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Send the Identify Controller command and interpret the output: +

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

    +Print the raw output to stdout: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 --raw-binary
    +
    +
    • +
  • +

    +Print the output in JSON format: +

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

    +Display the vendor-specific fields: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 --vendor-specific
+# nvme solidigm id-ctrl /dev/nvme0 -V
    +
    +
    • +
  • +

    +Use human-readable output: +

    +
    +
    +
    # nvme solidigm id-ctrl /dev/nvme0 --human-readable
+# nvme solidigm id-ctrl /dev/nvme0 -H
    +
    +
    • +
+
+
+
+

SEE ALSO

+
+

nvme-id-ctrl(1)

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-id-ctrl.txt b/Documentation/nvme-solidigm-id-ctrl.txt new file mode 100644 index 0000000000..7ac67e3767 --- /dev/null +++ b/Documentation/nvme-solidigm-id-ctrl.txt @@ -0,0 +1,74 @@ +nvme-solidigm-id-ctrl(1) +======================== + +NAME +---- +nvme-solidigm-id-ctrl - Send NVMe Identify Controller, return result and structure + +SYNOPSIS +-------- +[verse] +'nvme solidigm id-ctrl' [--raw-binary | -b] [--vendor-specific | -V] + [--output-format= | -o ] [--human-readable | -H] + [--verbose | -v] [--timeout= | -t ] + +DESCRIPTION +----------- +This command is a Solidigm-specific extension of the NVMe Identify Controller command. +It sends an NVMe Identify Controller command to the specified device and provides the result +and returned structure. + +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) +or a namespace block device (ex: /dev/nvme0n1). + +This command includes all options available in the generic `nvme id-ctrl` command, including: +- `--raw-binary` or `-b` +- `--vendor-specific` or `-V` +- `--output-format=` or `-o ` +- `--human-readable` or `-H` +- `--verbose` or `-v` +- `--timeout=` or `-t ` + +For detailed usage and options, please refer to the documentation for 'nvme id-ctrl'. + +EXAMPLES +-------- +* Send the Identify Controller command and interpret the output: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 +------------ + +* Print the raw output to stdout: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 --raw-binary +------------ + +* Print the output in JSON format: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 -o json +------------ + +* Display the vendor-specific fields: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 --vendor-specific +# nvme solidigm id-ctrl /dev/nvme0 -V +------------ + +* Use human-readable output: ++ +------------ +# nvme solidigm id-ctrl /dev/nvme0 --human-readable +# nvme solidigm id-ctrl /dev/nvme0 -H +------------ + +SEE ALSO +-------- +nvme-id-ctrl(1) + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-latency-tracking-log.1 b/Documentation/nvme-solidigm-latency-tracking-log.1 new file mode 100644 index 0000000000..438583bb97 --- /dev/null +++ b/Documentation/nvme-solidigm-latency-tracking-log.1 @@ -0,0 +1,166 @@ +'\" t +.\" Title: nvme-solidigm-latency-tracking-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-LATE" "1" "10/31/2024" "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-solidigm-latency-tracking-log \- Enable/Retrieve Latency tracking Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm latency\-tracking\-log\fR [\-\-enable | \-e] [\-\-disable | \-d] + [\-\-read | \-r] [\-\-write | \-w] + [\-\-type | \-t ] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Enables, disables, or retrieves the Solidigm latency tracking log for the given NVMe device\&. This log provides detailed information about I/O latencies\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-e, \-\-enable +.RS 4 +Enable latency tracking before retrieving the log\&. +.RE +.PP +\-d, \-\-disable +.RS 4 +Disable latency tracking after retrieving the log\&. +.RE +.PP +\-r, \-\-read +.RS 4 +Retrieve read latency statistics (default if neither \-\-read nor \-\-write is specified)\&. +.RE +.PP +\-w, \-\-write +.RS 4 +Retrieve write latency statistics\&. +.RE +.PP +\-t , \-\-type +.RS 4 +Specify the log type to retrieve\&. Valid values depend on the device\(cqs capabilities\&. +.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 +.\} +Enable latency tracking and retrieve the read latency log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-enable \-\-read +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the write latency log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-write \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Disable latency tracking after retrieving the log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-disable +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Specify a log type when retrieving latency statistics: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm latency\-tracking\-log /dev/nvme0 \-\-type 1 \-\-read +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-latency-tracking-log.html b/Documentation/nvme-solidigm-latency-tracking-log.html new file mode 100644 index 0000000000..af52beda91 --- /dev/null +++ b/Documentation/nvme-solidigm-latency-tracking-log.html @@ -0,0 +1,901 @@ + + + + + + +nvme-solidigm-latency-tracking-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm latency-tracking-log <device> [--enable | -e] [--disable | -d]
+                                              [--read | -r] [--write | -w]
+                                              [--type <value> | -t <value>]
+                                              [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Enables, disables, or retrieves the Solidigm latency tracking log for the +given NVMe device. This log provides detailed information about I/O latencies.

+

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

+
+
+
+-e +
+
+--enable +
+
+

+ Enable latency tracking before retrieving the log. +

+
+
+-d +
+
+--disable +
+
+

+ Disable latency tracking after retrieving the log. +

+
+
+-r +
+
+--read +
+
+

+ Retrieve read latency statistics (default if neither --read nor --write is specified). +

+
+
+-w +
+
+--write +
+
+

+ Retrieve write latency statistics. +

+
+
+-t <value> +
+
+--type <value> +
+
+

+ Specify the log type to retrieve. Valid values depend on the device’s capabilities. +

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Enable latency tracking and retrieve the read latency log: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --enable --read
    +
    +
    • +
  • +

    +Retrieve the write latency log in JSON format: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --write -o json
    +
    +
    • +
  • +

    +Disable latency tracking after retrieving the log: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --disable
    +
    +
    • +
  • +

    +Specify a log type when retrieving latency statistics: +

    +
    +
    +
    # nvme solidigm latency-tracking-log /dev/nvme0 --type 1 --read
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-latency-tracking-log.txt b/Documentation/nvme-solidigm-latency-tracking-log.txt new file mode 100644 index 0000000000..91940dcc7c --- /dev/null +++ b/Documentation/nvme-solidigm-latency-tracking-log.txt @@ -0,0 +1,79 @@ +nvme-solidigm-latency-tracking-log(1) +===================================== + +NAME +---- +nvme-solidigm-latency-tracking-log - Enable/Retrieve Latency tracking Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm latency-tracking-log' [--enable | -e] [--disable | -d] + [--read | -r] [--write | -w] + [--type | -t ] + [--output-format= | -o ] + +DESCRIPTION +----------- +Enables, disables, or retrieves the Solidigm latency tracking log for the +given NVMe device. This log provides detailed information about I/O latencies. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-e:: +--enable:: + Enable latency tracking before retrieving the log. + +-d:: +--disable:: + Disable latency tracking after retrieving the log. + +-r:: +--read:: + Retrieve read latency statistics (default if neither --read nor --write is specified). + +-w:: +--write:: + Retrieve write latency statistics. + +-t :: +--type :: + Specify the log type to retrieve. Valid values depend on the device's capabilities. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. Only one + output format can be used at a time. + +EXAMPLES +-------- +* Enable latency tracking and retrieve the read latency log: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --enable --read +------------ + +* Retrieve the write latency log in JSON format: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --write -o json +------------ + +* Disable latency tracking after retrieving the log: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --disable +------------ + +* Specify a log type when retrieving latency statistics: ++ +------------ +# nvme solidigm latency-tracking-log /dev/nvme0 --type 1 --read +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-log-page-directory.1 b/Documentation/nvme-solidigm-log-page-directory.1 new file mode 100644 index 0000000000..9ae03b4a1b --- /dev/null +++ b/Documentation/nvme-solidigm-log-page-directory.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-log-page-directory +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-LOG\" "1" "10/31/2024" "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-solidigm-log-page-directory \- Retrieve log page directory +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm log\-page\-directory\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the log page directory for the given Solidigm NVMe device\&. This command provides information about the available log pages and their characteristics\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-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\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the log page directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm log\-page\-directory /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the log page directory in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm log\-page\-directory /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-log-page-directory.html b/Documentation/nvme-solidigm-log-page-directory.html new file mode 100644 index 0000000000..e6e7b18b32 --- /dev/null +++ b/Documentation/nvme-solidigm-log-page-directory.html @@ -0,0 +1,825 @@ + + + + + + +nvme-solidigm-log-page-directory(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm log-page-directory <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the log page directory for the given Solidigm NVMe device. +This command provides information about the available log pages and their +characteristics.

+

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

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the log page directory: +

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

    +Retrieve the log page directory in JSON format: +

    +
    +
    +
    # nvme solidigm log-page-directory /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-log-page-directory.txt b/Documentation/nvme-solidigm-log-page-directory.txt new file mode 100644 index 0000000000..8a8b17595a --- /dev/null +++ b/Documentation/nvme-solidigm-log-page-directory.txt @@ -0,0 +1,44 @@ +nvme-solidigm-log-page-directory(1) +=================================== + +NAME +---- +nvme-solidigm-log-page-directory - Retrieve log page directory + +SYNOPSIS +-------- +[verse] +'nvme solidigm log-page-directory' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves and displays the log page directory for the given Solidigm NVMe device. +This command provides information about the available log pages and their +characteristics. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Retrieve and display the log page directory: ++ +------------ +# nvme solidigm log-page-directory /dev/nvme0 +------------ + +* Retrieve the log page directory in JSON format: ++ +------------ +# nvme solidigm log-page-directory /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-market-log.1 b/Documentation/nvme-solidigm-market-log.1 new file mode 100644 index 0000000000..9a70b2503d --- /dev/null +++ b/Documentation/nvme-solidigm-market-log.1 @@ -0,0 +1,93 @@ +'\" t +.\" Title: nvme-solidigm-market-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-MARK" "1" "10/31/2024" "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-solidigm-market-log \- Retrieve Market Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm market\-log\fR [\-\-raw\-binary | \-b] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the Solidigm Marketing Name log for the given NVMe device\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-b, \-\-raw\-binary +.RS 4 +Output the raw log data in binary format\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the marketing name log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm market\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the raw binary data of the marketing name log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm market\-log /dev/nvme0 \-\-raw\-binary +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-market-log.html b/Documentation/nvme-solidigm-market-log.html new file mode 100644 index 0000000000..d9d315ef80 --- /dev/null +++ b/Documentation/nvme-solidigm-market-log.html @@ -0,0 +1,823 @@ + + + + + + +nvme-solidigm-market-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm market-log <device> [--raw-binary | -b]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the Solidigm Marketing Name log for the given NVMe device.

+

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

+
+
+
+

OPTIONS

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

+ Output the raw log data in binary format. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the marketing name log: +

    +
    +
    +
    # nvme solidigm market-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the raw binary data of the marketing name log: +

    +
    +
    +
    # nvme solidigm market-log /dev/nvme0 --raw-binary
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-market-log.txt b/Documentation/nvme-solidigm-market-log.txt new file mode 100644 index 0000000000..1b5e268568 --- /dev/null +++ b/Documentation/nvme-solidigm-market-log.txt @@ -0,0 +1,42 @@ +nvme-solidigm-market-log(1) +=========================== + +NAME +---- +nvme-solidigm-market-log - Retrieve Market Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm market-log' [--raw-binary | -b] + +DESCRIPTION +----------- +Retrieves and displays the Solidigm Marketing Name log for the given NVMe device. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-b:: +--raw-binary:: + Output the raw log data in binary format. + +EXAMPLES +-------- +* Retrieve and display the marketing name log: ++ +------------ +# nvme solidigm market-log /dev/nvme0 +------------ + +* Retrieve the raw binary data of the marketing name log: ++ +------------ +# nvme solidigm market-log /dev/nvme0 --raw-binary +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.1 b/Documentation/nvme-solidigm-parse-telemetry-log.1 new file mode 100644 index 0000000000..9764fdf52a --- /dev/null +++ b/Documentation/nvme-solidigm-parse-telemetry-log.1 @@ -0,0 +1,183 @@ +'\" t +.\" Title: nvme-solidigm-parse-telemetry-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-PARS" "1" "10/31/2024" "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-solidigm-parse-telemetry-log \- Parse and display Solidigm Telemetry log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm parse\-telemetry\-log\fR [OPTIONS] +.fi +.SH "DESCRIPTION" +.sp +Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device\&. This command provides detailed information about the device\(cqs telemetry data, which can be useful for diagnostics and performance analysis\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-g , \-\-host\-generate= +.RS 4 +Controls when to generate a new host\-initiated report\&. Default value +\fI1\fR +generates a new host\-initiated report, value +\fI0\fR +causes retrieval of an existing log\&. Valid values are 0 and 1\&. +.RE +.PP +\-c, \-\-controller\-init +.RS 4 +Gather report generated by the controller\&. +.RE +.PP +\-d , \-\-data\-area= +.RS 4 +Pick which telemetry data area to report\&. Default is 3 to fetch areas 1\-3\&. Valid options are 1, 2, 3, 4\&. +.RE +.PP +\-j , \-\-config\-file= +.RS 4 +Specify a JSON configuration file for custom parsing of the telemetry log\&. +.RE +.PP +\-s, \-\-source\-file +.RS 4 +Indicates that the argument is a binary file containing a log dump instead of a block or character device\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and parse the telemetry log with default options: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve an existing telemetry log without generating a new one: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-g 0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Parse a specific data area of the telemetry log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-d 2 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Use a custom configuration file for parsing: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log /dev/nvme0 \-j config\&.json +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Parse a telemetry log from a binary file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm parse\-telemetry\-log telemetry_dump\&.bin \-s +.fi +.if n \{\ +.RE +.\} +.RE +.SH "OUTPUT" +.sp +The command outputs the parsed telemetry log in JSON format to stdout\&. +.SH "NVME" +.sp +Part of the nvme\-cli suite diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.html b/Documentation/nvme-solidigm-parse-telemetry-log.html new file mode 100644 index 0000000000..d33d709576 --- /dev/null +++ b/Documentation/nvme-solidigm-parse-telemetry-log.html @@ -0,0 +1,906 @@ + + + + + + +nvme-solidigm-parse-telemetry-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm parse-telemetry-log <device> [OPTIONS]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device. +This command provides detailed information about the device’s telemetry data, which +can be useful for diagnostics and performance analysis.

+

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

+
+
+
+-g <num> +
+
+--host-generate=<num> +
+
+

+ Controls when to generate a new host-initiated report. Default value 1 generates + a new host-initiated report, value 0 causes retrieval of an existing log. + Valid values are 0 and 1. +

+
+
+-c +
+
+--controller-init +
+
+

+ Gather report generated by the controller. +

+
+
+-d <num> +
+
+--data-area=<num> +
+
+

+ Pick which telemetry data area to report. Default is 3 to fetch areas 1-3. + Valid options are 1, 2, 3, 4. +

+
+
+-j <file> +
+
+--config-file=<file> +
+
+

+ Specify a JSON configuration file for custom parsing of the telemetry log. +

+
+
+-s +
+
+--source-file +
+
+

+ Indicates that the <device> argument is a binary file containing a log dump + instead of a block or character device. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and parse the telemetry log with default options: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve an existing telemetry log without generating a new one: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0 -g 0
    +
    +
    • +
  • +

    +Parse a specific data area of the telemetry log: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0 -d 2
    +
    +
    • +
  • +

    +Use a custom configuration file for parsing: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log /dev/nvme0 -j config.json
    +
    +
    • +
  • +

    +Parse a telemetry log from a binary file: +

    +
    +
    +
    # nvme solidigm parse-telemetry-log telemetry_dump.bin -s
    +
    +
    • +
+
+
+
+

OUTPUT

+
+

The command outputs the parsed telemetry log in JSON format to stdout.

+
+
+
+

NVME

+
+

Part of the nvme-cli suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.txt b/Documentation/nvme-solidigm-parse-telemetry-log.txt new file mode 100644 index 0000000000..38a678bd80 --- /dev/null +++ b/Documentation/nvme-solidigm-parse-telemetry-log.txt @@ -0,0 +1,86 @@ +nvme-solidigm-parse-telemetry-log(1) +==================================== + +NAME +---- +nvme-solidigm-parse-telemetry-log - Parse and display Solidigm Telemetry log + +SYNOPSIS +-------- +[verse] +'nvme solidigm parse-telemetry-log' [OPTIONS] + +DESCRIPTION +----------- +Retrieves, parses, and displays the Telemetry log for the given Solidigm NVMe device. +This command provides detailed information about the device's telemetry data, which +can be useful for diagnostics and performance analysis. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-g :: +--host-generate=:: + Controls when to generate a new host-initiated report. Default value '1' generates + a new host-initiated report, value '0' causes retrieval of an existing log. + Valid values are 0 and 1. + +-c:: +--controller-init:: + Gather report generated by the controller. + +-d :: +--data-area=:: + Pick which telemetry data area to report. Default is 3 to fetch areas 1-3. + Valid options are 1, 2, 3, 4. + +-j :: +--config-file=:: + Specify a JSON configuration file for custom parsing of the telemetry log. + +-s:: +--source-file:: + Indicates that the argument is a binary file containing a log dump + instead of a block or character device. + +EXAMPLES +-------- +* Retrieve and parse the telemetry log with default options: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 +------------ + +* Retrieve an existing telemetry log without generating a new one: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 -g 0 +------------ + +* Parse a specific data area of the telemetry log: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 -d 2 +------------ + +* Use a custom configuration file for parsing: ++ +------------ +# nvme solidigm parse-telemetry-log /dev/nvme0 -j config.json +------------ + +* Parse a telemetry log from a binary file: ++ +------------ +# nvme solidigm parse-telemetry-log telemetry_dump.bin -s +------------ + +OUTPUT +------ +The command outputs the parsed telemetry log in JSON format to stdout. + +NVME +---- +Part of the nvme-cli suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-smart-log-add.1 b/Documentation/nvme-solidigm-smart-log-add.1 new file mode 100644 index 0000000000..a71787b695 --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.1 @@ -0,0 +1,123 @@ +'\" t +.\" Title: nvme-solidigm-smart-log-add +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-SMAR" "1" "10/31/2024" "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-solidigm-smart-log-add \- Retrieve Solidigm SMART Log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm smart\-log\-add\fR [\-\-namespace\-id= | \-n ] + [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves the Solidigm vendor\-specific SMART log for the given NVMe device and optionally the specified namespace, then displays the log\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-n , \-\-namespace\-id= +.RS 4 +Retrieve the log for the given nsid\&. If not specified, the log will be retrieved for all namespaces\&. +.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 +.\} +Retrieve the Solidigm SMART log for all namespaces: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log for namespace 1: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 \-n 1 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the Solidigm SMART log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm smart\-log\-add /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-smart-log-add.html b/Documentation/nvme-solidigm-smart-log-add.html new file mode 100644 index 0000000000..178f6bf6d6 --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.html @@ -0,0 +1,847 @@ + + + + + + +nvme-solidigm-smart-log-add(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm smart-log-add <device> [--namespace-id=<nsid> | -n <nsid>]
+                                       [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves the Solidigm vendor-specific SMART log for the given NVMe device +and optionally the specified namespace, then displays the log.

+

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 <nsid> +
+
+--namespace-id=<nsid> +
+
+

+ Retrieve the log for the given nsid. If not specified, the log + will be retrieved for all namespaces. +

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve the Solidigm SMART log for all namespaces: +

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

    +Retrieve the Solidigm SMART log for namespace 1: +

    +
    +
    +
    # nvme solidigm smart-log-add /dev/nvme0 -n 1
    +
    +
    • +
  • +

    +Retrieve the Solidigm SMART log in JSON format: +

    +
    +
    +
    # nvme solidigm smart-log-add /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-smart-log-add.txt b/Documentation/nvme-solidigm-smart-log-add.txt new file mode 100644 index 0000000000..5a9b92c4f3 --- /dev/null +++ b/Documentation/nvme-solidigm-smart-log-add.txt @@ -0,0 +1,56 @@ +nvme-solidigm-smart-log-add(1) +============================== + +NAME +---- +nvme-solidigm-smart-log-add - Retrieve Solidigm SMART Log + +SYNOPSIS +-------- +[verse] +'nvme solidigm smart-log-add' [--namespace-id= | -n ] + [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves the Solidigm vendor-specific SMART log for the given NVMe device +and optionally the specified namespace, then displays the log. + +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=:: + Retrieve the log for the given nsid. If not specified, the log + will be retrieved for all namespaces. + +-o :: +--output-format=:: + Set the reporting format to 'normal', 'json', or 'binary'. Only one + output format can be used at a time. + +EXAMPLES +-------- +* Retrieve the Solidigm SMART log for all namespaces: ++ +------------ +# nvme solidigm smart-log-add /dev/nvme0 +------------ + +* Retrieve the Solidigm SMART log for namespace 1: ++ +------------ +# nvme solidigm smart-log-add /dev/nvme0 -n 1 +------------ + +* Retrieve the Solidigm SMART log in JSON format: ++ +------------ +# nvme solidigm smart-log-add /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-temp-stats.1 b/Documentation/nvme-solidigm-temp-stats.1 new file mode 100644 index 0000000000..50e5b44cbc --- /dev/null +++ b/Documentation/nvme-solidigm-temp-stats.1 @@ -0,0 +1,93 @@ +'\" t +.\" Title: nvme-solidigm-temp-stats +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-TEMP" "1" "10/31/2024" "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-solidigm-temp-stats \- Retrieve Temperature Statistics log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm temp\-stats\fR [\-\-raw\-binary | \-b] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays the Temperature Statistics log for the given Solidigm NVMe device\&. This log provides detailed temperature\-related information\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-b, \-\-raw\-binary +.RS 4 +Dump output in binary format\&. This option will display the raw data instead of interpreting it\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the temperature statistics log: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm temp\-stats /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the temperature statistics log in raw binary format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm temp\-stats /dev/nvme0 \-\-raw\-binary +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-temp-stats.html b/Documentation/nvme-solidigm-temp-stats.html new file mode 100644 index 0000000000..d61c5fcc62 --- /dev/null +++ b/Documentation/nvme-solidigm-temp-stats.html @@ -0,0 +1,825 @@ + + + + + + +nvme-solidigm-temp-stats(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm temp-stats <device> [--raw-binary | -b]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays the Temperature Statistics log for the given Solidigm +NVMe device. This log provides detailed temperature-related information.

+

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

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

+ Dump output in binary format. This option will display the raw data + instead of interpreting it. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the temperature statistics log: +

    +
    +
    +
    # nvme solidigm temp-stats /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the temperature statistics log in raw binary format: +

    +
    +
    +
    # nvme solidigm temp-stats /dev/nvme0 --raw-binary
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-temp-stats.txt b/Documentation/nvme-solidigm-temp-stats.txt new file mode 100644 index 0000000000..f672382dbf --- /dev/null +++ b/Documentation/nvme-solidigm-temp-stats.txt @@ -0,0 +1,44 @@ +nvme-solidigm-temp-stats(1) +=========================== + +NAME +---- +nvme-solidigm-temp-stats - Retrieve Temperature Statistics log + +SYNOPSIS +-------- +[verse] +'nvme solidigm temp-stats' [--raw-binary | -b] + +DESCRIPTION +----------- +Retrieves and displays the Temperature Statistics log for the given Solidigm +NVMe device. This log provides detailed temperature-related information. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-b:: +--raw-binary:: + Dump output in binary format. This option will display the raw data + instead of interpreting it. + +EXAMPLES +-------- +* Retrieve and display the temperature statistics log: ++ +------------ +# nvme solidigm temp-stats /dev/nvme0 +------------ + +* Retrieve the temperature statistics log in raw binary format: ++ +------------ +# nvme solidigm temp-stats /dev/nvme0 --raw-binary +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-vs-drive-info.1 b/Documentation/nvme-solidigm-vs-drive-info.1 new file mode 100644 index 0000000000..cd3b63eaac --- /dev/null +++ b/Documentation/nvme-solidigm-vs-drive-info.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nvme-solidigm-vs-drive-info +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "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-solidigm-vs-drive-info \- Retrieve drive information +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-drive\-info\fR [\-\-output\-format= | \-o ] +.fi +.SH "DESCRIPTION" +.sp +Retrieves and displays vendor\-specific drive information for the given Solidigm NVMe device\&. This command provides additional details about the drive that may not be available through standard NVMe commands\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-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\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve and display the drive information: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-drive\-info /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve the drive information in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-drive\-info /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-vs-drive-info.html b/Documentation/nvme-solidigm-vs-drive-info.html new file mode 100644 index 0000000000..04b0c74632 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-drive-info.html @@ -0,0 +1,826 @@ + + + + + + +nvme-solidigm-vs-drive-info(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-drive-info <device> [--output-format=<fmt> | -o <fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

Retrieves and displays vendor-specific drive information for the given Solidigm +NVMe device. This command provides additional details about the drive that may +not be available through standard NVMe commands.

+

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

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve and display the drive information: +

    +
    +
    +
    # nvme solidigm vs-drive-info /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve the drive information in JSON format: +

    +
    +
    +
    # nvme solidigm vs-drive-info /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-drive-info.txt b/Documentation/nvme-solidigm-vs-drive-info.txt new file mode 100644 index 0000000000..8096b138ef --- /dev/null +++ b/Documentation/nvme-solidigm-vs-drive-info.txt @@ -0,0 +1,45 @@ +nvme-solidigm-vs-drive-info(1) +============================== + +NAME +---- +nvme-solidigm-vs-drive-info - Retrieve drive information + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-drive-info' [--output-format= | -o ] + +DESCRIPTION +----------- +Retrieves and displays vendor-specific drive information for the given Solidigm +NVMe device. This command provides additional details about the drive that may +not be available through standard NVMe commands. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format + can be used at a time. + +EXAMPLES +-------- +* Retrieve and display the drive information: ++ +------------ +# nvme solidigm vs-drive-info /dev/nvme0 +------------ + +* Retrieve the drive information in JSON format: ++ +------------ +# nvme solidigm vs-drive-info /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.1 b/Documentation/nvme-solidigm-vs-fw-activate-history.1 new file mode 100644 index 0000000000..b1d2e998af --- /dev/null +++ b/Documentation/nvme-solidigm-vs-fw-activate-history.1 @@ -0,0 +1,94 @@ +'\" t +.\" Title: nvme-solidigm-vs-fw-activate-history +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "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-solidigm-vs-fw-activate-history \- Get firmware activation history log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-fw\-activate\-history\fR [OPTIONS] +.fi +.SH "DESCRIPTION" +.sp +This command retrieves the firmware activation history log for Solidigm NVMe devices\&. It redirects to the OCP plug\-in for compatibility\&. +.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\&. Default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the firmware activation history log in normal format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-fw\-activate\-history /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the firmware activation history log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-fw\-activate\-history /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-cli suite diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.html b/Documentation/nvme-solidigm-vs-fw-activate-history.html new file mode 100644 index 0000000000..75a6c877ed --- /dev/null +++ b/Documentation/nvme-solidigm-vs-fw-activate-history.html @@ -0,0 +1,821 @@ + + + + + + +nvme-solidigm-vs-fw-activate-history(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-fw-activate-history <device> [OPTIONS]
+
+
+
+
+
+

DESCRIPTION

+
+

This command retrieves the firmware activation history log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility.

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the firmware activation history log in normal format: +

    +
    +
    +
    # nvme solidigm vs-fw-activate-history /dev/nvme0
    +
    +
    • +
  • +

    +Print the firmware activation history log in JSON format: +

    +
    +
    +
    # nvme solidigm vs-fw-activate-history /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-cli suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.txt b/Documentation/nvme-solidigm-vs-fw-activate-history.txt new file mode 100644 index 0000000000..cfe4e864ec --- /dev/null +++ b/Documentation/nvme-solidigm-vs-fw-activate-history.txt @@ -0,0 +1,39 @@ +nvme-solidigm-vs-fw-activate-history(1) +======================================= + +NAME +---- +nvme-solidigm-vs-fw-activate-history - Get firmware activation history log + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-fw-activate-history' [OPTIONS] + +DESCRIPTION +----------- +This command retrieves the firmware activation history log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility. + +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 +-------- +* Print the firmware activation history log in normal format: ++ +------------ +# nvme solidigm vs-fw-activate-history /dev/nvme0 +------------ + +* Print the firmware activation history log in JSON format: ++ +------------ +# nvme solidigm vs-fw-activate-history /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-cli suite diff --git a/Documentation/nvme-solidigm-vs-internal-log.1 b/Documentation/nvme-solidigm-vs-internal-log.1 new file mode 100644 index 0000000000..c30a350987 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-internal-log.1 @@ -0,0 +1,126 @@ +'\" t +.\" Title: nvme-solidigm-vs-internal-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "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-solidigm-vs-internal-log \- Retrieve Debug log binaries +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-internal\-log\fR [\-\-log\-type= | \-t ] + [\-\-output\-dir= | \-d ] + [\-\-verbose | \-v] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, retrieves the Solidigm vendor\-specific internal debug log binaries and saves them to the specified output directory\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.SH "OPTIONS" +.PP +\-t , \-\-log\-type= +.RS 4 +Specify the type of log to retrieve\&. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT\&. Defaults to ALL\&. +.RE +.PP +\-d , \-\-output\-dir= +.RS 4 +Specify the output directory for the log files\&. Defaults to the current working directory\&. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Enable verbose output for additional information during the log retrieval process\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve all internal logs and save them to the current directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-internal\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve a specific log type and save it to a custom directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-internal\-log /dev/nvme0 \-t NLOG \-d /tmp/logs +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Retrieve logs with verbose output: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-internal\-log /dev/nvme0 \-v +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-solidigm-vs-internal-log.html b/Documentation/nvme-solidigm-vs-internal-log.html new file mode 100644 index 0000000000..2ab4fab512 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-internal-log.html @@ -0,0 +1,857 @@ + + + + + + +nvme-solidigm-vs-internal-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-internal-log <device> [--log-type=<type> | -t <type>]
+                                          [--output-dir=<dir> | -d <dir>]
+                                          [--verbose | -v]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, retrieves the Solidigm vendor-specific internal +debug log binaries and saves them to the specified output directory.

+

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

+
+
+
+-t <type> +
+
+--log-type=<type> +
+
+

+ Specify the type of log to retrieve. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT. Defaults to ALL. +

+
+
+-d <dir> +
+
+--output-dir=<dir> +
+
+

+ Specify the output directory for the log files. Defaults to the current working directory. +

+
+
+-v +
+
+--verbose +
+
+

+ Enable verbose output for additional information during the log retrieval process. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Retrieve all internal logs and save them to the current directory: +

    +
    +
    +
    # nvme solidigm vs-internal-log /dev/nvme0
    +
    +
    • +
  • +

    +Retrieve a specific log type and save it to a custom directory: +

    +
    +
    +
    # nvme solidigm vs-internal-log /dev/nvme0 -t NLOG -d /tmp/logs
    +
    +
    • +
  • +

    +Retrieve logs with verbose output: +

    +
    +
    +
    # nvme solidigm vs-internal-log /dev/nvme0 -v
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-internal-log.txt b/Documentation/nvme-solidigm-vs-internal-log.txt new file mode 100644 index 0000000000..e488106b25 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-internal-log.txt @@ -0,0 +1,59 @@ +nvme-solidigm-vs-internal-log(1) +================================ + +NAME +---- +nvme-solidigm-vs-internal-log - Retrieve Debug log binaries + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-internal-log' [--log-type= | -t ] + [--output-dir= | -d ] + [--verbose | -v] + +DESCRIPTION +----------- +For the NVMe device given, retrieves the Solidigm vendor-specific internal +debug log binaries and saves them to the specified output directory. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1). + +OPTIONS +------- +-t :: +--log-type=:: + Specify the type of log to retrieve. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT. Defaults to ALL. + +-d :: +--output-dir=:: + Specify the output directory for the log files. Defaults to the current working directory. + +-v:: +--verbose:: + Enable verbose output for additional information during the log retrieval process. + +EXAMPLES +-------- +* Retrieve all internal logs and save them to the current directory: ++ +------------ +# nvme solidigm vs-internal-log /dev/nvme0 +------------ + +* Retrieve a specific log type and save it to a custom directory: ++ +------------ +# nvme solidigm vs-internal-log /dev/nvme0 -t NLOG -d /tmp/logs +------------ + +* Retrieve logs with verbose output: ++ +------------ +# nvme solidigm vs-internal-log /dev/nvme0 -v +------------ + +NVME +---- +Part of the nvme-user suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.1 b/Documentation/nvme-solidigm-vs-smart-add-log.1 new file mode 100644 index 0000000000..80f2bb5af2 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-smart-add-log.1 @@ -0,0 +1,94 @@ +'\" t +.\" Title: nvme-solidigm-vs-smart-add-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-VS\-" "1" "10/31/2024" "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-solidigm-vs-smart-add-log \- Get SMART / health extended log +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm vs\-smart\-add\-log\fR [OPTIONS] +.fi +.SH "DESCRIPTION" +.sp +This command retrieves the SMART / health extended log for Solidigm NVMe devices\&. It redirects to the OCP plug\-in for compatibility\&. +.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\&. Default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the SMART / health extended log in normal format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-smart\-add\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Print the SMART / health extended log in JSON format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme solidigm vs\-smart\-add\-log /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-cli suite diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.html b/Documentation/nvme-solidigm-vs-smart-add-log.html new file mode 100644 index 0000000000..24832aa717 --- /dev/null +++ b/Documentation/nvme-solidigm-vs-smart-add-log.html @@ -0,0 +1,821 @@ + + + + + + +nvme-solidigm-vs-smart-add-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme solidigm vs-smart-add-log <device> [OPTIONS]
+
+
+
+
+
+

DESCRIPTION

+
+

This command retrieves the SMART / health extended log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility.

+
+
+
+

OPTIONS

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

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

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Print the SMART / health extended log in normal format: +

    +
    +
    +
    # nvme solidigm vs-smart-add-log /dev/nvme0
    +
    +
    • +
  • +

    +Print the SMART / health extended log in JSON format: +

    +
    +
    +
    # nvme solidigm vs-smart-add-log /dev/nvme0 -o json
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-cli suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.txt b/Documentation/nvme-solidigm-vs-smart-add-log.txt new file mode 100644 index 0000000000..c1bf0c83ad --- /dev/null +++ b/Documentation/nvme-solidigm-vs-smart-add-log.txt @@ -0,0 +1,39 @@ +nvme-solidigm-vs-smart-add-log(1) +================================= + +NAME +---- +nvme-solidigm-vs-smart-add-log - Get SMART / health extended log + +SYNOPSIS +-------- +[verse] +'nvme solidigm vs-smart-add-log' [OPTIONS] + +DESCRIPTION +----------- +This command retrieves the SMART / health extended log for Solidigm NVMe devices. It redirects to the OCP plug-in for compatibility. + +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 +-------- +* Print the SMART / health extended log in normal format: ++ +------------ +# nvme solidigm vs-smart-add-log /dev/nvme0 +------------ + +* Print the SMART / health extended log in JSON format: ++ +------------ +# nvme solidigm vs-smart-add-log /dev/nvme0 -o json +------------ + +NVME +---- +Part of the nvme-cli suite \ No newline at end of file diff --git a/Documentation/nvme-solidigm-workload-tracker.1 b/Documentation/nvme-solidigm-workload-tracker.1 new file mode 100644 index 0000000000..444a91d8a9 --- /dev/null +++ b/Documentation/nvme-solidigm-workload-tracker.1 @@ -0,0 +1,221 @@ +'\" t +.\" Title: nvme-solidigm-workload-tracker +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/31/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-SOLIDIGM\-WORK" "1" "10/31/2024" "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-solidigm-workload-tracker \- Real\-time capture of Workload Tracker samples +.SH "SYNOPSIS" +.sp +.nf +\fInvme solidigm workload\-tracker\fR [\-\-enable | \-e] [\-\-disable | \-d] + [\-\-sample\-time=