]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
Documentation: Added solidigm plugin commands
authorLeonardo da Cunha <leonardo.da.cunha@solidigm.com>
Wed, 18 Sep 2024 03:36:46 +0000 (20:36 -0700)
committerDaniel Wagner <wagi@monom.org>
Wed, 2 Oct 2024 07:54:13 +0000 (09:54 +0200)
Added documentation to all current solidigm plugin commands

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>
17 files changed:
Documentation/meson.build
Documentation/nvme-solidigm-clear-fw-activate-history.txt [new file with mode: 0644]
Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt [new file with mode: 0644]
Documentation/nvme-solidigm-cloud-SSDplugin-version.txt [new file with mode: 0644]
Documentation/nvme-solidigm-garbage-collect-log.txt [new file with mode: 0644]
Documentation/nvme-solidigm-id-ctrl.txt [new file with mode: 0644]
Documentation/nvme-solidigm-latency-tracking-log.txt [new file with mode: 0644]
Documentation/nvme-solidigm-log-page-directory.txt [new file with mode: 0644]
Documentation/nvme-solidigm-market-log.txt [new file with mode: 0644]
Documentation/nvme-solidigm-parse-telemetry-log.txt [new file with mode: 0644]
Documentation/nvme-solidigm-smart-log-add.txt [new file with mode: 0644]
Documentation/nvme-solidigm-temp-stats.txt [new file with mode: 0644]
Documentation/nvme-solidigm-vs-drive-info.txt [new file with mode: 0644]
Documentation/nvme-solidigm-vs-fw-activate-history.txt [new file with mode: 0644]
Documentation/nvme-solidigm-vs-internal-log.txt [new file with mode: 0644]
Documentation/nvme-solidigm-vs-smart-add-log.txt [new file with mode: 0644]
Documentation/nvme-solidigm-workload-tracker.txt [new file with mode: 0644]

