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