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 * The controller deterministically returns O's on reads to discarded 65 * logical blocks. 66 */ 67 NVME_QUIRK_DISCARD_ZEROES = (1 << 2), 68 }; 69 70 enum nvme_ctrl_state { 71 NVME_CTRL_NEW, 72 NVME_CTRL_LIVE, 73 NVME_CTRL_RESETTING, 74 NVME_CTRL_DELETING, 75 NVME_CTRL_DEAD, 76 }; 77 78 struct nvme_ctrl { 79 enum nvme_ctrl_state state; 80 spinlock_t lock; 81 const struct nvme_ctrl_ops *ops; 82 struct request_queue *admin_q; 83 struct request_queue *connect_q; 84 struct device *dev; 85 struct kref kref; 86 int instance; 87 struct blk_mq_tag_set *tagset; 88 struct list_head namespaces; 89 struct mutex namespaces_mutex; 90 struct device *device; /* char device */ 91 struct list_head node; 92 struct ida ns_ida; 93 94 char name[12]; 95 char serial[20]; 96 char model[40]; 97 char firmware_rev[8]; 98 u16 cntlid; 99 100 u32 ctrl_config; 101 102 u32 page_size; 103 u32 max_hw_sectors; 104 u32 stripe_size; 105 u16 oncs; 106 u16 vid; 107 atomic_t abort_limit; 108 u8 event_limit; 109 u8 vwc; 110 u32 vs; 111 u32 sgls; 112 bool subsystem; 113 unsigned long quirks; 114 struct work_struct scan_work; 115 struct work_struct async_event_work; 116 117 /* Fabrics only */ 118 u16 sqsize; 119 u32 ioccsz; 120 u32 iorcsz; 121 u16 icdoff; 122 u16 maxcmd; 123 struct nvmf_ctrl_options *opts; 124 }; 125 126 /* 127 * An NVM Express namespace is equivalent to a SCSI LUN 128 */ 129 struct nvme_ns { 130 struct list_head list; 131 132 struct nvme_ctrl *ctrl; 133 struct request_queue *queue; 134 struct gendisk *disk; 135 struct kref kref; 136 int instance; 137 138 u8 eui[8]; 139 u8 uuid[16]; 140 141 unsigned ns_id; 142 int lba_shift; 143 u16 ms; 144 bool ext; 145 u8 pi_type; 146 int type; 147 unsigned long flags; 148 149 #define NVME_NS_REMOVING 0 150 #define NVME_NS_DEAD 1 151 152 u64 mode_select_num_blocks; 153 u32 mode_select_block_len; 154 }; 155 156 struct nvme_ctrl_ops { 157 const char *name; 158 struct module *module; 159 bool is_fabrics; 160 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); 161 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); 162 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); 163 int (*reset_ctrl)(struct nvme_ctrl *ctrl); 164 void (*free_ctrl)(struct nvme_ctrl *ctrl); 165 void (*post_scan)(struct nvme_ctrl *ctrl); 166 void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx); 167 int (*delete_ctrl)(struct nvme_ctrl *ctrl); 168 const char *(*get_subsysnqn)(struct nvme_ctrl *ctrl); 169 int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size); 170 }; 171 172 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl) 173 { 174 u32 val = 0; 175 176 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val)) 177 return false; 178 return val & NVME_CSTS_RDY; 179 } 180 181 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) 182 { 183 if (!ctrl->subsystem) 184 return -ENOTTY; 185 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65); 186 } 187 188 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector) 189 { 190 return (sector >> (ns->lba_shift - 9)); 191 } 192 193 static inline unsigned nvme_map_len(struct request *rq) 194 { 195 if (req_op(rq) == REQ_OP_DISCARD) 196 return sizeof(struct nvme_dsm_range); 197 else 198 return blk_rq_bytes(rq); 199 } 200 201 static inline void nvme_cleanup_cmd(struct request *req) 202 { 203 if (req_op(req) == REQ_OP_DISCARD) 204 kfree(req->completion_data); 205 } 206 207 static inline int nvme_error_status(u16 status) 208 { 209 switch (status & 0x7ff) { 210 case NVME_SC_SUCCESS: 211 return 0; 212 case NVME_SC_CAP_EXCEEDED: 213 return -ENOSPC; 214 default: 215 return -EIO; 216 } 217 } 218 219 static inline bool nvme_req_needs_retry(struct request *req, u16 status) 220 { 221 return !(status & NVME_SC_DNR || blk_noretry_request(req)) && 222 (jiffies - req->start_time) < req->timeout; 223 } 224 225 void nvme_cancel_request(struct request *req, void *data, bool reserved); 226 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, 227 enum nvme_ctrl_state new_state); 228 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap); 229 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap); 230 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl); 231 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 232 const struct nvme_ctrl_ops *ops, unsigned long quirks); 233 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); 234 void nvme_put_ctrl(struct nvme_ctrl *ctrl); 235 int nvme_init_identify(struct nvme_ctrl *ctrl); 236 237 void nvme_queue_scan(struct nvme_ctrl *ctrl); 238 void nvme_remove_namespaces(struct nvme_ctrl *ctrl); 239 240 #define NVME_NR_AERS 1 241 void nvme_complete_async_event(struct nvme_ctrl *ctrl, 242 struct nvme_completion *cqe); 243 void nvme_queue_async_events(struct nvme_ctrl *ctrl); 244 245 void nvme_stop_queues(struct nvme_ctrl *ctrl); 246 void nvme_start_queues(struct nvme_ctrl *ctrl); 247 void nvme_kill_queues(struct nvme_ctrl *ctrl); 248 249 #define NVME_QID_ANY -1 250 struct request *nvme_alloc_request(struct request_queue *q, 251 struct nvme_command *cmd, unsigned int flags, int qid); 252 void nvme_requeue_req(struct request *req); 253 int nvme_setup_cmd(struct nvme_ns *ns, struct request *req, 254 struct nvme_command *cmd); 255 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 256 void *buf, unsigned bufflen); 257 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 258 struct nvme_completion *cqe, void *buffer, unsigned bufflen, 259 unsigned timeout, int qid, int at_head, int flags); 260 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd, 261 void __user *ubuffer, unsigned bufflen, u32 *result, 262 unsigned timeout); 263 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd, 264 void __user *ubuffer, unsigned bufflen, 265 void __user *meta_buffer, unsigned meta_len, u32 meta_seed, 266 u32 *result, unsigned timeout); 267 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id); 268 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid, 269 struct nvme_id_ns **id); 270 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log); 271 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid, 272 dma_addr_t dma_addr, u32 *result); 273 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11, 274 dma_addr_t dma_addr, u32 *result); 275 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); 276 277 struct sg_io_hdr; 278 279 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr); 280 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg); 281 int nvme_sg_get_version_num(int __user *ip); 282 283 #ifdef CONFIG_NVM 284 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id); 285 int nvme_nvm_register(struct request_queue *q, char *disk_name); 286 void nvme_nvm_unregister(struct request_queue *q, char *disk_name); 287 #else 288 static inline int nvme_nvm_register(struct request_queue *q, char *disk_name) 289 { 290 return 0; 291 } 292 293 static inline void nvme_nvm_unregister(struct request_queue *q, char *disk_name) {}; 294 295 static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id) 296 { 297 return 0; 298 } 299 #endif /* CONFIG_NVM */ 300 301 int __init nvme_core_init(void); 302 void nvme_core_exit(void); 303 304 #endif /* _NVME_H */ 305