From: Arunpandian J <arun.j@samsung.com>
Date: Wed, 23 Aug 2023 08:53:17 +0000 (+0530)
Subject: Documentation: Add document for DSSD Power state feature(FID: C7h)
X-Git-Tag: v2.6~39
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=b78bfe932218873db632ddb310d5a1a92c14b1ab;p=users%2Fsagi%2Fnvme-cli.git

Documentation: Add document for DSSD Power state feature(FID: C7h)

Signed-off-by: Arunpandian J <arun.j@samsung.com>
---

diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt
new file mode 100644
index 00000000..7dfe9ea8
--- /dev/null
+++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt
@@ -0,0 +1,42 @@
+set-dssd-power-state-feature(1)
+===============================
+
+NAME
+----
+nvme-ocp-set-dssd-power-state-feature - Set DSSD Power State
+
+SYNOPSIS
+--------
+[verse]
+'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 <format>::
+--power-state=<format>::
+	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.