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