1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (c) 2011-2014, Intel Corporation.
9 #include <linux/nvme.h>
10 #include <linux/cdev.h>
11 #include <linux/pci.h>
12 #include <linux/kref.h>
13 #include <linux/blk-mq.h>
14 #include <linux/lightnvm.h>
15 #include <linux/sed-opal.h>
16 #include <linux/fault-inject.h>
17 #include <linux/rcupdate.h>
19 extern unsigned int nvme_io_timeout;
20 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
22 extern unsigned int admin_timeout;
23 #define ADMIN_TIMEOUT (admin_timeout * HZ)
25 #define NVME_DEFAULT_KATO 5
26 #define NVME_KATO_GRACE 10
28 extern struct workqueue_struct *nvme_wq;
29 extern struct workqueue_struct *nvme_reset_wq;
30 extern struct workqueue_struct *nvme_delete_wq;
38 * List of workarounds for devices that required behavior not specified in
43 * Prefers I/O aligned to a stripe size specified in a vendor
44 * specific Identify field.
46 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
49 * The controller doesn't handle Identify value others than 0 or 1
52 NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
55 * The controller deterministically returns O's on reads to
56 * logical blocks that deallocate was called on.
58 NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2),
61 * The controller needs a delay before starts checking the device
62 * readiness, which is done by reading the NVME_CSTS_RDY bit.
64 NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3),
67 * APST should not be used.
69 NVME_QUIRK_NO_APST = (1 << 4),
72 * The deepest sleep state should not be used.
74 NVME_QUIRK_NO_DEEPEST_PS = (1 << 5),
77 * Supports the LighNVM command set if indicated in vs[1].
79 NVME_QUIRK_LIGHTNVM = (1 << 6),
82 * Set MEDIUM priority on SQ creation
84 NVME_QUIRK_MEDIUM_PRIO_SQ = (1 << 7),
87 * Ignore device provided subnqn.
89 NVME_QUIRK_IGNORE_DEV_SUBNQN = (1 << 8),
92 * Broken Write Zeroes.
94 NVME_QUIRK_DISABLE_WRITE_ZEROES = (1 << 9),
98 * Common request structure for NVMe passthrough. All drivers must have
99 * this structure as the first member of their request-private data.
101 struct nvme_request {
102 struct nvme_command *cmd;
103 union nvme_result result;
107 struct nvme_ctrl *ctrl;
111 * Mark a bio as coming in through the mpath node.
113 #define REQ_NVME_MPATH REQ_DRV
116 NVME_REQ_CANCELLED = (1 << 0),
117 NVME_REQ_USERCMD = (1 << 1),
120 static inline struct nvme_request *nvme_req(struct request *req)
122 return blk_mq_rq_to_pdu(req);
125 static inline u16 nvme_req_qid(struct request *req)
129 return blk_mq_unique_tag_to_hwq(blk_mq_unique_tag(req)) + 1;
132 /* The below value is the specific amount of delay needed before checking
133 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
134 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
137 #define NVME_QUIRK_DELAY_AMOUNT 2300
139 enum nvme_ctrl_state {
142 NVME_CTRL_ADMIN_ONLY, /* Only admin queue live */
144 NVME_CTRL_CONNECTING,
151 enum nvme_ctrl_state state;
154 struct mutex scan_lock;
155 const struct nvme_ctrl_ops *ops;
156 struct request_queue *admin_q;
157 struct request_queue *connect_q;
161 struct blk_mq_tag_set *tagset;
162 struct blk_mq_tag_set *admin_tagset;
163 struct list_head namespaces;
164 struct rw_semaphore namespaces_rwsem;
165 struct device ctrl_device;
166 struct device *device; /* char device */
168 struct work_struct reset_work;
169 struct work_struct delete_work;
171 struct nvme_subsystem *subsys;
172 struct list_head subsys_entry;
174 struct opal_dev *opal_dev;
193 atomic_t abort_limit;
203 unsigned int shutdown_timeout;
206 unsigned long quirks;
207 struct nvme_id_power_state psd[32];
208 struct nvme_effects_log *effects;
209 struct work_struct scan_work;
210 struct work_struct async_event_work;
211 struct delayed_work ka_work;
212 struct nvme_command ka_cmd;
213 struct work_struct fw_act_work;
214 unsigned long events;
216 #ifdef CONFIG_NVME_MULTIPATH
217 /* asymmetric namespace access: */
222 struct mutex ana_lock;
223 struct nvme_ana_rsp_hdr *ana_log_buf;
225 struct timer_list anatt_timer;
226 struct work_struct ana_work;
229 /* Power saving configuration */
230 u64 ps_max_latency_us;
246 struct nvmf_ctrl_options *opts;
248 struct page *discard_page;
249 unsigned long discard_page_busy;
257 struct nvme_subsystem {
261 * Because we unregister the device on the last put we need
262 * a separate refcount.
265 struct list_head entry;
267 struct list_head ctrls;
268 struct list_head nsheads;
269 char subnqn[NVMF_NQN_SIZE];
272 char firmware_rev[8];
276 #ifdef CONFIG_NVME_MULTIPATH
277 enum nvme_iopolicy iopolicy;
282 * Container structure for uniqueue namespace identifiers.
291 * Anchor structure for namespaces. There is one for each namespace in a
292 * NVMe subsystem that any of our controllers can see, and the namespace
293 * structure for each controller is chained of it. For private namespaces
294 * there is a 1:1 relation to our namespace structures, that is ->list
295 * only ever has a single entry for private namespaces.
297 struct nvme_ns_head {
298 struct list_head list;
299 struct srcu_struct srcu;
300 struct nvme_subsystem *subsys;
302 struct nvme_ns_ids ids;
303 struct list_head entry;
306 #ifdef CONFIG_NVME_MULTIPATH
307 struct gendisk *disk;
308 struct bio_list requeue_list;
309 spinlock_t requeue_lock;
310 struct work_struct requeue_work;
312 struct nvme_ns __rcu *current_path[];
316 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
317 struct nvme_fault_inject {
318 struct fault_attr attr;
319 struct dentry *parent;
320 bool dont_retry; /* DNR, do not retry */
321 u16 status; /* status code */
326 struct list_head list;
328 struct nvme_ctrl *ctrl;
329 struct request_queue *queue;
330 struct gendisk *disk;
331 #ifdef CONFIG_NVME_MULTIPATH
332 enum nvme_ana_state ana_state;
335 struct list_head siblings;
336 struct nvm_dev *ndev;
338 struct nvme_ns_head *head;
347 #define NVME_NS_REMOVING 0
348 #define NVME_NS_DEAD 1
349 #define NVME_NS_ANA_PENDING 2
352 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
353 struct nvme_fault_inject fault_inject;
358 struct nvme_ctrl_ops {
360 struct module *module;
362 #define NVME_F_FABRICS (1 << 0)
363 #define NVME_F_METADATA_SUPPORTED (1 << 1)
364 #define NVME_F_PCI_P2PDMA (1 << 2)
365 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
366 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
367 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
368 void (*free_ctrl)(struct nvme_ctrl *ctrl);
369 void (*submit_async_event)(struct nvme_ctrl *ctrl);
370 void (*delete_ctrl)(struct nvme_ctrl *ctrl);
371 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
374 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
375 void nvme_fault_inject_init(struct nvme_ns *ns);
376 void nvme_fault_inject_fini(struct nvme_ns *ns);
377 void nvme_should_fail(struct request *req);
379 static inline void nvme_fault_inject_init(struct nvme_ns *ns) {}
380 static inline void nvme_fault_inject_fini(struct nvme_ns *ns) {}
381 static inline void nvme_should_fail(struct request *req) {}
384 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
386 if (!ctrl->subsystem)
388 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
391 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
393 return (sector >> (ns->lba_shift - 9));
396 static inline void nvme_end_request(struct request *req, __le16 status,
397 union nvme_result result)
399 struct nvme_request *rq = nvme_req(req);
401 rq->status = le16_to_cpu(status) >> 1;
403 /* inject error when permitted by fault injection framework */
404 nvme_should_fail(req);
405 blk_mq_complete_request(req);
408 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
410 get_device(ctrl->device);
413 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
415 put_device(ctrl->device);
418 void nvme_complete_rq(struct request *req);
419 bool nvme_cancel_request(struct request *req, void *data, bool reserved);
420 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
421 enum nvme_ctrl_state new_state);
422 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
423 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
424 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
425 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
426 const struct nvme_ctrl_ops *ops, unsigned long quirks);
427 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
428 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
429 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
430 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
431 int nvme_init_identify(struct nvme_ctrl *ctrl);
433 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
435 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
438 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
439 volatile union nvme_result *res);
441 void nvme_stop_queues(struct nvme_ctrl *ctrl);
442 void nvme_start_queues(struct nvme_ctrl *ctrl);
443 void nvme_kill_queues(struct nvme_ctrl *ctrl);
444 void nvme_unfreeze(struct nvme_ctrl *ctrl);
445 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
446 void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
447 void nvme_start_freeze(struct nvme_ctrl *ctrl);
449 #define NVME_QID_ANY -1
450 struct request *nvme_alloc_request(struct request_queue *q,
451 struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
452 void nvme_cleanup_cmd(struct request *req);
453 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
454 struct nvme_command *cmd);
455 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
456 void *buf, unsigned bufflen);
457 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
458 union nvme_result *result, void *buffer, unsigned bufflen,
459 unsigned timeout, int qid, int at_head,
460 blk_mq_req_flags_t flags, bool poll);
461 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
462 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
463 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
464 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
465 int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
467 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp,
468 void *log, size_t size, u64 offset);
470 extern const struct attribute_group *nvme_ns_id_attr_groups[];
471 extern const struct block_device_operations nvme_ns_head_ops;
473 #ifdef CONFIG_NVME_MULTIPATH
474 bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl);
475 void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
476 struct nvme_ctrl *ctrl, int *flags);
477 void nvme_failover_req(struct request *req);
478 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
479 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
480 void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
481 void nvme_mpath_remove_disk(struct nvme_ns_head *head);
482 int nvme_mpath_init(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
483 void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
484 void nvme_mpath_stop(struct nvme_ctrl *ctrl);
485 void nvme_mpath_clear_current_path(struct nvme_ns *ns);
486 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
488 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
490 struct nvme_ns_head *head = ns->head;
492 if (head->disk && list_empty(&head->list))
493 kblockd_schedule_work(&head->requeue_work);
496 extern struct device_attribute dev_attr_ana_grpid;
497 extern struct device_attribute dev_attr_ana_state;
498 extern struct device_attribute subsys_attr_iopolicy;
501 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
506 * Without the multipath code enabled, multiple controller per subsystems are
507 * visible as devices and thus we cannot use the subsystem instance.
509 static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
510 struct nvme_ctrl *ctrl, int *flags)
512 sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance);
515 static inline void nvme_failover_req(struct request *req)
518 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
521 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
522 struct nvme_ns_head *head)
526 static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
527 struct nvme_id_ns *id)
530 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
533 static inline void nvme_mpath_clear_current_path(struct nvme_ns *ns)
536 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
539 static inline int nvme_mpath_init(struct nvme_ctrl *ctrl,
540 struct nvme_id_ctrl *id)
542 if (ctrl->subsys->cmic & (1 << 3))
543 dev_warn(ctrl->device,
544 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
547 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
550 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
553 #endif /* CONFIG_NVME_MULTIPATH */
556 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
557 void nvme_nvm_unregister(struct nvme_ns *ns);
558 extern const struct attribute_group nvme_nvm_attr_group;
559 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
561 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
567 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
568 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
573 #endif /* CONFIG_NVM */
575 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
577 return dev_to_disk(dev)->private_data;
580 int __init nvme_core_init(void);
581 void __exit nvme_core_exit(void);