Add new sndk plugin for Sandisk drives

Documentation/cmd-plugins.txt

@@ -55,6 +55,87 @@ linknvme:nvme-netapp-ontapdevices[1]::
 linknvme:nvme-netapp-smdevices[1]::
 	Display information for each NVMe path to an E-Series volume
 
+linknvme:nvme-sndk-capabilities[1]::
+	Display Sandisk plugin command capabilities
+
+linknvme:nvme-sndk-clear-assert-dump[1]::
+	Clears the assert dump (if present)
+
+linknvme:nvme-sndk-clear-fw-activate-history[1]::
+	Clears the firmware activate history table
+
+linknvme:nvme-sndk-clear-pcie-correctable-errors[1]::
+	Clears the pcie correctable errors returned in the smart-log-add command
+
+linknvme:nvme-sndk-cloud-SSD-plugin-version[1]::
+	Display Sandisk plugin Cloud SSD Plugin Version
+
+linknvme:nvme-sndk-cloud-boot-SSD-version[1]::
+	Display Sandisk Cloud Boot SSD Version
+
+linknvme:nvme-sndk-drive-resize[1]::
+	Send NVMe Sandisk Resize Vendor Unique Command
+
+linknvme:nvme-sndk-get-drive-status[1]::
+	Send the NVMe Sandisk get-drive-status command
+
+linknvme:nvme-sndk-get-dev-capabilities-log[1]::
+	Display device capabilities og page data in human readable format
+
+linknvme:nvme-sndk-get-error-recovery-log[1]::
+	Display error recovery log page data in human readable format
+
+linknvme:nvme-sndk-get-latency-monitor-log[1]::
+	Display latency monitor log page data in human readable format
+
+linknvme:nvme-sndk-get-unsupported-reqs-log[1]::
+	Display unsupported requirements log page data in human readable format
+
+linknvme:nvme-sndk-log-page-directory[1]::
+	Retrieves the list of Log IDs supported by the drive
+
+linknvme:nvme-sndk-namespace-resize[1]::
+	Resizes the device's namespace
+
+linknvme:nvme-sndk-set-latency-monitor-feature[1]::
+	Set Latency Monitor feature
+
+linknvme:nvme-sndk-vs-cloud-log[1]::
+	Display the cloud log page
+
+linknvme:nvme-sndk-vs-device-waf[1]::
+	Display calculated device Write Amplication Factor
+
+linknvme:nvme-sndk-vs-drive-info[1]::
+	Send the NVMe Sandisk vs-drive-info command
+
+linknvme:nvme-sndk-vs-error-reason-identifier[1]::
+	Retrieve Sandisk device's telemetry log error reason identifier field
+
+linknvme:nvme-sndk-vs-fw-activate-history[1]::
+	Execute NVMe Sandisk vs-fw-activate-history Vendor Unique Command
+
+linknvme:nvme-sndk-vs-hw-rev-log[1]::
+	Display hardware revision log page
+
+linknvme:nvme-sndk-vs-internal-log[1]::
+	Retrieve Sandisk device's internal firmware log and save to file
+
+linknvme:nvme-sndk-vs-nand-stats[1]::
+	Send NVMe Sandisk vs-nand-stats Vendor Unique Command
+
+linknvme:nvme-sndk-vs-pcie-stats[1]::
+	Send the NVMe Sandisk vs-pcie-stats command
+
+linknvme:nvme-sndk-vs-smart-add-log[1]::
+	Send NVMe Sandisk smart add log Vendor Unique Command
+
+linknvme:nvme-sndk-vs-telemetry-controller-option[1]::
+	Disable/Enable the controller initiated option of the telemetry log page
+
+linknvme:nvme-sndk-vs-temperature-stats[1]::
+	Display temperature-related statistics
+
 linknvme:nvme-toshiba-clear-pcie-correctable-errors[1]::
 	Reset the PCIe correctable errors count to zero
 

Documentation/meson.build

