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>
22 #include <linux/sed-opal.h>
26 * Driver internal status code for commands that were cancelled due
27 * to timeouts or controller shutdown. The value is negative so
28 * that it a) doesn't overlap with the unsigned hardware error codes,
29 * and b) can easily be tested for.
31 NVME_SC_CANCELLED = -EINTR,
34 extern unsigned char nvme_io_timeout;
35 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
37 extern unsigned char admin_timeout;
38 #define ADMIN_TIMEOUT (admin_timeout * HZ)
40 extern unsigned char shutdown_timeout;
41 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
43 #define NVME_DEFAULT_KATO 5
44 #define NVME_KATO_GRACE 10
46 extern unsigned int nvme_max_retries;
54 * List of workarounds for devices that required behavior not specified in
59 * Prefers I/O aligned to a stripe size specified in a vendor
60 * specific Identify field.
62 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
65 * The controller doesn't handle Identify value others than 0 or 1
68 NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
71 * The controller deterministically returns O's on reads to discarded
74 NVME_QUIRK_DISCARD_ZEROES = (1 << 2),
77 * The controller needs a delay before starts checking the device
78 * readiness, which is done by reading the NVME_CSTS_RDY bit.
80 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3),
83 * APST should not be used.
85 NVME_QUIRK_NO_APST = (1 << 4),
89 * Common request structure for NVMe passthrough. All drivers must have
90 * this structure as the first member of their request-private data.
93 struct nvme_command *cmd;
94 union nvme_result result;
97 static inline struct nvme_request *nvme_req(struct request *req)
99 return blk_mq_rq_to_pdu(req);
102 /* The below value is the specific amount of delay needed before checking
103 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
104 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
107 #define NVME_QUIRK_DELAY_AMOUNT 2000
109 enum nvme_ctrl_state {
113 NVME_CTRL_RECONNECTING,
119 enum nvme_ctrl_state state;
122 const struct nvme_ctrl_ops *ops;
123 struct request_queue *admin_q;
124 struct request_queue *connect_q;
128 struct blk_mq_tag_set *tagset;
129 struct list_head namespaces;
130 struct mutex namespaces_mutex;
131 struct device *device; /* char device */
132 struct list_head node;
135 struct opal_dev *opal_dev;
140 char firmware_rev[8];
150 atomic_t abort_limit;
160 unsigned long quirks;
161 struct nvme_id_power_state psd[32];
162 struct work_struct scan_work;
163 struct work_struct async_event_work;
164 struct delayed_work ka_work;
166 /* Power saving configuration */
167 u64 ps_max_latency_us;
175 struct nvmf_ctrl_options *opts;
179 * An NVM Express namespace is equivalent to a SCSI LUN
182 struct list_head list;
184 struct nvme_ctrl *ctrl;
185 struct request_queue *queue;
186 struct gendisk *disk;
187 struct nvm_dev *ndev;
201 #define NVME_NS_REMOVING 0
202 #define NVME_NS_DEAD 1
204 u64 mode_select_num_blocks;
205 u32 mode_select_block_len;
208 struct nvme_ctrl_ops {
210 struct module *module;
212 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
213 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
214 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
215 int (*reset_ctrl)(struct nvme_ctrl *ctrl);
216 void (*free_ctrl)(struct nvme_ctrl *ctrl);
217 void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx);
218 int (*delete_ctrl)(struct nvme_ctrl *ctrl);
219 const char *(*get_subsysnqn)(struct nvme_ctrl *ctrl);
220 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
223 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
227 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
229 return val & NVME_CSTS_RDY;
232 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
234 if (!ctrl->subsystem)
236 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
239 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
241 return (sector >> (ns->lba_shift - 9));
244 static inline void nvme_cleanup_cmd(struct request *req)
246 if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
247 kfree(page_address(req->special_vec.bv_page) +
248 req->special_vec.bv_offset);
252 static inline int nvme_error_status(u16 status)
254 switch (status & 0x7ff) {
255 case NVME_SC_SUCCESS:
257 case NVME_SC_CAP_EXCEEDED:
264 static inline bool nvme_req_needs_retry(struct request *req, u16 status)
266 return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
267 (jiffies - req->start_time) < req->timeout &&
268 req->retries < nvme_max_retries;
271 void nvme_cancel_request(struct request *req, void *data, bool reserved);
272 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
273 enum nvme_ctrl_state new_state);
274 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
275 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
276 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
277 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
278 const struct nvme_ctrl_ops *ops, unsigned long quirks);
279 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
280 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
281 int nvme_init_identify(struct nvme_ctrl *ctrl);
283 void nvme_queue_scan(struct nvme_ctrl *ctrl);
284 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
286 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
289 #define NVME_NR_AERS 1
290 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
291 union nvme_result *res);
292 void nvme_queue_async_events(struct nvme_ctrl *ctrl);
294 void nvme_stop_queues(struct nvme_ctrl *ctrl);
295 void nvme_start_queues(struct nvme_ctrl *ctrl);
296 void nvme_kill_queues(struct nvme_ctrl *ctrl);
297 void nvme_unfreeze(struct nvme_ctrl *ctrl);
298 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
299 void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
300 void nvme_start_freeze(struct nvme_ctrl *ctrl);
302 #define NVME_QID_ANY -1
303 struct request *nvme_alloc_request(struct request_queue *q,
304 struct nvme_command *cmd, unsigned int flags, int qid);
305 void nvme_requeue_req(struct request *req);
306 int nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
307 struct nvme_command *cmd);
308 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
309 void *buf, unsigned bufflen);
310 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
311 union nvme_result *result, void *buffer, unsigned bufflen,
312 unsigned timeout, int qid, int at_head, int flags);
313 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
314 void __user *ubuffer, unsigned bufflen, u32 *result,
316 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
317 void __user *ubuffer, unsigned bufflen,
318 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
319 u32 *result, unsigned timeout);
320 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
321 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
322 struct nvme_id_ns **id);
323 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
324 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
325 void *buffer, size_t buflen, u32 *result);
326 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
327 void *buffer, size_t buflen, u32 *result);
328 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
329 void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
330 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
334 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
335 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
336 int nvme_sg_get_version_num(int __user *ip);
339 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
340 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
341 void nvme_nvm_unregister(struct nvme_ns *ns);
342 int nvme_nvm_register_sysfs(struct nvme_ns *ns);
343 void nvme_nvm_unregister_sysfs(struct nvme_ns *ns);
344 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
346 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
352 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
353 static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns)
357 static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {};
358 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
362 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
367 #endif /* CONFIG_NVM */
369 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
371 return dev_to_disk(dev)->private_data;
374 int __init nvme_core_init(void);
375 void nvme_core_exit(void);