projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
nvme/host: reference the fabric module for each bdev open callout
[linux-2.6-block.git] / drivers / nvme / host / nvme.h
CommitLineData
f11bb3e2
CH		 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
297465c8
CH		 22enum {
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
f11bb3e2
CH		 32extern unsigned char nvme_io_timeout;
33#define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
34
21d34711
CH		 35extern unsigned char admin_timeout;
36#define ADMIN_TIMEOUT (admin_timeout * HZ)
37
5fd4ce1b
CH		 38extern unsigned char shutdown_timeout;
39#define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
40
ca064085
MB		 41enum {
42 NVME_NS_LBA = 0,
43 NVME_NS_LIGHTNVM = 1,
44};
45
f11bb3e2 46/*
106198ed
CH		 47 * List of workarounds for devices that required behavior not specified in
48 * the standard.
f11bb3e2 49 */
106198ed
CH		 50enum 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),
540c801c
KB		 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),
106198ed
CH		 62};
63
1c63dc66
CH		 64struct nvme_ctrl {
65 const struct nvme_ctrl_ops *ops;
f11bb3e2 66 struct request_queue *admin_q;
f11bb3e2 67 struct device *dev;
1673f1f0 68 struct kref kref;
f11bb3e2 69 int instance;
5bae7f73 70 struct blk_mq_tag_set *tagset;
f11bb3e2 71 struct list_head namespaces;
69d3b8ac 72 struct mutex namespaces_mutex;
5bae7f73 73 struct device *device; /* char device */
f3ca80fc 74 struct list_head node;
1c63dc66 75
f11bb3e2
CH		 76 char name[12];
77 char serial[20];
78 char model[40];
79 char firmware_rev[8];
5fd4ce1b
CH		 80
81 u32 ctrl_config;
82
83 u32 page_size;
f11bb3e2
CH		 84 u32 max_hw_sectors;
85 u32 stripe_size;
f11bb3e2 86 u16 oncs;
6bf25d16 87 atomic_t abort_limit;
f11bb3e2
CH		 88 u8 event_limit;
89 u8 vwc;
f3ca80fc
CH		 90 u32 vs;
91 bool subsystem;
106198ed 92 unsigned long quirks;
f11bb3e2
CH		 93};
94
95/*
96 * An NVM Express namespace is equivalent to a SCSI LUN
97 */
98struct nvme_ns {
99 struct list_head list;
100
1c63dc66 101 struct nvme_ctrl *ctrl;
f11bb3e2
CH		 102 struct request_queue *queue;
103 struct gendisk *disk;
104 struct kref kref;
105
2b9b6e86
KB		 106 u8 eui[8];
107 u8 uuid[16];
108
f11bb3e2
CH		 109 unsigned ns_id;
110 int lba_shift;
111 u16 ms;
112 bool ext;
113 u8 pi_type;
ca064085 114 int type;
f11bb3e2
CH		 115 u64 mode_select_num_blocks;
116 u32 mode_select_block_len;
117};
118
1c63dc66 119struct nvme_ctrl_ops {
e439bb12 120 struct module *module;
1c63dc66 121 int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
5fd4ce1b 122 int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
7fd8930f 123 int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
5bae7f73 124 bool (*io_incapable)(struct nvme_ctrl *ctrl);
f3ca80fc 125 int (*reset_ctrl)(struct nvme_ctrl *ctrl);
1673f1f0 126 void (*free_ctrl)(struct nvme_ctrl *ctrl);
f11bb3e2
CH		 127};
128
1c63dc66
CH		 129static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
130{
131 u32 val = 0;
132
133 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
134 return false;
135 return val & NVME_CSTS_RDY;
136}
137
5bae7f73
CH		 138static inline bool nvme_io_incapable(struct nvme_ctrl *ctrl)
139{
140 u32 val = 0;
141
142 if (ctrl->ops->io_incapable(ctrl))
143 return false;
144 if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
145 return false;
146 return val & NVME_CSTS_CFS;
147}
148
f3ca80fc
CH		 149static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
150{
151 if (!ctrl->subsystem)
152 return -ENOTTY;
153 return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
154}
155
f11bb3e2
CH		 156static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
157{
158 return (sector >> (ns->lba_shift - 9));
159}
160
22944e99
CH		 161static inline void nvme_setup_flush(struct nvme_ns *ns,
162 struct nvme_command *cmnd)
163{
164 memset(cmnd, 0, sizeof(*cmnd));
165 cmnd->common.opcode = nvme_cmd_flush;
166 cmnd->common.nsid = cpu_to_le32(ns->ns_id);
167}
168
169static inline void nvme_setup_rw(struct nvme_ns *ns, struct request *req,
170 struct nvme_command *cmnd)
171{
172 u16 control = 0;
173 u32 dsmgmt = 0;
174
175 if (req->cmd_flags & REQ_FUA)
176 control |= NVME_RW_FUA;
177 if (req->cmd_flags & (REQ_FAILFAST_DEV | REQ_RAHEAD))
178 control |= NVME_RW_LR;
179
180 if (req->cmd_flags & REQ_RAHEAD)
181 dsmgmt |= NVME_RW_DSM_FREQ_PREFETCH;
182
183 memset(cmnd, 0, sizeof(*cmnd));
184 cmnd->rw.opcode = (rq_data_dir(req) ? nvme_cmd_write : nvme_cmd_read);
185 cmnd->rw.command_id = req->tag;
186 cmnd->rw.nsid = cpu_to_le32(ns->ns_id);
187 cmnd->rw.slba = cpu_to_le64(nvme_block_nr(ns, blk_rq_pos(req)));
188 cmnd->rw.length = cpu_to_le16((blk_rq_bytes(req) >> ns->lba_shift) - 1);
189
190 if (ns->ms) {
191 switch (ns->pi_type) {
192 case NVME_NS_DPS_PI_TYPE3:
193 control |= NVME_RW_PRINFO_PRCHK_GUARD;
194 break;
195 case NVME_NS_DPS_PI_TYPE1:
196 case NVME_NS_DPS_PI_TYPE2:
197 control |= NVME_RW_PRINFO_PRCHK_GUARD |
198 NVME_RW_PRINFO_PRCHK_REF;
199 cmnd->rw.reftag = cpu_to_le32(
200 nvme_block_nr(ns, blk_rq_pos(req)));
201 break;
202 }
203 if (!blk_integrity_rq(req))
204 control |= NVME_RW_PRINFO_PRACT;
205 }
206
207 cmnd->rw.control = cpu_to_le16(control);
208 cmnd->rw.dsmgmt = cpu_to_le32(dsmgmt);
209}
210
211
15a190f7
CH		 212static inline int nvme_error_status(u16 status)
213{
214 switch (status & 0x7ff) {
215 case NVME_SC_SUCCESS:
216 return 0;
217 case NVME_SC_CAP_EXCEEDED:
218 return -ENOSPC;
219 default:
220 return -EIO;
221 }
222}
223
7688faa6
CH		 224static inline bool nvme_req_needs_retry(struct request *req, u16 status)
225{
226 return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
227 (jiffies - req->start_time) < req->timeout;
228}
229
5fd4ce1b
CH		 230int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
231int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
232int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
f3ca80fc
CH		 233int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
234 const struct nvme_ctrl_ops *ops, unsigned long quirks);
53029b04 235void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
1673f1f0 236void nvme_put_ctrl(struct nvme_ctrl *ctrl);
7fd8930f 237int nvme_init_identify(struct nvme_ctrl *ctrl);
5bae7f73
CH		 238
239void nvme_scan_namespaces(struct nvme_ctrl *ctrl);
240void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
1673f1f0 241
25646264
KB		 242void nvme_stop_queues(struct nvme_ctrl *ctrl);
243void nvme_start_queues(struct nvme_ctrl *ctrl);
363c9aac 244
4160982e
CH		 245struct request *nvme_alloc_request(struct request_queue *q,
246 struct nvme_command *cmd, unsigned int flags);
7688faa6 247void nvme_requeue_req(struct request *req);
f11bb3e2
CH		 248int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
249 void *buf, unsigned bufflen);
250int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
4160982e
CH		 251 void *buffer, unsigned bufflen, u32 *result, unsigned timeout);
252int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
253 void __user *ubuffer, unsigned bufflen, u32 *result,
254 unsigned timeout);
0b7f1f26
KB		 255int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
256 void __user *ubuffer, unsigned bufflen,
257 void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
f11bb3e2 258 u32 *result, unsigned timeout);
1c63dc66
CH		 259int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
260int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
f11bb3e2 261 struct nvme_id_ns **id);
1c63dc66
CH		 262int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
263int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
f11bb3e2 264 dma_addr_t dma_addr, u32 *result);
1c63dc66 265int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
f11bb3e2 266 dma_addr_t dma_addr, u32 *result);
9a0be7ab 267int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
f11bb3e2 268
1673f1f0 269extern spinlock_t dev_list_lock;
f11bb3e2
CH		 270
271struct sg_io_hdr;
272
273int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
274int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
275int nvme_sg_get_version_num(int __user *ip);
276
c4699e70 277#ifdef CONFIG_NVM
ca064085
MB		 278int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
279int nvme_nvm_register(struct request_queue *q, char *disk_name);
280void nvme_nvm_unregister(struct request_queue *q, char *disk_name);
c4699e70
KB		 281#else
282static inline int nvme_nvm_register(struct request_queue *q, char *disk_name)
283{
284 return 0;
285}
286
287static inline void nvme_nvm_unregister(struct request_queue *q, char *disk_name) {};
288
289static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
290{
291 return 0;
292}
293#endif /* CONFIG_NVM */
ca064085 294
5bae7f73
CH		 295int __init nvme_core_init(void);
296void nvme_core_exit(void);
297
f11bb3e2 298#endif /* _NVME_H */
Linux 6.x block layer and io_uring tree(s)