summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-get-property.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-get-property.txt')
-rw-r--r--Documentation/nvme-get-property.txt68
1 files changed, 68 insertions, 0 deletions
diff --git a/Documentation/nvme-get-property.txt b/Documentation/nvme-get-property.txt
new file mode 100644
index 0000000..601b8a4
--- /dev/null
+++ b/Documentation/nvme-get-property.txt
@@ -0,0 +1,68 @@
+nvme-get-property(1)
+====================
+
+NAME
+----
+nvme-get-property - Reads and shows the defined NVMe controller property
+for NVMe over Fabric
+
+SYNOPSIS
+--------
+[verse]
+'nvme get-property' <device> [--offset=<offset> | -O <offset>]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Reads and shows the defined NVMe controller property for NVMe over Fabric.
+
+OPTIONS
+-------
+-O::
+--offset::
+ The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
+
+-H::
+--human-readable:
+ Show the fields packed in the property
+
+-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
+--------
+* The following will run the get-property command with offset 0
++
+------------
+# nvme get-property /dev/nvme0 --offset=0x0 --human-readable
+------------
+
+BUGS
+----
+Currently the CAP value is truncated to 32 bits due to a limitation in
+the ioctl interface.
+
+In a recent enough kernel, the 64 bit value is shown in kernel traces.
+
+* First enable traces by this command
++
+------------
+# echo 1 > /sys/kernel/debug/tracing/events/nvme/enable
+------------
+
+* Then look for NVMe Fabrics command (0x7f) at trace
++
+------------
+/sys/kernel/debug/tracing/trace
+------------
+
+NVME
+----
+Part of the nvme-user suite