summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-get-reg.txt
blob: 5e9cd950a474afaa20e3455ff4b5ff366f1193b0 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
nvme-get-reg(1)
===============

NAME
----
nvme-get-reg - Read and show the defined NVMe controller register

SYNOPSIS
--------
[verse]
'nvme get-reg' <device> [--offset=<offset>, -O <offset>] [--human-readable | -H]
			[--cap] [--vs] [--cmbloc] [--cmbsz] [--bpinfo]
			[--cmbsts] [--cmbebs] [--cmbswtp] [--crto] [--pmrcap]
			[--pmrsts] [--pmrebs] [--pmrswtp] [--intms] [--intmc]
			[--cc] [--csts] [--nssr] [--aqa] [--asq] [--acq]
			[--bprsel] [--bpmbl] [--cmbmsc] [--nssd] [--pmrctl]
			[--pmrmscl] [--pmrmscu]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
			[--timeout=<timeout> | -t <timeout>]

DESCRIPTION
-----------
Read and show the defined NVMe controller register.

OPTIONS
-------
-O <offset>::
--offset=<offset>::
	offset of the requested register

-H::
--human-readable::
	show register in readable format

--cap::
	CAP=0x0 register offset

--vs::
	VS=0x8 register offset

--cmbloc::
	CMBLOC=0x38 register offset

--cmbsz::
	CMBSZ=0x3c register offset

--bpinfo::
	BPINFO=0x40 register offset

--cmbsts::
	CMBSTS=0x58 register offset

--cmbebs::
	CMBEBS=0x5c register offset

--cmbswtp::
	CMBSWTP=0x60 register offset

--crto::
	CRTO=0x68 register offset

--pmrcap::
	PMRCAP=0xe00 register offset

--pmrsts::
	PMRSTS=0xe08 register offset

--pmrebs::
	PMREBS=0xe0c register offset

--pmrswtp::
	PMRSWTP=0xe10 register offset

--intms::
	INTMS=0xc register offset

--intmc::
	INTMC=0x10 register offset

--cc::
	CC=0x14 register offset

--csts::
	CSTS=0x1c register offset

--nssr::
	NSSR=0x20 register offset

--aqa::
	AQA=0x24 register offset

--asq::
	ASQ=0x28 register offset

--acq::
	ACQ=0x30 register offset

--bprsel::
	BPRSEL=0x44 register offset

--bpmbl::
	BPMBL=0x48 register offset

--cmbmsc::
	CMBMSC=0x50 register offset

--nssd::
	NSSD=0x64 register offset

--pmrctl::
	PMRCTL=0xe04 register offset

--pmrmscl::
	PMRMSCL=0xe14 register offset

--pmrmscu::
	PMRMSCU=0xe18 register offset

-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.

-t <timeout>::
--timeout=<timeout>::
	Override default timeout value. In milliseconds.

EXAMPLES
--------
* The following will run the get-reg command with CC=0x14 register offset
+
------------
# nvme get-reg /dev/nvme0 --cc
register: 0x0014 (Controller Configuration), value: 0x460001
------------

NVME
----
Part of the nvme-user suite.