From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Wed, 10 Apr 2024 21:41:32 +0200
Subject: Adding upstream version 2.8.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 Documentation/nvme-show-regs.txt | 67 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/nvme-show-regs.txt

(limited to 'Documentation/nvme-show-regs.txt')

diff --git a/Documentation/nvme-show-regs.txt b/Documentation/nvme-show-regs.txt
new file mode 100644
index 0000000..0460365
--- /dev/null
+++ b/Documentation/nvme-show-regs.txt
@@ -0,0 +1,67 @@
+nvme-id-ns(1)
+=============
+
+NAME
+----
+nvme-show-regs - Reads and shows the defined NVMe controller registers for
+NVMe over PCIe or the controller properties for NVMe over Fabrics.
+
+SYNOPSIS
+--------
+[verse]
+'nvme show-regs' <device> [--human-readable | -H]
+			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+For the NVMe over PCIe device given, sends an identify namespace command and
+provides the result and returned structure.
+For the NVMe over Fabrics device given, sends a fabric command and provides
+the result and returned structure.
+
+The <device> parameter is mandatory and must be the nvme admin character
+device (ex: /dev/nvme0). For NVMe over PCIe, the program uses knowledge of the
+sysfs layout to map the device to the pci resource stored there and mmaps the
+memory to get access to the registers. For NVMe over Fabrics, the programs
+sends a fabric command to get the properties of the target NVMe controller.
+Only the supported properties are displayed.
+
+OPTIONS
+-------
+-H::
+--human-readable::
+	Display registers or supported properties in human readable format.
+
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'json' or 'binary'. Only one
+	output format can be used at a time.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Show the NVMe over PCIe controller registers or the NVMe over Fabric controller
+properties in a binary format:
++
+------------
+# nvme show-regs /dev/nvme0 -o binary
+------------
+* Show the NVMe over PCIe controller registers or the NVMe over Fabric controller
+properties in a human readable format:
++
+------------
+# nvme show-regs /dev/nvme0 -H
+------------
+* Show the NVMe over PCIe controller registers or NVMe-oF controller properties
+in a json format:
++
+------------
+# nvme show-regs /dev/nvme0 -o json
+------------
+
+NVME
+----
+Part of the nvme-user suite
-- 
cgit v1.2.3