[linux-2.6-block.git] / include / linux / nvme.h

/*
 * Definitions for the NVM Express interface
 * Copyright (c) 2011, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 
 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LINUX_NVME_H
#define _LINUX_NVME_H

#include <linux/types.h>

struct nvme_bar {
	__u64			cap;	/* Controller Capabilities */
	__u32			vs;	/* Version */
	__u32			intms;	/* Interrupt Mask Set */
	__u32			intmc;	/* Interrupt Mask Clear */
	__u32			cc;	/* Controller Configuration */
	__u32			rsvd1;	/* Reserved */
	__u32			csts;	/* Controller Status */
	__u32			rsvd2;	/* Reserved */
	__u32			aqa;	/* Admin Queue Attributes */
	__u64			asq;	/* Admin SQ Base Address */
	__u64			acq;	/* Admin CQ Base Address */
};

#define NVME_CAP_TIMEOUT(cap)	(((cap) >> 24) & 0xff)
#define NVME_CAP_STRIDE(cap)	(((cap) >> 32) & 0xf)

enum {
	NVME_CC_ENABLE		= 1 << 0,
	NVME_CC_CSS_NVM		= 0 << 4,
	NVME_CC_MPS_SHIFT	= 7,
	NVME_CC_ARB_RR		= 0 << 11,
	NVME_CC_ARB_WRRU	= 1 << 11,
	NVME_CC_ARB_VS		= 7 << 11,
	NVME_CC_SHN_NONE	= 0 << 14,
	NVME_CC_SHN_NORMAL	= 1 << 14,
	NVME_CC_SHN_ABRUPT	= 2 << 14,
	NVME_CC_IOSQES		= 6 << 16,
	NVME_CC_IOCQES		= 4 << 20,
	NVME_CSTS_RDY		= 1 << 0,
	NVME_CSTS_CFS		= 1 << 1,
	NVME_CSTS_SHST_NORMAL	= 0 << 2,
	NVME_CSTS_SHST_OCCUR	= 1 << 2,
	NVME_CSTS_SHST_CMPLT	= 2 << 2,
};

struct nvme_id_power_state {
	__le16			max_power;	/* centiwatts */
	__u16			rsvd2;
	__le32			entry_lat;	/* microseconds */
	__le32			exit_lat;	/* microseconds */
	__u8			read_tput;
	__u8			read_lat;
	__u8			write_tput;
	__u8			write_lat;
	__u8			rsvd16[16];
};

#define NVME_VS(major, minor)	(major << 16 | minor)

struct nvme_id_ctrl {
	__le16			vid;
	__le16			ssvid;
	char			sn[20];
	char			mn[40];
	char			fr[8];
	__u8			rab;
	__u8			ieee[3];
	__u8			mic;
	__u8			mdts;
	__u8			rsvd78[178];
	__le16			oacs;
	__u8			acl;
	__u8			aerl;
	__u8			frmw;
	__u8			lpa;
	__u8			elpe;
	__u8			npss;
	__u8			rsvd264[248];
	__u8			sqes;
	__u8			cqes;
	__u8			rsvd514[2];
	__le32			nn;
	__le16			oncs;
	__le16			fuses;
	__u8			fna;
	__u8			vwc;
	__le16			awun;
	__le16			awupf;
	__u8			rsvd530[1518];
	struct nvme_id_power_state	psd[32];
	__u8			vs[1024];
};

struct nvme_lbaf {
	__le16			ms;
	__u8			ds;
	__u8			rp;
};

struct nvme_id_ns {
	__le64			nsze;
	__le64			ncap;
	__le64			nuse;
	__u8			nsfeat;
	__u8			nlbaf;
	__u8			flbas;
	__u8			mc;
	__u8			dpc;
	__u8			dps;
	__u8			rsvd30[98];
	struct nvme_lbaf	lbaf[16];
	__u8			rsvd192[192];
	__u8			vs[3712];
};

enum {
	NVME_NS_FEAT_THIN	= 1 << 0,
	NVME_LBAF_RP_BEST	= 0,
	NVME_LBAF_RP_BETTER	= 1,
	NVME_LBAF_RP_GOOD	= 2,
	NVME_LBAF_RP_DEGRADED	= 3,
};

