blob: dc815cc6718db546ef1c0ae80e1b7be7fd768bb3 [file] [log] [blame]
Matthew Wilcoxb60503b2011-01-20 12:50:14 -05001/*
2 * Definitions for the NVM Express interface
Matthew Wilcox8757ad62014-04-11 10:37:39 -04003 * Copyright (c) 2011-2014, Intel Corporation.
Matthew Wilcoxb60503b2011-01-20 12:50:14 -05004 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
Matthew Wilcoxb60503b2011-01-20 12:50:14 -050013 */
14
15#ifndef _LINUX_NVME_H
16#define _LINUX_NVME_H
17
Christoph Hellwig2812dfe2015-10-09 18:19:20 +020018#include <linux/types.h>
19
Christoph Hellwig7a67cbe2015-11-20 08:58:10 +010020enum {
21 NVME_REG_CAP = 0x0000, /* Controller Capabilities */
22 NVME_REG_VS = 0x0008, /* Version */
23 NVME_REG_INTMS = 0x000c, /* Interrupt Mask Set */
Wang Sheng-Huia5b714a2016-04-27 20:10:16 +080024 NVME_REG_INTMC = 0x0010, /* Interrupt Mask Clear */
Christoph Hellwig7a67cbe2015-11-20 08:58:10 +010025 NVME_REG_CC = 0x0014, /* Controller Configuration */
26 NVME_REG_CSTS = 0x001c, /* Controller Status */
27 NVME_REG_NSSR = 0x0020, /* NVM Subsystem Reset */
28 NVME_REG_AQA = 0x0024, /* Admin Queue Attributes */
29 NVME_REG_ASQ = 0x0028, /* Admin SQ Base Address */
Wang Sheng-Huia5b714a2016-04-27 20:10:16 +080030 NVME_REG_ACQ = 0x0030, /* Admin CQ Base Address */
Christoph Hellwig7a67cbe2015-11-20 08:58:10 +010031 NVME_REG_CMBLOC = 0x0038, /* Controller Memory Buffer Location */
32 NVME_REG_CMBSZ = 0x003c, /* Controller Memory Buffer Size */
Matthew Wilcoxb60503b2011-01-20 12:50:14 -050033};
34
Keith Buscha0cadb82012-07-27 13:57:23 -040035#define NVME_CAP_MQES(cap) ((cap) & 0xffff)
Matthew Wilcox22605f92011-04-19 15:04:20 -040036#define NVME_CAP_TIMEOUT(cap) (((cap) >> 24) & 0xff)
Matthew Wilcoxf1938f62011-10-20 17:00:41 -040037#define NVME_CAP_STRIDE(cap) (((cap) >> 32) & 0xf)
Keith Buschdfbac8c2015-08-10 15:20:40 -060038#define NVME_CAP_NSSRC(cap) (((cap) >> 36) & 0x1)
Keith Busch8fc23e02012-07-26 11:29:57 -060039#define NVME_CAP_MPSMIN(cap) (((cap) >> 48) & 0xf)
Keith Busch1d090622014-06-23 11:34:01 -060040#define NVME_CAP_MPSMAX(cap) (((cap) >> 52) & 0xf)
Matthew Wilcox22605f92011-04-19 15:04:20 -040041
Jon Derrick8ffaadf2015-07-20 10:14:09 -060042#define NVME_CMB_BIR(cmbloc) ((cmbloc) & 0x7)
43#define NVME_CMB_OFST(cmbloc) (((cmbloc) >> 12) & 0xfffff)
44#define NVME_CMB_SZ(cmbsz) (((cmbsz) >> 12) & 0xfffff)
45#define NVME_CMB_SZU(cmbsz) (((cmbsz) >> 8) & 0xf)
46
47#define NVME_CMB_WDS(cmbsz) ((cmbsz) & 0x10)
48#define NVME_CMB_RDS(cmbsz) ((cmbsz) & 0x8)
49#define NVME_CMB_LISTS(cmbsz) ((cmbsz) & 0x4)
50#define NVME_CMB_CQS(cmbsz) ((cmbsz) & 0x2)
51#define NVME_CMB_SQS(cmbsz) ((cmbsz) & 0x1)
52
Christoph Hellwig69cd27e2016-06-06 23:20:45 +020053/*
54 * Submission and Completion Queue Entry Sizes for the NVM command set.
55 * (In bytes and specified as a power of two (2^n)).
56 */
57#define NVME_NVM_IOSQES 6
58#define NVME_NVM_IOCQES 4
59
Matthew Wilcoxb60503b2011-01-20 12:50:14 -050060enum {
61 NVME_CC_ENABLE = 1 << 0,
62 NVME_CC_CSS_NVM = 0 << 4,
63 NVME_CC_MPS_SHIFT = 7,
64 NVME_CC_ARB_RR = 0 << 11,
65 NVME_CC_ARB_WRRU = 1 << 11,
Matthew Wilcox7f53f9d2011-03-22 15:55:45 -040066 NVME_CC_ARB_VS = 7 << 11,
67 NVME_CC_SHN_NONE = 0 << 14,
68 NVME_CC_SHN_NORMAL = 1 << 14,
69 NVME_CC_SHN_ABRUPT = 2 << 14,
Keith Busch1894d8f2013-07-15 15:02:22 -060070 NVME_CC_SHN_MASK = 3 << 14,
Christoph Hellwig69cd27e2016-06-06 23:20:45 +020071 NVME_CC_IOSQES = NVME_NVM_IOSQES << 16,
72 NVME_CC_IOCQES = NVME_NVM_IOCQES << 20,
Matthew Wilcoxb60503b2011-01-20 12:50:14 -050073 NVME_CSTS_RDY = 1 << 0,
74 NVME_CSTS_CFS = 1 << 1,
Keith Buschdfbac8c2015-08-10 15:20:40 -060075 NVME_CSTS_NSSRO = 1 << 4,
Matthew Wilcoxb60503b2011-01-20 12:50:14 -050076 NVME_CSTS_SHST_NORMAL = 0 << 2,
77 NVME_CSTS_SHST_OCCUR = 1 << 2,
78 NVME_CSTS_SHST_CMPLT = 2 << 2,
Keith Busch1894d8f2013-07-15 15:02:22 -060079 NVME_CSTS_SHST_MASK = 3 << 2,
Matthew Wilcoxb60503b2011-01-20 12:50:14 -050080};
81
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +020082struct nvme_id_power_state {
83 __le16 max_power; /* centiwatts */
84 __u8 rsvd2;
85 __u8 flags;
86 __le32 entry_lat; /* microseconds */
87 __le32 exit_lat; /* microseconds */
88 __u8 read_tput;
89 __u8 read_lat;
90 __u8 write_tput;
91 __u8 write_lat;
92 __le16 idle_power;
93 __u8 idle_scale;
94 __u8 rsvd19;
95 __le16 active_power;
96 __u8 active_work_scale;
97 __u8 rsvd23[9];
98};
99
100enum {
101 NVME_PS_FLAGS_MAX_POWER_SCALE = 1 << 0,
102 NVME_PS_FLAGS_NON_OP_STATE = 1 << 1,
103};
104
105struct nvme_id_ctrl {
106 __le16 vid;
107 __le16 ssvid;
108 char sn[20];
109 char mn[40];
110 char fr[8];
111 __u8 rab;
112 __u8 ieee[3];
113 __u8 mic;
114 __u8 mdts;
Christoph Hellwig08c69642015-10-02 15:27:16 +0200115 __le16 cntlid;
116 __le32 ver;
Christoph Hellwig14e974a2016-06-06 23:20:43 +0200117 __le32 rtd3r;
118 __le32 rtd3e;
119 __le32 oaes;
120 __u8 rsvd96[160];
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +0200121 __le16 oacs;
122 __u8 acl;
123 __u8 aerl;
124 __u8 frmw;
125 __u8 lpa;
126 __u8 elpe;
127 __u8 npss;
128 __u8 avscc;
129 __u8 apsta;
130 __le16 wctemp;
131 __le16 cctemp;
132 __u8 rsvd270[242];
133 __u8 sqes;
134 __u8 cqes;
135 __u8 rsvd514[2];
136 __le32 nn;
137 __le16 oncs;
138 __le16 fuses;
139 __u8 fna;
140 __u8 vwc;
141 __le16 awun;
142 __le16 awupf;
143 __u8 nvscc;
144 __u8 rsvd531;
145 __le16 acwu;
146 __u8 rsvd534[2];
147 __le32 sgls;
148 __u8 rsvd540[1508];
149 struct nvme_id_power_state psd[32];
150 __u8 vs[1024];
151};
152
153enum {
154 NVME_CTRL_ONCS_COMPARE = 1 << 0,
155 NVME_CTRL_ONCS_WRITE_UNCORRECTABLE = 1 << 1,
156 NVME_CTRL_ONCS_DSM = 1 << 2,
157 NVME_CTRL_VWC_PRESENT = 1 << 0,
158};
159
160struct nvme_lbaf {
161 __le16 ms;
162 __u8 ds;
163 __u8 rp;
164};
165
166struct nvme_id_ns {
167 __le64 nsze;
168 __le64 ncap;
169 __le64 nuse;
170 __u8 nsfeat;
171 __u8 nlbaf;
172 __u8 flbas;
173 __u8 mc;
174 __u8 dpc;
175 __u8 dps;
176 __u8 nmic;
177 __u8 rescap;
178 __u8 fpi;
179 __u8 rsvd33;
180 __le16 nawun;
181 __le16 nawupf;
182 __le16 nacwu;
183 __le16 nabsn;
184 __le16 nabo;
185 __le16 nabspf;
186 __u16 rsvd46;
187 __le64 nvmcap[2];
188 __u8 rsvd64[40];
189 __u8 nguid[16];
190 __u8 eui64[8];
191 struct nvme_lbaf lbaf[16];
192 __u8 rsvd192[192];
193 __u8 vs[3712];
194};
195
196enum {
197 NVME_NS_FEAT_THIN = 1 << 0,
198 NVME_NS_FLBAS_LBA_MASK = 0xf,
199 NVME_NS_FLBAS_META_EXT = 0x10,
200 NVME_LBAF_RP_BEST = 0,
201 NVME_LBAF_RP_BETTER = 1,
202 NVME_LBAF_RP_GOOD = 2,
203 NVME_LBAF_RP_DEGRADED = 3,
204 NVME_NS_DPC_PI_LAST = 1 << 4,
205 NVME_NS_DPC_PI_FIRST = 1 << 3,
206 NVME_NS_DPC_PI_TYPE3 = 1 << 2,
207 NVME_NS_DPC_PI_TYPE2 = 1 << 1,
208 NVME_NS_DPC_PI_TYPE1 = 1 << 0,
209 NVME_NS_DPS_PI_FIRST = 1 << 3,
210 NVME_NS_DPS_PI_MASK = 0x7,
211 NVME_NS_DPS_PI_TYPE1 = 1,
212 NVME_NS_DPS_PI_TYPE2 = 2,
213 NVME_NS_DPS_PI_TYPE3 = 3,
214};
215
216struct nvme_smart_log {
217 __u8 critical_warning;
218 __u8 temperature[2];
219 __u8 avail_spare;
220 __u8 spare_thresh;
221 __u8 percent_used;
222 __u8 rsvd6[26];
223 __u8 data_units_read[16];
224 __u8 data_units_written[16];
225 __u8 host_reads[16];
226 __u8 host_writes[16];
227 __u8 ctrl_busy_time[16];
228 __u8 power_cycles[16];
229 __u8 power_on_hours[16];
230 __u8 unsafe_shutdowns[16];
231 __u8 media_errors[16];
232 __u8 num_err_log_entries[16];
233 __le32 warning_temp_time;
234 __le32 critical_comp_time;
235 __le16 temp_sensor[8];
236 __u8 rsvd216[296];
237};
238
239enum {
240 NVME_SMART_CRIT_SPARE = 1 << 0,
241 NVME_SMART_CRIT_TEMPERATURE = 1 << 1,
242 NVME_SMART_CRIT_RELIABILITY = 1 << 2,
243 NVME_SMART_CRIT_MEDIA = 1 << 3,
244 NVME_SMART_CRIT_VOLATILE_MEMORY = 1 << 4,
245};
246
247enum {
248 NVME_AER_NOTICE_NS_CHANGED = 0x0002,
249};
250
251struct nvme_lba_range_type {
252 __u8 type;
253 __u8 attributes;
254 __u8 rsvd2[14];
255 __u64 slba;
256 __u64 nlb;
257 __u8 guid[16];
258 __u8 rsvd48[16];
259};
260
261enum {
262 NVME_LBART_TYPE_FS = 0x01,
263 NVME_LBART_TYPE_RAID = 0x02,
264 NVME_LBART_TYPE_CACHE = 0x03,
265 NVME_LBART_TYPE_SWAP = 0x04,
266
267 NVME_LBART_ATTRIB_TEMP = 1 << 0,
268 NVME_LBART_ATTRIB_HIDE = 1 << 1,
269};
270
271struct nvme_reservation_status {
272 __le32 gen;
273 __u8 rtype;
274 __u8 regctl[2];
275 __u8 resv5[2];
276 __u8 ptpls;
277 __u8 resv10[13];
278 struct {
279 __le16 cntlid;
280 __u8 rcsts;
281 __u8 resv3[5];
282 __le64 hostid;
283 __le64 rkey;
284 } regctl_ds[];
285};
286
Christoph Hellwig79f370e2016-06-06 23:20:46 +0200287enum nvme_async_event_type {
288 NVME_AER_TYPE_ERROR = 0,
289 NVME_AER_TYPE_SMART = 1,
290 NVME_AER_TYPE_NOTICE = 2,
291};
292
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +0200293/* I/O commands */
294
295enum nvme_opcode {
296 nvme_cmd_flush = 0x00,
297 nvme_cmd_write = 0x01,
298 nvme_cmd_read = 0x02,
299 nvme_cmd_write_uncor = 0x04,
300 nvme_cmd_compare = 0x05,
301 nvme_cmd_write_zeroes = 0x08,
302 nvme_cmd_dsm = 0x09,
303 nvme_cmd_resv_register = 0x0d,
304 nvme_cmd_resv_report = 0x0e,
305 nvme_cmd_resv_acquire = 0x11,
306 nvme_cmd_resv_release = 0x15,
307};
308
James Smart3972be22016-06-06 23:20:47 +0200309/*
310 * Lowest two bits of our flags field (FUSE field in the spec):
311 *
312 * @NVME_CMD_FUSE_FIRST: Fused Operation, first command
313 * @NVME_CMD_FUSE_SECOND: Fused Operation, second command
314 *
315 * Highest two bits in our flags field (PSDT field in the spec):
316 *
317 * @NVME_CMD_PSDT_SGL_METABUF: Use SGLS for this transfer,
318 * If used, MPTR contains addr of single physical buffer (byte aligned).
319 * @NVME_CMD_PSDT_SGL_METASEG: Use SGLS for this transfer,
320 * If used, MPTR contains an address of an SGL segment containing
321 * exactly 1 SGL descriptor (qword aligned).
322 */
323enum {
324 NVME_CMD_FUSE_FIRST = (1 << 0),
325 NVME_CMD_FUSE_SECOND = (1 << 1),
326
327 NVME_CMD_SGL_METABUF = (1 << 6),
328 NVME_CMD_SGL_METASEG = (1 << 7),
329 NVME_CMD_SGL_ALL = NVME_CMD_SGL_METABUF | NVME_CMD_SGL_METASEG,
330};
331
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +0200332struct nvme_common_command {
333 __u8 opcode;
334 __u8 flags;
335 __u16 command_id;
336 __le32 nsid;
337 __le32 cdw2[2];
338 __le64 metadata;
339 __le64 prp1;
340 __le64 prp2;
341 __le32 cdw10[6];
342};
343
344struct nvme_rw_command {
345 __u8 opcode;
346 __u8 flags;
347 __u16 command_id;
348 __le32 nsid;
349 __u64 rsvd2;
350 __le64 metadata;
351 __le64 prp1;
352 __le64 prp2;
353 __le64 slba;
354 __le16 length;
355 __le16 control;
356 __le32 dsmgmt;
357 __le32 reftag;
358 __le16 apptag;
359 __le16 appmask;
360};
361
362enum {
363 NVME_RW_LR = 1 << 15,
364 NVME_RW_FUA = 1 << 14,
365 NVME_RW_DSM_FREQ_UNSPEC = 0,
366 NVME_RW_DSM_FREQ_TYPICAL = 1,
367 NVME_RW_DSM_FREQ_RARE = 2,
368 NVME_RW_DSM_FREQ_READS = 3,
369 NVME_RW_DSM_FREQ_WRITES = 4,
370 NVME_RW_DSM_FREQ_RW = 5,
371 NVME_RW_DSM_FREQ_ONCE = 6,
372 NVME_RW_DSM_FREQ_PREFETCH = 7,
373 NVME_RW_DSM_FREQ_TEMP = 8,
374 NVME_RW_DSM_LATENCY_NONE = 0 << 4,
375 NVME_RW_DSM_LATENCY_IDLE = 1 << 4,
376 NVME_RW_DSM_LATENCY_NORM = 2 << 4,
377 NVME_RW_DSM_LATENCY_LOW = 3 << 4,
378 NVME_RW_DSM_SEQ_REQ = 1 << 6,
379 NVME_RW_DSM_COMPRESSED = 1 << 7,
380 NVME_RW_PRINFO_PRCHK_REF = 1 << 10,
381 NVME_RW_PRINFO_PRCHK_APP = 1 << 11,
382 NVME_RW_PRINFO_PRCHK_GUARD = 1 << 12,
383 NVME_RW_PRINFO_PRACT = 1 << 13,
384};
385
386struct nvme_dsm_cmd {
387 __u8 opcode;
388 __u8 flags;
389 __u16 command_id;
390 __le32 nsid;
391 __u64 rsvd2[2];
392 __le64 prp1;
393 __le64 prp2;
394 __le32 nr;
395 __le32 attributes;
396 __u32 rsvd12[4];
397};
398
399enum {
400 NVME_DSMGMT_IDR = 1 << 0,
401 NVME_DSMGMT_IDW = 1 << 1,
402 NVME_DSMGMT_AD = 1 << 2,
403};
404
405struct nvme_dsm_range {
406 __le32 cattr;
407 __le32 nlb;
408 __le64 slba;
409};
410
411/* Admin commands */
412
413enum nvme_admin_opcode {
414 nvme_admin_delete_sq = 0x00,
415 nvme_admin_create_sq = 0x01,
416 nvme_admin_get_log_page = 0x02,
417 nvme_admin_delete_cq = 0x04,
418 nvme_admin_create_cq = 0x05,
419 nvme_admin_identify = 0x06,
420 nvme_admin_abort_cmd = 0x08,
421 nvme_admin_set_features = 0x09,
422 nvme_admin_get_features = 0x0a,
423 nvme_admin_async_event = 0x0c,
424 nvme_admin_activate_fw = 0x10,
425 nvme_admin_download_fw = 0x11,
426 nvme_admin_format_nvm = 0x80,
427 nvme_admin_security_send = 0x81,
428 nvme_admin_security_recv = 0x82,
429};
430
431enum {
432 NVME_QUEUE_PHYS_CONTIG = (1 << 0),
433 NVME_CQ_IRQ_ENABLED = (1 << 1),
434 NVME_SQ_PRIO_URGENT = (0 << 1),
435 NVME_SQ_PRIO_HIGH = (1 << 1),
436 NVME_SQ_PRIO_MEDIUM = (2 << 1),
437 NVME_SQ_PRIO_LOW = (3 << 1),
438 NVME_FEAT_ARBITRATION = 0x01,
439 NVME_FEAT_POWER_MGMT = 0x02,
440 NVME_FEAT_LBA_RANGE = 0x03,
441 NVME_FEAT_TEMP_THRESH = 0x04,
442 NVME_FEAT_ERR_RECOVERY = 0x05,
443 NVME_FEAT_VOLATILE_WC = 0x06,
444 NVME_FEAT_NUM_QUEUES = 0x07,
445 NVME_FEAT_IRQ_COALESCE = 0x08,
446 NVME_FEAT_IRQ_CONFIG = 0x09,
447 NVME_FEAT_WRITE_ATOMIC = 0x0a,
448 NVME_FEAT_ASYNC_EVENT = 0x0b,
449 NVME_FEAT_AUTO_PST = 0x0c,
450 NVME_FEAT_SW_PROGRESS = 0x80,
451 NVME_FEAT_HOST_ID = 0x81,
452 NVME_FEAT_RESV_MASK = 0x82,
453 NVME_FEAT_RESV_PERSIST = 0x83,
454 NVME_LOG_ERROR = 0x01,
455 NVME_LOG_SMART = 0x02,
456 NVME_LOG_FW_SLOT = 0x03,
457 NVME_LOG_RESERVATION = 0x80,
458 NVME_FWACT_REPL = (0 << 3),
459 NVME_FWACT_REPL_ACTV = (1 << 3),
460 NVME_FWACT_ACTV = (2 << 3),
461};
462
463struct nvme_identify {
464 __u8 opcode;
465 __u8 flags;
466 __u16 command_id;
467 __le32 nsid;
468 __u64 rsvd2[2];
469 __le64 prp1;
470 __le64 prp2;
471 __le32 cns;
472 __u32 rsvd11[5];
473};
474
475struct nvme_features {
476 __u8 opcode;
477 __u8 flags;
478 __u16 command_id;
479 __le32 nsid;
480 __u64 rsvd2[2];
481 __le64 prp1;
482 __le64 prp2;
483 __le32 fid;
484 __le32 dword11;
485 __u32 rsvd12[4];
486};
487
488struct nvme_create_cq {
489 __u8 opcode;
490 __u8 flags;
491 __u16 command_id;
492 __u32 rsvd1[5];
493 __le64 prp1;
494 __u64 rsvd8;
495 __le16 cqid;
496 __le16 qsize;
497 __le16 cq_flags;
498 __le16 irq_vector;
499 __u32 rsvd12[4];
500};
501
502struct nvme_create_sq {
503 __u8 opcode;
504 __u8 flags;
505 __u16 command_id;
506 __u32 rsvd1[5];
507 __le64 prp1;
508 __u64 rsvd8;
509 __le16 sqid;
510 __le16 qsize;
511 __le16 sq_flags;
512 __le16 cqid;
513 __u32 rsvd12[4];
514};
515
516struct nvme_delete_queue {
517 __u8 opcode;
518 __u8 flags;
519 __u16 command_id;
520 __u32 rsvd1[9];
521 __le16 qid;
522 __u16 rsvd10;
523 __u32 rsvd11[5];
524};
525
526struct nvme_abort_cmd {
527 __u8 opcode;
528 __u8 flags;
529 __u16 command_id;
530 __u32 rsvd1[9];
531 __le16 sqid;
532 __u16 cid;
533 __u32 rsvd11[5];
534};
535
536struct nvme_download_firmware {
537 __u8 opcode;
538 __u8 flags;
539 __u16 command_id;
540 __u32 rsvd1[5];
541 __le64 prp1;
542 __le64 prp2;
543 __le32 numd;
544 __le32 offset;
545 __u32 rsvd12[4];
546};
547
548struct nvme_format_cmd {
549 __u8 opcode;
550 __u8 flags;
551 __u16 command_id;
552 __le32 nsid;
553 __u64 rsvd2[4];
554 __le32 cdw10;
555 __u32 rsvd11[5];
556};
557
Armen Baloyan725b3582016-06-06 23:20:44 +0200558struct nvme_get_log_page_command {
559 __u8 opcode;
560 __u8 flags;
561 __u16 command_id;
562 __le32 nsid;
563 __u64 rsvd2[2];
564 __le64 prp1;
565 __le64 prp2;
566 __u8 lid;
567 __u8 rsvd10;
568 __le16 numdl;
569 __le16 numdu;
570 __u16 rsvd11;
571 __le32 lpol;
572 __le32 lpou;
573 __u32 rsvd14[2];
574};
575
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +0200576struct nvme_command {
577 union {
578 struct nvme_common_command common;
579 struct nvme_rw_command rw;
580 struct nvme_identify identify;
581 struct nvme_features features;
582 struct nvme_create_cq create_cq;
583 struct nvme_create_sq create_sq;
584 struct nvme_delete_queue delete_queue;
585 struct nvme_download_firmware dlfw;
586 struct nvme_format_cmd format;
587 struct nvme_dsm_cmd dsm;
588 struct nvme_abort_cmd abort;
Armen Baloyan725b3582016-06-06 23:20:44 +0200589 struct nvme_get_log_page_command get_log_page;
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +0200590 };
591};
592
Christoph Hellwig7a5abb42016-06-06 23:20:49 +0200593static inline bool nvme_is_write(struct nvme_command *cmd)
594{
595 return cmd->common.opcode & 1;
596}
597
Christoph Hellwig9d99a8d2015-10-02 15:25:49 +0200598enum {
599 NVME_SC_SUCCESS = 0x0,
600 NVME_SC_INVALID_OPCODE = 0x1,
601 NVME_SC_INVALID_FIELD = 0x2,
602 NVME_SC_CMDID_CONFLICT = 0x3,
603 NVME_SC_DATA_XFER_ERROR = 0x4,
604 NVME_SC_POWER_LOSS = 0x5,
605 NVME_SC_INTERNAL = 0x6,
606 NVME_SC_ABORT_REQ = 0x7,
607 NVME_SC_ABORT_QUEUE = 0x8,
608 NVME_SC_FUSED_FAIL = 0x9,
609 NVME_SC_FUSED_MISSING = 0xa,
610 NVME_SC_INVALID_NS = 0xb,
611 NVME_SC_CMD_SEQ_ERROR = 0xc,
612 NVME_SC_SGL_INVALID_LAST = 0xd,
613 NVME_SC_SGL_INVALID_COUNT = 0xe,
614 NVME_SC_SGL_INVALID_DATA = 0xf,
615 NVME_SC_SGL_INVALID_METADATA = 0x10,
616 NVME_SC_SGL_INVALID_TYPE = 0x11,
617 NVME_SC_LBA_RANGE = 0x80,
618 NVME_SC_CAP_EXCEEDED = 0x81,
619 NVME_SC_NS_NOT_READY = 0x82,
620 NVME_SC_RESERVATION_CONFLICT = 0x83,
621 NVME_SC_CQ_INVALID = 0x100,
622 NVME_SC_QID_INVALID = 0x101,
623 NVME_SC_QUEUE_SIZE = 0x102,
624 NVME_SC_ABORT_LIMIT = 0x103,
625 NVME_SC_ABORT_MISSING = 0x104,
626 NVME_SC_ASYNC_LIMIT = 0x105,
627 NVME_SC_FIRMWARE_SLOT = 0x106,
628 NVME_SC_FIRMWARE_IMAGE = 0x107,
629 NVME_SC_INVALID_VECTOR = 0x108,
630 NVME_SC_INVALID_LOG_PAGE = 0x109,
631 NVME_SC_INVALID_FORMAT = 0x10a,
632 NVME_SC_FIRMWARE_NEEDS_RESET = 0x10b,
633 NVME_SC_INVALID_QUEUE = 0x10c,
634 NVME_SC_FEATURE_NOT_SAVEABLE = 0x10d,
635 NVME_SC_FEATURE_NOT_CHANGEABLE = 0x10e,
636 NVME_SC_FEATURE_NOT_PER_NS = 0x10f,
637 NVME_SC_FW_NEEDS_RESET_SUBSYS = 0x110,
638 NVME_SC_BAD_ATTRIBUTES = 0x180,
639 NVME_SC_INVALID_PI = 0x181,
640 NVME_SC_READ_ONLY = 0x182,
641 NVME_SC_WRITE_FAULT = 0x280,
642 NVME_SC_READ_ERROR = 0x281,
643 NVME_SC_GUARD_CHECK = 0x282,
644 NVME_SC_APPTAG_CHECK = 0x283,
645 NVME_SC_REFTAG_CHECK = 0x284,
646 NVME_SC_COMPARE_FAILED = 0x285,
647 NVME_SC_ACCESS_DENIED = 0x286,
648 NVME_SC_DNR = 0x4000,
649};
650
651struct nvme_completion {
652 __le32 result; /* Used by admin commands to return data */
653 __u32 rsvd;
654 __le16 sq_head; /* how much of this queue may be reclaimed */
655 __le16 sq_id; /* submission queue that generated this entry */
656 __u16 command_id; /* of the command which completed */
657 __le16 status; /* did the command fail, and if so, why? */
658};
659
660#define NVME_VS(major, minor) (((major) << 16) | ((minor) << 8))
661
Matthew Wilcoxb60503b2011-01-20 12:50:14 -0500662#endif /* _LINUX_NVME_H */