index 4e8ffcad2609c45e26046df3a35a28bf1e742a8e..65495e3cceee6a4b83b9f5c02dbf7b3cdf7a8195 100644 (file)
@@ -143,6 +143,22 @@ 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',
diff --git a/Documentation/nvme-solidigm-clear-fw-activate-history.txt b/Documentation/nvme-solidigm-clear-fw-activate-history.txt
new file mode 100644 (file)
index 0000000..ac74728
--- /dev/null
@@ -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' <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-pcie-correctable-errors.txt b/Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt
new file mode 100644 (file)
index 0000000..3f5883d
--- /dev/null
@@ -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' <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-cloud-SSDplugin-version.txt b/Documentation/nvme-solidigm-cloud-SSDplugin-version.txt
new file mode 100644 (file)
index 0000000..5d17e47
--- /dev/null
@@ -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.txt b/Documentation/nvme-solidigm-garbage-collect-log.txt
new file mode 100644 (file)
index 0000000..77e1be3
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-id-ctrl.txt b/Documentation/nvme-solidigm-id-ctrl.txt
new file mode 100644 (file)
index 0000000..7ac67e3
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-latency-tracking-log.txt b/Documentation/nvme-solidigm-latency-tracking-log.txt
new file mode 100644 (file)
index 0000000..91940dc
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-log-page-directory.txt b/Documentation/nvme-solidigm-log-page-directory.txt
new file mode 100644 (file)
index 0000000..8a8b175
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-market-log.txt b/Documentation/nvme-solidigm-market-log.txt
new file mode 100644 (file)
index 0000000..1b5e268
--- /dev/null
@@ -0,0 +1,42 @@
+nvme-solidigm-market-log(1)
+===========================
+
+NAME
+----
+nvme-solidigm-market-log - Retrieve Market Log
+
+SYNOPSIS
+--------
+[verse]
+'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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-parse-telemetry-log.txt b/Documentation/nvme-solidigm-parse-telemetry-log.txt
new file mode 100644 (file)
index 0000000..38a678b
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-smart-log-add.txt b/Documentation/nvme-solidigm-smart-log-add.txt
new file mode 100644 (file)
index 0000000..5a9b92c
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-temp-stats.txt b/Documentation/nvme-solidigm-temp-stats.txt
new file mode 100644 (file)
index 0000000..f672382
--- /dev/null
@@ -0,0 +1,44 @@
+nvme-solidigm-temp-stats(1)
+===========================
+
+NAME
+----
+nvme-solidigm-temp-stats - Retrieve Temperature Statistics log
+
+SYNOPSIS
+--------
+[verse]
+'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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-vs-drive-info.txt b/Documentation/nvme-solidigm-vs-drive-info.txt
new file mode 100644 (file)
index 0000000..8096b13
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-vs-fw-activate-history.txt b/Documentation/nvme-solidigm-vs-fw-activate-history.txt
new file mode 100644 (file)
index 0000000..cfe4e86
--- /dev/null
@@ -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' <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-internal-log.txt b/Documentation/nvme-solidigm-vs-internal-log.txt
new file mode 100644 (file)
index 0000000..e488106
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-vs-smart-add-log.txt b/Documentation/nvme-solidigm-vs-smart-add-log.txt
new file mode 100644 (file)
index 0000000..c1bf0c8
--- /dev/null
@@ -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' <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
\ No newline at end of file
diff --git a/Documentation/nvme-solidigm-workload-tracker.txt b/Documentation/nvme-solidigm-workload-tracker.txt
new file mode 100644 (file)
index 0000000..d1f0b3a
--- /dev/null
@@ -0,0 +1,104 @@
+nvme-solidigm-workload-tracker(1)
+=================================
+
+NAME
+----
+nvme-solidigm-workload-tracker - Real-time capture of Workload Tracker samples
+
+SYNOPSIS
+--------
+[verse]
+'nvme solidigm workload-tracker' <device> [--enable | -e] [--disable | -d]
+                                      [--sample-time=<time> | -s <time>]
+                                      [--type=<type> | -t <type>]
+                                      [--run-time=<seconds> | -r <seconds>]
+                                      [--flush-freq=<count> | -f <count>]
+                                      [--wall-clock | -w]
+                                      [--trigger-field=<field> | -T <field>]
+                                      [--trigger-threshold=<value> | -V <value>]
+                                      [--trigger-on-delta | -D]
+                                      [--trigger-on-latency | -L]
+                                      [--verbose | -v]
+
+DESCRIPTION
+-----------
+Captures and displays real-time workload tracker samples for the given Solidigm
+NVMe device. This command allows for monitoring and analysis of the device's
+workload 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
+-------
+-e, --enable::
+    Enable the workload tracker before capturing samples.
+
+-d, --disable::
+    Disable the workload tracker after capturing samples.
+
+-s <time>, --sample-time=<time>::
+    Set the sample interval. Valid values are: default, 1ms, 5ms, 10ms, 50ms, 100ms, 500ms, 1s, 5s, 10s, 30s, 1m, 5m, 10m, 30m, 1h.
+
+-t <type>, --type=<type>::
+    Set the tracker type. Valid types are: Base, CmdQ, Pattern, RandSeq, Throttle, Power, Defrag.
+
+-r <seconds>, --run-time=<seconds>::
+    Limit runtime capture time in seconds.
+
+-f <count>, --flush-freq=<count>::
+    Number of samples (1 to 126) to wait before extracting data. Default is 100 samples.
+
+-w, --wall-clock::
+    Log current wall timestamp when entry was retrieved.
+
+-T <field>, --trigger-field=<field>::
+    Field name to stop trigger on.
+
+-V <value>, --trigger-threshold=<value>::
+    Field value to trigger stop sampling.
+
+-D, --trigger-on-delta::
+    Trigger on delta to stop sampling.
+
+-L, --trigger-on-latency::
+    Use latency tracker to trigger stop sampling.
+
+-v, --verbose::
+    Increase logging verbosity. Can be used multiple times.
+
+EXAMPLES
+--------
+* Enable the workload tracker and capture samples:
++
+------------
+# nvme solidigm workload-tracker /dev/nvme0 --enable
+------------
+
+* Capture workload tracker samples with a 1ms interval for 60 seconds:
++
+------------
+# nvme solidigm workload-tracker /dev/nvme0 --enable --sample-time=1ms --run-time=60
+------------
+
+* Disable the workload tracker:
++
+------------
+# nvme solidigm workload-tracker /dev/nvme0 --disable
+------------
+
+* Enable the workload tracker and capture samples with a specific sample time and type:
++
+------------
+# nvme solidigm workload-tracker /dev/nvme0 --enable --sample-time=1ms --type=Base
+------------
+
+* Capture Power tracker samples with a 10-second interval for 5 minutes:
++
+------------
+# nvme solidigm workload-tracker /dev/nvme0 --enable --type=Power --sample-time=10s --run-time=300
+------------
+
+NVME
+----
+Part of the nvme-user suite
\ No newline at end of file