struct nvme_lba_range_type {
	__u8			type;
	__u8			attributes;
	__u8			rsvd2[14];
	__u64			slba;
	__u64			nlb;
	__u8			guid[16];
	__u8			rsvd48[16];
};

enum {
	NVME_LBART_TYPE_FS	= 0x01,
	NVME_LBART_TYPE_RAID	= 0x02,
	NVME_LBART_TYPE_CACHE	= 0x03,
	NVME_LBART_TYPE_SWAP	= 0x04,

	NVME_LBART_ATTRIB_TEMP	= 1 << 0,
	NVME_LBART_ATTRIB_HIDE	= 1 << 1,
};

/* I/O commands */

enum nvme_opcode {
	nvme_cmd_flush		= 0x00,
	nvme_cmd_write		= 0x01,
	nvme_cmd_read		= 0x02,
	nvme_cmd_write_uncor	= 0x04,
	nvme_cmd_compare	= 0x05,
	nvme_cmd_dsm		= 0x09,
};

struct nvme_common_command {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u32			cdw2[2];
	__le64			metadata;
	__le64			prp1;
	__le64			prp2;
	__u32			cdw10[6];
};

struct nvme_rw_command {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd2;
	__le64			metadata;
	__le64			prp1;
	__le64			prp2;
	__le64			slba;
	__le16			length;
	__le16			control;
	__le32			dsmgmt;
	__le32			reftag;
	__le16			apptag;
	__le16			appmask;
};

enum {
	NVME_RW_LR			= 1 << 15,
	NVME_RW_FUA			= 1 << 14,
	NVME_RW_DSM_FREQ_UNSPEC		= 0,
	NVME_RW_DSM_FREQ_TYPICAL	= 1,
	NVME_RW_DSM_FREQ_RARE		= 2,
	NVME_RW_DSM_FREQ_READS		= 3,
	NVME_RW_DSM_FREQ_WRITES		= 4,
	NVME_RW_DSM_FREQ_RW		= 5,
	NVME_RW_DSM_FREQ_ONCE		= 6,
	NVME_RW_DSM_FREQ_PREFETCH	= 7,
	NVME_RW_DSM_FREQ_TEMP		= 8,
	NVME_RW_DSM_LATENCY_NONE	= 0 << 4,
	NVME_RW_DSM_LATENCY_IDLE	= 1 << 4,
	NVME_RW_DSM_LATENCY_NORM	= 2 << 4,
	NVME_RW_DSM_LATENCY_LOW		= 3 << 4,
	NVME_RW_DSM_SEQ_REQ		= 1 << 6,
	NVME_RW_DSM_COMPRESSED		= 1 << 7,
};

/* Admin commands */

enum nvme_admin_opcode {
	nvme_admin_delete_sq		= 0x00,
	nvme_admin_create_sq		= 0x01,
	nvme_admin_get_log_page		= 0x02,
	nvme_admin_delete_cq		= 0x04,
	nvme_admin_create_cq		= 0x05,
	nvme_admin_identify		= 0x06,
	nvme_admin_abort_cmd		= 0x08,
	nvme_admin_set_features		= 0x09,
	nvme_admin_get_features		= 0x0a,
	nvme_admin_async_event		= 0x0c,
	nvme_admin_activate_fw		= 0x10,
	nvme_admin_download_fw		= 0x11,
	nvme_admin_format_nvm		= 0x80,
	nvme_admin_security_send	= 0x81,
	nvme_admin_security_recv	= 0x82,
};

