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/nvme.h>
16 #include <linux/bitops.h>
17 #include <linux/blkdev.h>
18 #include <linux/blk-mq.h>
19 #include <linux/cpu.h>
20 #include <linux/delay.h>
21 #include <linux/errno.h>
23 #include <linux/genhd.h>
24 #include <linux/hdreg.h>
25 #include <linux/idr.h>
26 #include <linux/init.h>
27 #include <linux/interrupt.h>
29 #include <linux/kdev_t.h>
30 #include <linux/kthread.h>
31 #include <linux/kernel.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/types.h>
42 #include <asm-generic/io-64-nonatomic-lo-hi.h>
44 #define NVME_Q_DEPTH 1024
45 #define NVME_AQ_DEPTH 64
46 #define SQ_SIZE(depth) (depth * sizeof(struct nvme_command))
47 #define CQ_SIZE(depth) (depth * sizeof(struct nvme_completion))
48 #define ADMIN_TIMEOUT (admin_timeout * HZ)
49 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
50 #define IOD_TIMEOUT (retry_time * HZ)
52 static unsigned char admin_timeout = 60;
53 module_param(admin_timeout, byte, 0644);
54 MODULE_PARM_DESC(admin_timeout, "timeout in seconds for admin commands");
56 unsigned char nvme_io_timeout = 30;
57 module_param_named(io_timeout, nvme_io_timeout, byte, 0644);
58 MODULE_PARM_DESC(io_timeout, "timeout in seconds for I/O");
60 static unsigned char retry_time = 30;
61 module_param(retry_time, byte, 0644);
62 MODULE_PARM_DESC(retry_time, "time in seconds to retry failed I/O");
64 static unsigned char shutdown_timeout = 5;
65 module_param(shutdown_timeout, byte, 0644);
66 MODULE_PARM_DESC(shutdown_timeout, "timeout in seconds for controller shutdown");
68 static int nvme_major;
69 module_param(nvme_major, int, 0);
71 static int use_threaded_interrupts;
72 module_param(use_threaded_interrupts, int, 0);
74 static DEFINE_SPINLOCK(dev_list_lock);
75 static LIST_HEAD(dev_list);
76 static struct task_struct *nvme_thread;
77 static struct workqueue_struct *nvme_workq;
78 static wait_queue_head_t nvme_kthread_wait;
79 static struct notifier_block nvme_nb;
81 static void nvme_reset_failed_dev(struct work_struct *ws);
82 static int nvme_process_cq(struct nvme_queue *nvmeq);
84 struct async_cmd_info {
85 struct kthread_work work;
86 struct kthread_worker *worker;
94 * An NVM Express queue. Each device has at least two (one for admin
95 * commands and one for I/O commands).
98 struct llist_node node;
99 struct device *q_dmadev;
100 struct nvme_dev *dev;
101 char irqname[24]; /* nvme4294967295-65535\0 */
103 struct nvme_command *sq_cmds;
104 volatile struct nvme_completion *cqes;
105 dma_addr_t sq_dma_addr;
106 dma_addr_t cq_dma_addr;
116 struct async_cmd_info cmdinfo;
117 struct blk_mq_hw_ctx *hctx;
121 * Check we didin't inadvertently grow the command struct
123 static inline void _nvme_check_size(void)
125 BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
126 BUILD_BUG_ON(sizeof(struct nvme_create_cq) != 64);
127 BUILD_BUG_ON(sizeof(struct nvme_create_sq) != 64);
128 BUILD_BUG_ON(sizeof(struct nvme_delete_queue) != 64);
129 BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
130 BUILD_BUG_ON(sizeof(struct nvme_format_cmd) != 64);
131 BUILD_BUG_ON(sizeof(struct nvme_abort_cmd) != 64);
132 BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
133 BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != 4096);
134 BUILD_BUG_ON(sizeof(struct nvme_id_ns) != 4096);
135 BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64);
136 BUILD_BUG_ON(sizeof(struct nvme_smart_log) != 512);
139 typedef void (*nvme_completion_fn)(struct nvme_queue *, void *,
140 struct nvme_completion *);
142 struct nvme_cmd_info {
143 nvme_completion_fn fn;
146 struct nvme_queue *nvmeq;
149 static int nvme_admin_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
150 unsigned int hctx_idx)
152 struct nvme_dev *dev = data;
153 struct nvme_queue *nvmeq = dev->queues[0];
155 WARN_ON(nvmeq->hctx);
157 hctx->driver_data = nvmeq;
161 static int nvme_admin_init_request(void *data, struct request *req,
162 unsigned int hctx_idx, unsigned int rq_idx,
163 unsigned int numa_node)
165 struct nvme_dev *dev = data;
166 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
167 struct nvme_queue *nvmeq = dev->queues[0];
174 static void nvme_exit_hctx(struct blk_mq_hw_ctx *hctx, unsigned int hctx_idx)
176 struct nvme_queue *nvmeq = hctx->driver_data;
181 static int nvme_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
182 unsigned int hctx_idx)
184 struct nvme_dev *dev = data;
185 struct nvme_queue *nvmeq = dev->queues[
186 (hctx_idx % dev->queue_count) + 1];
191 /* nvmeq queues are shared between namespaces. We assume here that
192 * blk-mq map the tags so they match up with the nvme queue tags. */
193 WARN_ON(nvmeq->hctx->tags != hctx->tags);
195 hctx->driver_data = nvmeq;
199 static int nvme_init_request(void *data, struct request *req,
200 unsigned int hctx_idx, unsigned int rq_idx,
201 unsigned int numa_node)
203 struct nvme_dev *dev = data;
204 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
205 struct nvme_queue *nvmeq = dev->queues[hctx_idx + 1];
212 static void nvme_set_info(struct nvme_cmd_info *cmd, void *ctx,
213 nvme_completion_fn handler)
220 /* Special values must be less than 0x1000 */
221 #define CMD_CTX_BASE ((void *)POISON_POINTER_DELTA)
222 #define CMD_CTX_CANCELLED (0x30C + CMD_CTX_BASE)
223 #define CMD_CTX_COMPLETED (0x310 + CMD_CTX_BASE)
224 #define CMD_CTX_INVALID (0x314 + CMD_CTX_BASE)
226 static void special_completion(struct nvme_queue *nvmeq, void *ctx,
227 struct nvme_completion *cqe)
229 if (ctx == CMD_CTX_CANCELLED)
231 if (ctx == CMD_CTX_COMPLETED) {
232 dev_warn(nvmeq->q_dmadev,
233 "completed id %d twice on queue %d\n",
234 cqe->command_id, le16_to_cpup(&cqe->sq_id));
237 if (ctx == CMD_CTX_INVALID) {
238 dev_warn(nvmeq->q_dmadev,
239 "invalid id %d completed on queue %d\n",
240 cqe->command_id, le16_to_cpup(&cqe->sq_id));
243 dev_warn(nvmeq->q_dmadev, "Unknown special completion %p\n", ctx);
246 static void *cancel_cmd_info(struct nvme_cmd_info *cmd, nvme_completion_fn *fn)
253 cmd->fn = special_completion;
254 cmd->ctx = CMD_CTX_CANCELLED;
258 static void async_req_completion(struct nvme_queue *nvmeq, void *ctx,
259 struct nvme_completion *cqe)
261 struct request *req = ctx;
263 u32 result = le32_to_cpup(&cqe->result);
264 u16 status = le16_to_cpup(&cqe->status) >> 1;
266 if (status == NVME_SC_SUCCESS || status == NVME_SC_ABORT_REQ)
267 ++nvmeq->dev->event_limit;
268 if (status == NVME_SC_SUCCESS)
269 dev_warn(nvmeq->q_dmadev,
270 "async event result %08x\n", result);
272 blk_mq_free_hctx_request(nvmeq->hctx, req);
275 static void abort_completion(struct nvme_queue *nvmeq, void *ctx,
276 struct nvme_completion *cqe)
278 struct request *req = ctx;
280 u16 status = le16_to_cpup(&cqe->status) >> 1;
281 u32 result = le32_to_cpup(&cqe->result);
283 blk_mq_free_hctx_request(nvmeq->hctx, req);
285 dev_warn(nvmeq->q_dmadev, "Abort status:%x result:%x", status, result);
286 ++nvmeq->dev->abort_limit;
289 static void async_completion(struct nvme_queue *nvmeq, void *ctx,
290 struct nvme_completion *cqe)
292 struct async_cmd_info *cmdinfo = ctx;
293 cmdinfo->result = le32_to_cpup(&cqe->result);
294 cmdinfo->status = le16_to_cpup(&cqe->status) >> 1;
295 queue_kthread_work(cmdinfo->worker, &cmdinfo->work);
296 blk_mq_free_hctx_request(nvmeq->hctx, cmdinfo->req);
299 static inline struct nvme_cmd_info *get_cmd_from_tag(struct nvme_queue *nvmeq,
302 struct blk_mq_hw_ctx *hctx = nvmeq->hctx;
303 struct request *req = blk_mq_tag_to_rq(hctx->tags, tag);
305 return blk_mq_rq_to_pdu(req);
309 * Called with local interrupts disabled and the q_lock held. May not sleep.
311 static void *nvme_finish_cmd(struct nvme_queue *nvmeq, int tag,
312 nvme_completion_fn *fn)
314 struct nvme_cmd_info *cmd = get_cmd_from_tag(nvmeq, tag);
316 if (tag >= nvmeq->q_depth) {
317 *fn = special_completion;
318 return CMD_CTX_INVALID;
323 cmd->fn = special_completion;
324 cmd->ctx = CMD_CTX_COMPLETED;
329 * nvme_submit_cmd() - Copy a command into a queue and ring the doorbell
330 * @nvmeq: The queue to use
331 * @cmd: The command to send
333 * Safe to use from interrupt context
335 static int __nvme_submit_cmd(struct nvme_queue *nvmeq, struct nvme_command *cmd)
337 u16 tail = nvmeq->sq_tail;
339 memcpy(&nvmeq->sq_cmds[tail], cmd, sizeof(*cmd));
340 if (++tail == nvmeq->q_depth)
342 writel(tail, nvmeq->q_db);
343 nvmeq->sq_tail = tail;
348 static int nvme_submit_cmd(struct nvme_queue *nvmeq, struct nvme_command *cmd)
352 spin_lock_irqsave(&nvmeq->q_lock, flags);
353 ret = __nvme_submit_cmd(nvmeq, cmd);
354 spin_unlock_irqrestore(&nvmeq->q_lock, flags);
358 static __le64 **iod_list(struct nvme_iod *iod)
360 return ((void *)iod) + iod->offset;
364 * Will slightly overestimate the number of pages needed. This is OK
365 * as it only leads to a small amount of wasted memory for the lifetime of
368 static int nvme_npages(unsigned size, struct nvme_dev *dev)
370 unsigned nprps = DIV_ROUND_UP(size + dev->page_size, dev->page_size);
371 return DIV_ROUND_UP(8 * nprps, dev->page_size - 8);
374 static struct nvme_iod *
375 nvme_alloc_iod(unsigned nseg, unsigned nbytes, struct nvme_dev *dev, gfp_t gfp)
377 struct nvme_iod *iod = kmalloc(sizeof(struct nvme_iod) +
378 sizeof(__le64 *) * nvme_npages(nbytes, dev) +
379 sizeof(struct scatterlist) * nseg, gfp);
382 iod->offset = offsetof(struct nvme_iod, sg[nseg]);
384 iod->length = nbytes;
386 iod->first_dma = 0ULL;
392 void nvme_free_iod(struct nvme_dev *dev, struct nvme_iod *iod)
394 const int last_prp = dev->page_size / 8 - 1;
396 __le64 **list = iod_list(iod);
397 dma_addr_t prp_dma = iod->first_dma;
399 if (iod->npages == 0)
400 dma_pool_free(dev->prp_small_pool, list[0], prp_dma);
401 for (i = 0; i < iod->npages; i++) {
402 __le64 *prp_list = list[i];
403 dma_addr_t next_prp_dma = le64_to_cpu(prp_list[last_prp]);
404 dma_pool_free(dev->prp_page_pool, prp_list, prp_dma);
405 prp_dma = next_prp_dma;
410 static int nvme_error_status(u16 status)
412 switch (status & 0x7ff) {
413 case NVME_SC_SUCCESS:
415 case NVME_SC_CAP_EXCEEDED:
422 static void req_completion(struct nvme_queue *nvmeq, void *ctx,
423 struct nvme_completion *cqe)
425 struct nvme_iod *iod = ctx;
426 struct request *req = iod->private;
427 struct nvme_cmd_info *cmd_rq = blk_mq_rq_to_pdu(req);
429 u16 status = le16_to_cpup(&cqe->status) >> 1;
431 if (unlikely(status)) {
432 if (!(status & NVME_SC_DNR || blk_noretry_request(req))
433 && (jiffies - req->start_time) < req->timeout) {
434 blk_mq_requeue_request(req);
435 blk_mq_kick_requeue_list(req->q);
438 req->errors = nvme_error_status(status);
443 dev_warn(&nvmeq->dev->pci_dev->dev,
444 "completing aborted command with status:%04x\n",
448 dma_unmap_sg(&nvmeq->dev->pci_dev->dev, iod->sg, iod->nents,
449 rq_data_dir(req) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
450 nvme_free_iod(nvmeq->dev, iod);
452 blk_mq_complete_request(req);
455 /* length is in bytes. gfp flags indicates whether we may sleep. */
456 int nvme_setup_prps(struct nvme_dev *dev, struct nvme_iod *iod, int total_len,
459 struct dma_pool *pool;
460 int length = total_len;
461 struct scatterlist *sg = iod->sg;
462 int dma_len = sg_dma_len(sg);
463 u64 dma_addr = sg_dma_address(sg);
464 int offset = offset_in_page(dma_addr);
466 __le64 **list = iod_list(iod);
469 u32 page_size = dev->page_size;
471 length -= (page_size - offset);
475 dma_len -= (page_size - offset);
477 dma_addr += (page_size - offset);
480 dma_addr = sg_dma_address(sg);
481 dma_len = sg_dma_len(sg);
484 if (length <= page_size) {
485 iod->first_dma = dma_addr;
489 nprps = DIV_ROUND_UP(length, page_size);
490 if (nprps <= (256 / 8)) {
491 pool = dev->prp_small_pool;
494 pool = dev->prp_page_pool;
498 prp_list = dma_pool_alloc(pool, gfp, &prp_dma);
500 iod->first_dma = dma_addr;
502 return (total_len - length) + page_size;
505 iod->first_dma = prp_dma;
508 if (i == page_size >> 3) {
509 __le64 *old_prp_list = prp_list;
510 prp_list = dma_pool_alloc(pool, gfp, &prp_dma);
512 return total_len - length;
513 list[iod->npages++] = prp_list;
514 prp_list[0] = old_prp_list[i - 1];
515 old_prp_list[i - 1] = cpu_to_le64(prp_dma);
518 prp_list[i++] = cpu_to_le64(dma_addr);
519 dma_len -= page_size;
520 dma_addr += page_size;
528 dma_addr = sg_dma_address(sg);
529 dma_len = sg_dma_len(sg);
536 * We reuse the small pool to allocate the 16-byte range here as it is not
537 * worth having a special pool for these or additional cases to handle freeing
540 static void nvme_submit_discard(struct nvme_queue *nvmeq, struct nvme_ns *ns,
541 struct request *req, struct nvme_iod *iod)
543 struct nvme_dsm_range *range =
544 (struct nvme_dsm_range *)iod_list(iod)[0];
545 struct nvme_command *cmnd = &nvmeq->sq_cmds[nvmeq->sq_tail];
547 range->cattr = cpu_to_le32(0);
548 range->nlb = cpu_to_le32(blk_rq_bytes(req) >> ns->lba_shift);
549 range->slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
551 memset(cmnd, 0, sizeof(*cmnd));
552 cmnd->dsm.opcode = nvme_cmd_dsm;
553 cmnd->dsm.command_id = req->tag;
554 cmnd->dsm.nsid = cpu_to_le32(ns->ns_id);
555 cmnd->dsm.prp1 = cpu_to_le64(iod->first_dma);
557 cmnd->dsm.attributes = cpu_to_le32(NVME_DSMGMT_AD);
559 if (++nvmeq->sq_tail == nvmeq->q_depth)
561 writel(nvmeq->sq_tail, nvmeq->q_db);
564 static void nvme_submit_flush(struct nvme_queue *nvmeq, struct nvme_ns *ns,
567 struct nvme_command *cmnd = &nvmeq->sq_cmds[nvmeq->sq_tail];
569 memset(cmnd, 0, sizeof(*cmnd));
570 cmnd->common.opcode = nvme_cmd_flush;
571 cmnd->common.command_id = cmdid;
572 cmnd->common.nsid = cpu_to_le32(ns->ns_id);
574 if (++nvmeq->sq_tail == nvmeq->q_depth)
576 writel(nvmeq->sq_tail, nvmeq->q_db);
579 static int nvme_submit_iod(struct nvme_queue *nvmeq, struct nvme_iod *iod,
582 struct request *req = iod->private;
583 struct nvme_command *cmnd;
587 if (req->cmd_flags & REQ_FUA)
588 control |= NVME_RW_FUA;
589 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
590 control |= NVME_RW_LR;
592 if (req->cmd_flags & REQ_RAHEAD)
593 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
595 cmnd = &nvmeq->sq_cmds[nvmeq->sq_tail];
596 memset(cmnd, 0, sizeof(*cmnd));
598 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
599 cmnd->rw.command_id = req->tag;
600 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
601 cmnd->rw.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
602 cmnd->rw.prp2 = cpu_to_le64(iod->first_dma);
603 cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
604 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
605 cmnd->rw.control = cpu_to_le16(control);
606 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
608 if (++nvmeq->sq_tail == nvmeq->q_depth)
610 writel(nvmeq->sq_tail, nvmeq->q_db);
615 static int nvme_queue_rq(struct blk_mq_hw_ctx *hctx,
616 const struct blk_mq_queue_data *bd)
618 struct nvme_ns *ns = hctx->queue->queuedata;
619 struct nvme_queue *nvmeq = hctx->driver_data;
620 struct request *req = bd->rq;
621 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
622 struct nvme_iod *iod;
623 int psegs = req->nr_phys_segments;
624 int result = BLK_MQ_RQ_QUEUE_BUSY;
625 enum dma_data_direction dma_dir;
626 unsigned size = !(req->cmd_flags & REQ_DISCARD) ? blk_rq_bytes(req) :
627 sizeof(struct nvme_dsm_range);
630 * Requeued IO has already been prepped
636 iod = nvme_alloc_iod(psegs, size, ns->dev, GFP_ATOMIC);
643 nvme_set_info(cmd, iod, req_completion);
645 if (req->cmd_flags & REQ_DISCARD) {
648 * We reuse the small pool to allocate the 16-byte range here
649 * as it is not worth having a special pool for these or
650 * additional cases to handle freeing the iod.
652 range = dma_pool_alloc(nvmeq->dev->prp_small_pool,
657 iod_list(iod)[0] = (__le64 *)range;
660 dma_dir = rq_data_dir(req) ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
662 sg_init_table(iod->sg, psegs);
663 iod->nents = blk_rq_map_sg(req->q, req, iod->sg);
665 result = BLK_MQ_RQ_QUEUE_ERROR;
669 if (!dma_map_sg(nvmeq->q_dmadev, iod->sg, iod->nents, dma_dir))
672 if (blk_rq_bytes(req) != nvme_setup_prps(nvmeq->dev, iod,
673 blk_rq_bytes(req), GFP_ATOMIC))
677 blk_mq_start_request(req);
680 spin_lock_irq(&nvmeq->q_lock);
681 if (req->cmd_flags & REQ_DISCARD)
682 nvme_submit_discard(nvmeq, ns, req, iod);
683 else if (req->cmd_flags & REQ_FLUSH)
684 nvme_submit_flush(nvmeq, ns, req->tag);
686 nvme_submit_iod(nvmeq, iod, ns);
688 nvme_process_cq(nvmeq);
689 spin_unlock_irq(&nvmeq->q_lock);
690 return BLK_MQ_RQ_QUEUE_OK;
693 nvme_finish_cmd(nvmeq, req->tag, NULL);
694 nvme_free_iod(nvmeq->dev, iod);
698 static int nvme_process_cq(struct nvme_queue *nvmeq)
702 head = nvmeq->cq_head;
703 phase = nvmeq->cq_phase;
707 nvme_completion_fn fn;
708 struct nvme_completion cqe = nvmeq->cqes[head];
709 if ((le16_to_cpu(cqe.status) & 1) != phase)
711 nvmeq->sq_head = le16_to_cpu(cqe.sq_head);
712 if (++head == nvmeq->q_depth) {
716 ctx = nvme_finish_cmd(nvmeq, cqe.command_id, &fn);
717 fn(nvmeq, ctx, &cqe);
720 /* If the controller ignores the cq head doorbell and continuously
721 * writes to the queue, it is theoretically possible to wrap around
722 * the queue twice and mistakenly return IRQ_NONE. Linux only
723 * requires that 0.1% of your interrupts are handled, so this isn't
726 if (head == nvmeq->cq_head && phase == nvmeq->cq_phase)
729 writel(head, nvmeq->q_db + nvmeq->dev->db_stride);
730 nvmeq->cq_head = head;
731 nvmeq->cq_phase = phase;
737 /* Admin queue isn't initialized as a request queue. If at some point this
738 * happens anyway, make sure to notify the user */
739 static int nvme_admin_queue_rq(struct blk_mq_hw_ctx *hctx,
740 const struct blk_mq_queue_data *bd)
743 return BLK_MQ_RQ_QUEUE_ERROR;
746 static irqreturn_t nvme_irq(int irq, void *data)
749 struct nvme_queue *nvmeq = data;
750 spin_lock(&nvmeq->q_lock);
751 nvme_process_cq(nvmeq);
752 result = nvmeq->cqe_seen ? IRQ_HANDLED : IRQ_NONE;
754 spin_unlock(&nvmeq->q_lock);
758 static irqreturn_t nvme_irq_check(int irq, void *data)
760 struct nvme_queue *nvmeq = data;
761 struct nvme_completion cqe = nvmeq->cqes[nvmeq->cq_head];
762 if ((le16_to_cpu(cqe.status) & 1) != nvmeq->cq_phase)
764 return IRQ_WAKE_THREAD;
767 static void nvme_abort_cmd_info(struct nvme_queue *nvmeq, struct nvme_cmd_info *
770 spin_lock_irq(&nvmeq->q_lock);
771 cancel_cmd_info(cmd_info, NULL);
772 spin_unlock_irq(&nvmeq->q_lock);
775 struct sync_cmd_info {
776 struct task_struct *task;
781 static void sync_completion(struct nvme_queue *nvmeq, void *ctx,
782 struct nvme_completion *cqe)
784 struct sync_cmd_info *cmdinfo = ctx;
785 cmdinfo->result = le32_to_cpup(&cqe->result);
786 cmdinfo->status = le16_to_cpup(&cqe->status) >> 1;
787 wake_up_process(cmdinfo->task);
791 * Returns 0 on success. If the result is negative, it's a Linux error code;
792 * if the result is positive, it's an NVM Express status code
794 static int nvme_submit_sync_cmd(struct request *req, struct nvme_command *cmd,
795 u32 *result, unsigned timeout)
798 struct sync_cmd_info cmdinfo;
799 struct nvme_cmd_info *cmd_rq = blk_mq_rq_to_pdu(req);
800 struct nvme_queue *nvmeq = cmd_rq->nvmeq;
802 cmdinfo.task = current;
803 cmdinfo.status = -EINTR;
805 cmd->common.command_id = req->tag;
807 nvme_set_info(cmd_rq, &cmdinfo, sync_completion);
809 set_current_state(TASK_KILLABLE);
810 ret = nvme_submit_cmd(nvmeq, cmd);
812 nvme_finish_cmd(nvmeq, req->tag, NULL);
813 set_current_state(TASK_RUNNING);
815 schedule_timeout(timeout);
817 if (cmdinfo.status == -EINTR) {
818 nvme_abort_cmd_info(nvmeq, blk_mq_rq_to_pdu(req));
823 *result = cmdinfo.result;
825 return cmdinfo.status;
828 static int nvme_submit_async_admin_req(struct nvme_dev *dev)
830 struct nvme_queue *nvmeq = dev->queues[0];
831 struct nvme_command c;
832 struct nvme_cmd_info *cmd_info;
835 req = blk_mq_alloc_request(dev->admin_q, WRITE, GFP_ATOMIC, false);
839 cmd_info = blk_mq_rq_to_pdu(req);
840 nvme_set_info(cmd_info, req, async_req_completion);
842 memset(&c, 0, sizeof(c));
843 c.common.opcode = nvme_admin_async_event;
844 c.common.command_id = req->tag;
846 return __nvme_submit_cmd(nvmeq, &c);
849 static int nvme_submit_admin_async_cmd(struct nvme_dev *dev,
850 struct nvme_command *cmd,
851 struct async_cmd_info *cmdinfo, unsigned timeout)
853 struct nvme_queue *nvmeq = dev->queues[0];
855 struct nvme_cmd_info *cmd_rq;
857 req = blk_mq_alloc_request(dev->admin_q, WRITE, GFP_KERNEL, false);
861 req->timeout = timeout;
862 cmd_rq = blk_mq_rq_to_pdu(req);
864 nvme_set_info(cmd_rq, cmdinfo, async_completion);
865 cmdinfo->status = -EINTR;
867 cmd->common.command_id = req->tag;
869 return nvme_submit_cmd(nvmeq, cmd);
872 static int __nvme_submit_admin_cmd(struct nvme_dev *dev, struct nvme_command *cmd,
873 u32 *result, unsigned timeout)
878 req = blk_mq_alloc_request(dev->admin_q, WRITE, GFP_KERNEL, false);
881 res = nvme_submit_sync_cmd(req, cmd, result, timeout);
882 blk_mq_free_request(req);
886 int nvme_submit_admin_cmd(struct nvme_dev *dev, struct nvme_command *cmd,
889 return __nvme_submit_admin_cmd(dev, cmd, result, ADMIN_TIMEOUT);
892 int nvme_submit_io_cmd(struct nvme_dev *dev, struct nvme_ns *ns,
893 struct nvme_command *cmd, u32 *result)
898 req = blk_mq_alloc_request(ns->queue, WRITE, (GFP_KERNEL|__GFP_WAIT),
902 res = nvme_submit_sync_cmd(req, cmd, result, NVME_IO_TIMEOUT);
903 blk_mq_free_request(req);
907 static int adapter_delete_queue(struct nvme_dev *dev, u8 opcode, u16 id)
909 struct nvme_command c;
911 memset(&c, 0, sizeof(c));
912 c.delete_queue.opcode = opcode;
913 c.delete_queue.qid = cpu_to_le16(id);
915 return nvme_submit_admin_cmd(dev, &c, NULL);
918 static int adapter_alloc_cq(struct nvme_dev *dev, u16 qid,
919 struct nvme_queue *nvmeq)
921 struct nvme_command c;
922 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_CQ_IRQ_ENABLED;
924 memset(&c, 0, sizeof(c));
925 c.create_cq.opcode = nvme_admin_create_cq;
926 c.create_cq.prp1 = cpu_to_le64(nvmeq->cq_dma_addr);
927 c.create_cq.cqid = cpu_to_le16(qid);
928 c.create_cq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
929 c.create_cq.cq_flags = cpu_to_le16(flags);
930 c.create_cq.irq_vector = cpu_to_le16(nvmeq->cq_vector);
932 return nvme_submit_admin_cmd(dev, &c, NULL);
935 static int adapter_alloc_sq(struct nvme_dev *dev, u16 qid,
936 struct nvme_queue *nvmeq)
938 struct nvme_command c;
939 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_SQ_PRIO_MEDIUM;
941 memset(&c, 0, sizeof(c));
942 c.create_sq.opcode = nvme_admin_create_sq;
943 c.create_sq.prp1 = cpu_to_le64(nvmeq->sq_dma_addr);
944 c.create_sq.sqid = cpu_to_le16(qid);
945 c.create_sq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
946 c.create_sq.sq_flags = cpu_to_le16(flags);
947 c.create_sq.cqid = cpu_to_le16(qid);
949 return nvme_submit_admin_cmd(dev, &c, NULL);
952 static int adapter_delete_cq(struct nvme_dev *dev, u16 cqid)
954 return adapter_delete_queue(dev, nvme_admin_delete_cq, cqid);
957 static int adapter_delete_sq(struct nvme_dev *dev, u16 sqid)
959 return adapter_delete_queue(dev, nvme_admin_delete_sq, sqid);
962 int nvme_identify(struct nvme_dev *dev, unsigned nsid, unsigned cns,
965 struct nvme_command c;
967 memset(&c, 0, sizeof(c));
968 c.identify.opcode = nvme_admin_identify;
969 c.identify.nsid = cpu_to_le32(nsid);
970 c.identify.prp1 = cpu_to_le64(dma_addr);
971 c.identify.cns = cpu_to_le32(cns);
973 return nvme_submit_admin_cmd(dev, &c, NULL);
976 int nvme_get_features(struct nvme_dev *dev, unsigned fid, unsigned nsid,
977 dma_addr_t dma_addr, u32 *result)
979 struct nvme_command c;
981 memset(&c, 0, sizeof(c));
982 c.features.opcode = nvme_admin_get_features;
983 c.features.nsid = cpu_to_le32(nsid);
984 c.features.prp1 = cpu_to_le64(dma_addr);
985 c.features.fid = cpu_to_le32(fid);
987 return nvme_submit_admin_cmd(dev, &c, result);
990 int nvme_set_features(struct nvme_dev *dev, unsigned fid, unsigned dword11,
991 dma_addr_t dma_addr, u32 *result)
993 struct nvme_command c;
995 memset(&c, 0, sizeof(c));
996 c.features.opcode = nvme_admin_set_features;
997 c.features.prp1 = cpu_to_le64(dma_addr);
998 c.features.fid = cpu_to_le32(fid);
999 c.features.dword11 = cpu_to_le32(dword11);
1001 return nvme_submit_admin_cmd(dev, &c, result);
1005 * nvme_abort_req - Attempt aborting a request
1007 * Schedule controller reset if the command was already aborted once before and
1008 * still hasn't been returned to the driver, or if this is the admin queue.
1010 static void nvme_abort_req(struct request *req)
1012 struct nvme_cmd_info *cmd_rq = blk_mq_rq_to_pdu(req);
1013 struct nvme_queue *nvmeq = cmd_rq->nvmeq;
1014 struct nvme_dev *dev = nvmeq->dev;
1015 struct request *abort_req;
1016 struct nvme_cmd_info *abort_cmd;
1017 struct nvme_command cmd;
1019 if (!nvmeq->qid || cmd_rq->aborted) {
1020 if (work_busy(&dev->reset_work))
1022 list_del_init(&dev->node);
1023 dev_warn(&dev->pci_dev->dev,
1024 "I/O %d QID %d timeout, reset controller\n",
1025 req->tag, nvmeq->qid);
1026 dev->reset_workfn = nvme_reset_failed_dev;
1027 queue_work(nvme_workq, &dev->reset_work);
1031 if (!dev->abort_limit)
1034 abort_req = blk_mq_alloc_request(dev->admin_q, WRITE, GFP_ATOMIC,
1036 if (IS_ERR(abort_req))
1039 abort_cmd = blk_mq_rq_to_pdu(abort_req);
1040 nvme_set_info(abort_cmd, abort_req, abort_completion);
1042 memset(&cmd, 0, sizeof(cmd));
1043 cmd.abort.opcode = nvme_admin_abort_cmd;
1044 cmd.abort.cid = req->tag;
1045 cmd.abort.sqid = cpu_to_le16(nvmeq->qid);
1046 cmd.abort.command_id = abort_req->tag;
1049 cmd_rq->aborted = 1;
1051 dev_warn(nvmeq->q_dmadev, "Aborting I/O %d QID %d\n", req->tag,
1053 if (nvme_submit_cmd(dev->queues[0], &cmd) < 0) {
1054 dev_warn(nvmeq->q_dmadev,
1055 "Could not abort I/O %d QID %d",
1056 req->tag, nvmeq->qid);
1057 blk_mq_free_request(req);
1061 static void nvme_cancel_queue_ios(struct blk_mq_hw_ctx *hctx,
1062 struct request *req, void *data, bool reserved)
1064 struct nvme_queue *nvmeq = data;
1066 nvme_completion_fn fn;
1067 struct nvme_cmd_info *cmd;
1068 static struct nvme_completion cqe = {
1069 .status = cpu_to_le16(NVME_SC_ABORT_REQ << 1),
1072 cmd = blk_mq_rq_to_pdu(req);
1074 if (cmd->ctx == CMD_CTX_CANCELLED)
1077 dev_warn(nvmeq->q_dmadev, "Cancelling I/O %d QID %d\n",
1078 req->tag, nvmeq->qid);
1079 ctx = cancel_cmd_info(cmd, &fn);
1080 fn(nvmeq, ctx, &cqe);
1083 static enum blk_eh_timer_return nvme_timeout(struct request *req, bool reserved)
1085 struct nvme_cmd_info *cmd = blk_mq_rq_to_pdu(req);
1086 struct nvme_queue *nvmeq = cmd->nvmeq;
1088 dev_warn(nvmeq->q_dmadev, "Timeout I/O %d QID %d\n", req->tag,
1090 if (nvmeq->dev->initialized)
1091 nvme_abort_req(req);
1094 * The aborted req will be completed on receiving the abort req.
1095 * We enable the timer again. If hit twice, it'll cause a device reset,
1096 * as the device then is in a faulty state.
1098 return BLK_EH_RESET_TIMER;
1101 static void nvme_free_queue(struct nvme_queue *nvmeq)
1103 dma_free_coherent(nvmeq->q_dmadev, CQ_SIZE(nvmeq->q_depth),
1104 (void *)nvmeq->cqes, nvmeq->cq_dma_addr);
1105 dma_free_coherent(nvmeq->q_dmadev, SQ_SIZE(nvmeq->q_depth),
1106 nvmeq->sq_cmds, nvmeq->sq_dma_addr);
1110 static void nvme_free_queues(struct nvme_dev *dev, int lowest)
1113 struct nvme_queue *nvmeq, *next;
1114 struct llist_node *entry;
1117 for (i = dev->queue_count - 1; i >= lowest; i--) {
1118 struct nvme_queue *nvmeq = dev->queues[i];
1119 llist_add(&nvmeq->node, &q_list);
1121 dev->queues[i] = NULL;
1124 entry = llist_del_all(&q_list);
1125 llist_for_each_entry_safe(nvmeq, next, entry, node)
1126 nvme_free_queue(nvmeq);
1130 * nvme_suspend_queue - put queue into suspended state
1131 * @nvmeq - queue to suspend
1133 static int nvme_suspend_queue(struct nvme_queue *nvmeq)
1135 int vector = nvmeq->dev->entry[nvmeq->cq_vector].vector;
1137 spin_lock_irq(&nvmeq->q_lock);
1138 nvmeq->dev->online_queues--;
1139 spin_unlock_irq(&nvmeq->q_lock);
1141 irq_set_affinity_hint(vector, NULL);
1142 free_irq(vector, nvmeq);
1147 static void nvme_clear_queue(struct nvme_queue *nvmeq)
1149 struct blk_mq_hw_ctx *hctx = nvmeq->hctx;
1151 spin_lock_irq(&nvmeq->q_lock);
1152 nvme_process_cq(nvmeq);
1153 if (hctx && hctx->tags)
1154 blk_mq_tag_busy_iter(hctx, nvme_cancel_queue_ios, nvmeq);
1155 spin_unlock_irq(&nvmeq->q_lock);
1158 static void nvme_disable_queue(struct nvme_dev *dev, int qid)
1160 struct nvme_queue *nvmeq = dev->queues[qid];
1164 if (nvme_suspend_queue(nvmeq))
1167 /* Don't tell the adapter to delete the admin queue.
1168 * Don't tell a removed adapter to delete IO queues. */
1169 if (qid && readl(&dev->bar->csts) != -1) {
1170 adapter_delete_sq(dev, qid);
1171 adapter_delete_cq(dev, qid);
1173 nvme_clear_queue(nvmeq);
1176 static struct nvme_queue *nvme_alloc_queue(struct nvme_dev *dev, int qid,
1177 int depth, int vector)
1179 struct device *dmadev = &dev->pci_dev->dev;
1180 struct nvme_queue *nvmeq = kzalloc(sizeof(*nvmeq), GFP_KERNEL);
1184 nvmeq->cqes = dma_zalloc_coherent(dmadev, CQ_SIZE(depth),
1185 &nvmeq->cq_dma_addr, GFP_KERNEL);
1189 nvmeq->sq_cmds = dma_alloc_coherent(dmadev, SQ_SIZE(depth),
1190 &nvmeq->sq_dma_addr, GFP_KERNEL);
1191 if (!nvmeq->sq_cmds)
1194 nvmeq->q_dmadev = dmadev;
1196 snprintf(nvmeq->irqname, sizeof(nvmeq->irqname), "nvme%dq%d",
1197 dev->instance, qid);
1198 spin_lock_init(&nvmeq->q_lock);
1200 nvmeq->cq_phase = 1;
1201 nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
1202 nvmeq->q_depth = depth;
1203 nvmeq->cq_vector = vector;
1206 dev->queues[qid] = nvmeq;
1211 dma_free_coherent(dmadev, CQ_SIZE(depth), (void *)nvmeq->cqes,
1212 nvmeq->cq_dma_addr);
1218 static int queue_request_irq(struct nvme_dev *dev, struct nvme_queue *nvmeq,
1221 if (use_threaded_interrupts)
1222 return request_threaded_irq(dev->entry[nvmeq->cq_vector].vector,
1223 nvme_irq_check, nvme_irq, IRQF_SHARED,
1225 return request_irq(dev->entry[nvmeq->cq_vector].vector, nvme_irq,
1226 IRQF_SHARED, name, nvmeq);
1229 static void nvme_init_queue(struct nvme_queue *nvmeq, u16 qid)
1231 struct nvme_dev *dev = nvmeq->dev;
1233 spin_lock_irq(&nvmeq->q_lock);
1236 nvmeq->cq_phase = 1;
1237 nvmeq->q_db = &dev->dbs[qid * 2 * dev->db_stride];
1238 memset((void *)nvmeq->cqes, 0, CQ_SIZE(nvmeq->q_depth));
1239 dev->online_queues++;
1240 spin_unlock_irq(&nvmeq->q_lock);
1243 static int nvme_create_queue(struct nvme_queue *nvmeq, int qid)
1245 struct nvme_dev *dev = nvmeq->dev;
1248 result = adapter_alloc_cq(dev, qid, nvmeq);
1252 result = adapter_alloc_sq(dev, qid, nvmeq);
1256 result = queue_request_irq(dev, nvmeq, nvmeq->irqname);
1260 nvme_init_queue(nvmeq, qid);
1264 adapter_delete_sq(dev, qid);
1266 adapter_delete_cq(dev, qid);
1270 static int nvme_wait_ready(struct nvme_dev *dev, u64 cap, bool enabled)
1272 unsigned long timeout;
1273 u32 bit = enabled ? NVME_CSTS_RDY : 0;
1275 timeout = ((NVME_CAP_TIMEOUT(cap) + 1) * HZ / 2) + jiffies;
1277 while ((readl(&dev->bar->csts) & NVME_CSTS_RDY) != bit) {
1279 if (fatal_signal_pending(current))
1281 if (time_after(jiffies, timeout)) {
1282 dev_err(&dev->pci_dev->dev,
1283 "Device not ready; aborting %s\n", enabled ?
1284 "initialisation" : "reset");
1293 * If the device has been passed off to us in an enabled state, just clear
1294 * the enabled bit. The spec says we should set the 'shutdown notification
1295 * bits', but doing so may cause the device to complete commands to the
1296 * admin queue ... and we don't know what memory that might be pointing at!
1298 static int nvme_disable_ctrl(struct nvme_dev *dev, u64 cap)
1300 dev->ctrl_config &= ~NVME_CC_SHN_MASK;
1301 dev->ctrl_config &= ~NVME_CC_ENABLE;
1302 writel(dev->ctrl_config, &dev->bar->cc);
1304 return nvme_wait_ready(dev, cap, false);
1307 static int nvme_enable_ctrl(struct nvme_dev *dev, u64 cap)
1309 dev->ctrl_config &= ~NVME_CC_SHN_MASK;
1310 dev->ctrl_config |= NVME_CC_ENABLE;
1311 writel(dev->ctrl_config, &dev->bar->cc);
1313 return nvme_wait_ready(dev, cap, true);
1316 static int nvme_shutdown_ctrl(struct nvme_dev *dev)
1318 unsigned long timeout;
1320 dev->ctrl_config &= ~NVME_CC_SHN_MASK;
1321 dev->ctrl_config |= NVME_CC_SHN_NORMAL;
1323 writel(dev->ctrl_config, &dev->bar->cc);
1325 timeout = SHUTDOWN_TIMEOUT + jiffies;
1326 while ((readl(&dev->bar->csts) & NVME_CSTS_SHST_MASK) !=
1327 NVME_CSTS_SHST_CMPLT) {
1329 if (fatal_signal_pending(current))
1331 if (time_after(jiffies, timeout)) {
1332 dev_err(&dev->pci_dev->dev,
1333 "Device shutdown incomplete; abort shutdown\n");
1341 static struct blk_mq_ops nvme_mq_admin_ops = {
1342 .queue_rq = nvme_admin_queue_rq,
1343 .map_queue = blk_mq_map_queue,
1344 .init_hctx = nvme_admin_init_hctx,
1345 .exit_hctx = nvme_exit_hctx,
1346 .init_request = nvme_admin_init_request,
1347 .timeout = nvme_timeout,
1350 static struct blk_mq_ops nvme_mq_ops = {
1351 .queue_rq = nvme_queue_rq,
1352 .map_queue = blk_mq_map_queue,
1353 .init_hctx = nvme_init_hctx,
1354 .exit_hctx = nvme_exit_hctx,
1355 .init_request = nvme_init_request,
1356 .timeout = nvme_timeout,
1359 static int nvme_alloc_admin_tags(struct nvme_dev *dev)
1361 if (!dev->admin_q) {
1362 dev->admin_tagset.ops = &nvme_mq_admin_ops;
1363 dev->admin_tagset.nr_hw_queues = 1;
1364 dev->admin_tagset.queue_depth = NVME_AQ_DEPTH - 1;
1365 dev->admin_tagset.timeout = ADMIN_TIMEOUT;
1366 dev->admin_tagset.numa_node = dev_to_node(&dev->pci_dev->dev);
1367 dev->admin_tagset.cmd_size = sizeof(struct nvme_cmd_info);
1368 dev->admin_tagset.driver_data = dev;
1370 if (blk_mq_alloc_tag_set(&dev->admin_tagset))
1373 dev->admin_q = blk_mq_init_queue(&dev->admin_tagset);
1374 if (!dev->admin_q) {
1375 blk_mq_free_tag_set(&dev->admin_tagset);
1383 static void nvme_free_admin_tags(struct nvme_dev *dev)
1386 blk_mq_free_tag_set(&dev->admin_tagset);
1389 static int nvme_configure_admin_queue(struct nvme_dev *dev)
1393 u64 cap = readq(&dev->bar->cap);
1394 struct nvme_queue *nvmeq;
1395 unsigned page_shift = PAGE_SHIFT;
1396 unsigned dev_page_min = NVME_CAP_MPSMIN(cap) + 12;
1397 unsigned dev_page_max = NVME_CAP_MPSMAX(cap) + 12;
1399 if (page_shift < dev_page_min) {
1400 dev_err(&dev->pci_dev->dev,
1401 "Minimum device page size (%u) too large for "
1402 "host (%u)\n", 1 << dev_page_min,
1406 if (page_shift > dev_page_max) {
1407 dev_info(&dev->pci_dev->dev,
1408 "Device maximum page size (%u) smaller than "
1409 "host (%u); enabling work-around\n",
1410 1 << dev_page_max, 1 << page_shift);
1411 page_shift = dev_page_max;
1414 result = nvme_disable_ctrl(dev, cap);
1418 nvmeq = dev->queues[0];
1420 nvmeq = nvme_alloc_queue(dev, 0, NVME_AQ_DEPTH, 0);
1425 aqa = nvmeq->q_depth - 1;
1428 dev->page_size = 1 << page_shift;
1430 dev->ctrl_config = NVME_CC_CSS_NVM;
1431 dev->ctrl_config |= (page_shift - 12) << NVME_CC_MPS_SHIFT;
1432 dev->ctrl_config |= NVME_CC_ARB_RR | NVME_CC_SHN_NONE;
1433 dev->ctrl_config |= NVME_CC_IOSQES | NVME_CC_IOCQES;
1435 writel(aqa, &dev->bar->aqa);
1436 writeq(nvmeq->sq_dma_addr, &dev->bar->asq);
1437 writeq(nvmeq->cq_dma_addr, &dev->bar->acq);
1439 result = nvme_enable_ctrl(dev, cap);
1443 result = nvme_alloc_admin_tags(dev);
1447 result = queue_request_irq(dev, nvmeq, nvmeq->irqname);
1454 nvme_free_admin_tags(dev);
1456 nvme_free_queues(dev, 0);
1460 struct nvme_iod *nvme_map_user_pages(struct nvme_dev *dev, int write,
1461 unsigned long addr, unsigned length)
1463 int i, err, count, nents, offset;
1464 struct scatterlist *sg;
1465 struct page **pages;
1466 struct nvme_iod *iod;
1469 return ERR_PTR(-EINVAL);
1470 if (!length || length > INT_MAX - PAGE_SIZE)
1471 return ERR_PTR(-EINVAL);
1473 offset = offset_in_page(addr);
1474 count = DIV_ROUND_UP(offset + length, PAGE_SIZE);
1475 pages = kcalloc(count, sizeof(*pages), GFP_KERNEL);
1477 return ERR_PTR(-ENOMEM);
1479 err = get_user_pages_fast(addr, count, 1, pages);
1487 iod = nvme_alloc_iod(count, length, dev, GFP_KERNEL);
1492 sg_init_table(sg, count);
1493 for (i = 0; i < count; i++) {
1494 sg_set_page(&sg[i], pages[i],
1495 min_t(unsigned, length, PAGE_SIZE - offset),
1497 length -= (PAGE_SIZE - offset);
1500 sg_mark_end(&sg[i - 1]);
1503 nents = dma_map_sg(&dev->pci_dev->dev, sg, count,
1504 write ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
1514 for (i = 0; i < count; i++)
1517 return ERR_PTR(err);
1520 void nvme_unmap_user_pages(struct nvme_dev *dev, int write,
1521 struct nvme_iod *iod)
1525 dma_unmap_sg(&dev->pci_dev->dev, iod->sg, iod->nents,
1526 write ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
1528 for (i = 0; i < iod->nents; i++)
1529 put_page(sg_page(&iod->sg[i]));
1532 static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
1534 struct nvme_dev *dev = ns->dev;
1535 struct nvme_user_io io;
1536 struct nvme_command c;
1537 unsigned length, meta_len;
1539 struct nvme_iod *iod, *meta_iod = NULL;
1540 dma_addr_t meta_dma_addr;
1541 void *meta, *uninitialized_var(meta_mem);
1543 if (copy_from_user(&io, uio, sizeof(io)))
1545 length = (io.nblocks + 1) << ns->lba_shift;
1546 meta_len = (io.nblocks + 1) * ns->ms;
1548 if (meta_len && ((io.metadata & 3) || !io.metadata))
1551 switch (io.opcode) {
1552 case nvme_cmd_write:
1554 case nvme_cmd_compare:
1555 iod = nvme_map_user_pages(dev, io.opcode & 1, io.addr, length);
1562 return PTR_ERR(iod);
1564 memset(&c, 0, sizeof(c));
1565 c.rw.opcode = io.opcode;
1566 c.rw.flags = io.flags;
1567 c.rw.nsid = cpu_to_le32(ns->ns_id);
1568 c.rw.slba = cpu_to_le64(io.slba);
1569 c.rw.length = cpu_to_le16(io.nblocks);
1570 c.rw.control = cpu_to_le16(io.control);
1571 c.rw.dsmgmt = cpu_to_le32(io.dsmgmt);
1572 c.rw.reftag = cpu_to_le32(io.reftag);
1573 c.rw.apptag = cpu_to_le16(io.apptag);
1574 c.rw.appmask = cpu_to_le16(io.appmask);
1577 meta_iod = nvme_map_user_pages(dev, io.opcode & 1, io.metadata,
1579 if (IS_ERR(meta_iod)) {
1580 status = PTR_ERR(meta_iod);
1585 meta_mem = dma_alloc_coherent(&dev->pci_dev->dev, meta_len,
1586 &meta_dma_addr, GFP_KERNEL);
1592 if (io.opcode & 1) {
1593 int meta_offset = 0;
1595 for (i = 0; i < meta_iod->nents; i++) {
1596 meta = kmap_atomic(sg_page(&meta_iod->sg[i])) +
1597 meta_iod->sg[i].offset;
1598 memcpy(meta_mem + meta_offset, meta,
1599 meta_iod->sg[i].length);
1600 kunmap_atomic(meta);
1601 meta_offset += meta_iod->sg[i].length;
1605 c.rw.metadata = cpu_to_le64(meta_dma_addr);
1608 length = nvme_setup_prps(dev, iod, length, GFP_KERNEL);
1609 c.rw.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
1610 c.rw.prp2 = cpu_to_le64(iod->first_dma);
1612 if (length != (io.nblocks + 1) << ns->lba_shift)
1615 status = nvme_submit_io_cmd(dev, ns, &c, NULL);
1618 if (status == NVME_SC_SUCCESS && !(io.opcode & 1)) {
1619 int meta_offset = 0;
1621 for (i = 0; i < meta_iod->nents; i++) {
1622 meta = kmap_atomic(sg_page(&meta_iod->sg[i])) +
1623 meta_iod->sg[i].offset;
1624 memcpy(meta, meta_mem + meta_offset,
1625 meta_iod->sg[i].length);
1626 kunmap_atomic(meta);
1627 meta_offset += meta_iod->sg[i].length;
1631 dma_free_coherent(&dev->pci_dev->dev, meta_len, meta_mem,
1636 nvme_unmap_user_pages(dev, io.opcode & 1, iod);
1637 nvme_free_iod(dev, iod);
1640 nvme_unmap_user_pages(dev, io.opcode & 1, meta_iod);
1641 nvme_free_iod(dev, meta_iod);
1647 static int nvme_user_cmd(struct nvme_dev *dev, struct nvme_ns *ns,
1648 struct nvme_passthru_cmd __user *ucmd)
1650 struct nvme_passthru_cmd cmd;
1651 struct nvme_command c;
1653 struct nvme_iod *uninitialized_var(iod);
1656 if (!capable(CAP_SYS_ADMIN))
1658 if (copy_from_user(&cmd, ucmd, sizeof(cmd)))
1661 memset(&c, 0, sizeof(c));
1662 c.common.opcode = cmd.opcode;
1663 c.common.flags = cmd.flags;
1664 c.common.nsid = cpu_to_le32(cmd.nsid);
1665 c.common.cdw2[0] = cpu_to_le32(cmd.cdw2);
1666 c.common.cdw2[1] = cpu_to_le32(cmd.cdw3);
1667 c.common.cdw10[0] = cpu_to_le32(cmd.cdw10);
1668 c.common.cdw10[1] = cpu_to_le32(cmd.cdw11);
1669 c.common.cdw10[2] = cpu_to_le32(cmd.cdw12);
1670 c.common.cdw10[3] = cpu_to_le32(cmd.cdw13);
1671 c.common.cdw10[4] = cpu_to_le32(cmd.cdw14);
1672 c.common.cdw10[5] = cpu_to_le32(cmd.cdw15);
1674 length = cmd.data_len;
1676 iod = nvme_map_user_pages(dev, cmd.opcode & 1, cmd.addr,
1679 return PTR_ERR(iod);
1680 length = nvme_setup_prps(dev, iod, length, GFP_KERNEL);
1681 c.common.prp1 = cpu_to_le64(sg_dma_address(iod->sg));
1682 c.common.prp2 = cpu_to_le64(iod->first_dma);
1685 timeout = cmd.timeout_ms ? msecs_to_jiffies(cmd.timeout_ms) :
1688 if (length != cmd.data_len)
1691 struct request *req;
1693 req = blk_mq_alloc_request(ns->queue, WRITE,
1694 (GFP_KERNEL|__GFP_WAIT), false);
1698 status = nvme_submit_sync_cmd(req, &c, &cmd.result,
1700 blk_mq_free_request(req);
1703 status = __nvme_submit_admin_cmd(dev, &c, &cmd.result, timeout);
1706 nvme_unmap_user_pages(dev, cmd.opcode & 1, iod);
1707 nvme_free_iod(dev, iod);
1710 if ((status >= 0) && copy_to_user(&ucmd->result, &cmd.result,
1711 sizeof(cmd.result)))
1717 static int nvme_ioctl(struct block_device *bdev, fmode_t mode, unsigned int cmd,
1720 struct nvme_ns *ns = bdev->bd_disk->private_data;
1724 force_successful_syscall_return();
1726 case NVME_IOCTL_ADMIN_CMD:
1727 return nvme_user_cmd(ns->dev, NULL, (void __user *)arg);
1728 case NVME_IOCTL_IO_CMD:
1729 return nvme_user_cmd(ns->dev, ns, (void __user *)arg);
1730 case NVME_IOCTL_SUBMIT_IO:
1731 return nvme_submit_io(ns, (void __user *)arg);
1732 case SG_GET_VERSION_NUM:
1733 return nvme_sg_get_version_num((void __user *)arg);
1735 return nvme_sg_io(ns, (void __user *)arg);
1741 #ifdef CONFIG_COMPAT
1742 static int nvme_compat_ioctl(struct block_device *bdev, fmode_t mode,
1743 unsigned int cmd, unsigned long arg)
1747 return -ENOIOCTLCMD;
1749 return nvme_ioctl(bdev, mode, cmd, arg);
1752 #define nvme_compat_ioctl NULL
1755 static int nvme_open(struct block_device *bdev, fmode_t mode)
1760 spin_lock(&dev_list_lock);
1761 ns = bdev->bd_disk->private_data;
1764 else if (!kref_get_unless_zero(&ns->dev->kref))
1766 spin_unlock(&dev_list_lock);
1771 static void nvme_free_dev(struct kref *kref);
1773 static void nvme_release(struct gendisk *disk, fmode_t mode)
1775 struct nvme_ns *ns = disk->private_data;
1776 struct nvme_dev *dev = ns->dev;
1778 kref_put(&dev->kref, nvme_free_dev);
1781 static int nvme_getgeo(struct block_device *bd, struct hd_geometry *geo)
1783 /* some standard values */
1784 geo->heads = 1 << 6;
1785 geo->sectors = 1 << 5;
1786 geo->cylinders = get_capacity(bd->bd_disk) >> 11;
1790 static int nvme_revalidate_disk(struct gendisk *disk)
1792 struct nvme_ns *ns = disk->private_data;
1793 struct nvme_dev *dev = ns->dev;
1794 struct nvme_id_ns *id;
1795 dma_addr_t dma_addr;
1798 id = dma_alloc_coherent(&dev->pci_dev->dev, 4096, &dma_addr,
1801 dev_warn(&dev->pci_dev->dev, "%s: Memory alocation failure\n",
1806 if (nvme_identify(dev, ns->ns_id, 0, dma_addr))
1809 lbaf = id->flbas & 0xf;
1810 ns->lba_shift = id->lbaf[lbaf].ds;
1812 blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
1813 set_capacity(disk, le64_to_cpup(&id->nsze) << (ns->lba_shift - 9));
1815 dma_free_coherent(&dev->pci_dev->dev, 4096, id, dma_addr);
1819 static const struct block_device_operations nvme_fops = {
1820 .owner = THIS_MODULE,
1821 .ioctl = nvme_ioctl,
1822 .compat_ioctl = nvme_compat_ioctl,
1824 .release = nvme_release,
1825 .getgeo = nvme_getgeo,
1826 .revalidate_disk= nvme_revalidate_disk,
1829 static int nvme_kthread(void *data)
1831 struct nvme_dev *dev, *next;
1833 while (!kthread_should_stop()) {
1834 set_current_state(TASK_INTERRUPTIBLE);
1835 spin_lock(&dev_list_lock);
1836 list_for_each_entry_safe(dev, next, &dev_list, node) {
1838 if (readl(&dev->bar->csts) & NVME_CSTS_CFS &&
1840 if (work_busy(&dev->reset_work))
1842 list_del_init(&dev->node);
1843 dev_warn(&dev->pci_dev->dev,
1844 "Failed status: %x, reset controller\n",
1845 readl(&dev->bar->csts));
1846 dev->reset_workfn = nvme_reset_failed_dev;
1847 queue_work(nvme_workq, &dev->reset_work);
1850 for (i = 0; i < dev->queue_count; i++) {
1851 struct nvme_queue *nvmeq = dev->queues[i];
1854 spin_lock_irq(&nvmeq->q_lock);
1855 nvme_process_cq(nvmeq);
1857 while ((i == 0) && (dev->event_limit > 0)) {
1858 if (nvme_submit_async_admin_req(dev))
1862 spin_unlock_irq(&nvmeq->q_lock);
1865 spin_unlock(&dev_list_lock);
1866 schedule_timeout(round_jiffies_relative(HZ));
1871 static void nvme_config_discard(struct nvme_ns *ns)
1873 u32 logical_block_size = queue_logical_block_size(ns->queue);
1874 ns->queue->limits.discard_zeroes_data = 0;
1875 ns->queue->limits.discard_alignment = logical_block_size;
1876 ns->queue->limits.discard_granularity = logical_block_size;
1877 ns->queue->limits.max_discard_sectors = 0xffffffff;
1878 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, ns->queue);
1881 static struct nvme_ns *nvme_alloc_ns(struct nvme_dev *dev, unsigned nsid,
1882 struct nvme_id_ns *id, struct nvme_lba_range_type *rt)
1885 struct gendisk *disk;
1886 int node = dev_to_node(&dev->pci_dev->dev);
1889 if (rt->attributes & NVME_LBART_ATTRIB_HIDE)
1892 ns = kzalloc_node(sizeof(*ns), GFP_KERNEL, node);
1895 ns->queue = blk_mq_init_queue(&dev->tagset);
1896 if (IS_ERR(ns->queue))
1898 queue_flag_set_unlocked(QUEUE_FLAG_NOMERGES, ns->queue);
1899 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, ns->queue);
1900 queue_flag_set_unlocked(QUEUE_FLAG_SG_GAPS, ns->queue);
1902 ns->queue->queuedata = ns;
1904 disk = alloc_disk_node(0, node);
1906 goto out_free_queue;
1910 lbaf = id->flbas & 0xf;
1911 ns->lba_shift = id->lbaf[lbaf].ds;
1912 ns->ms = le16_to_cpu(id->lbaf[lbaf].ms);
1913 blk_queue_logical_block_size(ns->queue, 1 << ns->lba_shift);
1914 if (dev->max_hw_sectors)
1915 blk_queue_max_hw_sectors(ns->queue, dev->max_hw_sectors);
1916 if (dev->stripe_size)
1917 blk_queue_chunk_sectors(ns->queue, dev->stripe_size >> 9);
1918 if (dev->vwc & NVME_CTRL_VWC_PRESENT)
1919 blk_queue_flush(ns->queue, REQ_FLUSH | REQ_FUA);
1921 disk->major = nvme_major;
1922 disk->first_minor = 0;
1923 disk->fops = &nvme_fops;
1924 disk->private_data = ns;
1925 disk->queue = ns->queue;
1926 disk->driverfs_dev = &dev->pci_dev->dev;
1927 disk->flags = GENHD_FL_EXT_DEVT;
1928 sprintf(disk->disk_name, "nvme%dn%d", dev->instance, nsid);
1929 set_capacity(disk, le64_to_cpup(&id->nsze) << (ns->lba_shift - 9));
1931 if (dev->oncs & NVME_CTRL_ONCS_DSM)
1932 nvme_config_discard(ns);
1937 blk_cleanup_queue(ns->queue);
1943 static void nvme_create_io_queues(struct nvme_dev *dev)
1947 for (i = dev->queue_count; i <= dev->max_qid; i++)
1948 if (!nvme_alloc_queue(dev, i, dev->q_depth, i - 1))
1951 for (i = dev->online_queues; i <= dev->queue_count - 1; i++)
1952 if (nvme_create_queue(dev->queues[i], i))
1956 static int set_queue_count(struct nvme_dev *dev, int count)
1960 u32 q_count = (count - 1) | ((count - 1) << 16);
1962 status = nvme_set_features(dev, NVME_FEAT_NUM_QUEUES, q_count, 0,
1967 dev_err(&dev->pci_dev->dev, "Could not set queue count (%d)\n",
1971 return min(result & 0xffff, result >> 16) + 1;
1974 static size_t db_bar_size(struct nvme_dev *dev, unsigned nr_io_queues)
1976 return 4096 + ((nr_io_queues + 1) * 8 * dev->db_stride);
1979 static int nvme_setup_io_queues(struct nvme_dev *dev)
1981 struct nvme_queue *adminq = dev->queues[0];
1982 struct pci_dev *pdev = dev->pci_dev;
1983 int result, i, vecs, nr_io_queues, size;
1985 nr_io_queues = num_possible_cpus();
1986 result = set_queue_count(dev, nr_io_queues);
1989 if (result < nr_io_queues)
1990 nr_io_queues = result;
1992 size = db_bar_size(dev, nr_io_queues);
1996 dev->bar = ioremap(pci_resource_start(pdev, 0), size);
1999 if (!--nr_io_queues)
2001 size = db_bar_size(dev, nr_io_queues);
2003 dev->dbs = ((void __iomem *)dev->bar) + 4096;
2004 adminq->q_db = dev->dbs;
2007 /* Deregister the admin queue's interrupt */
2008 free_irq(dev->entry[0].vector, adminq);
2011 * If we enable msix early due to not intx, disable it again before
2012 * setting up the full range we need.
2015 pci_disable_msix(pdev);
2017 for (i = 0; i < nr_io_queues; i++)
2018 dev->entry[i].entry = i;
2019 vecs = pci_enable_msix_range(pdev, dev->entry, 1, nr_io_queues);
2021 vecs = pci_enable_msi_range(pdev, 1, min(nr_io_queues, 32));
2025 for (i = 0; i < vecs; i++)
2026 dev->entry[i].vector = i + pdev->irq;
2031 * Should investigate if there's a performance win from allocating
2032 * more queues than interrupt vectors; it might allow the submission
2033 * path to scale better, even if the receive path is limited by the
2034 * number of interrupts.
2036 nr_io_queues = vecs;
2037 dev->max_qid = nr_io_queues;
2039 result = queue_request_irq(dev, adminq, adminq->irqname);
2043 /* Free previously allocated queues that are no longer usable */
2044 nvme_free_queues(dev, nr_io_queues + 1);
2045 nvme_create_io_queues(dev);
2050 nvme_free_queues(dev, 1);
2055 * Return: error value if an error occurred setting up the queues or calling
2056 * Identify Device. 0 if these succeeded, even if adding some of the
2057 * namespaces failed. At the moment, these failures are silent. TBD which
2058 * failures should be reported.
2060 static int nvme_dev_add(struct nvme_dev *dev)
2062 struct pci_dev *pdev = dev->pci_dev;
2066 struct nvme_id_ctrl *ctrl;
2067 struct nvme_id_ns *id_ns;
2069 dma_addr_t dma_addr;
2070 int shift = NVME_CAP_MPSMIN(readq(&dev->bar->cap)) + 12;
2072 mem = dma_alloc_coherent(&pdev->dev, 8192, &dma_addr, GFP_KERNEL);
2076 res = nvme_identify(dev, 0, 1, dma_addr);
2078 dev_err(&pdev->dev, "Identify Controller failed (%d)\n", res);
2084 nn = le32_to_cpup(&ctrl->nn);
2085 dev->oncs = le16_to_cpup(&ctrl->oncs);
2086 dev->abort_limit = ctrl->acl + 1;
2087 dev->vwc = ctrl->vwc;
2088 dev->event_limit = min(ctrl->aerl + 1, 8);
2089 memcpy(dev->serial, ctrl->sn, sizeof(ctrl->sn));
2090 memcpy(dev->model, ctrl->mn, sizeof(ctrl->mn));
2091 memcpy(dev->firmware_rev, ctrl->fr, sizeof(ctrl->fr));
2093 dev->max_hw_sectors = 1 << (ctrl->mdts + shift - 9);
2094 if ((pdev->vendor == PCI_VENDOR_ID_INTEL) &&
2095 (pdev->device == 0x0953) && ctrl->vs[3]) {
2096 unsigned int max_hw_sectors;
2098 dev->stripe_size = 1 << (ctrl->vs[3] + shift);
2099 max_hw_sectors = dev->stripe_size >> (shift - 9);
2100 if (dev->max_hw_sectors) {
2101 dev->max_hw_sectors = min(max_hw_sectors,
2102 dev->max_hw_sectors);
2104 dev->max_hw_sectors = max_hw_sectors;
2107 dev->tagset.ops = &nvme_mq_ops;
2108 dev->tagset.nr_hw_queues = dev->online_queues - 1;
2109 dev->tagset.timeout = NVME_IO_TIMEOUT;
2110 dev->tagset.numa_node = dev_to_node(&dev->pci_dev->dev);
2111 dev->tagset.queue_depth =
2112 min_t(int, dev->q_depth, BLK_MQ_MAX_DEPTH) - 1;
2113 dev->tagset.cmd_size = sizeof(struct nvme_cmd_info);
2114 dev->tagset.flags = BLK_MQ_F_SHOULD_MERGE;
2115 dev->tagset.driver_data = dev;
2117 if (blk_mq_alloc_tag_set(&dev->tagset))
2121 for (i = 1; i <= nn; i++) {
2122 res = nvme_identify(dev, i, 0, dma_addr);
2126 if (id_ns->ncap == 0)
2129 res = nvme_get_features(dev, NVME_FEAT_LBA_RANGE, i,
2130 dma_addr + 4096, NULL);
2132 memset(mem + 4096, 0, 4096);
2134 ns = nvme_alloc_ns(dev, i, mem, mem + 4096);
2136 list_add_tail(&ns->list, &dev->namespaces);
2138 list_for_each_entry(ns, &dev->namespaces, list)
2143 dma_free_coherent(&dev->pci_dev->dev, 8192, mem, dma_addr);
2147 static int nvme_dev_map(struct nvme_dev *dev)
2150 int bars, result = -ENOMEM;
2151 struct pci_dev *pdev = dev->pci_dev;
2153 if (pci_enable_device_mem(pdev))
2156 dev->entry[0].vector = pdev->irq;
2157 pci_set_master(pdev);
2158 bars = pci_select_bars(pdev, IORESOURCE_MEM);
2162 if (pci_request_selected_regions(pdev, bars, "nvme"))
2165 if (dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64)) &&
2166 dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32)))
2169 dev->bar = ioremap(pci_resource_start(pdev, 0), 8192);
2173 if (readl(&dev->bar->csts) == -1) {
2179 * Some devices don't advertse INTx interrupts, pre-enable a single
2180 * MSIX vec for setup. We'll adjust this later.
2183 result = pci_enable_msix(pdev, dev->entry, 1);
2188 cap = readq(&dev->bar->cap);
2189 dev->q_depth = min_t(int, NVME_CAP_MQES(cap) + 1, NVME_Q_DEPTH);
2190 dev->db_stride = 1 << NVME_CAP_STRIDE(cap);
2191 dev->dbs = ((void __iomem *)dev->bar) + 4096;
2199 pci_release_regions(pdev);
2201 pci_disable_device(pdev);
2205 static void nvme_dev_unmap(struct nvme_dev *dev)
2207 if (dev->pci_dev->msi_enabled)
2208 pci_disable_msi(dev->pci_dev);
2209 else if (dev->pci_dev->msix_enabled)
2210 pci_disable_msix(dev->pci_dev);
2215 pci_release_regions(dev->pci_dev);
2218 if (pci_is_enabled(dev->pci_dev))
2219 pci_disable_device(dev->pci_dev);
2222 struct nvme_delq_ctx {
2223 struct task_struct *waiter;
2224 struct kthread_worker *worker;
2228 static void nvme_wait_dq(struct nvme_delq_ctx *dq, struct nvme_dev *dev)
2230 dq->waiter = current;
2234 set_current_state(TASK_KILLABLE);
2235 if (!atomic_read(&dq->refcount))
2237 if (!schedule_timeout(ADMIN_TIMEOUT) ||
2238 fatal_signal_pending(current)) {
2239 set_current_state(TASK_RUNNING);
2241 nvme_disable_ctrl(dev, readq(&dev->bar->cap));
2242 nvme_disable_queue(dev, 0);
2244 send_sig(SIGKILL, dq->worker->task, 1);
2245 flush_kthread_worker(dq->worker);
2249 set_current_state(TASK_RUNNING);
2252 static void nvme_put_dq(struct nvme_delq_ctx *dq)
2254 atomic_dec(&dq->refcount);
2256 wake_up_process(dq->waiter);
2259 static struct nvme_delq_ctx *nvme_get_dq(struct nvme_delq_ctx *dq)
2261 atomic_inc(&dq->refcount);
2265 static void nvme_del_queue_end(struct nvme_queue *nvmeq)
2267 struct nvme_delq_ctx *dq = nvmeq->cmdinfo.ctx;
2269 nvme_clear_queue(nvmeq);
2273 static int adapter_async_del_queue(struct nvme_queue *nvmeq, u8 opcode,
2274 kthread_work_func_t fn)
2276 struct nvme_command c;
2278 memset(&c, 0, sizeof(c));
2279 c.delete_queue.opcode = opcode;
2280 c.delete_queue.qid = cpu_to_le16(nvmeq->qid);
2282 init_kthread_work(&nvmeq->cmdinfo.work, fn);
2283 return nvme_submit_admin_async_cmd(nvmeq->dev, &c, &nvmeq->cmdinfo,
2287 static void nvme_del_cq_work_handler(struct kthread_work *work)
2289 struct nvme_queue *nvmeq = container_of(work, struct nvme_queue,
2291 nvme_del_queue_end(nvmeq);
2294 static int nvme_delete_cq(struct nvme_queue *nvmeq)
2296 return adapter_async_del_queue(nvmeq, nvme_admin_delete_cq,
2297 nvme_del_cq_work_handler);
2300 static void nvme_del_sq_work_handler(struct kthread_work *work)
2302 struct nvme_queue *nvmeq = container_of(work, struct nvme_queue,
2304 int status = nvmeq->cmdinfo.status;
2307 status = nvme_delete_cq(nvmeq);
2309 nvme_del_queue_end(nvmeq);
2312 static int nvme_delete_sq(struct nvme_queue *nvmeq)
2314 return adapter_async_del_queue(nvmeq, nvme_admin_delete_sq,
2315 nvme_del_sq_work_handler);
2318 static void nvme_del_queue_start(struct kthread_work *work)
2320 struct nvme_queue *nvmeq = container_of(work, struct nvme_queue,
2322 allow_signal(SIGKILL);
2323 if (nvme_delete_sq(nvmeq))
2324 nvme_del_queue_end(nvmeq);
2327 static void nvme_disable_io_queues(struct nvme_dev *dev)
2330 DEFINE_KTHREAD_WORKER_ONSTACK(worker);
2331 struct nvme_delq_ctx dq;
2332 struct task_struct *kworker_task = kthread_run(kthread_worker_fn,
2333 &worker, "nvme%d", dev->instance);
2335 if (IS_ERR(kworker_task)) {
2336 dev_err(&dev->pci_dev->dev,
2337 "Failed to create queue del task\n");
2338 for (i = dev->queue_count - 1; i > 0; i--)
2339 nvme_disable_queue(dev, i);
2344 atomic_set(&dq.refcount, 0);
2345 dq.worker = &worker;
2346 for (i = dev->queue_count - 1; i > 0; i--) {
2347 struct nvme_queue *nvmeq = dev->queues[i];
2349 if (nvme_suspend_queue(nvmeq))
2351 nvmeq->cmdinfo.ctx = nvme_get_dq(&dq);
2352 nvmeq->cmdinfo.worker = dq.worker;
2353 init_kthread_work(&nvmeq->cmdinfo.work, nvme_del_queue_start);
2354 queue_kthread_work(dq.worker, &nvmeq->cmdinfo.work);
2356 nvme_wait_dq(&dq, dev);
2357 kthread_stop(kworker_task);
2361 * Remove the node from the device list and check
2362 * for whether or not we need to stop the nvme_thread.
2364 static void nvme_dev_list_remove(struct nvme_dev *dev)
2366 struct task_struct *tmp = NULL;
2368 spin_lock(&dev_list_lock);
2369 list_del_init(&dev->node);
2370 if (list_empty(&dev_list) && !IS_ERR_OR_NULL(nvme_thread)) {
2374 spin_unlock(&dev_list_lock);
2380 static void nvme_dev_shutdown(struct nvme_dev *dev)
2385 dev->initialized = 0;
2386 nvme_dev_list_remove(dev);
2389 csts = readl(&dev->bar->csts);
2390 if (csts & NVME_CSTS_CFS || !(csts & NVME_CSTS_RDY)) {
2391 for (i = dev->queue_count - 1; i >= 0; i--) {
2392 struct nvme_queue *nvmeq = dev->queues[i];
2393 nvme_suspend_queue(nvmeq);
2394 nvme_clear_queue(nvmeq);
2397 nvme_disable_io_queues(dev);
2398 nvme_shutdown_ctrl(dev);
2399 nvme_disable_queue(dev, 0);
2401 nvme_dev_unmap(dev);
2404 static void nvme_dev_remove_admin(struct nvme_dev *dev)
2406 if (dev->admin_q && !blk_queue_dying(dev->admin_q))
2407 blk_cleanup_queue(dev->admin_q);
2410 static void nvme_dev_remove(struct nvme_dev *dev)
2414 list_for_each_entry(ns, &dev->namespaces, list) {
2415 if (ns->disk->flags & GENHD_FL_UP)
2416 del_gendisk(ns->disk);
2417 if (!blk_queue_dying(ns->queue))
2418 blk_cleanup_queue(ns->queue);
2422 static int nvme_setup_prp_pools(struct nvme_dev *dev)
2424 struct device *dmadev = &dev->pci_dev->dev;
2425 dev->prp_page_pool = dma_pool_create("prp list page", dmadev,
2426 PAGE_SIZE, PAGE_SIZE, 0);
2427 if (!dev->prp_page_pool)
2430 /* Optimisation for I/Os between 4k and 128k */
2431 dev->prp_small_pool = dma_pool_create("prp list 256", dmadev,
2433 if (!dev->prp_small_pool) {
2434 dma_pool_destroy(dev->prp_page_pool);
2440 static void nvme_release_prp_pools(struct nvme_dev *dev)
2442 dma_pool_destroy(dev->prp_page_pool);
2443 dma_pool_destroy(dev->prp_small_pool);
2446 static DEFINE_IDA(nvme_instance_ida);
2448 static int nvme_set_instance(struct nvme_dev *dev)
2450 int instance, error;
2453 if (!ida_pre_get(&nvme_instance_ida, GFP_KERNEL))
2456 spin_lock(&dev_list_lock);
2457 error = ida_get_new(&nvme_instance_ida, &instance);
2458 spin_unlock(&dev_list_lock);
2459 } while (error == -EAGAIN);
2464 dev->instance = instance;
2468 static void nvme_release_instance(struct nvme_dev *dev)
2470 spin_lock(&dev_list_lock);
2471 ida_remove(&nvme_instance_ida, dev->instance);
2472 spin_unlock(&dev_list_lock);
2475 static void nvme_free_namespaces(struct nvme_dev *dev)
2477 struct nvme_ns *ns, *next;
2479 list_for_each_entry_safe(ns, next, &dev->namespaces, list) {
2480 list_del(&ns->list);
2482 spin_lock(&dev_list_lock);
2483 ns->disk->private_data = NULL;
2484 spin_unlock(&dev_list_lock);
2491 static void nvme_free_dev(struct kref *kref)
2493 struct nvme_dev *dev = container_of(kref, struct nvme_dev, kref);
2495 pci_dev_put(dev->pci_dev);
2496 nvme_free_namespaces(dev);
2497 blk_mq_free_tag_set(&dev->tagset);
2503 static int nvme_dev_open(struct inode *inode, struct file *f)
2505 struct nvme_dev *dev = container_of(f->private_data, struct nvme_dev,
2507 kref_get(&dev->kref);
2508 f->private_data = dev;
2512 static int nvme_dev_release(struct inode *inode, struct file *f)
2514 struct nvme_dev *dev = f->private_data;
2515 kref_put(&dev->kref, nvme_free_dev);
2519 static long nvme_dev_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
2521 struct nvme_dev *dev = f->private_data;
2525 case NVME_IOCTL_ADMIN_CMD:
2526 return nvme_user_cmd(dev, NULL, (void __user *)arg);
2527 case NVME_IOCTL_IO_CMD:
2528 if (list_empty(&dev->namespaces))
2530 ns = list_first_entry(&dev->namespaces, struct nvme_ns, list);
2531 return nvme_user_cmd(dev, ns, (void __user *)arg);
2537 static const struct file_operations nvme_dev_fops = {
2538 .owner = THIS_MODULE,
2539 .open = nvme_dev_open,
2540 .release = nvme_dev_release,
2541 .unlocked_ioctl = nvme_dev_ioctl,
2542 .compat_ioctl = nvme_dev_ioctl,
2545 static void nvme_set_irq_hints(struct nvme_dev *dev)
2547 struct nvme_queue *nvmeq;
2550 for (i = 0; i < dev->online_queues; i++) {
2551 nvmeq = dev->queues[i];
2556 irq_set_affinity_hint(dev->entry[nvmeq->cq_vector].vector,
2557 nvmeq->hctx->cpumask);
2561 static int nvme_dev_start(struct nvme_dev *dev)
2564 bool start_thread = false;
2566 result = nvme_dev_map(dev);
2570 result = nvme_configure_admin_queue(dev);
2574 spin_lock(&dev_list_lock);
2575 if (list_empty(&dev_list) && IS_ERR_OR_NULL(nvme_thread)) {
2576 start_thread = true;
2579 list_add(&dev->node, &dev_list);
2580 spin_unlock(&dev_list_lock);
2583 nvme_thread = kthread_run(nvme_kthread, NULL, "nvme");
2584 wake_up_all(&nvme_kthread_wait);
2586 wait_event_killable(nvme_kthread_wait, nvme_thread);
2588 if (IS_ERR_OR_NULL(nvme_thread)) {
2589 result = nvme_thread ? PTR_ERR(nvme_thread) : -EINTR;
2593 nvme_init_queue(dev->queues[0], 0);
2595 result = nvme_setup_io_queues(dev);
2599 nvme_set_irq_hints(dev);
2604 nvme_disable_queue(dev, 0);
2605 nvme_dev_list_remove(dev);
2607 nvme_dev_unmap(dev);
2611 static int nvme_remove_dead_ctrl(void *arg)
2613 struct nvme_dev *dev = (struct nvme_dev *)arg;
2614 struct pci_dev *pdev = dev->pci_dev;
2616 if (pci_get_drvdata(pdev))
2617 pci_stop_and_remove_bus_device_locked(pdev);
2618 kref_put(&dev->kref, nvme_free_dev);
2622 static void nvme_remove_disks(struct work_struct *ws)
2624 struct nvme_dev *dev = container_of(ws, struct nvme_dev, reset_work);
2626 nvme_free_queues(dev, 1);
2627 nvme_dev_remove(dev);
2630 static int nvme_dev_resume(struct nvme_dev *dev)
2634 ret = nvme_dev_start(dev);
2637 if (dev->online_queues < 2) {
2638 spin_lock(&dev_list_lock);
2639 dev->reset_workfn = nvme_remove_disks;
2640 queue_work(nvme_workq, &dev->reset_work);
2641 spin_unlock(&dev_list_lock);
2643 dev->initialized = 1;
2647 static void nvme_dev_reset(struct nvme_dev *dev)
2649 nvme_dev_shutdown(dev);
2650 if (nvme_dev_resume(dev)) {
2651 dev_warn(&dev->pci_dev->dev, "Device failed to resume\n");
2652 kref_get(&dev->kref);
2653 if (IS_ERR(kthread_run(nvme_remove_dead_ctrl, dev, "nvme%d",
2655 dev_err(&dev->pci_dev->dev,
2656 "Failed to start controller remove task\n");
2657 kref_put(&dev->kref, nvme_free_dev);
2662 static void nvme_reset_failed_dev(struct work_struct *ws)
2664 struct nvme_dev *dev = container_of(ws, struct nvme_dev, reset_work);
2665 nvme_dev_reset(dev);
2668 static void nvme_reset_workfn(struct work_struct *work)
2670 struct nvme_dev *dev = container_of(work, struct nvme_dev, reset_work);
2671 dev->reset_workfn(work);
2674 static int nvme_probe(struct pci_dev *pdev, const struct pci_device_id *id)
2676 int node, result = -ENOMEM;
2677 struct nvme_dev *dev;
2679 node = dev_to_node(&pdev->dev);
2680 if (node == NUMA_NO_NODE)
2681 set_dev_node(&pdev->dev, 0);
2683 dev = kzalloc_node(sizeof(*dev), GFP_KERNEL, node);
2686 dev->entry = kzalloc_node(num_possible_cpus() * sizeof(*dev->entry),
2690 dev->queues = kzalloc_node((num_possible_cpus() + 1) * sizeof(void *),
2695 INIT_LIST_HEAD(&dev->namespaces);
2696 dev->reset_workfn = nvme_reset_failed_dev;
2697 INIT_WORK(&dev->reset_work, nvme_reset_workfn);
2698 dev->pci_dev = pci_dev_get(pdev);
2699 pci_set_drvdata(pdev, dev);
2700 result = nvme_set_instance(dev);
2704 result = nvme_setup_prp_pools(dev);
2708 kref_init(&dev->kref);
2709 result = nvme_dev_start(dev);
2713 if (dev->online_queues > 1)
2714 result = nvme_dev_add(dev);
2718 scnprintf(dev->name, sizeof(dev->name), "nvme%d", dev->instance);
2719 dev->miscdev.minor = MISC_DYNAMIC_MINOR;
2720 dev->miscdev.parent = &pdev->dev;
2721 dev->miscdev.name = dev->name;
2722 dev->miscdev.fops = &nvme_dev_fops;
2723 result = misc_register(&dev->miscdev);
2727 nvme_set_irq_hints(dev);
2729 dev->initialized = 1;
2733 nvme_dev_remove(dev);
2734 nvme_dev_remove_admin(dev);
2735 nvme_free_namespaces(dev);
2737 nvme_dev_shutdown(dev);
2739 nvme_free_queues(dev, 0);
2740 nvme_release_prp_pools(dev);
2742 nvme_release_instance(dev);
2744 pci_dev_put(dev->pci_dev);
2752 static void nvme_reset_notify(struct pci_dev *pdev, bool prepare)
2754 struct nvme_dev *dev = pci_get_drvdata(pdev);
2757 nvme_dev_shutdown(dev);
2759 nvme_dev_resume(dev);
2762 static void nvme_shutdown(struct pci_dev *pdev)
2764 struct nvme_dev *dev = pci_get_drvdata(pdev);
2765 nvme_dev_shutdown(dev);
2768 static void nvme_remove(struct pci_dev *pdev)
2770 struct nvme_dev *dev = pci_get_drvdata(pdev);
2772 spin_lock(&dev_list_lock);
2773 list_del_init(&dev->node);
2774 spin_unlock(&dev_list_lock);
2776 pci_set_drvdata(pdev, NULL);
2777 flush_work(&dev->reset_work);
2778 misc_deregister(&dev->miscdev);
2779 nvme_dev_remove(dev);
2780 nvme_dev_shutdown(dev);
2781 nvme_dev_remove_admin(dev);
2782 nvme_free_queues(dev, 0);
2783 nvme_free_admin_tags(dev);
2784 nvme_release_instance(dev);
2785 nvme_release_prp_pools(dev);
2786 kref_put(&dev->kref, nvme_free_dev);
2789 /* These functions are yet to be implemented */
2790 #define nvme_error_detected NULL
2791 #define nvme_dump_registers NULL
2792 #define nvme_link_reset NULL
2793 #define nvme_slot_reset NULL
2794 #define nvme_error_resume NULL
2796 #ifdef CONFIG_PM_SLEEP
2797 static int nvme_suspend(struct device *dev)
2799 struct pci_dev *pdev = to_pci_dev(dev);
2800 struct nvme_dev *ndev = pci_get_drvdata(pdev);
2802 nvme_dev_shutdown(ndev);
2806 static int nvme_resume(struct device *dev)
2808 struct pci_dev *pdev = to_pci_dev(dev);
2809 struct nvme_dev *ndev = pci_get_drvdata(pdev);
2811 if (nvme_dev_resume(ndev) && !work_busy(&ndev->reset_work)) {
2812 ndev->reset_workfn = nvme_reset_failed_dev;
2813 queue_work(nvme_workq, &ndev->reset_work);
2819 static SIMPLE_DEV_PM_OPS(nvme_dev_pm_ops, nvme_suspend, nvme_resume);
2821 static const struct pci_error_handlers nvme_err_handler = {
2822 .error_detected = nvme_error_detected,
2823 .mmio_enabled = nvme_dump_registers,
2824 .link_reset = nvme_link_reset,
2825 .slot_reset = nvme_slot_reset,
2826 .resume = nvme_error_resume,
2827 .reset_notify = nvme_reset_notify,
2830 /* Move to pci_ids.h later */
2831 #define PCI_CLASS_STORAGE_EXPRESS 0x010802
2833 static const struct pci_device_id nvme_id_table[] = {
2834 { PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) },
2837 MODULE_DEVICE_TABLE(pci, nvme_id_table);
2839 static struct pci_driver nvme_driver = {
2841 .id_table = nvme_id_table,
2842 .probe = nvme_probe,
2843 .remove = nvme_remove,
2844 .shutdown = nvme_shutdown,
2846 .pm = &nvme_dev_pm_ops,
2848 .err_handler = &nvme_err_handler,
2851 static int __init nvme_init(void)
2855 init_waitqueue_head(&nvme_kthread_wait);
2857 nvme_workq = create_singlethread_workqueue("nvme");
2861 result = register_blkdev(nvme_major, "nvme");
2864 else if (result > 0)
2865 nvme_major = result;
2867 result = pci_register_driver(&nvme_driver);
2869 goto unregister_blkdev;
2873 unregister_blkdev(nvme_major, "nvme");
2875 destroy_workqueue(nvme_workq);
2879 static void __exit nvme_exit(void)
2881 pci_unregister_driver(&nvme_driver);
2882 unregister_hotcpu_notifier(&nvme_nb);
2883 unregister_blkdev(nvme_major, "nvme");
2884 destroy_workqueue(nvme_workq);
2885 BUG_ON(nvme_thread && !IS_ERR(nvme_thread));
2889 MODULE_AUTHOR("Matthew Wilcox <willy@linux.intel.com>");
2890 MODULE_LICENSE("GPL");
2891 MODULE_VERSION("0.9");
2892 module_init(nvme_init);
2893 module_exit(nvme_exit);