drivers/nvme/host/nvme.h

   1 /*
   2  * Copyright (c) 2011-2014, Intel Corporation.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms and conditions of the GNU General Public License,
   6  * version 2, as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  */
  13
  14 #ifndef _NVME_H
  15 #define _NVME_H
  16
  17 #include <linux/nvme.h>
  18 #include <linux/pci.h>
  19 #include <linux/kref.h>
  20 #include <linux/blk-mq.h>
  21
  22 extern unsigned char nvme_io_timeout;
  23 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
  24
  25 /*
  26  * Represents an NVM Express device.  Each nvme_dev is a PCI function.
  27  */
  28 struct nvme_dev {
  29         struct list_head node;
  30         struct nvme_queue **queues;
  31         struct request_queue *admin_q;
  32         struct blk_mq_tag_set tagset;
  33         struct blk_mq_tag_set admin_tagset;
  34         u32 __iomem *dbs;
  35         struct device *dev;
  36         struct dma_pool *prp_page_pool;
  37         struct dma_pool *prp_small_pool;
  38         int instance;
  39         unsigned queue_count;
  40         unsigned online_queues;
  41         unsigned max_qid;
  42         int q_depth;
  43         u32 db_stride;
  44         u32 ctrl_config;
  45         struct msix_entry *entry;
  46         struct nvme_bar __iomem *bar;
  47         struct list_head namespaces;
  48         struct kref kref;
  49         struct device *device;
  50         struct work_struct reset_work;
  51         struct work_struct probe_work;
  52         struct work_struct scan_work;
  53         char name[12];
  54         char serial[20];
  55         char model[40];
  56         char firmware_rev[8];
  57         bool subsystem;
  58         u32 max_hw_sectors;
  59         u32 stripe_size;
  60         u32 page_size;
  61         void __iomem *cmb;
  62         dma_addr_t cmb_dma_addr;
  63         u64 cmb_size;
  64         u32 cmbsz;
  65         u16 oncs;
  66         u16 abort_limit;
  67         u8 event_limit;
  68         u8 vwc;
  69 };
  70
  71 /*
  72  * An NVM Express namespace is equivalent to a SCSI LUN
  73  */
  74 struct nvme_ns {
  75         struct list_head list;
  76
  77         struct nvme_dev *dev;
  78         struct request_queue *queue;
  79         struct gendisk *disk;
  80         struct kref kref;
  81
  82         unsigned ns_id;
  83         int lba_shift;
  84         u16 ms;
  85         bool ext;
  86         u8 pi_type;
  87         u64 mode_select_num_blocks;
  88         u32 mode_select_block_len;
  89 };
  90
  91 /*
  92  * The nvme_iod describes the data in an I/O, including the list of PRP
  93  * entries.  You can't see it in this data structure because C doesn't let
  94  * me express that.  Use nvme_alloc_iod to ensure there's enough space
  95  * allocated to store the PRP list.
  96  */
  97 struct nvme_iod {
  98         unsigned long private;  /* For the use of the submitter of the I/O */
  99         int npages;             /* In the PRP list. 0 means small pool in use */
 100         int offset;             /* Of PRP list */
 101         int nents;              /* Used in scatterlist */
 102         int length;             /* Of data, in bytes */
 103         dma_addr_t first_dma;
 104         struct scatterlist meta_sg[1]; /* metadata requires single contiguous buffer */
 105         struct scatterlist sg[0];
 106 };
 107
 108 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
 109 {
 110         return (sector >> (ns->lba_shift - 9));
 111 }
 112
 113 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 114                 void *buf, unsigned bufflen);
 115 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 116                 void *buffer, void __user *ubuffer, unsigned bufflen,
 117                 u32 *result, unsigned timeout);
 118 int nvme_identify_ctrl(struct nvme_dev *dev, struct nvme_id_ctrl **id);
 119 int nvme_identify_ns(struct nvme_dev *dev, unsigned nsid,
 120                 struct nvme_id_ns **id);
 121 int nvme_get_log_page(struct nvme_dev *dev, struct nvme_smart_log **log);
 122 int nvme_get_features(struct nvme_dev *dev, unsigned fid, unsigned nsid,
 123                         dma_addr_t dma_addr, u32 *result);
 124 int nvme_set_features(struct nvme_dev *dev, unsigned fid, unsigned dword11,
 125                         dma_addr_t dma_addr, u32 *result);
 126
 127 struct sg_io_hdr;
 128
 129 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
 130 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
 131 int nvme_sg_get_version_num(int __user *ip);
 132
 133 #endif /* _NVME_H */