enum {
	NVME_QUEUE_PHYS_CONTIG	= (1 << 0),
	NVME_CQ_IRQ_ENABLED	= (1 << 1),
	NVME_SQ_PRIO_URGENT	= (0 << 1),
	NVME_SQ_PRIO_HIGH	= (1 << 1),
	NVME_SQ_PRIO_MEDIUM	= (2 << 1),
	NVME_SQ_PRIO_LOW	= (3 << 1),
	NVME_FEAT_ARBITRATION	= 0x01,
	NVME_FEAT_POWER_MGMT	= 0x02,
	NVME_FEAT_LBA_RANGE	= 0x03,
	NVME_FEAT_TEMP_THRESH	= 0x04,
	NVME_FEAT_ERR_RECOVERY	= 0x05,
	NVME_FEAT_VOLATILE_WC	= 0x06,
	NVME_FEAT_NUM_QUEUES	= 0x07,
	NVME_FEAT_IRQ_COALESCE	= 0x08,
	NVME_FEAT_IRQ_CONFIG	= 0x09,
	NVME_FEAT_WRITE_ATOMIC	= 0x0a,
	NVME_FEAT_ASYNC_EVENT	= 0x0b,
	NVME_FEAT_SW_PROGRESS	= 0x0c,
};

struct nvme_identify {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd2[2];
	__le64			prp1;
	__le64			prp2;
	__le32			cns;
	__u32			rsvd11[5];
};

struct nvme_features {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__le32			nsid;
	__u64			rsvd2[2];
	__le64			prp1;
	__le64			prp2;
	__le32			fid;
	__le32			dword11;
	__u32			rsvd12[4];
};

struct nvme_create_cq {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__u32			rsvd1[5];
	__le64			prp1;
	__u64			rsvd8;
	__le16			cqid;
	__le16			qsize;
	__le16			cq_flags;
	__le16			irq_vector;
	__u32			rsvd12[4];
};

struct nvme_create_sq {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__u32			rsvd1[5];
	__le64			prp1;
	__u64			rsvd8;
	__le16			sqid;
	__le16			qsize;
	__le16			sq_flags;
	__le16			cqid;
	__u32			rsvd12[4];
};

struct nvme_delete_queue {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__u32			rsvd1[9];
	__le16			qid;
	__u16			rsvd10;
	__u32			rsvd11[5];
};

struct nvme_download_firmware {
	__u8			opcode;
	__u8			flags;
	__u16			command_id;
	__u32			rsvd1[5];
	__le64			prp1;
	__le64			prp2;
	__le32			numd;
	__le32			offset;
	__u32			rsvd12[4];
};

struct nvme_command {
	union {
		struct nvme_common_command common;
		struct nvme_rw_command rw;
		struct nvme_identify identify;
		struct nvme_features features;
		struct nvme_create_cq create_cq;
		struct nvme_create_sq create_sq;
		struct nvme_delete_queue delete_queue;
		struct nvme_download_firmware dlfw;
	};
};

enum {
	NVME_SC_SUCCESS			= 0x0,
	NVME_SC_INVALID_OPCODE		= 0x1,
	NVME_SC_INVALID_FIELD		= 0x2,
	NVME_SC_CMDID_CONFLICT		= 0x3,
	NVME_SC_DATA_XFER_ERROR		= 0x4,
	NVME_SC_POWER_LOSS		= 0x5,
	NVME_SC_INTERNAL		= 0x6,
	NVME_SC_ABORT_REQ		= 0x7,
	NVME_SC_ABORT_QUEUE		= 0x8,
	NVME_SC_FUSED_FAIL		= 0x9,
	NVME_SC_FUSED_MISSING		= 0xa,
	NVME_SC_INVALID_NS		= 0xb,
	NVME_SC_LBA_RANGE		= 0x80,
	NVME_SC_CAP_EXCEEDED		= 0x81,
	NVME_SC_NS_NOT_READY		= 0x82,
	NVME_SC_CQ_INVALID		= 0x100,
	NVME_SC_QID_INVALID		= 0x101,
	NVME_SC_QUEUE_SIZE		= 0x102,
	NVME_SC_ABORT_LIMIT		= 0x103,
	NVME_SC_ABORT_MISSING		= 0x104,
	NVME_SC_ASYNC_LIMIT		= 0x105,
	NVME_SC_FIRMWARE_SLOT		= 0x106,
	NVME_SC_FIRMWARE_IMAGE		= 0x107,
	NVME_SC_INVALID_VECTOR		= 0x108,
	NVME_SC_INVALID_LOG_PAGE	= 0x109,
	NVME_SC_INVALID_FORMAT		= 0x10a,
	NVME_SC_BAD_ATTRIBUTES		= 0x180,
	NVME_SC_WRITE_FAULT		= 0x280,
	NVME_SC_READ_ERROR		= 0x281,
	NVME_SC_GUARD_CHECK		= 0x282,
	NVME_SC_APPTAG_CHECK		= 0x283,
	NVME_SC_REFTAG_CHECK		= 0x284,
	NVME_SC_COMPARE_FAILED		= 0x285,
	NVME_SC_ACCESS_DENIED		= 0x286,
};

