2 * NVM Express device driver
3 * Copyright (c) 2011, 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
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 #include <linux/nvme.h>
20 #include <linux/bio.h>
21 #include <linux/blkdev.h>
22 #include <linux/errno.h>
24 #include <linux/genhd.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
28 #include <linux/kdev_t.h>
29 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/moduleparam.h>
33 #include <linux/pci.h>
34 #include <linux/poison.h>
35 #include <linux/sched.h>
36 #include <linux/slab.h>
37 #include <linux/types.h>
38 #include <linux/version.h>
40 #define NVME_Q_DEPTH 1024
41 #define SQ_SIZE(depth) (depth * sizeof(struct nvme_command))
42 #define CQ_SIZE(depth) (depth * sizeof(struct nvme_completion))
43 #define NVME_MINORS 64
45 static int nvme_major;
46 module_param(nvme_major, int, 0);
48 static int use_threaded_interrupts;
49 module_param(use_threaded_interrupts, int, 0);
52 * Represents an NVM Express device. Each nvme_dev is a PCI function.
55 struct nvme_queue **queues;
57 struct pci_dev *pci_dev;
61 struct msix_entry *entry;
62 struct nvme_bar __iomem *bar;
63 struct list_head namespaces;
70 * An NVM Express namespace is equivalent to a SCSI LUN
73 struct list_head list;
76 struct request_queue *queue;
84 * An NVM Express queue. Each device has at least two (one for admin
85 * commands and one for I/O commands).
88 struct device *q_dmadev;
90 struct nvme_command *sq_cmds;
91 volatile struct nvme_completion *cqes;
92 dma_addr_t sq_dma_addr;
93 dma_addr_t cq_dma_addr;
94 wait_queue_head_t sq_full;
95 struct bio_list sq_cong;
103 unsigned long cmdid_data[];
107 * Check we didin't inadvertently grow the command struct
109 static inline void _nvme_check_size(void)
111 BUILD_BUG_ON(sizeof(struct nvme_rw_command) != 64);
112 BUILD_BUG_ON(sizeof(struct nvme_create_cq) != 64);
113 BUILD_BUG_ON(sizeof(struct nvme_create_sq) != 64);
114 BUILD_BUG_ON(sizeof(struct nvme_delete_queue) != 64);
115 BUILD_BUG_ON(sizeof(struct nvme_features) != 64);
116 BUILD_BUG_ON(sizeof(struct nvme_command) != 64);
117 BUILD_BUG_ON(sizeof(struct nvme_id_ctrl) != 4096);
118 BUILD_BUG_ON(sizeof(struct nvme_id_ns) != 4096);
119 BUILD_BUG_ON(sizeof(struct nvme_lba_range_type) != 64);
123 * alloc_cmdid - Allocate a Command ID
124 * @param nvmeq The queue that will be used for this command
125 * @param ctx A pointer that will be passed to the handler
126 * @param handler The ID of the handler to call
128 * Allocate a Command ID for a queue. The data passed in will
129 * be passed to the completion handler. This is implemented by using
130 * the bottom two bits of the ctx pointer to store the handler ID.
131 * Passing in a pointer that's not 4-byte aligned will cause a BUG.
132 * We can change this if it becomes a problem.
134 static int alloc_cmdid(struct nvme_queue *nvmeq, void *ctx, int handler)
136 int depth = nvmeq->q_depth;
137 unsigned long data = (unsigned long)ctx | handler;
140 BUG_ON((unsigned long)ctx & 3);
143 cmdid = find_first_zero_bit(nvmeq->cmdid_data, depth);
146 } while (test_and_set_bit(cmdid, nvmeq->cmdid_data));
148 nvmeq->cmdid_data[cmdid + BITS_TO_LONGS(depth)] = data;
152 static int alloc_cmdid_killable(struct nvme_queue *nvmeq, void *ctx,
156 wait_event_killable(nvmeq->sq_full,
157 (cmdid = alloc_cmdid(nvmeq, ctx, handler)) >= 0);
158 return (cmdid < 0) ? -EINTR : cmdid;
161 /* If you need more than four handlers, you'll need to change how
162 * alloc_cmdid and nvme_process_cq work. Consider using a special
163 * CMD_CTX value instead, if that works for your situation.
166 sync_completion_id = 0,
170 #define CMD_CTX_BASE (POISON_POINTER_DELTA + sync_completion_id)
171 #define CMD_CTX_CANCELLED (0x2008 + CMD_CTX_BASE)
172 #define CMD_CTX_COMPLETED (0x2010 + CMD_CTX_BASE)
174 static unsigned long free_cmdid(struct nvme_queue *nvmeq, int cmdid)
177 unsigned offset = cmdid + BITS_TO_LONGS(nvmeq->q_depth);
179 data = nvmeq->cmdid_data[offset];
180 nvmeq->cmdid_data[offset] = CMD_CTX_COMPLETED;
181 clear_bit(cmdid, nvmeq->cmdid_data);
182 wake_up(&nvmeq->sq_full);
186 static void cancel_cmdid_data(struct nvme_queue *nvmeq, int cmdid)
188 unsigned offset = cmdid + BITS_TO_LONGS(nvmeq->q_depth);
189 nvmeq->cmdid_data[offset] = CMD_CTX_CANCELLED;
192 static struct nvme_queue *get_nvmeq(struct nvme_ns *ns)
194 int qid, cpu = get_cpu();
195 if (cpu < ns->dev->queue_count)
198 qid = (cpu % rounddown_pow_of_two(ns->dev->queue_count)) + 1;
199 return ns->dev->queues[qid];
202 static void put_nvmeq(struct nvme_queue *nvmeq)
208 * nvme_submit_cmd: Copy a command into a queue and ring the doorbell
209 * @nvmeq: The queue to use
210 * @cmd: The command to send
212 * Safe to use from interrupt context
214 static int nvme_submit_cmd(struct nvme_queue *nvmeq, struct nvme_command *cmd)
218 /* XXX: Need to check tail isn't going to overrun head */
219 spin_lock_irqsave(&nvmeq->q_lock, flags);
220 tail = nvmeq->sq_tail;
221 memcpy(&nvmeq->sq_cmds[tail], cmd, sizeof(*cmd));
222 writel(tail, nvmeq->q_db);
223 if (++tail == nvmeq->q_depth)
225 nvmeq->sq_tail = tail;
226 spin_unlock_irqrestore(&nvmeq->q_lock, flags);
231 struct nvme_req_info {
234 struct scatterlist sg[0];
237 /* XXX: use a mempool */
238 static struct nvme_req_info *alloc_info(unsigned nseg, gfp_t gfp)
240 return kmalloc(sizeof(struct nvme_req_info) +
241 sizeof(struct scatterlist) * nseg, gfp);
244 static void free_info(struct nvme_req_info *info)
249 static void bio_completion(struct nvme_queue *nvmeq, void *ctx,
250 struct nvme_completion *cqe)
252 struct nvme_req_info *info = ctx;
253 struct bio *bio = info->bio;
254 u16 status = le16_to_cpup(&cqe->status) >> 1;
256 dma_unmap_sg(nvmeq->q_dmadev, info->sg, info->nents,
257 bio_data_dir(bio) ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
259 bio_endio(bio, status ? -EIO : 0);
262 /* length is in bytes */
263 static void nvme_setup_prps(struct nvme_common_command *cmd,
264 struct scatterlist *sg, int length)
266 int dma_len = sg_dma_len(sg);
267 u64 dma_addr = sg_dma_address(sg);
268 int offset = offset_in_page(dma_addr);
270 cmd->prp1 = cpu_to_le64(dma_addr);
271 length -= (PAGE_SIZE - offset);
275 dma_len -= (PAGE_SIZE - offset);
277 dma_addr += (PAGE_SIZE - offset);
280 dma_addr = sg_dma_address(sg);
281 dma_len = sg_dma_len(sg);
284 if (length <= PAGE_SIZE) {
285 cmd->prp2 = cpu_to_le64(dma_addr);
289 /* XXX: support PRP lists */
292 static int nvme_map_bio(struct device *dev, struct nvme_req_info *info,
293 struct bio *bio, enum dma_data_direction dma_dir, int psegs)
295 struct bio_vec *bvec;
296 struct scatterlist *sg = info->sg;
299 sg_init_table(sg, psegs);
300 bio_for_each_segment(bvec, bio, i) {
301 sg_set_page(sg, bvec->bv_page, bvec->bv_len, bvec->bv_offset);
302 /* XXX: handle non-mergable here */
307 return dma_map_sg(dev, info->sg, info->nents, dma_dir);
310 static int nvme_submit_bio_queue(struct nvme_queue *nvmeq, struct nvme_ns *ns,
313 struct nvme_command *cmnd;
314 struct nvme_req_info *info;
315 enum dma_data_direction dma_dir;
320 int psegs = bio_phys_segments(ns->queue, bio);
322 info = alloc_info(psegs, GFP_NOIO);
327 cmdid = alloc_cmdid(nvmeq, info, bio_completion_id);
328 if (unlikely(cmdid < 0))
332 if (bio->bi_rw & REQ_FUA)
333 control |= NVME_RW_FUA;
334 if (bio->bi_rw & (REQ_FAILFAST_DEV | REQ_RAHEAD))
335 control |= NVME_RW_LR;
338 if (bio->bi_rw & REQ_RAHEAD)
339 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
341 spin_lock_irqsave(&nvmeq->q_lock, flags);
342 cmnd = &nvmeq->sq_cmds[nvmeq->sq_tail];
344 memset(cmnd, 0, sizeof(*cmnd));
345 if (bio_data_dir(bio)) {
346 cmnd->rw.opcode = nvme_cmd_write;
347 dma_dir = DMA_TO_DEVICE;
349 cmnd->rw.opcode = nvme_cmd_read;
350 dma_dir = DMA_FROM_DEVICE;
353 nvme_map_bio(nvmeq->q_dmadev, info, bio, dma_dir, psegs);
356 cmnd->rw.command_id = cmdid;
357 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
358 nvme_setup_prps(&cmnd->common, info->sg, bio->bi_size);
359 cmnd->rw.slba = cpu_to_le64(bio->bi_sector >> (ns->lba_shift - 9));
360 cmnd->rw.length = cpu_to_le16((bio->bi_size >> ns->lba_shift) - 1);
361 cmnd->rw.control = cpu_to_le16(control);
362 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
364 writel(nvmeq->sq_tail, nvmeq->q_db);
365 if (++nvmeq->sq_tail == nvmeq->q_depth)
368 spin_unlock_irqrestore(&nvmeq->q_lock, flags);
379 * NB: return value of non-zero would mean that we were a stacking driver.
380 * make_request must always succeed.
382 static int nvme_make_request(struct request_queue *q, struct bio *bio)
384 struct nvme_ns *ns = q->queuedata;
385 struct nvme_queue *nvmeq = get_nvmeq(ns);
387 if (nvme_submit_bio_queue(nvmeq, ns, bio)) {
388 blk_set_queue_congested(q, rw_is_sync(bio->bi_rw));
389 bio_list_add(&nvmeq->sq_cong, bio);
396 struct sync_cmd_info {
397 struct task_struct *task;
402 static void sync_completion(struct nvme_queue *nvmeq, void *ctx,
403 struct nvme_completion *cqe)
405 struct sync_cmd_info *cmdinfo = ctx;
406 if ((unsigned long)cmdinfo == CMD_CTX_CANCELLED)
408 if (unlikely((unsigned long)cmdinfo == CMD_CTX_COMPLETED)) {
409 dev_warn(nvmeq->q_dmadev,
410 "completed id %d twice on queue %d\n",
411 cqe->command_id, le16_to_cpup(&cqe->sq_id));
414 cmdinfo->result = le32_to_cpup(&cqe->result);
415 cmdinfo->status = le16_to_cpup(&cqe->status) >> 1;
416 wake_up_process(cmdinfo->task);
419 typedef void (*completion_fn)(struct nvme_queue *, void *,
420 struct nvme_completion *);
422 static irqreturn_t nvme_process_cq(struct nvme_queue *nvmeq)
426 static const completion_fn completions[4] = {
427 [sync_completion_id] = sync_completion,
428 [bio_completion_id] = bio_completion,
431 head = nvmeq->cq_head;
432 phase = nvmeq->cq_phase;
437 unsigned char handler;
438 struct nvme_completion cqe = nvmeq->cqes[head];
439 if ((le16_to_cpu(cqe.status) & 1) != phase)
441 nvmeq->sq_head = le16_to_cpu(cqe.sq_head);
442 if (++head == nvmeq->q_depth) {
447 data = free_cmdid(nvmeq, cqe.command_id);
449 ptr = (void *)(data & ~3UL);
450 completions[handler](nvmeq, ptr, &cqe);
453 /* If the controller ignores the cq head doorbell and continuously
454 * writes to the queue, it is theoretically possible to wrap around
455 * the queue twice and mistakenly return IRQ_NONE. Linux only
456 * requires that 0.1% of your interrupts are handled, so this isn't
459 if (head == nvmeq->cq_head && phase == nvmeq->cq_phase)
462 writel(head, nvmeq->q_db + 1);
463 nvmeq->cq_head = head;
464 nvmeq->cq_phase = phase;
469 static irqreturn_t nvme_irq(int irq, void *data)
471 return nvme_process_cq(data);
474 static irqreturn_t nvme_irq_thread(int irq, void *data)
477 struct nvme_queue *nvmeq = data;
478 spin_lock(&nvmeq->q_lock);
479 result = nvme_process_cq(nvmeq);
480 spin_unlock(&nvmeq->q_lock);
484 static irqreturn_t nvme_irq_check(int irq, void *data)
486 struct nvme_queue *nvmeq = data;
487 struct nvme_completion cqe = nvmeq->cqes[nvmeq->cq_head];
488 if ((le16_to_cpu(cqe.status) & 1) != nvmeq->cq_phase)
490 return IRQ_WAKE_THREAD;
493 static void nvme_abort_command(struct nvme_queue *nvmeq, int cmdid)
495 spin_lock_irq(&nvmeq->q_lock);
496 cancel_cmdid_data(nvmeq, cmdid);
497 spin_unlock_irq(&nvmeq->q_lock);
501 * Returns 0 on success. If the result is negative, it's a Linux error code;
502 * if the result is positive, it's an NVM Express status code
504 static int nvme_submit_sync_cmd(struct nvme_queue *nvmeq,
505 struct nvme_command *cmd, u32 *result)
508 struct sync_cmd_info cmdinfo;
510 cmdinfo.task = current;
511 cmdinfo.status = -EINTR;
513 cmdid = alloc_cmdid_killable(nvmeq, &cmdinfo, sync_completion_id);
516 cmd->common.command_id = cmdid;
518 set_current_state(TASK_KILLABLE);
519 nvme_submit_cmd(nvmeq, cmd);
522 if (cmdinfo.status == -EINTR) {
523 nvme_abort_command(nvmeq, cmdid);
528 *result = cmdinfo.result;
530 return cmdinfo.status;
533 static int nvme_submit_admin_cmd(struct nvme_dev *dev, struct nvme_command *cmd,
536 return nvme_submit_sync_cmd(dev->queues[0], cmd, result);
539 static int adapter_delete_queue(struct nvme_dev *dev, u8 opcode, u16 id)
542 struct nvme_command c;
544 memset(&c, 0, sizeof(c));
545 c.delete_queue.opcode = opcode;
546 c.delete_queue.qid = cpu_to_le16(id);
548 status = nvme_submit_admin_cmd(dev, &c, NULL);
554 static int adapter_alloc_cq(struct nvme_dev *dev, u16 qid,
555 struct nvme_queue *nvmeq)
558 struct nvme_command c;
559 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_CQ_IRQ_ENABLED;
561 memset(&c, 0, sizeof(c));
562 c.create_cq.opcode = nvme_admin_create_cq;
563 c.create_cq.prp1 = cpu_to_le64(nvmeq->cq_dma_addr);
564 c.create_cq.cqid = cpu_to_le16(qid);
565 c.create_cq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
566 c.create_cq.cq_flags = cpu_to_le16(flags);
567 c.create_cq.irq_vector = cpu_to_le16(nvmeq->cq_vector);
569 status = nvme_submit_admin_cmd(dev, &c, NULL);
575 static int adapter_alloc_sq(struct nvme_dev *dev, u16 qid,
576 struct nvme_queue *nvmeq)
579 struct nvme_command c;
580 int flags = NVME_QUEUE_PHYS_CONTIG | NVME_SQ_PRIO_MEDIUM;
582 memset(&c, 0, sizeof(c));
583 c.create_sq.opcode = nvme_admin_create_sq;
584 c.create_sq.prp1 = cpu_to_le64(nvmeq->sq_dma_addr);
585 c.create_sq.sqid = cpu_to_le16(qid);
586 c.create_sq.qsize = cpu_to_le16(nvmeq->q_depth - 1);
587 c.create_sq.sq_flags = cpu_to_le16(flags);
588 c.create_sq.cqid = cpu_to_le16(qid);
590 status = nvme_submit_admin_cmd(dev, &c, NULL);
596 static int adapter_delete_cq(struct nvme_dev *dev, u16 cqid)
598 return adapter_delete_queue(dev, nvme_admin_delete_cq, cqid);
601 static int adapter_delete_sq(struct nvme_dev *dev, u16 sqid)
603 return adapter_delete_queue(dev, nvme_admin_delete_sq, sqid);
606 static void nvme_free_queue(struct nvme_dev *dev, int qid)
608 struct nvme_queue *nvmeq = dev->queues[qid];
610 free_irq(dev->entry[nvmeq->cq_vector].vector, nvmeq);
612 /* Don't tell the adapter to delete the admin queue */
614 adapter_delete_sq(dev, qid);
615 adapter_delete_cq(dev, qid);
618 dma_free_coherent(nvmeq->q_dmadev, CQ_SIZE(nvmeq->q_depth),
619 (void *)nvmeq->cqes, nvmeq->cq_dma_addr);
620 dma_free_coherent(nvmeq->q_dmadev, SQ_SIZE(nvmeq->q_depth),
621 nvmeq->sq_cmds, nvmeq->sq_dma_addr);
625 static struct nvme_queue *nvme_alloc_queue(struct nvme_dev *dev, int qid,
626 int depth, int vector)
628 struct device *dmadev = &dev->pci_dev->dev;
629 unsigned extra = (depth + BITS_TO_LONGS(depth)) * sizeof(long);
630 struct nvme_queue *nvmeq = kzalloc(sizeof(*nvmeq) + extra, GFP_KERNEL);
634 nvmeq->cqes = dma_alloc_coherent(dmadev, CQ_SIZE(depth),
635 &nvmeq->cq_dma_addr, GFP_KERNEL);
638 memset((void *)nvmeq->cqes, 0, CQ_SIZE(depth));
640 nvmeq->sq_cmds = dma_alloc_coherent(dmadev, SQ_SIZE(depth),
641 &nvmeq->sq_dma_addr, GFP_KERNEL);
645 nvmeq->q_dmadev = dmadev;
646 spin_lock_init(&nvmeq->q_lock);
649 init_waitqueue_head(&nvmeq->sq_full);
650 bio_list_init(&nvmeq->sq_cong);
651 nvmeq->q_db = &dev->dbs[qid * 2];
652 nvmeq->q_depth = depth;
653 nvmeq->cq_vector = vector;
658 dma_free_coherent(dmadev, CQ_SIZE(nvmeq->q_depth), (void *)nvmeq->cqes,
665 static int queue_request_irq(struct nvme_dev *dev, struct nvme_queue *nvmeq,
668 if (use_threaded_interrupts)
669 return request_threaded_irq(dev->entry[nvmeq->cq_vector].vector,
670 nvme_irq_check, nvme_irq_thread,
671 IRQF_DISABLED | IRQF_SHARED,
673 return request_irq(dev->entry[nvmeq->cq_vector].vector, nvme_irq,
674 IRQF_DISABLED | IRQF_SHARED, name, nvmeq);
677 static __devinit struct nvme_queue *nvme_create_queue(struct nvme_dev *dev,
678 int qid, int cq_size, int vector)
681 struct nvme_queue *nvmeq = nvme_alloc_queue(dev, qid, cq_size, vector);
686 result = adapter_alloc_cq(dev, qid, nvmeq);
690 result = adapter_alloc_sq(dev, qid, nvmeq);
694 result = queue_request_irq(dev, nvmeq, "nvme");
701 adapter_delete_sq(dev, qid);
703 adapter_delete_cq(dev, qid);
705 dma_free_coherent(nvmeq->q_dmadev, CQ_SIZE(nvmeq->q_depth),
706 (void *)nvmeq->cqes, nvmeq->cq_dma_addr);
707 dma_free_coherent(nvmeq->q_dmadev, SQ_SIZE(nvmeq->q_depth),
708 nvmeq->sq_cmds, nvmeq->sq_dma_addr);
713 static int __devinit nvme_configure_admin_queue(struct nvme_dev *dev)
717 struct nvme_queue *nvmeq;
719 dev->dbs = ((void __iomem *)dev->bar) + 4096;
721 nvmeq = nvme_alloc_queue(dev, 0, 64, 0);
725 aqa = nvmeq->q_depth - 1;
728 dev->ctrl_config = NVME_CC_ENABLE | NVME_CC_CSS_NVM;
729 dev->ctrl_config |= (PAGE_SHIFT - 12) << NVME_CC_MPS_SHIFT;
730 dev->ctrl_config |= NVME_CC_ARB_RR | NVME_CC_SHN_NONE;
732 writel(0, &dev->bar->cc);
733 writel(aqa, &dev->bar->aqa);
734 writeq(nvmeq->sq_dma_addr, &dev->bar->asq);
735 writeq(nvmeq->cq_dma_addr, &dev->bar->acq);
736 writel(dev->ctrl_config, &dev->bar->cc);
738 while (!(readl(&dev->bar->csts) & NVME_CSTS_RDY)) {
740 if (fatal_signal_pending(current))
744 result = queue_request_irq(dev, nvmeq, "nvme admin");
745 dev->queues[0] = nvmeq;
749 static int nvme_map_user_pages(struct nvme_dev *dev, int write,
750 unsigned long addr, unsigned length,
751 struct scatterlist **sgp)
753 int i, err, count, nents, offset;
754 struct scatterlist *sg;
762 offset = offset_in_page(addr);
763 count = DIV_ROUND_UP(offset + length, PAGE_SIZE);
764 pages = kcalloc(count, sizeof(*pages), GFP_KERNEL);
766 err = get_user_pages_fast(addr, count, 1, pages);
773 sg = kcalloc(count, sizeof(*sg), GFP_KERNEL);
774 sg_init_table(sg, count);
775 sg_set_page(&sg[0], pages[0], PAGE_SIZE - offset, offset);
776 length -= (PAGE_SIZE - offset);
777 for (i = 1; i < count; i++) {
778 sg_set_page(&sg[i], pages[i], min_t(int, length, PAGE_SIZE), 0);
783 nents = dma_map_sg(&dev->pci_dev->dev, sg, count,
784 write ? DMA_TO_DEVICE : DMA_FROM_DEVICE);
793 for (i = 0; i < count; i++)
799 static void nvme_unmap_user_pages(struct nvme_dev *dev, int write,
800 unsigned long addr, int length,
801 struct scatterlist *sg, int nents)
805 count = DIV_ROUND_UP(offset_in_page(addr) + length, PAGE_SIZE);
806 dma_unmap_sg(&dev->pci_dev->dev, sg, nents, DMA_FROM_DEVICE);
808 for (i = 0; i < count; i++)
809 put_page(sg_page(&sg[i]));
812 static int nvme_submit_user_admin_command(struct nvme_dev *dev,
813 unsigned long addr, unsigned length,
814 struct nvme_command *cmd)
817 struct scatterlist *sg;
819 nents = nvme_map_user_pages(dev, 0, addr, length, &sg);
822 nvme_setup_prps(&cmd->common, sg, length);
823 err = nvme_submit_admin_cmd(dev, cmd, NULL);
824 nvme_unmap_user_pages(dev, 0, addr, length, sg, nents);
825 return err ? -EIO : 0;
828 static int nvme_identify(struct nvme_ns *ns, unsigned long addr, int cns)
830 struct nvme_command c;
832 memset(&c, 0, sizeof(c));
833 c.identify.opcode = nvme_admin_identify;
834 c.identify.nsid = cns ? 0 : cpu_to_le32(ns->ns_id);
835 c.identify.cns = cpu_to_le32(cns);
837 return nvme_submit_user_admin_command(ns->dev, addr, 4096, &c);
840 static int nvme_get_range_type(struct nvme_ns *ns, unsigned long addr)
842 struct nvme_command c;
844 memset(&c, 0, sizeof(c));
845 c.features.opcode = nvme_admin_get_features;
846 c.features.nsid = cpu_to_le32(ns->ns_id);
847 c.features.fid = cpu_to_le32(NVME_FEAT_LBA_RANGE);
849 return nvme_submit_user_admin_command(ns->dev, addr, 4096, &c);
852 static int nvme_submit_io(struct nvme_ns *ns, struct nvme_user_io __user *uio)
854 struct nvme_dev *dev = ns->dev;
855 struct nvme_queue *nvmeq;
856 struct nvme_user_io io;
857 struct nvme_command c;
861 struct scatterlist *sg;
863 if (copy_from_user(&io, uio, sizeof(io)))
865 length = io.nblocks << io.block_shift;
866 nents = nvme_map_user_pages(dev, io.opcode & 1, io.addr, length, &sg);
870 memset(&c, 0, sizeof(c));
871 c.rw.opcode = io.opcode;
872 c.rw.flags = io.flags;
873 c.rw.nsid = cpu_to_le32(io.nsid);
874 c.rw.slba = cpu_to_le64(io.slba);
875 c.rw.length = cpu_to_le16(io.nblocks - 1);
876 c.rw.control = cpu_to_le16(io.control);
877 c.rw.dsmgmt = cpu_to_le16(io.dsmgmt);
878 c.rw.reftag = cpu_to_le32(io.reftag); /* XXX: endian? */
879 c.rw.apptag = cpu_to_le16(io.apptag);
880 c.rw.appmask = cpu_to_le16(io.appmask);
882 nvme_setup_prps(&c.common, sg, length);
884 nvmeq = get_nvmeq(ns);
885 /* Since nvme_submit_sync_cmd sleeps, we can't keep preemption
886 * disabled. We may be preempted at any point, and be rescheduled
887 * to a different CPU. That will cause cacheline bouncing, but no
888 * additional races since q_lock already protects against other CPUs.
891 status = nvme_submit_sync_cmd(nvmeq, &c, &result);
893 nvme_unmap_user_pages(dev, io.opcode & 1, io.addr, length, sg, nents);
894 put_user(result, &uio->result);
898 static int nvme_download_firmware(struct nvme_ns *ns,
899 struct nvme_dlfw __user *udlfw)
901 struct nvme_dev *dev = ns->dev;
902 struct nvme_dlfw dlfw;
903 struct nvme_command c;
905 struct scatterlist *sg;
907 if (copy_from_user(&dlfw, udlfw, sizeof(dlfw)))
909 if (dlfw.length >= (1 << 30))
912 nents = nvme_map_user_pages(dev, 1, dlfw.addr, dlfw.length * 4, &sg);
916 memset(&c, 0, sizeof(c));
917 c.dlfw.opcode = nvme_admin_download_fw;
918 c.dlfw.numd = cpu_to_le32(dlfw.length);
919 c.dlfw.offset = cpu_to_le32(dlfw.offset);
920 nvme_setup_prps(&c.common, sg, dlfw.length * 4);
922 status = nvme_submit_admin_cmd(dev, &c, NULL);
923 nvme_unmap_user_pages(dev, 0, dlfw.addr, dlfw.length * 4, sg, nents);
927 static int nvme_activate_firmware(struct nvme_ns *ns, unsigned long arg)
929 struct nvme_dev *dev = ns->dev;
930 struct nvme_command c;
932 memset(&c, 0, sizeof(c));
933 c.common.opcode = nvme_admin_activate_fw;
934 c.common.rsvd10[0] = cpu_to_le32(arg);
936 return nvme_submit_admin_cmd(dev, &c, NULL);
939 static int nvme_ioctl(struct block_device *bdev, fmode_t mode, unsigned int cmd,
942 struct nvme_ns *ns = bdev->bd_disk->private_data;
945 case NVME_IOCTL_IDENTIFY_NS:
946 return nvme_identify(ns, arg, 0);
947 case NVME_IOCTL_IDENTIFY_CTRL:
948 return nvme_identify(ns, arg, 1);
949 case NVME_IOCTL_GET_RANGE_TYPE:
950 return nvme_get_range_type(ns, arg);
951 case NVME_IOCTL_SUBMIT_IO:
952 return nvme_submit_io(ns, (void __user *)arg);
953 case NVME_IOCTL_DOWNLOAD_FW:
954 return nvme_download_firmware(ns, (void __user *)arg);
955 case NVME_IOCTL_ACTIVATE_FW:
956 return nvme_activate_firmware(ns, arg);
962 static const struct block_device_operations nvme_fops = {
963 .owner = THIS_MODULE,
967 static struct nvme_ns *nvme_alloc_ns(struct nvme_dev *dev, int index,
968 struct nvme_id_ns *id, struct nvme_lba_range_type *rt)
971 struct gendisk *disk;
974 if (rt->attributes & NVME_LBART_ATTRIB_HIDE)
977 ns = kzalloc(sizeof(*ns), GFP_KERNEL);
980 ns->queue = blk_alloc_queue(GFP_KERNEL);
983 ns->queue->queue_flags = QUEUE_FLAG_DEFAULT | QUEUE_FLAG_NOMERGES |
984 QUEUE_FLAG_NONROT | QUEUE_FLAG_DISCARD;
985 blk_queue_make_request(ns->queue, nvme_make_request);
987 ns->queue->queuedata = ns;
989 disk = alloc_disk(NVME_MINORS);
994 lbaf = id->flbas & 0xf;
995 ns->lba_shift = id->lbaf[lbaf].ds;
997 disk->major = nvme_major;
998 disk->minors = NVME_MINORS;
999 disk->first_minor = NVME_MINORS * index;
1000 disk->fops = &nvme_fops;
1001 disk->private_data = ns;
1002 disk->queue = ns->queue;
1003 disk->driverfs_dev = &dev->pci_dev->dev;
1004 sprintf(disk->disk_name, "nvme%dn%d", dev->instance, index);
1005 set_capacity(disk, le64_to_cpup(&id->nsze) << (ns->lba_shift - 9));
1010 blk_cleanup_queue(ns->queue);
1016 static void nvme_ns_free(struct nvme_ns *ns)
1019 blk_cleanup_queue(ns->queue);
1023 static int set_queue_count(struct nvme_dev *dev, int count)
1027 struct nvme_command c;
1028 u32 q_count = (count - 1) | ((count - 1) << 16);
1030 memset(&c, 0, sizeof(c));
1031 c.features.opcode = nvme_admin_get_features;
1032 c.features.fid = cpu_to_le32(NVME_FEAT_NUM_QUEUES);
1033 c.features.dword11 = cpu_to_le32(q_count);
1035 status = nvme_submit_admin_cmd(dev, &c, &result);
1038 return min(result & 0xffff, result >> 16) + 1;
1041 static int __devinit nvme_setup_io_queues(struct nvme_dev *dev)
1043 int result, cpu, i, nr_queues;
1045 nr_queues = num_online_cpus();
1046 result = set_queue_count(dev, nr_queues);
1049 if (result < nr_queues)
1052 /* Deregister the admin queue's interrupt */
1053 free_irq(dev->entry[0].vector, dev->queues[0]);
1055 for (i = 0; i < nr_queues; i++)
1056 dev->entry[i].entry = i;
1058 result = pci_enable_msix(dev->pci_dev, dev->entry, nr_queues);
1061 } else if (result > 0) {
1070 result = queue_request_irq(dev, dev->queues[0], "nvme admin");
1071 /* XXX: handle failure here */
1073 cpu = cpumask_first(cpu_online_mask);
1074 for (i = 0; i < nr_queues; i++) {
1075 irq_set_affinity_hint(dev->entry[i].vector, get_cpu_mask(cpu));
1076 cpu = cpumask_next(cpu, cpu_online_mask);
1079 for (i = 0; i < nr_queues; i++) {
1080 dev->queues[i + 1] = nvme_create_queue(dev, i + 1,
1082 if (!dev->queues[i + 1])
1090 static void nvme_free_queues(struct nvme_dev *dev)
1094 for (i = dev->queue_count - 1; i >= 0; i--)
1095 nvme_free_queue(dev, i);
1098 static int __devinit nvme_dev_add(struct nvme_dev *dev)
1101 struct nvme_ns *ns, *next;
1102 struct nvme_id_ctrl *ctrl;
1104 dma_addr_t dma_addr;
1105 struct nvme_command cid, crt;
1107 res = nvme_setup_io_queues(dev);
1111 /* XXX: Switch to a SG list once prp2 works */
1112 id = dma_alloc_coherent(&dev->pci_dev->dev, 8192, &dma_addr,
1115 memset(&cid, 0, sizeof(cid));
1116 cid.identify.opcode = nvme_admin_identify;
1117 cid.identify.nsid = 0;
1118 cid.identify.prp1 = cpu_to_le64(dma_addr);
1119 cid.identify.cns = cpu_to_le32(1);
1121 res = nvme_submit_admin_cmd(dev, &cid, NULL);
1128 nn = le32_to_cpup(&ctrl->nn);
1129 memcpy(dev->serial, ctrl->sn, sizeof(ctrl->sn));
1130 memcpy(dev->model, ctrl->mn, sizeof(ctrl->mn));
1131 memcpy(dev->firmware_rev, ctrl->fr, sizeof(ctrl->fr));
1133 cid.identify.cns = 0;
1134 memset(&crt, 0, sizeof(crt));
1135 crt.features.opcode = nvme_admin_get_features;
1136 crt.features.prp1 = cpu_to_le64(dma_addr + 4096);
1137 crt.features.fid = cpu_to_le32(NVME_FEAT_LBA_RANGE);
1139 for (i = 0; i < nn; i++) {
1140 cid.identify.nsid = cpu_to_le32(i);
1141 res = nvme_submit_admin_cmd(dev, &cid, NULL);
1145 if (((struct nvme_id_ns *)id)->ncap == 0)
1148 crt.features.nsid = cpu_to_le32(i);
1149 res = nvme_submit_admin_cmd(dev, &crt, NULL);
1153 ns = nvme_alloc_ns(dev, i, id, id + 4096);
1155 list_add_tail(&ns->list, &dev->namespaces);
1157 list_for_each_entry(ns, &dev->namespaces, list)
1160 dma_free_coherent(&dev->pci_dev->dev, 4096, id, dma_addr);
1164 list_for_each_entry_safe(ns, next, &dev->namespaces, list) {
1165 list_del(&ns->list);
1169 dma_free_coherent(&dev->pci_dev->dev, 4096, id, dma_addr);
1173 static int nvme_dev_remove(struct nvme_dev *dev)
1175 struct nvme_ns *ns, *next;
1177 /* TODO: wait all I/O finished or cancel them */
1179 list_for_each_entry_safe(ns, next, &dev->namespaces, list) {
1180 list_del(&ns->list);
1181 del_gendisk(ns->disk);
1185 nvme_free_queues(dev);
1190 /* XXX: Use an ida or something to let remove / add work correctly */
1191 static void nvme_set_instance(struct nvme_dev *dev)
1193 static int instance;
1194 dev->instance = instance++;
1197 static void nvme_release_instance(struct nvme_dev *dev)
1201 static int __devinit nvme_probe(struct pci_dev *pdev,
1202 const struct pci_device_id *id)
1204 int bars, result = -ENOMEM;
1205 struct nvme_dev *dev;
1207 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1210 dev->entry = kcalloc(num_possible_cpus(), sizeof(*dev->entry),
1214 dev->queues = kcalloc(num_possible_cpus() + 1, sizeof(void *),
1219 if (pci_enable_device_mem(pdev))
1221 pci_set_master(pdev);
1222 bars = pci_select_bars(pdev, IORESOURCE_MEM);
1223 if (pci_request_selected_regions(pdev, bars, "nvme"))
1226 INIT_LIST_HEAD(&dev->namespaces);
1227 dev->pci_dev = pdev;
1228 pci_set_drvdata(pdev, dev);
1229 dma_set_mask(&pdev->dev, DMA_BIT_MASK(64));
1230 dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(64));
1231 nvme_set_instance(dev);
1232 dev->entry[0].vector = pdev->irq;
1234 dev->bar = ioremap(pci_resource_start(pdev, 0), 8192);
1240 result = nvme_configure_admin_queue(dev);
1245 result = nvme_dev_add(dev);
1251 nvme_free_queues(dev);
1255 pci_disable_msix(pdev);
1256 nvme_release_instance(dev);
1258 pci_disable_device(pdev);
1259 pci_release_regions(pdev);
1267 static void __devexit nvme_remove(struct pci_dev *pdev)
1269 struct nvme_dev *dev = pci_get_drvdata(pdev);
1270 nvme_dev_remove(dev);
1271 pci_disable_msix(pdev);
1273 nvme_release_instance(dev);
1274 pci_disable_device(pdev);
1275 pci_release_regions(pdev);
1281 /* These functions are yet to be implemented */
1282 #define nvme_error_detected NULL
1283 #define nvme_dump_registers NULL
1284 #define nvme_link_reset NULL
1285 #define nvme_slot_reset NULL
1286 #define nvme_error_resume NULL
1287 #define nvme_suspend NULL
1288 #define nvme_resume NULL
1290 static struct pci_error_handlers nvme_err_handler = {
1291 .error_detected = nvme_error_detected,
1292 .mmio_enabled = nvme_dump_registers,
1293 .link_reset = nvme_link_reset,
1294 .slot_reset = nvme_slot_reset,
1295 .resume = nvme_error_resume,
1298 /* Move to pci_ids.h later */
1299 #define PCI_CLASS_STORAGE_EXPRESS 0x010802
1301 static DEFINE_PCI_DEVICE_TABLE(nvme_id_table) = {
1302 { PCI_DEVICE_CLASS(PCI_CLASS_STORAGE_EXPRESS, 0xffffff) },
1305 MODULE_DEVICE_TABLE(pci, nvme_id_table);
1307 static struct pci_driver nvme_driver = {
1309 .id_table = nvme_id_table,
1310 .probe = nvme_probe,
1311 .remove = __devexit_p(nvme_remove),
1312 .suspend = nvme_suspend,
1313 .resume = nvme_resume,
1314 .err_handler = &nvme_err_handler,
1317 static int __init nvme_init(void)
1321 nvme_major = register_blkdev(nvme_major, "nvme");
1322 if (nvme_major <= 0)
1325 result = pci_register_driver(&nvme_driver);
1329 unregister_blkdev(nvme_major, "nvme");
1333 static void __exit nvme_exit(void)
1335 pci_unregister_driver(&nvme_driver);
1336 unregister_blkdev(nvme_major, "nvme");
1339 MODULE_AUTHOR("Matthew Wilcox <willy@linux.intel.com>");
1340 MODULE_LICENSE("GPL");
1341 MODULE_VERSION("0.2");
1342 module_init(nvme_init);
1343 module_exit(nvme_exit);