summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_cc.2
blob: 8c4a2dd57b32e818486e3f16dd28ed4c602ecdf7 (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
.TH "libnvme" 9 "enum nvme_cc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cc \- This field indicates the controller configuration
.SH SYNOPSIS
enum nvme_cc {
.br
.BI "    NVME_CC_EN_SHIFT"
, 
.br
.br
.BI "    NVME_CC_CSS_SHIFT"
, 
.br
.br
.BI "    NVME_CC_MPS_SHIFT"
, 
.br
.br
.BI "    NVME_CC_AMS_SHIFT"
, 
.br
.br
.BI "    NVME_CC_SHN_SHIFT"
, 
.br
.br
.BI "    NVME_CC_IOSQES_SHIFT"
, 
.br
.br
.BI "    NVME_CC_IOCQES_SHIFT"
, 
.br
.br
.BI "    NVME_CC_CRIME_SHIFT"
, 
.br
.br
.BI "    NVME_CC_EN_MASK"
, 
.br
.br
.BI "    NVME_CC_CSS_MASK"
, 
.br
.br
.BI "    NVME_CC_MPS_MASK"
, 
.br
.br
.BI "    NVME_CC_AMS_MASK"
, 
.br
.br
.BI "    NVME_CC_SHN_MASK"
, 
.br
.br
.BI "    NVME_CC_CRIME_MASK"
, 
.br
.br
.BI "    NVME_CC_IOSQES_MASK"
, 
.br
.br
.BI "    NVME_CC_IOCQES_MASK"
, 
.br
.br
.BI "    NVME_CC_CSS_NVM"
, 
.br
.br
.BI "    NVME_CC_CSS_CSI"
, 
.br
.br
.BI "    NVME_CC_CSS_ADMIN"
, 
.br
.br
.BI "    NVME_CC_AMS_RR"
, 
.br
.br
.BI "    NVME_CC_AMS_WRRU"
, 
.br
.br
.BI "    NVME_CC_AMS_VS"
, 
.br
.br
.BI "    NVME_CC_SHN_NONE"
, 
.br
.br
.BI "    NVME_CC_SHN_NORMAL"
, 
.br
.br
.BI "    NVME_CC_SHN_ABRUPT"
, 
.br
.br
.BI "    NVME_CC_CRWME"
, 
.br
.br
.BI "    NVME_CC_CRIME"

};
.SH Constants
.IP "NVME_CC_EN_SHIFT" 12
Shift amount to get the enable
.IP "NVME_CC_CSS_SHIFT" 12
Shift amount to get the I/O command set selected
.IP "NVME_CC_MPS_SHIFT" 12
Shift amount to get the memory page size
.IP "NVME_CC_AMS_SHIFT" 12
Shift amount to get the arbitration mechanism selected
.IP "NVME_CC_SHN_SHIFT" 12
Shift amount to get the shutdown notification
.IP "NVME_CC_IOSQES_SHIFT" 12
Shift amount to get the I/O submission queue entry size
.IP "NVME_CC_IOCQES_SHIFT" 12
Shift amount to get the I/O completion queue entry size
.IP "NVME_CC_CRIME_SHIFT" 12
Shift amount to get the controller ready independent of media enable
.IP "NVME_CC_EN_MASK" 12
Mask to get the enable
.IP "NVME_CC_CSS_MASK" 12
Mask to get the I/O command set selected
.IP "NVME_CC_MPS_MASK" 12
Mask to get the memory page size
.IP "NVME_CC_AMS_MASK" 12
Mask to get the arbitration mechanism selected
.IP "NVME_CC_SHN_MASK" 12
Mask to get the shutdown notification
.IP "NVME_CC_CRIME_MASK" 12
Mask to get the I/O submission queue entry size
.IP "NVME_CC_IOSQES_MASK" 12
Mask to get the I/O completion queue entry size
.IP "NVME_CC_IOCQES_MASK" 12
Mask to get the controller ready independent of media enable
.IP "NVME_CC_CSS_NVM" 12
NVM command set
.IP "NVME_CC_CSS_CSI" 12
All supported I/O command sets
.IP "NVME_CC_CSS_ADMIN" 12
Admin command set only
.IP "NVME_CC_AMS_RR" 12
Round robin
.IP "NVME_CC_AMS_WRRU" 12
Weighted round robin with urgent priority class
.IP "NVME_CC_AMS_VS" 12
Vendor specific
.IP "NVME_CC_SHN_NONE" 12
No notification; no effect
.IP "NVME_CC_SHN_NORMAL" 12
Normal shutdown notification
.IP "NVME_CC_SHN_ABRUPT" 12
Abrupt shutdown notification
.IP "NVME_CC_CRWME" 12
Controller ready with media enable
.IP "NVME_CC_CRIME" 12
Controller ready independent of media enable