struct nvme_completion {
	__le32	result;		/* Used by admin commands to return data */
	__u32	rsvd;
	__le16	sq_head;	/* how much of this queue may be reclaimed */
	__le16	sq_id;		/* submission queue that generated this entry */
	__u16	command_id;	/* of the command which completed */
	__le16	status;		/* did the command fail, and if so, why? */
};

struct nvme_user_io {
	__u8	opcode;
	__u8	flags;
	__u16	control;
	__u16	nblocks;
	__u16	rsvd;
	__u64	metadata;
	__u64	addr;
	__u64	slba;
	__u32	dsmgmt;
	__u32	reftag;
	__u16	apptag;
	__u16	appmask;
};

struct nvme_admin_cmd {
	__u8	opcode;
	__u8	flags;
	__u16	rsvd1;
	__u32	nsid;
	__u32	cdw2;
	__u32	cdw3;
	__u64	metadata;
	__u64	addr;
	__u32	metadata_len;
	__u32	data_len;
	__u32	cdw10;
	__u32	cdw11;
	__u32	cdw12;
	__u32	cdw13;
	__u32	cdw14;
	__u32	cdw15;
	__u32	timeout_ms;
	__u32	result;
};

#define NVME_IOCTL_ID		_IO('N', 0x40)
#define NVME_IOCTL_ADMIN_CMD	_IOWR('N', 0x41, struct nvme_admin_cmd)
#define NVME_IOCTL_SUBMIT_IO	_IOW('N', 0x42, struct nvme_user_io)

#endif /* _LINUX_NVME_H */
Commit	Line	Data
b60503ba MW	1	/*
	2	* Definitions for the NVM Express interface
	3	* Copyright (c) 2011, Intel Corporation.
	4	*
	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.
	13	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
	17	*/
	18
	19	#ifndef _LINUX_NVME_H
	20	#define _LINUX_NVME_H
	21
	22	#include <linux/types.h>
	23
	24	struct nvme_bar {
	25	__u64 cap; /* Controller Capabilities */
	26	__u32 vs; /* Version */
897cfe1c MW	27	__u32 intms; /* Interrupt Mask Set */
897cfe1c MW	28	__u32 intmc; /* Interrupt Mask Clear */
b60503ba	29	__u32 cc; /* Controller Configuration */
897cfe1c	30	__u32 rsvd1; /* Reserved */
b60503ba	31	__u32 csts; /* Controller Status */
897cfe1c	32	__u32 rsvd2; /* Reserved */
b60503ba MW	33	__u32 aqa; /* Admin Queue Attributes */
	34	__u64 asq; /* Admin SQ Base Address */
	35	__u64 acq; /* Admin CQ Base Address */
	36	};
	37
22605f96	38	#define NVME_CAP_TIMEOUT(cap) (((cap) >> 24) & 0xff)
f1938f6e	39	#define NVME_CAP_STRIDE(cap) (((cap) >> 32) & 0xf)
22605f96	40
b60503ba MW	41	enum {
	42	NVME_CC_ENABLE = 1 << 0,
	43	NVME_CC_CSS_NVM = 0 << 4,
	44	NVME_CC_MPS_SHIFT = 7,
	45	NVME_CC_ARB_RR = 0 << 11,
	46	NVME_CC_ARB_WRRU = 1 << 11,
7f53f9d2 MW	47	NVME_CC_ARB_VS = 7 << 11,
	48	NVME_CC_SHN_NONE = 0 << 14,
	49	NVME_CC_SHN_NORMAL = 1 << 14,
	50	NVME_CC_SHN_ABRUPT = 2 << 14,
	51	NVME_CC_IOSQES = 6 << 16,
	52	NVME_CC_IOCQES = 4 << 20,
b60503ba MW	53	NVME_CSTS_RDY = 1 << 0,
	54	NVME_CSTS_CFS = 1 << 1,
	55	NVME_CSTS_SHST_NORMAL = 0 << 2,
	56	NVME_CSTS_SHST_OCCUR = 1 << 2,
	57	NVME_CSTS_SHST_CMPLT = 2 << 2,
	58	};
	59
