summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_cap.2
blob: 403901a0ba19298604b37f176f1ce39ed06bf9a8 (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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
.TH "libnvme" 9 "enum nvme_cap" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cap \- This field indicates the controller capabilities register
.SH SYNOPSIS
enum nvme_cap {
.br
.BI "    NVME_CAP_MQES_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_CQR_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_AMS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_TO_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_DSTRD_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_NSSRC_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_CSS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_BPS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_CPS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_MPSMIN_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_MPSMAX_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_PMRS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_CMBS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_NSSS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_CRMS_SHIFT"
, 
.br
.br
.BI "    NVME_CAP_MQES_MASK"
, 
.br
.br
.BI "    NVME_CAP_CQR_MASK"
, 
.br
.br
.BI "    NVME_CAP_AMS_MASK"
, 
.br
.br
.BI "    NVME_CAP_TO_MASK"
, 
.br
.br
.BI "    NVME_CAP_DSTRD_MASK"
, 
.br
.br
.BI "    NVME_CAP_NSSRC_MASK"
, 
.br
.br
.BI "    NVME_CAP_CSS_MASK"
, 
.br
.br
.BI "    NVME_CAP_BPS_MASK"
, 
.br
.br
.BI "    NVME_CAP_CPS_MASK"
, 
.br
.br
.BI "    NVME_CAP_MPSMIN_MASK"
, 
.br
.br
.BI "    NVME_CAP_MPSMAX_MASK"
, 
.br
.br
.BI "    NVME_CAP_PMRS_MASK"
, 
.br
.br
.BI "    NVME_CAP_CMBS_MASK"
, 
.br
.br
.BI "    NVME_CAP_NSSS_MASK"
, 
.br
.br
.BI "    NVME_CAP_CRMS_MASK"
, 
.br
.br
.BI "    NVME_CAP_AMS_WRR"
, 
.br
.br
.BI "    NVME_CAP_AMS_VS"
, 
.br
.br
.BI "    NVME_CAP_CSS_NVM"
, 
.br
.br
.BI "    NVME_CAP_CSS_CSI"
, 
.br
.br
.BI "    NVME_CAP_CSS_ADMIN"
, 
.br
.br
.BI "    NVME_CAP_CPS_NONE"
, 
.br
.br
.BI "    NVME_CAP_CPS_CTRL"
, 
.br
.br
.BI "    NVME_CAP_CPS_DOMAIN"
, 
.br
.br
.BI "    NVME_CAP_CPS_NVMS"
, 
.br
.br
.BI "    NVME_CAP_CRWMS"
, 
.br
.br
.BI "    NVME_CAP_CRIMS"

};
.SH Constants
.IP "NVME_CAP_MQES_SHIFT" 12
Shift amount to get the maximum queue entries supported
.IP "NVME_CAP_CQR_SHIFT" 12
Shift amount to get the contiguous queues required
.IP "NVME_CAP_AMS_SHIFT" 12
Shift amount to get the arbitration mechanism supported
.IP "NVME_CAP_TO_SHIFT" 12
Shift amount to get the timeout
.IP "NVME_CAP_DSTRD_SHIFT" 12
Shift amount to get the doorbell stride
.IP "NVME_CAP_NSSRC_SHIFT" 12
Shift amount to get the NVM subsystem reset supported
.IP "NVME_CAP_CSS_SHIFT" 12
Shift amount to get the command sets supported
.IP "NVME_CAP_BPS_SHIFT" 12
Shift amount to get the boot partition support
.IP "NVME_CAP_CPS_SHIFT" 12
Shift amount to get the controller power scope
.IP "NVME_CAP_MPSMIN_SHIFT" 12
Shift amount to get the memory page size minimum
.IP "NVME_CAP_MPSMAX_SHIFT" 12
Shift amount to get the memory page size maximum
.IP "NVME_CAP_PMRS_SHIFT" 12
Shift amount to get the persistent memory region supported
.IP "NVME_CAP_CMBS_SHIFT" 12
Shift amount to get the controller memory buffer supported
.IP "NVME_CAP_NSSS_SHIFT" 12
Shift amount to get the NVM subsystem shutdown supported
.IP "NVME_CAP_CRMS_SHIFT" 12
Shift amount to get the controller ready modes supported
.IP "NVME_CAP_MQES_MASK" 12
Mask to get the maximum queue entries supported
.IP "NVME_CAP_CQR_MASK" 12
Mask to get the contiguous queues required
.IP "NVME_CAP_AMS_MASK" 12
Mask to get the arbitration mechanism supported
.IP "NVME_CAP_TO_MASK" 12
Mask to get the timeout
.IP "NVME_CAP_DSTRD_MASK" 12
Mask to get the doorbell stride
.IP "NVME_CAP_NSSRC_MASK" 12
Mask to get the NVM subsystem reset supported
.IP "NVME_CAP_CSS_MASK" 12
Mask to get the command sets supported
.IP "NVME_CAP_BPS_MASK" 12
Mask to get the boot partition support
.IP "NVME_CAP_CPS_MASK" 12
Mask to get the controller power scope
.IP "NVME_CAP_MPSMIN_MASK" 12
Mask to get the memory page size minimum
.IP "NVME_CAP_MPSMAX_MASK" 12
Mask to get the memory page size maximum
.IP "NVME_CAP_PMRS_MASK" 12
Mask to get the persistent memory region supported
.IP "NVME_CAP_CMBS_MASK" 12
Mask to get the controller memory buffer supported
.IP "NVME_CAP_NSSS_MASK" 12
Mask to get the NVM subsystem shutdown supported
.IP "NVME_CAP_CRMS_MASK" 12
Mask to get the controller ready modes supported
.IP "NVME_CAP_AMS_WRR" 12
Weighted round robin with urgent priority class
.IP "NVME_CAP_AMS_VS" 12
Vendor specific
.IP "NVME_CAP_CSS_NVM" 12
NVM command set or a discovery controller
.IP "NVME_CAP_CSS_CSI" 12
Controller supports one or more I/O command sets
.IP "NVME_CAP_CSS_ADMIN" 12
No I/O command set is supported
.IP "NVME_CAP_CPS_NONE" 12
Not reported
.IP "NVME_CAP_CPS_CTRL" 12
Controller scope
.IP "NVME_CAP_CPS_DOMAIN" 12
Domain scope
.IP "NVME_CAP_CPS_NVMS" 12
NVM subsystem scope
.IP "NVME_CAP_CRWMS" 12
Controller ready with media support
.IP "NVME_CAP_CRIMS" 12
Controller ready independent of media support