From: Jeff Lien <jeff.lien@wdc.com>
Date: Wed, 13 Apr 2022 19:12:01 +0000 (-0500)
Subject: doc: Add/update man page files for WDC plugin command changes
X-Git-Tag: v2.1-rc0~66^2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=106bb3ddccd635a7697ab1674aaf517f07cdefba;p=users%2Fsagi%2Fnvme-cli.git

doc: Add/update man page files for WDC plugin command changes

Signed-off-by: Jeff Lien <jeff.lien@wdc.com>
---

diff --git a/Documentation/meson.build b/Documentation/meson.build
index a12eec4d..ef8a46a1 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -114,6 +114,7 @@ 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-drive-essentials',
   'nvme-wdc-drive-log',
@@ -131,9 +132,11 @@ adoc_sources = [
   'nvme-wdc-namespace-resize',
   'nvme-wdc-purge',
   'nvme-wdc-purge-monitor',
+  'nvme-wdc-vs-cloud-log',
   'nvme-wdc-vs-drive-info',
   'nvme-wdc-vs-error-reason-identifier',
   'nvme-wdc-vs-fw-activate-history',
+  'nvme-wdc-vs-hw-rev-log',
   'nvme-wdc-vs-internal-log',
   'nvme-wdc-vs-nand-stats',
   'nvme-wdc-vs-smart-add-log',
diff --git a/Documentation/nvme-wdc-cloud-boot-SSD-version.txt b/Documentation/nvme-wdc-cloud-boot-SSD-version.txt
new file mode 100644
index 00000000..a3f105e2
--- /dev/null
+++ b/Documentation/nvme-wdc-cloud-boot-SSD-version.txt
@@ -0,0 +1,33 @@
+nvme-wdc-cloud-boot-SSD-version(1)
+==================================
+
+NAME
+----
+nvme-wdc-cloud-boot-SSD-version - Display WDC plugin Cloud Boot SSD Version
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc 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 wdc cloud-boot-SSD-version /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
diff --git a/Documentation/nvme-wdc-vs-cloud-log.txt b/Documentation/nvme-wdc-vs-cloud-log.txt
new file mode 100644
index 00000000..9eeee421
--- /dev/null
+++ b/Documentation/nvme-wdc-vs-cloud-log.txt
@@ -0,0 +1,52 @@
+nvme-wdc-vs-cloud-log(1)
+========================
+
+NAME
+----
+nvme-wdc-vs-cloud-log - Send NVMe WDC vs-cloud-log Vendor Unique Command, return result
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc vs-cloud-log' <device> [--output-format=<normal|json> -o <normal|json>]
+			[--namespace-id=<nsid> | -n <nsid>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send a Vendor Unique WDC vs-cloud-log command and
+provide the smart/health 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 WDC devices supporting this feature.
+Results for any other device are undefined.
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+	Set the reporting format to 'normal', or
+	'json'. Only one output format can be used at a time.
+	Default is normal.
+
+-n <nsid>::
+--namespace-id=<nsid>::
+	Sets the command's nsid value to the given nsid. Defaults to
+	0xffffffff if not given. This option may not affect anything
+	depending on the log page, which may or may not be specific to
+	a namespace.
+
+EXAMPLES
+--------
+* Has the program issue WDC vs-cloud-log Vendor Unique Command :
++
+------------
+# nvme wdc vs-cloud-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
diff --git a/Documentation/nvme-wdc-vs-drive-info.txt b/Documentation/nvme-wdc-vs-drive-info.txt
index 15e7c6b7..0cfdd7a2 100644
--- a/Documentation/nvme-wdc-vs-drive-info.txt
+++ b/Documentation/nvme-wdc-vs-drive-info.txt
@@ -25,12 +25,19 @@ On success it returns 0, error code otherwise.
 
 Output Explanation
 ------------------
-There are 2 fields returned from this command:
+There are several different fields returned from this command depending
+on the drive:
 
 Drive HW Revision
 
 FTL Unit Size
 
+Customer Serial Number
+
+HyperScale Boot Version
+
+TCG Device Ownership
+
 
 EXAMPLE
 --------
diff --git a/Documentation/nvme-wdc-vs-hw-rev-log.txt b/Documentation/nvme-wdc-vs-hw-rev-log.txt
new file mode 100644
index 00000000..c5335d95
--- /dev/null
+++ b/Documentation/nvme-wdc-vs-hw-rev-log.txt
@@ -0,0 +1,51 @@
+nvme-wdc-vs-hw-rev-log(1)
+=========================
+
+NAME
+----
+nvme-wdc-vs-hw-rev-log - Send NVMe WDC vs-hw-rev-log Vendor Unique Command, return result
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc vs-hw-rev-log' <device> [--output-format=<normal|json> -o <normal|json>]
+			[--namespace-id=<nsid> | -n <nsid>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, retrieves and formats the Vendor Unique WDC hw revision 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 WDC devices supporting this feature.
+Results for any other device are undefined.
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+	Set the reporting format to 'normal', or
+	'json'. Only one output format can be used at a time.
+	Default is normal.
+
+-n <nsid>::
+--namespace-id=<nsid>::
+	Sets the command's nsid value to the given nsid. Defaults to
+	0xffffffff if not given. This option may not affect anything
+	depending on the log page, which may or may not be specific to
+	a namespace.
+
+EXAMPLES
+--------
+* Has the program issue WDC vs-hw-rev-log plugin Command :
++
+------------
+# nvme wdc vs-hw-rev-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.