2011-01-20 17:50:14 +00:00
|
|
|
/*
|
|
|
|
* 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 */
|
2011-02-14 17:20:15 +00:00
|
|
|
__u32 intms; /* Interrupt Mask Set */
|
|
|
|
__u32 intmc; /* Interrupt Mask Clear */
|
2011-01-20 17:50:14 +00:00
|
|
|
__u32 cc; /* Controller Configuration */
|
2011-02-14 17:20:15 +00:00
|
|
|
__u32 rsvd1; /* Reserved */
|
2011-01-20 17:50:14 +00:00
|
|
|
__u32 csts; /* Controller Status */
|
2011-02-14 17:20:15 +00:00
|
|
|
__u32 rsvd2; /* Reserved */
|
2011-01-20 17:50:14 +00:00
|
|
|
__u32 aqa; /* Admin Queue Attributes */
|
|
|
|
__u64 asq; /* Admin SQ Base Address */
|
|
|
|
__u64 acq; /* Admin CQ Base Address */
|
|
|
|
};
|
|
|
|
|
|
|
|
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 = 3 << 11,
|
|
|
|
NVME_CC_SHN_NONE = 0 << 13,
|
|
|
|
NVME_CC_SHN_NORMAL = 1 << 13,
|
|
|
|
NVME_CC_SHN_ABRUPT = 2 << 13,
|
|
|
|
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,
|
|
|
|
};
|
|
|
|
|
|
|
|
#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];
|
|
|
|
__le32 nn;
|
|
|
|
__u8 rab;
|
|
|
|
__u8 rsvd77[178];
|
|
|
|
__le16 oacs;
|
|
|
|
__u8 acl;
|
|
|
|
__u8 aerl;
|
|
|
|
__u8 frmw;
|
|
|
|
__u8 lpa;
|
|
|
|
__u8 elpe;
|
|
|
|
__u8 npss;
|
|
|
|
__u8 rsvd264[248];
|
|
|
|
__le64 psd[32];
|
|
|
|
__le16 oncs;
|
|
|
|
__le16 fuses;
|
|
|
|
__u8 fna;
|
|
|
|
__u8 vwc;
|
|
|
|
__le16 awun;
|
|
|
|
__le16 awupf;
|
|
|
|
__u8 rsvd778[246];
|
|
|
|
__u8 cmdset[2048];
|
|
|
|
__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,
|
|
|
|
};
|
|
|
|
|
2011-01-26 15:01:21 +00:00
|
|
|
struct nvme_common_command {
|
|
|
|
__u8 opcode;
|
|
|
|
__u8 flags;
|
|
|
|
__u16 command_id;
|
|
|
|
__le32 nsid;
|
|
|
|
__u64 rsvd2;
|
|
|
|
__le64 metadata;
|
|
|
|
__le64 prp1;
|
|
|
|
__le64 prp2;
|
|
|
|
__u32 rsvd10[6];
|
|
|
|
};
|
|
|
|
|
2011-01-20 17:50:14 +00:00
|
|
|
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,
|
2011-02-28 07:27:13 +00:00
|
|
|
nvme_admin_get_log_page = 0x02,
|
2011-01-20 17:50:14 +00:00
|
|
|
nvme_admin_delete_cq = 0x04,
|
|
|
|
nvme_admin_create_cq = 0x05,
|
|
|
|
nvme_admin_identify = 0x06,
|
|
|
|
nvme_admin_abort_cmd = 0x08,
|
|
|
|
nvme_admin_set_features = 0x09,
|
2011-02-28 07:27:13 +00:00
|
|
|
nvme_admin_get_features = 0x0a,
|
2011-01-20 17:50:14 +00:00
|
|
|
nvme_admin_async_event = 0x0c,
|
2011-02-28 07:27:13 +00:00
|
|
|
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,
|
2011-01-20 17:50:14 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
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;
|
2011-02-03 15:58:26 +00:00
|
|
|
__u32 rsvd1[5];
|
2011-01-20 17:50:14 +00:00
|
|
|
__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;
|
2011-02-03 15:58:26 +00:00
|
|
|
__u32 rsvd1[5];
|
2011-01-20 17:50:14 +00:00
|
|
|
__le64 prp1;
|
|
|
|
__u64 rsvd8;
|
|
|
|
__le16 sqid;
|
|
|
|
__le16 qsize;
|
|
|
|
__le16 sq_flags;
|
|
|
|
__le16 cqid;
|
2011-02-03 15:58:26 +00:00
|
|
|
__u32 rsvd12[4];
|
2011-01-20 17:50:14 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct nvme_delete_queue {
|
|
|
|
__u8 opcode;
|
|
|
|
__u8 flags;
|
|
|
|
__u16 command_id;
|
|
|
|
__u32 rsvd1[9];
|
|
|
|
__le16 qid;
|
2011-02-03 15:58:26 +00:00
|
|
|
__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];
|
2011-01-20 17:50:14 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
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;
|
2011-02-03 15:58:26 +00:00
|
|
|
struct nvme_download_firmware dlfw;
|
2011-01-20 17:50:14 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
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,
|
2011-02-03 14:20:57 +00:00
|
|
|
NVME_SC_INVALID_NS = 0xb,
|
2011-01-20 17:50:14 +00:00
|
|
|
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,
|
2011-02-03 14:20:57 +00:00
|
|
|
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,
|
2011-01-20 17:50:14 +00:00
|
|
|
NVME_SC_WRITE_FAULT = 0x280,
|
|
|
|
NVME_SC_READ_ERROR = 0x281,
|
2011-02-03 14:20:57 +00:00
|
|
|
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,
|
2011-01-20 17:50:14 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct nvme_completion {
|
|
|
|
__le32 result; /* Used by admin commands to return data */
|
2011-02-03 15:58:26 +00:00
|
|
|
__u32 rsvd;
|
2011-01-20 17:50:14 +00:00
|
|
|
__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? */
|
|
|
|
};
|
|
|
|
|
2011-02-01 21:13:29 +00:00
|
|
|
struct nvme_user_io {
|
|
|
|
__u8 opcode;
|
|
|
|
__u8 flags;
|
|
|
|
__u16 control;
|
|
|
|
__u32 nsid;
|
|
|
|
__u64 metadata;
|
|
|
|
__u64 addr;
|
|
|
|
__u64 slba;
|
|
|
|
__u16 nblocks;
|
|
|
|
__u16 block_shift;
|
|
|
|
__u32 dsmgmt;
|
|
|
|
__u32 reftag;
|
|
|
|
__u16 apptag;
|
|
|
|
__u16 appmask;
|
|
|
|
__u32 result;
|
|
|
|
};
|
|
|
|
|
2011-02-03 15:58:26 +00:00
|
|
|
struct nvme_dlfw {
|
|
|
|
__u64 addr;
|
|
|
|
__u32 length; /* In dwords */
|
|
|
|
__u32 offset; /* In dwords */
|
|
|
|
};
|
|
|
|
|
2011-01-20 17:50:14 +00:00
|
|
|
#define NVME_IOCTL_IDENTIFY_NS _IOW('N', 0x40, struct nvme_id_ns)
|
|
|
|
#define NVME_IOCTL_IDENTIFY_CTRL _IOW('N', 0x41, struct nvme_id_ctrl)
|
|
|
|
#define NVME_IOCTL_GET_RANGE_TYPE _IOW('N', 0x42, struct nvme_lba_range_type)
|
2011-02-01 21:13:29 +00:00
|
|
|
#define NVME_IOCTL_SUBMIT_IO _IOWR('N', 0x43, struct nvme_rw_command)
|
2011-02-03 15:58:26 +00:00
|
|
|
#define NVME_IOCTL_DOWNLOAD_FW _IOR('N', 0x44, struct nvme_dlfw)
|
|
|
|
#define NVME_IOCTL_ACTIVATE_FW _IO('N', 0x45)
|
2011-01-20 17:50:14 +00:00
|
|
|
|
|
|
|
#endif /* _LINUX_NVME_H */
|