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