summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-get-property.txt
blob: bee65d11b58dca315fdf3d592adcf9c59ef06755 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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>::
--offset=<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