2 * Copyright (c) 2011-2014, Intel Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 #include <linux/nvme.h>
18 #include <linux/pci.h>
19 #include <linux/kref.h>
20 #include <linux/blk-mq.h>
24 * Driver internal status code for commands that were cancelled due
25 * to timeouts or controller shutdown. The value is negative so
26 * that it a) doesn't overlap with the unsigned hardware error codes,
27 * and b) can easily be tested for.
29 NVME_SC_CANCELLED = -EINTR,
32 extern unsigned char nvme_io_timeout;
33 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
35 extern unsigned char admin_timeout;
36 #define ADMIN_TIMEOUT (admin_timeout * HZ)
38 extern unsigned char shutdown_timeout;
39 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
47 * List of workarounds for devices that required behavior not specified in
52 * Prefers I/O aligned to a stripe size specified in a vendor
53 * specific Identify field.
55 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
59 const struct nvme_ctrl_ops *ops;
60 struct request_queue *admin_q;
64 struct blk_mq_tag_set *tagset;
65 struct list_head namespaces;
66 struct device *device; /* char device */
67 struct list_head node;
89 * An NVM Express namespace is equivalent to a SCSI LUN
92 struct list_head list;
94 struct nvme_ctrl *ctrl;
95 struct request_queue *queue;
105 u64 mode_select_num_blocks;
106 u32 mode_select_block_len;
109 struct nvme_ctrl_ops {
110 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
111 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
112 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
113 bool (*io_incapable)(struct nvme_ctrl *ctrl);
114 int (*reset_ctrl)(struct nvme_ctrl *ctrl);
115 void (*free_ctrl)(struct nvme_ctrl *ctrl);
118 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
122 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
124 return val & NVME_CSTS_RDY;
127 static inline bool nvme_io_incapable(struct nvme_ctrl *ctrl)
131 if (ctrl->ops->io_incapable(ctrl))
133 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
135 return val & NVME_CSTS_CFS;
138 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
140 if (!ctrl->subsystem)
142 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
145 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
147 return (sector >> (ns->lba_shift - 9));
150 static inline void nvme_setup_flush(struct nvme_ns *ns,
151 struct nvme_command *cmnd)
153 memset(cmnd, 0, sizeof(*cmnd));
154 cmnd->common.opcode = nvme_cmd_flush;
155 cmnd->common.nsid = cpu_to_le32(ns->ns_id);
158 static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req,
159 struct nvme_command *cmnd)
164 if (req->cmd_flags & REQ_FUA)
165 control |= NVME_RW_FUA;
166 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
167 control |= NVME_RW_LR;
169 if (req->cmd_flags & REQ_RAHEAD)
170 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
172 memset(cmnd, 0, sizeof(*cmnd));
173 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
174 cmnd->rw.command_id = req->tag;
175 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
176 cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
177 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
180 switch (ns->pi_type) {
181 case NVME_NS_DPS_PI_TYPE3:
182 control |= NVME_RW_PRINFO_PRCHK_GUARD;
184 case NVME_NS_DPS_PI_TYPE1:
185 case NVME_NS_DPS_PI_TYPE2:
186 control |= NVME_RW_PRINFO_PRCHK_GUARD |
187 NVME_RW_PRINFO_PRCHK_REF;
188 cmnd->rw.reftag = cpu_to_le32(
189 nvme_block_nr(ns, blk_rq_pos(req)));
192 if (!blk_integrity_rq(req))
193 control |= NVME_RW_PRINFO_PRACT;
196 cmnd->rw.control = cpu_to_le16(control);
197 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
201 static inline int nvme_error_status(u16 status)
203 switch (status & 0x7ff) {
204 case NVME_SC_SUCCESS:
206 case NVME_SC_CAP_EXCEEDED:
213 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
214 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
215 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
216 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
217 const struct nvme_ctrl_ops *ops, unsigned long quirks);
218 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
219 int nvme_init_identify(struct nvme_ctrl *ctrl);
221 void nvme_scan_namespaces(struct nvme_ctrl *ctrl);
222 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
224 struct request *nvme_alloc_request(struct request_queue *q,
225 struct nvme_command *cmd, unsigned int flags);
226 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
227 void *buf, unsigned bufflen);
228 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
229 void *buffer, unsigned bufflen, u32 *result, unsigned timeout);
230 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
231 void __user *ubuffer, unsigned bufflen, u32 *result,
233 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
234 void __user *ubuffer, unsigned bufflen,
235 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
236 u32 *result, unsigned timeout);
237 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
238 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
239 struct nvme_id_ns **id);
240 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
241 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
242 dma_addr_t dma_addr, u32 *result);
243 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
244 dma_addr_t dma_addr, u32 *result);
245 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
247 extern spinlock_t dev_list_lock;
251 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
252 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
253 int nvme_sg_get_version_num(int __user *ip);
255 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
256 int nvme_nvm_register(struct request_queue *q, char *disk_name);
257 void nvme_nvm_unregister(struct request_queue *q, char *disk_name);
259 int __init nvme_core_init(void);
260 void nvme_core_exit(void);