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 enum {
  23         /*
  24          * Driver internal status code for commands that were cancelled due
  25          * to timeouts or controller shutdown.  The value is negative so
  26          * that it a) doesn't overlap with the unsigned hardware error codes,
  27          * and b) can easily be tested for.
  28          */
  29         NVME_SC_CANCELLED               = -EINTR,
  30 };
  31
  32 extern unsigned char nvme_io_timeout;
  33 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
  34
  35 extern unsigned char admin_timeout;
  36 #define ADMIN_TIMEOUT   (admin_timeout * HZ)
  37
  38 extern unsigned char shutdown_timeout;
  39 #define SHUTDOWN_TIMEOUT        (shutdown_timeout * HZ)
  40
  41 enum {
  42         NVME_NS_LBA             = 0,
  43         NVME_NS_LIGHTNVM        = 1,
  44 };
  45
  46 /*
  47  * List of workarounds for devices that required behavior not specified in
  48  * the standard.
  49  */
  50 enum nvme_quirks {
  51         /*
  52          * Prefers I/O aligned to a stripe size specified in a vendor
  53          * specific Identify field.
  54          */
  55         NVME_QUIRK_STRIPE_SIZE                  = (1 << 0),
  56
  57         /*
  58          * The controller doesn't handle Identify value others than 0 or 1
  59          * correctly.
  60          */
  61         NVME_QUIRK_IDENTIFY_CNS                 = (1 << 1),
  62 };
  63
  64 struct nvme_ctrl {
  65         const struct nvme_ctrl_ops *ops;
  66         struct request_queue *admin_q;
  67         struct device *dev;
  68         struct kref kref;
  69         int instance;
  70         struct blk_mq_tag_set *tagset;
  71         struct list_head namespaces;
  72         struct mutex namespaces_mutex;
  73         struct device *device;  /* char device */
  74         struct list_head node;
  75
  76         char name[12];
  77         char serial[20];
  78         char model[40];
  79         char firmware_rev[8];
  80
  81         u32 ctrl_config;
  82
  83         u32 page_size;
  84         u32 max_hw_sectors;
  85         u32 stripe_size;
  86         u16 oncs;
  87         atomic_t abort_limit;
  88         u8 event_limit;
  89         u8 vwc;
  90         u32 vs;
  91         bool subsystem;
  92         unsigned long quirks;
  93 };
  94
  95 /*
  96  * An NVM Express namespace is equivalent to a SCSI LUN
  97  */
  98 struct nvme_ns {
  99         struct list_head list;
 100
 101         struct nvme_ctrl *ctrl;
 102         struct request_queue *queue;
 103         struct gendisk *disk;
 104         struct kref kref;
 105
 106         u8 eui[8];
 107         u8 uuid[16];
 108
 109         unsigned ns_id;
 110         int lba_shift;
 111         u16 ms;
 112         bool ext;
 113         u8 pi_type;
 114         int type;
 115         u64 mode_select_num_blocks;
 116         u32 mode_select_block_len;
 117 };
 118
 119 struct nvme_ctrl_ops {
 120         struct module *module;
 121         int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 122         int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
 123         int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 124         bool (*io_incapable)(struct nvme_ctrl *ctrl);
 125         int (*reset_ctrl)(struct nvme_ctrl *ctrl);
 126         void (*free_ctrl)(struct nvme_ctrl *ctrl);
 127 };
 128
 129 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
 130 {
 131         u32 val = 0;
 132
 133         if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
 134                 return false;
 135         return val & NVME_CSTS_RDY;
 136 }
 137
 138 static inline bool nvme_io_incapable(struct nvme_ctrl *ctrl)
 139 {
 140         u32 val = 0;
 141
 142         if (ctrl->ops->io_incapable(ctrl))
 143                 return false;
 144         if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
 145                 return false;
 146         return val & NVME_CSTS_CFS;
 147 }
 148
 149 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
 150 {
 151         if (!ctrl->subsystem)
 152                 return -ENOTTY;
 153         return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
 154 }
 155
 156 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
 157 {
 158         return (sector >> (ns->lba_shift - 9));
 159 }
 160
 161 static inline void nvme_setup_flush(struct nvme_ns *ns,
 162                 struct nvme_command *cmnd)
 163 {
 164         memset(cmnd, 0, sizeof(*cmnd));
 165         cmnd->common.opcode = nvme_cmd_flush;
 166         cmnd->common.nsid = cpu_to_le32(ns->ns_id);
 167 }
 168
 169 static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req,
 170                 struct nvme_command *cmnd)
 171 {
 172         u16 control = 0;
 173         u32 dsmgmt = 0;
 174
 175         if (req->cmd_flags & REQ_FUA)
 176                 control |= NVME_RW_FUA;
 177         if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
 178                 control |= NVME_RW_LR;
 179
 180         if (req->cmd_flags & REQ_RAHEAD)
 181                 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
 182
 183         memset(cmnd, 0, sizeof(*cmnd));
 184         cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
 185         cmnd->rw.command_id = req->tag;
 186         cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
 187         cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
 188         cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
 189
 190         if (ns->ms) {
 191                 switch (ns->pi_type) {
 192                 case NVME_NS_DPS_PI_TYPE3:
 193                         control |= NVME_RW_PRINFO_PRCHK_GUARD;
 194                         break;
 195                 case NVME_NS_DPS_PI_TYPE1:
 196                 case NVME_NS_DPS_PI_TYPE2:
 197                         control |= NVME_RW_PRINFO_PRCHK_GUARD |
 198                                         NVME_RW_PRINFO_PRCHK_REF;
 199                         cmnd->rw.reftag = cpu_to_le32(
 200                                         nvme_block_nr(ns, blk_rq_pos(req)));
 201                         break;
 202                 }
 203                 if (!blk_integrity_rq(req))
 204                         control |= NVME_RW_PRINFO_PRACT;
 205         }
 206
 207         cmnd->rw.control = cpu_to_le16(control);
 208         cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
 209 }
 210
 211
 212 static inline int nvme_error_status(u16 status)
 213 {
 214         switch (status & 0x7ff) {
 215         case NVME_SC_SUCCESS:
 216                 return 0;
 217         case NVME_SC_CAP_EXCEEDED:
 218                 return -ENOSPC;
 219         default:
 220                 return -EIO;
 221         }
 222 }
 223
 224 static inline bool nvme_req_needs_retry(struct request *req, u16 status)
 225 {
 226         return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
 227                 (jiffies - req->start_time) < req->timeout;
 228 }
 229
 230 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
 231 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
 232 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
 233 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
 234                 const struct nvme_ctrl_ops *ops, unsigned long quirks);
 235 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
 236 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
 237 int nvme_init_identify(struct nvme_ctrl *ctrl);
 238
 239 void nvme_scan_namespaces(struct nvme_ctrl *ctrl);
 240 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
 241
 242 void nvme_stop_queues(struct nvme_ctrl *ctrl);
 243 void nvme_start_queues(struct nvme_ctrl *ctrl);
 244
 245 struct request *nvme_alloc_request(struct request_queue *q,
 246                 struct nvme_command *cmd, unsigned int flags);
 247 void nvme_requeue_req(struct request *req);
 248 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 249                 void *buf, unsigned bufflen);
 250 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 251                 void *buffer, unsigned bufflen,  u32 *result, unsigned timeout);
 252 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
 253                 void __user *ubuffer, unsigned bufflen, u32 *result,
 254                 unsigned timeout);
 255 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
 256                 void __user *ubuffer, unsigned bufflen,
 257                 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
 258                 u32 *result, unsigned timeout);
 259 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
 260 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
 261                 struct nvme_id_ns **id);
 262 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
 263 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
 264                         dma_addr_t dma_addr, u32 *result);
 265 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
 266                         dma_addr_t dma_addr, u32 *result);
 267 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
 268
 269 struct sg_io_hdr;
 270
 271 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
 272 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
 273 int nvme_sg_get_version_num(int __user *ip);
 274
 275 #ifdef CONFIG_NVM
 276 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
 277 int nvme_nvm_register(struct request_queue *q, char *disk_name);
 278 void nvme_nvm_unregister(struct request_queue *q, char *disk_name);
 279 #else
 280 static inline int nvme_nvm_register(struct request_queue *q, char *disk_name)
 281 {
 282         return 0;
 283 }
 284
 285 static inline void nvme_nvm_unregister(struct request_queue *q, char *disk_name) {};
 286
 287 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
 288 {
 289         return 0;
 290 }
 291 #endif /* CONFIG_NVM */
 292
 293 int __init nvme_core_init(void);
 294 void nvme_core_exit(void);
 295
 296 #endif /* _NVME_H */