2 * Copyright (c) 2011-2014, Intel Corporation.
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.
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
17 #include <linux/nvme.h>
18 #include <linux/pci.h>
19 #include <linux/kref.h>
20 #include <linux/blk-mq.h>
22 struct nvme_passthru_cmd;
24 extern unsigned char nvme_io_timeout;
25 #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
27 extern unsigned char admin_timeout;
28 #define ADMIN_TIMEOUT (admin_timeout * HZ)
30 extern unsigned char shutdown_timeout;
31 #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
39 * List of workarounds for devices that required behavior not specified in
44 * Prefers I/O aligned to a stripe size specified in a vendor
45 * specific Identify field.
47 NVME_QUIRK_STRIPE_SIZE = (1 << 0),
51 const struct nvme_ctrl_ops *ops;
52 struct request_queue *admin_q;
75 * An NVM Express namespace is equivalent to a SCSI LUN
78 struct list_head list;
80 struct nvme_ctrl *ctrl;
81 struct request_queue *queue;
91 u64 mode_select_num_blocks;
92 u32 mode_select_block_len;
95 struct nvme_ctrl_ops {
96 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
97 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
98 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
99 void (*free_ctrl)(struct nvme_ctrl *ctrl);
102 static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
106 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
108 return val & NVME_CSTS_RDY;
111 static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
113 return (sector >> (ns->lba_shift - 9));
116 static inline void nvme_setup_flush(struct nvme_ns *ns,
117 struct nvme_command *cmnd)
119 memset(cmnd, 0, sizeof(*cmnd));
120 cmnd->common.opcode = nvme_cmd_flush;
121 cmnd->common.nsid = cpu_to_le32(ns->ns_id);
124 static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req,
125 struct nvme_command *cmnd)
130 if (req->cmd_flags & REQ_FUA)
131 control |= NVME_RW_FUA;
132 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
133 control |= NVME_RW_LR;
135 if (req->cmd_flags & REQ_RAHEAD)
136 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
138 memset(cmnd, 0, sizeof(*cmnd));
139 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
140 cmnd->rw.command_id = req->tag;
141 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
142 cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
143 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
146 switch (ns->pi_type) {
147 case NVME_NS_DPS_PI_TYPE3:
148 control |= NVME_RW_PRINFO_PRCHK_GUARD;
150 case NVME_NS_DPS_PI_TYPE1:
151 case NVME_NS_DPS_PI_TYPE2:
152 control |= NVME_RW_PRINFO_PRCHK_GUARD |
153 NVME_RW_PRINFO_PRCHK_REF;
154 cmnd->rw.reftag = cpu_to_le32(
155 nvme_block_nr(ns, blk_rq_pos(req)));
158 if (!blk_integrity_rq(req))
159 control |= NVME_RW_PRINFO_PRACT;
162 cmnd->rw.control = cpu_to_le16(control);
163 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
167 static inline int nvme_error_status(u16 status)
169 switch (status & 0x7ff) {
170 case NVME_SC_SUCCESS:
172 case NVME_SC_CAP_EXCEEDED:
179 int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
180 int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
181 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
182 void nvme_put_ctrl(struct nvme_ctrl *ctrl);
183 int nvme_init_identify(struct nvme_ctrl *ctrl);
184 void nvme_put_ns(struct nvme_ns *ns);
186 struct request *nvme_alloc_request(struct request_queue *q,
187 struct nvme_command *cmd, unsigned int flags);
188 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
189 void *buf, unsigned bufflen);
190 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
191 void *buffer, unsigned bufflen, u32 *result, unsigned timeout);
192 int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
193 void __user *ubuffer, unsigned bufflen, u32 *result,
195 int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
196 void __user *ubuffer, unsigned bufflen,
197 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
198 u32 *result, unsigned timeout);
199 int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
200 int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
201 struct nvme_id_ns **id);
202 int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
203 int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
204 dma_addr_t dma_addr, u32 *result);
205 int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
206 dma_addr_t dma_addr, u32 *result);
208 extern const struct block_device_operations nvme_fops;
209 extern spinlock_t dev_list_lock;
211 int nvme_revalidate_disk(struct gendisk *disk);
212 int nvme_user_cmd(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
213 struct nvme_passthru_cmd __user *ucmd);
217 int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
218 int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
219 int nvme_sg_get_version_num(int __user *ip);
221 int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
222 int nvme_nvm_register(struct request_queue *q, char *disk_name);
223 void nvme_nvm_unregister(struct request_queue *q, char *disk_name);