From: Arunpandian J <arun.j@samsung.com>
Date: Wed, 17 May 2023 13:25:36 +0000 (+0530)
Subject: Documentation: Add document for OCP Device capability(LID: 0xC4) log page
X-Git-Tag: v2.5~96
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=372b4b0fd0616111ed89564ddbc1a7f9a160c1f8;p=users%2Fsagi%2Fnvme-cli.git

Documentation: Add document for OCP Device capability(LID: 0xC4) log page

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

diff --git a/Documentation/nvme-ocp-device-capability-log.txt b/Documentation/nvme-ocp-device-capability-log.txt
new file mode 100644
index 00000000..77895319
--- /dev/null
+++ b/Documentation/nvme-ocp-device-capability-log.txt
@@ -0,0 +1,42 @@
+nvme-ocp-device-capability-log(1)
+=================================
+
+NAME
+----
+nvme-ocp-device-capability-log - Retrieves OCP Device Capability Log Page
+
+SYNOPSIS
+--------
+[verse]
+'nvme ocp device-capability-log' <device> [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, retrieves OCP Device Capability 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 OCP compliant 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' or 'binary'. 
+	Only one output format can be used at a time. The default is normal.
+
+EXAMPLES
+--------
+* Has the program issue a device-capability-log command to retrieve the 0xC4 log page.
++
+------------
+# nvme ocp device-capability-log /dev/nvme0 -o normal
+------------
+
+NVME
+----
+Part of the nvme-user suite.