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),
58 * The controller doesn't handle Identify value others than 0 or 1
61 NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
64 * The controller deterministically returns O's on reads to discarded
67 NVME_QUIRK_DISCARD_ZEROES = (1 << 2),
71 const struct nvme_ctrl_ops *ops;
72 struct request_queue *admin_q;
76 struct blk_mq_tag_set *tagset;
77 struct list_head namespaces;
78 struct mutex namespaces_mutex;
79 struct device *device; /* char device */
80 struct list_head node;
101 unsigned long quirks;
105 * An NVM Express namespace is equivalent to a SCSI LUN
108 struct list_head list;
110 struct nvme_ctrl *ctrl;
111 struct request_queue *queue;
112 struct gendisk *disk;
127 #define NVME_NS_REMOVING 0
128 #define NVME_NS_DEAD 1
130 u64 mode_select_num_blocks;
131 u32 mode_select_block_len;
134 struct nvme_ctrl_ops {
135 struct module *module;
136 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
137 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
138 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
139 int (*reset_ctrl)(struct nvme_ctrl *ctrl);
140 void (*free_ctrl)(struct nvme_ctrl *ctrl);
143 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
147 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
149 return val & NVME_CSTS_RDY;
152 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
154 if (!ctrl->subsystem)
156 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
159 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
161 return (sector >> (ns->lba_shift - 9));
164 static inline unsigned nvme_map_len(struct request *rq)
166 if (rq->cmd_flags & REQ_DISCARD)
167 return sizeof(struct nvme_dsm_range);
169 return blk_rq_bytes(rq);
172 static inline int nvme_error_status(u16 status)
174 switch (status & 0x7ff) {
175 case NVME_SC_SUCCESS:
177 case NVME_SC_CAP_EXCEEDED:
184 static inline bool nvme_req_needs_retry(struct request *req, u16 status)
186 return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
187 (jiffies - req->start_time) < req->timeout;
190 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
191 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
192 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
193 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
194 const struct nvme_ctrl_ops *ops, unsigned long quirks);
195 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
196 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
197 int nvme_init_identify(struct nvme_ctrl *ctrl);
199 void nvme_scan_namespaces(struct nvme_ctrl *ctrl);
200 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
202 void nvme_stop_queues(struct nvme_ctrl *ctrl);
203 void nvme_start_queues(struct nvme_ctrl *ctrl);
204 void nvme_kill_queues(struct nvme_ctrl *ctrl);
206 struct request *nvme_alloc_request(struct request_queue *q,
207 struct nvme_command *cmd, unsigned int flags);
208 void nvme_requeue_req(struct request *req);
209 int nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
210 struct nvme_command *cmd);
211 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
212 void *buf, unsigned bufflen);
213 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
214 struct nvme_completion *cqe, void *buffer, unsigned bufflen,
216 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
217 void __user *ubuffer, unsigned bufflen, u32 *result,
219 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
220 void __user *ubuffer, unsigned bufflen,
221 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
222 u32 *result, unsigned timeout);
223 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
224 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
225 struct nvme_id_ns **id);
226 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
227 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
228 dma_addr_t dma_addr, u32 *result);
229 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
230 dma_addr_t dma_addr, u32 *result);
231 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
235 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
236 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
237 int nvme_sg_get_version_num(int __user *ip);
240 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
241 int nvme_nvm_register(struct request_queue *q, char *disk_name);
242 void nvme_nvm_unregister(struct request_queue *q, char *disk_name);
244 static inline int nvme_nvm_register(struct request_queue *q, char *disk_name)
249 static inline void nvme_nvm_unregister(struct request_queue *q, char *disk_name) {};
251 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
255 #endif /* CONFIG_NVM */
257 int __init nvme_core_init(void);
258 void nvme_core_exit(void);