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