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>
21 #include <linux/lightnvm.h>
25 * Driver internal status code for commands that were cancelled due
26 * to timeouts or controller shutdown. The value is negative so
27 * that it a) doesn't overlap with the unsigned hardware error codes,
28 * and b) can easily be tested for.
30 NVME_SC_CANCELLED = -EINTR,
33 extern unsigned char nvme_io_timeout;
34 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
36 extern unsigned char admin_timeout;
37 #define ADMIN_TIMEOUT (admin_timeout * HZ)
39 extern unsigned char shutdown_timeout;
40 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
42 #define NVME_DEFAULT_KATO 5
43 #define NVME_KATO_GRACE 10
45 extern unsigned int nvme_max_retries;
53 * List of workarounds for devices that required behavior not specified in
58 * Prefers I/O aligned to a stripe size specified in a vendor
59 * specific Identify field.
61 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
64 * The controller doesn't handle Identify value others than 0 or 1
67 NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
70 * The controller deterministically returns O's on reads to discarded
73 NVME_QUIRK_DISCARD_ZEROES = (1 << 2),
76 * The controller needs a delay before starts checking the device
77 * readiness, which is done by reading the NVME_CSTS_RDY bit.
79 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3),
82 /* The below value is the specific amount of delay needed before checking
83 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
84 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
87 #define NVME_QUIRK_DELAY_AMOUNT 2000
89 enum nvme_ctrl_state {
93 NVME_CTRL_RECONNECTING,
99 enum nvme_ctrl_state state;
101 const struct nvme_ctrl_ops *ops;
102 struct request_queue *admin_q;
103 struct request_queue *connect_q;
107 struct blk_mq_tag_set *tagset;
108 struct list_head namespaces;
109 struct mutex namespaces_mutex;
110 struct device *device; /* char device */
111 struct list_head node;
117 char firmware_rev[8];
127 atomic_t abort_limit;
135 unsigned long quirks;
136 struct work_struct scan_work;
137 struct work_struct async_event_work;
138 struct delayed_work ka_work;
146 struct nvmf_ctrl_options *opts;
150 * An NVM Express namespace is equivalent to a SCSI LUN
153 struct list_head list;
155 struct nvme_ctrl *ctrl;
156 struct request_queue *queue;
157 struct gendisk *disk;
158 struct nvm_dev *ndev;
172 #define NVME_NS_REMOVING 0
173 #define NVME_NS_DEAD 1
175 u64 mode_select_num_blocks;
176 u32 mode_select_block_len;
179 struct nvme_ctrl_ops {
181 struct module *module;
183 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
184 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
185 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
186 int (*reset_ctrl)(struct nvme_ctrl *ctrl);
187 void (*free_ctrl)(struct nvme_ctrl *ctrl);
188 void (*post_scan)(struct nvme_ctrl *ctrl);
189 void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx);
190 int (*delete_ctrl)(struct nvme_ctrl *ctrl);
191 const char *(*get_subsysnqn)(struct nvme_ctrl *ctrl);
192 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
195 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
199 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
201 return val & NVME_CSTS_RDY;
204 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
206 if (!ctrl->subsystem)
208 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
211 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
213 return (sector >> (ns->lba_shift - 9));
216 static inline unsigned nvme_map_len(struct request *rq)
218 if (req_op(rq) == REQ_OP_DISCARD)
219 return sizeof(struct nvme_dsm_range);
221 return blk_rq_bytes(rq);
224 static inline void nvme_cleanup_cmd(struct request *req)
226 if (req_op(req) == REQ_OP_DISCARD)
227 kfree(req->completion_data);
230 static inline int nvme_error_status(u16 status)
232 switch (status & 0x7ff) {
233 case NVME_SC_SUCCESS:
235 case NVME_SC_CAP_EXCEEDED:
242 static inline bool nvme_req_needs_retry(struct request *req, u16 status)
244 return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
245 (jiffies - req->start_time) < req->timeout &&
246 req->retries < nvme_max_retries;
249 void nvme_cancel_request(struct request *req, void *data, bool reserved);
250 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
251 enum nvme_ctrl_state new_state);
252 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
253 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
254 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
255 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
256 const struct nvme_ctrl_ops *ops, unsigned long quirks);
257 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
258 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
259 int nvme_init_identify(struct nvme_ctrl *ctrl);
261 void nvme_queue_scan(struct nvme_ctrl *ctrl);
262 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
264 #define NVME_NR_AERS 1
265 void nvme_complete_async_event(struct nvme_ctrl *ctrl,
266 struct nvme_completion *cqe);
267 void nvme_queue_async_events(struct nvme_ctrl *ctrl);
269 void nvme_stop_queues(struct nvme_ctrl *ctrl);
270 void nvme_start_queues(struct nvme_ctrl *ctrl);
271 void nvme_kill_queues(struct nvme_ctrl *ctrl);
273 #define NVME_QID_ANY -1
274 struct request *nvme_alloc_request(struct request_queue *q,
275 struct nvme_command *cmd, unsigned int flags, int qid);
276 void nvme_requeue_req(struct request *req);
277 int nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
278 struct nvme_command *cmd);
279 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
280 void *buf, unsigned bufflen);
281 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
282 struct nvme_completion *cqe, void *buffer, unsigned bufflen,
283 unsigned timeout, int qid, int at_head, int flags);
284 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
285 void __user *ubuffer, unsigned bufflen, u32 *result,
287 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
288 void __user *ubuffer, unsigned bufflen,
289 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
290 u32 *result, unsigned timeout);
291 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
292 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
293 struct nvme_id_ns **id);
294 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
295 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
296 void *buffer, size_t buflen, u32 *result);
297 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
298 void *buffer, size_t buflen, u32 *result);
299 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
300 void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
301 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
305 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
306 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
307 int nvme_sg_get_version_num(int __user *ip);
310 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
311 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node,
312 const struct attribute_group *attrs);
313 void nvme_nvm_unregister(struct nvme_ns *ns);
315 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
317 if (dev->type->devnode)
318 return dev_to_disk(dev)->private_data;
320 return (container_of(dev, struct nvm_dev, dev))->private_data;
323 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
325 const struct attribute_group *attrs)
330 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
332 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
336 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
338 return dev_to_disk(dev)->private_data;
340 #endif /* CONFIG_NVM */
342 int __init nvme_core_init(void);
343 void nvme_core_exit(void);