include/linux/nvme.h

   1 /*
   2  * Definitions for the NVM Express interface
   3  * Copyright (c) 2011-2014, Intel Corporation.
   4  *
   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.
   8  *
   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
  12  * more details.
  13  */
  14
  15 #ifndef _LINUX_NVME_H
  16 #define _LINUX_NVME_H
  17
  18 #include <uapi/linux/nvme.h>
  19 #include <linux/pci.h>
  20 #include <linux/miscdevice.h>
  21 #include <linux/kref.h>
  22 #include <linux/blk-mq.h>
  23
  24 struct nvme_bar {
  25         __u64                   cap;    /* Controller Capabilities */
  26         __u32                   vs;     /* Version */
  27         __u32                   intms;  /* Interrupt Mask Set */
  28         __u32                   intmc;  /* Interrupt Mask Clear */
  29         __u32                   cc;     /* Controller Configuration */
  30         __u32                   rsvd1;  /* Reserved */
  31         __u32                   csts;   /* Controller Status */
  32         __u32                   rsvd2;  /* Reserved */
  33         __u32                   aqa;    /* Admin Queue Attributes */
  34         __u64                   asq;    /* Admin SQ Base Address */
  35         __u64                   acq;    /* Admin CQ Base Address */
  36 };
  37
  38 #define NVME_CAP_MQES(cap)      ((cap) & 0xffff)
  39 #define NVME_CAP_TIMEOUT(cap)   (((cap) >> 24) & 0xff)
  40 #define NVME_CAP_STRIDE(cap)    (((cap) >> 32) & 0xf)
  41 #define NVME_CAP_MPSMIN(cap)    (((cap) >> 48) & 0xf)
  42 #define NVME_CAP_MPSMAX(cap)    (((cap) >> 52) & 0xf)
  43
  44 enum {
  45         NVME_CC_ENABLE          = 1 << 0,
  46         NVME_CC_CSS_NVM         = 0 << 4,
  47         NVME_CC_MPS_SHIFT       = 7,
  48         NVME_CC_ARB_RR          = 0 << 11,
  49         NVME_CC_ARB_WRRU        = 1 << 11,
  50         NVME_CC_ARB_VS          = 7 << 11,
  51         NVME_CC_SHN_NONE        = 0 << 14,
  52         NVME_CC_SHN_NORMAL      = 1 << 14,
  53         NVME_CC_SHN_ABRUPT      = 2 << 14,
  54         NVME_CC_SHN_MASK        = 3 << 14,
  55         NVME_CC_IOSQES          = 6 << 16,
  56         NVME_CC_IOCQES          = 4 << 20,
  57         NVME_CSTS_RDY           = 1 << 0,
  58         NVME_CSTS_CFS           = 1 << 1,
  59         NVME_CSTS_SHST_NORMAL   = 0 << 2,
  60         NVME_CSTS_SHST_OCCUR    = 1 << 2,
  61         NVME_CSTS_SHST_CMPLT    = 2 << 2,
  62         NVME_CSTS_SHST_MASK     = 3 << 2,
  63 };
  64
  65 extern unsigned char nvme_io_timeout;
  66 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
  67
  68 /*
  69  * Represents an NVM Express device.  Each nvme_dev is a PCI function.
  70  */
  71 struct nvme_dev {
  72         struct list_head node;
  73         struct nvme_queue **queues;
  74         struct request_queue *admin_q;
  75         struct blk_mq_tag_set tagset;
  76         struct blk_mq_tag_set admin_tagset;
  77         u32 __iomem *dbs;
  78         struct pci_dev *pci_dev;
  79         struct dma_pool *prp_page_pool;
  80         struct dma_pool *prp_small_pool;
  81         int instance;
  82         unsigned queue_count;
  83         unsigned online_queues;
  84         unsigned max_qid;
  85         int q_depth;
  86         u32 db_stride;
  87         u32 ctrl_config;
  88         struct msix_entry *entry;
  89         struct nvme_bar __iomem *bar;
  90         struct list_head namespaces;
  91         struct kref kref;
  92         struct miscdevice miscdev;
  93         work_func_t reset_workfn;
  94         struct work_struct reset_work;
  95         char name[12];
  96         char serial[20];
  97         char model[40];
  98         char firmware_rev[8];
  99         u32 max_hw_sectors;
 100         u32 stripe_size;
 101         u32 page_size;
 102         u16 oncs;
 103         u16 abort_limit;
 104         u8 event_limit;
 105         u8 vwc;
 106         u8 initialized;
 107 };
 108
 109 /*
 110  * An NVM Express namespace is equivalent to a SCSI LUN
 111  */
 112 struct nvme_ns {
 113         struct list_head list;
 114
 115         struct nvme_dev *dev;
 116         struct request_queue *queue;
 117         struct gendisk *disk;
 118
 119         unsigned ns_id;
 120         int lba_shift;
 121         int ms;
 122         int pi_type;
 123         u64 mode_select_num_blocks;
 124         u32 mode_select_block_len;
 125 };
 126
 127 /*
 128  * The nvme_iod describes the data in an I/O, including the list of PRP
 129  * entries.  You can't see it in this data structure because C doesn't let
 130  * me express that.  Use nvme_alloc_iod to ensure there's enough space
 131  * allocated to store the PRP list.
 132  */
 133 struct nvme_iod {
 134         unsigned long private;  /* For the use of the submitter of the I/O */
 135         int npages;             /* In the PRP list. 0 means small pool in use */
 136         int offset;             /* Of PRP list */
 137         int nents;              /* Used in scatterlist */
 138         int length;             /* Of data, in bytes */
 139         dma_addr_t first_dma;
 140         struct scatterlist meta_sg[1]; /* metadata requires single contiguous buffer */
 141         struct scatterlist sg[0];
 142 };
 143
 144 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
 145 {
 146         return (sector >> (ns->lba_shift - 9));
 147 }
 148
 149 /**
 150  * nvme_free_iod - frees an nvme_iod
 151  * @dev: The device that the I/O was submitted to
 152  * @iod: The memory to free
 153  */
 154 void nvme_free_iod(struct nvme_dev *dev, struct nvme_iod *iod);
 155
 156 int nvme_setup_prps(struct nvme_dev *, struct nvme_iod *, int, gfp_t);
 157 struct nvme_iod *nvme_map_user_pages(struct nvme_dev *dev, int write,
 158                                 unsigned long addr, unsigned length);
 159 void nvme_unmap_user_pages(struct nvme_dev *dev, int write,
 160                         struct nvme_iod *iod);
 161 int nvme_submit_io_cmd(struct nvme_dev *, struct nvme_ns *,
 162                                                 struct nvme_command *, u32 *);
 163 int nvme_submit_flush_data(struct nvme_queue *nvmeq, struct nvme_ns *ns);
 164 int nvme_submit_admin_cmd(struct nvme_dev *, struct nvme_command *,
 165                                                         u32 *result);
 166 int nvme_identify(struct nvme_dev *, unsigned nsid, unsigned cns,
 167                                                         dma_addr_t dma_addr);
 168 int nvme_get_features(struct nvme_dev *dev, unsigned fid, unsigned nsid,
 169                         dma_addr_t dma_addr, u32 *result);
 170 int nvme_set_features(struct nvme_dev *dev, unsigned fid, unsigned dword11,
 171                         dma_addr_t dma_addr, u32 *result);
 172
 173 struct sg_io_hdr;
 174
 175 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
 176 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
 177 int nvme_sg_get_version_num(int __user *ip);
 178
 179 #endif /* _LINUX_NVME_H */