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>
24 extern unsigned char nvme_io_timeout;
25 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
27 extern unsigned char admin_timeout;
28 #define ADMIN_TIMEOUT (admin_timeout * HZ)
30 #define NVME_DEFAULT_KATO 5
31 #define NVME_KATO_GRACE 10
33 extern struct workqueue_struct *nvme_wq;
41 * List of workarounds for devices that required behavior not specified in
46 * Prefers I/O aligned to a stripe size specified in a vendor
47 * specific Identify field.
49 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
52 * The controller doesn't handle Identify value others than 0 or 1
55 NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
58 * The controller deterministically returns O's on reads to
59 * logical blocks that deallocate was called on.
61 NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2),
64 * The controller needs a delay before starts checking the device
65 * readiness, which is done by reading the NVME_CSTS_RDY bit.
67 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3),
70 * APST should not be used.
72 NVME_QUIRK_NO_APST = (1 << 4),
75 * The deepest sleep state should not be used.
77 NVME_QUIRK_NO_DEEPEST_PS = (1 << 5),
80 * Supports the LighNVM command set if indicated in vs[1].
82 NVME_QUIRK_LIGHTNVM = (1 << 6),
85 * Set MEDIUM priority on SQ creation
87 NVME_QUIRK_MEDIUM_PRIO_SQ = (1 << 7),
91 * Common request structure for NVMe passthrough. All drivers must have
92 * this structure as the first member of their request-private data.
95 struct nvme_command *cmd;
96 union nvme_result result;
103 NVME_REQ_CANCELLED = (1 << 0),
106 static inline struct nvme_request *nvme_req(struct request *req)
108 return blk_mq_rq_to_pdu(req);
111 /* The below value is the specific amount of delay needed before checking
112 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
113 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
116 #define NVME_QUIRK_DELAY_AMOUNT 2300
118 enum nvme_ctrl_state {
122 NVME_CTRL_RECONNECTING,
128 enum nvme_ctrl_state state;
131 const struct nvme_ctrl_ops *ops;
132 struct request_queue *admin_q;
133 struct request_queue *connect_q;
137 struct blk_mq_tag_set *tagset;
138 struct blk_mq_tag_set *admin_tagset;
139 struct list_head namespaces;
140 struct mutex namespaces_mutex;
141 struct device *device; /* char device */
142 struct list_head node;
144 struct work_struct reset_work;
146 struct opal_dev *opal_dev;
151 char firmware_rev[8];
152 char subnqn[NVMF_NQN_SIZE];
167 atomic_t abort_limit;
175 unsigned int shutdown_timeout;
178 unsigned long quirks;
179 struct nvme_id_power_state psd[32];
180 struct work_struct scan_work;
181 struct work_struct async_event_work;
182 struct delayed_work ka_work;
183 struct work_struct fw_act_work;
185 /* Power saving configuration */
186 u64 ps_max_latency_us;
202 struct nvmf_ctrl_options *opts;
206 struct list_head list;
208 struct nvme_ctrl *ctrl;
209 struct request_queue *queue;
210 struct gendisk *disk;
211 struct nvm_dev *ndev;
227 #define NVME_NS_REMOVING 0
228 #define NVME_NS_DEAD 1
232 struct nvme_ctrl_ops {
234 struct module *module;
236 #define NVME_F_FABRICS (1 << 0)
237 #define NVME_F_METADATA_SUPPORTED (1 << 1)
238 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
239 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
240 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
241 void (*free_ctrl)(struct nvme_ctrl *ctrl);
242 void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx);
243 int (*delete_ctrl)(struct nvme_ctrl *ctrl);
244 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
247 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
251 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
253 return val & NVME_CSTS_RDY;
256 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
258 if (!ctrl->subsystem)
260 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
263 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
265 return (sector >> (ns->lba_shift - 9));
268 static inline void nvme_cleanup_cmd(struct request *req)
270 if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
271 kfree(page_address(req->special_vec.bv_page) +
272 req->special_vec.bv_offset);
276 static inline void nvme_end_request(struct request *req, __le16 status,
277 union nvme_result result)
279 struct nvme_request *rq = nvme_req(req);
281 rq->status = le16_to_cpu(status) >> 1;
283 blk_mq_complete_request(req);
286 void nvme_complete_rq(struct request *req);
287 void nvme_cancel_request(struct request *req, void *data, bool reserved);
288 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
289 enum nvme_ctrl_state new_state);
290 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
291 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
292 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
293 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
294 const struct nvme_ctrl_ops *ops, unsigned long quirks);
295 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
296 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
297 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
298 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
299 int nvme_init_identify(struct nvme_ctrl *ctrl);
301 void nvme_queue_scan(struct nvme_ctrl *ctrl);
302 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
304 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
307 #define NVME_NR_AERS 1
308 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
309 union nvme_result *res);
310 void nvme_queue_async_events(struct nvme_ctrl *ctrl);
312 void nvme_stop_queues(struct nvme_ctrl *ctrl);
313 void nvme_start_queues(struct nvme_ctrl *ctrl);
314 void nvme_kill_queues(struct nvme_ctrl *ctrl);
315 void nvme_unfreeze(struct nvme_ctrl *ctrl);
316 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
317 void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
318 void nvme_start_freeze(struct nvme_ctrl *ctrl);
320 #define NVME_QID_ANY -1
321 struct request *nvme_alloc_request(struct request_queue *q,
322 struct nvme_command *cmd, unsigned int flags, int qid);
323 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
324 struct nvme_command *cmd);
325 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
326 void *buf, unsigned bufflen);
327 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
328 union nvme_result *result, void *buffer, unsigned bufflen,
329 unsigned timeout, int qid, int at_head, int flags);
330 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
331 void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
332 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
333 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
336 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
337 void nvme_nvm_unregister(struct nvme_ns *ns);
338 int nvme_nvm_register_sysfs(struct nvme_ns *ns);
339 void nvme_nvm_unregister_sysfs(struct nvme_ns *ns);
340 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
342 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
348 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
349 static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns)
353 static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {};
354 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
359 #endif /* CONFIG_NVM */
361 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
363 return dev_to_disk(dev)->private_data;
366 int __init nvme_core_init(void);
367 void nvme_core_exit(void);