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