]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/nvme.h
projects / mirror_ubuntu-jammy-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'char-misc-5.7-rc7' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh...
[mirror_ubuntu-jammy-kernel.git] / include / linux / nvme.h
CommitLineData
fadccd8f 1/* SPDX-License-Identifier: GPL-2.0 */
b60503ba
MW		 2/*
3 * Definitions for the NVM Express interface
8757ad65 4 * Copyright (c) 2011-2014, Intel Corporation.
b60503ba
MW		 5 */
6
7#ifndef _LINUX_NVME_H
8#define _LINUX_NVME_H
9
2812dfe3 10#include <linux/types.h>
8e412263 11#include <linux/uuid.h>
eb793e2c
CH		 12
13/* NQN names in commands fields specified one size */
14#define NVMF_NQN_FIELD_LEN 256
15
16/* However the max length of a qualified name is another size */
17#define NVMF_NQN_SIZE 223
18
19#define NVMF_TRSVCID_SIZE 32
20#define NVMF_TRADDR_SIZE 256
21#define NVMF_TSAS_SIZE 256
22
23#define NVME_DISC_SUBSYS_NAME "nqn.2014-08.org.nvmexpress.discovery"
24
25#define NVME_RDMA_IP_PORT 4420
26
62346eae
AD		 27#define NVME_NSID_ALL 0xffffffff
28
eb793e2c
CH		 29enum nvme_subsys_type {
30 NVME_NQN_DISC = 1, /* Discovery type target subsystem */
31 NVME_NQN_NVME = 2, /* NVME type target subsystem */
32};
33
34/* Address Family codes for Discovery Log Page entry ADRFAM field */
35enum {
36 NVMF_ADDR_FAMILY_PCI = 0, /* PCIe */
37 NVMF_ADDR_FAMILY_IP4 = 1, /* IP4 */
38 NVMF_ADDR_FAMILY_IP6 = 2, /* IP6 */
39 NVMF_ADDR_FAMILY_IB = 3, /* InfiniBand */
40 NVMF_ADDR_FAMILY_FC = 4, /* Fibre Channel */
41};
42
43/* Transport Type codes for Discovery Log Page entry TRTYPE field */
44enum {
45 NVMF_TRTYPE_RDMA = 1, /* RDMA */
46 NVMF_TRTYPE_FC = 2, /* Fibre Channel */
fc221d05 47 NVMF_TRTYPE_TCP = 3, /* TCP/IP */
eb793e2c
CH		 48 NVMF_TRTYPE_LOOP = 254, /* Reserved for host usage */
49 NVMF_TRTYPE_MAX,
50};
51
52/* Transport Requirements codes for Discovery Log Page entry TREQ field */
53enum {
9b95d2fb
SG		 54 NVMF_TREQ_NOT_SPECIFIED = 0, /* Not specified */
55 NVMF_TREQ_REQUIRED = 1, /* Required */
56 NVMF_TREQ_NOT_REQUIRED = 2, /* Not Required */
0445e1b5
SG		 57#define NVME_TREQ_SECURE_CHANNEL_MASK \
58 (NVMF_TREQ_REQUIRED | NVMF_TREQ_NOT_REQUIRED)
9b95d2fb
SG		 59
60 NVMF_TREQ_DISABLE_SQFLOW = (1 << 2), /* Supports SQ flow control disable */
eb793e2c
CH		 61};
62
63/* RDMA QP Service Type codes for Discovery Log Page entry TSAS
64 * RDMA_QPTYPE field
65 */
66enum {
bf17aa36
RD		 67 NVMF_RDMA_QPTYPE_CONNECTED = 1, /* Reliable Connected */
68 NVMF_RDMA_QPTYPE_DATAGRAM = 2, /* Reliable Datagram */
eb793e2c
CH		 69};
70
71/* RDMA QP Service Type codes for Discovery Log Page entry TSAS
72 * RDMA_QPTYPE field
73 */
74enum {
bf17aa36
RD		 75 NVMF_RDMA_PRTYPE_NOT_SPECIFIED = 1, /* No Provider Specified */
76 NVMF_RDMA_PRTYPE_IB = 2, /* InfiniBand */
77 NVMF_RDMA_PRTYPE_ROCE = 3, /* InfiniBand RoCE */
78 NVMF_RDMA_PRTYPE_ROCEV2 = 4, /* InfiniBand RoCEV2 */
79 NVMF_RDMA_PRTYPE_IWARP = 5, /* IWARP */
eb793e2c
CH		 80};
81
82/* RDMA Connection Management Service Type codes for Discovery Log Page
83 * entry TSAS RDMA_CMS field
84 */
85enum {
bf17aa36 86 NVMF_RDMA_CMS_RDMA_CM = 1, /* Sockets based endpoint addressing */
eb793e2c
CH		 87};
88
7aa1f427 89#define NVME_AQ_DEPTH 32
38dabe21
KB		 90#define NVME_NR_AEN_COMMANDS 1
91#define NVME_AQ_BLK_MQ_DEPTH (NVME_AQ_DEPTH - NVME_NR_AEN_COMMANDS)
92
93/*
94 * Subtract one to leave an empty queue entry for 'Full Queue' condition. See
95 * NVM-Express 1.2 specification, section 4.1.2.
96 */
97#define NVME_AQ_MQ_TAG_DEPTH (NVME_AQ_BLK_MQ_DEPTH - 1)
2812dfe3 98
7a67cbea
CH		 99enum {
100 NVME_REG_CAP = 0x0000, /* Controller Capabilities */
101 NVME_REG_VS = 0x0008, /* Version */
102 NVME_REG_INTMS = 0x000c, /* Interrupt Mask Set */
a5b714ad 103 NVME_REG_INTMC = 0x0010, /* Interrupt Mask Clear */
7a67cbea
CH		 104 NVME_REG_CC = 0x0014, /* Controller Configuration */
105 NVME_REG_CSTS = 0x001c, /* Controller Status */
106 NVME_REG_NSSR = 0x0020, /* NVM Subsystem Reset */
107 NVME_REG_AQA = 0x0024, /* Admin Queue Attributes */
108 NVME_REG_ASQ = 0x0028, /* Admin SQ Base Address */
a5b714ad 109 NVME_REG_ACQ = 0x0030, /* Admin CQ Base Address */
48c9e85b 110 NVME_REG_CMBLOC = 0x0038, /* Controller Memory Buffer Location */
7a67cbea 111 NVME_REG_CMBSZ = 0x003c, /* Controller Memory Buffer Size */
48c9e85b
RR		 112 NVME_REG_BPINFO = 0x0040, /* Boot Partition Information */
113 NVME_REG_BPRSEL = 0x0044, /* Boot Partition Read Select */
114 NVME_REG_BPMBL = 0x0048, /* Boot Partition Memory Buffer
115 * Location
116 */
117 NVME_REG_PMRCAP = 0x0e00, /* Persistent Memory Capabilities */
118 NVME_REG_PMRCTL = 0x0e04, /* Persistent Memory Region Control */
119 NVME_REG_PMRSTS = 0x0e08, /* Persistent Memory Region Status */
120 NVME_REG_PMREBS = 0x0e0c, /* Persistent Memory Region Elasticity
121 * Buffer Size
122 */
123 NVME_REG_PMRSWTP = 0x0e10, /* Persistent Memory Region Sustained
124 * Write Throughput
125 */
97f6ef64 126 NVME_REG_DBS = 0x1000, /* SQ 0 Tail Doorbell */
b60503ba
MW		 127};
128
a0cadb85 129#define NVME_CAP_MQES(cap) ((cap) & 0xffff)
22605f96 130#define NVME_CAP_TIMEOUT(cap) (((cap) >> 24) & 0xff)
f1938f6e 131#define NVME_CAP_STRIDE(cap) (((cap) >> 32) & 0xf)
dfbac8c7 132#define NVME_CAP_NSSRC(cap) (((cap) >> 36) & 0x1)
8fc23e03 133#define NVME_CAP_MPSMIN(cap) (((cap) >> 48) & 0xf)
1d090624 134#define NVME_CAP_MPSMAX(cap) (((cap) >> 52) & 0xf)
22605f96 135
8ffaadf7
JD		 136#define NVME_CMB_BIR(cmbloc) ((cmbloc) & 0x7)
137#define NVME_CMB_OFST(cmbloc) (((cmbloc) >> 12) & 0xfffff)
88de4598
CH		 138
139enum {
140 NVME_CMBSZ_SQS = 1 << 0,
141 NVME_CMBSZ_CQS = 1 << 1,
142 NVME_CMBSZ_LISTS = 1 << 2,
143 NVME_CMBSZ_RDS = 1 << 3,
144 NVME_CMBSZ_WDS = 1 << 4,
145
146 NVME_CMBSZ_SZ_SHIFT = 12,
147 NVME_CMBSZ_SZ_MASK = 0xfffff,
148
149 NVME_CMBSZ_SZU_SHIFT = 8,
150 NVME_CMBSZ_SZU_MASK = 0xf,
151};
8ffaadf7 152
69cd27e2
CH		 153/*
154 * Submission and Completion Queue Entry Sizes for the NVM command set.
155 * (In bytes and specified as a power of two (2^n)).
156 */
c1e0cc7e 157#define NVME_ADM_SQES 6
69cd27e2
CH		 158#define NVME_NVM_IOSQES 6
159#define NVME_NVM_IOCQES 4
160
b60503ba
MW		 161enum {
162 NVME_CC_ENABLE = 1 << 0,
163 NVME_CC_CSS_NVM = 0 << 4,
ad4e05b2
MG		 164 NVME_CC_EN_SHIFT = 0,
165 NVME_CC_CSS_SHIFT = 4,
b60503ba 166 NVME_CC_MPS_SHIFT = 7,
ad4e05b2
MG		 167 NVME_CC_AMS_SHIFT = 11,
168 NVME_CC_SHN_SHIFT = 14,
169 NVME_CC_IOSQES_SHIFT = 16,
170 NVME_CC_IOCQES_SHIFT = 20,
60b43f62
MG		 171 NVME_CC_AMS_RR = 0 << NVME_CC_AMS_SHIFT,
172 NVME_CC_AMS_WRRU = 1 << NVME_CC_AMS_SHIFT,
173 NVME_CC_AMS_VS = 7 << NVME_CC_AMS_SHIFT,
ad4e05b2
MG		 174 NVME_CC_SHN_NONE = 0 << NVME_CC_SHN_SHIFT,
175 NVME_CC_SHN_NORMAL = 1 << NVME_CC_SHN_SHIFT,
176 NVME_CC_SHN_ABRUPT = 2 << NVME_CC_SHN_SHIFT,
177 NVME_CC_SHN_MASK = 3 << NVME_CC_SHN_SHIFT,
178 NVME_CC_IOSQES = NVME_NVM_IOSQES << NVME_CC_IOSQES_SHIFT,
179 NVME_CC_IOCQES = NVME_NVM_IOCQES << NVME_CC_IOCQES_SHIFT,
b60503ba
MW		 180 NVME_CSTS_RDY = 1 << 0,
181 NVME_CSTS_CFS = 1 << 1,
dfbac8c7 182 NVME_CSTS_NSSRO = 1 << 4,
b6dccf7f 183 NVME_CSTS_PP = 1 << 5,
b60503ba
MW		 184 NVME_CSTS_SHST_NORMAL = 0 << 2,
185 NVME_CSTS_SHST_OCCUR = 1 << 2,
186 NVME_CSTS_SHST_CMPLT = 2 << 2,
1894d8f1 187 NVME_CSTS_SHST_MASK = 3 << 2,
b60503ba
MW		 188};
189
9d99a8dd
CH		 190struct nvme_id_power_state {
191 __le16 max_power; /* centiwatts */
192 __u8 rsvd2;
193 __u8 flags;
194 __le32 entry_lat; /* microseconds */
195 __le32 exit_lat; /* microseconds */
196 __u8 read_tput;
197 __u8 read_lat;
198 __u8 write_tput;
199 __u8 write_lat;
200 __le16 idle_power;
201 __u8 idle_scale;
202 __u8 rsvd19;
203 __le16 active_power;
204 __u8 active_work_scale;
205 __u8 rsvd23[9];
206};
207
208enum {
209 NVME_PS_FLAGS_MAX_POWER_SCALE = 1 << 0,
210 NVME_PS_FLAGS_NON_OP_STATE = 1 << 1,
211};
212
12b21171
SG		 213enum nvme_ctrl_attr {
214 NVME_CTRL_ATTR_HID_128_BIT = (1 << 0),
6e3ca03e 215 NVME_CTRL_ATTR_TBKAS = (1 << 6),
12b21171
SG		 216};
217
9d99a8dd
CH		 218struct nvme_id_ctrl {
219 __le16 vid;
220 __le16 ssvid;
221 char sn[20];
222 char mn[40];
223 char fr[8];
224 __u8 rab;
225 __u8 ieee[3];
a446c084 226 __u8 cmic;
9d99a8dd 227 __u8 mdts;
08c69640
CH		 228 __le16 cntlid;
229 __le32 ver;
14e974a8
CH		 230 __le32 rtd3r;
231 __le32 rtd3e;
232 __le32 oaes;
eb793e2c 233 __le32 ctratt;
49cd84b6
KB		 234 __u8 rsvd100[28];
235 __le16 crdt1;
236 __le16 crdt2;
237 __le16 crdt3;
238 __u8 rsvd134[122];
9d99a8dd
CH		 239 __le16 oacs;
240 __u8 acl;
241 __u8 aerl;
242 __u8 frmw;
243 __u8 lpa;
244 __u8 elpe;
245 __u8 npss;
246 __u8 avscc;
247 __u8 apsta;
248 __le16 wctemp;
249 __le16 cctemp;
a446c084
CH		 250 __le16 mtfa;
251 __le32 hmpre;
252 __le32 hmmin;
253 __u8 tnvmcap[16];
254 __u8 unvmcap[16];
255 __le32 rpmbs;
435e8090
GJ		 256 __le16 edstt;
257 __u8 dsto;
258 __u8 fwug;
7b89eae2 259 __le16 kas;
435e8090
GJ		 260 __le16 hctma;
261 __le16 mntmt;
262 __le16 mxtmt;
263 __le32 sanicap;
044a9df1
CH		 264 __le32 hmminds;
265 __le16 hmmaxd;
1a376216
CH		 266 __u8 rsvd338[4];
267 __u8 anatt;
268 __u8 anacap;
269 __le32 anagrpmax;
270 __le32 nanagrpid;
271 __u8 rsvd352[160];
9d99a8dd
CH		 272 __u8 sqes;
273 __u8 cqes;
eb793e2c 274 __le16 maxcmd;
9d99a8dd
CH		 275 __le32 nn;
276 __le16 oncs;
277 __le16 fuses;
278 __u8 fna;
279 __u8 vwc;
280 __le16 awun;
281 __le16 awupf;
282 __u8 nvscc;
93045d59 283 __u8 nwpc;
9d99a8dd
CH		 284 __le16 acwu;
285 __u8 rsvd534[2];
286 __le32 sgls;
1a376216
CH		 287 __le32 mnan;
288 __u8 rsvd544[224];
eb793e2c
CH		 289 char subnqn[256];
290 __u8 rsvd1024[768];
291 __le32 ioccsz;
292 __le32 iorcsz;
293 __le16 icdoff;
294 __u8 ctrattr;
295 __u8 msdbd;
296 __u8 rsvd1804[244];
9d99a8dd
CH		 297 struct nvme_id_power_state psd[32];
298 __u8 vs[1024];
299};
300
301enum {
302 NVME_CTRL_ONCS_COMPARE = 1 << 0,
303 NVME_CTRL_ONCS_WRITE_UNCORRECTABLE = 1 << 1,
304 NVME_CTRL_ONCS_DSM = 1 << 2,
3b7c33b2 305 NVME_CTRL_ONCS_WRITE_ZEROES = 1 << 3,
dbf86b39 306 NVME_CTRL_ONCS_TIMESTAMP = 1 << 6,
9d99a8dd 307 NVME_CTRL_VWC_PRESENT = 1 << 0,
8a9ae523 308 NVME_CTRL_OACS_SEC_SUPP = 1 << 0,
f5d11840 309 NVME_CTRL_OACS_DIRECTIVES = 1 << 5,
223694b9 310 NVME_CTRL_OACS_DBBUF_SUPP = 1 << 8,
84fef62d 311 NVME_CTRL_LPA_CMD_EFFECTS_LOG = 1 << 1,
48c9e85b
RR		 312 NVME_CTRL_CTRATT_128_ID = 1 << 0,
313 NVME_CTRL_CTRATT_NON_OP_PSP = 1 << 1,
314 NVME_CTRL_CTRATT_NVM_SETS = 1 << 2,
315 NVME_CTRL_CTRATT_READ_RECV_LVLS = 1 << 3,
316 NVME_CTRL_CTRATT_ENDURANCE_GROUPS = 1 << 4,
317 NVME_CTRL_CTRATT_PREDICTABLE_LAT = 1 << 5,
318 NVME_CTRL_CTRATT_NAMESPACE_GRANULARITY = 1 << 7,
319 NVME_CTRL_CTRATT_UUID_LIST = 1 << 9,
9d99a8dd
CH		 320};
321
322struct nvme_lbaf {
323 __le16 ms;
324 __u8 ds;
325 __u8 rp;
326};
327
328struct nvme_id_ns {
329 __le64 nsze;
330 __le64 ncap;
331 __le64 nuse;
332 __u8 nsfeat;
333 __u8 nlbaf;
334 __u8 flbas;
335 __u8 mc;
336 __u8 dpc;
337 __u8 dps;
338 __u8 nmic;
339 __u8 rescap;
340 __u8 fpi;
6605bdd5 341 __u8 dlfeat;
9d99a8dd
CH		 342 __le16 nawun;
343 __le16 nawupf;
344 __le16 nacwu;
345 __le16 nabsn;
346 __le16 nabo;
347 __le16 nabspf;
6b8190d6 348 __le16 noiob;
a446c084 349 __u8 nvmcap[16];
6605bdd5
BVA		 350 __le16 npwg;
351 __le16 npwa;
352 __le16 npdg;
353 __le16 npda;
354 __le16 nows;
355 __u8 rsvd74[18];
1a376216 356 __le32 anagrpid;
93045d59
CK		 357 __u8 rsvd96[3];
358 __u8 nsattr;
6605bdd5
BVA		 359 __le16 nvmsetid;
360 __le16 endgid;
9d99a8dd
CH		 361 __u8 nguid[16];
362 __u8 eui64[8];
363 struct nvme_lbaf lbaf[16];
364 __u8 rsvd192[192];
365 __u8 vs[3712];
366};
367
329dd768
CH		 368enum {
369 NVME_ID_CNS_NS = 0x00,
370 NVME_ID_CNS_CTRL = 0x01,
371 NVME_ID_CNS_NS_ACTIVE_LIST = 0x02,
af8b86e9 372 NVME_ID_CNS_NS_DESC_LIST = 0x03,
329dd768
CH		 373 NVME_ID_CNS_NS_PRESENT_LIST = 0x10,
374 NVME_ID_CNS_NS_PRESENT = 0x11,
375 NVME_ID_CNS_CTRL_NS_LIST = 0x12,
376 NVME_ID_CNS_CTRL_LIST = 0x13,
48c9e85b
RR		 377 NVME_ID_CNS_SCNDRY_CTRL_LIST = 0x15,
378 NVME_ID_CNS_NS_GRANULARITY = 0x16,
379 NVME_ID_CNS_UUID_LIST = 0x17,
329dd768
CH		 380};
381
f5d11840
JA		 382enum {
383 NVME_DIR_IDENTIFY = 0x00,
384 NVME_DIR_STREAMS = 0x01,
385 NVME_DIR_SND_ID_OP_ENABLE = 0x01,
386 NVME_DIR_SND_ST_OP_REL_ID = 0x01,
387 NVME_DIR_SND_ST_OP_REL_RSC = 0x02,
388 NVME_DIR_RCV_ID_OP_PARAM = 0x01,
389 NVME_DIR_RCV_ST_OP_PARAM = 0x01,
390 NVME_DIR_RCV_ST_OP_STATUS = 0x02,
391 NVME_DIR_RCV_ST_OP_RESOURCE = 0x03,
392 NVME_DIR_ENDIR = 0x01,
393};
394
9d99a8dd
CH		 395enum {
396 NVME_NS_FEAT_THIN = 1 << 0,
397 NVME_NS_FLBAS_LBA_MASK = 0xf,
398 NVME_NS_FLBAS_META_EXT = 0x10,
399 NVME_LBAF_RP_BEST = 0,
400 NVME_LBAF_RP_BETTER = 1,
401 NVME_LBAF_RP_GOOD = 2,
402 NVME_LBAF_RP_DEGRADED = 3,
403 NVME_NS_DPC_PI_LAST = 1 << 4,
404 NVME_NS_DPC_PI_FIRST = 1 << 3,
405 NVME_NS_DPC_PI_TYPE3 = 1 << 2,
406 NVME_NS_DPC_PI_TYPE2 = 1 << 1,
407 NVME_NS_DPC_PI_TYPE1 = 1 << 0,
408 NVME_NS_DPS_PI_FIRST = 1 << 3,
409 NVME_NS_DPS_PI_MASK = 0x7,
410 NVME_NS_DPS_PI_TYPE1 = 1,
411 NVME_NS_DPS_PI_TYPE2 = 2,
412 NVME_NS_DPS_PI_TYPE3 = 3,
413};
414
af8b86e9
JT		 415struct nvme_ns_id_desc {
416 __u8 nidt;
417 __u8 nidl;
418 __le16 reserved;
419};
420
421#define NVME_NIDT_EUI64_LEN 8
422#define NVME_NIDT_NGUID_LEN 16
423#define NVME_NIDT_UUID_LEN 16
424
425enum {
426 NVME_NIDT_EUI64 = 0x01,
427 NVME_NIDT_NGUID = 0x02,
428 NVME_NIDT_UUID = 0x03,
429};
430
9d99a8dd
CH		 431struct nvme_smart_log {
432 __u8 critical_warning;
433 __u8 temperature[2];
434 __u8 avail_spare;
435 __u8 spare_thresh;
436 __u8 percent_used;
48c9e85b
RR		 437 __u8 endu_grp_crit_warn_sumry;
438 __u8 rsvd7[25];
9d99a8dd
CH		 439 __u8 data_units_read[16];
440 __u8 data_units_written[16];
441 __u8 host_reads[16];
442 __u8 host_writes[16];
443 __u8 ctrl_busy_time[16];
444 __u8 power_cycles[16];
445 __u8 power_on_hours[16];
446 __u8 unsafe_shutdowns[16];
447 __u8 media_errors[16];
448 __u8 num_err_log_entries[16];
449 __le32 warning_temp_time;
450 __le32 critical_comp_time;
451 __le16 temp_sensor[8];
48c9e85b
RR		 452 __le32 thm_temp1_trans_count;
453 __le32 thm_temp2_trans_count;
454 __le32 thm_temp1_total_time;
455 __le32 thm_temp2_total_time;
456 __u8 rsvd232[280];
9d99a8dd
CH		 457};
458
b6dccf7f
AD		 459struct nvme_fw_slot_info_log {
460 __u8 afi;
461 __u8 rsvd1[7];
462 __le64 frs[7];
463 __u8 rsvd64[448];
464};
465
84fef62d
KB		 466enum {
467 NVME_CMD_EFFECTS_CSUPP = 1 << 0,
468 NVME_CMD_EFFECTS_LBCC = 1 << 1,
469 NVME_CMD_EFFECTS_NCC = 1 << 2,
470 NVME_CMD_EFFECTS_NIC = 1 << 3,
471 NVME_CMD_EFFECTS_CCC = 1 << 4,
472 NVME_CMD_EFFECTS_CSE_MASK = 3 << 16,
48c9e85b 473 NVME_CMD_EFFECTS_UUID_SEL = 1 << 19,
84fef62d
KB		 474};
475
476struct nvme_effects_log {
477 __le32 acs[256];
478 __le32 iocs[256];
479 __u8 resv[2048];
480};
481
1a376216
CH		 482enum nvme_ana_state {
483 NVME_ANA_OPTIMIZED = 0x01,
484 NVME_ANA_NONOPTIMIZED = 0x02,
485 NVME_ANA_INACCESSIBLE = 0x03,
486 NVME_ANA_PERSISTENT_LOSS = 0x04,
487 NVME_ANA_CHANGE = 0x0f,
488};
489
490struct nvme_ana_group_desc {
491 __le32 grpid;
492 __le32 nnsids;
493 __le64 chgcnt;
494 __u8 state;
8b92d0e3 495 __u8 rsvd17[15];
1a376216
CH		 496 __le32 nsids[];
497};
498
499/* flag for the log specific field of the ANA log */
500#define NVME_ANA_LOG_RGO (1 << 0)
501
502struct nvme_ana_rsp_hdr {
503 __le64 chgcnt;
504 __le16 ngrps;
505 __le16 rsvd10[3];
506};
507
9d99a8dd
CH		 508enum {
509 NVME_SMART_CRIT_SPARE = 1 << 0,
510 NVME_SMART_CRIT_TEMPERATURE = 1 << 1,
511 NVME_SMART_CRIT_RELIABILITY = 1 << 2,
512 NVME_SMART_CRIT_MEDIA = 1 << 3,
513 NVME_SMART_CRIT_VOLATILE_MEMORY = 1 << 4,
514};
515
516enum {
e3d7874d
KB		 517 NVME_AER_ERROR = 0,
518 NVME_AER_SMART = 1,
868c2392 519 NVME_AER_NOTICE = 2,
e3d7874d
KB		 520 NVME_AER_CSS = 6,
521 NVME_AER_VS = 7,
868c2392
CH		 522};
523
524enum {
525 NVME_AER_NOTICE_NS_CHANGED = 0x00,
526 NVME_AER_NOTICE_FW_ACT_STARTING = 0x01,
1a376216 527 NVME_AER_NOTICE_ANA = 0x03,
f301c2b1 528 NVME_AER_NOTICE_DISC_CHANGED = 0xf0,
9d99a8dd
CH		 529};
530
aafd3afe 531enum {
7114ddeb
JS		 532 NVME_AEN_BIT_NS_ATTR = 8,
533 NVME_AEN_BIT_FW_ACT = 9,
534 NVME_AEN_BIT_ANA_CHANGE = 11,
f301c2b1 535 NVME_AEN_BIT_DISC_CHANGE = 31,
7114ddeb
JS		 536};
537
538enum {
539 NVME_AEN_CFG_NS_ATTR = 1 << NVME_AEN_BIT_NS_ATTR,
540 NVME_AEN_CFG_FW_ACT = 1 << NVME_AEN_BIT_FW_ACT,
541 NVME_AEN_CFG_ANA_CHANGE = 1 << NVME_AEN_BIT_ANA_CHANGE,
f301c2b1 542 NVME_AEN_CFG_DISC_CHANGE = 1 << NVME_AEN_BIT_DISC_CHANGE,
aafd3afe
HR		 543};
544
9d99a8dd
CH		 545struct nvme_lba_range_type {
546 __u8 type;
547 __u8 attributes;
548 __u8 rsvd2[14];
549 __u64 slba;
550 __u64 nlb;
551 __u8 guid[16];
552 __u8 rsvd48[16];
553};
554
555enum {
556 NVME_LBART_TYPE_FS = 0x01,
557 NVME_LBART_TYPE_RAID = 0x02,
558 NVME_LBART_TYPE_CACHE = 0x03,
559 NVME_LBART_TYPE_SWAP = 0x04,
560
561 NVME_LBART_ATTRIB_TEMP = 1 << 0,
562 NVME_LBART_ATTRIB_HIDE = 1 << 1,
563};
564
565struct nvme_reservation_status {
566 __le32 gen;
567 __u8 rtype;
568 __u8 regctl[2];
569 __u8 resv5[2];
570 __u8 ptpls;
571 __u8 resv10[13];
572 struct {
573 __le16 cntlid;
574 __u8 rcsts;
575 __u8 resv3[5];
576 __le64 hostid;
577 __le64 rkey;
578 } regctl_ds[];
579};
580
79f370ea
CH		 581enum nvme_async_event_type {
582 NVME_AER_TYPE_ERROR = 0,
583 NVME_AER_TYPE_SMART = 1,
584 NVME_AER_TYPE_NOTICE = 2,
585};
586
9d99a8dd
CH		 587/* I/O commands */
588
589enum nvme_opcode {
590 nvme_cmd_flush = 0x00,
591 nvme_cmd_write = 0x01,
592 nvme_cmd_read = 0x02,
593 nvme_cmd_write_uncor = 0x04,
594 nvme_cmd_compare = 0x05,
595 nvme_cmd_write_zeroes = 0x08,
596 nvme_cmd_dsm = 0x09,
48c9e85b 597 nvme_cmd_verify = 0x0c,
9d99a8dd
CH		 598 nvme_cmd_resv_register = 0x0d,
599 nvme_cmd_resv_report = 0x0e,
600 nvme_cmd_resv_acquire = 0x11,
601 nvme_cmd_resv_release = 0x15,
602};
603
26f2990d
MI		 604#define nvme_opcode_name(opcode) { opcode, #opcode }
605#define show_nvm_opcode_name(val) \
606 __print_symbolic(val, \
607 nvme_opcode_name(nvme_cmd_flush), \
608 nvme_opcode_name(nvme_cmd_write), \
609 nvme_opcode_name(nvme_cmd_read), \
610 nvme_opcode_name(nvme_cmd_write_uncor), \
611 nvme_opcode_name(nvme_cmd_compare), \
612 nvme_opcode_name(nvme_cmd_write_zeroes), \
613 nvme_opcode_name(nvme_cmd_dsm), \
614 nvme_opcode_name(nvme_cmd_resv_register), \
615 nvme_opcode_name(nvme_cmd_resv_report), \
616 nvme_opcode_name(nvme_cmd_resv_acquire), \
617 nvme_opcode_name(nvme_cmd_resv_release))
618
619
eb793e2c
CH		 620/*
621 * Descriptor subtype - lower 4 bits of nvme_(keyed_)sgl_desc identifier
622 *
623 * @NVME_SGL_FMT_ADDRESS: absolute address of the data block
624 * @NVME_SGL_FMT_OFFSET: relative offset of the in-capsule data block
d85cf207 625 * @NVME_SGL_FMT_TRANSPORT_A: transport defined format, value 0xA
eb793e2c
CH		 626 * @NVME_SGL_FMT_INVALIDATE: RDMA transport specific remote invalidation
627 * request subtype
628 */
629enum {
630 NVME_SGL_FMT_ADDRESS = 0x00,
631 NVME_SGL_FMT_OFFSET = 0x01,
d85cf207 632 NVME_SGL_FMT_TRANSPORT_A = 0x0A,
eb793e2c
CH		 633 NVME_SGL_FMT_INVALIDATE = 0x0f,
634};
635
636/*
637 * Descriptor type - upper 4 bits of nvme_(keyed_)sgl_desc identifier
638 *
639 * For struct nvme_sgl_desc:
640 * @NVME_SGL_FMT_DATA_DESC: data block descriptor
641 * @NVME_SGL_FMT_SEG_DESC: sgl segment descriptor
642 * @NVME_SGL_FMT_LAST_SEG_DESC: last sgl segment descriptor
643 *
644 * For struct nvme_keyed_sgl_desc:
645 * @NVME_KEY_SGL_FMT_DATA_DESC: keyed data block descriptor
d85cf207
JS		 646 *
647 * Transport-specific SGL types:
648 * @NVME_TRANSPORT_SGL_DATA_DESC: Transport SGL data dlock descriptor
eb793e2c
CH		 649 */
650enum {
651 NVME_SGL_FMT_DATA_DESC = 0x00,
652 NVME_SGL_FMT_SEG_DESC = 0x02,
653 NVME_SGL_FMT_LAST_SEG_DESC = 0x03,
654 NVME_KEY_SGL_FMT_DATA_DESC = 0x04,
d85cf207 655 NVME_TRANSPORT_SGL_DATA_DESC = 0x05,
eb793e2c
CH		 656};
657
658struct nvme_sgl_desc {
659 __le64 addr;
660 __le32 length;
661 __u8 rsvd[3];
662 __u8 type;
663};
664
665struct nvme_keyed_sgl_desc {
666 __le64 addr;
667 __u8 length[3];
668 __u8 key[4];
669 __u8 type;
670};
671
672union nvme_data_ptr {
673 struct {
674 __le64 prp1;
675 __le64 prp2;
676 };
677 struct nvme_sgl_desc sgl;
678 struct nvme_keyed_sgl_desc ksgl;
679};
680
3972be23
JS		 681/*
682 * Lowest two bits of our flags field (FUSE field in the spec):
683 *
684 * @NVME_CMD_FUSE_FIRST: Fused Operation, first command
685 * @NVME_CMD_FUSE_SECOND: Fused Operation, second command
686 *
687 * Highest two bits in our flags field (PSDT field in the spec):
688 *
689 * @NVME_CMD_PSDT_SGL_METABUF: Use SGLS for this transfer,
690 * If used, MPTR contains addr of single physical buffer (byte aligned).
691 * @NVME_CMD_PSDT_SGL_METASEG: Use SGLS for this transfer,
692 * If used, MPTR contains an address of an SGL segment containing
693 * exactly 1 SGL descriptor (qword aligned).
694 */
695enum {
696 NVME_CMD_FUSE_FIRST = (1 << 0),
697 NVME_CMD_FUSE_SECOND = (1 << 1),
698
699 NVME_CMD_SGL_METABUF = (1 << 6),
700 NVME_CMD_SGL_METASEG = (1 << 7),
701 NVME_CMD_SGL_ALL = NVME_CMD_SGL_METABUF | NVME_CMD_SGL_METASEG,
702};
703
9d99a8dd
CH		 704struct nvme_common_command {
705 __u8 opcode;
706 __u8 flags;
707 __u16 command_id;
708 __le32 nsid;
709 __le32 cdw2[2];
710 __le64 metadata;
eb793e2c 711 union nvme_data_ptr dptr;
b7c8f366
CK		 712 __le32 cdw10;
713 __le32 cdw11;
714 __le32 cdw12;
715 __le32 cdw13;
716 __le32 cdw14;
717 __le32 cdw15;
9d99a8dd
CH		 718};
719
720struct nvme_rw_command {
721 __u8 opcode;
722 __u8 flags;
723 __u16 command_id;
724 __le32 nsid;
725 __u64 rsvd2;
726 __le64 metadata;
eb793e2c 727 union nvme_data_ptr dptr;
9d99a8dd
CH		 728 __le64 slba;
729 __le16 length;
730 __le16 control;
731 __le32 dsmgmt;
732 __le32 reftag;
733 __le16 apptag;
734 __le16 appmask;
735};
736
737enum {
738 NVME_RW_LR = 1 << 15,
739 NVME_RW_FUA = 1 << 14,
740 NVME_RW_DSM_FREQ_UNSPEC = 0,
741 NVME_RW_DSM_FREQ_TYPICAL = 1,
742 NVME_RW_DSM_FREQ_RARE = 2,
743 NVME_RW_DSM_FREQ_READS = 3,
744 NVME_RW_DSM_FREQ_WRITES = 4,
745 NVME_RW_DSM_FREQ_RW = 5,
746 NVME_RW_DSM_FREQ_ONCE = 6,
747 NVME_RW_DSM_FREQ_PREFETCH = 7,
748 NVME_RW_DSM_FREQ_TEMP = 8,
749 NVME_RW_DSM_LATENCY_NONE = 0 << 4,
750 NVME_RW_DSM_LATENCY_IDLE = 1 << 4,
751 NVME_RW_DSM_LATENCY_NORM = 2 << 4,
752 NVME_RW_DSM_LATENCY_LOW = 3 << 4,
753 NVME_RW_DSM_SEQ_REQ = 1 << 6,
754 NVME_RW_DSM_COMPRESSED = 1 << 7,
755 NVME_RW_PRINFO_PRCHK_REF = 1 << 10,
756 NVME_RW_PRINFO_PRCHK_APP = 1 << 11,
757 NVME_RW_PRINFO_PRCHK_GUARD = 1 << 12,
758 NVME_RW_PRINFO_PRACT = 1 << 13,
f5d11840 759 NVME_RW_DTYPE_STREAMS = 1 << 4,
9d99a8dd
CH		 760};
761
762struct nvme_dsm_cmd {
763 __u8 opcode;
764 __u8 flags;
765 __u16 command_id;
766 __le32 nsid;
767 __u64 rsvd2[2];
eb793e2c 768 union nvme_data_ptr dptr;
9d99a8dd
CH		 769 __le32 nr;
770 __le32 attributes;
771 __u32 rsvd12[4];
772};
773
774enum {
775 NVME_DSMGMT_IDR = 1 << 0,
776 NVME_DSMGMT_IDW = 1 << 1,
777 NVME_DSMGMT_AD = 1 << 2,
778};
779
b35ba01e
CH		 780#define NVME_DSM_MAX_RANGES 256
781
9d99a8dd
CH		 782struct nvme_dsm_range {
783 __le32 cattr;
784 __le32 nlb;
785 __le64 slba;
786};
787
3b7c33b2
CK		 788struct nvme_write_zeroes_cmd {
789 __u8 opcode;
790 __u8 flags;
791 __u16 command_id;
792 __le32 nsid;
793 __u64 rsvd2;
794 __le64 metadata;
795 union nvme_data_ptr dptr;
796 __le64 slba;
797 __le16 length;
798 __le16 control;
799 __le32 dsmgmt;
800 __le32 reftag;
801 __le16 apptag;
802 __le16 appmask;
803};
804
c5552fde
AL		 805/* Features */
806
52deba0f
AM		 807enum {
808 NVME_TEMP_THRESH_MASK = 0xffff,
809 NVME_TEMP_THRESH_SELECT_SHIFT = 16,
810 NVME_TEMP_THRESH_TYPE_UNDER = 0x100000,
811};
812
c5552fde
AL		 813struct nvme_feat_auto_pst {
814 __le64 entries[32];
815};
816
39673e19
CH		 817enum {
818 NVME_HOST_MEM_ENABLE = (1 << 0),
819 NVME_HOST_MEM_RETURN = (1 << 1),
820};
821
49cd84b6
KB		 822struct nvme_feat_host_behavior {
823 __u8 acre;
824 __u8 resv1[511];
825};
826
827enum {
828 NVME_ENABLE_ACRE = 1,
829};
830
9d99a8dd
CH		 831/* Admin commands */
832
833enum nvme_admin_opcode {
834 nvme_admin_delete_sq = 0x00,
835 nvme_admin_create_sq = 0x01,
836 nvme_admin_get_log_page = 0x02,
837 nvme_admin_delete_cq = 0x04,
838 nvme_admin_create_cq = 0x05,
839 nvme_admin_identify = 0x06,
840 nvme_admin_abort_cmd = 0x08,
841 nvme_admin_set_features = 0x09,
842 nvme_admin_get_features = 0x0a,
843 nvme_admin_async_event = 0x0c,
a446c084 844 nvme_admin_ns_mgmt = 0x0d,
9d99a8dd
CH		 845 nvme_admin_activate_fw = 0x10,
846 nvme_admin_download_fw = 0x11,
48c9e85b 847 nvme_admin_dev_self_test = 0x14,
a446c084 848 nvme_admin_ns_attach = 0x15,
7b89eae2 849 nvme_admin_keep_alive = 0x18,
f5d11840
JA		 850 nvme_admin_directive_send = 0x19,
851 nvme_admin_directive_recv = 0x1a,
48c9e85b
RR		 852 nvme_admin_virtual_mgmt = 0x1c,
853 nvme_admin_nvme_mi_send = 0x1d,
854 nvme_admin_nvme_mi_recv = 0x1e,
f9f38e33 855 nvme_admin_dbbuf = 0x7C,
9d99a8dd
CH		 856 nvme_admin_format_nvm = 0x80,
857 nvme_admin_security_send = 0x81,
858 nvme_admin_security_recv = 0x82,
84fef62d 859 nvme_admin_sanitize_nvm = 0x84,
c6389845 860 nvme_admin_get_lba_status = 0x86,
9d99a8dd
CH		 861};
862
26f2990d
MI		 863#define nvme_admin_opcode_name(opcode) { opcode, #opcode }
864#define show_admin_opcode_name(val) \
865 __print_symbolic(val, \
866 nvme_admin_opcode_name(nvme_admin_delete_sq), \
867 nvme_admin_opcode_name(nvme_admin_create_sq), \
868 nvme_admin_opcode_name(nvme_admin_get_log_page), \
869 nvme_admin_opcode_name(nvme_admin_delete_cq), \
870 nvme_admin_opcode_name(nvme_admin_create_cq), \
871 nvme_admin_opcode_name(nvme_admin_identify), \
872 nvme_admin_opcode_name(nvme_admin_abort_cmd), \
873 nvme_admin_opcode_name(nvme_admin_set_features), \
874 nvme_admin_opcode_name(nvme_admin_get_features), \
875 nvme_admin_opcode_name(nvme_admin_async_event), \
876 nvme_admin_opcode_name(nvme_admin_ns_mgmt), \
877 nvme_admin_opcode_name(nvme_admin_activate_fw), \
878 nvme_admin_opcode_name(nvme_admin_download_fw), \
879 nvme_admin_opcode_name(nvme_admin_ns_attach), \
880 nvme_admin_opcode_name(nvme_admin_keep_alive), \
881 nvme_admin_opcode_name(nvme_admin_directive_send), \
882 nvme_admin_opcode_name(nvme_admin_directive_recv), \
883 nvme_admin_opcode_name(nvme_admin_dbbuf), \
884 nvme_admin_opcode_name(nvme_admin_format_nvm), \
885 nvme_admin_opcode_name(nvme_admin_security_send), \
886 nvme_admin_opcode_name(nvme_admin_security_recv), \
a5ef7572
MI		 887 nvme_admin_opcode_name(nvme_admin_sanitize_nvm), \
888 nvme_admin_opcode_name(nvme_admin_get_lba_status))
26f2990d 889
9d99a8dd
CH		 890enum {
891 NVME_QUEUE_PHYS_CONTIG = (1 << 0),
892 NVME_CQ_IRQ_ENABLED = (1 << 1),
893 NVME_SQ_PRIO_URGENT = (0 << 1),
894 NVME_SQ_PRIO_HIGH = (1 << 1),
895 NVME_SQ_PRIO_MEDIUM = (2 << 1),
896 NVME_SQ_PRIO_LOW = (3 << 1),
897 NVME_FEAT_ARBITRATION = 0x01,
898 NVME_FEAT_POWER_MGMT = 0x02,
899 NVME_FEAT_LBA_RANGE = 0x03,
900 NVME_FEAT_TEMP_THRESH = 0x04,
901 NVME_FEAT_ERR_RECOVERY = 0x05,
902 NVME_FEAT_VOLATILE_WC = 0x06,
903 NVME_FEAT_NUM_QUEUES = 0x07,
904 NVME_FEAT_IRQ_COALESCE = 0x08,
905 NVME_FEAT_IRQ_CONFIG = 0x09,
906 NVME_FEAT_WRITE_ATOMIC = 0x0a,
907 NVME_FEAT_ASYNC_EVENT = 0x0b,
908 NVME_FEAT_AUTO_PST = 0x0c,
a446c084 909 NVME_FEAT_HOST_MEM_BUF = 0x0d,
dbf86b39 910 NVME_FEAT_TIMESTAMP = 0x0e,
7b89eae2 911 NVME_FEAT_KATO = 0x0f,
40c6f9c2
RR		 912 NVME_FEAT_HCTM = 0x10,
913 NVME_FEAT_NOPSC = 0x11,
914 NVME_FEAT_RRL = 0x12,
915 NVME_FEAT_PLM_CONFIG = 0x13,
916 NVME_FEAT_PLM_WINDOW = 0x14,
49cd84b6 917 NVME_FEAT_HOST_BEHAVIOR = 0x16,
48c9e85b 918 NVME_FEAT_SANITIZE = 0x17,
9d99a8dd
CH		 919 NVME_FEAT_SW_PROGRESS = 0x80,
920 NVME_FEAT_HOST_ID = 0x81,
921 NVME_FEAT_RESV_MASK = 0x82,
922 NVME_FEAT_RESV_PERSIST = 0x83,
93045d59 923 NVME_FEAT_WRITE_PROTECT = 0x84,
9d99a8dd
CH		 924 NVME_LOG_ERROR = 0x01,
925 NVME_LOG_SMART = 0x02,
926 NVME_LOG_FW_SLOT = 0x03,
b3984e06 927 NVME_LOG_CHANGED_NS = 0x04,
84fef62d 928 NVME_LOG_CMD_EFFECTS = 0x05,
48c9e85b
RR		 929 NVME_LOG_DEVICE_SELF_TEST = 0x06,
930 NVME_LOG_TELEMETRY_HOST = 0x07,
931 NVME_LOG_TELEMETRY_CTRL = 0x08,
932 NVME_LOG_ENDURANCE_GROUP = 0x09,
1a376216 933 NVME_LOG_ANA = 0x0c,
eb793e2c 934 NVME_LOG_DISC = 0x70,
9d99a8dd
CH		 935 NVME_LOG_RESERVATION = 0x80,
936 NVME_FWACT_REPL = (0 << 3),
937 NVME_FWACT_REPL_ACTV = (1 << 3),
938 NVME_FWACT_ACTV = (2 << 3),
939};
940
93045d59
CK		 941/* NVMe Namespace Write Protect State */
942enum {
943 NVME_NS_NO_WRITE_PROTECT = 0,
944 NVME_NS_WRITE_PROTECT,
945 NVME_NS_WRITE_PROTECT_POWER_CYCLE,
946 NVME_NS_WRITE_PROTECT_PERMANENT,
947};
948
b3984e06
CH		 949#define NVME_MAX_CHANGED_NAMESPACES 1024
950
9d99a8dd
CH		 951struct nvme_identify {
952 __u8 opcode;
953 __u8 flags;
954 __u16 command_id;
955 __le32 nsid;
956 __u64 rsvd2[2];
eb793e2c 957 union nvme_data_ptr dptr;
986994a2
PP		 958 __u8 cns;
959 __u8 rsvd3;
960 __le16 ctrlid;
9d99a8dd
CH		 961 __u32 rsvd11[5];
962};
963
0add5e8e
JT		 964#define NVME_IDENTIFY_DATA_SIZE 4096
965
9d99a8dd
CH		 966struct nvme_features {
967 __u8 opcode;
968 __u8 flags;
969 __u16 command_id;
970 __le32 nsid;
971 __u64 rsvd2[2];
eb793e2c 972 union nvme_data_ptr dptr;
9d99a8dd
CH		 973 __le32 fid;
974 __le32 dword11;
b85cf734
AD		 975 __le32 dword12;
976 __le32 dword13;
977 __le32 dword14;
978 __le32 dword15;
9d99a8dd
CH		 979};
980
39673e19
CH		 981struct nvme_host_mem_buf_desc {
982 __le64 addr;
983 __le32 size;
984 __u32 rsvd;
985};
986
9d99a8dd
CH		 987struct nvme_create_cq {
988 __u8 opcode;
989 __u8 flags;
990 __u16 command_id;
991 __u32 rsvd1[5];
992 __le64 prp1;
993 __u64 rsvd8;
994 __le16 cqid;
995 __le16 qsize;
996 __le16 cq_flags;
997 __le16 irq_vector;
998 __u32 rsvd12[4];
999};
1000
1001struct nvme_create_sq {
1002 __u8 opcode;
1003 __u8 flags;
1004 __u16 command_id;
1005 __u32 rsvd1[5];
1006 __le64 prp1;
1007 __u64 rsvd8;
1008 __le16 sqid;
1009 __le16 qsize;
1010 __le16 sq_flags;
1011 __le16 cqid;
1012 __u32 rsvd12[4];
1013};
1014
1015struct nvme_delete_queue {
1016 __u8 opcode;
1017 __u8 flags;
1018 __u16 command_id;
1019 __u32 rsvd1[9];
1020 __le16 qid;
1021 __u16 rsvd10;
1022 __u32 rsvd11[5];
1023};
1024
1025struct nvme_abort_cmd {
1026 __u8 opcode;
1027 __u8 flags;
1028 __u16 command_id;
1029 __u32 rsvd1[9];
1030 __le16 sqid;
1031 __u16 cid;
1032 __u32 rsvd11[5];
1033};
1034
1035struct nvme_download_firmware {
1036 __u8 opcode;
1037 __u8 flags;
1038 __u16 command_id;
1039 __u32 rsvd1[5];
eb793e2c 1040 union nvme_data_ptr dptr;
9d99a8dd
CH		 1041 __le32 numd;
1042 __le32 offset;
1043 __u32 rsvd12[4];
1044};
1045
1046struct nvme_format_cmd {
1047 __u8 opcode;
1048 __u8 flags;
1049 __u16 command_id;
1050 __le32 nsid;
1051 __u64 rsvd2[4];
1052 __le32 cdw10;
1053 __u32 rsvd11[5];
1054};
1055
725b3588
AB		 1056struct nvme_get_log_page_command {
1057 __u8 opcode;
1058 __u8 flags;
1059 __u16 command_id;
1060 __le32 nsid;
1061 __u64 rsvd2[2];
eb793e2c 1062 union nvme_data_ptr dptr;
725b3588 1063 __u8 lid;
9b89bc38 1064 __u8 lsp; /* upper 4 bits reserved */
725b3588
AB		 1065 __le16 numdl;
1066 __le16 numdu;
1067 __u16 rsvd11;
d808b7f7
KB		 1068 union {
1069 struct {
1070 __le32 lpol;
1071 __le32 lpou;
1072 };
1073 __le64 lpo;
1074 };
725b3588
AB		 1075 __u32 rsvd14[2];
1076};
1077
f5d11840
JA		 1078struct nvme_directive_cmd {
1079 __u8 opcode;
1080 __u8 flags;
1081 __u16 command_id;
1082 __le32 nsid;
1083 __u64 rsvd2[2];
1084 union nvme_data_ptr dptr;
1085 __le32 numd;
1086 __u8 doper;
1087 __u8 dtype;
1088 __le16 dspec;
1089 __u8 endir;
1090 __u8 tdtype;
1091 __u16 rsvd15;
1092
1093 __u32 rsvd16[3];
1094};
1095
eb793e2c
CH		 1096/*
1097 * Fabrics subcommands.
1098 */
1099enum nvmf_fabrics_opcode {
1100 nvme_fabrics_command = 0x7f,
1101};
1102
1103enum nvmf_capsule_command {
1104 nvme_fabrics_type_property_set = 0x00,
1105 nvme_fabrics_type_connect = 0x01,
1106 nvme_fabrics_type_property_get = 0x04,
1107};
1108
ad795e47
MI		 1109#define nvme_fabrics_type_name(type) { type, #type }
1110#define show_fabrics_type_name(type) \
1111 __print_symbolic(type, \
1112 nvme_fabrics_type_name(nvme_fabrics_type_property_set), \
1113 nvme_fabrics_type_name(nvme_fabrics_type_connect), \
1114 nvme_fabrics_type_name(nvme_fabrics_type_property_get))
1115
1116/*
1117 * If not fabrics command, fctype will be ignored.
1118 */
1119#define show_opcode_name(qid, opcode, fctype) \
1120 ((opcode) == nvme_fabrics_command ? \
1121 show_fabrics_type_name(fctype) : \
1122 ((qid) ? \
1123 show_nvm_opcode_name(opcode) : \
1124 show_admin_opcode_name(opcode)))
1125
eb793e2c
CH		 1126struct nvmf_common_command {
1127 __u8 opcode;
1128 __u8 resv1;
1129 __u16 command_id;
1130 __u8 fctype;
1131 __u8 resv2[35];
1132 __u8 ts[24];
1133};
1134
1135/*
1136 * The legal cntlid range a NVMe Target will provide.
1137 * Note that cntlid of value 0 is considered illegal in the fabrics world.
1138 * Devices based on earlier specs did not have the subsystem concept;
1139 * therefore, those devices had their cntlid value set to 0 as a result.
1140 */
1141#define NVME_CNTLID_MIN 1
1142#define NVME_CNTLID_MAX 0xffef
1143#define NVME_CNTLID_DYNAMIC 0xffff
1144
1145#define MAX_DISC_LOGS 255
1146
1147/* Discovery log page entry */
1148struct nvmf_disc_rsp_page_entry {
1149 __u8 trtype;
1150 __u8 adrfam;
a446c084 1151 __u8 subtype;
eb793e2c
CH		 1152 __u8 treq;
1153 __le16 portid;
1154 __le16 cntlid;
1155 __le16 asqsz;
1156 __u8 resv8[22];
1157 char trsvcid[NVMF_TRSVCID_SIZE];
1158 __u8 resv64[192];
1159 char subnqn[NVMF_NQN_FIELD_LEN];
1160 char traddr[NVMF_TRADDR_SIZE];
1161 union tsas {
1162 char common[NVMF_TSAS_SIZE];
1163 struct rdma {
1164 __u8 qptype;
1165 __u8 prtype;
1166 __u8 cms;
1167 __u8 resv3[5];
1168 __u16 pkey;
1169 __u8 resv10[246];
1170 } rdma;
1171 } tsas;
1172};
1173
1174/* Discovery log page header */
1175struct nvmf_disc_rsp_page_hdr {
1176 __le64 genctr;
1177 __le64 numrec;
1178 __le16 recfmt;
1179 __u8 resv14[1006];
1180 struct nvmf_disc_rsp_page_entry entries[0];
1181};
1182
e6a622fd
SG		 1183enum {
1184 NVME_CONNECT_DISABLE_SQFLOW = (1 << 2),
1185};
1186
eb793e2c
CH		 1187struct nvmf_connect_command {
1188 __u8 opcode;
1189 __u8 resv1;
1190 __u16 command_id;
1191 __u8 fctype;
1192 __u8 resv2[19];
1193 union nvme_data_ptr dptr;
1194 __le16 recfmt;
1195 __le16 qid;
1196 __le16 sqsize;
1197 __u8 cattr;
1198 __u8 resv3;
1199 __le32 kato;
1200 __u8 resv4[12];
1201};
1202
1203struct nvmf_connect_data {
8e412263 1204 uuid_t hostid;
eb793e2c
CH		 1205 __le16 cntlid;
1206 char resv4[238];
1207 char subsysnqn[NVMF_NQN_FIELD_LEN];
1208 char hostnqn[NVMF_NQN_FIELD_LEN];
1209 char resv5[256];
1210};
1211
1212struct nvmf_property_set_command {
1213 __u8 opcode;
1214 __u8 resv1;
1215 __u16 command_id;
1216 __u8 fctype;
1217 __u8 resv2[35];
1218 __u8 attrib;
1219 __u8 resv3[3];
1220 __le32 offset;
1221 __le64 value;
1222 __u8 resv4[8];
1223};
1224
1225struct nvmf_property_get_command {
1226 __u8 opcode;
1227 __u8 resv1;
1228 __u16 command_id;
1229 __u8 fctype;
1230 __u8 resv2[35];
1231 __u8 attrib;
1232 __u8 resv3[3];
1233 __le32 offset;
1234 __u8 resv4[16];
1235};
1236
f9f38e33
HK		 1237struct nvme_dbbuf {
1238 __u8 opcode;
1239 __u8 flags;
1240 __u16 command_id;
1241 __u32 rsvd1[5];
1242 __le64 prp1;
1243 __le64 prp2;
1244 __u32 rsvd12[6];
1245};
1246
f5d11840 1247struct streams_directive_params {
dc1a0afb
CH		 1248 __le16 msl;
1249 __le16 nssa;
1250 __le16 nsso;
f5d11840 1251 __u8 rsvd[10];
dc1a0afb
CH		 1252 __le32 sws;
1253 __le16 sgs;
1254 __le16 nsa;
1255 __le16 nso;
f5d11840
JA		 1256 __u8 rsvd2[6];
1257};
1258
9d99a8dd
CH		 1259struct nvme_command {
1260 union {
1261 struct nvme_common_command common;
1262 struct nvme_rw_command rw;
1263 struct nvme_identify identify;
1264 struct nvme_features features;
1265 struct nvme_create_cq create_cq;
1266 struct nvme_create_sq create_sq;
1267 struct nvme_delete_queue delete_queue;
1268 struct nvme_download_firmware dlfw;
1269 struct nvme_format_cmd format;
1270 struct nvme_dsm_cmd dsm;
3b7c33b2 1271 struct nvme_write_zeroes_cmd write_zeroes;
9d99a8dd 1272 struct nvme_abort_cmd abort;
725b3588 1273 struct nvme_get_log_page_command get_log_page;
eb793e2c
CH		 1274 struct nvmf_common_command fabrics;
1275 struct nvmf_connect_command connect;
1276 struct nvmf_property_set_command prop_set;
1277 struct nvmf_property_get_command prop_get;
f9f38e33 1278 struct nvme_dbbuf dbbuf;
f5d11840 1279 struct nvme_directive_cmd directive;
9d99a8dd
CH		 1280 };
1281};
1282
7a1f46e3
MI		 1283static inline bool nvme_is_fabrics(struct nvme_command *cmd)
1284{
1285 return cmd->common.opcode == nvme_fabrics_command;
1286}
1287
b34de7ce
CK		 1288struct nvme_error_slot {
1289 __le64 error_count;
1290 __le16 sqid;
1291 __le16 cmdid;
1292 __le16 status_field;
1293 __le16 param_error_location;
1294 __le64 lba;
1295 __le32 nsid;
1296 __u8 vs;
1297 __u8 resv[3];
1298 __le64 cs;
1299 __u8 resv2[24];
1300};
1301
7a5abb4b
CH		 1302static inline bool nvme_is_write(struct nvme_command *cmd)
1303{
eb793e2c
CH		 1304 /*
1305 * What a mess...
1306 *
1307 * Why can't we simply have a Fabrics In and Fabrics out command?
1308 */
7a1f46e3 1309 if (unlikely(nvme_is_fabrics(cmd)))
2fd4167f 1310 return cmd->fabrics.fctype & 1;
7a5abb4b
CH		 1311 return cmd->common.opcode & 1;
1312}
1313
9d99a8dd 1314enum {
eb793e2c
CH		 1315 /*
1316 * Generic Command Status:
1317 */
9d99a8dd
CH		 1318 NVME_SC_SUCCESS = 0x0,
1319 NVME_SC_INVALID_OPCODE = 0x1,
1320 NVME_SC_INVALID_FIELD = 0x2,
1321 NVME_SC_CMDID_CONFLICT = 0x3,
1322 NVME_SC_DATA_XFER_ERROR = 0x4,
1323 NVME_SC_POWER_LOSS = 0x5,
1324 NVME_SC_INTERNAL = 0x6,
1325 NVME_SC_ABORT_REQ = 0x7,
1326 NVME_SC_ABORT_QUEUE = 0x8,
1327 NVME_SC_FUSED_FAIL = 0x9,
1328 NVME_SC_FUSED_MISSING = 0xa,
1329 NVME_SC_INVALID_NS = 0xb,
1330 NVME_SC_CMD_SEQ_ERROR = 0xc,
1331 NVME_SC_SGL_INVALID_LAST = 0xd,
1332 NVME_SC_SGL_INVALID_COUNT = 0xe,
1333 NVME_SC_SGL_INVALID_DATA = 0xf,
1334 NVME_SC_SGL_INVALID_METADATA = 0x10,
1335 NVME_SC_SGL_INVALID_TYPE = 0x11,
eb793e2c
CH		 1336
1337 NVME_SC_SGL_INVALID_OFFSET = 0x16,
1338 NVME_SC_SGL_INVALID_SUBTYPE = 0x17,
1339
48c9e85b
RR		 1340 NVME_SC_SANITIZE_FAILED = 0x1C,
1341 NVME_SC_SANITIZE_IN_PROGRESS = 0x1D,
1342
93045d59 1343 NVME_SC_NS_WRITE_PROTECTED = 0x20,
48c9e85b 1344 NVME_SC_CMD_INTERRUPTED = 0x21,
93045d59 1345
9d99a8dd
CH		 1346 NVME_SC_LBA_RANGE = 0x80,
1347 NVME_SC_CAP_EXCEEDED = 0x81,
1348 NVME_SC_NS_NOT_READY = 0x82,
1349 NVME_SC_RESERVATION_CONFLICT = 0x83,
eb793e2c
CH		 1350
1351 /*
1352 * Command Specific Status:
1353 */
9d99a8dd
CH		 1354 NVME_SC_CQ_INVALID = 0x100,
1355 NVME_SC_QID_INVALID = 0x101,
1356 NVME_SC_QUEUE_SIZE = 0x102,
1357 NVME_SC_ABORT_LIMIT = 0x103,
1358 NVME_SC_ABORT_MISSING = 0x104,
1359 NVME_SC_ASYNC_LIMIT = 0x105,
1360 NVME_SC_FIRMWARE_SLOT = 0x106,
1361 NVME_SC_FIRMWARE_IMAGE = 0x107,
1362 NVME_SC_INVALID_VECTOR = 0x108,
1363 NVME_SC_INVALID_LOG_PAGE = 0x109,
1364 NVME_SC_INVALID_FORMAT = 0x10a,
a446c084 1365 NVME_SC_FW_NEEDS_CONV_RESET = 0x10b,
9d99a8dd
CH		 1366 NVME_SC_INVALID_QUEUE = 0x10c,
1367 NVME_SC_FEATURE_NOT_SAVEABLE = 0x10d,
1368 NVME_SC_FEATURE_NOT_CHANGEABLE = 0x10e,
1369 NVME_SC_FEATURE_NOT_PER_NS = 0x10f,
a446c084
CH		 1370 NVME_SC_FW_NEEDS_SUBSYS_RESET = 0x110,
1371 NVME_SC_FW_NEEDS_RESET = 0x111,
1372 NVME_SC_FW_NEEDS_MAX_TIME = 0x112,
9581ae4f 1373 NVME_SC_FW_ACTIVATE_PROHIBITED = 0x113,
a446c084 1374 NVME_SC_OVERLAPPING_RANGE = 0x114,
9581ae4f 1375 NVME_SC_NS_INSUFFICIENT_CAP = 0x115,
a446c084
CH		 1376 NVME_SC_NS_ID_UNAVAILABLE = 0x116,
1377 NVME_SC_NS_ALREADY_ATTACHED = 0x118,
1378 NVME_SC_NS_IS_PRIVATE = 0x119,
1379 NVME_SC_NS_NOT_ATTACHED = 0x11a,
1380 NVME_SC_THIN_PROV_NOT_SUPP = 0x11b,
1381 NVME_SC_CTRL_LIST_INVALID = 0x11c,
48c9e85b
RR		 1382 NVME_SC_BP_WRITE_PROHIBITED = 0x11e,
1383 NVME_SC_PMR_SAN_PROHIBITED = 0x123,
eb793e2c
CH		 1384
1385 /*
1386 * I/O Command Set Specific - NVM commands:
1387 */
9d99a8dd
CH		 1388 NVME_SC_BAD_ATTRIBUTES = 0x180,
1389 NVME_SC_INVALID_PI = 0x181,
1390 NVME_SC_READ_ONLY = 0x182,
3b7c33b2 1391 NVME_SC_ONCS_NOT_SUPPORTED = 0x183,
eb793e2c
CH		 1392
1393 /*
1394 * I/O Command Set Specific - Fabrics commands:
1395 */
1396 NVME_SC_CONNECT_FORMAT = 0x180,
1397 NVME_SC_CONNECT_CTRL_BUSY = 0x181,
1398 NVME_SC_CONNECT_INVALID_PARAM = 0x182,
1399 NVME_SC_CONNECT_RESTART_DISC = 0x183,
1400 NVME_SC_CONNECT_INVALID_HOST = 0x184,
1401
1402 NVME_SC_DISCOVERY_RESTART = 0x190,
1403 NVME_SC_AUTH_REQUIRED = 0x191,
1404
1405 /*
1406 * Media and Data Integrity Errors:
1407 */
9d99a8dd
CH		 1408 NVME_SC_WRITE_FAULT = 0x280,
1409 NVME_SC_READ_ERROR = 0x281,
1410 NVME_SC_GUARD_CHECK = 0x282,
1411 NVME_SC_APPTAG_CHECK = 0x283,
1412 NVME_SC_REFTAG_CHECK = 0x284,
1413 NVME_SC_COMPARE_FAILED = 0x285,
1414 NVME_SC_ACCESS_DENIED = 0x286,
a446c084 1415 NVME_SC_UNWRITTEN_BLOCK = 0x287,
eb793e2c 1416
1a376216
CH		 1417 /*
1418 * Path-related Errors:
1419 */
1420 NVME_SC_ANA_PERSISTENT_LOSS = 0x301,
1421 NVME_SC_ANA_INACCESSIBLE = 0x302,
1422 NVME_SC_ANA_TRANSITION = 0x303,
783f4a44 1423 NVME_SC_HOST_PATH_ERROR = 0x370,
2dc3947b 1424 NVME_SC_HOST_ABORTED_CMD = 0x371,
1a376216 1425
49cd84b6 1426 NVME_SC_CRD = 0x1800,
9d99a8dd
CH		 1427 NVME_SC_DNR = 0x4000,
1428};
1429
1430struct nvme_completion {
eb793e2c
CH		 1431 /*
1432 * Used by Admin and Fabrics commands to return data:
1433 */
d49187e9
CH		 1434 union nvme_result {
1435 __le16 u16;
1436 __le32 u32;
1437 __le64 u64;
1438 } result;
9d99a8dd
CH		 1439 __le16 sq_head; /* how much of this queue may be reclaimed */
1440 __le16 sq_id; /* submission queue that generated this entry */
1441 __u16 command_id; /* of the command which completed */
1442 __le16 status; /* did the command fail, and if so, why? */
1443};
1444
8ef2074d
GKB		 1445#define NVME_VS(major, minor, tertiary) \
1446 (((major) << 16) | ((minor) << 8) | (tertiary))
9d99a8dd 1447
c61d788b
JT		 1448#define NVME_MAJOR(ver) ((ver) >> 16)
1449#define NVME_MINOR(ver) (((ver) >> 8) & 0xff)
1450#define NVME_TERTIARY(ver) ((ver) & 0xff)
1451
b60503ba 1452#endif /* _LINUX_NVME_H */
Ubuntu Jammy Linux kernel mirror