Commit | Line | Data |
---|---|---|
b60503ba MW |
1 | /* |
2 | * Definitions for the NVM Express interface | |
42c77683 | 3 | * Copyright (c) 2011-2013, Intel Corporation. |
b60503ba MW |
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 | ||
42c77683 MW |
22 | #include <uapi/linux/nvme.h> |
23 | #include <linux/pci.h> | |
24 | #include <linux/miscdevice.h> | |
25 | #include <linux/kref.h> | |
b60503ba MW |
26 | |
27 | struct nvme_bar { | |
28 | __u64 cap; /* Controller Capabilities */ | |
29 | __u32 vs; /* Version */ | |
897cfe1c MW |
30 | __u32 intms; /* Interrupt Mask Set */ |
31 | __u32 intmc; /* Interrupt Mask Clear */ | |
b60503ba | 32 | __u32 cc; /* Controller Configuration */ |
897cfe1c | 33 | __u32 rsvd1; /* Reserved */ |
b60503ba | 34 | __u32 csts; /* Controller Status */ |
897cfe1c | 35 | __u32 rsvd2; /* Reserved */ |
b60503ba MW |
36 | __u32 aqa; /* Admin Queue Attributes */ |
37 | __u64 asq; /* Admin SQ Base Address */ | |
38 | __u64 acq; /* Admin CQ Base Address */ | |
39 | }; | |
40 | ||
a0cadb85 | 41 | #define NVME_CAP_MQES(cap) ((cap) & 0xffff) |
22605f96 | 42 | #define NVME_CAP_TIMEOUT(cap) (((cap) >> 24) & 0xff) |
f1938f6e | 43 | #define NVME_CAP_STRIDE(cap) (((cap) >> 32) & 0xf) |
8fc23e03 | 44 | #define NVME_CAP_MPSMIN(cap) (((cap) >> 48) & 0xf) |
22605f96 | 45 | |
b60503ba MW |
46 | enum { |
47 | NVME_CC_ENABLE = 1 << 0, | |
48 | NVME_CC_CSS_NVM = 0 << 4, | |
49 | NVME_CC_MPS_SHIFT = 7, | |
50 | NVME_CC_ARB_RR = 0 << 11, | |
51 | NVME_CC_ARB_WRRU = 1 << 11, | |
7f53f9d2 MW |
52 | NVME_CC_ARB_VS = 7 << 11, |
53 | NVME_CC_SHN_NONE = 0 << 14, | |
54 | NVME_CC_SHN_NORMAL = 1 << 14, | |
55 | NVME_CC_SHN_ABRUPT = 2 << 14, | |
1894d8f1 | 56 | NVME_CC_SHN_MASK = 3 << 14, |
7f53f9d2 MW |
57 | NVME_CC_IOSQES = 6 << 16, |
58 | NVME_CC_IOCQES = 4 << 20, | |
b60503ba MW |
59 | NVME_CSTS_RDY = 1 << 0, |
60 | NVME_CSTS_CFS = 1 << 1, | |
61 | NVME_CSTS_SHST_NORMAL = 0 << 2, | |
62 | NVME_CSTS_SHST_OCCUR = 1 << 2, | |
63 | NVME_CSTS_SHST_CMPLT = 2 << 2, | |
1894d8f1 | 64 | NVME_CSTS_SHST_MASK = 3 << 2, |
b60503ba MW |
65 | }; |
66 | ||
67 | #define NVME_VS(major, minor) (major << 16 | minor) | |
68 | ||
13c3b0fc VV |
69 | #define NVME_IO_TIMEOUT (5 * HZ) |
70 | ||
71 | /* | |
72 | * Represents an NVM Express device. Each nvme_dev is a PCI function. | |
73 | */ | |
74 | struct nvme_dev { | |
75 | struct list_head node; | |
76 | struct nvme_queue **queues; | |
77 | u32 __iomem *dbs; | |
78 | struct pci_dev *pci_dev; | |
79 | struct dma_pool *prp_page_pool; | |
80 | struct dma_pool *prp_small_pool; | |
81 | int instance; | |
82 | int queue_count; | |
83 | int db_stride; | |
84 | u32 ctrl_config; | |
85 | struct msix_entry *entry; | |
86 | struct nvme_bar __iomem *bar; | |
87 | struct list_head namespaces; | |
5e82e952 KB |
88 | struct kref kref; |
89 | struct miscdevice miscdev; | |
90 | char name[12]; | |
13c3b0fc VV |
91 | char serial[20]; |
92 | char model[40]; | |
93 | char firmware_rev[8]; | |
94 | u32 max_hw_sectors; | |
159b67d7 | 95 | u32 stripe_size; |
13c3b0fc VV |
96 | u16 oncs; |
97 | }; | |
98 | ||
99 | /* | |
100 | * An NVM Express namespace is equivalent to a SCSI LUN | |
101 | */ | |
102 | struct nvme_ns { | |
103 | struct list_head list; | |
104 | ||
105 | struct nvme_dev *dev; | |
106 | struct request_queue *queue; | |
107 | struct gendisk *disk; | |
108 | ||
c3bfe717 | 109 | unsigned ns_id; |
13c3b0fc | 110 | int lba_shift; |
f410c680 | 111 | int ms; |
5d0f6131 VV |
112 | u64 mode_select_num_blocks; |
113 | u32 mode_select_block_len; | |
13c3b0fc VV |
114 | }; |
115 | ||
116 | /* | |
117 | * The nvme_iod describes the data in an I/O, including the list of PRP | |
118 | * entries. You can't see it in this data structure because C doesn't let | |
119 | * me express that. Use nvme_alloc_iod to ensure there's enough space | |
120 | * allocated to store the PRP list. | |
121 | */ | |
122 | struct nvme_iod { | |
123 | void *private; /* For the use of the submitter of the I/O */ | |
124 | int npages; /* In the PRP list. 0 means small pool in use */ | |
125 | int offset; /* Of PRP list */ | |
126 | int nents; /* Used in scatterlist */ | |
127 | int length; /* Of data, in bytes */ | |
6198221f | 128 | unsigned long start_time; |
13c3b0fc VV |
129 | dma_addr_t first_dma; |
130 | struct scatterlist sg[0]; | |
131 | }; | |
5d0f6131 | 132 | |
063cc6d5 MW |
133 | static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector) |
134 | { | |
135 | return (sector >> (ns->lba_shift - 9)); | |
136 | } | |
137 | ||
5d0f6131 VV |
138 | /** |
139 | * nvme_free_iod - frees an nvme_iod | |
140 | * @dev: The device that the I/O was submitted to | |
141 | * @iod: The memory to free | |
142 | */ | |
143 | void nvme_free_iod(struct nvme_dev *dev, struct nvme_iod *iod); | |
144 | ||
145 | int nvme_setup_prps(struct nvme_dev *dev, struct nvme_common_command *cmd, | |
146 | struct nvme_iod *iod, int total_len, gfp_t gfp); | |
147 | struct nvme_iod *nvme_map_user_pages(struct nvme_dev *dev, int write, | |
148 | unsigned long addr, unsigned length); | |
149 | void nvme_unmap_user_pages(struct nvme_dev *dev, int write, | |
150 | struct nvme_iod *iod); | |
151 | struct nvme_queue *get_nvmeq(struct nvme_dev *dev); | |
152 | void put_nvmeq(struct nvme_queue *nvmeq); | |
153 | int nvme_submit_sync_cmd(struct nvme_queue *nvmeq, struct nvme_command *cmd, | |
154 | u32 *result, unsigned timeout); | |
155 | int nvme_submit_flush_data(struct nvme_queue *nvmeq, struct nvme_ns *ns); | |
156 | int nvme_submit_admin_cmd(struct nvme_dev *, struct nvme_command *, | |
157 | u32 *result); | |
158 | int nvme_identify(struct nvme_dev *, unsigned nsid, unsigned cns, | |
159 | dma_addr_t dma_addr); | |
160 | int nvme_get_features(struct nvme_dev *dev, unsigned fid, unsigned nsid, | |
161 | dma_addr_t dma_addr, u32 *result); | |
162 | int nvme_set_features(struct nvme_dev *dev, unsigned fid, unsigned dword11, | |
163 | dma_addr_t dma_addr, u32 *result); | |
164 | ||
165 | struct sg_io_hdr; | |
166 | ||
167 | int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr); | |
168 | int nvme_sg_get_version_num(int __user *ip); | |
169 | ||
b60503ba | 170 | #endif /* _LINUX_NVME_H */ |