010e646b MW	60	struct nvme_id_power_state {
	61	__le16 max_power; /* centiwatts */
	62	__u16 rsvd2;
	63	__le32 entry_lat; /* microseconds */
	64	__le32 exit_lat; /* microseconds */
	65	__u8 read_tput;
	66	__u8 read_lat;
	67	__u8 write_tput;
	68	__u8 write_lat;
	69	__u8 rsvd16[16];
	70	};
	71
b60503ba MW	72	#define NVME_VS(major, minor) (major << 16 \| minor)
	73
	74	struct nvme_id_ctrl {
	75	__le16 vid;
	76	__le16 ssvid;
	77	char sn[20];
	78	char mn[40];
	79	char fr[8];
b60503ba	80	__u8 rab;
010e646b MW	81	__u8 ieee[3];
	82	__u8 mic;
	83	__u8 mdts;
	84	__u8 rsvd78[178];
b60503ba MW	85	__le16 oacs;
	86	__u8 acl;
	87	__u8 aerl;
	88	__u8 frmw;
	89	__u8 lpa;
	90	__u8 elpe;
	91	__u8 npss;
	92	__u8 rsvd264[248];
010e646b MW	93	__u8 sqes;
	94	__u8 cqes;
	95	__u8 rsvd514[2];
	96	__le32 nn;
b60503ba MW	97	__le16 oncs;
	98	__le16 fuses;
	99	__u8 fna;
	100	__u8 vwc;
	101	__le16 awun;
	102	__le16 awupf;
010e646b MW	103	__u8 rsvd530[1518];
010e646b MW	104	struct nvme_id_power_state psd[32];
b60503ba MW	105	__u8 vs[1024];
	106	};
	107
	108	struct nvme_lbaf {
	109	__le16 ms;
	110	__u8 ds;
	111	__u8 rp;
	112	};
	113
	114	struct nvme_id_ns {
	115	__le64 nsze;
	116	__le64 ncap;
	117	__le64 nuse;
	118	__u8 nsfeat;
	119	__u8 nlbaf;
	120	__u8 flbas;
	121	__u8 mc;
	122	__u8 dpc;
	123	__u8 dps;
	124	__u8 rsvd30[98];
	125	struct nvme_lbaf lbaf[16];
	126	__u8 rsvd192[192];
	127	__u8 vs[3712];
	128	};
	129
	130	enum {
	131	NVME_NS_FEAT_THIN = 1 << 0,
	132	NVME_LBAF_RP_BEST = 0,
	133	NVME_LBAF_RP_BETTER = 1,
	134	NVME_LBAF_RP_GOOD = 2,
	135	NVME_LBAF_RP_DEGRADED = 3,
	136	};
	137
	138	struct nvme_lba_range_type {
	139	__u8 type;
	140	__u8 attributes;
	141	__u8 rsvd2[14];
	142	__u64 slba;
	143	__u64 nlb;
	144	__u8 guid[16];
	145	__u8 rsvd48[16];
	146	};
	147
	148	enum {
	149	NVME_LBART_TYPE_FS = 0x01,
	150	NVME_LBART_TYPE_RAID = 0x02,
	151	NVME_LBART_TYPE_CACHE = 0x03,
	152	NVME_LBART_TYPE_SWAP = 0x04,
	153
	154	NVME_LBART_ATTRIB_TEMP = 1 << 0,
	155	NVME_LBART_ATTRIB_HIDE = 1 << 1,
	156	};
	157
	158	/* I/O commands */
	159
	160	enum nvme_opcode {
	161	nvme_cmd_flush = 0x00,
	162	nvme_cmd_write = 0x01,
	163	nvme_cmd_read = 0x02,
	164	nvme_cmd_write_uncor = 0x04,
	165	nvme_cmd_compare = 0x05,
	166	nvme_cmd_dsm = 0x09,
	167	};
	168
