• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Copyright (c) 2011-2014, Intel Corporation.
4  */
5 
6 #ifndef _NVME_H
7 #define _NVME_H
8 
9 #include <linux/nvme.h>
10 #include <linux/cdev.h>
11 #include <linux/pci.h>
12 #include <linux/kref.h>
13 #include <linux/blk-mq.h>
14 #include <linux/lightnvm.h>
15 #include <linux/sed-opal.h>
16 #include <linux/fault-inject.h>
17 #include <linux/rcupdate.h>
18 #include <linux/wait.h>
19 #include <linux/t10-pi.h>
20 
21 #include <trace/events/block.h>
22 
23 extern unsigned int nvme_io_timeout;
24 #define NVME_IO_TIMEOUT	(nvme_io_timeout * HZ)
25 
26 extern unsigned int admin_timeout;
27 #define ADMIN_TIMEOUT	(admin_timeout * HZ)
28 
29 #define NVME_DEFAULT_KATO	5
30 #define NVME_KATO_GRACE		10
31 
32 #ifdef CONFIG_ARCH_NO_SG_CHAIN
33 #define  NVME_INLINE_SG_CNT  0
34 #define  NVME_INLINE_METADATA_SG_CNT  0
35 #else
36 #define  NVME_INLINE_SG_CNT  2
37 #define  NVME_INLINE_METADATA_SG_CNT  1
38 #endif
39 
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 
48 extern struct workqueue_struct *nvme_wq;
49 extern struct workqueue_struct *nvme_reset_wq;
50 extern struct workqueue_struct *nvme_delete_wq;
51 
52 enum {
53 	NVME_NS_LBA		= 0,
54 	NVME_NS_LIGHTNVM	= 1,
55 };
56 
57 /*
58  * List of workarounds for devices that required behavior not specified in
59  * the standard.
60  */
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),
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),
73 
74 	/*
75 	 * The controller deterministically returns O's on reads to
76 	 * logical blocks that deallocate was called on.
77 	 */
78 	NVME_QUIRK_DEALLOCATE_ZEROES		= (1 << 2),
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),
85 
86 	/*
87 	 * APST should not be used.
88 	 */
89 	NVME_QUIRK_NO_APST			= (1 << 4),
90 
91 	/*
92 	 * The deepest sleep state should not be used.
93 	 */
94 	NVME_QUIRK_NO_DEEPEST_PS		= (1 << 5),
95 
96 	/*
97 	 * Supports the LighNVM command set if indicated in vs[1].
98 	 */
99 	NVME_QUIRK_LIGHTNVM			= (1 << 6),
100 
101 	/*
102 	 * Set MEDIUM priority on SQ creation
103 	 */
104 	NVME_QUIRK_MEDIUM_PRIO_SQ		= (1 << 7),
105 
106 	/*
107 	 * Ignore device provided subnqn.
108 	 */
109 	NVME_QUIRK_IGNORE_DEV_SUBNQN		= (1 << 8),
110 
111 	/*
112 	 * Broken Write Zeroes.
113 	 */
114 	NVME_QUIRK_DISABLE_WRITE_ZEROES		= (1 << 9),
115 
116 	/*
117 	 * Force simple suspend/resume path.
118 	 */
119 	NVME_QUIRK_SIMPLE_SUSPEND		= (1 << 10),
120 
121 	/*
122 	 * Use only one interrupt vector for all queues
123 	 */
124 	NVME_QUIRK_SINGLE_VECTOR		= (1 << 11),
125 
126 	/*
127 	 * Use non-standard 128 bytes SQEs.
128 	 */
129 	NVME_QUIRK_128_BYTES_SQES		= (1 << 12),
130 
131 	/*
132 	 * Prevent tag overlap between queues
133 	 */
134 	NVME_QUIRK_SHARED_TAGS                  = (1 << 13),
135 
136 	/*
137 	 * Don't change the value of the temperature threshold feature
138 	 */
139 	NVME_QUIRK_NO_TEMP_THRESH_CHANGE	= (1 << 14),
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),
147 
148 	/*
149 	 * The controller requires the command_id value be be limited, so skip
150 	 * encoding the generation sequence number.
151 	 */
152 	NVME_QUIRK_SKIP_CID_GEN			= (1 << 17),
153 };
154 
155 /*
156  * Common request structure for NVMe passthrough.  All drivers must have
157  * this structure as the first member of their request-private data.
158  */
159 struct nvme_request {
160 	struct nvme_command	*cmd;
161 	union nvme_result	result;
162 	u8			genctr;
163 	u8			retries;
164 	u8			flags;
165 	u16			status;
166 	struct nvme_ctrl	*ctrl;
167 };
168 
169 /*
170  * Mark a bio as coming in through the mpath node.
171  */
172 #define REQ_NVME_MPATH		REQ_DRV
173 
174 enum {
175 	NVME_REQ_CANCELLED		= (1 << 0),
176 	NVME_REQ_USERCMD		= (1 << 1),
177 };
178 
nvme_req(struct request * req)179 static inline struct nvme_request *nvme_req(struct request *req)
180 {
181 	return blk_mq_rq_to_pdu(req);
182 }
183 
nvme_req_qid(struct request * req)184 static inline u16 nvme_req_qid(struct request *req)
185 {
186 	if (!req->q->queuedata)
187 		return 0;
188 	return blk_mq_unique_tag_to_hwq(blk_mq_unique_tag(req)) + 1;
189 }
190 
191 /* The below value is the specific amount of delay needed before checking
192  * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
193  * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
194  * found empirically.
195  */
196 #define NVME_QUIRK_DELAY_AMOUNT		2300
197 
198 /*
199  * enum nvme_ctrl_state: Controller state
200  *
201  * @NVME_CTRL_NEW:		New controller just allocated, initial state
202  * @NVME_CTRL_LIVE:		Controller is connected and I/O capable
203  * @NVME_CTRL_RESETTING:	Controller is resetting (or scheduled reset)
204  * @NVME_CTRL_CONNECTING:	Controller is disconnected, now connecting the
205  *				transport
206  * @NVME_CTRL_DELETING:		Controller is deleting (or scheduled deletion)
207  * @NVME_CTRL_DELETING_NOIO:	Controller is deleting and I/O is not
208  *				disabled/failed immediately. This state comes
209  * 				after all async event processing took place and
210  * 				before ns removal and the controller deletion
211  * 				progress
212  * @NVME_CTRL_DEAD:		Controller is non-present/unresponsive during
213  *				shutdown or removal. In this case we forcibly
214  *				kill all inflight I/O as they have no chance to
215  *				complete
216  */
217 enum nvme_ctrl_state {
218 	NVME_CTRL_NEW,
219 	NVME_CTRL_LIVE,
220 	NVME_CTRL_RESETTING,
221 	NVME_CTRL_CONNECTING,
222 	NVME_CTRL_DELETING,
223 	NVME_CTRL_DELETING_NOIO,
224 	NVME_CTRL_DEAD,
225 };
226 
227 struct nvme_fault_inject {
228 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
229 	struct fault_attr attr;
230 	struct dentry *parent;
231 	bool dont_retry;	/* DNR, do not retry */
232 	u16 status;		/* status code */
233 #endif
234 };
235 
236 struct nvme_ctrl {
237 	bool comp_seen;
238 	enum nvme_ctrl_state state;
239 	bool identified;
240 	spinlock_t lock;
241 	struct mutex scan_lock;
242 	const struct nvme_ctrl_ops *ops;
243 	struct request_queue *admin_q;
244 	struct request_queue *connect_q;
245 	struct request_queue *fabrics_q;
246 	struct device *dev;
247 	int instance;
248 	int numa_node;
249 	struct blk_mq_tag_set *tagset;
250 	struct blk_mq_tag_set *admin_tagset;
251 	struct list_head namespaces;
252 	struct rw_semaphore namespaces_rwsem;
253 	struct device ctrl_device;
254 	struct device *device;	/* char device */
255 	struct cdev cdev;
256 	struct work_struct reset_work;
257 	struct work_struct delete_work;
258 	wait_queue_head_t state_wq;
259 
260 	struct nvme_subsystem *subsys;
261 	struct list_head subsys_entry;
262 
263 	struct opal_dev *opal_dev;
264 
265 	char name[12];
266 	u16 cntlid;
267 
268 	u32 ctrl_config;
269 	u16 mtfa;
270 	u32 queue_count;
271 
272 	u64 cap;
273 	u32 max_hw_sectors;
274 	u32 max_segments;
275 	u32 max_integrity_segments;
276 #ifdef CONFIG_BLK_DEV_ZONED
277 	u32 max_zone_append;
278 #endif
279 	u16 crdt[3];
280 	u16 oncs;
281 	u16 oacs;
282 	u16 nssa;
283 	u16 nr_streams;
284 	u16 sqsize;
285 	u32 max_namespaces;
286 	atomic_t abort_limit;
287 	u8 vwc;
288 	u32 vs;
289 	u32 sgls;
290 	u16 kas;
291 	u8 npss;
292 	u8 apsta;
293 	u16 wctemp;
294 	u16 cctemp;
295 	u32 oaes;
296 	u32 aen_result;
297 	u32 ctratt;
298 	unsigned int shutdown_timeout;
299 	unsigned int kato;
300 	bool subsystem;
301 	unsigned long quirks;
302 	struct nvme_id_power_state psd[32];
303 	struct nvme_effects_log *effects;
304 	struct xarray cels;
305 	struct work_struct scan_work;
306 	struct work_struct async_event_work;
307 	struct delayed_work ka_work;
308 	struct nvme_command ka_cmd;
309 	struct work_struct fw_act_work;
310 	unsigned long events;
311 
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 
325 	/* Power saving configuration */
326 	u64 ps_max_latency_us;
327 	bool apst_enabled;
328 
329 	/* PCIe only: */
330 	u32 hmpre;
331 	u32 hmmin;
332 	u32 hmminds;
333 	u16 hmmaxd;
334 
335 	/* Fabrics only */
336 	u32 ioccsz;
337 	u32 iorcsz;
338 	u16 icdoff;
339 	u16 maxcmd;
340 	int nr_reconnects;
341 	unsigned long flags;
342 #define NVME_CTRL_ADMIN_Q_STOPPED	0
343 	struct nvmf_ctrl_options *opts;
344 
345 	struct page *discard_page;
346 	unsigned long discard_page_busy;
347 
348 	struct nvme_fault_inject fault_inject;
349 };
350 
351 enum nvme_iopolicy {
352 	NVME_IOPOLICY_NUMA,
353 	NVME_IOPOLICY_RR,
354 };
355 
356 struct nvme_subsystem {
357 	int			instance;
358 	struct device		dev;
359 	/*
360 	 * Because we unregister the device on the last put we need
361 	 * a separate refcount.
362 	 */
363 	struct kref		ref;
364 	struct list_head	entry;
365 	struct mutex		lock;
366 	struct list_head	ctrls;
367 	struct list_head	nsheads;
368 	char			subnqn[NVMF_NQN_SIZE];
369 	char			serial[20];
370 	char			model[40];
371 	char			firmware_rev[8];
372 	u8			cmic;
373 	u16			vendor_id;
374 	u16			awupf;	/* 0's based awupf value. */
375 	struct ida		ns_ida;
376 #ifdef CONFIG_NVME_MULTIPATH
377 	enum nvme_iopolicy	iopolicy;
378 #endif
379 };
380 
381 /*
382  * Container structure for uniqueue namespace identifiers.
383  */
384 struct nvme_ns_ids {
385 	u8	eui64[8];
386 	u8	nguid[16];
387 	uuid_t	uuid;
388 	u8	csi;
389 };
390 
391 /*
392  * Anchor structure for namespaces.  There is one for each namespace in a
393  * NVMe subsystem that any of our controllers can see, and the namespace
394  * structure for each controller is chained of it.  For private namespaces
395  * there is a 1:1 relation to our namespace structures, that is ->list
396  * only ever has a single entry for private namespaces.
397  */
398 struct nvme_ns_head {
399 	struct list_head	list;
400 	struct srcu_struct      srcu;
401 	struct nvme_subsystem	*subsys;
402 	unsigned		ns_id;
403 	struct nvme_ns_ids	ids;
404 	struct list_head	entry;
405 	struct kref		ref;
406 	bool			shared;
407 	int			instance;
408 	struct nvme_effects_log *effects;
409 #ifdef CONFIG_NVME_MULTIPATH
410 	struct gendisk		*disk;
411 	struct bio_list		requeue_list;
412 	spinlock_t		requeue_lock;
413 	struct work_struct	requeue_work;
414 	struct mutex		lock;
415 	unsigned long		flags;
416 #define NVME_NSHEAD_DISK_LIVE	0
417 	struct nvme_ns __rcu	*current_path[];
418 #endif
419 };
420 
421 enum nvme_ns_features {
422 	NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
423 	NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
424 };
425 
426 struct nvme_ns {
427 	struct list_head list;
428 
429 	struct nvme_ctrl *ctrl;
430 	struct request_queue *queue;
431 	struct gendisk *disk;
432 #ifdef CONFIG_NVME_MULTIPATH
433 	enum nvme_ana_state ana_state;
434 	u32 ana_grpid;
435 #endif
436 	struct list_head siblings;
437 	struct nvm_dev *ndev;
438 	struct kref kref;
439 	struct nvme_ns_head *head;
440 
441 	int lba_shift;
442 	u16 ms;
443 	u16 sgs;
444 	u32 sws;
445 	u8 pi_type;
446 #ifdef CONFIG_BLK_DEV_ZONED
447 	u64 zsze;
448 #endif
449 	unsigned long features;
450 	unsigned long flags;
451 #define NVME_NS_REMOVING	0
452 #define NVME_NS_DEAD     	1
453 #define NVME_NS_ANA_PENDING	2
454 #define NVME_NS_STOPPED		3
455 
456 	struct nvme_fault_inject fault_inject;
457 
458 };
459 
460 /* NVMe ns supports metadata actions by the controller (generate/strip) */
nvme_ns_has_pi(struct nvme_ns * ns)461 static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
462 {
463 	return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
464 }
465 
466 struct nvme_ctrl_ops {
467 	const char *name;
468 	struct module *module;
469 	unsigned int flags;
470 #define NVME_F_FABRICS			(1 << 0)
471 #define NVME_F_METADATA_SUPPORTED	(1 << 1)
472 #define NVME_F_PCI_P2PDMA		(1 << 2)
473 	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
474 	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
475 	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
476 	void (*free_ctrl)(struct nvme_ctrl *ctrl);
477 	void (*submit_async_event)(struct nvme_ctrl *ctrl);
478 	void (*delete_ctrl)(struct nvme_ctrl *ctrl);
479 	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
480 };
481 
482 /*
483  * nvme command_id is constructed as such:
484  * | xxxx | xxxxxxxxxxxx |
485  *   gen    request tag
486  */
487 #define nvme_genctr_mask(gen)			(gen & 0xf)
488 #define nvme_cid_install_genctr(gen)		(nvme_genctr_mask(gen) << 12)
489 #define nvme_genctr_from_cid(cid)		((cid & 0xf000) >> 12)
490 #define nvme_tag_from_cid(cid)			(cid & 0xfff)
491 
nvme_cid(struct request * rq)492 static inline u16 nvme_cid(struct request *rq)
493 {
494 	return nvme_cid_install_genctr(nvme_req(rq)->genctr) | rq->tag;
495 }
496 
nvme_find_rq(struct blk_mq_tags * tags,u16 command_id)497 static inline struct request *nvme_find_rq(struct blk_mq_tags *tags,
498 		u16 command_id)
499 {
500 	u8 genctr = nvme_genctr_from_cid(command_id);
501 	u16 tag = nvme_tag_from_cid(command_id);
502 	struct request *rq;
503 
504 	rq = blk_mq_tag_to_rq(tags, tag);
505 	if (unlikely(!rq)) {
506 		pr_err("could not locate request for tag %#x\n",
507 			tag);
508 		return NULL;
509 	}
510 	if (unlikely(nvme_genctr_mask(nvme_req(rq)->genctr) != genctr)) {
511 		dev_err(nvme_req(rq)->ctrl->device,
512 			"request %#x genctr mismatch (got %#x expected %#x)\n",
513 			tag, genctr, nvme_genctr_mask(nvme_req(rq)->genctr));
514 		return NULL;
515 	}
516 	return rq;
517 }
518 
nvme_cid_to_rq(struct blk_mq_tags * tags,u16 command_id)519 static inline struct request *nvme_cid_to_rq(struct blk_mq_tags *tags,
520                 u16 command_id)
521 {
522 	return blk_mq_tag_to_rq(tags, nvme_tag_from_cid(command_id));
523 }
524 
525 #ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
526 void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
527 			    const char *dev_name);
528 void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
529 void nvme_should_fail(struct request *req);
530 #else
nvme_fault_inject_init(struct nvme_fault_inject * fault_inj,const char * dev_name)531 static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
532 					  const char *dev_name)
533 {
534 }
nvme_fault_inject_fini(struct nvme_fault_inject * fault_inj)535 static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
536 {
537 }
nvme_should_fail(struct request * req)538 static inline void nvme_should_fail(struct request *req) {}
539 #endif
540 
541 bool nvme_wait_reset(struct nvme_ctrl *ctrl);
542 int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
543 
nvme_reset_subsystem(struct nvme_ctrl * ctrl)544 static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
545 {
546 	int ret;
547 
548 	if (!ctrl->subsystem)
549 		return -ENOTTY;
550 	if (!nvme_wait_reset(ctrl))
551 		return -EBUSY;
552 
553 	ret = ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
554 	if (ret)
555 		return ret;
556 
557 	return nvme_try_sched_reset(ctrl);
558 }
559 
560 /*
561  * Convert a 512B sector number to a device logical block number.
562  */
nvme_sect_to_lba(struct nvme_ns * ns,sector_t sector)563 static inline u64 nvme_sect_to_lba(struct nvme_ns *ns, sector_t sector)
564 {
565 	return sector >> (ns->lba_shift - SECTOR_SHIFT);
566 }
567 
568 /*
569  * Convert a device logical block number to a 512B sector number.
570  */
nvme_lba_to_sect(struct nvme_ns * ns,u64 lba)571 static inline sector_t nvme_lba_to_sect(struct nvme_ns *ns, u64 lba)
572 {
573 	return lba << (ns->lba_shift - SECTOR_SHIFT);
574 }
575 
576 /*
577  * Convert byte length to nvme's 0-based num dwords
578  */
nvme_bytes_to_numd(size_t len)579 static inline u32 nvme_bytes_to_numd(size_t len)
580 {
581 	return (len >> 2) - 1;
582 }
583 
nvme_is_ana_error(u16 status)584 static inline bool nvme_is_ana_error(u16 status)
585 {
586 	switch (status & 0x7ff) {
587 	case NVME_SC_ANA_TRANSITION:
588 	case NVME_SC_ANA_INACCESSIBLE:
589 	case NVME_SC_ANA_PERSISTENT_LOSS:
590 		return true;
591 	default:
592 		return false;
593 	}
594 }
595 
nvme_is_path_error(u16 status)596 static inline bool nvme_is_path_error(u16 status)
597 {
598 	/* check for a status code type of 'path related status' */
599 	return (status & 0x700) == 0x300;
600 }
601 
602 /*
603  * Fill in the status and result information from the CQE, and then figure out
604  * if blk-mq will need to use IPI magic to complete the request, and if yes do
605  * so.  If not let the caller complete the request without an indirect function
606  * call.
607  */
nvme_try_complete_req(struct request * req,__le16 status,union nvme_result result)608 static inline bool nvme_try_complete_req(struct request *req, __le16 status,
609 		union nvme_result result)
610 {
611 	struct nvme_request *rq = nvme_req(req);
612 
613 	rq->status = le16_to_cpu(status) >> 1;
614 	rq->result = result;
615 	/* inject error when permitted by fault injection framework */
616 	nvme_should_fail(req);
617 	if (unlikely(blk_should_fake_timeout(req->q)))
618 		return true;
619 	return blk_mq_complete_request_remote(req);
620 }
621 
nvme_get_ctrl(struct nvme_ctrl * ctrl)622 static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
623 {
624 	get_device(ctrl->device);
625 }
626 
nvme_put_ctrl(struct nvme_ctrl * ctrl)627 static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
628 {
629 	put_device(ctrl->device);
630 }
631 
nvme_is_aen_req(u16 qid,__u16 command_id)632 static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
633 {
634 	return !qid &&
635 		nvme_tag_from_cid(command_id) >= NVME_AQ_BLK_MQ_DEPTH;
636 }
637 
638 void nvme_complete_rq(struct request *req);
639 bool nvme_cancel_request(struct request *req, void *data, bool reserved);
640 void nvme_cancel_tagset(struct nvme_ctrl *ctrl);
641 void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl);
642 bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
643 		enum nvme_ctrl_state new_state);
644 int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
645 int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
646 int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
647 int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
648 		const struct nvme_ctrl_ops *ops, unsigned long quirks);
649 void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
650 void nvme_start_ctrl(struct nvme_ctrl *ctrl);
651 void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
652 int nvme_init_identify(struct nvme_ctrl *ctrl);
653 
654 void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
655 
656 int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
657 		bool send);
658 
659 void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
660 		volatile union nvme_result *res);
661 
662 void nvme_stop_queues(struct nvme_ctrl *ctrl);
663 void nvme_start_queues(struct nvme_ctrl *ctrl);
664 void nvme_stop_admin_queue(struct nvme_ctrl *ctrl);
665 void nvme_start_admin_queue(struct nvme_ctrl *ctrl);
666 void nvme_kill_queues(struct nvme_ctrl *ctrl);
667 void nvme_sync_queues(struct nvme_ctrl *ctrl);
668 void nvme_sync_io_queues(struct nvme_ctrl *ctrl);
669 void nvme_unfreeze(struct nvme_ctrl *ctrl);
670 void nvme_wait_freeze(struct nvme_ctrl *ctrl);
671 int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
672 void nvme_start_freeze(struct nvme_ctrl *ctrl);
673 
674 #define NVME_QID_ANY -1
675 struct request *nvme_alloc_request(struct request_queue *q,
676 		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
677 void nvme_cleanup_cmd(struct request *req);
678 blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
679 		struct nvme_command *cmd);
680 int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
681 		void *buf, unsigned bufflen);
682 int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
683 		union nvme_result *result, void *buffer, unsigned bufflen,
684 		unsigned timeout, int qid, int at_head,
685 		blk_mq_req_flags_t flags, bool poll);
686 int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
687 		      unsigned int dword11, void *buffer, size_t buflen,
688 		      u32 *result);
689 int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
690 		      unsigned int dword11, void *buffer, size_t buflen,
691 		      u32 *result);
692 int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
693 void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
694 int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
695 int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
696 int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
697 
698 int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
699 		void *log, size_t size, u64 offset);
700 struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
701 		struct nvme_ns_head **head, int *srcu_idx);
702 void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx);
703 
704 extern const struct attribute_group *nvme_ns_id_attr_groups[];
705 extern const struct block_device_operations nvme_ns_head_ops;
706 
707 #ifdef CONFIG_NVME_MULTIPATH
nvme_ctrl_use_ana(struct nvme_ctrl * ctrl)708 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
709 {
710 	return ctrl->ana_log_buf != NULL;
711 }
712 
713 void nvme_mpath_unfreeze(struct nvme_subsystem *subsys);
714 void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys);
715 void nvme_mpath_start_freeze(struct nvme_subsystem *subsys);
716 void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
717 			struct nvme_ctrl *ctrl, int *flags);
718 void nvme_failover_req(struct request *req);
719 void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
720 int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
721 void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
722 void nvme_mpath_remove_disk(struct nvme_ns_head *head);
723 int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
724 void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl);
725 void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
726 void nvme_mpath_stop(struct nvme_ctrl *ctrl);
727 bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
728 void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
729 struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
730 blk_qc_t nvme_ns_head_submit_bio(struct bio *bio);
731 
nvme_mpath_check_last_path(struct nvme_ns * ns)732 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
733 {
734 	struct nvme_ns_head *head = ns->head;
735 
736 	if (head->disk && list_empty(&head->list))
737 		kblockd_schedule_work(&head->requeue_work);
738 }
739 
nvme_trace_bio_complete(struct request * req,blk_status_t status)740 static inline void nvme_trace_bio_complete(struct request *req,
741         blk_status_t status)
742 {
743 	struct nvme_ns *ns = req->q->queuedata;
744 
745 	if (req->cmd_flags & REQ_NVME_MPATH)
746 		trace_block_bio_complete(ns->head->disk->queue, req->bio);
747 }
748 
749 extern struct device_attribute dev_attr_ana_grpid;
750 extern struct device_attribute dev_attr_ana_state;
751 extern struct device_attribute subsys_attr_iopolicy;
752 
753 #else
nvme_ctrl_use_ana(struct nvme_ctrl * ctrl)754 static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
755 {
756 	return false;
757 }
758 /*
759  * Without the multipath code enabled, multiple controller per subsystems are
760  * visible as devices and thus we cannot use the subsystem instance.
761  */
nvme_set_disk_name(char * disk_name,struct nvme_ns * ns,struct nvme_ctrl * ctrl,int * flags)762 static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
763 				      struct nvme_ctrl *ctrl, int *flags)
764 {
765 	sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance);
766 }
767 
nvme_failover_req(struct request * req)768 static inline void nvme_failover_req(struct request *req)
769 {
770 }
nvme_kick_requeue_lists(struct nvme_ctrl * ctrl)771 static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
772 {
773 }
nvme_mpath_alloc_disk(struct nvme_ctrl * ctrl,struct nvme_ns_head * head)774 static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
775 		struct nvme_ns_head *head)
776 {
777 	return 0;
778 }
nvme_mpath_add_disk(struct nvme_ns * ns,struct nvme_id_ns * id)779 static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
780 		struct nvme_id_ns *id)
781 {
782 }
nvme_mpath_remove_disk(struct nvme_ns_head * head)783 static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
784 {
785 }
nvme_mpath_clear_current_path(struct nvme_ns * ns)786 static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
787 {
788 	return false;
789 }
nvme_mpath_clear_ctrl_paths(struct nvme_ctrl * ctrl)790 static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
791 {
792 }
nvme_mpath_check_last_path(struct nvme_ns * ns)793 static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
794 {
795 }
nvme_trace_bio_complete(struct request * req,blk_status_t status)796 static inline void nvme_trace_bio_complete(struct request *req,
797         blk_status_t status)
798 {
799 }
nvme_mpath_init_ctrl(struct nvme_ctrl * ctrl)800 static inline void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl)
801 {
802 }
nvme_mpath_init_identify(struct nvme_ctrl * ctrl,struct nvme_id_ctrl * id)803 static inline int nvme_mpath_init_identify(struct nvme_ctrl *ctrl,
804 		struct nvme_id_ctrl *id)
805 {
806 	if (ctrl->subsys->cmic & (1 << 3))
807 		dev_warn(ctrl->device,
808 "Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
809 	return 0;
810 }
nvme_mpath_uninit(struct nvme_ctrl * ctrl)811 static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
812 {
813 }
nvme_mpath_stop(struct nvme_ctrl * ctrl)814 static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
815 {
816 }
nvme_mpath_unfreeze(struct nvme_subsystem * subsys)817 static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
818 {
819 }
nvme_mpath_wait_freeze(struct nvme_subsystem * subsys)820 static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
821 {
822 }
nvme_mpath_start_freeze(struct nvme_subsystem * subsys)823 static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
824 {
825 }
826 #endif /* CONFIG_NVME_MULTIPATH */
827 
828 int nvme_revalidate_zones(struct nvme_ns *ns);
829 #ifdef CONFIG_BLK_DEV_ZONED
830 int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf);
831 int nvme_report_zones(struct gendisk *disk, sector_t sector,
832 		      unsigned int nr_zones, report_zones_cb cb, void *data);
833 
834 blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req,
835 				       struct nvme_command *cmnd,
836 				       enum nvme_zone_mgmt_action action);
837 #else
838 #define nvme_report_zones NULL
839 
nvme_setup_zone_mgmt_send(struct nvme_ns * ns,struct request * req,struct nvme_command * cmnd,enum nvme_zone_mgmt_action action)840 static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns,
841 		struct request *req, struct nvme_command *cmnd,
842 		enum nvme_zone_mgmt_action action)
843 {
844 	return BLK_STS_NOTSUPP;
845 }
846 
nvme_update_zone_info(struct nvme_ns * ns,unsigned lbaf)847 static inline int nvme_update_zone_info(struct nvme_ns *ns, unsigned lbaf)
848 {
849 	dev_warn(ns->ctrl->device,
850 		 "Please enable CONFIG_BLK_DEV_ZONED to support ZNS devices\n");
851 	return -EPROTONOSUPPORT;
852 }
853 #endif
854 
855 #ifdef CONFIG_NVM
856 int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
857 void nvme_nvm_unregister(struct nvme_ns *ns);
858 extern const struct attribute_group nvme_nvm_attr_group;
859 int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
860 #else
nvme_nvm_register(struct nvme_ns * ns,char * disk_name,int node)861 static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
862 				    int node)
863 {
864 	return 0;
865 }
866 
nvme_nvm_unregister(struct nvme_ns * ns)867 static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
nvme_nvm_ioctl(struct nvme_ns * ns,unsigned int cmd,unsigned long arg)868 static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
869 							unsigned long arg)
870 {
871 	return -ENOTTY;
872 }
873 #endif /* CONFIG_NVM */
874 
nvme_get_ns_from_dev(struct device * dev)875 static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
876 {
877 	return dev_to_disk(dev)->private_data;
878 }
879 
880 #ifdef CONFIG_NVME_HWMON
881 int nvme_hwmon_init(struct nvme_ctrl *ctrl);
882 #else
nvme_hwmon_init(struct nvme_ctrl * ctrl)883 static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl)
884 {
885 	return 0;
886 }
887 #endif
888 
889 u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
890 			 u8 opcode);
891 void nvme_execute_passthru_rq(struct request *rq);
892 struct nvme_ctrl *nvme_ctrl_from_file(struct file *file);
893 struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid);
894 void nvme_put_ns(struct nvme_ns *ns);
895 
896 #endif /* _NVME_H */
897