]>
Commit | Line | Data |
---|---|---|
bc50ad75 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
f11bb3e2 CH |
2 | /* |
3 | * Copyright (c) 2011-2014, Intel Corporation. | |
f11bb3e2 CH |
4 | */ |
5 | ||
6 | #ifndef _NVME_H | |
7 | #define _NVME_H | |
8 | ||
9 | #include <linux/nvme.h> | |
a6a5149b | 10 | #include <linux/cdev.h> |
f11bb3e2 CH |
11 | #include <linux/pci.h> |
12 | #include <linux/kref.h> | |
13 | #include <linux/blk-mq.h> | |
b0b4e09c | 14 | #include <linux/lightnvm.h> |
a98e58e5 | 15 | #include <linux/sed-opal.h> |
b9e03857 | 16 | #include <linux/fault-inject.h> |
978628ec | 17 | #include <linux/rcupdate.h> |
c1ac9a4b | 18 | #include <linux/wait.h> |
4d2ce688 | 19 | #include <linux/t10-pi.h> |
f11bb3e2 | 20 | |
35fe0d12 HR |
21 | #include <trace/events/block.h> |
22 | ||
8ae4e447 | 23 | extern unsigned int nvme_io_timeout; |
f11bb3e2 CH |
24 | #define NVME_IO_TIMEOUT (nvme_io_timeout * HZ) |
25 | ||
8ae4e447 | 26 | extern unsigned int admin_timeout; |
21d34711 CH |
27 | #define ADMIN_TIMEOUT (admin_timeout * HZ) |
28 | ||
038bd4cb SG |
29 | #define NVME_DEFAULT_KATO 5 |
30 | #define NVME_KATO_GRACE 10 | |
31 | ||
38e18002 IR |
32 | #ifdef CONFIG_ARCH_NO_SG_CHAIN |
33 | #define NVME_INLINE_SG_CNT 0 | |
ba7ca2ae | 34 | #define NVME_INLINE_METADATA_SG_CNT 0 |
38e18002 IR |
35 | #else |
36 | #define NVME_INLINE_SG_CNT 2 | |
ba7ca2ae | 37 | #define NVME_INLINE_METADATA_SG_CNT 1 |
38e18002 IR |
38 | #endif |
39 | ||
6c3c05b0 CK |
40 | /* |
41 | * Default to a 4K page size, with the intention to update this | |
42 | * path in the future to accommodate architectures with differing | |
43 | * kernel and IO page sizes. | |
44 | */ | |
45 | #define NVME_CTRL_PAGE_SHIFT 12 | |
46 | #define NVME_CTRL_PAGE_SIZE (1 << NVME_CTRL_PAGE_SHIFT) | |
47 | ||
9a6327d2 | 48 | extern struct workqueue_struct *nvme_wq; |
b227c59b RS |
49 | extern struct workqueue_struct *nvme_reset_wq; |
50 | extern struct workqueue_struct *nvme_delete_wq; | |
9a6327d2 | 51 | |
ca064085 MB |
52 | enum { |
53 | NVME_NS_LBA = 0, | |
54 | NVME_NS_LIGHTNVM = 1, | |
55 | }; | |
56 | ||
f11bb3e2 | 57 | /* |
106198ed CH |
58 | * List of workarounds for devices that required behavior not specified in |
59 | * the standard. | |
f11bb3e2 | 60 | */ |
106198ed CH |
61 | enum nvme_quirks { |
62 | /* | |
63 | * Prefers I/O aligned to a stripe size specified in a vendor | |
64 | * specific Identify field. | |
65 | */ | |
66 | NVME_QUIRK_STRIPE_SIZE = (1 << 0), | |
540c801c KB |
67 | |
68 | /* | |
69 | * The controller doesn't handle Identify value others than 0 or 1 | |
70 | * correctly. | |
71 | */ | |
72 | NVME_QUIRK_IDENTIFY_CNS = (1 << 1), | |
08095e70 KB |
73 | |
74 | /* | |
e850fd16 CH |
75 | * The controller deterministically returns O's on reads to |
76 | * logical blocks that deallocate was called on. | |
08095e70 | 77 | */ |
e850fd16 | 78 | NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2), |
54adc010 GP |
79 | |
80 | /* | |
81 | * The controller needs a delay before starts checking the device | |
82 | * readiness, which is done by reading the NVME_CSTS_RDY bit. | |
83 | */ | |
84 | NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3), | |
c5552fde AL |
85 | |
86 | /* | |
87 | * APST should not be used. | |
88 | */ | |
89 | NVME_QUIRK_NO_APST = (1 << 4), | |
ff5350a8 AL |
90 | |
91 | /* | |
92 | * The deepest sleep state should not be used. | |
93 | */ | |
94 | NVME_QUIRK_NO_DEEPEST_PS = (1 << 5), | |
608cc4b1 CH |
95 | |
96 | /* | |
97 | * Supports the LighNVM command set if indicated in vs[1]. | |
98 | */ | |
99 | NVME_QUIRK_LIGHTNVM = (1 << 6), | |
9abd68ef JA |
100 | |
101 | /* | |
102 | * Set MEDIUM priority on SQ creation | |
103 | */ | |
104 | NVME_QUIRK_MEDIUM_PRIO_SQ = (1 << 7), | |
6299358d JD |
105 | |
106 | /* | |
107 | * Ignore device provided subnqn. | |
108 | */ | |
109 | NVME_QUIRK_IGNORE_DEV_SUBNQN = (1 << 8), | |
7b210e4e CH |
110 | |
111 | /* | |
112 | * Broken Write Zeroes. | |
113 | */ | |
114 | NVME_QUIRK_DISABLE_WRITE_ZEROES = (1 << 9), | |
cb32de1b ML |
115 | |
116 | /* | |
117 | * Force simple suspend/resume path. | |
118 | */ | |
119 | NVME_QUIRK_SIMPLE_SUSPEND = (1 << 10), | |
7ad67ca5 | 120 | |
66341331 BH |
121 | /* |
122 | * Use only one interrupt vector for all queues | |
123 | */ | |
7ad67ca5 | 124 | NVME_QUIRK_SINGLE_VECTOR = (1 << 11), |
66341331 BH |
125 | |
126 | /* | |
127 | * Use non-standard 128 bytes SQEs. | |
128 | */ | |
7ad67ca5 | 129 | NVME_QUIRK_128_BYTES_SQES = (1 << 12), |
d38e9f04 BH |
130 | |
131 | /* | |
132 | * Prevent tag overlap between queues | |
133 | */ | |
7ad67ca5 | 134 | NVME_QUIRK_SHARED_TAGS = (1 << 13), |
6c6aa2f2 AM |
135 | |
136 | /* | |
137 | * Don't change the value of the temperature threshold feature | |
138 | */ | |
139 | NVME_QUIRK_NO_TEMP_THRESH_CHANGE = (1 << 14), | |
5bedd3af CH |
140 | |
141 | /* | |
142 | * The controller doesn't handle the Identify Namespace | |
143 | * Identification Descriptor list subcommand despite claiming | |
144 | * NVMe 1.3 compliance. | |
145 | */ | |
146 | NVME_QUIRK_NO_NS_DESC_LIST = (1 << 15), | |
106198ed CH |
147 | }; |
148 | ||
d49187e9 CH |
149 | /* |
150 | * Common request structure for NVMe passthrough. All drivers must have | |
151 | * this structure as the first member of their request-private data. | |
152 | */ | |
153 | struct nvme_request { | |
154 | struct nvme_command *cmd; | |
155 | union nvme_result result; | |
44e44b29 | 156 | u8 retries; |
27fa9bc5 CH |
157 | u8 flags; |
158 | u16 status; | |
59e29ce6 | 159 | struct nvme_ctrl *ctrl; |
27fa9bc5 CH |
160 | }; |
161 | ||
32acab31 CH |
162 | /* |
163 | * Mark a bio as coming in through the mpath node. | |
164 | */ | |
165 | #define REQ_NVME_MPATH REQ_DRV | |
166 | ||
27fa9bc5 CH |
167 | enum { |
168 | NVME_REQ_CANCELLED = (1 << 0), | |
bb06ec31 | 169 | NVME_REQ_USERCMD = (1 << 1), |
d49187e9 CH |
170 | }; |
171 | ||
172 | static inline struct nvme_request *nvme_req(struct request *req) | |
173 | { | |
174 | return blk_mq_rq_to_pdu(req); | |
175 | } | |
176 | ||
5d87eb94 KB |
177 | static inline u16 nvme_req_qid(struct request *req) |
178 | { | |
643c476d | 179 | if (!req->q->queuedata) |
5d87eb94 KB |
180 | return 0; |
181 | return blk_mq_unique_tag_to_hwq(blk_mq_unique_tag(req)) + 1; | |
182 | } | |
183 | ||
54adc010 GP |
184 | /* The below value is the specific amount of delay needed before checking |
185 | * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the | |
186 | * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was | |
187 | * found empirically. | |
188 | */ | |
8c97eecc | 189 | #define NVME_QUIRK_DELAY_AMOUNT 2300 |
54adc010 | 190 | |
4212f4e9 SG |
191 | /* |
192 | * enum nvme_ctrl_state: Controller state | |
193 | * | |
194 | * @NVME_CTRL_NEW: New controller just allocated, initial state | |
195 | * @NVME_CTRL_LIVE: Controller is connected and I/O capable | |
196 | * @NVME_CTRL_RESETTING: Controller is resetting (or scheduled reset) | |
197 | * @NVME_CTRL_CONNECTING: Controller is disconnected, now connecting the | |
198 | * transport | |
199 | * @NVME_CTRL_DELETING: Controller is deleting (or scheduled deletion) | |
ecca390e SG |
200 | * @NVME_CTRL_DELETING_NOIO: Controller is deleting and I/O is not |
201 | * disabled/failed immediately. This state comes | |
202 | * after all async event processing took place and | |
203 | * before ns removal and the controller deletion | |
204 | * progress | |
4212f4e9 SG |
205 | * @NVME_CTRL_DEAD: Controller is non-present/unresponsive during |
206 | * shutdown or removal. In this case we forcibly | |
207 | * kill all inflight I/O as they have no chance to | |
208 | * complete | |
209 | */ | |
bb8d261e CH |
210 | enum nvme_ctrl_state { |
211 | NVME_CTRL_NEW, | |
212 | NVME_CTRL_LIVE, | |
213 | NVME_CTRL_RESETTING, | |
ad6a0a52 | 214 | NVME_CTRL_CONNECTING, |
bb8d261e | 215 | NVME_CTRL_DELETING, |
ecca390e | 216 | NVME_CTRL_DELETING_NOIO, |
0ff9d4e1 | 217 | NVME_CTRL_DEAD, |
bb8d261e CH |
218 | }; |
219 | ||
a3646451 AM |
220 | struct nvme_fault_inject { |
221 | #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS | |
222 | struct fault_attr attr; | |
223 | struct dentry *parent; | |
224 | bool dont_retry; /* DNR, do not retry */ | |
225 | u16 status; /* status code */ | |
226 | #endif | |
227 | }; | |
228 | ||
be93e87e KB |
229 | struct nvme_cel { |
230 | struct list_head entry; | |
231 | struct nvme_effects_log log; | |
232 | u8 csi; | |
233 | }; | |
234 | ||
1c63dc66 | 235 | struct nvme_ctrl { |
6e3ca03e | 236 | bool comp_seen; |
bb8d261e | 237 | enum nvme_ctrl_state state; |
bd4da3ab | 238 | bool identified; |
bb8d261e | 239 | spinlock_t lock; |
e7ad43c3 | 240 | struct mutex scan_lock; |
1c63dc66 | 241 | const struct nvme_ctrl_ops *ops; |
f11bb3e2 | 242 | struct request_queue *admin_q; |
07bfcd09 | 243 | struct request_queue *connect_q; |
e7832cb4 | 244 | struct request_queue *fabrics_q; |
f11bb3e2 | 245 | struct device *dev; |
f11bb3e2 | 246 | int instance; |
103e515e | 247 | int numa_node; |
5bae7f73 | 248 | struct blk_mq_tag_set *tagset; |
34b6c231 | 249 | struct blk_mq_tag_set *admin_tagset; |
f11bb3e2 | 250 | struct list_head namespaces; |
765cc031 | 251 | struct rw_semaphore namespaces_rwsem; |
d22524a4 | 252 | struct device ctrl_device; |
5bae7f73 | 253 | struct device *device; /* char device */ |
a6a5149b | 254 | struct cdev cdev; |
d86c4d8e | 255 | struct work_struct reset_work; |
c5017e85 | 256 | struct work_struct delete_work; |
c1ac9a4b | 257 | wait_queue_head_t state_wq; |
1c63dc66 | 258 | |
ab9e00cc CH |
259 | struct nvme_subsystem *subsys; |
260 | struct list_head subsys_entry; | |
261 | ||
4f1244c8 | 262 | struct opal_dev *opal_dev; |
a98e58e5 | 263 | |
f11bb3e2 | 264 | char name[12]; |
76e3914a | 265 | u16 cntlid; |
5fd4ce1b CH |
266 | |
267 | u32 ctrl_config; | |
b6dccf7f | 268 | u16 mtfa; |
d858e5f0 | 269 | u32 queue_count; |
5fd4ce1b | 270 | |
20d0dfe6 | 271 | u64 cap; |
f11bb3e2 | 272 | u32 max_hw_sectors; |
943e942e | 273 | u32 max_segments; |
95093350 | 274 | u32 max_integrity_segments; |
240e6ee2 KB |
275 | #ifdef CONFIG_BLK_DEV_ZONED |
276 | u32 max_zone_append; | |
277 | #endif | |
49cd84b6 | 278 | u16 crdt[3]; |
f11bb3e2 | 279 | u16 oncs; |
8a9ae523 | 280 | u16 oacs; |
f5d11840 JA |
281 | u16 nssa; |
282 | u16 nr_streams; | |
f968688f | 283 | u16 sqsize; |
0d0b660f | 284 | u32 max_namespaces; |
6bf25d16 | 285 | atomic_t abort_limit; |
f11bb3e2 | 286 | u8 vwc; |
f3ca80fc | 287 | u32 vs; |
07bfcd09 | 288 | u32 sgls; |
038bd4cb | 289 | u16 kas; |
c5552fde AL |
290 | u8 npss; |
291 | u8 apsta; | |
400b6a7b GR |
292 | u16 wctemp; |
293 | u16 cctemp; | |
c0561f82 | 294 | u32 oaes; |
e3d7874d | 295 | u32 aen_result; |
3e53ba38 | 296 | u32 ctratt; |
07fbd32a | 297 | unsigned int shutdown_timeout; |
038bd4cb | 298 | unsigned int kato; |
f3ca80fc | 299 | bool subsystem; |
106198ed | 300 | unsigned long quirks; |
c5552fde | 301 | struct nvme_id_power_state psd[32]; |
84fef62d | 302 | struct nvme_effects_log *effects; |
1cf7a12e | 303 | struct xarray cels; |
5955be21 | 304 | struct work_struct scan_work; |
f866fc42 | 305 | struct work_struct async_event_work; |
038bd4cb | 306 | struct delayed_work ka_work; |
0a34e466 | 307 | struct nvme_command ka_cmd; |
b6dccf7f | 308 | struct work_struct fw_act_work; |
30d90964 | 309 | unsigned long events; |
07bfcd09 | 310 | |
0d0b660f CH |
311 | #ifdef CONFIG_NVME_MULTIPATH |
312 | /* asymmetric namespace access: */ | |
313 | u8 anacap; | |
314 | u8 anatt; | |
315 | u32 anagrpmax; | |
316 | u32 nanagrpid; | |
317 | struct mutex ana_lock; | |
318 | struct nvme_ana_rsp_hdr *ana_log_buf; | |
319 | size_t ana_log_size; | |
320 | struct timer_list anatt_timer; | |
321 | struct work_struct ana_work; | |
322 | #endif | |
323 | ||
c5552fde AL |
324 | /* Power saving configuration */ |
325 | u64 ps_max_latency_us; | |
76a5af84 | 326 | bool apst_enabled; |
c5552fde | 327 | |
044a9df1 | 328 | /* PCIe only: */ |
fe6d53c9 CH |
329 | u32 hmpre; |
330 | u32 hmmin; | |
044a9df1 CH |
331 | u32 hmminds; |
332 | u16 hmmaxd; | |
fe6d53c9 | 333 | |
07bfcd09 | 334 | /* Fabrics only */ |
07bfcd09 CH |
335 | u32 ioccsz; |
336 | u32 iorcsz; | |
337 | u16 icdoff; | |
338 | u16 maxcmd; | |
fdf9dfa8 | 339 | int nr_reconnects; |
07bfcd09 | 340 | struct nvmf_ctrl_options *opts; |
cb5b7262 JA |
341 | |
342 | struct page *discard_page; | |
343 | unsigned long discard_page_busy; | |
f79d5fda AM |
344 | |
345 | struct nvme_fault_inject fault_inject; | |
f11bb3e2 CH |
346 | }; |
347 | ||
75c10e73 HR |
348 | enum nvme_iopolicy { |
349 | NVME_IOPOLICY_NUMA, | |
350 | NVME_IOPOLICY_RR, | |
351 | }; | |
352 | ||
ab9e00cc CH |
353 | struct nvme_subsystem { |
354 | int instance; | |
355 | struct device dev; | |
356 | /* | |
357 | * Because we unregister the device on the last put we need | |
358 | * a separate refcount. | |
359 | */ | |
360 | struct kref ref; | |
361 | struct list_head entry; | |
362 | struct mutex lock; | |
363 | struct list_head ctrls; | |
ed754e5d | 364 | struct list_head nsheads; |
ab9e00cc CH |
365 | char subnqn[NVMF_NQN_SIZE]; |
366 | char serial[20]; | |
367 | char model[40]; | |
368 | char firmware_rev[8]; | |
369 | u8 cmic; | |
370 | u16 vendor_id; | |
81adb863 | 371 | u16 awupf; /* 0's based awupf value. */ |
ed754e5d | 372 | struct ida ns_ida; |
75c10e73 HR |
373 | #ifdef CONFIG_NVME_MULTIPATH |
374 | enum nvme_iopolicy iopolicy; | |
375 | #endif | |
ab9e00cc CH |
376 | }; |
377 | ||
002fab04 CH |
378 | /* |
379 | * Container structure for uniqueue namespace identifiers. | |
380 | */ | |
381 | struct nvme_ns_ids { | |
382 | u8 eui64[8]; | |
383 | u8 nguid[16]; | |
384 | uuid_t uuid; | |
71010c30 | 385 | u8 csi; |
002fab04 CH |
386 | }; |
387 | ||
ed754e5d CH |
388 | /* |
389 | * Anchor structure for namespaces. There is one for each namespace in a | |
390 | * NVMe subsystem that any of our controllers can see, and the namespace | |
391 | * structure for each controller is chained of it. For private namespaces | |
392 | * there is a 1:1 relation to our namespace structures, that is ->list | |
393 | * only ever has a single entry for private namespaces. | |
394 | */ | |
395 | struct nvme_ns_head { | |
396 | struct list_head list; | |
397 | struct srcu_struct srcu; | |
398 | struct nvme_subsystem *subsys; | |
399 | unsigned ns_id; | |
400 | struct nvme_ns_ids ids; | |
401 | struct list_head entry; | |
402 | struct kref ref; | |
0c284db7 | 403 | bool shared; |
ed754e5d | 404 | int instance; |
be93e87e | 405 | struct nvme_effects_log *effects; |
f3334447 CH |
406 | #ifdef CONFIG_NVME_MULTIPATH |
407 | struct gendisk *disk; | |
408 | struct bio_list requeue_list; | |
409 | spinlock_t requeue_lock; | |
410 | struct work_struct requeue_work; | |
411 | struct mutex lock; | |
d8a22f85 AE |
412 | unsigned long flags; |
413 | #define NVME_NSHEAD_DISK_LIVE 0 | |
f3334447 CH |
414 | struct nvme_ns __rcu *current_path[]; |
415 | #endif | |
ed754e5d CH |
416 | }; |
417 | ||
ffc89b1d MG |
418 | enum nvme_ns_features { |
419 | NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */ | |
b29f8485 | 420 | NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */ |
ffc89b1d MG |
421 | }; |
422 | ||
f11bb3e2 CH |
423 | struct nvme_ns { |
424 | struct list_head list; | |
425 | ||
1c63dc66 | 426 | struct nvme_ctrl *ctrl; |
f11bb3e2 CH |
427 | struct request_queue *queue; |
428 | struct gendisk *disk; | |
0d0b660f CH |
429 | #ifdef CONFIG_NVME_MULTIPATH |
430 | enum nvme_ana_state ana_state; | |
431 | u32 ana_grpid; | |
432 | #endif | |
ed754e5d | 433 | struct list_head siblings; |
b0b4e09c | 434 | struct nvm_dev *ndev; |
f11bb3e2 | 435 | struct kref kref; |
ed754e5d | 436 | struct nvme_ns_head *head; |
f11bb3e2 | 437 | |
f11bb3e2 CH |
438 | int lba_shift; |
439 | u16 ms; | |
f5d11840 JA |
440 | u16 sgs; |
441 | u32 sws; | |
f11bb3e2 | 442 | u8 pi_type; |
240e6ee2 KB |
443 | #ifdef CONFIG_BLK_DEV_ZONED |
444 | u64 zsze; | |
445 | #endif | |
ffc89b1d | 446 | unsigned long features; |
646017a6 | 447 | unsigned long flags; |
0d0b660f CH |
448 | #define NVME_NS_REMOVING 0 |
449 | #define NVME_NS_DEAD 1 | |
450 | #define NVME_NS_ANA_PENDING 2 | |
b9e03857 | 451 | |
b9e03857 | 452 | struct nvme_fault_inject fault_inject; |
b9e03857 | 453 | |
f11bb3e2 CH |
454 | }; |
455 | ||
4d2ce688 JS |
456 | /* NVMe ns supports metadata actions by the controller (generate/strip) */ |
457 | static inline bool nvme_ns_has_pi(struct nvme_ns *ns) | |
458 | { | |
459 | return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple); | |
460 | } | |
461 | ||
1c63dc66 | 462 | struct nvme_ctrl_ops { |
1a353d85 | 463 | const char *name; |
e439bb12 | 464 | struct module *module; |
d3d5b87d CH |
465 | unsigned int flags; |
466 | #define NVME_F_FABRICS (1 << 0) | |
c81bfba9 | 467 | #define NVME_F_METADATA_SUPPORTED (1 << 1) |
e0596ab2 | 468 | #define NVME_F_PCI_P2PDMA (1 << 2) |
1c63dc66 | 469 | int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val); |
5fd4ce1b | 470 | int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val); |
7fd8930f | 471 | int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val); |
1673f1f0 | 472 | void (*free_ctrl)(struct nvme_ctrl *ctrl); |
ad22c355 | 473 | void (*submit_async_event)(struct nvme_ctrl *ctrl); |
c5017e85 | 474 | void (*delete_ctrl)(struct nvme_ctrl *ctrl); |
1a353d85 | 475 | int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size); |
f11bb3e2 CH |
476 | }; |
477 | ||
b9e03857 | 478 | #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS |
a3646451 AM |
479 | void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, |
480 | const char *dev_name); | |
481 | void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject); | |
b9e03857 TT |
482 | void nvme_should_fail(struct request *req); |
483 | #else | |
a3646451 AM |
484 | static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj, |
485 | const char *dev_name) | |
486 | { | |
487 | } | |
488 | static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj) | |
489 | { | |
490 | } | |
b9e03857 TT |
491 | static inline void nvme_should_fail(struct request *req) {} |
492 | #endif | |
493 | ||
f3ca80fc CH |
494 | static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl) |
495 | { | |
496 | if (!ctrl->subsystem) | |
497 | return -ENOTTY; | |
498 | return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65); | |
499 | } | |
500 | ||
314d48dd DLM |
501 | /* |
502 | * Convert a 512B sector number to a device logical block number. | |
503 | */ | |
504 | static inline u64 nvme_sect_to_lba(struct nvme_ns *ns, sector_t sector) | |
f11bb3e2 | 505 | { |
314d48dd | 506 | return sector >> (ns->lba_shift - SECTOR_SHIFT); |
f11bb3e2 CH |
507 | } |
508 | ||
e08f2ae8 DLM |
509 | /* |
510 | * Convert a device logical block number to a 512B sector number. | |
511 | */ | |
512 | static inline sector_t nvme_lba_to_sect(struct nvme_ns *ns, u64 lba) | |
f11bb3e2 | 513 | { |
e08f2ae8 | 514 | return lba << (ns->lba_shift - SECTOR_SHIFT); |
f11bb3e2 CH |
515 | } |
516 | ||
71fb90eb KB |
517 | /* |
518 | * Convert byte length to nvme's 0-based num dwords | |
519 | */ | |
520 | static inline u32 nvme_bytes_to_numd(size_t len) | |
521 | { | |
522 | return (len >> 2) - 1; | |
523 | } | |
524 | ||
5ddaabe8 CH |
525 | static inline bool nvme_is_ana_error(u16 status) |
526 | { | |
527 | switch (status & 0x7ff) { | |
528 | case NVME_SC_ANA_TRANSITION: | |
529 | case NVME_SC_ANA_INACCESSIBLE: | |
530 | case NVME_SC_ANA_PERSISTENT_LOSS: | |
531 | return true; | |
532 | default: | |
533 | return false; | |
534 | } | |
535 | } | |
536 | ||
537 | static inline bool nvme_is_path_error(u16 status) | |
538 | { | |
1e41f3bd CH |
539 | /* check for a status code type of 'path related status' */ |
540 | return (status & 0x700) == 0x300; | |
5ddaabe8 CH |
541 | } |
542 | ||
2eb81a33 CH |
543 | /* |
544 | * Fill in the status and result information from the CQE, and then figure out | |
545 | * if blk-mq will need to use IPI magic to complete the request, and if yes do | |
546 | * so. If not let the caller complete the request without an indirect function | |
547 | * call. | |
548 | */ | |
549 | static inline bool nvme_try_complete_req(struct request *req, __le16 status, | |
27fa9bc5 | 550 | union nvme_result result) |
15a190f7 | 551 | { |
27fa9bc5 | 552 | struct nvme_request *rq = nvme_req(req); |
15a190f7 | 553 | |
27fa9bc5 CH |
554 | rq->status = le16_to_cpu(status) >> 1; |
555 | rq->result = result; | |
b9e03857 TT |
556 | /* inject error when permitted by fault injection framework */ |
557 | nvme_should_fail(req); | |
ff029451 CH |
558 | if (unlikely(blk_should_fake_timeout(req->q))) |
559 | return true; | |
560 | return blk_mq_complete_request_remote(req); | |
7688faa6 CH |
561 | } |
562 | ||
d22524a4 CH |
563 | static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl) |
564 | { | |
565 | get_device(ctrl->device); | |
566 | } | |
567 | ||
568 | static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl) | |
569 | { | |
570 | put_device(ctrl->device); | |
571 | } | |
572 | ||
58a8df67 IR |
573 | static inline bool nvme_is_aen_req(u16 qid, __u16 command_id) |
574 | { | |
575 | return !qid && command_id >= NVME_AQ_BLK_MQ_DEPTH; | |
576 | } | |
577 | ||
77f02a7a | 578 | void nvme_complete_rq(struct request *req); |
7baa8572 | 579 | bool nvme_cancel_request(struct request *req, void *data, bool reserved); |
bb8d261e CH |
580 | bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl, |
581 | enum nvme_ctrl_state new_state); | |
c1ac9a4b | 582 | bool nvme_wait_reset(struct nvme_ctrl *ctrl); |
b5b05048 | 583 | int nvme_disable_ctrl(struct nvme_ctrl *ctrl); |
c0f2f45b | 584 | int nvme_enable_ctrl(struct nvme_ctrl *ctrl); |
5fd4ce1b | 585 | int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl); |
f3ca80fc CH |
586 | int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev, |
587 | const struct nvme_ctrl_ops *ops, unsigned long quirks); | |
53029b04 | 588 | void nvme_uninit_ctrl(struct nvme_ctrl *ctrl); |
d09f2b45 SG |
589 | void nvme_start_ctrl(struct nvme_ctrl *ctrl); |
590 | void nvme_stop_ctrl(struct nvme_ctrl *ctrl); | |
7fd8930f | 591 | int nvme_init_identify(struct nvme_ctrl *ctrl); |
5bae7f73 | 592 | |
5bae7f73 | 593 | void nvme_remove_namespaces(struct nvme_ctrl *ctrl); |
1673f1f0 | 594 | |
4f1244c8 CH |
595 | int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len, |
596 | bool send); | |
a98e58e5 | 597 | |
7bf58533 | 598 | void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status, |
287a63eb | 599 | volatile union nvme_result *res); |
f866fc42 | 600 | |
25646264 KB |
601 | void nvme_stop_queues(struct nvme_ctrl *ctrl); |
602 | void nvme_start_queues(struct nvme_ctrl *ctrl); | |
69d9a99c | 603 | void nvme_kill_queues(struct nvme_ctrl *ctrl); |
d6135c3a | 604 | void nvme_sync_queues(struct nvme_ctrl *ctrl); |
302ad8cc KB |
605 | void nvme_unfreeze(struct nvme_ctrl *ctrl); |
606 | void nvme_wait_freeze(struct nvme_ctrl *ctrl); | |
7cf0d7c0 | 607 | int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout); |
302ad8cc | 608 | void nvme_start_freeze(struct nvme_ctrl *ctrl); |
363c9aac | 609 | |
eb71f435 | 610 | #define NVME_QID_ANY -1 |
4160982e | 611 | struct request *nvme_alloc_request(struct request_queue *q, |
9a95e4ef | 612 | struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid); |
f7f1fc36 | 613 | void nvme_cleanup_cmd(struct request *req); |
fc17b653 | 614 | blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req, |
8093f7ca | 615 | struct nvme_command *cmd); |
f11bb3e2 CH |
616 | int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, |
617 | void *buf, unsigned bufflen); | |
618 | int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd, | |
d49187e9 | 619 | union nvme_result *result, void *buffer, unsigned bufflen, |
9a95e4ef | 620 | unsigned timeout, int qid, int at_head, |
6287b51c | 621 | blk_mq_req_flags_t flags, bool poll); |
1a87ee65 KB |
622 | int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid, |
623 | unsigned int dword11, void *buffer, size_t buflen, | |
624 | u32 *result); | |
625 | int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid, | |
626 | unsigned int dword11, void *buffer, size_t buflen, | |
627 | u32 *result); | |
9a0be7ab | 628 | int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count); |
038bd4cb | 629 | void nvme_stop_keep_alive(struct nvme_ctrl *ctrl); |
d86c4d8e | 630 | int nvme_reset_ctrl(struct nvme_ctrl *ctrl); |
79c48ccf | 631 | int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl); |
c1ac9a4b | 632 | int nvme_try_sched_reset(struct nvme_ctrl *ctrl); |
c5017e85 | 633 | int nvme_delete_ctrl(struct nvme_ctrl *ctrl); |
f11bb3e2 | 634 | |
be93e87e | 635 | int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi, |
0e98719b | 636 | void *log, size_t size, u64 offset); |
240e6ee2 KB |
637 | struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk, |
638 | struct nvme_ns_head **head, int *srcu_idx); | |
639 | void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx); | |
d558fb51 | 640 | |
33b14f67 | 641 | extern const struct attribute_group *nvme_ns_id_attr_groups[]; |
32acab31 CH |
642 | extern const struct block_device_operations nvme_ns_head_ops; |
643 | ||
644 | #ifdef CONFIG_NVME_MULTIPATH | |
66b20ac0 MR |
645 | static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) |
646 | { | |
647 | return ctrl->ana_log_buf != NULL; | |
648 | } | |
649 | ||
b9156dae SG |
650 | void nvme_mpath_unfreeze(struct nvme_subsystem *subsys); |
651 | void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys); | |
652 | void nvme_mpath_start_freeze(struct nvme_subsystem *subsys); | |
a785dbcc KB |
653 | void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns, |
654 | struct nvme_ctrl *ctrl, int *flags); | |
5ddaabe8 | 655 | void nvme_failover_req(struct request *req); |
32acab31 CH |
656 | void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl); |
657 | int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head); | |
0d0b660f | 658 | void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id); |
32acab31 | 659 | void nvme_mpath_remove_disk(struct nvme_ns_head *head); |
0d0b660f CH |
660 | int nvme_mpath_init(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id); |
661 | void nvme_mpath_uninit(struct nvme_ctrl *ctrl); | |
662 | void nvme_mpath_stop(struct nvme_ctrl *ctrl); | |
0157ec8d SG |
663 | bool nvme_mpath_clear_current_path(struct nvme_ns *ns); |
664 | void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl); | |
32acab31 | 665 | struct nvme_ns *nvme_find_path(struct nvme_ns_head *head); |
c62b37d9 | 666 | blk_qc_t nvme_ns_head_submit_bio(struct bio *bio); |
479a322f SG |
667 | |
668 | static inline void nvme_mpath_check_last_path(struct nvme_ns *ns) | |
669 | { | |
670 | struct nvme_ns_head *head = ns->head; | |
671 | ||
672 | if (head->disk && list_empty(&head->list)) | |
673 | kblockd_schedule_work(&head->requeue_work); | |
674 | } | |
675 | ||
35fe0d12 HR |
676 | static inline void nvme_trace_bio_complete(struct request *req, |
677 | blk_status_t status) | |
678 | { | |
679 | struct nvme_ns *ns = req->q->queuedata; | |
680 | ||
681 | if (req->cmd_flags & REQ_NVME_MPATH) | |
d24de76a | 682 | trace_block_bio_complete(ns->head->disk->queue, req->bio); |
35fe0d12 HR |
683 | } |
684 | ||
0d0b660f CH |
685 | extern struct device_attribute dev_attr_ana_grpid; |
686 | extern struct device_attribute dev_attr_ana_state; | |
75c10e73 | 687 | extern struct device_attribute subsys_attr_iopolicy; |
0d0b660f | 688 | |
32acab31 | 689 | #else |
0d0b660f CH |
690 | static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl) |
691 | { | |
692 | return false; | |
693 | } | |
a785dbcc KB |
694 | /* |
695 | * Without the multipath code enabled, multiple controller per subsystems are | |
696 | * visible as devices and thus we cannot use the subsystem instance. | |
697 | */ | |
698 | static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns, | |
699 | struct nvme_ctrl *ctrl, int *flags) | |
700 | { | |
701 | sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance); | |
702 | } | |
703 | ||
5ddaabe8 | 704 | static inline void nvme_failover_req(struct request *req) |
32acab31 CH |
705 | { |
706 | } | |
32acab31 CH |
707 | static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl) |
708 | { | |
709 | } | |
710 | static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl, | |
711 | struct nvme_ns_head *head) | |
712 | { | |
713 | return 0; | |
714 | } | |
0d0b660f CH |
715 | static inline void nvme_mpath_add_disk(struct nvme_ns *ns, |
716 | struct nvme_id_ns *id) | |
32acab31 CH |
717 | { |
718 | } | |
719 | static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head) | |
720 | { | |
721 | } | |
0157ec8d SG |
722 | static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns) |
723 | { | |
724 | return false; | |
725 | } | |
726 | static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl) | |
479a322f SG |
727 | { |
728 | } | |
729 | static inline void nvme_mpath_check_last_path(struct nvme_ns *ns) | |
32acab31 CH |
730 | { |
731 | } | |
35fe0d12 HR |
732 | static inline void nvme_trace_bio_complete(struct request *req, |
733 | blk_status_t status) | |
734 | { | |
735 | } | |
0d0b660f CH |
736 | static inline int nvme_mpath_init(struct nvme_ctrl *ctrl, |
737 | struct nvme_id_ctrl *id) | |
738 | { | |
14a1336e CH |
739 | if (ctrl->subsys->cmic & (1 << 3)) |
740 | dev_warn(ctrl->device, | |
741 | "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n"); | |
0d0b660f CH |
742 | return 0; |
743 | } | |
744 | static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl) | |
745 | { | |
746 | } | |
747 | static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl) | |
748 | { | |
749 | } | |
b9156dae SG |
750 | static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys) |
751 | { | |
752 | } | |
753 | static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys) | |
754 | { | |
755 | } | |
756 | static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys) | |
757 | { | |
758 | } | |
32acab31 CH |
759 | #endif /* CONFIG_NVME_MULTIPATH */ |
760 | ||
7fad20dd | 761 | int nvme_revalidate_zones(struct nvme_ns *ns); |
240e6ee2 | 762 | #ifdef CONFIG_BLK_DEV_ZONED |
d525c3c0 | 763 | int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf); |
240e6ee2 KB |
764 | int nvme_report_zones(struct gendisk *disk, sector_t sector, |
765 | unsigned int nr_zones, report_zones_cb cb, void *data); | |
766 | ||
767 | blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req, | |
768 | struct nvme_command *cmnd, | |
769 | enum nvme_zone_mgmt_action action); | |
770 | #else | |
771 | #define nvme_report_zones NULL | |
772 | ||
773 | static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, | |
774 | struct request *req, struct nvme_command *cmnd, | |
775 | enum nvme_zone_mgmt_action action) | |
776 | { | |
777 | return BLK_STS_NOTSUPP; | |
778 | } | |
779 | ||
d525c3c0 | 780 | static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf) |
240e6ee2 KB |
781 | { |
782 | dev_warn(ns->ctrl->device, | |
783 | "Please enable CONFIG_BLK_DEV_ZONED to support ZNS devices\n"); | |
784 | return -EPROTONOSUPPORT; | |
785 | } | |
786 | #endif | |
787 | ||
c4699e70 | 788 | #ifdef CONFIG_NVM |
3dc87dd0 | 789 | int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node); |
b0b4e09c | 790 | void nvme_nvm_unregister(struct nvme_ns *ns); |
33b14f67 | 791 | extern const struct attribute_group nvme_nvm_attr_group; |
84d4add7 | 792 | int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg); |
c4699e70 | 793 | #else |
b0b4e09c | 794 | static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, |
3dc87dd0 | 795 | int node) |
c4699e70 KB |
796 | { |
797 | return 0; | |
798 | } | |
799 | ||
b0b4e09c | 800 | static inline void nvme_nvm_unregister(struct nvme_ns *ns) {}; |
84d4add7 MB |
801 | static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, |
802 | unsigned long arg) | |
803 | { | |
804 | return -ENOTTY; | |
805 | } | |
3dc87dd0 MB |
806 | #endif /* CONFIG_NVM */ |
807 | ||
40267efd SL |
808 | static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev) |
809 | { | |
810 | return dev_to_disk(dev)->private_data; | |
811 | } | |
ca064085 | 812 | |
400b6a7b | 813 | #ifdef CONFIG_NVME_HWMON |
59e330f8 | 814 | int nvme_hwmon_init(struct nvme_ctrl *ctrl); |
400b6a7b | 815 | #else |
59e330f8 KB |
816 | static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl) |
817 | { | |
818 | return 0; | |
819 | } | |
400b6a7b GR |
820 | #endif |
821 | ||
df21b6b1 LG |
822 | u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns, |
823 | u8 opcode); | |
17365ae6 | 824 | void nvme_execute_passthru_rq(struct request *rq); |
b2702aaa | 825 | struct nvme_ctrl *nvme_ctrl_from_file(struct file *file); |
24493b8b LG |
826 | struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid); |
827 | void nvme_put_ns(struct nvme_ns *ns); | |
df21b6b1 | 828 | |
f11bb3e2 | 829 | #endif /* _NVME_H */ |