7b4fe9b1 MW	169	struct nvme_common_command {
	170	__u8 opcode;
	171	__u8 flags;
	172	__u16 command_id;
	173	__le32 nsid;
6bbf1acd	174	__u32 cdw2[2];
7b4fe9b1 MW	175	__le64 metadata;
	176	__le64 prp1;
	177	__le64 prp2;
6bbf1acd	178	__u32 cdw10[6];
7b4fe9b1 MW	179	};
7b4fe9b1 MW	180
b60503ba MW	181	struct nvme_rw_command {
	182	__u8 opcode;
	183	__u8 flags;
	184	__u16 command_id;
	185	__le32 nsid;
	186	__u64 rsvd2;
	187	__le64 metadata;
	188	__le64 prp1;
	189	__le64 prp2;
	190	__le64 slba;
	191	__le16 length;
	192	__le16 control;
	193	__le32 dsmgmt;
	194	__le32 reftag;
	195	__le16 apptag;
	196	__le16 appmask;
	197	};
	198
	199	enum {
	200	NVME_RW_LR = 1 << 15,
	201	NVME_RW_FUA = 1 << 14,
	202	NVME_RW_DSM_FREQ_UNSPEC = 0,
	203	NVME_RW_DSM_FREQ_TYPICAL = 1,
	204	NVME_RW_DSM_FREQ_RARE = 2,
	205	NVME_RW_DSM_FREQ_READS = 3,
	206	NVME_RW_DSM_FREQ_WRITES = 4,
	207	NVME_RW_DSM_FREQ_RW = 5,
	208	NVME_RW_DSM_FREQ_ONCE = 6,
	209	NVME_RW_DSM_FREQ_PREFETCH = 7,
	210	NVME_RW_DSM_FREQ_TEMP = 8,
	211	NVME_RW_DSM_LATENCY_NONE = 0 << 4,
	212	NVME_RW_DSM_LATENCY_IDLE = 1 << 4,
	213	NVME_RW_DSM_LATENCY_NORM = 2 << 4,
	214	NVME_RW_DSM_LATENCY_LOW = 3 << 4,
	215	NVME_RW_DSM_SEQ_REQ = 1 << 6,
	216	NVME_RW_DSM_COMPRESSED = 1 << 7,
	217	};
	218
	219	/* Admin commands */
	220
	221	enum nvme_admin_opcode {
	222	nvme_admin_delete_sq = 0x00,
	223	nvme_admin_create_sq = 0x01,
2ddc4f74	224	nvme_admin_get_log_page = 0x02,
b60503ba MW	225	nvme_admin_delete_cq = 0x04,
	226	nvme_admin_create_cq = 0x05,
	227	nvme_admin_identify = 0x06,
	228	nvme_admin_abort_cmd = 0x08,
	229	nvme_admin_set_features = 0x09,
2ddc4f74	230	nvme_admin_get_features = 0x0a,
b60503ba	231	nvme_admin_async_event = 0x0c,
2ddc4f74 KW	232	nvme_admin_activate_fw = 0x10,
	233	nvme_admin_download_fw = 0x11,
	234	nvme_admin_format_nvm = 0x80,
	235	nvme_admin_security_send = 0x81,
	236	nvme_admin_security_recv = 0x82,
b60503ba MW	237	};
	238
	239	enum {
	240	NVME_QUEUE_PHYS_CONTIG = (1 << 0),
	241	NVME_CQ_IRQ_ENABLED = (1 << 1),
	242	NVME_SQ_PRIO_URGENT = (0 << 1),
	243	NVME_SQ_PRIO_HIGH = (1 << 1),
	244	NVME_SQ_PRIO_MEDIUM = (2 << 1),
	245	NVME_SQ_PRIO_LOW = (3 << 1),
	246	NVME_FEAT_ARBITRATION = 0x01,
	247	NVME_FEAT_POWER_MGMT = 0x02,
	248	NVME_FEAT_LBA_RANGE = 0x03,
	249	NVME_FEAT_TEMP_THRESH = 0x04,
	250	NVME_FEAT_ERR_RECOVERY = 0x05,
	251	NVME_FEAT_VOLATILE_WC = 0x06,
	252	NVME_FEAT_NUM_QUEUES = 0x07,
	253	NVME_FEAT_IRQ_COALESCE = 0x08,
	254	NVME_FEAT_IRQ_CONFIG = 0x09,
	255	NVME_FEAT_WRITE_ATOMIC = 0x0a,
	256	NVME_FEAT_ASYNC_EVENT = 0x0b,
	257	NVME_FEAT_SW_PROGRESS = 0x0c,
	258	};
	259
	260	struct nvme_identify {
	261	__u8 opcode;
	262	__u8 flags;
	263	__u16 command_id;
	264	__le32 nsid;
	265	__u64 rsvd2[2];
	266	__le64 prp1;
	267	__le64 prp2;
	268	__le32 cns;
	269	__u32 rsvd11[5];
	270	};
	271
	272	struct nvme_features {
	273	__u8 opcode;
	274	__u8 flags;
	275	__u16 command_id;
	276	__le32 nsid;
	277	__u64 rsvd2[2];
	278	__le64 prp1;
	279	__le64 prp2;
	280	__le32 fid;
	281	__le32 dword11;
	282	__u32 rsvd12[4];
	283	};
	284
	285	struct nvme_create_cq {
	286	__u8 opcode;
	287	__u8 flags;
	288	__u16 command_id;
6ee44cdc	289	__u32 rsvd1[5];
b60503ba MW	290	__le64 prp1;
	291	__u64 rsvd8;
	292	__le16 cqid;
	293	__le16 qsize;
	294	__le16 cq_flags;
	295	__le16 irq_vector;
	296	__u32 rsvd12[4];
	297	};
	298
	299	struct nvme_create_sq {
	300	__u8 opcode;
	301	__u8 flags;
	302	__u16 command_id;
6ee44cdc	303	__u32 rsvd1[5];
b60503ba MW	304	__le64 prp1;
	305	__u64 rsvd8;
	306	__le16 sqid;
	307	__le16 qsize;
	308	__le16 sq_flags;
	309	__le16 cqid;
6ee44cdc	310	__u32 rsvd12[4];
b60503ba MW	311	};
	312
	313	struct nvme_delete_queue {
	314	__u8 opcode;
	315	__u8 flags;
	316	__u16 command_id;
	317	__u32 rsvd1[9];
	318	__le16 qid;
6ee44cdc MW	319	__u16 rsvd10;
	320	__u32 rsvd11[5];
	321	};
	322
	323	struct nvme_download_firmware {
	324	__u8 opcode;
	325	__u8 flags;
	326	__u16 command_id;
	327	__u32 rsvd1[5];
	328	__le64 prp1;
	329	__le64 prp2;
	330	__le32 numd;
	331	__le32 offset;
	332	__u32 rsvd12[4];
b60503ba MW	333	};
b60503ba MW	334
b60503ba MW	335	struct nvme_command {
	336	union {
	337	struct nvme_common_command common;
	338	struct nvme_rw_command rw;
	339	struct nvme_identify identify;
	340	struct nvme_features features;
	341	struct nvme_create_cq create_cq;
	342	struct nvme_create_sq create_sq;
	343	struct nvme_delete_queue delete_queue;
6ee44cdc	344	struct nvme_download_firmware dlfw;
b60503ba MW	345	};
	346	};
	347
