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 #include <linux/lightnvm.h>
  22
  23 enum {
  24         /*
  25          * Driver internal status code for commands that were cancelled due
  26          * to timeouts or controller shutdown.  The value is negative so
  27          * that it a) doesn't overlap with the unsigned hardware error codes,
  28          * and b) can easily be tested for.
  29          */
  30         NVME_SC_CANCELLED               = -EINTR,
  31 };
  32
  33 extern unsigned char nvme_io_timeout;
  34 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
  35
  36 extern unsigned char admin_timeout;
  37 #define ADMIN_TIMEOUT   (admin_timeout * HZ)
  38
  39 extern unsigned char shutdown_timeout;
  40 #define SHUTDOWN_TIMEOUT        (shutdown_timeout * HZ)
  41
  42 #define NVME_DEFAULT_KATO       5
  43 #define NVME_KATO_GRACE         10
  44
  45 extern unsigned int nvme_max_retries;
  46
  47 enum {
  48         NVME_NS_LBA             = 0,
  49         NVME_NS_LIGHTNVM        = 1,
  50 };
  51
  52 /*
  53  * List of workarounds for devices that required behavior not specified in
  54  * the standard.
  55  */
  56 enum nvme_quirks {
  57         /*
  58          * Prefers I/O aligned to a stripe size specified in a vendor
  59          * specific Identify field.
  60          */
  61         NVME_QUIRK_STRIPE_SIZE                  = (1 << 0),
  62
  63         /*
  64          * The controller doesn't handle Identify value others than 0 or 1
  65          * correctly.
  66          */
  67         NVME_QUIRK_IDENTIFY_CNS                 = (1 << 1),
  68
  69         /*
  70          * The controller deterministically returns O's on reads to discarded
  71          * logical blocks.
  72          */
  73         NVME_QUIRK_DISCARD_ZEROES               = (1 << 2),
  74
  75         /*
  76          * The controller needs a delay before starts checking the device
  77          * readiness, which is done by reading the NVME_CSTS_RDY bit.
  78          */
  79         NVME_QUIRK_DELAY_BEFORE_CHK_RDY         = (1 << 3),
  80
  81         /*
  82          * APST should not be used.
  83          */
  84         NVME_QUIRK_NO_APST                      = (1 << 4),
  85
  86         /*
  87          * The deepest sleep state should not be used.
  88          */
  89         NVME_QUIRK_NO_DEEPEST_PS                = (1 << 5),
  90 };
  91
  92 /*
  93  * Common request structure for NVMe passthrough.  All drivers must have
  94  * this structure as the first member of their request-private data.
  95  */
  96 struct nvme_request {
  97         struct nvme_command     *cmd;
  98         union nvme_result       result;
  99 };
 100
 101 static inline struct nvme_request *nvme_req(struct request *req)
 102 {
 103         return blk_mq_rq_to_pdu(req);
 104 }
 105
 106 /* The below value is the specific amount of delay needed before checking
 107  * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
 108  * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
 109  * found empirically.
 110  */
 111 #define NVME_QUIRK_DELAY_AMOUNT         2000
 112
 113 enum nvme_ctrl_state {
 114         NVME_CTRL_NEW,
 115         NVME_CTRL_LIVE,
 116         NVME_CTRL_RESETTING,
 117         NVME_CTRL_RECONNECTING,
 118         NVME_CTRL_DELETING,
 119         NVME_CTRL_DEAD,
 120 };
 121
 122 struct nvme_ctrl {
 123         enum nvme_ctrl_state state;
 124         bool identified;
 125         spinlock_t lock;
 126         const struct nvme_ctrl_ops *ops;
 127         struct request_queue *admin_q;
 128         struct request_queue *connect_q;
 129         struct device *dev;
 130         struct kref kref;
 131         int instance;
 132         struct blk_mq_tag_set *tagset;
 133         struct list_head namespaces;
 134         struct mutex namespaces_mutex;
 135         struct device *device;  /* char device */
 136         struct list_head node;
 137         struct ida ns_ida;
 138
 139         char name[12];
 140         char serial[20];
 141         char model[40];
 142         char firmware_rev[8];
 143         u16 cntlid;
 144
 145         u32 ctrl_config;
 146
 147         u32 page_size;
 148         u32 max_hw_sectors;
 149         u16 oncs;
 150         u16 vid;
 151         atomic_t abort_limit;
 152         u8 event_limit;
 153         u8 vwc;
 154         u32 vs;
 155         u32 sgls;
 156         u16 kas;
 157         u8 npss;
 158         u8 apsta;
 159         unsigned int kato;
 160         bool subsystem;
 161         unsigned long quirks;
 162         struct nvme_id_power_state psd[32];
 163         struct work_struct scan_work;
 164         struct work_struct async_event_work;
 165         struct delayed_work ka_work;
 166
 167         /* Power saving configuration */
 168         u64 ps_max_latency_us;
 169         bool apst_enabled;
 170
 171         /* Fabrics only */
 172         u16 sqsize;
 173         u32 ioccsz;
 174         u32 iorcsz;
 175         u16 icdoff;
 176         u16 maxcmd;
 177         struct nvmf_ctrl_options *opts;
 178 };
 179
 180 /*
 181  * An NVM Express namespace is equivalent to a SCSI LUN
 182  */
 183 struct nvme_ns {
 184         struct list_head list;
 185
 186         struct nvme_ctrl *ctrl;
 187         struct request_queue *queue;
 188         struct gendisk *disk;
 189         struct nvm_dev *ndev;
 190         struct kref kref;
 191         int instance;
 192
 193         u8 eui[8];
 194         u8 uuid[16];
 195
 196         unsigned ns_id;
 197         int lba_shift;
 198         u16 ms;
 199         bool ext;
 200         u8 pi_type;
 201         unsigned long flags;
 202
 203 #define NVME_NS_REMOVING 0
 204 #define NVME_NS_DEAD     1
 205
 206         u64 mode_select_num_blocks;
 207         u32 mode_select_block_len;
 208 };
 209
 210 struct nvme_ctrl_ops {
 211         const char *name;
 212         struct module *module;
 213         bool is_fabrics;
 214         int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 215         int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
 216         int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 217         int (*reset_ctrl)(struct nvme_ctrl *ctrl);
 218         void (*free_ctrl)(struct nvme_ctrl *ctrl);
 219         void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx);
 220         int (*delete_ctrl)(struct nvme_ctrl *ctrl);
 221         const char *(*get_subsysnqn)(struct nvme_ctrl *ctrl);
 222         int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
 223 };
 224
 225 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
 226 {
 227         u32 val = 0;
 228
 229         if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
 230                 return false;
 231         return val & NVME_CSTS_RDY;
 232 }
 233
 234 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
 235 {
 236         if (!ctrl->subsystem)
 237                 return -ENOTTY;
 238         return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
 239 }
 240
 241 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
 242 {
 243         return (sector >> (ns->lba_shift - 9));
 244 }
 245
 246 static inline void nvme_cleanup_cmd(struct request *req)
 247 {
 248         if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
 249                 kfree(page_address(req->special_vec.bv_page) +
 250                       req->special_vec.bv_offset);
 251         }
 252 }
 253
 254 static inline int nvme_error_status(u16 status)
 255 {
 256         switch (status & 0x7ff) {
 257         case NVME_SC_SUCCESS:
 258                 return 0;
 259         case NVME_SC_CAP_EXCEEDED:
 260                 return -ENOSPC;
 261         default:
 262                 return -EIO;
 263         }
 264 }
 265
 266 static inline bool nvme_req_needs_retry(struct request *req, u16 status)
 267 {
 268         return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
 269                 (jiffies - req->start_time) < req->timeout &&
 270                 req->retries < nvme_max_retries;
 271 }
 272
 273 void nvme_cancel_request(struct request *req, void *data, bool reserved);
 274 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
 275                 enum nvme_ctrl_state new_state);
 276 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
 277 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
 278 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
 279 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
 280                 const struct nvme_ctrl_ops *ops, unsigned long quirks);
 281 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
 282 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
 283 int nvme_init_identify(struct nvme_ctrl *ctrl);
 284
 285 void nvme_queue_scan(struct nvme_ctrl *ctrl);
 286 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
 287
 288 #define NVME_NR_AERS    1
 289 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
 290                 union nvme_result *res);
 291 void nvme_queue_async_events(struct nvme_ctrl *ctrl);
 292
 293 void nvme_stop_queues(struct nvme_ctrl *ctrl);
 294 void nvme_start_queues(struct nvme_ctrl *ctrl);
 295 void nvme_kill_queues(struct nvme_ctrl *ctrl);
 296
 297 #define NVME_QID_ANY -1
 298 struct request *nvme_alloc_request(struct request_queue *q,
 299                 struct nvme_command *cmd, unsigned int flags, int qid);
 300 void nvme_requeue_req(struct request *req);
 301 int nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
 302                 struct nvme_command *cmd);
 303 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 304                 void *buf, unsigned bufflen);
 305 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 306                 union nvme_result *result, void *buffer, unsigned bufflen,
 307                 unsigned timeout, int qid, int at_head, int flags);
 308 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
 309                 void __user *ubuffer, unsigned bufflen, u32 *result,
 310                 unsigned timeout);
 311 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
 312                 void __user *ubuffer, unsigned bufflen,
 313                 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
 314                 u32 *result, unsigned timeout);
 315 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
 316 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
 317                 struct nvme_id_ns **id);
 318 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
 319 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
 320                       void *buffer, size_t buflen, u32 *result);
 321 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
 322                       void *buffer, size_t buflen, u32 *result);
 323 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
 324 void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
 325 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
 326
 327 struct sg_io_hdr;
 328
 329 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
 330 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
 331 int nvme_sg_get_version_num(int __user *ip);
 332
 333 #ifdef CONFIG_NVM
 334 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
 335 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
 336 void nvme_nvm_unregister(struct nvme_ns *ns);
 337 int nvme_nvm_register_sysfs(struct nvme_ns *ns);
 338 void nvme_nvm_unregister_sysfs(struct nvme_ns *ns);
 339 #else
 340 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
 341                                     int node)
 342 {
 343         return 0;
 344 }
 345
 346 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
 347 static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns)
 348 {
 349         return 0;
 350 }
 351 static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {};
 352 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
 353 {
 354         return 0;
 355 }
 356 #endif /* CONFIG_NVM */
 357
 358 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
 359 {
 360         return dev_to_disk(dev)->private_data;
 361 }
 362
 363 int __init nvme_core_init(void);
 364 void nvme_core_exit(void);
 365
 366 #endif /* _NVME_H */