summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-set-reg.txt
blob: 6fd6a4920cec6795e5057eb49ee4ba981ba30f0a (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
nvme-set-reg(1)
===============

NAME
----
nvme-set-reg - Writes and shows the defined NVMe controller register

SYNOPSIS
--------
[verse]
'nvme set-reg' <device> [--offset=<offset>, -O <offset>]
			[--value=<val> | -V <val>] [--mmio32 | -m]
			[--intms=<val>] [--intmc=<val>] [--cc=<val>]
			[--csts=<val>] [--nssr=<val>] [--aqa=<val>]
			[--asq=<val>] [--acq=<val>] [--bprsel=<val>]
			[--bpmbl=<val>] [--cmbmsc=<val>] [--nssd=<val>]
			[--pmrctl=<val>] [--pmrmscl=<val>] [--pmrmscu=<val>]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
Writes and shows the defined NVMe controller register.

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

-V <val>::
--value=<val>::
	the value of the register to be set

--mmio32::
-m::
	Access 64-bit registers as 2 32-bit

--intms=<val>::
	INTMS=0xc register offset

--intmc=<val>::
	INTMC=0x10 register offset

--cc=<val>::
	CC=0x14 register offset

--csts=<val>::
	CSTS=0x1c register offset

--nssr=<val>::
	NSSR=0x20 register offset

--aqa=<val>::
	AQA=0x24 register offset

--asq=<val>::
	ASQ=0x28 register offset

--acq=<val>::
	ACQ=0x30 register offset

--bprsel=<val>::
	BPRSEL=0x44 register offset

--bpmbl=<val>::
	BPMBL=0x48 register offset

--cmbmsc=<val>::
	CMBMSC=0x50 register offset

--nssd=<val>::
	NSSD=0x64 register offset

--pmrctl=<val>::
	PMRCTL=0xe04 register offset

--pmrmscl=<val>::
	PMRMSCL=0xe14 register offset

--pmrmscu=<val>::
	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.

EXAMPLES
--------
* The following will run the set-reg command with offset 0x14 and value 0x460000
+
------------
# nvme set-reg /dev/nvme0 -O 0x14 -V 0x460000
------------

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