b60503ba MW	348	enum {
	349	NVME_SC_SUCCESS = 0x0,
	350	NVME_SC_INVALID_OPCODE = 0x1,
	351	NVME_SC_INVALID_FIELD = 0x2,
	352	NVME_SC_CMDID_CONFLICT = 0x3,
	353	NVME_SC_DATA_XFER_ERROR = 0x4,
	354	NVME_SC_POWER_LOSS = 0x5,
	355	NVME_SC_INTERNAL = 0x6,
	356	NVME_SC_ABORT_REQ = 0x7,
	357	NVME_SC_ABORT_QUEUE = 0x8,
	358	NVME_SC_FUSED_FAIL = 0x9,
	359	NVME_SC_FUSED_MISSING = 0xa,
7a63e07b	360	NVME_SC_INVALID_NS = 0xb,
b60503ba MW	361	NVME_SC_LBA_RANGE = 0x80,
	362	NVME_SC_CAP_EXCEEDED = 0x81,
	363	NVME_SC_NS_NOT_READY = 0x82,
	364	NVME_SC_CQ_INVALID = 0x100,
	365	NVME_SC_QID_INVALID = 0x101,
	366	NVME_SC_QUEUE_SIZE = 0x102,
7a63e07b MW	367	NVME_SC_ABORT_LIMIT = 0x103,
	368	NVME_SC_ABORT_MISSING = 0x104,
	369	NVME_SC_ASYNC_LIMIT = 0x105,
	370	NVME_SC_FIRMWARE_SLOT = 0x106,
	371	NVME_SC_FIRMWARE_IMAGE = 0x107,
	372	NVME_SC_INVALID_VECTOR = 0x108,
	373	NVME_SC_INVALID_LOG_PAGE = 0x109,
	374	NVME_SC_INVALID_FORMAT = 0x10a,
	375	NVME_SC_BAD_ATTRIBUTES = 0x180,
b60503ba MW	376	NVME_SC_WRITE_FAULT = 0x280,
b60503ba MW	377	NVME_SC_READ_ERROR = 0x281,
7a63e07b MW	378	NVME_SC_GUARD_CHECK = 0x282,
	379	NVME_SC_APPTAG_CHECK = 0x283,
	380	NVME_SC_REFTAG_CHECK = 0x284,
	381	NVME_SC_COMPARE_FAILED = 0x285,
	382	NVME_SC_ACCESS_DENIED = 0x286,
b60503ba MW	383	};
	384
	385	struct nvme_completion {
	386	__le32 result; /* Used by admin commands to return data */
6ee44cdc	387	__u32 rsvd;
b60503ba MW	388	__le16 sq_head; /* how much of this queue may be reclaimed */
	389	__le16 sq_id; /* submission queue that generated this entry */
	390	__u16 command_id; /* of the command which completed */
	391	__le16 status; /* did the command fail, and if so, why? */
	392	};
	393
