2 * NVM Express device driver
3 * Copyright (c) 2011-2014, Intel Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 #include <linux/bitops.h>
16 #include <linux/blkdev.h>
17 #include <linux/blk-mq.h>
18 #include <linux/cpu.h>
19 #include <linux/delay.h>
20 #include <linux/errno.h>
22 #include <linux/genhd.h>
23 #include <linux/hdreg.h>
24 #include <linux/idr.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
28 #include <linux/kdev_t.h>
29 #include <linux/kthread.h>
30 #include <linux/kernel.h>
31 #include <linux/list_sort.h>
33 #include <linux/module.h>
34 #include <linux/moduleparam.h>
35 #include <linux/pci.h>
36 #include <linux/poison.h>
37 #include <linux/ptrace.h>
38 #include <linux/sched.h>
39 #include <linux/slab.h>
40 #include <linux/t10-pi.h>
41 #include <linux/types.h>
44 #include <linux/io-64-nonatomic-lo-hi.h>
45 #include <asm/unaligned.h>
47 #include <uapi/linux/nvme_ioctl.h>
50 #define NVME_MINORS (1U << MINORBITS)
51 #define NVME_Q_DEPTH 1024
52 #define NVME_AQ_DEPTH 256
53 #define SQ_SIZE(depth) (depth * sizeof(struct nvme_command))
54 #define CQ_SIZE(depth) (depth * sizeof(struct nvme_completion))
55 #define ADMIN_TIMEOUT (admin_timeout * HZ)
56 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
58 static unsigned char admin_timeout = 60;
59 module_param(admin_timeout, byte, 0644);
60 MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
62 unsigned char nvme_io_timeout = 30;
63 module_param_named(io_timeout, nvme_io_timeout, byte, 0644);
64 MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
66 static unsigned char shutdown_timeout = 5;
67 module_param(shutdown_timeout, byte, 0644);
68 MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");
70 static int nvme_major;
71 module_param(nvme_major, int, 0);
73 static int nvme_char_major;
74 module_param(nvme_char_major, int, 0);
76 static int use_threaded_interrupts;
77 module_param(use_threaded_interrupts, int, 0);
79 static bool use_cmb_sqes = true;
80 module_param(use_cmb_sqes, bool, 0644);
81 MODULE_PARM_DESC(use_cmb_sqes, "use controller's memory buffer for I/O SQes");
83 static DEFINE_SPINLOCK(dev_list_lock);
84 static LIST_HEAD(dev_list);
85 static struct task_struct *nvme_thread;
86 static struct workqueue_struct *nvme_workq;
87 static wait_queue_head_t nvme_kthread_wait;
89 static struct class *nvme_class;
91 static int __nvme_reset(struct nvme_dev *dev);
92 static int nvme_reset(struct nvme_dev *dev);
93 static void nvme_process_cq(struct nvme_queue *nvmeq);
94 static void nvme_dead_ctrl(struct nvme_dev *dev);
96 struct async_cmd_info {
97 struct kthread_work work;
98 struct kthread_worker *worker;
106 * An NVM Express queue. Each device has at least two (one for admin
107 * commands and one for I/O commands).
110 struct device *q_dmadev;
111 struct nvme_dev *dev;
112 char irqname[24]; /* nvme4294967295-65535\0 */
114 struct nvme_command *sq_cmds;
115 struct nvme_command __iomem *sq_cmds_io;
116 volatile struct nvme_completion *cqes;
117 struct blk_mq_tags **tags;
118 dma_addr_t sq_dma_addr;
119 dma_addr_t cq_dma_addr;
129 struct async_cmd_info cmdinfo;
133 * The nvme_iod describes the data in an I/O, including the list of PRP
134 * entries. You can't see it in this data structure because C doesn't let
135 * me express that. Use nvme_alloc_iod to ensure there's enough space
136 * allocated to store the PRP list.
139 unsigned long private; /* For the use of the submitter of the I/O */
140 int npages; /* In the PRP list. 0 means small pool in use */
141 int offset; /* Of PRP list */
142 int nents; /* Used in scatterlist */
143 int length; /* Of data, in bytes */
144 dma_addr_t first_dma;
145 struct scatterlist meta_sg[1]; /* metadata requires single contiguous buffer */
146 struct scatterlist sg[0];
150 * Check we didin't inadvertently grow the command struct
152 static inline void _nvme_check_size(void)
154 BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
155 BUILD_BUG_ON(sizeof(struct nvme_create_cq) != 64);
156 BUILD_BUG_ON(sizeof(struct nvme_create_sq) != 64);
157 BUILD_BUG_ON(sizeof(struct nvme_delete_queue) != 64);
158 BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
159 BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64);
160 BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64);
161 BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
162 BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != 4096);
163 BUILD_BUG_ON(sizeof(struct nvme_id_ns) != 4096);
164 BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64);
165 BUILD_BUG_ON(sizeof(struct nvme_smart_log) != 512);
168 typedef void (*nvme_completion_fn)(struct nvme_queue *, void *,
169 struct nvme_completion *);
171 struct nvme_cmd_info {
172 nvme_completion_fn fn;
175 struct nvme_queue *nvmeq;
176 struct nvme_iod iod[0];
180 * Max size of iod being embedded in the request payload
182 #define NVME_INT_PAGES 2
183 #define NVME_INT_BYTES(dev) (NVME_INT_PAGES * (dev)->page_size)
184 #define NVME_INT_MASK 0x01
187 * Will slightly overestimate the number of pages needed. This is OK
188 * as it only leads to a small amount of wasted memory for the lifetime of
191 static int nvme_npages(unsigned size, struct nvme_dev *dev)
193 unsigned nprps = DIV_ROUND_UP(size + dev->page_size, dev->page_size);
194 return DIV_ROUND_UP(8 * nprps, PAGE_SIZE - 8);
197 static unsigned int nvme_cmd_size(struct nvme_dev *dev)
199 unsigned int ret = sizeof(struct nvme_cmd_info);
201 ret += sizeof(struct nvme_iod);
202 ret += sizeof(__le64 *) * nvme_npages(NVME_INT_BYTES(dev), dev);
203 ret += sizeof(struct scatterlist) * NVME_INT_PAGES;
208 static int nvme_admin_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
209 unsigned int hctx_idx)
211 struct nvme_dev *dev = data;
212 struct nvme_queue *nvmeq = dev->queues[0];
214 WARN_ON(hctx_idx != 0);
215 WARN_ON(dev->admin_tagset.tags[0] != hctx->tags);
216 WARN_ON(nvmeq->tags);
218 hctx->driver_data = nvmeq;
219 nvmeq->tags = &dev->admin_tagset.tags[0];
223 static void nvme_admin_exit_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
225 struct nvme_queue *nvmeq = hctx->driver_data;
230 static int nvme_admin_init_request(void *data, struct request *req,
231 unsigned int hctx_idx, unsigned int rq_idx,
232 unsigned int numa_node)
234 struct nvme_dev *dev = data;
235 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
236 struct nvme_queue *nvmeq = dev->queues[0];
243 static int nvme_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
244 unsigned int hctx_idx)
246 struct nvme_dev *dev = data;
247 struct nvme_queue *nvmeq = dev->queues[hctx_idx + 1];
250 nvmeq->tags = &dev->tagset.tags[hctx_idx];
252 WARN_ON(dev->tagset.tags[hctx_idx] != hctx->tags);
253 hctx->driver_data = nvmeq;
257 static int nvme_init_request(void *data, struct request *req,
258 unsigned int hctx_idx, unsigned int rq_idx,
259 unsigned int numa_node)
261 struct nvme_dev *dev = data;
262 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
263 struct nvme_queue *nvmeq = dev->queues[hctx_idx + 1];
270 static void nvme_set_info(struct nvme_cmd_info *cmd, void *ctx,
271 nvme_completion_fn handler)
276 blk_mq_start_request(blk_mq_rq_from_pdu(cmd));
279 static void *iod_get_private(struct nvme_iod *iod)
281 return (void *) (iod->private & ~0x1UL);
285 * If bit 0 is set, the iod is embedded in the request payload.
287 static bool iod_should_kfree(struct nvme_iod *iod)
289 return (iod->private & NVME_INT_MASK) == 0;
292 /* Special values must be less than 0x1000 */
293 #define CMD_CTX_BASE ((void *)POISON_POINTER_DELTA)
294 #define CMD_CTX_CANCELLED (0x30C + CMD_CTX_BASE)
295 #define CMD_CTX_COMPLETED (0x310 + CMD_CTX_BASE)
296 #define CMD_CTX_INVALID (0x314 + CMD_CTX_BASE)
298 static void special_completion(struct nvme_queue *nvmeq, void *ctx,
299 struct nvme_completion *cqe)
301 if (ctx == CMD_CTX_CANCELLED)
303 if (ctx == CMD_CTX_COMPLETED) {
304 dev_warn(nvmeq->q_dmadev,
305 "completed id %d twice on queue %d\n",
306 cqe->command_id, le16_to_cpup(&cqe->sq_id));
309 if (ctx == CMD_CTX_INVALID) {
310 dev_warn(nvmeq->q_dmadev,
311 "invalid id %d completed on queue %d\n",
312 cqe->command_id, le16_to_cpup(&cqe->sq_id));
315 dev_warn(nvmeq->q_dmadev, "Unknown special completion %p\n", ctx);
318 static void *cancel_cmd_info(struct nvme_cmd_info *cmd, nvme_completion_fn *fn)
325 cmd->fn = special_completion;
326 cmd->ctx = CMD_CTX_CANCELLED;
330 static void async_req_completion(struct nvme_queue *nvmeq, void *ctx,
331 struct nvme_completion *cqe)
333 u32 result = le32_to_cpup(&cqe->result);
334 u16 status = le16_to_cpup(&cqe->status) >> 1;
336 if (status == NVME_SC_SUCCESS || status == NVME_SC_ABORT_REQ)
337 ++nvmeq->dev->event_limit;
338 if (status != NVME_SC_SUCCESS)
341 switch (result & 0xff07) {
342 case NVME_AER_NOTICE_NS_CHANGED:
343 dev_info(nvmeq->q_dmadev, "rescanning\n");
344 schedule_work(&nvmeq->dev->scan_work);
346 dev_warn(nvmeq->q_dmadev, "async event result %08x\n", result);
350 static void abort_completion(struct nvme_queue *nvmeq, void *ctx,
351 struct nvme_completion *cqe)
353 struct request *req = ctx;
355 u16 status = le16_to_cpup(&cqe->status) >> 1;
356 u32 result = le32_to_cpup(&cqe->result);
358 blk_mq_free_request(req);
360 dev_warn(nvmeq->q_dmadev, "Abort status:%x result:%x", status, result);
361 ++nvmeq->dev->abort_limit;
364 static void async_completion(struct nvme_queue *nvmeq, void *ctx,
365 struct nvme_completion *cqe)
367 struct async_cmd_info *cmdinfo = ctx;
368 cmdinfo->result = le32_to_cpup(&cqe->result);
369 cmdinfo->status = le16_to_cpup(&cqe->status) >> 1;
370 queue_kthread_work(cmdinfo->worker, &cmdinfo->work);
371 blk_mq_free_request(cmdinfo->req);
374 static inline struct nvme_cmd_info *get_cmd_from_tag(struct nvme_queue *nvmeq,
377 struct request *req = blk_mq_tag_to_rq(*nvmeq->tags, tag);
379 return blk_mq_rq_to_pdu(req);
383 * Called with local interrupts disabled and the q_lock held. May not sleep.
385 static void *nvme_finish_cmd(struct nvme_queue *nvmeq, int tag,
386 nvme_completion_fn *fn)
388 struct nvme_cmd_info *cmd = get_cmd_from_tag(nvmeq, tag);
390 if (tag >= nvmeq->q_depth) {
391 *fn = special_completion;
392 return CMD_CTX_INVALID;
397 cmd->fn = special_completion;
398 cmd->ctx = CMD_CTX_COMPLETED;
403 * nvme_submit_cmd() - Copy a command into a queue and ring the doorbell
404 * @nvmeq: The queue to use
405 * @cmd: The command to send
407 * Safe to use from interrupt context
409 static void __nvme_submit_cmd(struct nvme_queue *nvmeq,
410 struct nvme_command *cmd)
412 u16 tail = nvmeq->sq_tail;
414 if (nvmeq->sq_cmds_io)
415 memcpy_toio(&nvmeq->sq_cmds_io[tail], cmd, sizeof(*cmd));
417 memcpy(&nvmeq->sq_cmds[tail], cmd, sizeof(*cmd));
419 if (++tail == nvmeq->q_depth)
421 writel(tail, nvmeq->q_db);
422 nvmeq->sq_tail = tail;
425 static void nvme_submit_cmd(struct nvme_queue *nvmeq, struct nvme_command *cmd)
428 spin_lock_irqsave(&nvmeq->q_lock, flags);
429 __nvme_submit_cmd(nvmeq, cmd);
430 spin_unlock_irqrestore(&nvmeq->q_lock, flags);
433 static __le64 **iod_list(struct nvme_iod *iod)
435 return ((void *)iod) + iod->offset;
438 static inline void iod_init(struct nvme_iod *iod, unsigned nbytes,
439 unsigned nseg, unsigned long private)
441 iod->private = private;
442 iod->offset = offsetof(struct nvme_iod, sg[nseg]);
444 iod->length = nbytes;
448 static struct nvme_iod *
449 __nvme_alloc_iod(unsigned nseg, unsigned bytes, struct nvme_dev *dev,
450 unsigned long priv, gfp_t gfp)
452 struct nvme_iod *iod = kmalloc(sizeof(struct nvme_iod) +
453 sizeof(__le64 *) * nvme_npages(bytes, dev) +
454 sizeof(struct scatterlist) * nseg, gfp);
457 iod_init(iod, bytes, nseg, priv);
462 static struct nvme_iod *nvme_alloc_iod(struct request *rq, struct nvme_dev *dev,
465 unsigned size = !(rq->cmd_flags & REQ_DISCARD) ? blk_rq_bytes(rq) :
466 sizeof(struct nvme_dsm_range);
467 struct nvme_iod *iod;
469 if (rq->nr_phys_segments <= NVME_INT_PAGES &&
470 size <= NVME_INT_BYTES(dev)) {
471 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(rq);
474 iod_init(iod, size, rq->nr_phys_segments,
475 (unsigned long) rq | NVME_INT_MASK);
479 return __nvme_alloc_iod(rq->nr_phys_segments, size, dev,
480 (unsigned long) rq, gfp);
483 static void nvme_free_iod(struct nvme_dev *dev, struct nvme_iod *iod)
485 const int last_prp = dev->page_size / 8 - 1;
487 __le64 **list = iod_list(iod);
488 dma_addr_t prp_dma = iod->first_dma;
490 if (iod->npages == 0)
491 dma_pool_free(dev->prp_small_pool, list[0], prp_dma);
492 for (i = 0; i < iod->npages; i++) {
493 __le64 *prp_list = list[i];
494 dma_addr_t next_prp_dma = le64_to_cpu(prp_list[last_prp]);
495 dma_pool_free(dev->prp_page_pool, prp_list, prp_dma);
496 prp_dma = next_prp_dma;
499 if (iod_should_kfree(iod))
503 static int nvme_error_status(u16 status)
505 switch (status & 0x7ff) {
506 case NVME_SC_SUCCESS:
508 case NVME_SC_CAP_EXCEEDED:
515 #ifdef CONFIG_BLK_DEV_INTEGRITY
516 static void nvme_dif_prep(u32 p, u32 v, struct t10_pi_tuple *pi)
518 if (be32_to_cpu(pi->ref_tag) == v)
519 pi->ref_tag = cpu_to_be32(p);
522 static void nvme_dif_complete(u32 p, u32 v, struct t10_pi_tuple *pi)
524 if (be32_to_cpu(pi->ref_tag) == p)
525 pi->ref_tag = cpu_to_be32(v);
529 * nvme_dif_remap - remaps ref tags to bip seed and physical lba
531 * The virtual start sector is the one that was originally submitted by the
532 * block layer. Due to partitioning, MD/DM cloning, etc. the actual physical
533 * start sector may be different. Remap protection information to match the
534 * physical LBA on writes, and back to the original seed on reads.
536 * Type 0 and 3 do not have a ref tag, so no remapping required.
538 static void nvme_dif_remap(struct request *req,
539 void (*dif_swap)(u32 p, u32 v, struct t10_pi_tuple *pi))
541 struct nvme_ns *ns = req->rq_disk->private_data;
542 struct bio_integrity_payload *bip;
543 struct t10_pi_tuple *pi;
545 u32 i, nlb, ts, phys, virt;
547 if (!ns->pi_type || ns->pi_type == NVME_NS_DPS_PI_TYPE3)
550 bip = bio_integrity(req->bio);
554 pmap = kmap_atomic(bip->bip_vec->bv_page) + bip->bip_vec->bv_offset;
557 virt = bip_get_seed(bip);
558 phys = nvme_block_nr(ns, blk_rq_pos(req));
559 nlb = (blk_rq_bytes(req) >> ns->lba_shift);
560 ts = ns->disk->queue->integrity.tuple_size;
562 for (i = 0; i < nlb; i++, virt++, phys++) {
563 pi = (struct t10_pi_tuple *)p;
564 dif_swap(phys, virt, pi);
570 static void nvme_init_integrity(struct nvme_ns *ns)
572 struct blk_integrity integrity;
574 switch (ns->pi_type) {
575 case NVME_NS_DPS_PI_TYPE3:
576 integrity.profile = &t10_pi_type3_crc;
578 case NVME_NS_DPS_PI_TYPE1:
579 case NVME_NS_DPS_PI_TYPE2:
580 integrity.profile = &t10_pi_type1_crc;
583 integrity.profile = NULL;
586 integrity.tuple_size = ns->ms;
587 blk_integrity_register(ns->disk, &integrity);
588 blk_queue_max_integrity_segments(ns->queue, 1);
590 #else /* CONFIG_BLK_DEV_INTEGRITY */
591 static void nvme_dif_remap(struct request *req,
592 void (*dif_swap)(u32 p, u32 v, struct t10_pi_tuple *pi))
595 static void nvme_dif_prep(u32 p, u32 v, struct t10_pi_tuple *pi)
598 static void nvme_dif_complete(u32 p, u32 v, struct t10_pi_tuple *pi)
601 static void nvme_init_integrity(struct nvme_ns *ns)
606 static void req_completion(struct nvme_queue *nvmeq, void *ctx,
607 struct nvme_completion *cqe)
609 struct nvme_iod *iod = ctx;
610 struct request *req = iod_get_private(iod);
611 struct nvme_cmd_info *cmd_rq = blk_mq_rq_to_pdu(req);
612 u16 status = le16_to_cpup(&cqe->status) >> 1;
613 bool requeue = false;
616 if (unlikely(status)) {
617 if (!(status & NVME_SC_DNR || blk_noretry_request(req))
618 && (jiffies - req->start_time) < req->timeout) {
622 blk_mq_requeue_request(req);
623 spin_lock_irqsave(req->q->queue_lock, flags);
624 if (!blk_queue_stopped(req->q))
625 blk_mq_kick_requeue_list(req->q);
626 spin_unlock_irqrestore(req->q->queue_lock, flags);
630 if (req->cmd_type == REQ_TYPE_DRV_PRIV) {
631 if (cmd_rq->ctx == CMD_CTX_CANCELLED)
636 error = nvme_error_status(status);
640 if (req->cmd_type == REQ_TYPE_DRV_PRIV) {
641 u32 result = le32_to_cpup(&cqe->result);
642 req->special = (void *)(uintptr_t)result;
646 dev_warn(nvmeq->dev->dev,
647 "completing aborted command with status:%04x\n",
652 dma_unmap_sg(nvmeq->dev->dev, iod->sg, iod->nents,
653 rq_data_dir(req) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
654 if (blk_integrity_rq(req)) {
655 if (!rq_data_dir(req))
656 nvme_dif_remap(req, nvme_dif_complete);
657 dma_unmap_sg(nvmeq->dev->dev, iod->meta_sg, 1,
658 rq_data_dir(req) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
661 nvme_free_iod(nvmeq->dev, iod);
663 if (likely(!requeue))
664 blk_mq_complete_request(req, error);
667 /* length is in bytes. gfp flags indicates whether we may sleep. */
668 static int nvme_setup_prps(struct nvme_dev *dev, struct nvme_iod *iod,
669 int total_len, gfp_t gfp)
671 struct dma_pool *pool;
672 int length = total_len;
673 struct scatterlist *sg = iod->sg;
674 int dma_len = sg_dma_len(sg);
675 u64 dma_addr = sg_dma_address(sg);
676 u32 page_size = dev->page_size;
677 int offset = dma_addr & (page_size - 1);
679 __le64 **list = iod_list(iod);
683 length -= (page_size - offset);
687 dma_len -= (page_size - offset);
689 dma_addr += (page_size - offset);
692 dma_addr = sg_dma_address(sg);
693 dma_len = sg_dma_len(sg);
696 if (length <= page_size) {
697 iod->first_dma = dma_addr;
701 nprps = DIV_ROUND_UP(length, page_size);
702 if (nprps <= (256 / 8)) {
703 pool = dev->prp_small_pool;
706 pool = dev->prp_page_pool;
710 prp_list = dma_pool_alloc(pool, gfp, &prp_dma);
712 iod->first_dma = dma_addr;
714 return (total_len - length) + page_size;
717 iod->first_dma = prp_dma;
720 if (i == page_size >> 3) {
721 __le64 *old_prp_list = prp_list;
722 prp_list = dma_pool_alloc(pool, gfp, &prp_dma);
724 return total_len - length;
725 list[iod->npages++] = prp_list;
726 prp_list[0] = old_prp_list[i - 1];
727 old_prp_list[i - 1] = cpu_to_le64(prp_dma);
730 prp_list[i++] = cpu_to_le64(dma_addr);
731 dma_len -= page_size;
732 dma_addr += page_size;
740 dma_addr = sg_dma_address(sg);
741 dma_len = sg_dma_len(sg);
747 static void nvme_submit_priv(struct nvme_queue *nvmeq, struct request *req,
748 struct nvme_iod *iod)
750 struct nvme_command cmnd;
752 memcpy(&cmnd, req->cmd, sizeof(cmnd));
753 cmnd.rw.command_id = req->tag;
754 if (req->nr_phys_segments) {
755 cmnd.rw.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
756 cmnd.rw.prp2 = cpu_to_le64(iod->first_dma);
759 __nvme_submit_cmd(nvmeq, &cmnd);
763 * We reuse the small pool to allocate the 16-byte range here as it is not
764 * worth having a special pool for these or additional cases to handle freeing
767 static void nvme_submit_discard(struct nvme_queue *nvmeq, struct nvme_ns *ns,
768 struct request *req, struct nvme_iod *iod)
770 struct nvme_dsm_range *range =
771 (struct nvme_dsm_range *)iod_list(iod)[0];
772 struct nvme_command cmnd;
774 range->cattr = cpu_to_le32(0);
775 range->nlb = cpu_to_le32(blk_rq_bytes(req) >> ns->lba_shift);
776 range->slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
778 memset(&cmnd, 0, sizeof(cmnd));
779 cmnd.dsm.opcode = nvme_cmd_dsm;
780 cmnd.dsm.command_id = req->tag;
781 cmnd.dsm.nsid = cpu_to_le32(ns->ns_id);
782 cmnd.dsm.prp1 = cpu_to_le64(iod->first_dma);
784 cmnd.dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
786 __nvme_submit_cmd(nvmeq, &cmnd);
789 static void nvme_submit_flush(struct nvme_queue *nvmeq, struct nvme_ns *ns,
792 struct nvme_command cmnd;
794 memset(&cmnd, 0, sizeof(cmnd));
795 cmnd.common.opcode = nvme_cmd_flush;
796 cmnd.common.command_id = cmdid;
797 cmnd.common.nsid = cpu_to_le32(ns->ns_id);
799 __nvme_submit_cmd(nvmeq, &cmnd);
802 static int nvme_submit_iod(struct nvme_queue *nvmeq, struct nvme_iod *iod,
805 struct request *req = iod_get_private(iod);
806 struct nvme_command cmnd;
810 if (req->cmd_flags & REQ_FUA)
811 control |= NVME_RW_FUA;
812 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
813 control |= NVME_RW_LR;
815 if (req->cmd_flags & REQ_RAHEAD)
816 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
818 memset(&cmnd, 0, sizeof(cmnd));
819 cmnd.rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
820 cmnd.rw.command_id = req->tag;
821 cmnd.rw.nsid = cpu_to_le32(ns->ns_id);
822 cmnd.rw.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
823 cmnd.rw.prp2 = cpu_to_le64(iod->first_dma);
824 cmnd.rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
825 cmnd.rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
828 switch (ns->pi_type) {
829 case NVME_NS_DPS_PI_TYPE3:
830 control |= NVME_RW_PRINFO_PRCHK_GUARD;
832 case NVME_NS_DPS_PI_TYPE1:
833 case NVME_NS_DPS_PI_TYPE2:
834 control |= NVME_RW_PRINFO_PRCHK_GUARD |
835 NVME_RW_PRINFO_PRCHK_REF;
836 cmnd.rw.reftag = cpu_to_le32(
837 nvme_block_nr(ns, blk_rq_pos(req)));
840 if (blk_integrity_rq(req))
842 cpu_to_le64(sg_dma_address(iod->meta_sg));
844 control |= NVME_RW_PRINFO_PRACT;
847 cmnd.rw.control = cpu_to_le16(control);
848 cmnd.rw.dsmgmt = cpu_to_le32(dsmgmt);
850 __nvme_submit_cmd(nvmeq, &cmnd);
856 * NOTE: ns is NULL when called on the admin queue.
858 static int nvme_queue_rq(struct blk_mq_hw_ctx *hctx,
859 const struct blk_mq_queue_data *bd)
861 struct nvme_ns *ns = hctx->queue->queuedata;
862 struct nvme_queue *nvmeq = hctx->driver_data;
863 struct nvme_dev *dev = nvmeq->dev;
864 struct request *req = bd->rq;
865 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
866 struct nvme_iod *iod;
867 enum dma_data_direction dma_dir;
870 * If formated with metadata, require the block layer provide a buffer
871 * unless this namespace is formated such that the metadata can be
872 * stripped/generated by the controller with PRACT=1.
874 if (ns && ns->ms && !blk_integrity_rq(req)) {
875 if (!(ns->pi_type && ns->ms == 8) &&
876 req->cmd_type != REQ_TYPE_DRV_PRIV) {
877 blk_mq_complete_request(req, -EFAULT);
878 return BLK_MQ_RQ_QUEUE_OK;
882 iod = nvme_alloc_iod(req, dev, GFP_ATOMIC);
884 return BLK_MQ_RQ_QUEUE_BUSY;
886 if (req->cmd_flags & REQ_DISCARD) {
889 * We reuse the small pool to allocate the 16-byte range here
890 * as it is not worth having a special pool for these or
891 * additional cases to handle freeing the iod.
893 range = dma_pool_alloc(dev->prp_small_pool, GFP_ATOMIC,
897 iod_list(iod)[0] = (__le64 *)range;
899 } else if (req->nr_phys_segments) {
900 dma_dir = rq_data_dir(req) ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
902 sg_init_table(iod->sg, req->nr_phys_segments);
903 iod->nents = blk_rq_map_sg(req->q, req, iod->sg);
907 if (!dma_map_sg(nvmeq->q_dmadev, iod->sg, iod->nents, dma_dir))
910 if (blk_rq_bytes(req) !=
911 nvme_setup_prps(dev, iod, blk_rq_bytes(req), GFP_ATOMIC)) {
912 dma_unmap_sg(dev->dev, iod->sg, iod->nents, dma_dir);
915 if (blk_integrity_rq(req)) {
916 if (blk_rq_count_integrity_sg(req->q, req->bio) != 1) {
917 dma_unmap_sg(dev->dev, iod->sg, iod->nents,
922 sg_init_table(iod->meta_sg, 1);
923 if (blk_rq_map_integrity_sg(
924 req->q, req->bio, iod->meta_sg) != 1) {
925 dma_unmap_sg(dev->dev, iod->sg, iod->nents,
930 if (rq_data_dir(req))
931 nvme_dif_remap(req, nvme_dif_prep);
933 if (!dma_map_sg(nvmeq->q_dmadev, iod->meta_sg, 1, dma_dir)) {
934 dma_unmap_sg(dev->dev, iod->sg, iod->nents,
941 nvme_set_info(cmd, iod, req_completion);
942 spin_lock_irq(&nvmeq->q_lock);
943 if (req->cmd_type == REQ_TYPE_DRV_PRIV)
944 nvme_submit_priv(nvmeq, req, iod);
945 else if (req->cmd_flags & REQ_DISCARD)
946 nvme_submit_discard(nvmeq, ns, req, iod);
947 else if (req->cmd_flags & REQ_FLUSH)
948 nvme_submit_flush(nvmeq, ns, req->tag);
950 nvme_submit_iod(nvmeq, iod, ns);
952 nvme_process_cq(nvmeq);
953 spin_unlock_irq(&nvmeq->q_lock);
954 return BLK_MQ_RQ_QUEUE_OK;
957 nvme_free_iod(dev, iod);
958 return BLK_MQ_RQ_QUEUE_ERROR;
960 nvme_free_iod(dev, iod);
961 return BLK_MQ_RQ_QUEUE_BUSY;
964 static void __nvme_process_cq(struct nvme_queue *nvmeq, unsigned int *tag)
968 head = nvmeq->cq_head;
969 phase = nvmeq->cq_phase;
973 nvme_completion_fn fn;
974 struct nvme_completion cqe = nvmeq->cqes[head];
975 if ((le16_to_cpu(cqe.status) & 1) != phase)
977 nvmeq->sq_head = le16_to_cpu(cqe.sq_head);
978 if (++head == nvmeq->q_depth) {
982 if (tag && *tag == cqe.command_id)
984 ctx = nvme_finish_cmd(nvmeq, cqe.command_id, &fn);
985 fn(nvmeq, ctx, &cqe);
988 /* If the controller ignores the cq head doorbell and continuously
989 * writes to the queue, it is theoretically possible to wrap around
990 * the queue twice and mistakenly return IRQ_NONE. Linux only
991 * requires that 0.1% of your interrupts are handled, so this isn't
994 if (head == nvmeq->cq_head && phase == nvmeq->cq_phase)
997 if (likely(nvmeq->cq_vector >= 0))
998 writel(head, nvmeq->q_db + nvmeq->dev->db_stride);
999 nvmeq->cq_head = head;
1000 nvmeq->cq_phase = phase;
1002 nvmeq->cqe_seen = 1;
1005 static void nvme_process_cq(struct nvme_queue *nvmeq)
1007 __nvme_process_cq(nvmeq, NULL);
1010 static irqreturn_t nvme_irq(int irq, void *data)
1013 struct nvme_queue *nvmeq = data;
1014 spin_lock(&nvmeq->q_lock);
1015 nvme_process_cq(nvmeq);
1016 result = nvmeq->cqe_seen ? IRQ_HANDLED : IRQ_NONE;
1017 nvmeq->cqe_seen = 0;
1018 spin_unlock(&nvmeq->q_lock);
1022 static irqreturn_t nvme_irq_check(int irq, void *data)
1024 struct nvme_queue *nvmeq = data;
1025 struct nvme_completion cqe = nvmeq->cqes[nvmeq->cq_head];
1026 if ((le16_to_cpu(cqe.status) & 1) != nvmeq->cq_phase)
1028 return IRQ_WAKE_THREAD;
1031 static int nvme_poll(struct blk_mq_hw_ctx *hctx, unsigned int tag)
1033 struct nvme_queue *nvmeq = hctx->driver_data;
1035 if ((le16_to_cpu(nvmeq->cqes[nvmeq->cq_head].status) & 1) ==
1037 spin_lock_irq(&nvmeq->q_lock);
1038 __nvme_process_cq(nvmeq, &tag);
1039 spin_unlock_irq(&nvmeq->q_lock);
1049 * Returns 0 on success. If the result is negative, it's a Linux error code;
1050 * if the result is positive, it's an NVM Express status code
1052 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
1053 void *buffer, void __user *ubuffer, unsigned bufflen,
1054 u32 *result, unsigned timeout)
1056 bool write = cmd->common.opcode & 1;
1057 struct bio *bio = NULL;
1058 struct request *req;
1061 req = blk_mq_alloc_request(q, write, 0);
1063 return PTR_ERR(req);
1065 req->cmd_type = REQ_TYPE_DRV_PRIV;
1066 req->cmd_flags |= REQ_FAILFAST_DRIVER;
1067 req->__data_len = 0;
1068 req->__sector = (sector_t) -1;
1069 req->bio = req->biotail = NULL;
1071 req->timeout = timeout ? timeout : ADMIN_TIMEOUT;
1073 req->cmd = (unsigned char *)cmd;
1074 req->cmd_len = sizeof(struct nvme_command);
1075 req->special = (void *)0;
1077 if (buffer && bufflen) {
1078 ret = blk_rq_map_kern(q, req, buffer, bufflen,
1079 __GFP_DIRECT_RECLAIM);
1082 } else if (ubuffer && bufflen) {
1083 ret = blk_rq_map_user(q, req, NULL, ubuffer, bufflen,
1084 __GFP_DIRECT_RECLAIM);
1090 blk_execute_rq(req->q, NULL, req, 0);
1092 blk_rq_unmap_user(bio);
1094 *result = (u32)(uintptr_t)req->special;
1097 blk_mq_free_request(req);
1101 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
1102 void *buffer, unsigned bufflen)
1104 return __nvme_submit_sync_cmd(q, cmd, buffer, NULL, bufflen, NULL, 0);
1107 static int nvme_submit_async_admin_req(struct nvme_dev *dev)
1109 struct nvme_queue *nvmeq = dev->queues[0];
1110 struct nvme_command c;
1111 struct nvme_cmd_info *cmd_info;
1112 struct request *req;
1114 req = blk_mq_alloc_request(dev->admin_q, WRITE,
1115 BLK_MQ_REQ_NOWAIT | BLK_MQ_REQ_RESERVED);
1117 return PTR_ERR(req);
1119 req->cmd_flags |= REQ_NO_TIMEOUT;
1120 cmd_info = blk_mq_rq_to_pdu(req);
1121 nvme_set_info(cmd_info, NULL, async_req_completion);
1123 memset(&c, 0, sizeof(c));
1124 c.common.opcode = nvme_admin_async_event;
1125 c.common.command_id = req->tag;
1127 blk_mq_free_request(req);
1128 __nvme_submit_cmd(nvmeq, &c);
1132 static int nvme_submit_admin_async_cmd(struct nvme_dev *dev,
1133 struct nvme_command *cmd,
1134 struct async_cmd_info *cmdinfo, unsigned timeout)
1136 struct nvme_queue *nvmeq = dev->queues[0];
1137 struct request *req;
1138 struct nvme_cmd_info *cmd_rq;
1140 req = blk_mq_alloc_request(dev->admin_q, WRITE, 0);
1142 return PTR_ERR(req);
1144 req->timeout = timeout;
1145 cmd_rq = blk_mq_rq_to_pdu(req);
1147 nvme_set_info(cmd_rq, cmdinfo, async_completion);
1148 cmdinfo->status = -EINTR;
1150 cmd->common.command_id = req->tag;
1152 nvme_submit_cmd(nvmeq, cmd);
1156 static int adapter_delete_queue(struct nvme_dev *dev, u8 opcode, u16 id)
1158 struct nvme_command c;
1160 memset(&c, 0, sizeof(c));
1161 c.delete_queue.opcode = opcode;
1162 c.delete_queue.qid = cpu_to_le16(id);
1164 return nvme_submit_sync_cmd(dev->admin_q, &c, NULL, 0);
1167 static int adapter_alloc_cq(struct nvme_dev *dev, u16 qid,
1168 struct nvme_queue *nvmeq)
1170 struct nvme_command c;
1171 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_CQ_IRQ_ENABLED;
1174 * Note: we (ab)use the fact the the prp fields survive if no data
1175 * is attached to the request.
1177 memset(&c, 0, sizeof(c));
1178 c.create_cq.opcode = nvme_admin_create_cq;
1179 c.create_cq.prp1 = cpu_to_le64(nvmeq->cq_dma_addr);
1180 c.create_cq.cqid = cpu_to_le16(qid);
1181 c.create_cq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
1182 c.create_cq.cq_flags = cpu_to_le16(flags);
1183 c.create_cq.irq_vector = cpu_to_le16(nvmeq->cq_vector);
1185 return nvme_submit_sync_cmd(dev->admin_q, &c, NULL, 0);
1188 static int adapter_alloc_sq(struct nvme_dev *dev, u16 qid,
1189 struct nvme_queue *nvmeq)
1191 struct nvme_command c;
1192 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_SQ_PRIO_MEDIUM;
1195 * Note: we (ab)use the fact the the prp fields survive if no data
1196 * is attached to the request.
1198 memset(&c, 0, sizeof(c));
1199 c.create_sq.opcode = nvme_admin_create_sq;
1200 c.create_sq.prp1 = cpu_to_le64(nvmeq->sq_dma_addr);
1201 c.create_sq.sqid = cpu_to_le16(qid);
1202 c.create_sq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
1203 c.create_sq.sq_flags = cpu_to_le16(flags);
1204 c.create_sq.cqid = cpu_to_le16(qid);
1206 return nvme_submit_sync_cmd(dev->admin_q, &c, NULL, 0);
1209 static int adapter_delete_cq(struct nvme_dev *dev, u16 cqid)
1211 return adapter_delete_queue(dev, nvme_admin_delete_cq, cqid);
1214 static int adapter_delete_sq(struct nvme_dev *dev, u16 sqid)
1216 return adapter_delete_queue(dev, nvme_admin_delete_sq, sqid);
1219 int nvme_identify_ctrl(struct nvme_dev *dev, struct nvme_id_ctrl **id)
1221 struct nvme_command c = { };
1224 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1225 c.identify.opcode = nvme_admin_identify;
1226 c.identify.cns = cpu_to_le32(1);
1228 *id = kmalloc(sizeof(struct nvme_id_ctrl), GFP_KERNEL);
1232 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
1233 sizeof(struct nvme_id_ctrl));
1239 int nvme_identify_ns(struct nvme_dev *dev, unsigned nsid,
1240 struct nvme_id_ns **id)
1242 struct nvme_command c = { };
1245 /* gcc-4.4.4 (at least) has issues with initializers and anon unions */
1246 c.identify.opcode = nvme_admin_identify,
1247 c.identify.nsid = cpu_to_le32(nsid),
1249 *id = kmalloc(sizeof(struct nvme_id_ns), GFP_KERNEL);
1253 error = nvme_submit_sync_cmd(dev->admin_q, &c, *id,
1254 sizeof(struct nvme_id_ns));
1260 int nvme_get_features(struct nvme_dev *dev, unsigned fid, unsigned nsid,
1261 dma_addr_t dma_addr, u32 *result)
1263 struct nvme_command c;
1265 memset(&c, 0, sizeof(c));
1266 c.features.opcode = nvme_admin_get_features;
1267 c.features.nsid = cpu_to_le32(nsid);
1268 c.features.prp1 = cpu_to_le64(dma_addr);
1269 c.features.fid = cpu_to_le32(fid);
1271 return __nvme_submit_sync_cmd(dev->admin_q, &c, NULL, NULL, 0,
1275 int nvme_set_features(struct nvme_dev *dev, unsigned fid, unsigned dword11,
1276 dma_addr_t dma_addr, u32 *result)
1278 struct nvme_command c;
1280 memset(&c, 0, sizeof(c));
1281 c.features.opcode = nvme_admin_set_features;
1282 c.features.prp1 = cpu_to_le64(dma_addr);
1283 c.features.fid = cpu_to_le32(fid);
1284 c.features.dword11 = cpu_to_le32(dword11);
1286 return __nvme_submit_sync_cmd(dev->admin_q, &c, NULL, NULL, 0,
1290 int nvme_get_log_page(struct nvme_dev *dev, struct nvme_smart_log **log)
1292 struct nvme_command c = { };
1295 c.common.opcode = nvme_admin_get_log_page,
1296 c.common.nsid = cpu_to_le32(0xFFFFFFFF),
1297 c.common.cdw10[0] = cpu_to_le32(
1298 (((sizeof(struct nvme_smart_log) / 4) - 1) << 16) |
1301 *log = kmalloc(sizeof(struct nvme_smart_log), GFP_KERNEL);
1305 error = nvme_submit_sync_cmd(dev->admin_q, &c, *log,
1306 sizeof(struct nvme_smart_log));
1313 * nvme_abort_req - Attempt aborting a request
1315 * Schedule controller reset if the command was already aborted once before and
1316 * still hasn't been returned to the driver, or if this is the admin queue.
1318 static void nvme_abort_req(struct request *req)
1320 struct nvme_cmd_info *cmd_rq = blk_mq_rq_to_pdu(req);
1321 struct nvme_queue *nvmeq = cmd_rq->nvmeq;
1322 struct nvme_dev *dev = nvmeq->dev;
1323 struct request *abort_req;
1324 struct nvme_cmd_info *abort_cmd;
1325 struct nvme_command cmd;
1327 if (!nvmeq->qid || cmd_rq->aborted) {
1328 spin_lock(&dev_list_lock);
1329 if (!__nvme_reset(dev)) {
1331 "I/O %d QID %d timeout, reset controller\n",
1332 req->tag, nvmeq->qid);
1334 spin_unlock(&dev_list_lock);
1338 if (!dev->abort_limit)
1341 abort_req = blk_mq_alloc_request(dev->admin_q, WRITE,
1343 if (IS_ERR(abort_req))
1346 abort_cmd = blk_mq_rq_to_pdu(abort_req);
1347 nvme_set_info(abort_cmd, abort_req, abort_completion);
1349 memset(&cmd, 0, sizeof(cmd));
1350 cmd.abort.opcode = nvme_admin_abort_cmd;
1351 cmd.abort.cid = req->tag;
1352 cmd.abort.sqid = cpu_to_le16(nvmeq->qid);
1353 cmd.abort.command_id = abort_req->tag;
1356 cmd_rq->aborted = 1;
1358 dev_warn(nvmeq->q_dmadev, "Aborting I/O %d QID %d\n", req->tag,
1360 nvme_submit_cmd(dev->queues[0], &cmd);
1363 static void nvme_cancel_queue_ios(struct request *req, void *data, bool reserved)
1365 struct nvme_queue *nvmeq = data;
1367 nvme_completion_fn fn;
1368 struct nvme_cmd_info *cmd;
1369 struct nvme_completion cqe;
1371 if (!blk_mq_request_started(req))
1374 cmd = blk_mq_rq_to_pdu(req);
1376 if (cmd->ctx == CMD_CTX_CANCELLED)
1379 if (blk_queue_dying(req->q))
1380 cqe.status = cpu_to_le16((NVME_SC_ABORT_REQ | NVME_SC_DNR) << 1);
1382 cqe.status = cpu_to_le16(NVME_SC_ABORT_REQ << 1);
1385 dev_warn(nvmeq->q_dmadev, "Cancelling I/O %d QID %d\n",
1386 req->tag, nvmeq->qid);
1387 ctx = cancel_cmd_info(cmd, &fn);
1388 fn(nvmeq, ctx, &cqe);
1391 static enum blk_eh_timer_return nvme_timeout(struct request *req, bool reserved)
1393 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
1394 struct nvme_queue *nvmeq = cmd->nvmeq;
1396 dev_warn(nvmeq->q_dmadev, "Timeout I/O %d QID %d\n", req->tag,
1398 spin_lock_irq(&nvmeq->q_lock);
1399 nvme_abort_req(req);
1400 spin_unlock_irq(&nvmeq->q_lock);
1403 * The aborted req will be completed on receiving the abort req.
1404 * We enable the timer again. If hit twice, it'll cause a device reset,
1405 * as the device then is in a faulty state.
1407 return BLK_EH_RESET_TIMER;
1410 static void nvme_free_queue(struct nvme_queue *nvmeq)
1412 dma_free_coherent(nvmeq->q_dmadev, CQ_SIZE(nvmeq->q_depth),
1413 (void *)nvmeq->cqes, nvmeq->cq_dma_addr);
1415 dma_free_coherent(nvmeq->q_dmadev, SQ_SIZE(nvmeq->q_depth),
1416 nvmeq->sq_cmds, nvmeq->sq_dma_addr);
1420 static void nvme_free_queues(struct nvme_dev *dev, int lowest)
1424 for (i = dev->queue_count - 1; i >= lowest; i--) {
1425 struct nvme_queue *nvmeq = dev->queues[i];
1427 dev->queues[i] = NULL;
1428 nvme_free_queue(nvmeq);
1433 * nvme_suspend_queue - put queue into suspended state
1434 * @nvmeq - queue to suspend
1436 static int nvme_suspend_queue(struct nvme_queue *nvmeq)
1440 spin_lock_irq(&nvmeq->q_lock);
1441 if (nvmeq->cq_vector == -1) {
1442 spin_unlock_irq(&nvmeq->q_lock);
1445 vector = nvmeq->dev->entry[nvmeq->cq_vector].vector;
1446 nvmeq->dev->online_queues--;
1447 nvmeq->cq_vector = -1;
1448 spin_unlock_irq(&nvmeq->q_lock);
1450 if (!nvmeq->qid && nvmeq->dev->admin_q)
1451 blk_mq_freeze_queue_start(nvmeq->dev->admin_q);
1453 irq_set_affinity_hint(vector, NULL);
1454 free_irq(vector, nvmeq);
1459 static void nvme_clear_queue(struct nvme_queue *nvmeq)
1461 spin_lock_irq(&nvmeq->q_lock);
1462 if (nvmeq->tags && *nvmeq->tags)
1463 blk_mq_all_tag_busy_iter(*nvmeq->tags, nvme_cancel_queue_ios, nvmeq);
1464 spin_unlock_irq(&nvmeq->q_lock);
1467 static void nvme_disable_queue(struct nvme_dev *dev, int qid)
1469 struct nvme_queue *nvmeq = dev->queues[qid];
1473 if (nvme_suspend_queue(nvmeq))
1476 /* Don't tell the adapter to delete the admin queue.
1477 * Don't tell a removed adapter to delete IO queues. */
1478 if (qid && readl(&dev->bar->csts) != -1) {
1479 adapter_delete_sq(dev, qid);
1480 adapter_delete_cq(dev, qid);
1483 spin_lock_irq(&nvmeq->q_lock);
1484 nvme_process_cq(nvmeq);
1485 spin_unlock_irq(&nvmeq->q_lock);
1488 static int nvme_cmb_qdepth(struct nvme_dev *dev, int nr_io_queues,
1491 int q_depth = dev->q_depth;
1492 unsigned q_size_aligned = roundup(q_depth * entry_size, dev->page_size);
1494 if (q_size_aligned * nr_io_queues > dev->cmb_size) {
1495 u64 mem_per_q = div_u64(dev->cmb_size, nr_io_queues);
1496 mem_per_q = round_down(mem_per_q, dev->page_size);
1497 q_depth = div_u64(mem_per_q, entry_size);
1500 * Ensure the reduced q_depth is above some threshold where it
1501 * would be better to map queues in system memory with the
1511 static int nvme_alloc_sq_cmds(struct nvme_dev *dev, struct nvme_queue *nvmeq,
1514 if (qid && dev->cmb && use_cmb_sqes && NVME_CMB_SQS(dev->cmbsz)) {
1515 unsigned offset = (qid - 1) *
1516 roundup(SQ_SIZE(depth), dev->page_size);
1517 nvmeq->sq_dma_addr = dev->cmb_dma_addr + offset;
1518 nvmeq->sq_cmds_io = dev->cmb + offset;
1520 nvmeq->sq_cmds = dma_alloc_coherent(dev->dev, SQ_SIZE(depth),
1521 &nvmeq->sq_dma_addr, GFP_KERNEL);
1522 if (!nvmeq->sq_cmds)
1529 static struct nvme_queue *nvme_alloc_queue(struct nvme_dev *dev, int qid,
1532 struct nvme_queue *nvmeq = kzalloc(sizeof(*nvmeq), GFP_KERNEL);
1536 nvmeq->cqes = dma_zalloc_coherent(dev->dev, CQ_SIZE(depth),
1537 &nvmeq->cq_dma_addr, GFP_KERNEL);
1541 if (nvme_alloc_sq_cmds(dev, nvmeq, qid, depth))
1544 nvmeq->q_dmadev = dev->dev;
1546 snprintf(nvmeq->irqname, sizeof(nvmeq->irqname), "nvme%dq%d",
1547 dev->instance, qid);
1548 spin_lock_init(&nvmeq->q_lock);
1550 nvmeq->cq_phase = 1;
1551 nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
1552 nvmeq->q_depth = depth;
1554 nvmeq->cq_vector = -1;
1555 dev->queues[qid] = nvmeq;
1557 /* make sure queue descriptor is set before queue count, for kthread */
1564 dma_free_coherent(dev->dev, CQ_SIZE(depth), (void *)nvmeq->cqes,
1565 nvmeq->cq_dma_addr);
1571 static int queue_request_irq(struct nvme_dev *dev, struct nvme_queue *nvmeq,
1574 if (use_threaded_interrupts)
1575 return request_threaded_irq(dev->entry[nvmeq->cq_vector].vector,
1576 nvme_irq_check, nvme_irq, IRQF_SHARED,
1578 return request_irq(dev->entry[nvmeq->cq_vector].vector, nvme_irq,
1579 IRQF_SHARED, name, nvmeq);
1582 static void nvme_init_queue(struct nvme_queue *nvmeq, u16 qid)
1584 struct nvme_dev *dev = nvmeq->dev;
1586 spin_lock_irq(&nvmeq->q_lock);
1589 nvmeq->cq_phase = 1;
1590 nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
1591 memset((void *)nvmeq->cqes, 0, CQ_SIZE(nvmeq->q_depth));
1592 dev->online_queues++;
1593 spin_unlock_irq(&nvmeq->q_lock);
1596 static int nvme_create_queue(struct nvme_queue *nvmeq, int qid)
1598 struct nvme_dev *dev = nvmeq->dev;
1601 nvmeq->cq_vector = qid - 1;
1602 result = adapter_alloc_cq(dev, qid, nvmeq);
1606 result = adapter_alloc_sq(dev, qid, nvmeq);
1610 result = queue_request_irq(dev, nvmeq, nvmeq->irqname);
1614 nvme_init_queue(nvmeq, qid);
1618 adapter_delete_sq(dev, qid);
1620 adapter_delete_cq(dev, qid);
1624 static int nvme_wait_ready(struct nvme_dev *dev, u64 cap, bool enabled)
1626 unsigned long timeout;
1627 u32 bit = enabled ? NVME_CSTS_RDY : 0;
1629 timeout = ((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
1631 while ((readl(&dev->bar->csts) & NVME_CSTS_RDY) != bit) {
1633 if (fatal_signal_pending(current))
1635 if (time_after(jiffies, timeout)) {
1637 "Device not ready; aborting %s\n", enabled ?
1638 "initialisation" : "reset");
1647 * If the device has been passed off to us in an enabled state, just clear
1648 * the enabled bit. The spec says we should set the 'shutdown notification
1649 * bits', but doing so may cause the device to complete commands to the
1650 * admin queue ... and we don't know what memory that might be pointing at!
1652 static int nvme_disable_ctrl(struct nvme_dev *dev, u64 cap)
1654 dev->ctrl_config &= ~NVME_CC_SHN_MASK;
1655 dev->ctrl_config &= ~NVME_CC_ENABLE;
1656 writel(dev->ctrl_config, &dev->bar->cc);
1658 return nvme_wait_ready(dev, cap, false);
1661 static int nvme_enable_ctrl(struct nvme_dev *dev, u64 cap)
1663 dev->ctrl_config &= ~NVME_CC_SHN_MASK;
1664 dev->ctrl_config |= NVME_CC_ENABLE;
1665 writel(dev->ctrl_config, &dev->bar->cc);
1667 return nvme_wait_ready(dev, cap, true);
1670 static int nvme_shutdown_ctrl(struct nvme_dev *dev)
1672 unsigned long timeout;
1674 dev->ctrl_config &= ~NVME_CC_SHN_MASK;
1675 dev->ctrl_config |= NVME_CC_SHN_NORMAL;
1677 writel(dev->ctrl_config, &dev->bar->cc);
1679 timeout = SHUTDOWN_TIMEOUT + jiffies;
1680 while ((readl(&dev->bar->csts) & NVME_CSTS_SHST_MASK) !=
1681 NVME_CSTS_SHST_CMPLT) {
1683 if (fatal_signal_pending(current))
1685 if (time_after(jiffies, timeout)) {
1687 "Device shutdown incomplete; abort shutdown\n");
1695 static struct blk_mq_ops nvme_mq_admin_ops = {
1696 .queue_rq = nvme_queue_rq,
1697 .map_queue = blk_mq_map_queue,
1698 .init_hctx = nvme_admin_init_hctx,
1699 .exit_hctx = nvme_admin_exit_hctx,
1700 .init_request = nvme_admin_init_request,
1701 .timeout = nvme_timeout,
1704 static struct blk_mq_ops nvme_mq_ops = {
1705 .queue_rq = nvme_queue_rq,
1706 .map_queue = blk_mq_map_queue,
1707 .init_hctx = nvme_init_hctx,
1708 .init_request = nvme_init_request,
1709 .timeout = nvme_timeout,
1713 static void nvme_dev_remove_admin(struct nvme_dev *dev)
1715 if (dev->admin_q && !blk_queue_dying(dev->admin_q)) {
1716 blk_cleanup_queue(dev->admin_q);
1717 blk_mq_free_tag_set(&dev->admin_tagset);
1721 static int nvme_alloc_admin_tags(struct nvme_dev *dev)
1723 if (!dev->admin_q) {
1724 dev->admin_tagset.ops = &nvme_mq_admin_ops;
1725 dev->admin_tagset.nr_hw_queues = 1;
1726 dev->admin_tagset.queue_depth = NVME_AQ_DEPTH - 1;
1727 dev->admin_tagset.reserved_tags = 1;
1728 dev->admin_tagset.timeout = ADMIN_TIMEOUT;
1729 dev->admin_tagset.numa_node = dev_to_node(dev->dev);
1730 dev->admin_tagset.cmd_size = nvme_cmd_size(dev);
1731 dev->admin_tagset.driver_data = dev;
1733 if (blk_mq_alloc_tag_set(&dev->admin_tagset))
1736 dev->admin_q = blk_mq_init_queue(&dev->admin_tagset);
1737 if (IS_ERR(dev->admin_q)) {
1738 blk_mq_free_tag_set(&dev->admin_tagset);
1741 if (!blk_get_queue(dev->admin_q)) {
1742 nvme_dev_remove_admin(dev);
1743 dev->admin_q = NULL;
1747 blk_mq_unfreeze_queue(dev->admin_q);
1752 static int nvme_configure_admin_queue(struct nvme_dev *dev)
1756 u64 cap = lo_hi_readq(&dev->bar->cap);
1757 struct nvme_queue *nvmeq;
1759 * default to a 4K page size, with the intention to update this
1760 * path in the future to accomodate architectures with differing
1761 * kernel and IO page sizes.
1763 unsigned page_shift = 12;
1764 unsigned dev_page_min = NVME_CAP_MPSMIN(cap) + 12;
1766 if (page_shift < dev_page_min) {
1768 "Minimum device page size (%u) too large for "
1769 "host (%u)\n", 1 << dev_page_min,
1774 dev->subsystem = readl(&dev->bar->vs) >= NVME_VS(1, 1) ?
1775 NVME_CAP_NSSRC(cap) : 0;
1777 if (dev->subsystem && (readl(&dev->bar->csts) & NVME_CSTS_NSSRO))
1778 writel(NVME_CSTS_NSSRO, &dev->bar->csts);
1780 result = nvme_disable_ctrl(dev, cap);
1784 nvmeq = dev->queues[0];
1786 nvmeq = nvme_alloc_queue(dev, 0, NVME_AQ_DEPTH);
1791 aqa = nvmeq->q_depth - 1;
1794 dev->page_size = 1 << page_shift;
1796 dev->ctrl_config = NVME_CC_CSS_NVM;
1797 dev->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT;
1798 dev->ctrl_config |= NVME_CC_ARB_RR | NVME_CC_SHN_NONE;
1799 dev->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
1801 writel(aqa, &dev->bar->aqa);
1802 lo_hi_writeq(nvmeq->sq_dma_addr, &dev->bar->asq);
1803 lo_hi_writeq(nvmeq->cq_dma_addr, &dev->bar->acq);
1805 result = nvme_enable_ctrl(dev, cap);
1809 nvmeq->cq_vector = 0;
1810 result = queue_request_irq(dev, nvmeq, nvmeq->irqname);
1812 nvmeq->cq_vector = -1;
1819 nvme_free_queues(dev, 0);
1823 static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
1825 struct nvme_dev *dev = ns->dev;
1826 struct nvme_user_io io;
1827 struct nvme_command c;
1828 unsigned length, meta_len;
1830 dma_addr_t meta_dma = 0;
1832 void __user *metadata;
1834 if (copy_from_user(&io, uio, sizeof(io)))
1837 switch (io.opcode) {
1838 case nvme_cmd_write:
1840 case nvme_cmd_compare:
1846 length = (io.nblocks + 1) << ns->lba_shift;
1847 meta_len = (io.nblocks + 1) * ns->ms;
1848 metadata = (void __user *)(uintptr_t)io.metadata;
1849 write = io.opcode & 1;
1856 if (((io.metadata & 3) || !io.metadata) && !ns->ext)
1859 meta = dma_alloc_coherent(dev->dev, meta_len,
1860 &meta_dma, GFP_KERNEL);
1867 if (copy_from_user(meta, metadata, meta_len)) {
1874 memset(&c, 0, sizeof(c));
1875 c.rw.opcode = io.opcode;
1876 c.rw.flags = io.flags;
1877 c.rw.nsid = cpu_to_le32(ns->ns_id);
1878 c.rw.slba = cpu_to_le64(io.slba);
1879 c.rw.length = cpu_to_le16(io.nblocks);
1880 c.rw.control = cpu_to_le16(io.control);
1881 c.rw.dsmgmt = cpu_to_le32(io.dsmgmt);
1882 c.rw.reftag = cpu_to_le32(io.reftag);
1883 c.rw.apptag = cpu_to_le16(io.apptag);
1884 c.rw.appmask = cpu_to_le16(io.appmask);
1885 c.rw.metadata = cpu_to_le64(meta_dma);
1887 status = __nvme_submit_sync_cmd(ns->queue, &c, NULL,
1888 (void __user *)(uintptr_t)io.addr, length, NULL, 0);
1891 if (status == NVME_SC_SUCCESS && !write) {
1892 if (copy_to_user(metadata, meta, meta_len))
1895 dma_free_coherent(dev->dev, meta_len, meta, meta_dma);
1900 static int nvme_user_cmd(struct nvme_dev *dev, struct nvme_ns *ns,
1901 struct nvme_passthru_cmd __user *ucmd)
1903 struct nvme_passthru_cmd cmd;
1904 struct nvme_command c;
1905 unsigned timeout = 0;
1908 if (!capable(CAP_SYS_ADMIN))
1910 if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
1913 memset(&c, 0, sizeof(c));
1914 c.common.opcode = cmd.opcode;
1915 c.common.flags = cmd.flags;
1916 c.common.nsid = cpu_to_le32(cmd.nsid);
1917 c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
1918 c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
1919 c.common.cdw10[0] = cpu_to_le32(cmd.cdw10);
1920 c.common.cdw10[1] = cpu_to_le32(cmd.cdw11);
1921 c.common.cdw10[2] = cpu_to_le32(cmd.cdw12);
1922 c.common.cdw10[3] = cpu_to_le32(cmd.cdw13);
1923 c.common.cdw10[4] = cpu_to_le32(cmd.cdw14);
1924 c.common.cdw10[5] = cpu_to_le32(cmd.cdw15);
1927 timeout = msecs_to_jiffies(cmd.timeout_ms);
1929 status = __nvme_submit_sync_cmd(ns ? ns->queue : dev->admin_q, &c,
1930 NULL, (void __user *)(uintptr_t)cmd.addr, cmd.data_len,
1931 &cmd.result, timeout);
1933 if (put_user(cmd.result, &ucmd->result))
1940 static int nvme_subsys_reset(struct nvme_dev *dev)
1942 if (!dev->subsystem)
1945 writel(0x4E564D65, &dev->bar->nssr); /* "NVMe" */
1949 static int nvme_ioctl(struct block_device *bdev, fmode_t mode, unsigned int cmd,
1952 struct nvme_ns *ns = bdev->bd_disk->private_data;
1956 force_successful_syscall_return();
1958 case NVME_IOCTL_ADMIN_CMD:
1959 return nvme_user_cmd(ns->dev, NULL, (void __user *)arg);
1960 case NVME_IOCTL_IO_CMD:
1961 return nvme_user_cmd(ns->dev, ns, (void __user *)arg);
1962 case NVME_IOCTL_SUBMIT_IO:
1963 return nvme_submit_io(ns, (void __user *)arg);
1964 case SG_GET_VERSION_NUM:
1965 return nvme_sg_get_version_num((void __user *)arg);
1967 return nvme_sg_io(ns, (void __user *)arg);
1973 #ifdef CONFIG_COMPAT
1974 static int nvme_compat_ioctl(struct block_device *bdev, fmode_t mode,
1975 unsigned int cmd, unsigned long arg)
1979 return -ENOIOCTLCMD;
1981 return nvme_ioctl(bdev, mode, cmd, arg);
1984 #define nvme_compat_ioctl NULL
1987 static void nvme_free_dev(struct kref *kref);
1988 static void nvme_free_ns(struct kref *kref)
1990 struct nvme_ns *ns = container_of(kref, struct nvme_ns, kref);
1992 if (ns->type == NVME_NS_LIGHTNVM)
1993 nvme_nvm_unregister(ns->queue, ns->disk->disk_name);
1995 spin_lock(&dev_list_lock);
1996 ns->disk->private_data = NULL;
1997 spin_unlock(&dev_list_lock);
1999 kref_put(&ns->dev->kref, nvme_free_dev);
2004 static int nvme_open(struct block_device *bdev, fmode_t mode)
2009 spin_lock(&dev_list_lock);
2010 ns = bdev->bd_disk->private_data;
2013 else if (!kref_get_unless_zero(&ns->kref))
2015 spin_unlock(&dev_list_lock);
2020 static void nvme_release(struct gendisk *disk, fmode_t mode)
2022 struct nvme_ns *ns = disk->private_data;
2023 kref_put(&ns->kref, nvme_free_ns);
2026 static int nvme_getgeo(struct block_device *bd, struct hd_geometry *geo)
2028 /* some standard values */
2029 geo->heads = 1 << 6;
2030 geo->sectors = 1 << 5;
2031 geo->cylinders = get_capacity(bd->bd_disk) >> 11;
2035 static void nvme_config_discard(struct nvme_ns *ns)
2037 u32 logical_block_size = queue_logical_block_size(ns->queue);
2038 ns->queue->limits.discard_zeroes_data = 0;
2039 ns->queue->limits.discard_alignment = logical_block_size;
2040 ns->queue->limits.discard_granularity = logical_block_size;
2041 blk_queue_max_discard_sectors(ns->queue, 0xffffffff);
2042 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, ns->queue);
2045 static int nvme_revalidate_disk(struct gendisk *disk)
2047 struct nvme_ns *ns = disk->private_data;
2048 struct nvme_dev *dev = ns->dev;
2049 struct nvme_id_ns *id;
2054 if (nvme_identify_ns(dev, ns->ns_id, &id)) {
2055 dev_warn(dev->dev, "%s: Identify failure nvme%dn%d\n", __func__,
2056 dev->instance, ns->ns_id);
2059 if (id->ncap == 0) {
2064 if (nvme_nvm_ns_supported(ns, id) && ns->type != NVME_NS_LIGHTNVM) {
2065 if (nvme_nvm_register(ns->queue, disk->disk_name)) {
2067 "%s: LightNVM init failure\n", __func__);
2071 ns->type = NVME_NS_LIGHTNVM;
2075 lbaf = id->flbas & NVME_NS_FLBAS_LBA_MASK;
2076 ns->lba_shift = id->lbaf[lbaf].ds;
2077 ns->ms = le16_to_cpu(id->lbaf[lbaf].ms);
2078 ns->ext = ns->ms && (id->flbas & NVME_NS_FLBAS_META_EXT);
2081 * If identify namespace failed, use default 512 byte block size so
2082 * block layer can use before failing read/write for 0 capacity.
2084 if (ns->lba_shift == 0)
2086 bs = 1 << ns->lba_shift;
2088 /* XXX: PI implementation requires metadata equal t10 pi tuple size */
2089 pi_type = ns->ms == sizeof(struct t10_pi_tuple) ?
2090 id->dps & NVME_NS_DPS_PI_MASK : 0;
2092 blk_mq_freeze_queue(disk->queue);
2093 if (blk_get_integrity(disk) && (ns->pi_type != pi_type ||
2095 bs != queue_logical_block_size(disk->queue) ||
2096 (ns->ms && ns->ext)))
2097 blk_integrity_unregister(disk);
2099 ns->pi_type = pi_type;
2100 blk_queue_logical_block_size(ns->queue, bs);
2102 if (ns->ms && !ns->ext)
2103 nvme_init_integrity(ns);
2105 if ((ns->ms && !(ns->ms == 8 && ns->pi_type) &&
2106 !blk_get_integrity(disk)) ||
2107 ns->type == NVME_NS_LIGHTNVM)
2108 set_capacity(disk, 0);
2110 set_capacity(disk, le64_to_cpup(&id->nsze) << (ns->lba_shift - 9));
2112 if (dev->oncs & NVME_CTRL_ONCS_DSM)
2113 nvme_config_discard(ns);
2114 blk_mq_unfreeze_queue(disk->queue);
2120 static char nvme_pr_type(enum pr_type type)
2123 case PR_WRITE_EXCLUSIVE:
2125 case PR_EXCLUSIVE_ACCESS:
2127 case PR_WRITE_EXCLUSIVE_REG_ONLY:
2129 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
2131 case PR_WRITE_EXCLUSIVE_ALL_REGS:
2133 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
2140 static int nvme_pr_command(struct block_device *bdev, u32 cdw10,
2141 u64 key, u64 sa_key, u8 op)
2143 struct nvme_ns *ns = bdev->bd_disk->private_data;
2144 struct nvme_command c;
2145 u8 data[16] = { 0, };
2147 put_unaligned_le64(key, &data[0]);
2148 put_unaligned_le64(sa_key, &data[8]);
2150 memset(&c, 0, sizeof(c));
2151 c.common.opcode = op;
2152 c.common.nsid = cpu_to_le32(ns->ns_id);
2153 c.common.cdw10[0] = cpu_to_le32(cdw10);
2155 return nvme_submit_sync_cmd(ns->queue, &c, data, 16);
2158 static int nvme_pr_register(struct block_device *bdev, u64 old,
2159 u64 new, unsigned flags)
2163 if (flags & ~PR_FL_IGNORE_KEY)
2166 cdw10 = old ? 2 : 0;
2167 cdw10 |= (flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0;
2168 cdw10 |= (1 << 30) | (1 << 31); /* PTPL=1 */
2169 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_register);
2172 static int nvme_pr_reserve(struct block_device *bdev, u64 key,
2173 enum pr_type type, unsigned flags)
2177 if (flags & ~PR_FL_IGNORE_KEY)
2180 cdw10 = nvme_pr_type(type) << 8;
2181 cdw10 |= ((flags & PR_FL_IGNORE_KEY) ? 1 << 3 : 0);
2182 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_acquire);
2185 static int nvme_pr_preempt(struct block_device *bdev, u64 old, u64 new,
2186 enum pr_type type, bool abort)
2188 u32 cdw10 = nvme_pr_type(type) << 8 | abort ? 2 : 1;
2189 return nvme_pr_command(bdev, cdw10, old, new, nvme_cmd_resv_acquire);
2192 static int nvme_pr_clear(struct block_device *bdev, u64 key)
2194 u32 cdw10 = 1 | (key ? 1 << 3 : 0);
2195 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_register);
2198 static int nvme_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
2200 u32 cdw10 = nvme_pr_type(type) << 8 | key ? 1 << 3 : 0;
2201 return nvme_pr_command(bdev, cdw10, key, 0, nvme_cmd_resv_release);
2204 static const struct pr_ops nvme_pr_ops = {
2205 .pr_register = nvme_pr_register,
2206 .pr_reserve = nvme_pr_reserve,
2207 .pr_release = nvme_pr_release,
2208 .pr_preempt = nvme_pr_preempt,
2209 .pr_clear = nvme_pr_clear,
2212 static const struct block_device_operations nvme_fops = {
2213 .owner = THIS_MODULE,
2214 .ioctl = nvme_ioctl,
2215 .compat_ioctl = nvme_compat_ioctl,
2217 .release = nvme_release,
2218 .getgeo = nvme_getgeo,
2219 .revalidate_disk= nvme_revalidate_disk,
2220 .pr_ops = &nvme_pr_ops,
2223 static int nvme_kthread(void *data)
2225 struct nvme_dev *dev, *next;
2227 while (!kthread_should_stop()) {
2228 set_current_state(TASK_INTERRUPTIBLE);
2229 spin_lock(&dev_list_lock);
2230 list_for_each_entry_safe(dev, next, &dev_list, node) {
2232 u32 csts = readl(&dev->bar->csts);
2234 if ((dev->subsystem && (csts & NVME_CSTS_NSSRO)) ||
2235 csts & NVME_CSTS_CFS) {
2236 if (!__nvme_reset(dev)) {
2238 "Failed status: %x, reset controller\n",
2239 readl(&dev->bar->csts));
2243 for (i = 0; i < dev->queue_count; i++) {
2244 struct nvme_queue *nvmeq = dev->queues[i];
2247 spin_lock_irq(&nvmeq->q_lock);
2248 nvme_process_cq(nvmeq);
2250 while ((i == 0) && (dev->event_limit > 0)) {
2251 if (nvme_submit_async_admin_req(dev))
2255 spin_unlock_irq(&nvmeq->q_lock);
2258 spin_unlock(&dev_list_lock);
2259 schedule_timeout(round_jiffies_relative(HZ));
2264 static void nvme_alloc_ns(struct nvme_dev *dev, unsigned nsid)
2267 struct gendisk *disk;
2268 int node = dev_to_node(dev->dev);
2270 ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
2274 ns->queue = blk_mq_init_queue(&dev->tagset);
2275 if (IS_ERR(ns->queue))
2277 queue_flag_set_unlocked(QUEUE_FLAG_NOMERGES, ns->queue);
2278 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, ns->queue);
2280 ns->queue->queuedata = ns;
2282 disk = alloc_disk_node(0, node);
2284 goto out_free_queue;
2286 kref_init(&ns->kref);
2289 ns->lba_shift = 9; /* set to a default value for 512 until disk is validated */
2290 list_add_tail(&ns->list, &dev->namespaces);
2292 blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
2293 if (dev->max_hw_sectors) {
2294 blk_queue_max_hw_sectors(ns->queue, dev->max_hw_sectors);
2295 blk_queue_max_segments(ns->queue,
2296 (dev->max_hw_sectors / (dev->page_size >> 9)) + 1);
2298 if (dev->stripe_size)
2299 blk_queue_chunk_sectors(ns->queue, dev->stripe_size >> 9);
2300 if (dev->vwc & NVME_CTRL_VWC_PRESENT)
2301 blk_queue_flush(ns->queue, REQ_FLUSH | REQ_FUA);
2302 blk_queue_virt_boundary(ns->queue, dev->page_size - 1);
2304 disk->major = nvme_major;
2305 disk->first_minor = 0;
2306 disk->fops = &nvme_fops;
2307 disk->private_data = ns;
2308 disk->queue = ns->queue;
2309 disk->driverfs_dev = dev->device;
2310 disk->flags = GENHD_FL_EXT_DEVT;
2311 sprintf(disk->disk_name, "nvme%dn%d", dev->instance, nsid);
2314 * Initialize capacity to 0 until we establish the namespace format and
2315 * setup integrity extentions if necessary. The revalidate_disk after
2316 * add_disk allows the driver to register with integrity if the format
2319 set_capacity(disk, 0);
2320 if (nvme_revalidate_disk(ns->disk))
2323 kref_get(&dev->kref);
2324 if (ns->type != NVME_NS_LIGHTNVM) {
2327 struct block_device *bd = bdget_disk(ns->disk, 0);
2330 if (blkdev_get(bd, FMODE_READ, NULL)) {
2334 blkdev_reread_part(bd);
2335 blkdev_put(bd, FMODE_READ);
2341 list_del(&ns->list);
2343 blk_cleanup_queue(ns->queue);
2349 * Create I/O queues. Failing to create an I/O queue is not an issue,
2350 * we can continue with less than the desired amount of queues, and
2351 * even a controller without I/O queues an still be used to issue
2352 * admin commands. This might be useful to upgrade a buggy firmware
2355 static void nvme_create_io_queues(struct nvme_dev *dev)
2359 for (i = dev->queue_count; i <= dev->max_qid; i++)
2360 if (!nvme_alloc_queue(dev, i, dev->q_depth))
2363 for (i = dev->online_queues; i <= dev->queue_count - 1; i++)
2364 if (nvme_create_queue(dev->queues[i], i)) {
2365 nvme_free_queues(dev, i);
2370 static int set_queue_count(struct nvme_dev *dev, int count)
2374 u32 q_count = (count - 1) | ((count - 1) << 16);
2376 status = nvme_set_features(dev, NVME_FEAT_NUM_QUEUES, q_count, 0,
2381 dev_err(dev->dev, "Could not set queue count (%d)\n", status);
2384 return min(result & 0xffff, result >> 16) + 1;
2387 static void __iomem *nvme_map_cmb(struct nvme_dev *dev)
2389 u64 szu, size, offset;
2391 resource_size_t bar_size;
2392 struct pci_dev *pdev = to_pci_dev(dev->dev);
2394 dma_addr_t dma_addr;
2399 dev->cmbsz = readl(&dev->bar->cmbsz);
2400 if (!(NVME_CMB_SZ(dev->cmbsz)))
2403 cmbloc = readl(&dev->bar->cmbloc);
2405 szu = (u64)1 << (12 + 4 * NVME_CMB_SZU(dev->cmbsz));
2406 size = szu * NVME_CMB_SZ(dev->cmbsz);
2407 offset = szu * NVME_CMB_OFST(cmbloc);
2408 bar_size = pci_resource_len(pdev, NVME_CMB_BIR(cmbloc));
2410 if (offset > bar_size)
2414 * Controllers may support a CMB size larger than their BAR,
2415 * for example, due to being behind a bridge. Reduce the CMB to
2416 * the reported size of the BAR
2418 if (size > bar_size - offset)
2419 size = bar_size - offset;
2421 dma_addr = pci_resource_start(pdev, NVME_CMB_BIR(cmbloc)) + offset;
2422 cmb = ioremap_wc(dma_addr, size);
2426 dev->cmb_dma_addr = dma_addr;
2427 dev->cmb_size = size;
2431 static inline void nvme_release_cmb(struct nvme_dev *dev)
2439 static size_t db_bar_size(struct nvme_dev *dev, unsigned nr_io_queues)
2441 return 4096 + ((nr_io_queues + 1) * 8 * dev->db_stride);
2444 static int nvme_setup_io_queues(struct nvme_dev *dev)
2446 struct nvme_queue *adminq = dev->queues[0];
2447 struct pci_dev *pdev = to_pci_dev(dev->dev);
2448 int result, i, vecs, nr_io_queues, size;
2450 nr_io_queues = num_possible_cpus();
2451 result = set_queue_count(dev, nr_io_queues);
2454 if (result < nr_io_queues)
2455 nr_io_queues = result;
2457 if (dev->cmb && NVME_CMB_SQS(dev->cmbsz)) {
2458 result = nvme_cmb_qdepth(dev, nr_io_queues,
2459 sizeof(struct nvme_command));
2461 dev->q_depth = result;
2463 nvme_release_cmb(dev);
2466 size = db_bar_size(dev, nr_io_queues);
2470 dev->bar = ioremap(pci_resource_start(pdev, 0), size);
2473 if (!--nr_io_queues)
2475 size = db_bar_size(dev, nr_io_queues);
2477 dev->dbs = ((void __iomem *)dev->bar) + 4096;
2478 adminq->q_db = dev->dbs;
2481 /* Deregister the admin queue's interrupt */
2482 free_irq(dev->entry[0].vector, adminq);
2485 * If we enable msix early due to not intx, disable it again before
2486 * setting up the full range we need.
2489 pci_disable_msix(pdev);
2491 for (i = 0; i < nr_io_queues; i++)
2492 dev->entry[i].entry = i;
2493 vecs = pci_enable_msix_range(pdev, dev->entry, 1, nr_io_queues);
2495 vecs = pci_enable_msi_range(pdev, 1, min(nr_io_queues, 32));
2499 for (i = 0; i < vecs; i++)
2500 dev->entry[i].vector = i + pdev->irq;
2505 * Should investigate if there's a performance win from allocating
2506 * more queues than interrupt vectors; it might allow the submission
2507 * path to scale better, even if the receive path is limited by the
2508 * number of interrupts.
2510 nr_io_queues = vecs;
2511 dev->max_qid = nr_io_queues;
2513 result = queue_request_irq(dev, adminq, adminq->irqname);
2515 adminq->cq_vector = -1;
2519 /* Free previously allocated queues that are no longer usable */
2520 nvme_free_queues(dev, nr_io_queues + 1);
2521 nvme_create_io_queues(dev);
2526 nvme_free_queues(dev, 1);
2530 static int ns_cmp(void *priv, struct list_head *a, struct list_head *b)
2532 struct nvme_ns *nsa = container_of(a, struct nvme_ns, list);
2533 struct nvme_ns *nsb = container_of(b, struct nvme_ns, list);
2535 return nsa->ns_id - nsb->ns_id;
2538 static struct nvme_ns *nvme_find_ns(struct nvme_dev *dev, unsigned nsid)
2542 list_for_each_entry(ns, &dev->namespaces, list) {
2543 if (ns->ns_id == nsid)
2545 if (ns->ns_id > nsid)
2551 static inline bool nvme_io_incapable(struct nvme_dev *dev)
2553 return (!dev->bar || readl(&dev->bar->csts) & NVME_CSTS_CFS ||
2554 dev->online_queues < 2);
2557 static void nvme_ns_remove(struct nvme_ns *ns)
2559 bool kill = nvme_io_incapable(ns->dev) && !blk_queue_dying(ns->queue);
2562 blk_set_queue_dying(ns->queue);
2563 if (ns->disk->flags & GENHD_FL_UP)
2564 del_gendisk(ns->disk);
2565 if (kill || !blk_queue_dying(ns->queue)) {
2566 blk_mq_abort_requeue_list(ns->queue);
2567 blk_cleanup_queue(ns->queue);
2569 list_del_init(&ns->list);
2570 kref_put(&ns->kref, nvme_free_ns);
2573 static void nvme_scan_namespaces(struct nvme_dev *dev, unsigned nn)
2575 struct nvme_ns *ns, *next;
2578 for (i = 1; i <= nn; i++) {
2579 ns = nvme_find_ns(dev, i);
2581 if (revalidate_disk(ns->disk))
2584 nvme_alloc_ns(dev, i);
2586 list_for_each_entry_safe(ns, next, &dev->namespaces, list) {
2590 list_sort(NULL, &dev->namespaces, ns_cmp);
2593 static void nvme_set_irq_hints(struct nvme_dev *dev)
2595 struct nvme_queue *nvmeq;
2598 for (i = 0; i < dev->online_queues; i++) {
2599 nvmeq = dev->queues[i];
2601 if (!nvmeq->tags || !(*nvmeq->tags))
2604 irq_set_affinity_hint(dev->entry[nvmeq->cq_vector].vector,
2605 blk_mq_tags_cpumask(*nvmeq->tags));
2609 static void nvme_dev_scan(struct work_struct *work)
2611 struct nvme_dev *dev = container_of(work, struct nvme_dev, scan_work);
2612 struct nvme_id_ctrl *ctrl;
2614 if (!dev->tagset.tags)
2616 if (nvme_identify_ctrl(dev, &ctrl))
2618 nvme_scan_namespaces(dev, le32_to_cpup(&ctrl->nn));
2620 nvme_set_irq_hints(dev);
2624 * Return: error value if an error occurred setting up the queues or calling
2625 * Identify Device. 0 if these succeeded, even if adding some of the
2626 * namespaces failed. At the moment, these failures are silent. TBD which
2627 * failures should be reported.
2629 static int nvme_dev_add(struct nvme_dev *dev)
2631 struct pci_dev *pdev = to_pci_dev(dev->dev);
2633 struct nvme_id_ctrl *ctrl;
2634 int shift = NVME_CAP_MPSMIN(lo_hi_readq(&dev->bar->cap)) + 12;
2636 res = nvme_identify_ctrl(dev, &ctrl);
2638 dev_err(dev->dev, "Identify Controller failed (%d)\n", res);
2642 dev->oncs = le16_to_cpup(&ctrl->oncs);
2643 dev->abort_limit = ctrl->acl + 1;
2644 dev->vwc = ctrl->vwc;
2645 memcpy(dev->serial, ctrl->sn, sizeof(ctrl->sn));
2646 memcpy(dev->model, ctrl->mn, sizeof(ctrl->mn));
2647 memcpy(dev->firmware_rev, ctrl->fr, sizeof(ctrl->fr));
2649 dev->max_hw_sectors = 1 << (ctrl->mdts + shift - 9);
2651 dev->max_hw_sectors = UINT_MAX;
2652 if ((pdev->vendor == PCI_VENDOR_ID_INTEL) &&
2653 (pdev->device == 0x0953) && ctrl->vs[3]) {
2654 unsigned int max_hw_sectors;
2656 dev->stripe_size = 1 << (ctrl->vs[3] + shift);
2657 max_hw_sectors = dev->stripe_size >> (shift - 9);
2658 if (dev->max_hw_sectors) {
2659 dev->max_hw_sectors = min(max_hw_sectors,
2660 dev->max_hw_sectors);
2662 dev->max_hw_sectors = max_hw_sectors;
2666 if (!dev->tagset.tags) {
2667 dev->tagset.ops = &nvme_mq_ops;
2668 dev->tagset.nr_hw_queues = dev->online_queues - 1;
2669 dev->tagset.timeout = NVME_IO_TIMEOUT;
2670 dev->tagset.numa_node = dev_to_node(dev->dev);
2671 dev->tagset.queue_depth =
2672 min_t(int, dev->q_depth, BLK_MQ_MAX_DEPTH) - 1;
2673 dev->tagset.cmd_size = nvme_cmd_size(dev);
2674 dev->tagset.flags = BLK_MQ_F_SHOULD_MERGE;
2675 dev->tagset.driver_data = dev;
2677 if (blk_mq_alloc_tag_set(&dev->tagset))
2680 schedule_work(&dev->scan_work);
2684 static int nvme_dev_map(struct nvme_dev *dev)
2687 int bars, result = -ENOMEM;
2688 struct pci_dev *pdev = to_pci_dev(dev->dev);
2690 if (pci_enable_device_mem(pdev))
2693 dev->entry[0].vector = pdev->irq;
2694 pci_set_master(pdev);
2695 bars = pci_select_bars(pdev, IORESOURCE_MEM);
2699 if (pci_request_selected_regions(pdev, bars, "nvme"))
2702 if (dma_set_mask_and_coherent(dev->dev, DMA_BIT_MASK(64)) &&
2703 dma_set_mask_and_coherent(dev->dev, DMA_BIT_MASK(32)))
2706 dev->bar = ioremap(pci_resource_start(pdev, 0), 8192);
2710 if (readl(&dev->bar->csts) == -1) {
2716 * Some devices don't advertse INTx interrupts, pre-enable a single
2717 * MSIX vec for setup. We'll adjust this later.
2720 result = pci_enable_msix(pdev, dev->entry, 1);
2725 cap = lo_hi_readq(&dev->bar->cap);
2726 dev->q_depth = min_t(int, NVME_CAP_MQES(cap) + 1, NVME_Q_DEPTH);
2727 dev->db_stride = 1 << NVME_CAP_STRIDE(cap);
2728 dev->dbs = ((void __iomem *)dev->bar) + 4096;
2729 if (readl(&dev->bar->vs) >= NVME_VS(1, 2))
2730 dev->cmb = nvme_map_cmb(dev);
2738 pci_release_regions(pdev);
2740 pci_disable_device(pdev);
2744 static void nvme_dev_unmap(struct nvme_dev *dev)
2746 struct pci_dev *pdev = to_pci_dev(dev->dev);
2748 if (pdev->msi_enabled)
2749 pci_disable_msi(pdev);
2750 else if (pdev->msix_enabled)
2751 pci_disable_msix(pdev);
2756 pci_release_regions(pdev);
2759 if (pci_is_enabled(pdev))
2760 pci_disable_device(pdev);
2763 struct nvme_delq_ctx {
2764 struct task_struct *waiter;
2765 struct kthread_worker *worker;
2769 static void nvme_wait_dq(struct nvme_delq_ctx *dq, struct nvme_dev *dev)
2771 dq->waiter = current;
2775 set_current_state(TASK_KILLABLE);
2776 if (!atomic_read(&dq->refcount))
2778 if (!schedule_timeout(ADMIN_TIMEOUT) ||
2779 fatal_signal_pending(current)) {
2781 * Disable the controller first since we can't trust it
2782 * at this point, but leave the admin queue enabled
2783 * until all queue deletion requests are flushed.
2784 * FIXME: This may take a while if there are more h/w
2785 * queues than admin tags.
2787 set_current_state(TASK_RUNNING);
2788 nvme_disable_ctrl(dev, lo_hi_readq(&dev->bar->cap));
2789 nvme_clear_queue(dev->queues[0]);
2790 flush_kthread_worker(dq->worker);
2791 nvme_disable_queue(dev, 0);
2795 set_current_state(TASK_RUNNING);
2798 static void nvme_put_dq(struct nvme_delq_ctx *dq)
2800 atomic_dec(&dq->refcount);
2802 wake_up_process(dq->waiter);
2805 static struct nvme_delq_ctx *nvme_get_dq(struct nvme_delq_ctx *dq)
2807 atomic_inc(&dq->refcount);
2811 static void nvme_del_queue_end(struct nvme_queue *nvmeq)
2813 struct nvme_delq_ctx *dq = nvmeq->cmdinfo.ctx;
2816 spin_lock_irq(&nvmeq->q_lock);
2817 nvme_process_cq(nvmeq);
2818 spin_unlock_irq(&nvmeq->q_lock);
2821 static int adapter_async_del_queue(struct nvme_queue *nvmeq, u8 opcode,
2822 kthread_work_func_t fn)
2824 struct nvme_command c;
2826 memset(&c, 0, sizeof(c));
2827 c.delete_queue.opcode = opcode;
2828 c.delete_queue.qid = cpu_to_le16(nvmeq->qid);
2830 init_kthread_work(&nvmeq->cmdinfo.work, fn);
2831 return nvme_submit_admin_async_cmd(nvmeq->dev, &c, &nvmeq->cmdinfo,
2835 static void nvme_del_cq_work_handler(struct kthread_work *work)
2837 struct nvme_queue *nvmeq = container_of(work, struct nvme_queue,
2839 nvme_del_queue_end(nvmeq);
2842 static int nvme_delete_cq(struct nvme_queue *nvmeq)
2844 return adapter_async_del_queue(nvmeq, nvme_admin_delete_cq,
2845 nvme_del_cq_work_handler);
2848 static void nvme_del_sq_work_handler(struct kthread_work *work)
2850 struct nvme_queue *nvmeq = container_of(work, struct nvme_queue,
2852 int status = nvmeq->cmdinfo.status;
2855 status = nvme_delete_cq(nvmeq);
2857 nvme_del_queue_end(nvmeq);
2860 static int nvme_delete_sq(struct nvme_queue *nvmeq)
2862 return adapter_async_del_queue(nvmeq, nvme_admin_delete_sq,
2863 nvme_del_sq_work_handler);
2866 static void nvme_del_queue_start(struct kthread_work *work)
2868 struct nvme_queue *nvmeq = container_of(work, struct nvme_queue,
2870 if (nvme_delete_sq(nvmeq))
2871 nvme_del_queue_end(nvmeq);
2874 static void nvme_disable_io_queues(struct nvme_dev *dev)
2877 DEFINE_KTHREAD_WORKER_ONSTACK(worker);
2878 struct nvme_delq_ctx dq;
2879 struct task_struct *kworker_task = kthread_run(kthread_worker_fn,
2880 &worker, "nvme%d", dev->instance);
2882 if (IS_ERR(kworker_task)) {
2884 "Failed to create queue del task\n");
2885 for (i = dev->queue_count - 1; i > 0; i--)
2886 nvme_disable_queue(dev, i);
2891 atomic_set(&dq.refcount, 0);
2892 dq.worker = &worker;
2893 for (i = dev->queue_count - 1; i > 0; i--) {
2894 struct nvme_queue *nvmeq = dev->queues[i];
2896 if (nvme_suspend_queue(nvmeq))
2898 nvmeq->cmdinfo.ctx = nvme_get_dq(&dq);
2899 nvmeq->cmdinfo.worker = dq.worker;
2900 init_kthread_work(&nvmeq->cmdinfo.work, nvme_del_queue_start);
2901 queue_kthread_work(dq.worker, &nvmeq->cmdinfo.work);
2903 nvme_wait_dq(&dq, dev);
2904 kthread_stop(kworker_task);
2908 * Remove the node from the device list and check
2909 * for whether or not we need to stop the nvme_thread.
2911 static void nvme_dev_list_remove(struct nvme_dev *dev)
2913 struct task_struct *tmp = NULL;
2915 spin_lock(&dev_list_lock);
2916 list_del_init(&dev->node);
2917 if (list_empty(&dev_list) && !IS_ERR_OR_NULL(nvme_thread)) {
2921 spin_unlock(&dev_list_lock);
2927 static void nvme_freeze_queues(struct nvme_dev *dev)
2931 list_for_each_entry(ns, &dev->namespaces, list) {
2932 blk_mq_freeze_queue_start(ns->queue);
2934 spin_lock_irq(ns->queue->queue_lock);
2935 queue_flag_set(QUEUE_FLAG_STOPPED, ns->queue);
2936 spin_unlock_irq(ns->queue->queue_lock);
2938 blk_mq_cancel_requeue_work(ns->queue);
2939 blk_mq_stop_hw_queues(ns->queue);
2943 static void nvme_unfreeze_queues(struct nvme_dev *dev)
2947 list_for_each_entry(ns, &dev->namespaces, list) {
2948 queue_flag_clear_unlocked(QUEUE_FLAG_STOPPED, ns->queue);
2949 blk_mq_unfreeze_queue(ns->queue);
2950 blk_mq_start_stopped_hw_queues(ns->queue, true);
2951 blk_mq_kick_requeue_list(ns->queue);
2955 static void nvme_dev_shutdown(struct nvme_dev *dev)
2960 nvme_dev_list_remove(dev);
2963 nvme_freeze_queues(dev);
2964 csts = readl(&dev->bar->csts);
2966 if (csts & NVME_CSTS_CFS || !(csts & NVME_CSTS_RDY)) {
2967 for (i = dev->queue_count - 1; i >= 0; i--) {
2968 struct nvme_queue *nvmeq = dev->queues[i];
2969 nvme_suspend_queue(nvmeq);
2972 nvme_disable_io_queues(dev);
2973 nvme_shutdown_ctrl(dev);
2974 nvme_disable_queue(dev, 0);
2976 nvme_dev_unmap(dev);
2978 for (i = dev->queue_count - 1; i >= 0; i--)
2979 nvme_clear_queue(dev->queues[i]);
2982 static void nvme_dev_remove(struct nvme_dev *dev)
2984 struct nvme_ns *ns, *next;
2986 list_for_each_entry_safe(ns, next, &dev->namespaces, list)
2990 static int nvme_setup_prp_pools(struct nvme_dev *dev)
2992 dev->prp_page_pool = dma_pool_create("prp list page", dev->dev,
2993 PAGE_SIZE, PAGE_SIZE, 0);
2994 if (!dev->prp_page_pool)
2997 /* Optimisation for I/Os between 4k and 128k */
2998 dev->prp_small_pool = dma_pool_create("prp list 256", dev->dev,
3000 if (!dev->prp_small_pool) {
3001 dma_pool_destroy(dev->prp_page_pool);
3007 static void nvme_release_prp_pools(struct nvme_dev *dev)
3009 dma_pool_destroy(dev->prp_page_pool);
3010 dma_pool_destroy(dev->prp_small_pool);
3013 static DEFINE_IDA(nvme_instance_ida);
3015 static int nvme_set_instance(struct nvme_dev *dev)
3017 int instance, error;
3020 if (!ida_pre_get(&nvme_instance_ida, GFP_KERNEL))
3023 spin_lock(&dev_list_lock);
3024 error = ida_get_new(&nvme_instance_ida, &instance);
3025 spin_unlock(&dev_list_lock);
3026 } while (error == -EAGAIN);
3031 dev->instance = instance;
3035 static void nvme_release_instance(struct nvme_dev *dev)
3037 spin_lock(&dev_list_lock);
3038 ida_remove(&nvme_instance_ida, dev->instance);
3039 spin_unlock(&dev_list_lock);
3042 static void nvme_free_dev(struct kref *kref)
3044 struct nvme_dev *dev = container_of(kref, struct nvme_dev, kref);
3046 put_device(dev->dev);
3047 put_device(dev->device);
3048 nvme_release_instance(dev);
3049 if (dev->tagset.tags)
3050 blk_mq_free_tag_set(&dev->tagset);
3052 blk_put_queue(dev->admin_q);
3058 static int nvme_dev_open(struct inode *inode, struct file *f)
3060 struct nvme_dev *dev;
3061 int instance = iminor(inode);
3064 spin_lock(&dev_list_lock);
3065 list_for_each_entry(dev, &dev_list, node) {
3066 if (dev->instance == instance) {
3067 if (!dev->admin_q) {
3071 if (!kref_get_unless_zero(&dev->kref))
3073 f->private_data = dev;
3078 spin_unlock(&dev_list_lock);
3083 static int nvme_dev_release(struct inode *inode, struct file *f)
3085 struct nvme_dev *dev = f->private_data;
3086 kref_put(&dev->kref, nvme_free_dev);
3090 static long nvme_dev_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
3092 struct nvme_dev *dev = f->private_data;
3096 case NVME_IOCTL_ADMIN_CMD:
3097 return nvme_user_cmd(dev, NULL, (void __user *)arg);
3098 case NVME_IOCTL_IO_CMD:
3099 if (list_empty(&dev->namespaces))
3101 ns = list_first_entry(&dev->namespaces, struct nvme_ns, list);
3102 return nvme_user_cmd(dev, ns, (void __user *)arg);
3103 case NVME_IOCTL_RESET:
3104 dev_warn(dev->dev, "resetting controller\n");
3105 return nvme_reset(dev);
3106 case NVME_IOCTL_SUBSYS_RESET:
3107 return nvme_subsys_reset(dev);
3113 static const struct file_operations nvme_dev_fops = {
3114 .owner = THIS_MODULE,
3115 .open = nvme_dev_open,
3116 .release = nvme_dev_release,
3117 .unlocked_ioctl = nvme_dev_ioctl,
3118 .compat_ioctl = nvme_dev_ioctl,
3121 static void nvme_probe_work(struct work_struct *work)
3123 struct nvme_dev *dev = container_of(work, struct nvme_dev, probe_work);
3124 bool start_thread = false;
3127 result = nvme_dev_map(dev);
3131 result = nvme_configure_admin_queue(dev);
3135 spin_lock(&dev_list_lock);
3136 if (list_empty(&dev_list) && IS_ERR_OR_NULL(nvme_thread)) {
3137 start_thread = true;
3140 list_add(&dev->node, &dev_list);
3141 spin_unlock(&dev_list_lock);
3144 nvme_thread = kthread_run(nvme_kthread, NULL, "nvme");
3145 wake_up_all(&nvme_kthread_wait);
3147 wait_event_killable(nvme_kthread_wait, nvme_thread);
3149 if (IS_ERR_OR_NULL(nvme_thread)) {
3150 result = nvme_thread ? PTR_ERR(nvme_thread) : -EINTR;
3154 nvme_init_queue(dev->queues[0], 0);
3155 result = nvme_alloc_admin_tags(dev);
3159 result = nvme_setup_io_queues(dev);
3163 dev->event_limit = 1;
3166 * Keep the controller around but remove all namespaces if we don't have
3167 * any working I/O queue.
3169 if (dev->online_queues < 2) {
3170 dev_warn(dev->dev, "IO queues not created\n");
3171 nvme_dev_remove(dev);
3173 nvme_unfreeze_queues(dev);
3180 nvme_dev_remove_admin(dev);
3181 blk_put_queue(dev->admin_q);
3182 dev->admin_q = NULL;
3183 dev->queues[0]->tags = NULL;
3185 nvme_disable_queue(dev, 0);
3186 nvme_dev_list_remove(dev);
3188 nvme_dev_unmap(dev);
3190 if (!work_busy(&dev->reset_work))
3191 nvme_dead_ctrl(dev);
3194 static int nvme_remove_dead_ctrl(void *arg)
3196 struct nvme_dev *dev = (struct nvme_dev *)arg;
3197 struct pci_dev *pdev = to_pci_dev(dev->dev);
3199 if (pci_get_drvdata(pdev))
3200 pci_stop_and_remove_bus_device_locked(pdev);
3201 kref_put(&dev->kref, nvme_free_dev);
3205 static void nvme_dead_ctrl(struct nvme_dev *dev)
3207 dev_warn(dev->dev, "Device failed to resume\n");
3208 kref_get(&dev->kref);
3209 if (IS_ERR(kthread_run(nvme_remove_dead_ctrl, dev, "nvme%d",
3212 "Failed to start controller remove task\n");
3213 kref_put(&dev->kref, nvme_free_dev);
3217 static void nvme_reset_work(struct work_struct *ws)
3219 struct nvme_dev *dev = container_of(ws, struct nvme_dev, reset_work);
3220 bool in_probe = work_busy(&dev->probe_work);
3222 nvme_dev_shutdown(dev);
3224 /* Synchronize with device probe so that work will see failure status
3225 * and exit gracefully without trying to schedule another reset */
3226 flush_work(&dev->probe_work);
3228 /* Fail this device if reset occured during probe to avoid
3229 * infinite initialization loops. */
3231 nvme_dead_ctrl(dev);
3234 /* Schedule device resume asynchronously so the reset work is available
3235 * to cleanup errors that may occur during reinitialization */
3236 schedule_work(&dev->probe_work);
3239 static int __nvme_reset(struct nvme_dev *dev)
3241 if (work_pending(&dev->reset_work))
3243 list_del_init(&dev->node);
3244 queue_work(nvme_workq, &dev->reset_work);
3248 static int nvme_reset(struct nvme_dev *dev)
3252 if (!dev->admin_q || blk_queue_dying(dev->admin_q))
3255 spin_lock(&dev_list_lock);
3256 ret = __nvme_reset(dev);
3257 spin_unlock(&dev_list_lock);
3260 flush_work(&dev->reset_work);
3261 flush_work(&dev->probe_work);
3268 static ssize_t nvme_sysfs_reset(struct device *dev,
3269 struct device_attribute *attr, const char *buf,
3272 struct nvme_dev *ndev = dev_get_drvdata(dev);
3275 ret = nvme_reset(ndev);
3281 static DEVICE_ATTR(reset_controller, S_IWUSR, NULL, nvme_sysfs_reset);
3283 static int nvme_probe(struct pci_dev *pdev, const struct pci_device_id *id)
3285 int node, result = -ENOMEM;
3286 struct nvme_dev *dev;
3288 node = dev_to_node(&pdev->dev);
3289 if (node == NUMA_NO_NODE)
3290 set_dev_node(&pdev->dev, 0);
3292 dev = kzalloc_node(sizeof(*dev), GFP_KERNEL, node);
3295 dev->entry = kzalloc_node(num_possible_cpus() * sizeof(*dev->entry),
3299 dev->queues = kzalloc_node((num_possible_cpus() + 1) * sizeof(void *),
3304 INIT_LIST_HEAD(&dev->namespaces);
3305 INIT_WORK(&dev->reset_work, nvme_reset_work);
3306 dev->dev = get_device(&pdev->dev);
3307 pci_set_drvdata(pdev, dev);
3308 result = nvme_set_instance(dev);
3312 result = nvme_setup_prp_pools(dev);
3316 kref_init(&dev->kref);
3317 dev->device = device_create(nvme_class, &pdev->dev,
3318 MKDEV(nvme_char_major, dev->instance),
3319 dev, "nvme%d", dev->instance);
3320 if (IS_ERR(dev->device)) {
3321 result = PTR_ERR(dev->device);
3324 get_device(dev->device);
3325 dev_set_drvdata(dev->device, dev);
3327 result = device_create_file(dev->device, &dev_attr_reset_controller);
3331 INIT_LIST_HEAD(&dev->node);
3332 INIT_WORK(&dev->scan_work, nvme_dev_scan);
3333 INIT_WORK(&dev->probe_work, nvme_probe_work);
3334 schedule_work(&dev->probe_work);
3338 device_destroy(nvme_class, MKDEV(nvme_char_major, dev->instance));
3339 put_device(dev->device);
3341 nvme_release_prp_pools(dev);
3343 nvme_release_instance(dev);
3345 put_device(dev->dev);
3353 static void nvme_reset_notify(struct pci_dev *pdev, bool prepare)
3355 struct nvme_dev *dev = pci_get_drvdata(pdev);
3358 nvme_dev_shutdown(dev);
3360 schedule_work(&dev->probe_work);
3363 static void nvme_shutdown(struct pci_dev *pdev)
3365 struct nvme_dev *dev = pci_get_drvdata(pdev);
3366 nvme_dev_shutdown(dev);
3369 static void nvme_remove(struct pci_dev *pdev)
3371 struct nvme_dev *dev = pci_get_drvdata(pdev);
3373 spin_lock(&dev_list_lock);
3374 list_del_init(&dev->node);
3375 spin_unlock(&dev_list_lock);
3377 pci_set_drvdata(pdev, NULL);
3378 flush_work(&dev->probe_work);
3379 flush_work(&dev->reset_work);
3380 flush_work(&dev->scan_work);
3381 device_remove_file(dev->device, &dev_attr_reset_controller);
3382 nvme_dev_remove(dev);
3383 nvme_dev_shutdown(dev);
3384 nvme_dev_remove_admin(dev);
3385 device_destroy(nvme_class, MKDEV(nvme_char_major, dev->instance));
3386 nvme_free_queues(dev, 0);
3387 nvme_release_cmb(dev);
3388 nvme_release_prp_pools(dev);
3389 kref_put(&dev->kref, nvme_free_dev);
3392 /* These functions are yet to be implemented */
3393 #define nvme_error_detected NULL
3394 #define nvme_dump_registers NULL
3395 #define nvme_link_reset NULL
3396 #define nvme_slot_reset NULL
3397 #define nvme_error_resume NULL
3399 #ifdef CONFIG_PM_SLEEP
3400 static int nvme_suspend(struct device *dev)
3402 struct pci_dev *pdev = to_pci_dev(dev);
3403 struct nvme_dev *ndev = pci_get_drvdata(pdev);
3405 nvme_dev_shutdown(ndev);
3409 static int nvme_resume(struct device *dev)
3411 struct pci_dev *pdev = to_pci_dev(dev);
3412 struct nvme_dev *ndev = pci_get_drvdata(pdev);
3414 schedule_work(&ndev->probe_work);
3419 static SIMPLE_DEV_PM_OPS(nvme_dev_pm_ops, nvme_suspend, nvme_resume);
3421 static const struct pci_error_handlers nvme_err_handler = {
3422 .error_detected = nvme_error_detected,
3423 .mmio_enabled = nvme_dump_registers,
3424 .link_reset = nvme_link_reset,
3425 .slot_reset = nvme_slot_reset,
3426 .resume = nvme_error_resume,
3427 .reset_notify = nvme_reset_notify,
3430 /* Move to pci_ids.h later */
3431 #define PCI_CLASS_STORAGE_EXPRESS 0x010802
3433 static const struct pci_device_id nvme_id_table[] = {
3434 { PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) },
3435 { PCI_DEVICE(PCI_VENDOR_ID_APPLE, 0x2001) },
3438 MODULE_DEVICE_TABLE(pci, nvme_id_table);
3440 static struct pci_driver nvme_driver = {
3442 .id_table = nvme_id_table,
3443 .probe = nvme_probe,
3444 .remove = nvme_remove,
3445 .shutdown = nvme_shutdown,
3447 .pm = &nvme_dev_pm_ops,
3449 .err_handler = &nvme_err_handler,
3452 static int __init nvme_init(void)
3456 init_waitqueue_head(&nvme_kthread_wait);
3458 nvme_workq = create_singlethread_workqueue("nvme");
3462 result = register_blkdev(nvme_major, "nvme");
3465 else if (result > 0)
3466 nvme_major = result;
3468 result = __register_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme",
3471 goto unregister_blkdev;
3472 else if (result > 0)
3473 nvme_char_major = result;
3475 nvme_class = class_create(THIS_MODULE, "nvme");
3476 if (IS_ERR(nvme_class)) {
3477 result = PTR_ERR(nvme_class);
3478 goto unregister_chrdev;
3481 result = pci_register_driver(&nvme_driver);
3487 class_destroy(nvme_class);
3489 __unregister_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme");
3491 unregister_blkdev(nvme_major, "nvme");
3493 destroy_workqueue(nvme_workq);
3497 static void __exit nvme_exit(void)
3499 pci_unregister_driver(&nvme_driver);
3500 unregister_blkdev(nvme_major, "nvme");
3501 destroy_workqueue(nvme_workq);
3502 class_destroy(nvme_class);
3503 __unregister_chrdev(nvme_char_major, 0, NVME_MINORS, "nvme");
3504 BUG_ON(nvme_thread && !IS_ERR(nvme_thread));
3508 MODULE_AUTHOR("Matthew Wilcox <willy@linux.intel.com>");
3509 MODULE_LICENSE("GPL");
3510 MODULE_VERSION("1.0");
3511 module_init(nvme_init);
3512 module_exit(nvme_exit);