]>
Commit | Line | Data |
---|---|---|
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> | |
b0b4e09c | 21 | #include <linux/lightnvm.h> |
a98e58e5 | 22 | #include <linux/sed-opal.h> |
f11bb3e2 | 23 | |
297465c8 CH |
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 | ||
f11bb3e2 CH |
34 | extern unsigned char nvme_io_timeout; |
35 | #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ) | |
36 | ||
21d34711 CH |
37 | extern unsigned char admin_timeout; |
38 | #define ADMIN_TIMEOUT (admin_timeout * HZ) | |
39 | ||
5fd4ce1b CH |
40 | extern unsigned char shutdown_timeout; |
41 | #define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ) | |
42 | ||
038bd4cb SG |
43 | #define NVME_DEFAULT_KATO 5 |
44 | #define NVME_KATO_GRACE 10 | |
45 | ||
f80ec966 KB |
46 | extern unsigned int nvme_max_retries; |
47 | ||
ca064085 MB |
48 | enum { |
49 | NVME_NS_LBA = 0, | |
50 | NVME_NS_LIGHTNVM = 1, | |
51 | }; | |
52 | ||
f11bb3e2 | 53 | /* |
106198ed CH |
54 | * List of workarounds for devices that required behavior not specified in |
55 | * the standard. | |
f11bb3e2 | 56 | */ |
106198ed CH |
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), | |
540c801c KB |
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), | |
08095e70 KB |
69 | |
70 | /* | |
71 | * The controller deterministically returns O's on reads to discarded | |
72 | * logical blocks. | |
73 | */ | |
74 | NVME_QUIRK_DISCARD_ZEROES = (1 << 2), | |
54adc010 GP |
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), | |
106198ed CH |
81 | }; |
82 | ||
d49187e9 CH |
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 | ||
54adc010 GP |
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 | ||
bb8d261e CH |
104 | enum nvme_ctrl_state { |
105 | NVME_CTRL_NEW, | |
106 | NVME_CTRL_LIVE, | |
107 | NVME_CTRL_RESETTING, | |
def61eca | 108 | NVME_CTRL_RECONNECTING, |
bb8d261e | 109 | NVME_CTRL_DELETING, |
0ff9d4e1 | 110 | NVME_CTRL_DEAD, |
bb8d261e CH |
111 | }; |
112 | ||
1c63dc66 | 113 | struct nvme_ctrl { |
bb8d261e CH |
114 | enum nvme_ctrl_state state; |
115 | spinlock_t lock; | |
1c63dc66 | 116 | const struct nvme_ctrl_ops *ops; |
f11bb3e2 | 117 | struct request_queue *admin_q; |
07bfcd09 | 118 | struct request_queue *connect_q; |
f11bb3e2 | 119 | struct device *dev; |
1673f1f0 | 120 | struct kref kref; |
f11bb3e2 | 121 | int instance; |
5bae7f73 | 122 | struct blk_mq_tag_set *tagset; |
f11bb3e2 | 123 | struct list_head namespaces; |
69d3b8ac | 124 | struct mutex namespaces_mutex; |
5bae7f73 | 125 | struct device *device; /* char device */ |
f3ca80fc | 126 | struct list_head node; |
075790eb | 127 | struct ida ns_ida; |
1c63dc66 | 128 | |
4f1244c8 | 129 | struct opal_dev *opal_dev; |
a98e58e5 | 130 | |
f11bb3e2 CH |
131 | char name[12]; |
132 | char serial[20]; | |
133 | char model[40]; | |
134 | char firmware_rev[8]; | |
76e3914a | 135 | u16 cntlid; |
5fd4ce1b CH |
136 | |
137 | u32 ctrl_config; | |
138 | ||
139 | u32 page_size; | |
f11bb3e2 | 140 | u32 max_hw_sectors; |
f11bb3e2 | 141 | u16 oncs; |
118472ab | 142 | u16 vid; |
8a9ae523 | 143 | u16 oacs; |
6bf25d16 | 144 | atomic_t abort_limit; |
f11bb3e2 CH |
145 | u8 event_limit; |
146 | u8 vwc; | |
f3ca80fc | 147 | u32 vs; |
07bfcd09 | 148 | u32 sgls; |
038bd4cb SG |
149 | u16 kas; |
150 | unsigned int kato; | |
f3ca80fc | 151 | bool subsystem; |
106198ed | 152 | unsigned long quirks; |
5955be21 | 153 | struct work_struct scan_work; |
f866fc42 | 154 | struct work_struct async_event_work; |
038bd4cb | 155 | struct delayed_work ka_work; |
07bfcd09 CH |
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; | |
f11bb3e2 CH |
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 | ||
1c63dc66 | 172 | struct nvme_ctrl *ctrl; |
f11bb3e2 CH |
173 | struct request_queue *queue; |
174 | struct gendisk *disk; | |
b0b4e09c | 175 | struct nvm_dev *ndev; |
f11bb3e2 | 176 | struct kref kref; |
075790eb | 177 | int instance; |
f11bb3e2 | 178 | |
2b9b6e86 KB |
179 | u8 eui[8]; |
180 | u8 uuid[16]; | |
181 | ||
f11bb3e2 CH |
182 | unsigned ns_id; |
183 | int lba_shift; | |
184 | u16 ms; | |
185 | bool ext; | |
186 | u8 pi_type; | |
646017a6 KB |
187 | unsigned long flags; |
188 | ||
189 | #define NVME_NS_REMOVING 0 | |
69d9a99c | 190 | #define NVME_NS_DEAD 1 |
646017a6 | 191 | |
f11bb3e2 CH |
192 | u64 mode_select_num_blocks; |
193 | u32 mode_select_block_len; | |
194 | }; | |
195 | ||
1c63dc66 | 196 | struct nvme_ctrl_ops { |
1a353d85 | 197 | const char *name; |
e439bb12 | 198 | struct module *module; |
07bfcd09 | 199 | bool is_fabrics; |
1c63dc66 | 200 | int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); |
5fd4ce1b | 201 | int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); |
7fd8930f | 202 | int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); |
f3ca80fc | 203 | int (*reset_ctrl)(struct nvme_ctrl *ctrl); |
1673f1f0 | 204 | void (*free_ctrl)(struct nvme_ctrl *ctrl); |
f866fc42 | 205 | void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx); |
1a353d85 ML |
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); | |
f11bb3e2 CH |
209 | }; |
210 | ||
1c63dc66 CH |
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 | ||
f3ca80fc CH |
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 | ||
f11bb3e2 CH |
227 | static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector) |
228 | { | |
229 | return (sector >> (ns->lba_shift - 9)); | |
230 | } | |
231 | ||
6904242d ML |
232 | static inline void nvme_cleanup_cmd(struct request *req) |
233 | { | |
f9d03f96 CH |
234 | if (req->rq_flags & RQF_SPECIAL_PAYLOAD) { |
235 | kfree(page_address(req->special_vec.bv_page) + | |
236 | req->special_vec.bv_offset); | |
237 | } | |
6904242d ML |
238 | } |
239 | ||
15a190f7 CH |
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 | ||
7688faa6 CH |
252 | static inline bool nvme_req_needs_retry(struct request *req, u16 status) |
253 | { | |
254 | return !(status & NVME_SC_DNR || blk_noretry_request(req)) && | |
f80ec966 KB |
255 | (jiffies - req->start_time) < req->timeout && |
256 | req->retries < nvme_max_retries; | |
7688faa6 CH |
257 | } |
258 | ||
c55a2fd4 | 259 | void nvme_cancel_request(struct request *req, void *data, bool reserved); |
bb8d261e CH |
260 | bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, |
261 | enum nvme_ctrl_state new_state); | |
5fd4ce1b CH |
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); | |
f3ca80fc CH |
265 | int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, |
266 | const struct nvme_ctrl_ops *ops, unsigned long quirks); | |
53029b04 | 267 | void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); |
1673f1f0 | 268 | void nvme_put_ctrl(struct nvme_ctrl *ctrl); |
7fd8930f | 269 | int nvme_init_identify(struct nvme_ctrl *ctrl); |
5bae7f73 | 270 | |
5955be21 | 271 | void nvme_queue_scan(struct nvme_ctrl *ctrl); |
5bae7f73 | 272 | void nvme_remove_namespaces(struct nvme_ctrl *ctrl); |
1673f1f0 | 273 | |
4f1244c8 CH |
274 | int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len, |
275 | bool send); | |
a98e58e5 | 276 | |
f866fc42 | 277 | #define NVME_NR_AERS 1 |
7bf58533 CH |
278 | void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, |
279 | union nvme_result *res); | |
f866fc42 CH |
280 | void nvme_queue_async_events(struct nvme_ctrl *ctrl); |
281 | ||
25646264 KB |
282 | void nvme_stop_queues(struct nvme_ctrl *ctrl); |
283 | void nvme_start_queues(struct nvme_ctrl *ctrl); | |
69d9a99c | 284 | void nvme_kill_queues(struct nvme_ctrl *ctrl); |
363c9aac | 285 | |
eb71f435 | 286 | #define NVME_QID_ANY -1 |
4160982e | 287 | struct request *nvme_alloc_request(struct request_queue *q, |
eb71f435 | 288 | struct nvme_command *cmd, unsigned int flags, int qid); |
7688faa6 | 289 | void nvme_requeue_req(struct request *req); |
8093f7ca ML |
290 | int nvme_setup_cmd(struct nvme_ns *ns, struct request *req, |
291 | struct nvme_command *cmd); | |
f11bb3e2 CH |
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, | |
d49187e9 | 295 | union nvme_result *result, void *buffer, unsigned bufflen, |
eb71f435 | 296 | unsigned timeout, int qid, int at_head, int flags); |
4160982e CH |
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); | |
0b7f1f26 KB |
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, | |
f11bb3e2 | 303 | u32 *result, unsigned timeout); |
1c63dc66 CH |
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, | |
f11bb3e2 | 306 | struct nvme_id_ns **id); |
1c63dc66 CH |
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, | |
1a6fe74d | 309 | void *buffer, size_t buflen, u32 *result); |
1c63dc66 | 310 | int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11, |
1a6fe74d | 311 | void *buffer, size_t buflen, u32 *result); |
9a0be7ab | 312 | int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); |
038bd4cb SG |
313 | void nvme_start_keep_alive(struct nvme_ctrl *ctrl); |
314 | void nvme_stop_keep_alive(struct nvme_ctrl *ctrl); | |
f11bb3e2 CH |
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 | ||
c4699e70 | 322 | #ifdef CONFIG_NVM |
ca064085 | 323 | int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id); |
3dc87dd0 | 324 | int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node); |
b0b4e09c | 325 | void nvme_nvm_unregister(struct nvme_ns *ns); |
3dc87dd0 MB |
326 | int nvme_nvm_register_sysfs(struct nvme_ns *ns); |
327 | void nvme_nvm_unregister_sysfs(struct nvme_ns *ns); | |
84d4add7 | 328 | int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg); |
c4699e70 | 329 | #else |
b0b4e09c | 330 | static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, |
3dc87dd0 | 331 | int node) |
c4699e70 KB |
332 | { |
333 | return 0; | |
334 | } | |
335 | ||
b0b4e09c | 336 | static inline void nvme_nvm_unregister(struct nvme_ns *ns) {}; |
3dc87dd0 MB |
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) {}; | |
c4699e70 KB |
342 | static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id) |
343 | { | |
344 | return 0; | |
345 | } | |
84d4add7 MB |
346 | static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, |
347 | unsigned long arg) | |
348 | { | |
349 | return -ENOTTY; | |
350 | } | |
3dc87dd0 MB |
351 | #endif /* CONFIG_NVM */ |
352 | ||
40267efd SL |
353 | static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) |
354 | { | |
355 | return dev_to_disk(dev)->private_data; | |
356 | } | |
ca064085 | 357 | |
5bae7f73 CH |
358 | int __init nvme_core_init(void); |
359 | void nvme_core_exit(void); | |
360 | ||
f11bb3e2 | 361 | #endif /* _NVME_H */ |