a53295b6 MW	394	struct nvme_user_io {
	395	__u8 opcode;
	396	__u8 flags;
	397	__u16 control;
6c7d4945 MW	398	__u16 nblocks;
6c7d4945 MW	399	__u16 rsvd;
a53295b6 MW	400	__u64 metadata;
	401	__u64 addr;
	402	__u64 slba;
a53295b6 MW	403	__u32 dsmgmt;
	404	__u32 reftag;
	405	__u16 apptag;
	406	__u16 appmask;
a53295b6 MW	407	};
a53295b6 MW	408
6bbf1acd MW	409	struct nvme_admin_cmd {
	410	__u8 opcode;
	411	__u8 flags;
	412	__u16 rsvd1;
	413	__u32 nsid;
	414	__u32 cdw2;
	415	__u32 cdw3;
	416	__u64 metadata;
6ee44cdc	417	__u64 addr;
6bbf1acd MW	418	__u32 metadata_len;
	419	__u32 data_len;
	420	__u32 cdw10;
	421	__u32 cdw11;
	422	__u32 cdw12;
	423	__u32 cdw13;
	424	__u32 cdw14;
	425	__u32 cdw15;
	426	__u32 timeout_ms;
	427	__u32 result;
6ee44cdc MW	428	};
6ee44cdc MW	429
6bbf1acd MW	430	#define NVME_IOCTL_ID _IO('N', 0x40)
	431	#define NVME_IOCTL_ADMIN_CMD _IOWR('N', 0x41, struct nvme_admin_cmd)
	432	#define NVME_IOCTL_SUBMIT_IO _IOW('N', 0x42, struct nvme_user_io)
b60503ba MW	433
b60503ba MW	434	#endif /* _LINUX_NVME_H */