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         struct ida ns_ida;
  76
  77         char name[12];
  78         char serial[20];
  79         char model[40];
  80         char firmware_rev[8];
  81
  82         u32 ctrl_config;
  83
  84         u32 page_size;
  85         u32 max_hw_sectors;
  86         u32 stripe_size;
  87         u16 oncs;
  88         atomic_t abort_limit;
  89         u8 event_limit;
  90         u8 vwc;
  91         u32 vs;
  92         bool subsystem;
  93         unsigned long quirks;
  94 };
  95
  96 /*
  97  * An NVM Express namespace is equivalent to a SCSI LUN
  98  */
  99 struct nvme_ns {
 100         struct list_head list;
 101
 102         struct nvme_ctrl *ctrl;
 103         struct request_queue *queue;
 104         struct gendisk *disk;
 105         struct kref kref;
 106         int instance;
 107
 108         u8 eui[8];
 109         u8 uuid[16];
 110
 111         unsigned ns_id;
 112         int lba_shift;
 113         u16 ms;
 114         bool ext;
 115         u8 pi_type;
 116         int type;
 117         unsigned long flags;
 118
 119 #define NVME_NS_REMOVING 0
 120
 121         u64 mode_select_num_blocks;
 122         u32 mode_select_block_len;
 123 };
 124
 125 struct nvme_ctrl_ops {
 126         int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 127         int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
 128         int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 129         bool (*io_incapable)(struct nvme_ctrl *ctrl);
 130         int (*reset_ctrl)(struct nvme_ctrl *ctrl);
 131         void (*free_ctrl)(struct nvme_ctrl *ctrl);
 132 };
 133
 134 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
 135 {
 136         u32 val = 0;
 137
 138         if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
 139                 return false;
 140         return val & NVME_CSTS_RDY;
 141 }
 142
 143 static inline bool nvme_io_incapable(struct nvme_ctrl *ctrl)
 144 {
 145         u32 val = 0;
 146
 147         if (ctrl->ops->io_incapable(ctrl))
 148                 return true;
 149         if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
 150                 return true;
 151         return val & NVME_CSTS_CFS;
 152 }
 153
 154 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
 155 {
 156         if (!ctrl->subsystem)
 157                 return -ENOTTY;
 158         return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
 159 }
 160
 161 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
 162 {
 163         return (sector >> (ns->lba_shift - 9));
 164 }
 165
 166 static inline void nvme_setup_flush(struct nvme_ns *ns,
 167                 struct nvme_command *cmnd)
 168 {
 169         memset(cmnd, 0, sizeof(*cmnd));
 170         cmnd->common.opcode = nvme_cmd_flush;
 171         cmnd->common.nsid = cpu_to_le32(ns->ns_id);
 172 }
 173
 174 static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req,
 175                 struct nvme_command *cmnd)
 176 {
 177         u16 control = 0;
 178         u32 dsmgmt = 0;
 179
 180         if (req->cmd_flags & REQ_FUA)
 181                 control |= NVME_RW_FUA;
 182         if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
 183                 control |= NVME_RW_LR;
 184
 185         if (req->cmd_flags & REQ_RAHEAD)
 186                 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
 187
 188         memset(cmnd, 0, sizeof(*cmnd));
 189         cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
 190         cmnd->rw.command_id = req->tag;
 191         cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
 192         cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
 193         cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
 194
 195         if (ns->ms) {
 196                 switch (ns->pi_type) {
 197                 case NVME_NS_DPS_PI_TYPE3:
 198                         control |= NVME_RW_PRINFO_PRCHK_GUARD;
 199                         break;
 200                 case NVME_NS_DPS_PI_TYPE1:
 201                 case NVME_NS_DPS_PI_TYPE2:
 202                         control |= NVME_RW_PRINFO_PRCHK_GUARD |
 203                                         NVME_RW_PRINFO_PRCHK_REF;
 204                         cmnd->rw.reftag = cpu_to_le32(
 205                                         nvme_block_nr(ns, blk_rq_pos(req)));
 206                         break;
 207                 }
 208                 if (!blk_integrity_rq(req))
 209                         control |= NVME_RW_PRINFO_PRACT;
 210         }
 211
 212         cmnd->rw.control = cpu_to_le16(control);
 213         cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
 214 }
 215
 216
 217 static inline int nvme_error_status(u16 status)
 218 {
 219         switch (status & 0x7ff) {
 220         case NVME_SC_SUCCESS:
 221                 return 0;
 222         case NVME_SC_CAP_EXCEEDED:
 223                 return -ENOSPC;
 224         default:
 225                 return -EIO;
 226         }
 227 }
 228
 229 static inline bool nvme_req_needs_retry(struct request *req, u16 status)
 230 {
 231         return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
 232                 (jiffies - req->start_time) < req->timeout;
 233 }
 234
 235 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
 236 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
 237 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
 238 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
 239                 const struct nvme_ctrl_ops *ops, unsigned long quirks);
 240 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
 241 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
 242 int nvme_init_identify(struct nvme_ctrl *ctrl);
 243
 244 void nvme_scan_namespaces(struct nvme_ctrl *ctrl);
 245 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
 246
 247 void nvme_stop_queues(struct nvme_ctrl *ctrl);
 248 void nvme_start_queues(struct nvme_ctrl *ctrl);
 249
 250 struct request *nvme_alloc_request(struct request_queue *q,
 251                 struct nvme_command *cmd, unsigned int flags);
 252 void nvme_requeue_req(struct request *req);
 253 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 254                 void *buf, unsigned bufflen);
 255 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 256                 void *buffer, unsigned bufflen,  u32 *result, unsigned timeout);
 257 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
 258                 void __user *ubuffer, unsigned bufflen, u32 *result,
 259                 unsigned timeout);
 260 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
 261                 void __user *ubuffer, unsigned bufflen,
 262                 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
 263                 u32 *result, unsigned timeout);
 264 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
 265 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
 266                 struct nvme_id_ns **id);
 267 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
 268 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
 269                         dma_addr_t dma_addr, u32 *result);
 270 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
 271                         dma_addr_t dma_addr, u32 *result);
 272 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
 273
 274 extern spinlock_t dev_list_lock;
 275
 276 struct sg_io_hdr;
 277
 278 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
 279 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
 280 int nvme_sg_get_version_num(int __user *ip);
 281
 282 #ifdef CONFIG_NVM
 283 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
 284 int nvme_nvm_register(struct request_queue *q, char *disk_name);
 285 void nvme_nvm_unregister(struct request_queue *q, char *disk_name);
 286 #else
 287 static inline int nvme_nvm_register(struct request_queue *q, char *disk_name)
 288 {
 289         return 0;
 290 }
 291
 292 static inline void nvme_nvm_unregister(struct request_queue *q, char *disk_name) {};
 293
 294 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
 295 {
 296         return 0;
 297 }
 298 #endif /* CONFIG_NVM */
 299
 300 int __init nvme_core_init(void);
 301 void nvme_core_exit(void);
 302
 303 #endif /* _NVME_H */