2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2012-2013 Intel Corporation
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 #include <sys/types.h>
38 #include <sys/param.h>
39 #include <sys/endian.h>
41 #define NVME_PASSTHROUGH_CMD _IOWR('n', 0, struct nvme_pt_command)
42 #define NVME_RESET_CONTROLLER _IO('n', 1)
43 #define NVME_GET_NSID _IOR('n', 2, struct nvme_get_nsid)
45 #define NVME_IO_TEST _IOWR('n', 100, struct nvme_io_test)
46 #define NVME_BIO_TEST _IOWR('n', 101, struct nvme_io_test)
49 * Macros to deal with NVME revisions, as defined VS register
51 #define NVME_REV(x, y) (((x) << 16) | ((y) << 8))
52 #define NVME_MAJOR(r) (((r) >> 16) & 0xffff)
53 #define NVME_MINOR(r) (((r) >> 8) & 0xff)
56 * Use to mark a command to apply to all namespaces, or to retrieve global
59 #define NVME_GLOBAL_NAMESPACE_TAG ((uint32_t)0xFFFFFFFF)
61 /* Cap nvme to 1MB transfers driver explodes with larger sizes */
62 #define NVME_MAX_XFER_SIZE (MAXPHYS < (1<<20) ? MAXPHYS : (1<<20))
64 /* Register field definitions */
65 #define NVME_CAP_LO_REG_MQES_SHIFT (0)
66 #define NVME_CAP_LO_REG_MQES_MASK (0xFFFF)
67 #define NVME_CAP_LO_REG_CQR_SHIFT (16)
68 #define NVME_CAP_LO_REG_CQR_MASK (0x1)
69 #define NVME_CAP_LO_REG_AMS_SHIFT (17)
70 #define NVME_CAP_LO_REG_AMS_MASK (0x3)
71 #define NVME_CAP_LO_REG_TO_SHIFT (24)
72 #define NVME_CAP_LO_REG_TO_MASK (0xFF)
73 #define NVME_CAP_LO_MQES(x) \
74 (((x) >> NVME_CAP_LO_REG_MQES_SHIFT) & NVME_CAP_LO_REG_MQES_MASK)
75 #define NVME_CAP_LO_CQR(x) \
76 (((x) >> NVME_CAP_LO_REG_CQR_SHIFT) & NVME_CAP_LO_REG_CQR_MASK)
77 #define NVME_CAP_LO_AMS(x) \
78 (((x) >> NVME_CAP_LO_REG_AMS_SHIFT) & NVME_CAP_LO_REG_AMS_MASK)
79 #define NVME_CAP_LO_TO(x) \
80 (((x) >> NVME_CAP_LO_REG_TO_SHIFT) & NVME_CAP_LO_REG_TO_MASK)
82 #define NVME_CAP_HI_REG_DSTRD_SHIFT (0)
83 #define NVME_CAP_HI_REG_DSTRD_MASK (0xF)
84 #define NVME_CAP_HI_REG_CSS_NVM_SHIFT (5)
85 #define NVME_CAP_HI_REG_CSS_NVM_MASK (0x1)
86 #define NVME_CAP_HI_REG_MPSMIN_SHIFT (16)
87 #define NVME_CAP_HI_REG_MPSMIN_MASK (0xF)
88 #define NVME_CAP_HI_REG_MPSMAX_SHIFT (20)
89 #define NVME_CAP_HI_REG_MPSMAX_MASK (0xF)
90 #define NVME_CAP_HI_DSTRD(x) \
91 (((x) >> NVME_CAP_HI_REG_DSTRD_SHIFT) & NVME_CAP_HI_REG_DSTRD_MASK)
92 #define NVME_CAP_HI_CSS_NVM(x) \
93 (((x) >> NVME_CAP_HI_REG_CSS_NVM_SHIFT) & NVME_CAP_HI_REG_CSS_NVM_MASK)
94 #define NVME_CAP_HI_MPSMIN(x) \
95 (((x) >> NVME_CAP_HI_REG_MPSMIN_SHIFT) & NVME_CAP_HI_REG_MPSMIN_MASK)
96 #define NVME_CAP_HI_MPSMAX(x) \
97 (((x) >> NVME_CAP_HI_REG_MPSMAX_SHIFT) & NVME_CAP_HI_REG_MPSMAX_MASK)
99 #define NVME_CC_REG_EN_SHIFT (0)
100 #define NVME_CC_REG_EN_MASK (0x1)
101 #define NVME_CC_REG_CSS_SHIFT (4)
102 #define NVME_CC_REG_CSS_MASK (0x7)
103 #define NVME_CC_REG_MPS_SHIFT (7)
104 #define NVME_CC_REG_MPS_MASK (0xF)
105 #define NVME_CC_REG_AMS_SHIFT (11)
106 #define NVME_CC_REG_AMS_MASK (0x7)
107 #define NVME_CC_REG_SHN_SHIFT (14)
108 #define NVME_CC_REG_SHN_MASK (0x3)
109 #define NVME_CC_REG_IOSQES_SHIFT (16)
110 #define NVME_CC_REG_IOSQES_MASK (0xF)
111 #define NVME_CC_REG_IOCQES_SHIFT (20)
112 #define NVME_CC_REG_IOCQES_MASK (0xF)
114 #define NVME_CSTS_REG_RDY_SHIFT (0)
115 #define NVME_CSTS_REG_RDY_MASK (0x1)
116 #define NVME_CSTS_REG_CFS_SHIFT (1)
117 #define NVME_CSTS_REG_CFS_MASK (0x1)
118 #define NVME_CSTS_REG_SHST_SHIFT (2)
119 #define NVME_CSTS_REG_SHST_MASK (0x3)
121 #define NVME_CSTS_GET_SHST(csts) (((csts) >> NVME_CSTS_REG_SHST_SHIFT) & NVME_CSTS_REG_SHST_MASK)
123 #define NVME_AQA_REG_ASQS_SHIFT (0)
124 #define NVME_AQA_REG_ASQS_MASK (0xFFF)
125 #define NVME_AQA_REG_ACQS_SHIFT (16)
126 #define NVME_AQA_REG_ACQS_MASK (0xFFF)
128 /* Command field definitions */
130 #define NVME_CMD_FUSE_SHIFT (8)
131 #define NVME_CMD_FUSE_MASK (0x3)
133 #define NVME_STATUS_P_SHIFT (0)
134 #define NVME_STATUS_P_MASK (0x1)
135 #define NVME_STATUS_SC_SHIFT (1)
136 #define NVME_STATUS_SC_MASK (0xFF)
137 #define NVME_STATUS_SCT_SHIFT (9)
138 #define NVME_STATUS_SCT_MASK (0x7)
139 #define NVME_STATUS_M_SHIFT (14)
140 #define NVME_STATUS_M_MASK (0x1)
141 #define NVME_STATUS_DNR_SHIFT (15)
142 #define NVME_STATUS_DNR_MASK (0x1)
144 #define NVME_STATUS_GET_P(st) (((st) >> NVME_STATUS_P_SHIFT) & NVME_STATUS_P_MASK)
145 #define NVME_STATUS_GET_SC(st) (((st) >> NVME_STATUS_SC_SHIFT) & NVME_STATUS_SC_MASK)
146 #define NVME_STATUS_GET_SCT(st) (((st) >> NVME_STATUS_SCT_SHIFT) & NVME_STATUS_SCT_MASK)
147 #define NVME_STATUS_GET_M(st) (((st) >> NVME_STATUS_M_SHIFT) & NVME_STATUS_M_MASK)
148 #define NVME_STATUS_GET_DNR(st) (((st) >> NVME_STATUS_DNR_SHIFT) & NVME_STATUS_DNR_MASK)
150 #define NVME_PWR_ST_MPS_SHIFT (0)
151 #define NVME_PWR_ST_MPS_MASK (0x1)
152 #define NVME_PWR_ST_NOPS_SHIFT (1)
153 #define NVME_PWR_ST_NOPS_MASK (0x1)
154 #define NVME_PWR_ST_RRT_SHIFT (0)
155 #define NVME_PWR_ST_RRT_MASK (0x1F)
156 #define NVME_PWR_ST_RRL_SHIFT (0)
157 #define NVME_PWR_ST_RRL_MASK (0x1F)
158 #define NVME_PWR_ST_RWT_SHIFT (0)
159 #define NVME_PWR_ST_RWT_MASK (0x1F)
160 #define NVME_PWR_ST_RWL_SHIFT (0)
161 #define NVME_PWR_ST_RWL_MASK (0x1F)
162 #define NVME_PWR_ST_IPS_SHIFT (6)
163 #define NVME_PWR_ST_IPS_MASK (0x3)
164 #define NVME_PWR_ST_APW_SHIFT (0)
165 #define NVME_PWR_ST_APW_MASK (0x7)
166 #define NVME_PWR_ST_APS_SHIFT (6)
167 #define NVME_PWR_ST_APS_MASK (0x3)
169 /** Controller Multi-path I/O and Namespace Sharing Capabilities */
170 /* More then one port */
171 #define NVME_CTRLR_DATA_MIC_MPORTS_SHIFT (0)
172 #define NVME_CTRLR_DATA_MIC_MPORTS_MASK (0x1)
173 /* More then one controller */
174 #define NVME_CTRLR_DATA_MIC_MCTRLRS_SHIFT (1)
175 #define NVME_CTRLR_DATA_MIC_MCTRLRS_MASK (0x1)
176 /* SR-IOV Virtual Function */
177 #define NVME_CTRLR_DATA_MIC_SRIOVVF_SHIFT (2)
178 #define NVME_CTRLR_DATA_MIC_SRIOVVF_MASK (0x1)
179 /* Asymmetric Namespace Access Reporting */
180 #define NVME_CTRLR_DATA_MIC_ANAR_SHIFT (3)
181 #define NVME_CTRLR_DATA_MIC_ANAR_MASK (0x1)
183 /** OACS - optional admin command support */
184 /* supports security send/receive commands */
185 #define NVME_CTRLR_DATA_OACS_SECURITY_SHIFT (0)
186 #define NVME_CTRLR_DATA_OACS_SECURITY_MASK (0x1)
187 /* supports format nvm command */
188 #define NVME_CTRLR_DATA_OACS_FORMAT_SHIFT (1)
189 #define NVME_CTRLR_DATA_OACS_FORMAT_MASK (0x1)
190 /* supports firmware activate/download commands */
191 #define NVME_CTRLR_DATA_OACS_FIRMWARE_SHIFT (2)
192 #define NVME_CTRLR_DATA_OACS_FIRMWARE_MASK (0x1)
193 /* supports namespace management commands */
194 #define NVME_CTRLR_DATA_OACS_NSMGMT_SHIFT (3)
195 #define NVME_CTRLR_DATA_OACS_NSMGMT_MASK (0x1)
196 /* supports Device Self-test command */
197 #define NVME_CTRLR_DATA_OACS_SELFTEST_SHIFT (4)
198 #define NVME_CTRLR_DATA_OACS_SELFTEST_MASK (0x1)
199 /* supports Directives */
200 #define NVME_CTRLR_DATA_OACS_DIRECTIVES_SHIFT (5)
201 #define NVME_CTRLR_DATA_OACS_DIRECTIVES_MASK (0x1)
202 /* supports NVMe-MI Send/Receive */
203 #define NVME_CTRLR_DATA_OACS_NVMEMI_SHIFT (6)
204 #define NVME_CTRLR_DATA_OACS_NVMEMI_MASK (0x1)
205 /* supports Virtualization Management */
206 #define NVME_CTRLR_DATA_OACS_VM_SHIFT (7)
207 #define NVME_CTRLR_DATA_OACS_VM_MASK (0x1)
208 /* supports Doorbell Buffer Config */
209 #define NVME_CTRLR_DATA_OACS_DBBUFFER_SHIFT (8)
210 #define NVME_CTRLR_DATA_OACS_DBBUFFER_MASK (0x1)
211 /* supports Get LBA Status */
212 #define NVME_CTRLR_DATA_OACS_GETLBA_SHIFT (9)
213 #define NVME_CTRLR_DATA_OACS_GETLBA_MASK (0x1)
215 /** firmware updates */
216 /* first slot is read-only */
217 #define NVME_CTRLR_DATA_FRMW_SLOT1_RO_SHIFT (0)
218 #define NVME_CTRLR_DATA_FRMW_SLOT1_RO_MASK (0x1)
219 /* number of firmware slots */
220 #define NVME_CTRLR_DATA_FRMW_NUM_SLOTS_SHIFT (1)
221 #define NVME_CTRLR_DATA_FRMW_NUM_SLOTS_MASK (0x7)
222 /* firmware activation without reset */
223 #define NVME_CTRLR_DATA_FRMW_ACT_WO_RESET_SHIFT (4)
224 #define NVME_CTRLR_DATA_FRMW_ACT_WO_RESET_MASK (0x1)
226 /** log page attributes */
227 /* per namespace smart/health log page */
228 #define NVME_CTRLR_DATA_LPA_NS_SMART_SHIFT (0)
229 #define NVME_CTRLR_DATA_LPA_NS_SMART_MASK (0x1)
231 /** AVSCC - admin vendor specific command configuration */
232 /* admin vendor specific commands use spec format */
233 #define NVME_CTRLR_DATA_AVSCC_SPEC_FORMAT_SHIFT (0)
234 #define NVME_CTRLR_DATA_AVSCC_SPEC_FORMAT_MASK (0x1)
236 /** Autonomous Power State Transition Attributes */
237 /* Autonomous Power State Transitions supported */
238 #define NVME_CTRLR_DATA_APSTA_APST_SUPP_SHIFT (0)
239 #define NVME_CTRLR_DATA_APSTA_APST_SUPP_MASK (0x1)
241 /** Sanitize Capabilities */
242 /* Crypto Erase Support */
243 #define NVME_CTRLR_DATA_SANICAP_CES_SHIFT (0)
244 #define NVME_CTRLR_DATA_SANICAP_CES_MASK (0x1)
245 /* Block Erase Support */
246 #define NVME_CTRLR_DATA_SANICAP_BES_SHIFT (1)
247 #define NVME_CTRLR_DATA_SANICAP_BES_MASK (0x1)
248 /* Overwrite Support */
249 #define NVME_CTRLR_DATA_SANICAP_OWS_SHIFT (2)
250 #define NVME_CTRLR_DATA_SANICAP_OWS_MASK (0x1)
251 /* No-Deallocate Inhibited */
252 #define NVME_CTRLR_DATA_SANICAP_NDI_SHIFT (29)
253 #define NVME_CTRLR_DATA_SANICAP_NDI_MASK (0x1)
254 /* No-Deallocate Modifies Media After Sanitize */
255 #define NVME_CTRLR_DATA_SANICAP_NODMMAS_SHIFT (30)
256 #define NVME_CTRLR_DATA_SANICAP_NODMMAS_MASK (0x3)
257 #define NVME_CTRLR_DATA_SANICAP_NODMMAS_UNDEF (0)
258 #define NVME_CTRLR_DATA_SANICAP_NODMMAS_NO (1)
259 #define NVME_CTRLR_DATA_SANICAP_NODMMAS_YES (2)
261 /** submission queue entry size */
262 #define NVME_CTRLR_DATA_SQES_MIN_SHIFT (0)
263 #define NVME_CTRLR_DATA_SQES_MIN_MASK (0xF)
264 #define NVME_CTRLR_DATA_SQES_MAX_SHIFT (4)
265 #define NVME_CTRLR_DATA_SQES_MAX_MASK (0xF)
267 /** completion queue entry size */
268 #define NVME_CTRLR_DATA_CQES_MIN_SHIFT (0)
269 #define NVME_CTRLR_DATA_CQES_MIN_MASK (0xF)
270 #define NVME_CTRLR_DATA_CQES_MAX_SHIFT (4)
271 #define NVME_CTRLR_DATA_CQES_MAX_MASK (0xF)
273 /** optional nvm command support */
274 #define NVME_CTRLR_DATA_ONCS_COMPARE_SHIFT (0)
275 #define NVME_CTRLR_DATA_ONCS_COMPARE_MASK (0x1)
276 #define NVME_CTRLR_DATA_ONCS_WRITE_UNC_SHIFT (1)
277 #define NVME_CTRLR_DATA_ONCS_WRITE_UNC_MASK (0x1)
278 #define NVME_CTRLR_DATA_ONCS_DSM_SHIFT (2)
279 #define NVME_CTRLR_DATA_ONCS_DSM_MASK (0x1)
280 #define NVME_CTRLR_DATA_ONCS_WRZERO_SHIFT (3)
281 #define NVME_CTRLR_DATA_ONCS_WRZERO_MASK (0x1)
282 #define NVME_CTRLR_DATA_ONCS_SAVEFEAT_SHIFT (4)
283 #define NVME_CTRLR_DATA_ONCS_SAVEFEAT_MASK (0x1)
284 #define NVME_CTRLR_DATA_ONCS_RESERV_SHIFT (5)
285 #define NVME_CTRLR_DATA_ONCS_RESERV_MASK (0x1)
286 #define NVME_CTRLR_DATA_ONCS_TIMESTAMP_SHIFT (6)
287 #define NVME_CTRLR_DATA_ONCS_TIMESTAMP_MASK (0x1)
288 #define NVME_CTRLR_DATA_ONCS_VERIFY_SHIFT (7)
289 #define NVME_CTRLR_DATA_ONCS_VERIFY_MASK (0x1)
291 /** Fused Operation Support */
292 #define NVME_CTRLR_DATA_FUSES_CNW_SHIFT (0)
293 #define NVME_CTRLR_DATA_FUSES_CNW_MASK (0x1)
295 /** Format NVM Attributes */
296 #define NVME_CTRLR_DATA_FNA_FORMAT_ALL_SHIFT (0)
297 #define NVME_CTRLR_DATA_FNA_FORMAT_ALL_MASK (0x1)
298 #define NVME_CTRLR_DATA_FNA_ERASE_ALL_SHIFT (1)
299 #define NVME_CTRLR_DATA_FNA_ERASE_ALL_MASK (0x1)
300 #define NVME_CTRLR_DATA_FNA_CRYPTO_ERASE_SHIFT (2)
301 #define NVME_CTRLR_DATA_FNA_CRYPTO_ERASE_MASK (0x1)
303 /** volatile write cache */
304 /* volatile write cache present */
305 #define NVME_CTRLR_DATA_VWC_PRESENT_SHIFT (0)
306 #define NVME_CTRLR_DATA_VWC_PRESENT_MASK (0x1)
307 /* flush all namespaces supported */
308 #define NVME_CTRLR_DATA_VWC_ALL_SHIFT (1)
309 #define NVME_CTRLR_DATA_VWC_ALL_MASK (0x3)
310 #define NVME_CTRLR_DATA_VWC_ALL_UNKNOWN (0)
311 #define NVME_CTRLR_DATA_VWC_ALL_NO (2)
312 #define NVME_CTRLR_DATA_VWC_ALL_YES (3)
314 /** namespace features */
315 /* thin provisioning */
316 #define NVME_NS_DATA_NSFEAT_THIN_PROV_SHIFT (0)
317 #define NVME_NS_DATA_NSFEAT_THIN_PROV_MASK (0x1)
318 /* NAWUN, NAWUPF, and NACWU fields are valid */
319 #define NVME_NS_DATA_NSFEAT_NA_FIELDS_SHIFT (1)
320 #define NVME_NS_DATA_NSFEAT_NA_FIELDS_MASK (0x1)
321 /* Deallocated or Unwritten Logical Block errors supported */
322 #define NVME_NS_DATA_NSFEAT_DEALLOC_SHIFT (2)
323 #define NVME_NS_DATA_NSFEAT_DEALLOC_MASK (0x1)
324 /* NGUID and EUI64 fields are not reusable */
325 #define NVME_NS_DATA_NSFEAT_NO_ID_REUSE_SHIFT (3)
326 #define NVME_NS_DATA_NSFEAT_NO_ID_REUSE_MASK (0x1)
327 /* NPWG, NPWA, NPDG, NPDA, and NOWS are valid */
328 #define NVME_NS_DATA_NSFEAT_NPVALID_SHIFT (4)
329 #define NVME_NS_DATA_NSFEAT_NPVALID_MASK (0x1)
331 /** formatted lba size */
332 #define NVME_NS_DATA_FLBAS_FORMAT_SHIFT (0)
333 #define NVME_NS_DATA_FLBAS_FORMAT_MASK (0xF)
334 #define NVME_NS_DATA_FLBAS_EXTENDED_SHIFT (4)
335 #define NVME_NS_DATA_FLBAS_EXTENDED_MASK (0x1)
337 /** metadata capabilities */
338 /* metadata can be transferred as part of data prp list */
339 #define NVME_NS_DATA_MC_EXTENDED_SHIFT (0)
340 #define NVME_NS_DATA_MC_EXTENDED_MASK (0x1)
341 /* metadata can be transferred with separate metadata pointer */
342 #define NVME_NS_DATA_MC_POINTER_SHIFT (1)
343 #define NVME_NS_DATA_MC_POINTER_MASK (0x1)
345 /** end-to-end data protection capabilities */
346 /* protection information type 1 */
347 #define NVME_NS_DATA_DPC_PIT1_SHIFT (0)
348 #define NVME_NS_DATA_DPC_PIT1_MASK (0x1)
349 /* protection information type 2 */
350 #define NVME_NS_DATA_DPC_PIT2_SHIFT (1)
351 #define NVME_NS_DATA_DPC_PIT2_MASK (0x1)
352 /* protection information type 3 */
353 #define NVME_NS_DATA_DPC_PIT3_SHIFT (2)
354 #define NVME_NS_DATA_DPC_PIT3_MASK (0x1)
355 /* first eight bytes of metadata */
356 #define NVME_NS_DATA_DPC_MD_START_SHIFT (3)
357 #define NVME_NS_DATA_DPC_MD_START_MASK (0x1)
358 /* last eight bytes of metadata */
359 #define NVME_NS_DATA_DPC_MD_END_SHIFT (4)
360 #define NVME_NS_DATA_DPC_MD_END_MASK (0x1)
362 /** end-to-end data protection type settings */
363 /* protection information type */
364 #define NVME_NS_DATA_DPS_PIT_SHIFT (0)
365 #define NVME_NS_DATA_DPS_PIT_MASK (0x7)
366 /* 1 == protection info transferred at start of metadata */
367 /* 0 == protection info transferred at end of metadata */
368 #define NVME_NS_DATA_DPS_MD_START_SHIFT (3)
369 #define NVME_NS_DATA_DPS_MD_START_MASK (0x1)
371 /** Namespace Multi-path I/O and Namespace Sharing Capabilities */
372 /* the namespace may be attached to two or more controllers */
373 #define NVME_NS_DATA_NMIC_MAY_BE_SHARED_SHIFT (0)
374 #define NVME_NS_DATA_NMIC_MAY_BE_SHARED_MASK (0x1)
376 /** Reservation Capabilities */
377 /* Persist Through Power Loss */
378 #define NVME_NS_DATA_RESCAP_PTPL_SHIFT (0)
379 #define NVME_NS_DATA_RESCAP_PTPL_MASK (0x1)
380 /* supports the Write Exclusive */
381 #define NVME_NS_DATA_RESCAP_WR_EX_SHIFT (1)
382 #define NVME_NS_DATA_RESCAP_WR_EX_MASK (0x1)
383 /* supports the Exclusive Access */
384 #define NVME_NS_DATA_RESCAP_EX_AC_SHIFT (2)
385 #define NVME_NS_DATA_RESCAP_EX_AC_MASK (0x1)
386 /* supports the Write Exclusive – Registrants Only */
387 #define NVME_NS_DATA_RESCAP_WR_EX_RO_SHIFT (3)
388 #define NVME_NS_DATA_RESCAP_WR_EX_RO_MASK (0x1)
389 /* supports the Exclusive Access - Registrants Only */
390 #define NVME_NS_DATA_RESCAP_EX_AC_RO_SHIFT (4)
391 #define NVME_NS_DATA_RESCAP_EX_AC_RO_MASK (0x1)
392 /* supports the Write Exclusive – All Registrants */
393 #define NVME_NS_DATA_RESCAP_WR_EX_AR_SHIFT (5)
394 #define NVME_NS_DATA_RESCAP_WR_EX_AR_MASK (0x1)
395 /* supports the Exclusive Access - All Registrants */
396 #define NVME_NS_DATA_RESCAP_EX_AC_AR_SHIFT (6)
397 #define NVME_NS_DATA_RESCAP_EX_AC_AR_MASK (0x1)
398 /* Ignore Existing Key is used as defined in revision 1.3 or later */
399 #define NVME_NS_DATA_RESCAP_IEKEY13_SHIFT (7)
400 #define NVME_NS_DATA_RESCAP_IEKEY13_MASK (0x1)
402 /** Format Progress Indicator */
403 /* percentage of the Format NVM command that remains to be completed */
404 #define NVME_NS_DATA_FPI_PERC_SHIFT (0)
405 #define NVME_NS_DATA_FPI_PERC_MASK (0x7f)
406 /* namespace supports the Format Progress Indicator */
407 #define NVME_NS_DATA_FPI_SUPP_SHIFT (7)
408 #define NVME_NS_DATA_FPI_SUPP_MASK (0x1)
410 /** Deallocate Logical Block Features */
411 /* deallocated logical block read behavior */
412 #define NVME_NS_DATA_DLFEAT_READ_SHIFT (0)
413 #define NVME_NS_DATA_DLFEAT_READ_MASK (0x07)
414 #define NVME_NS_DATA_DLFEAT_READ_NR (0x00)
415 #define NVME_NS_DATA_DLFEAT_READ_00 (0x01)
416 #define NVME_NS_DATA_DLFEAT_READ_FF (0x02)
417 /* supports the Deallocate bit in the Write Zeroes */
418 #define NVME_NS_DATA_DLFEAT_DWZ_SHIFT (3)
419 #define NVME_NS_DATA_DLFEAT_DWZ_MASK (0x01)
420 /* Guard field for deallocated logical blocks is set to the CRC */
421 #define NVME_NS_DATA_DLFEAT_GCRC_SHIFT (4)
422 #define NVME_NS_DATA_DLFEAT_GCRC_MASK (0x01)
424 /** lba format support */
426 #define NVME_NS_DATA_LBAF_MS_SHIFT (0)
427 #define NVME_NS_DATA_LBAF_MS_MASK (0xFFFF)
429 #define NVME_NS_DATA_LBAF_LBADS_SHIFT (16)
430 #define NVME_NS_DATA_LBAF_LBADS_MASK (0xFF)
431 /* relative performance */
432 #define NVME_NS_DATA_LBAF_RP_SHIFT (24)
433 #define NVME_NS_DATA_LBAF_RP_MASK (0x3)
435 enum nvme_critical_warning_state {
436 NVME_CRIT_WARN_ST_AVAILABLE_SPARE = 0x1,
437 NVME_CRIT_WARN_ST_TEMPERATURE = 0x2,
438 NVME_CRIT_WARN_ST_DEVICE_RELIABILITY = 0x4,
439 NVME_CRIT_WARN_ST_READ_ONLY = 0x8,
440 NVME_CRIT_WARN_ST_VOLATILE_MEMORY_BACKUP = 0x10,
442 #define NVME_CRIT_WARN_ST_RESERVED_MASK (0xE0)
444 /* slot for current FW */
445 #define NVME_FIRMWARE_PAGE_AFI_SLOT_SHIFT (0)
446 #define NVME_FIRMWARE_PAGE_AFI_SLOT_MASK (0x7)
448 /* CC register SHN field values */
450 NVME_SHN_NORMAL = 0x1,
451 NVME_SHN_ABRUPT = 0x2,
454 /* CSTS register SHST field values */
456 NVME_SHST_NORMAL = 0x0,
457 NVME_SHST_OCCURRING = 0x1,
458 NVME_SHST_COMPLETE = 0x2,
461 struct nvme_registers
463 /** controller capabilities */
467 uint32_t vs; /* version */
468 uint32_t intms; /* interrupt mask set */
469 uint32_t intmc; /* interrupt mask clear */
471 /** controller configuration */
476 /** controller status */
481 /** admin queue attributes */
484 uint64_t asq; /* admin submission queue base addr */
485 uint64_t acq; /* admin completion queue base addr */
486 uint32_t reserved3[0x3f2];
489 uint32_t sq_tdbl; /* submission queue tail doorbell */
490 uint32_t cq_hdbl; /* completion queue head doorbell */
491 } doorbell[1] __packed;
494 _Static_assert(sizeof(struct nvme_registers) == 0x1008, "bad size for nvme_registers");
499 uint8_t opc; /* opcode */
500 uint8_t fuse; /* fused operation */
501 uint16_t cid; /* command identifier */
504 uint32_t nsid; /* namespace identifier */
511 uint64_t mptr; /* metadata pointer */
514 uint64_t prp1; /* prp entry 1 */
517 uint64_t prp2; /* prp entry 2 */
520 uint32_t cdw10; /* command-specific */
521 uint32_t cdw11; /* command-specific */
522 uint32_t cdw12; /* command-specific */
523 uint32_t cdw13; /* command-specific */
524 uint32_t cdw14; /* command-specific */
525 uint32_t cdw15; /* command-specific */
528 _Static_assert(sizeof(struct nvme_command) == 16 * 4, "bad size for nvme_command");
530 struct nvme_completion {
533 uint32_t cdw0; /* command-specific */
539 uint16_t sqhd; /* submission queue head pointer */
540 uint16_t sqid; /* submission queue identifier */
543 uint16_t cid; /* command identifier */
547 _Static_assert(sizeof(struct nvme_completion) == 4 * 4, "bad size for nvme_completion");
549 struct nvme_dsm_range {
552 uint64_t starting_lba;
555 /* Largest DSM Trim that can be done */
556 #define NVME_MAX_DSM_TRIM 4096
558 _Static_assert(sizeof(struct nvme_dsm_range) == 16, "bad size for nvme_dsm_ranage");
560 /* status code types */
561 enum nvme_status_code_type {
562 NVME_SCT_GENERIC = 0x0,
563 NVME_SCT_COMMAND_SPECIFIC = 0x1,
564 NVME_SCT_MEDIA_ERROR = 0x2,
565 /* 0x3-0x6 - reserved */
566 NVME_SCT_VENDOR_SPECIFIC = 0x7,
569 /* generic command status codes */
570 enum nvme_generic_command_status_code {
571 NVME_SC_SUCCESS = 0x00,
572 NVME_SC_INVALID_OPCODE = 0x01,
573 NVME_SC_INVALID_FIELD = 0x02,
574 NVME_SC_COMMAND_ID_CONFLICT = 0x03,
575 NVME_SC_DATA_TRANSFER_ERROR = 0x04,
576 NVME_SC_ABORTED_POWER_LOSS = 0x05,
577 NVME_SC_INTERNAL_DEVICE_ERROR = 0x06,
578 NVME_SC_ABORTED_BY_REQUEST = 0x07,
579 NVME_SC_ABORTED_SQ_DELETION = 0x08,
580 NVME_SC_ABORTED_FAILED_FUSED = 0x09,
581 NVME_SC_ABORTED_MISSING_FUSED = 0x0a,
582 NVME_SC_INVALID_NAMESPACE_OR_FORMAT = 0x0b,
583 NVME_SC_COMMAND_SEQUENCE_ERROR = 0x0c,
584 NVME_SC_INVALID_SGL_SEGMENT_DESCR = 0x0d,
585 NVME_SC_INVALID_NUMBER_OF_SGL_DESCR = 0x0e,
586 NVME_SC_DATA_SGL_LENGTH_INVALID = 0x0f,
587 NVME_SC_METADATA_SGL_LENGTH_INVALID = 0x10,
588 NVME_SC_SGL_DESCRIPTOR_TYPE_INVALID = 0x11,
589 NVME_SC_INVALID_USE_OF_CMB = 0x12,
590 NVME_SC_PRP_OFFET_INVALID = 0x13,
591 NVME_SC_ATOMIC_WRITE_UNIT_EXCEEDED = 0x14,
592 NVME_SC_OPERATION_DENIED = 0x15,
593 NVME_SC_SGL_OFFSET_INVALID = 0x16,
594 /* 0x17 - reserved */
595 NVME_SC_HOST_ID_INCONSISTENT_FORMAT = 0x18,
596 NVME_SC_KEEP_ALIVE_TIMEOUT_EXPIRED = 0x19,
597 NVME_SC_KEEP_ALIVE_TIMEOUT_INVALID = 0x1a,
598 NVME_SC_ABORTED_DUE_TO_PREEMPT = 0x1b,
599 NVME_SC_SANITIZE_FAILED = 0x1c,
600 NVME_SC_SANITIZE_IN_PROGRESS = 0x1d,
601 NVME_SC_SGL_DATA_BLOCK_GRAN_INVALID = 0x1e,
602 NVME_SC_NOT_SUPPORTED_IN_CMB = 0x1f,
603 NVME_SC_NAMESPACE_IS_WRITE_PROTECTED = 0x20,
604 NVME_SC_COMMAND_INTERRUPTED = 0x21,
605 NVME_SC_TRANSIENT_TRANSPORT_ERROR = 0x22,
607 NVME_SC_LBA_OUT_OF_RANGE = 0x80,
608 NVME_SC_CAPACITY_EXCEEDED = 0x81,
609 NVME_SC_NAMESPACE_NOT_READY = 0x82,
610 NVME_SC_RESERVATION_CONFLICT = 0x83,
611 NVME_SC_FORMAT_IN_PROGRESS = 0x84,
614 /* command specific status codes */
615 enum nvme_command_specific_status_code {
616 NVME_SC_COMPLETION_QUEUE_INVALID = 0x00,
617 NVME_SC_INVALID_QUEUE_IDENTIFIER = 0x01,
618 NVME_SC_MAXIMUM_QUEUE_SIZE_EXCEEDED = 0x02,
619 NVME_SC_ABORT_COMMAND_LIMIT_EXCEEDED = 0x03,
620 /* 0x04 - reserved */
621 NVME_SC_ASYNC_EVENT_REQUEST_LIMIT_EXCEEDED = 0x05,
622 NVME_SC_INVALID_FIRMWARE_SLOT = 0x06,
623 NVME_SC_INVALID_FIRMWARE_IMAGE = 0x07,
624 NVME_SC_INVALID_INTERRUPT_VECTOR = 0x08,
625 NVME_SC_INVALID_LOG_PAGE = 0x09,
626 NVME_SC_INVALID_FORMAT = 0x0a,
627 NVME_SC_FIRMWARE_REQUIRES_RESET = 0x0b,
628 NVME_SC_INVALID_QUEUE_DELETION = 0x0c,
629 NVME_SC_FEATURE_NOT_SAVEABLE = 0x0d,
630 NVME_SC_FEATURE_NOT_CHANGEABLE = 0x0e,
631 NVME_SC_FEATURE_NOT_NS_SPECIFIC = 0x0f,
632 NVME_SC_FW_ACT_REQUIRES_NVMS_RESET = 0x10,
633 NVME_SC_FW_ACT_REQUIRES_RESET = 0x11,
634 NVME_SC_FW_ACT_REQUIRES_TIME = 0x12,
635 NVME_SC_FW_ACT_PROHIBITED = 0x13,
636 NVME_SC_OVERLAPPING_RANGE = 0x14,
637 NVME_SC_NS_INSUFFICIENT_CAPACITY = 0x15,
638 NVME_SC_NS_ID_UNAVAILABLE = 0x16,
639 /* 0x17 - reserved */
640 NVME_SC_NS_ALREADY_ATTACHED = 0x18,
641 NVME_SC_NS_IS_PRIVATE = 0x19,
642 NVME_SC_NS_NOT_ATTACHED = 0x1a,
643 NVME_SC_THIN_PROV_NOT_SUPPORTED = 0x1b,
644 NVME_SC_CTRLR_LIST_INVALID = 0x1c,
645 NVME_SC_SELT_TEST_IN_PROGRESS = 0x1d,
646 NVME_SC_BOOT_PART_WRITE_PROHIB = 0x1e,
647 NVME_SC_INVALID_CTRLR_ID = 0x1f,
648 NVME_SC_INVALID_SEC_CTRLR_STATE = 0x20,
649 NVME_SC_INVALID_NUM_OF_CTRLR_RESRC = 0x21,
650 NVME_SC_INVALID_RESOURCE_ID = 0x22,
651 NVME_SC_SANITIZE_PROHIBITED_WPMRE = 0x23,
652 NVME_SC_ANA_GROUP_ID_INVALID = 0x24,
653 NVME_SC_ANA_ATTACH_FAILED = 0x25,
655 NVME_SC_CONFLICTING_ATTRIBUTES = 0x80,
656 NVME_SC_INVALID_PROTECTION_INFO = 0x81,
657 NVME_SC_ATTEMPTED_WRITE_TO_RO_PAGE = 0x82,
660 /* media error status codes */
661 enum nvme_media_error_status_code {
662 NVME_SC_WRITE_FAULTS = 0x80,
663 NVME_SC_UNRECOVERED_READ_ERROR = 0x81,
664 NVME_SC_GUARD_CHECK_ERROR = 0x82,
665 NVME_SC_APPLICATION_TAG_CHECK_ERROR = 0x83,
666 NVME_SC_REFERENCE_TAG_CHECK_ERROR = 0x84,
667 NVME_SC_COMPARE_FAILURE = 0x85,
668 NVME_SC_ACCESS_DENIED = 0x86,
669 NVME_SC_DEALLOCATED_OR_UNWRITTEN = 0x87,
673 enum nvme_admin_opcode {
674 NVME_OPC_DELETE_IO_SQ = 0x00,
675 NVME_OPC_CREATE_IO_SQ = 0x01,
676 NVME_OPC_GET_LOG_PAGE = 0x02,
677 /* 0x03 - reserved */
678 NVME_OPC_DELETE_IO_CQ = 0x04,
679 NVME_OPC_CREATE_IO_CQ = 0x05,
680 NVME_OPC_IDENTIFY = 0x06,
681 /* 0x07 - reserved */
682 NVME_OPC_ABORT = 0x08,
683 NVME_OPC_SET_FEATURES = 0x09,
684 NVME_OPC_GET_FEATURES = 0x0a,
685 /* 0x0b - reserved */
686 NVME_OPC_ASYNC_EVENT_REQUEST = 0x0c,
687 NVME_OPC_NAMESPACE_MANAGEMENT = 0x0d,
688 /* 0x0e-0x0f - reserved */
689 NVME_OPC_FIRMWARE_ACTIVATE = 0x10,
690 NVME_OPC_FIRMWARE_IMAGE_DOWNLOAD = 0x11,
691 /* 0x12-0x13 - reserved */
692 NVME_OPC_DEVICE_SELF_TEST = 0x14,
693 NVME_OPC_NAMESPACE_ATTACHMENT = 0x15,
694 /* 0x16-0x17 - reserved */
695 NVME_OPC_KEEP_ALIVE = 0x18,
696 NVME_OPC_DIRECTIVE_SEND = 0x19,
697 NVME_OPC_DIRECTIVE_RECEIVE = 0x1a,
698 /* 0x1b - reserved */
699 NVME_OPC_VIRTUALIZATION_MANAGEMENT = 0x1c,
700 NVME_OPC_NVME_MI_SEND = 0x1d,
701 NVME_OPC_NVME_MI_RECEIVE = 0x1e,
702 /* 0x1f-0x7b - reserved */
703 NVME_OPC_DOORBELL_BUFFER_CONFIG = 0x7c,
705 NVME_OPC_FORMAT_NVM = 0x80,
706 NVME_OPC_SECURITY_SEND = 0x81,
707 NVME_OPC_SECURITY_RECEIVE = 0x82,
708 /* 0x83 - reserved */
709 NVME_OPC_SANITIZE = 0x84,
710 /* 0x85 - reserved */
711 NVME_OPC_GET_LBA_STATUS = 0x86,
714 /* nvme nvm opcodes */
715 enum nvme_nvm_opcode {
716 NVME_OPC_FLUSH = 0x00,
717 NVME_OPC_WRITE = 0x01,
718 NVME_OPC_READ = 0x02,
719 /* 0x03 - reserved */
720 NVME_OPC_WRITE_UNCORRECTABLE = 0x04,
721 NVME_OPC_COMPARE = 0x05,
722 /* 0x06-0x07 - reserved */
723 NVME_OPC_WRITE_ZEROES = 0x08,
724 NVME_OPC_DATASET_MANAGEMENT = 0x09,
725 /* 0x0a-0x0b - reserved */
726 NVME_OPC_VERIFY = 0x0c,
727 NVME_OPC_RESERVATION_REGISTER = 0x0d,
728 NVME_OPC_RESERVATION_REPORT = 0x0e,
729 /* 0x0f-0x10 - reserved */
730 NVME_OPC_RESERVATION_ACQUIRE = 0x11,
731 /* 0x12-0x14 - reserved */
732 NVME_OPC_RESERVATION_RELEASE = 0x15,
736 /* 0x00 - reserved */
737 NVME_FEAT_ARBITRATION = 0x01,
738 NVME_FEAT_POWER_MANAGEMENT = 0x02,
739 NVME_FEAT_LBA_RANGE_TYPE = 0x03,
740 NVME_FEAT_TEMPERATURE_THRESHOLD = 0x04,
741 NVME_FEAT_ERROR_RECOVERY = 0x05,
742 NVME_FEAT_VOLATILE_WRITE_CACHE = 0x06,
743 NVME_FEAT_NUMBER_OF_QUEUES = 0x07,
744 NVME_FEAT_INTERRUPT_COALESCING = 0x08,
745 NVME_FEAT_INTERRUPT_VECTOR_CONFIGURATION = 0x09,
746 NVME_FEAT_WRITE_ATOMICITY = 0x0A,
747 NVME_FEAT_ASYNC_EVENT_CONFIGURATION = 0x0B,
748 NVME_FEAT_AUTONOMOUS_POWER_STATE_TRANSITION = 0x0C,
749 NVME_FEAT_HOST_MEMORY_BUFFER = 0x0D,
750 NVME_FEAT_TIMESTAMP = 0x0E,
751 NVME_FEAT_KEEP_ALIVE_TIMER = 0x0F,
752 NVME_FEAT_HOST_CONTROLLED_THERMAL_MGMT = 0x10,
753 NVME_FEAT_NON_OP_POWER_STATE_CONFIG = 0x11,
754 NVME_FEAT_READ_RECOVERY_LEVEL_CONFIG = 0x12,
755 NVME_FEAT_PREDICTABLE_LATENCY_MODE_CONFIG = 0x13,
756 NVME_FEAT_PREDICTABLE_LATENCY_MODE_WINDOW = 0x14,
757 NVME_FEAT_LBA_STATUS_INFORMATION_ATTRIBUTES = 0x15,
758 NVME_FEAT_HOST_BEHAVIOR_SUPPORT = 0x16,
759 NVME_FEAT_SANITIZE_CONFIG = 0x17,
760 NVME_FEAT_ENDURANCE_GROUP_EVENT_CONFIGURATION = 0x18,
761 /* 0x19-0x77 - reserved */
762 /* 0x78-0x7f - NVMe Management Interface */
763 NVME_FEAT_SOFTWARE_PROGRESS_MARKER = 0x80,
764 NVME_FEAT_HOST_IDENTIFIER = 0x81,
765 NVME_FEAT_RESERVATION_NOTIFICATION_MASK = 0x82,
766 NVME_FEAT_RESERVATION_PERSISTENCE = 0x83,
767 NVME_FEAT_NAMESPACE_WRITE_PROTECTION_CONFIG = 0x84,
768 /* 0x85-0xBF - command set specific (reserved) */
769 /* 0xC0-0xFF - vendor specific */
772 enum nvme_dsm_attribute {
773 NVME_DSM_ATTR_INTEGRAL_READ = 0x1,
774 NVME_DSM_ATTR_INTEGRAL_WRITE = 0x2,
775 NVME_DSM_ATTR_DEALLOCATE = 0x4,
778 enum nvme_activate_action {
779 NVME_AA_REPLACE_NO_ACTIVATE = 0x0,
780 NVME_AA_REPLACE_ACTIVATE = 0x1,
781 NVME_AA_ACTIVATE = 0x2,
784 struct nvme_power_state {
786 uint16_t mp; /* Maximum Power */
788 uint8_t mps_nops; /* Max Power Scale, Non-Operational State */
790 uint32_t enlat; /* Entry Latency */
791 uint32_t exlat; /* Exit Latency */
793 uint8_t rrt; /* Relative Read Throughput */
794 uint8_t rrl; /* Relative Read Latency */
795 uint8_t rwt; /* Relative Write Throughput */
796 uint8_t rwl; /* Relative Write Latency */
798 uint16_t idlp; /* Idle Power */
799 uint8_t ips; /* Idle Power Scale */
802 uint16_t actp; /* Active Power */
803 uint8_t apw_aps; /* Active Power Workload, Active Power Scale */
804 uint8_t ps_rsvd10[9];
807 _Static_assert(sizeof(struct nvme_power_state) == 32, "bad size for nvme_power_state");
809 #define NVME_SERIAL_NUMBER_LENGTH 20
810 #define NVME_MODEL_NUMBER_LENGTH 40
811 #define NVME_FIRMWARE_REVISION_LENGTH 8
813 struct nvme_controller_data {
815 /* bytes 0-255: controller capabilities and features */
820 /** pci subsystem vendor id */
824 uint8_t sn[NVME_SERIAL_NUMBER_LENGTH];
827 uint8_t mn[NVME_MODEL_NUMBER_LENGTH];
829 /** firmware revision */
830 uint8_t fr[NVME_FIRMWARE_REVISION_LENGTH];
832 /** recommended arbitration burst */
835 /** ieee oui identifier */
838 /** multi-interface capabilities */
841 /** maximum data transfer size */
850 /** RTD3 Resume Latency */
853 /** RTD3 Enter Latency */
856 /** Optional Asynchronous Events Supported */
857 uint32_t oaes; /* bitfield really */
859 /** Controller Attributes */
860 uint32_t ctratt; /* bitfield really */
862 /** Read Recovery Levels Supported */
865 uint8_t reserved1[9];
867 /** Controller Type */
870 /** FRU Globally Unique Identifier */
873 /** Command Retry Delay Time 1 */
876 /** Command Retry Delay Time 2 */
879 /** Command Retry Delay Time 3 */
882 uint8_t reserved2[122];
884 /* bytes 256-511: admin command set attributes */
886 /** optional admin command support */
889 /** abort command limit */
892 /** asynchronous event request limit */
895 /** firmware updates */
898 /** log page attributes */
901 /** error log page entries */
904 /** number of power states supported */
907 /** admin vendor specific command configuration */
910 /** Autonomous Power State Transition Attributes */
913 /** Warning Composite Temperature Threshold */
916 /** Critical Composite Temperature Threshold */
919 /** Maximum Time for Firmware Activation */
922 /** Host Memory Buffer Preferred Size */
925 /** Host Memory Buffer Minimum Size */
928 /** Name space capabilities */
930 /* if nsmgmt, report tnvmcap and unvmcap */
935 /** Replay Protected Memory Block Support */
936 uint32_t rpmbs; /* Really a bitfield */
938 /** Extended Device Self-test Time */
941 /** Device Self-test Options */
942 uint8_t dsto; /* Really a bitfield */
944 /** Firmware Update Granularity */
947 /** Keep Alive Support */
950 /** Host Controlled Thermal Management Attributes */
951 uint16_t hctma; /* Really a bitfield */
953 /** Minimum Thermal Management Temperature */
956 /** Maximum Thermal Management Temperature */
959 /** Sanitize Capabilities */
960 uint32_t sanicap; /* Really a bitfield */
962 /** Host Memory Buffer Minimum Descriptor Entry Size */
965 /** Host Memory Maximum Descriptors Entries */
968 /** NVM Set Identifier Maximum */
971 /** Endurance Group Identifier Maximum */
974 /** ANA Transition Time */
977 /** Asymmetric Namespace Access Capabilities */
980 /** ANA Group Identifier Maximum */
983 /** Number of ANA Group Identifiers */
986 /** Persistent Event Log Size */
989 uint8_t reserved3[156];
990 /* bytes 512-703: nvm command set attributes */
992 /** submission queue entry size */
995 /** completion queue entry size */
998 /** Maximum Outstanding Commands */
1001 /** number of namespaces */
1004 /** optional nvm command support */
1007 /** fused operation support */
1010 /** format nvm attributes */
1013 /** volatile write cache */
1016 /** Atomic Write Unit Normal */
1019 /** Atomic Write Unit Power Fail */
1022 /** NVM Vendor Specific Command Configuration */
1025 /** Namespace Write Protection Capabilities */
1028 /** Atomic Compare & Write Unit */
1035 /** Maximum Number of Allowed Namespaces */
1038 /* bytes 540-767: Reserved */
1039 uint8_t reserved7[224];
1041 /** NVM Subsystem NVMe Qualified Name */
1042 uint8_t subnqn[256];
1044 /* bytes 1024-1791: Reserved */
1045 uint8_t reserved8[768];
1047 /* bytes 1792-2047: NVMe over Fabrics specification */
1048 uint8_t reserved9[256];
1050 /* bytes 2048-3071: power state descriptors */
1051 struct nvme_power_state power_state[32];
1053 /* bytes 3072-4095: vendor specific */
1055 } __packed __aligned(4);
1057 _Static_assert(sizeof(struct nvme_controller_data) == 4096, "bad size for nvme_controller_data");
1059 struct nvme_namespace_data {
1061 /** namespace size */
1064 /** namespace capacity */
1067 /** namespace utilization */
1070 /** namespace features */
1073 /** number of lba formats */
1076 /** formatted lba size */
1079 /** metadata capabilities */
1082 /** end-to-end data protection capabilities */
1085 /** end-to-end data protection type settings */
1088 /** Namespace Multi-path I/O and Namespace Sharing Capabilities */
1091 /** Reservation Capabilities */
1094 /** Format Progress Indicator */
1097 /** Deallocate Logical Block Features */
1100 /** Namespace Atomic Write Unit Normal */
1103 /** Namespace Atomic Write Unit Power Fail */
1106 /** Namespace Atomic Compare & Write Unit */
1109 /** Namespace Atomic Boundary Size Normal */
1112 /** Namespace Atomic Boundary Offset */
1115 /** Namespace Atomic Boundary Size Power Fail */
1118 /** Namespace Optimal IO Boundary */
1124 /** Namespace Preferred Write Granularity */
1127 /** Namespace Preferred Write Alignment */
1130 /** Namespace Preferred Deallocate Granularity */
1133 /** Namespace Preferred Deallocate Alignment */
1136 /** Namespace Optimal Write Size */
1139 /* bytes 74-91: Reserved */
1140 uint8_t reserved5[18];
1142 /** ANA Group Identifier */
1145 /* bytes 96-98: Reserved */
1146 uint8_t reserved6[3];
1148 /** Namespace Attributes */
1151 /** NVM Set Identifier */
1154 /** Endurance Group Identifier */
1157 /** Namespace Globally Unique Identifier */
1160 /** IEEE Extended Unique Identifier */
1163 /** lba format support */
1166 uint8_t reserved7[192];
1168 uint8_t vendor_specific[3712];
1169 } __packed __aligned(4);
1171 _Static_assert(sizeof(struct nvme_namespace_data) == 4096, "bad size for nvme_namepsace_data");
1173 enum nvme_log_page {
1175 /* 0x00 - reserved */
1176 NVME_LOG_ERROR = 0x01,
1177 NVME_LOG_HEALTH_INFORMATION = 0x02,
1178 NVME_LOG_FIRMWARE_SLOT = 0x03,
1179 NVME_LOG_CHANGED_NAMESPACE = 0x04,
1180 NVME_LOG_COMMAND_EFFECT = 0x05,
1181 NVME_LOG_DEVICE_SELF_TEST = 0x06,
1182 NVME_LOG_TELEMETRY_HOST_INITIATED = 0x07,
1183 NVME_LOG_TELEMETRY_CONTROLLER_INITIATED = 0x08,
1184 NVME_LOG_ENDURANCE_GROUP_INFORMATION = 0x09,
1185 NVME_LOG_PREDICTABLE_LATENCY_PER_NVM_SET = 0x0a,
1186 NVME_LOG_PREDICTABLE_LATENCY_EVENT_AGGREGATE = 0x0b,
1187 NVME_LOG_ASYMMETRIC_NAMESPAVE_ACCESS = 0x0c,
1188 NVME_LOG_PERSISTENT_EVENT_LOG = 0x0d,
1189 NVME_LOG_LBA_STATUS_INFORMATION = 0x0e,
1190 NVME_LOG_ENDURANCE_GROUP_EVENT_AGGREGATE = 0x0f,
1191 /* 0x06-0x7F - reserved */
1192 /* 0x80-0xBF - I/O command set specific */
1193 NVME_LOG_RES_NOTIFICATION = 0x80,
1194 NVME_LOG_SANITIZE_STATUS = 0x81,
1195 /* 0x82-0xBF - reserved */
1196 /* 0xC0-0xFF - vendor specific */
1199 * The following are Intel Specific log pages, but they seem
1200 * to be widely implemented.
1202 INTEL_LOG_READ_LAT_LOG = 0xc1,
1203 INTEL_LOG_WRITE_LAT_LOG = 0xc2,
1204 INTEL_LOG_TEMP_STATS = 0xc5,
1205 INTEL_LOG_ADD_SMART = 0xca,
1206 INTEL_LOG_DRIVE_MKT_NAME = 0xdd,
1209 * HGST log page, with lots ofs sub pages.
1211 HGST_INFO_LOG = 0xc1,
1214 struct nvme_error_information_entry {
1216 uint64_t error_count;
1220 uint16_t error_location;
1223 uint8_t vendor_specific;
1225 uint16_t reserved30;
1228 uint8_t reserved[22];
1229 } __packed __aligned(4);
1231 _Static_assert(sizeof(struct nvme_error_information_entry) == 64, "bad size for nvme_error_information_entry");
1233 struct nvme_health_information_page {
1235 uint8_t critical_warning;
1236 uint16_t temperature;
1237 uint8_t available_spare;
1238 uint8_t available_spare_threshold;
1239 uint8_t percentage_used;
1241 uint8_t reserved[26];
1244 * Note that the following are 128-bit values, but are
1245 * defined as an array of 2 64-bit values.
1247 /* Data Units Read is always in 512-byte units. */
1248 uint64_t data_units_read[2];
1249 /* Data Units Written is always in 512-byte units. */
1250 uint64_t data_units_written[2];
1251 /* For NVM command set, this includes Compare commands. */
1252 uint64_t host_read_commands[2];
1253 uint64_t host_write_commands[2];
1254 /* Controller Busy Time is reported in minutes. */
1255 uint64_t controller_busy_time[2];
1256 uint64_t power_cycles[2];
1257 uint64_t power_on_hours[2];
1258 uint64_t unsafe_shutdowns[2];
1259 uint64_t media_errors[2];
1260 uint64_t num_error_info_log_entries[2];
1261 uint32_t warning_temp_time;
1262 uint32_t error_temp_time;
1263 uint16_t temp_sensor[8];
1264 /* Thermal Management Temperature 1 Transition Count */
1266 /* Thermal Management Temperature 2 Transition Count */
1268 /* Total Time For Thermal Management Temperature 1 */
1270 /* Total Time For Thermal Management Temperature 2 */
1273 uint8_t reserved2[280];
1274 } __packed __aligned(4);
1276 _Static_assert(sizeof(struct nvme_health_information_page) == 512, "bad size for nvme_health_information_page");
1278 struct nvme_firmware_page {
1281 uint8_t reserved[7];
1282 uint64_t revision[7]; /* revisions for 7 slots */
1283 uint8_t reserved2[448];
1284 } __packed __aligned(4);
1286 _Static_assert(sizeof(struct nvme_firmware_page) == 512, "bad size for nvme_firmware_page");
1288 struct nvme_ns_list {
1290 } __packed __aligned(4);
1292 _Static_assert(sizeof(struct nvme_ns_list) == 4096, "bad size for nvme_ns_list");
1294 struct intel_log_temp_stats
1297 uint64_t overtemp_flag_last;
1298 uint64_t overtemp_flag_life;
1302 uint64_t max_oper_temp;
1303 uint64_t min_oper_temp;
1304 uint64_t est_offset;
1305 } __packed __aligned(4);
1307 _Static_assert(sizeof(struct intel_log_temp_stats) == 13 * 8, "bad size for intel_log_temp_stats");
1309 #define NVME_TEST_MAX_THREADS 128
1311 struct nvme_io_test {
1313 enum nvme_nvm_opcode opc;
1315 uint32_t time; /* in seconds */
1316 uint32_t num_threads;
1318 uint64_t io_completed[NVME_TEST_MAX_THREADS];
1321 enum nvme_io_test_flags {
1324 * Specifies whether dev_refthread/dev_relthread should be
1325 * called during NVME_BIO_TEST. Ignored for other test
1328 NVME_TEST_FLAG_REFTHREAD = 0x1,
1331 struct nvme_pt_command {
1334 * cmd is used to specify a passthrough command to a controller or
1337 * The following fields from cmd may be specified by the caller:
1339 * * nsid (namespace id) - for admin commands only
1342 * Remaining fields must be set to 0 by the caller.
1344 struct nvme_command cmd;
1347 * cpl returns completion status for the passthrough command
1350 * The following fields will be filled out by the driver, for
1351 * consumption by the caller:
1353 * * status (except for phase)
1355 * Remaining fields will be set to 0 by the driver.
1357 struct nvme_completion cpl;
1359 /* buf is the data buffer associated with this passthrough command. */
1363 * len is the length of the data buffer associated with this
1364 * passthrough command.
1369 * is_read = 1 if the passthrough command will read data into the
1370 * supplied buffer from the controller.
1372 * is_read = 0 if the passthrough command will write data from the
1373 * supplied buffer to the controller.
1378 * driver_lock is used by the driver only. It must be set to 0
1381 struct mtx * driver_lock;
1384 struct nvme_get_nsid {
1385 char cdev[SPECNAMELEN + 1];
1389 #define nvme_completion_is_error(cpl) \
1390 (NVME_STATUS_GET_SC((cpl)->status) != 0 || NVME_STATUS_GET_SCT((cpl)->status) != 0)
1392 void nvme_strvis(uint8_t *dst, const uint8_t *src, int dstlen, int srclen);
1399 struct nvme_namespace;
1400 struct nvme_controller;
1401 struct nvme_consumer;
1403 typedef void (*nvme_cb_fn_t)(void *, const struct nvme_completion *);
1405 typedef void *(*nvme_cons_ns_fn_t)(struct nvme_namespace *, void *);
1406 typedef void *(*nvme_cons_ctrlr_fn_t)(struct nvme_controller *);
1407 typedef void (*nvme_cons_async_fn_t)(void *, const struct nvme_completion *,
1408 uint32_t, void *, uint32_t);
1409 typedef void (*nvme_cons_fail_fn_t)(void *);
1411 enum nvme_namespace_flags {
1412 NVME_NS_DEALLOCATE_SUPPORTED = 0x1,
1413 NVME_NS_FLUSH_SUPPORTED = 0x2,
1416 int nvme_ctrlr_passthrough_cmd(struct nvme_controller *ctrlr,
1417 struct nvme_pt_command *pt,
1418 uint32_t nsid, int is_user_buffer,
1421 /* Admin functions */
1422 void nvme_ctrlr_cmd_set_feature(struct nvme_controller *ctrlr,
1423 uint8_t feature, uint32_t cdw11,
1424 void *payload, uint32_t payload_size,
1425 nvme_cb_fn_t cb_fn, void *cb_arg);
1426 void nvme_ctrlr_cmd_get_feature(struct nvme_controller *ctrlr,
1427 uint8_t feature, uint32_t cdw11,
1428 void *payload, uint32_t payload_size,
1429 nvme_cb_fn_t cb_fn, void *cb_arg);
1430 void nvme_ctrlr_cmd_get_log_page(struct nvme_controller *ctrlr,
1431 uint8_t log_page, uint32_t nsid,
1432 void *payload, uint32_t payload_size,
1433 nvme_cb_fn_t cb_fn, void *cb_arg);
1435 /* NVM I/O functions */
1436 int nvme_ns_cmd_write(struct nvme_namespace *ns, void *payload,
1437 uint64_t lba, uint32_t lba_count, nvme_cb_fn_t cb_fn,
1439 int nvme_ns_cmd_write_bio(struct nvme_namespace *ns, struct bio *bp,
1440 nvme_cb_fn_t cb_fn, void *cb_arg);
1441 int nvme_ns_cmd_read(struct nvme_namespace *ns, void *payload,
1442 uint64_t lba, uint32_t lba_count, nvme_cb_fn_t cb_fn,
1444 int nvme_ns_cmd_read_bio(struct nvme_namespace *ns, struct bio *bp,
1445 nvme_cb_fn_t cb_fn, void *cb_arg);
1446 int nvme_ns_cmd_deallocate(struct nvme_namespace *ns, void *payload,
1447 uint8_t num_ranges, nvme_cb_fn_t cb_fn,
1449 int nvme_ns_cmd_flush(struct nvme_namespace *ns, nvme_cb_fn_t cb_fn,
1451 int nvme_ns_dump(struct nvme_namespace *ns, void *virt, off_t offset,
1454 /* Registration functions */
1455 struct nvme_consumer * nvme_register_consumer(nvme_cons_ns_fn_t ns_fn,
1456 nvme_cons_ctrlr_fn_t ctrlr_fn,
1457 nvme_cons_async_fn_t async_fn,
1458 nvme_cons_fail_fn_t fail_fn);
1459 void nvme_unregister_consumer(struct nvme_consumer *consumer);
1461 /* Controller helper functions */
1462 device_t nvme_ctrlr_get_device(struct nvme_controller *ctrlr);
1463 const struct nvme_controller_data *
1464 nvme_ctrlr_get_data(struct nvme_controller *ctrlr);
1466 nvme_ctrlr_has_dataset_mgmt(const struct nvme_controller_data *cd)
1468 /* Assumes cd was byte swapped by nvme_controller_data_swapbytes() */
1469 return ((cd->oncs >> NVME_CTRLR_DATA_ONCS_DSM_SHIFT) &
1470 NVME_CTRLR_DATA_ONCS_DSM_MASK);
1473 /* Namespace helper functions */
1474 uint32_t nvme_ns_get_max_io_xfer_size(struct nvme_namespace *ns);
1475 uint32_t nvme_ns_get_sector_size(struct nvme_namespace *ns);
1476 uint64_t nvme_ns_get_num_sectors(struct nvme_namespace *ns);
1477 uint64_t nvme_ns_get_size(struct nvme_namespace *ns);
1478 uint32_t nvme_ns_get_flags(struct nvme_namespace *ns);
1479 const char * nvme_ns_get_serial_number(struct nvme_namespace *ns);
1480 const char * nvme_ns_get_model_number(struct nvme_namespace *ns);
1481 const struct nvme_namespace_data *
1482 nvme_ns_get_data(struct nvme_namespace *ns);
1483 uint32_t nvme_ns_get_stripesize(struct nvme_namespace *ns);
1485 int nvme_ns_bio_process(struct nvme_namespace *ns, struct bio *bp,
1486 nvme_cb_fn_t cb_fn);
1487 int nvme_ns_ioctl_process(struct nvme_namespace *ns, u_long cmd,
1488 caddr_t arg, int flag, struct thread *td);
1491 * Command building helper functions -- shared with CAM
1492 * These functions assume allocator zeros out cmd structure
1493 * CAM's xpt_get_ccb and the request allocator for nvme both
1494 * do zero'd allocations.
1497 void nvme_ns_flush_cmd(struct nvme_command *cmd, uint32_t nsid)
1500 cmd->opc = NVME_OPC_FLUSH;
1501 cmd->nsid = htole32(nsid);
1505 void nvme_ns_rw_cmd(struct nvme_command *cmd, uint32_t rwcmd, uint32_t nsid,
1506 uint64_t lba, uint32_t count)
1509 cmd->nsid = htole32(nsid);
1510 cmd->cdw10 = htole32(lba & 0xffffffffu);
1511 cmd->cdw11 = htole32(lba >> 32);
1512 cmd->cdw12 = htole32(count-1);
1516 void nvme_ns_write_cmd(struct nvme_command *cmd, uint32_t nsid,
1517 uint64_t lba, uint32_t count)
1519 nvme_ns_rw_cmd(cmd, NVME_OPC_WRITE, nsid, lba, count);
1523 void nvme_ns_read_cmd(struct nvme_command *cmd, uint32_t nsid,
1524 uint64_t lba, uint32_t count)
1526 nvme_ns_rw_cmd(cmd, NVME_OPC_READ, nsid, lba, count);
1530 void nvme_ns_trim_cmd(struct nvme_command *cmd, uint32_t nsid,
1531 uint32_t num_ranges)
1533 cmd->opc = NVME_OPC_DATASET_MANAGEMENT;
1534 cmd->nsid = htole32(nsid);
1535 cmd->cdw10 = htole32(num_ranges - 1);
1536 cmd->cdw11 = htole32(NVME_DSM_ATTR_DEALLOCATE);
1539 extern int nvme_use_nvd;
1541 #endif /* _KERNEL */
1543 /* Endianess conversion functions for NVMe structs */
1545 void nvme_completion_swapbytes(struct nvme_completion *s)
1548 s->cdw0 = le32toh(s->cdw0);
1550 s->sqhd = le16toh(s->sqhd);
1551 s->sqid = le16toh(s->sqid);
1553 s->status = le16toh(s->status);
1557 void nvme_power_state_swapbytes(struct nvme_power_state *s)
1560 s->mp = le16toh(s->mp);
1561 s->enlat = le32toh(s->enlat);
1562 s->exlat = le32toh(s->exlat);
1563 s->idlp = le16toh(s->idlp);
1564 s->actp = le16toh(s->actp);
1568 void nvme_controller_data_swapbytes(struct nvme_controller_data *s)
1572 s->vid = le16toh(s->vid);
1573 s->ssvid = le16toh(s->ssvid);
1574 s->ctrlr_id = le16toh(s->ctrlr_id);
1575 s->ver = le32toh(s->ver);
1576 s->rtd3r = le32toh(s->rtd3r);
1577 s->rtd3e = le32toh(s->rtd3e);
1578 s->oaes = le32toh(s->oaes);
1579 s->ctratt = le32toh(s->ctratt);
1580 s->rrls = le16toh(s->rrls);
1581 s->crdt1 = le16toh(s->crdt1);
1582 s->crdt2 = le16toh(s->crdt2);
1583 s->crdt3 = le16toh(s->crdt3);
1584 s->oacs = le16toh(s->oacs);
1585 s->wctemp = le16toh(s->wctemp);
1586 s->cctemp = le16toh(s->cctemp);
1587 s->mtfa = le16toh(s->mtfa);
1588 s->hmpre = le32toh(s->hmpre);
1589 s->hmmin = le32toh(s->hmmin);
1590 s->rpmbs = le32toh(s->rpmbs);
1591 s->edstt = le16toh(s->edstt);
1592 s->kas = le16toh(s->kas);
1593 s->hctma = le16toh(s->hctma);
1594 s->mntmt = le16toh(s->mntmt);
1595 s->mxtmt = le16toh(s->mxtmt);
1596 s->sanicap = le32toh(s->sanicap);
1597 s->hmminds = le32toh(s->hmminds);
1598 s->hmmaxd = le16toh(s->hmmaxd);
1599 s->nsetidmax = le16toh(s->nsetidmax);
1600 s->endgidmax = le16toh(s->endgidmax);
1601 s->anagrpmax = le32toh(s->anagrpmax);
1602 s->nanagrpid = le32toh(s->nanagrpid);
1603 s->pels = le32toh(s->pels);
1604 s->maxcmd = le16toh(s->maxcmd);
1605 s->nn = le32toh(s->nn);
1606 s->oncs = le16toh(s->oncs);
1607 s->fuses = le16toh(s->fuses);
1608 s->awun = le16toh(s->awun);
1609 s->awupf = le16toh(s->awupf);
1610 s->acwu = le16toh(s->acwu);
1611 s->sgls = le32toh(s->sgls);
1612 s->mnan = le32toh(s->mnan);
1613 for (i = 0; i < 32; i++)
1614 nvme_power_state_swapbytes(&s->power_state[i]);
1618 void nvme_namespace_data_swapbytes(struct nvme_namespace_data *s)
1622 s->nsze = le64toh(s->nsze);
1623 s->ncap = le64toh(s->ncap);
1624 s->nuse = le64toh(s->nuse);
1625 s->nawun = le16toh(s->nawun);
1626 s->nawupf = le16toh(s->nawupf);
1627 s->nacwu = le16toh(s->nacwu);
1628 s->nabsn = le16toh(s->nabsn);
1629 s->nabo = le16toh(s->nabo);
1630 s->nabspf = le16toh(s->nabspf);
1631 s->noiob = le16toh(s->noiob);
1632 s->npwg = le16toh(s->npwg);
1633 s->npwa = le16toh(s->npwa);
1634 s->npdg = le16toh(s->npdg);
1635 s->npda = le16toh(s->npda);
1636 s->nows = le16toh(s->nows);
1637 s->anagrpid = le32toh(s->anagrpid);
1638 s->nvmsetid = le16toh(s->nvmsetid);
1639 s->endgid = le16toh(s->endgid);
1640 for (i = 0; i < 16; i++)
1641 s->lbaf[i] = le32toh(s->lbaf[i]);
1645 void nvme_error_information_entry_swapbytes(struct nvme_error_information_entry *s)
1648 s->error_count = le64toh(s->error_count);
1649 s->sqid = le16toh(s->sqid);
1650 s->cid = le16toh(s->cid);
1651 s->status = le16toh(s->status);
1652 s->error_location = le16toh(s->error_location);
1653 s->lba = le64toh(s->lba);
1654 s->nsid = le32toh(s->nsid);
1655 s->csi = le64toh(s->csi);
1656 s->ttsi = le16toh(s->ttsi);
1660 void nvme_le128toh(void *p)
1662 #if _BYTE_ORDER != _LITTLE_ENDIAN
1663 /* Swap 16 bytes in place */
1664 char *tmp = (char*)p;
1667 for (i = 0; i < 8; i++) {
1678 void nvme_health_information_page_swapbytes(struct nvme_health_information_page *s)
1682 s->temperature = le16toh(s->temperature);
1683 nvme_le128toh((void *)s->data_units_read);
1684 nvme_le128toh((void *)s->data_units_written);
1685 nvme_le128toh((void *)s->host_read_commands);
1686 nvme_le128toh((void *)s->host_write_commands);
1687 nvme_le128toh((void *)s->controller_busy_time);
1688 nvme_le128toh((void *)s->power_cycles);
1689 nvme_le128toh((void *)s->power_on_hours);
1690 nvme_le128toh((void *)s->unsafe_shutdowns);
1691 nvme_le128toh((void *)s->media_errors);
1692 nvme_le128toh((void *)s->num_error_info_log_entries);
1693 s->warning_temp_time = le32toh(s->warning_temp_time);
1694 s->error_temp_time = le32toh(s->error_temp_time);
1695 for (i = 0; i < 8; i++)
1696 s->temp_sensor[i] = le16toh(s->temp_sensor[i]);
1697 s->tmt1tc = le32toh(s->tmt1tc);
1698 s->tmt2tc = le32toh(s->tmt2tc);
1699 s->ttftmt1 = le32toh(s->ttftmt1);
1700 s->ttftmt2 = le32toh(s->ttftmt2);
1705 void nvme_firmware_page_swapbytes(struct nvme_firmware_page *s)
1709 for (i = 0; i < 7; i++)
1710 s->revision[i] = le64toh(s->revision[i]);
1714 void nvme_ns_list_swapbytes(struct nvme_ns_list *s)
1718 for (i = 0; i < 1024; i++)
1719 s->ns[i] = le32toh(s->ns[i]);
1723 void intel_log_temp_stats_swapbytes(struct intel_log_temp_stats *s)
1726 s->current = le64toh(s->current);
1727 s->overtemp_flag_last = le64toh(s->overtemp_flag_last);
1728 s->overtemp_flag_life = le64toh(s->overtemp_flag_life);
1729 s->max_temp = le64toh(s->max_temp);
1730 s->min_temp = le64toh(s->min_temp);
1732 s->max_oper_temp = le64toh(s->max_oper_temp);
1733 s->min_oper_temp = le64toh(s->min_oper_temp);
1734 s->est_offset = le64toh(s->est_offset);
1737 #endif /* __NVME_H__ */
projects / FreeBSD / FreeBSD.git / blob