Documentation: Added solidigm plugin commands

Added documentation to all current solidigm plugin commands

Signed-off-by: Leonardo da Cunha <[email protected]>

Documentation/meson.build

@@ -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',

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

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

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

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

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

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