@@ -144,6 +144,33 @@ adoc_sources = [
   'nvme-show-regs',
   'nvme-show-topology',
   'nvme-smart-log',
+  'nvme-sndk-capabilities',
+  'nvme-sndk-clear-assert-dump',
+  'nvme-sndk-clear-fw-activate-history',
+  'nvme-sndk-clear-pcie-correctable-errors',
+  'nvme-sndk-cloud-SSD-plugin-version',
+  'nvme-sndk-cloud-boot-SSD-version',
+  'nvme-sndk-drive-resize',
+  'nvme-sndk-get-drive-status',
+  'nvme-sndk-get-dev-capabilities-log',
+  'nvme-sndk-get-error-recovery-log',
+  'nvme-sndk-get-latency-monitor-log',
+  'nvme-sndk-get-unsupported-reqs-log',
+  'nvme-sndk-log-page-directory',
+  'nvme-sndk-namespace-resize',
+  'nvme-sndk-set-latency-monitor-feature',
+  'nvme-sndk-vs-cloud-log',
+  'nvme-sndk-vs-device-waf',
+  'nvme-sndk-vs-drive-info',
+  'nvme-sndk-vs-error-reason-identifier',
+  'nvme-sndk-vs-fw-activate-history',
+  'nvme-sndk-vs-hw-rev-log',
+  'nvme-sndk-vs-internal-log',
+  'nvme-sndk-vs-nand-stats',
+  'nvme-sndk-vs-pcie-stats',
+  'nvme-sndk-vs-smart-add-log',
+  'nvme-sndk-vs-telemetry-controller-option',
+  'nvme-sndk-vs-temperature-stats',
   'nvme-solidigm-clear-fw-activate-history',
   'nvme-solidigm-clear-pcie-correctable-errors',
   'nvme-solidigm-cloud-SSDplugin-version',

Documentation/nvme-sndk-capabilities.txt

@@ -0,0 +1,32 @@
+nvme-sndk-capabilities(1)
+=========================
+
+NAME
+----
+nvme-sndk-capabilities - Display sndk device command capabilities
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk capabilities' <device>
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, displays list of commands and support status.
+
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+EXAMPLES
+--------
+* Displays the capabilities for the device:
++
+------------
+# nvme sndk capabilities /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.

Documentation/nvme-sndk-clear-assert-dump.txt

@@ -0,0 +1,38 @@
+nvme-sndk-clear-assert-dump(1)
+==============================
+
+NAME
+----
+nvme-sndk-clear-assert-dump - Clears the assert dump (if present).
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk clear-assert-dump' <device>
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the sndk vendor unique clear assert
+dump command.
+
+The <device> parameter is mandatory and must be the NVMe character
+device (ex: /dev/nvme0).
+
+This will only work on Sandisk devices supporting this feature.
+The command will not be executed on devices that don't support it.
+
+OPTIONS
+-------
+None
+
+EXAMPLES
+--------
+* Clears the assert dump (if present):
++
+------------
+# nvme sndk clear-assert-dump /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite

Documentation/nvme-sndk-clear-fw-activate-history.txt

@@ -0,0 +1,37 @@
+nvme-sndk-clear-fw-activate-history(1)
+======================================
+
+NAME
+----
+nvme-sndk-clear-fw-activate-history - Clears the firmware activate history table.
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk clear-fw-activate-history' <device>
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the sndk vendor unique clear fw activate
+history command.
+
+The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).
+
+This will only work on Sandisk devices supporting this feature.
+Results for any other device are undefined.
+
+OPTIONS
+-------
+None
+
+EXAMPLES
+--------
+* Clears the firmware activate history table:
++
+------------
+# nvme sndk clear-fw-activate-history /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite

Documentation/nvme-sndk-clear-pcie-correctable-errors.txt

@@ -0,0 +1,39 @@
+nvme-sndk-clear-pcie-correctable-errors(1)
+==========================================
+
+NAME
+----
+nvme-sndk-clear-pcie-correctable-errors - Clears the pcie correctable errors field returned in the smart-log-add command.
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk clear-pcie-correctable-errors' <device>
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends the sndk vendor unique clear pcie
+correctable errors command.
+
+The <device> parameter is mandatory and may be either the NVMe
+character device (ex: /dev/nvme0), or a namespace block device (ex:
+/dev/nvme0n1).
+
+This will only work on Sandisk devices supporting this feature.
+Results for any other device are undefined.
+
+OPTIONS
+-------
+None
+
+EXAMPLES
+--------
+* Clears the PCIe Correctable Error Count field returned in the smart-log-add command:
++
+------------
+# nvme sndk clear-pcie-correctable-errors /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite

Documentation/nvme-sndk-cloud-SSD-plugin-version.txt

@@ -0,0 +1,33 @@
+nvme-sndk-cloud-SSD-plugin-version(1)
+=====================================
+
+NAME
+----
+nvme-sndk-cloud-SSD-plugin-version - Display sndk plugin Cloud SSD Plugin Version
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk cloud-SSD-plugin-version' <device>
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, this command displays the current Cloud SSD
+Plugin Version (if supported by the device).
+
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+EXAMPLES
+--------
+* Displays the cloud ssd plugin version for the device:
++
+------------
+# nvme sndk cloud-SSD-plugin-version /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.

Documentation/nvme-sndk-cloud-boot-SSD-version.txt

@@ -0,0 +1,33 @@
+nvme-sndk-cloud-boot-SSD-version(1)
+===================================
+
+NAME
+----
+nvme-sndk-cloud-boot-SSD-version - Display sndk plugin Cloud Boot SSD Version
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk cloud-boot-SSD-version' <device>
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, this command displays the current Cloud Hyperscale
+Boot Version (if supported by the device).
+
+The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
+
+On success it returns 0, error code otherwise.
+
+EXAMPLES
+--------
+* Displays the cloud boot ssd version for the device:
++
+------------
+# nvme sndk cloud-boot-SSD-version /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.

Documentation/nvme-sndk-drive-resize.txt

@@ -0,0 +1,42 @@
+nvme-sndk-drive-resize(1)
+=========================
+
+NAME
+----
+nvme-sndk-drive-resize - Send NVMe sndk Resize Vendor Unique Command,
+return result.
+
+SYNOPSIS
+--------
+[verse]
+'nvme sndk drive-resize' <device> [--size=<sz> | -s <sz>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends a Vendor Unique sndk Resize command.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+This will only work on Sandisk devices supporting this feature.
+Results for any other device are undefined.
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-s <sz>::
+--size=<sz>::
+	The new size (in GB) to resize the drive to.
+
+EXAMPLES
+--------
+* Has the program issue sndk Resize Vendor Unique Command :
++
+------------
+# nvme sndk drive-resize /dev/nvme0n1 --size=100
+------------
+
+NVME
+----
+Part of the nvme-user suite.