157dacad5SJay Sternberg /* 257dacad5SJay Sternberg * Copyright (c) 2011-2014, Intel Corporation. 357dacad5SJay Sternberg * 457dacad5SJay Sternberg * This program is free software; you can redistribute it and/or modify it 557dacad5SJay Sternberg * under the terms and conditions of the GNU General Public License, 657dacad5SJay Sternberg * version 2, as published by the Free Software Foundation. 757dacad5SJay Sternberg * 857dacad5SJay Sternberg * This program is distributed in the hope it will be useful, but WITHOUT 957dacad5SJay Sternberg * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1057dacad5SJay Sternberg * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 1157dacad5SJay Sternberg * more details. 1257dacad5SJay Sternberg */ 1357dacad5SJay Sternberg 1457dacad5SJay Sternberg #ifndef _NVME_H 1557dacad5SJay Sternberg #define _NVME_H 1657dacad5SJay Sternberg 1757dacad5SJay Sternberg #include <linux/nvme.h> 1857dacad5SJay Sternberg #include <linux/pci.h> 1957dacad5SJay Sternberg #include <linux/kref.h> 2057dacad5SJay Sternberg #include <linux/blk-mq.h> 2157dacad5SJay Sternberg 22297465c8SChristoph Hellwig enum { 23297465c8SChristoph Hellwig /* 24297465c8SChristoph Hellwig * Driver internal status code for commands that were cancelled due 25297465c8SChristoph Hellwig * to timeouts or controller shutdown. The value is negative so 26297465c8SChristoph Hellwig * that it a) doesn't overlap with the unsigned hardware error codes, 27297465c8SChristoph Hellwig * and b) can easily be tested for. 28297465c8SChristoph Hellwig */ 29297465c8SChristoph Hellwig NVME_SC_CANCELLED = -EINTR, 30297465c8SChristoph Hellwig }; 31297465c8SChristoph Hellwig 3257dacad5SJay Sternberg extern unsigned char nvme_io_timeout; 3357dacad5SJay Sternberg #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ) 3457dacad5SJay Sternberg 3521d34711SChristoph Hellwig extern unsigned char admin_timeout; 3621d34711SChristoph Hellwig #define ADMIN_TIMEOUT (admin_timeout * HZ) 3721d34711SChristoph Hellwig 385fd4ce1bSChristoph Hellwig extern unsigned char shutdown_timeout; 395fd4ce1bSChristoph Hellwig #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ) 405fd4ce1bSChristoph Hellwig 41ca064085SMatias Bjørling enum { 42ca064085SMatias Bjørling NVME_NS_LBA = 0, 43ca064085SMatias Bjørling NVME_NS_LIGHTNVM = 1, 44ca064085SMatias Bjørling }; 45ca064085SMatias Bjørling 46106198edSChristoph Hellwig /* 47106198edSChristoph Hellwig * List of workarounds for devices that required behavior not specified in 48106198edSChristoph Hellwig * the standard. 49106198edSChristoph Hellwig */ 50106198edSChristoph Hellwig enum nvme_quirks { 51106198edSChristoph Hellwig /* 52106198edSChristoph Hellwig * Prefers I/O aligned to a stripe size specified in a vendor 53106198edSChristoph Hellwig * specific Identify field. 54106198edSChristoph Hellwig */ 55106198edSChristoph Hellwig NVME_QUIRK_STRIPE_SIZE = (1 << 0), 56540c801cSKeith Busch 57540c801cSKeith Busch /* 58540c801cSKeith Busch * The controller doesn't handle Identify value others than 0 or 1 59540c801cSKeith Busch * correctly. 60540c801cSKeith Busch */ 61540c801cSKeith Busch NVME_QUIRK_IDENTIFY_CNS = (1 << 1), 62106198edSChristoph Hellwig }; 63106198edSChristoph Hellwig 641c63dc66SChristoph Hellwig struct nvme_ctrl { 651c63dc66SChristoph Hellwig const struct nvme_ctrl_ops *ops; 6657dacad5SJay Sternberg struct request_queue *admin_q; 6757dacad5SJay Sternberg struct device *dev; 681673f1f0SChristoph Hellwig struct kref kref; 6957dacad5SJay Sternberg int instance; 705bae7f73SChristoph Hellwig struct blk_mq_tag_set *tagset; 715bae7f73SChristoph Hellwig struct list_head namespaces; 725bae7f73SChristoph Hellwig struct device *device; /* char device */ 73f3ca80fcSChristoph Hellwig struct list_head node; 741c63dc66SChristoph Hellwig 7557dacad5SJay Sternberg char name[12]; 7657dacad5SJay Sternberg char serial[20]; 7757dacad5SJay Sternberg char model[40]; 7857dacad5SJay Sternberg char firmware_rev[8]; 795fd4ce1bSChristoph Hellwig 805fd4ce1bSChristoph Hellwig u32 ctrl_config; 815fd4ce1bSChristoph Hellwig 825fd4ce1bSChristoph Hellwig u32 page_size; 837fd8930fSChristoph Hellwig u32 max_hw_sectors; 847fd8930fSChristoph Hellwig u32 stripe_size; 8557dacad5SJay Sternberg u16 oncs; 866bf25d16SChristoph Hellwig atomic_t abort_limit; 8757dacad5SJay Sternberg u8 event_limit; 8857dacad5SJay Sternberg u8 vwc; 89f3ca80fcSChristoph Hellwig u32 vs; 90f3ca80fcSChristoph Hellwig bool subsystem; 91106198edSChristoph Hellwig unsigned long quirks; 9257dacad5SJay Sternberg }; 9357dacad5SJay Sternberg 9457dacad5SJay Sternberg /* 9557dacad5SJay Sternberg * An NVM Express namespace is equivalent to a SCSI LUN 9657dacad5SJay Sternberg */ 9757dacad5SJay Sternberg struct nvme_ns { 9857dacad5SJay Sternberg struct list_head list; 9957dacad5SJay Sternberg 1001c63dc66SChristoph Hellwig struct nvme_ctrl *ctrl; 10157dacad5SJay Sternberg struct request_queue *queue; 10257dacad5SJay Sternberg struct gendisk *disk; 10357dacad5SJay Sternberg struct kref kref; 10457dacad5SJay Sternberg 1052b9b6e86SKeith Busch u8 eui[8]; 1062b9b6e86SKeith Busch u8 uuid[16]; 1072b9b6e86SKeith Busch 10857dacad5SJay Sternberg unsigned ns_id; 10957dacad5SJay Sternberg int lba_shift; 11057dacad5SJay Sternberg u16 ms; 11157dacad5SJay Sternberg bool ext; 11257dacad5SJay Sternberg u8 pi_type; 113ca064085SMatias Bjørling int type; 11457dacad5SJay Sternberg u64 mode_select_num_blocks; 11557dacad5SJay Sternberg u32 mode_select_block_len; 11657dacad5SJay Sternberg }; 11757dacad5SJay Sternberg 1181c63dc66SChristoph Hellwig struct nvme_ctrl_ops { 1191c63dc66SChristoph Hellwig int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); 1205fd4ce1bSChristoph Hellwig int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); 1217fd8930fSChristoph Hellwig int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); 1225bae7f73SChristoph Hellwig bool (*io_incapable)(struct nvme_ctrl *ctrl); 123f3ca80fcSChristoph Hellwig int (*reset_ctrl)(struct nvme_ctrl *ctrl); 1241673f1f0SChristoph Hellwig void (*free_ctrl)(struct nvme_ctrl *ctrl); 1251c63dc66SChristoph Hellwig }; 1261c63dc66SChristoph Hellwig 1271c63dc66SChristoph Hellwig static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl) 1281c63dc66SChristoph Hellwig { 1291c63dc66SChristoph Hellwig u32 val = 0; 1301c63dc66SChristoph Hellwig 1311c63dc66SChristoph Hellwig if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val)) 1321c63dc66SChristoph Hellwig return false; 1331c63dc66SChristoph Hellwig return val & NVME_CSTS_RDY; 1341c63dc66SChristoph Hellwig } 1351c63dc66SChristoph Hellwig 1365bae7f73SChristoph Hellwig static inline bool nvme_io_incapable(struct nvme_ctrl *ctrl) 1375bae7f73SChristoph Hellwig { 1385bae7f73SChristoph Hellwig u32 val = 0; 1395bae7f73SChristoph Hellwig 1405bae7f73SChristoph Hellwig if (ctrl->ops->io_incapable(ctrl)) 1415bae7f73SChristoph Hellwig return false; 1425bae7f73SChristoph Hellwig if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val)) 1435bae7f73SChristoph Hellwig return false; 1445bae7f73SChristoph Hellwig return val & NVME_CSTS_CFS; 1455bae7f73SChristoph Hellwig } 1465bae7f73SChristoph Hellwig 147f3ca80fcSChristoph Hellwig static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) 148f3ca80fcSChristoph Hellwig { 149f3ca80fcSChristoph Hellwig if (!ctrl->subsystem) 150f3ca80fcSChristoph Hellwig return -ENOTTY; 151f3ca80fcSChristoph Hellwig return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65); 152f3ca80fcSChristoph Hellwig } 153f3ca80fcSChristoph Hellwig 15457dacad5SJay Sternberg static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector) 15557dacad5SJay Sternberg { 15657dacad5SJay Sternberg return (sector >> (ns->lba_shift - 9)); 15757dacad5SJay Sternberg } 15857dacad5SJay Sternberg 15922944e99SChristoph Hellwig static inline void nvme_setup_flush(struct nvme_ns *ns, 16022944e99SChristoph Hellwig struct nvme_command *cmnd) 16122944e99SChristoph Hellwig { 16222944e99SChristoph Hellwig memset(cmnd, 0, sizeof(*cmnd)); 16322944e99SChristoph Hellwig cmnd->common.opcode = nvme_cmd_flush; 16422944e99SChristoph Hellwig cmnd->common.nsid = cpu_to_le32(ns->ns_id); 16522944e99SChristoph Hellwig } 16622944e99SChristoph Hellwig 16722944e99SChristoph Hellwig static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req, 16822944e99SChristoph Hellwig struct nvme_command *cmnd) 16922944e99SChristoph Hellwig { 17022944e99SChristoph Hellwig u16 control = 0; 17122944e99SChristoph Hellwig u32 dsmgmt = 0; 17222944e99SChristoph Hellwig 17322944e99SChristoph Hellwig if (req->cmd_flags & REQ_FUA) 17422944e99SChristoph Hellwig control |= NVME_RW_FUA; 17522944e99SChristoph Hellwig if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD)) 17622944e99SChristoph Hellwig control |= NVME_RW_LR; 17722944e99SChristoph Hellwig 17822944e99SChristoph Hellwig if (req->cmd_flags & REQ_RAHEAD) 17922944e99SChristoph Hellwig dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH; 18022944e99SChristoph Hellwig 18122944e99SChristoph Hellwig memset(cmnd, 0, sizeof(*cmnd)); 18222944e99SChristoph Hellwig cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read); 18322944e99SChristoph Hellwig cmnd->rw.command_id = req->tag; 18422944e99SChristoph Hellwig cmnd->rw.nsid = cpu_to_le32(ns->ns_id); 18522944e99SChristoph Hellwig cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req))); 18622944e99SChristoph Hellwig cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1); 18722944e99SChristoph Hellwig 18822944e99SChristoph Hellwig if (ns->ms) { 18922944e99SChristoph Hellwig switch (ns->pi_type) { 19022944e99SChristoph Hellwig case NVME_NS_DPS_PI_TYPE3: 19122944e99SChristoph Hellwig control |= NVME_RW_PRINFO_PRCHK_GUARD; 19222944e99SChristoph Hellwig break; 19322944e99SChristoph Hellwig case NVME_NS_DPS_PI_TYPE1: 19422944e99SChristoph Hellwig case NVME_NS_DPS_PI_TYPE2: 19522944e99SChristoph Hellwig control |= NVME_RW_PRINFO_PRCHK_GUARD | 19622944e99SChristoph Hellwig NVME_RW_PRINFO_PRCHK_REF; 19722944e99SChristoph Hellwig cmnd->rw.reftag = cpu_to_le32( 19822944e99SChristoph Hellwig nvme_block_nr(ns, blk_rq_pos(req))); 19922944e99SChristoph Hellwig break; 20022944e99SChristoph Hellwig } 20122944e99SChristoph Hellwig if (!blk_integrity_rq(req)) 20222944e99SChristoph Hellwig control |= NVME_RW_PRINFO_PRACT; 20322944e99SChristoph Hellwig } 20422944e99SChristoph Hellwig 20522944e99SChristoph Hellwig cmnd->rw.control = cpu_to_le16(control); 20622944e99SChristoph Hellwig cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt); 20722944e99SChristoph Hellwig } 20822944e99SChristoph Hellwig 20922944e99SChristoph Hellwig 21015a190f7SChristoph Hellwig static inline int nvme_error_status(u16 status) 21115a190f7SChristoph Hellwig { 21215a190f7SChristoph Hellwig switch (status & 0x7ff) { 21315a190f7SChristoph Hellwig case NVME_SC_SUCCESS: 21415a190f7SChristoph Hellwig return 0; 21515a190f7SChristoph Hellwig case NVME_SC_CAP_EXCEEDED: 21615a190f7SChristoph Hellwig return -ENOSPC; 21715a190f7SChristoph Hellwig default: 21815a190f7SChristoph Hellwig return -EIO; 21915a190f7SChristoph Hellwig } 22015a190f7SChristoph Hellwig } 22115a190f7SChristoph Hellwig 2227688faa6SChristoph Hellwig static inline bool nvme_req_needs_retry(struct request *req, u16 status) 2237688faa6SChristoph Hellwig { 2247688faa6SChristoph Hellwig return !(status & NVME_SC_DNR || blk_noretry_request(req)) && 2257688faa6SChristoph Hellwig (jiffies - req->start_time) < req->timeout; 2267688faa6SChristoph Hellwig } 2277688faa6SChristoph Hellwig 2285fd4ce1bSChristoph Hellwig int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap); 2295fd4ce1bSChristoph Hellwig int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap); 2305fd4ce1bSChristoph Hellwig int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl); 231f3ca80fcSChristoph Hellwig int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, 232f3ca80fcSChristoph Hellwig const struct nvme_ctrl_ops *ops, unsigned long quirks); 23353029b04SKeith Busch void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); 2341673f1f0SChristoph Hellwig void nvme_put_ctrl(struct nvme_ctrl *ctrl); 2357fd8930fSChristoph Hellwig int nvme_init_identify(struct nvme_ctrl *ctrl); 2365bae7f73SChristoph Hellwig 2375bae7f73SChristoph Hellwig void nvme_scan_namespaces(struct nvme_ctrl *ctrl); 2385bae7f73SChristoph Hellwig void nvme_remove_namespaces(struct nvme_ctrl *ctrl); 2391673f1f0SChristoph Hellwig 2404160982eSChristoph Hellwig struct request *nvme_alloc_request(struct request_queue *q, 2414160982eSChristoph Hellwig struct nvme_command *cmd, unsigned int flags); 2427688faa6SChristoph Hellwig void nvme_requeue_req(struct request *req); 24357dacad5SJay Sternberg int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 24457dacad5SJay Sternberg void *buf, unsigned bufflen); 24557dacad5SJay Sternberg int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, 2464160982eSChristoph Hellwig void *buffer, unsigned bufflen, u32 *result, unsigned timeout); 2474160982eSChristoph Hellwig int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd, 2484160982eSChristoph Hellwig void __user *ubuffer, unsigned bufflen, u32 *result, 2494160982eSChristoph Hellwig unsigned timeout); 2500b7f1f26SKeith Busch int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd, 2510b7f1f26SKeith Busch void __user *ubuffer, unsigned bufflen, 2520b7f1f26SKeith Busch void __user *meta_buffer, unsigned meta_len, u32 meta_seed, 2530b7f1f26SKeith Busch u32 *result, unsigned timeout); 2541c63dc66SChristoph Hellwig int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id); 2551c63dc66SChristoph Hellwig int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid, 25657dacad5SJay Sternberg struct nvme_id_ns **id); 2571c63dc66SChristoph Hellwig int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log); 2581c63dc66SChristoph Hellwig int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid, 25957dacad5SJay Sternberg dma_addr_t dma_addr, u32 *result); 2601c63dc66SChristoph Hellwig int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11, 26157dacad5SJay Sternberg dma_addr_t dma_addr, u32 *result); 2629a0be7abSChristoph Hellwig int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); 26357dacad5SJay Sternberg 2641673f1f0SChristoph Hellwig extern spinlock_t dev_list_lock; 2651673f1f0SChristoph Hellwig 26657dacad5SJay Sternberg struct sg_io_hdr; 26757dacad5SJay Sternberg 26857dacad5SJay Sternberg int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr); 26957dacad5SJay Sternberg int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg); 27057dacad5SJay Sternberg int nvme_sg_get_version_num(int __user *ip); 27157dacad5SJay Sternberg 272ca064085SMatias Bjørling int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id); 273ca064085SMatias Bjørling int nvme_nvm_register(struct request_queue *q, char *disk_name); 274ca064085SMatias Bjørling void nvme_nvm_unregister(struct request_queue *q, char *disk_name); 275ca064085SMatias Bjørling 2765bae7f73SChristoph Hellwig int __init nvme_core_init(void); 2775bae7f73SChristoph Hellwig void nvme_core_exit(void); 2785bae7f73SChristoph Hellwig 27957dacad5SJay Sternberg #endif /* _NVME_H */ 280