nvme.h 19.6 KB
Newer Older
1
/* SPDX-License-Identifier: GPL-2.0 */
2 3 4 5 6 7 8 9
/*
 * Copyright (c) 2011-2014, Intel Corporation.
 */

#ifndef _NVME_H
#define _NVME_H

#include <linux/nvme.h>
10
#include <linux/cdev.h>
11 12 13
#include <linux/pci.h>
#include <linux/kref.h>
#include <linux/blk-mq.h>
14
#include <linux/lightnvm.h>
15
#include <linux/sed-opal.h>
T
Thomas Tai 已提交
16
#include <linux/fault-inject.h>
17
#include <linux/rcupdate.h>
18
#include <linux/wait.h>
19
#include <linux/t10-pi.h>
20

H
Hannes Reinecke 已提交
21 22
#include <trace/events/block.h>

23
extern unsigned int nvme_io_timeout;
24 25
#define NVME_IO_TIMEOUT	(nvme_io_timeout * HZ)

26
extern unsigned int admin_timeout;
27 28
#define ADMIN_TIMEOUT	(admin_timeout * HZ)

S
Sagi Grimberg 已提交
29 30 31
#define NVME_DEFAULT_KATO	5
#define NVME_KATO_GRACE		10

32 33
#ifdef CONFIG_ARCH_NO_SG_CHAIN
#define  NVME_INLINE_SG_CNT  0
34
#define  NVME_INLINE_METADATA_SG_CNT  0
35 36
#else
#define  NVME_INLINE_SG_CNT  2
37
#define  NVME_INLINE_METADATA_SG_CNT  1
38 39
#endif

40 41 42 43 44 45 46 47
/*
 * Default to a 4K page size, with the intention to update this
 * path in the future to accommodate architectures with differing
 * kernel and IO page sizes.
 */
#define NVME_CTRL_PAGE_SHIFT	12
#define NVME_CTRL_PAGE_SIZE	(1 << NVME_CTRL_PAGE_SHIFT)

48
extern struct workqueue_struct *nvme_wq;
49 50
extern struct workqueue_struct *nvme_reset_wq;
extern struct workqueue_struct *nvme_delete_wq;
51

M
Matias Bjørling 已提交
52 53 54 55 56
enum {
	NVME_NS_LBA		= 0,
	NVME_NS_LIGHTNVM	= 1,
};

57
/*
58 59
 * List of workarounds for devices that required behavior not specified in
 * the standard.
60
 */
61 62 63 64 65 66
enum nvme_quirks {
	/*
	 * Prefers I/O aligned to a stripe size specified in a vendor
	 * specific Identify field.
	 */
	NVME_QUIRK_STRIPE_SIZE			= (1 << 0),
67 68 69 70 71 72

	/*
	 * The controller doesn't handle Identify value others than 0 or 1
	 * correctly.
	 */
	NVME_QUIRK_IDENTIFY_CNS			= (1 << 1),
73 74

	/*
75 76
	 * The controller deterministically returns O's on reads to
	 * logical blocks that deallocate was called on.
77
	 */
78
	NVME_QUIRK_DEALLOCATE_ZEROES		= (1 << 2),
79 80 81 82 83 84

	/*
	 * The controller needs a delay before starts checking the device
	 * readiness, which is done by reading the NVME_CSTS_RDY bit.
	 */
	NVME_QUIRK_DELAY_BEFORE_CHK_RDY		= (1 << 3),
85 86 87 88 89

	/*
	 * APST should not be used.
	 */
	NVME_QUIRK_NO_APST			= (1 << 4),
90 91 92 93 94

	/*
	 * The deepest sleep state should not be used.
	 */
	NVME_QUIRK_NO_DEEPEST_PS		= (1 << 5),
C
Christoph Hellwig 已提交
95 96 97 98 99

	/*
	 * Supports the LighNVM command set if indicated in vs[1].
	 */
	NVME_QUIRK_LIGHTNVM			= (1 << 6),
100 101 102 103 104

	/*
	 * Set MEDIUM priority on SQ creation
	 */
	NVME_QUIRK_MEDIUM_PRIO_SQ		= (1 << 7),
105 106 107 108 109

	/*
	 * Ignore device provided subnqn.
	 */
	NVME_QUIRK_IGNORE_DEV_SUBNQN		= (1 << 8),
110 111 112 113 114

	/*
	 * Broken Write Zeroes.
	 */
	NVME_QUIRK_DISABLE_WRITE_ZEROES		= (1 << 9),
115 116 117 118 119

	/*
	 * Force simple suspend/resume path.
	 */
	NVME_QUIRK_SIMPLE_SUSPEND		= (1 << 10),
120

121 122 123
	/*
	 * Use only one interrupt vector for all queues
	 */
124
	NVME_QUIRK_SINGLE_VECTOR		= (1 << 11),
125 126 127 128

	/*
	 * Use non-standard 128 bytes SQEs.
	 */
129
	NVME_QUIRK_128_BYTES_SQES		= (1 << 12),
130 131 132 133

	/*
	 * Prevent tag overlap between queues
	 */
134
	NVME_QUIRK_SHARED_TAGS                  = (1 << 13),
135 136 137 138 139

	/*
	 * Don't change the value of the temperature threshold feature
	 */
	NVME_QUIRK_NO_TEMP_THRESH_CHANGE	= (1 << 14),
140 141
};

142 143 144 145 146 147 148
/*
 * Common request structure for NVMe passthrough.  All drivers must have
 * this structure as the first member of their request-private data.
 */
struct nvme_request {
	struct nvme_command	*cmd;
	union nvme_result	result;
149
	u8			retries;
150 151
	u8			flags;
	u16			status;
152
	struct nvme_ctrl	*ctrl;
153 154
};

155 156 157 158 159
/*
 * Mark a bio as coming in through the mpath node.
 */
#define REQ_NVME_MPATH		REQ_DRV

160 161
enum {
	NVME_REQ_CANCELLED		= (1 << 0),
162
	NVME_REQ_USERCMD		= (1 << 1),
163 164 165 166 167 168 169
};

static inline struct nvme_request *nvme_req(struct request *req)
{
	return blk_mq_rq_to_pdu(req);
}

K
Keith Busch 已提交
170 171 172 173 174 175 176
static inline u16 nvme_req_qid(struct request *req)
{
	if (!req->rq_disk)
		return 0;
	return blk_mq_unique_tag_to_hwq(blk_mq_unique_tag(req)) + 1;
}

177 178 179 180 181
/* The below value is the specific amount of delay needed before checking
 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
 * found empirically.
 */
182
#define NVME_QUIRK_DELAY_AMOUNT		2300
183

184 185 186 187
enum nvme_ctrl_state {
	NVME_CTRL_NEW,
	NVME_CTRL_LIVE,
	NVME_CTRL_RESETTING,
188
	NVME_CTRL_CONNECTING,
189
	NVME_CTRL_DELETING,
190
	NVME_CTRL_DEAD,
191 192
};

193 194 195 196 197 198 199 200 201
struct nvme_fault_inject {
#ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
	struct fault_attr attr;
	struct dentry *parent;
	bool dont_retry;	/* DNR, do not retry */
	u16 status;		/* status code */
#endif
};

202 203 204 205 206 207
struct nvme_cel {
	struct list_head	entry;
	struct nvme_effects_log	log;
	u8			csi;
};

208
struct nvme_ctrl {
209
	bool comp_seen;
210
	enum nvme_ctrl_state state;
211
	bool identified;
212
	spinlock_t lock;
213
	struct mutex scan_lock;
214
	const struct nvme_ctrl_ops *ops;
215
	struct request_queue *admin_q;
216
	struct request_queue *connect_q;
217
	struct request_queue *fabrics_q;
218 219
	struct device *dev;
	int instance;
220
	int numa_node;
221
	struct blk_mq_tag_set *tagset;
222
	struct blk_mq_tag_set *admin_tagset;
223
	struct list_head namespaces;
224
	struct rw_semaphore namespaces_rwsem;
225
	struct device ctrl_device;
226
	struct device *device;	/* char device */
227
	struct cdev cdev;
228
	struct work_struct reset_work;
229
	struct work_struct delete_work;
230
	wait_queue_head_t state_wq;
231

C
Christoph Hellwig 已提交
232 233 234
	struct nvme_subsystem *subsys;
	struct list_head subsys_entry;

235
	struct opal_dev *opal_dev;
236

237
	char name[12];
C
Christoph Hellwig 已提交
238
	u16 cntlid;
239 240

	u32 ctrl_config;
241
	u16 mtfa;
242
	u32 queue_count;
243

244
	u64 cap;
245
	u32 max_hw_sectors;
246
	u32 max_segments;
247
	u32 max_integrity_segments;
K
Keith Busch 已提交
248 249 250
#ifdef CONFIG_BLK_DEV_ZONED
	u32 max_zone_append;
#endif
251
	u16 crdt[3];
252
	u16 oncs;
253
	u16 oacs;
254 255
	u16 nssa;
	u16 nr_streams;
256
	u16 sqsize;
C
Christoph Hellwig 已提交
257
	u32 max_namespaces;
258
	atomic_t abort_limit;
259
	u8 vwc;
260
	u32 vs;
261
	u32 sgls;
S
Sagi Grimberg 已提交
262
	u16 kas;
263 264
	u8 npss;
	u8 apsta;
265 266
	u16 wctemp;
	u16 cctemp;
267
	u32 oaes;
268
	u32 aen_result;
S
Sagi Grimberg 已提交
269
	u32 ctratt;
270
	unsigned int shutdown_timeout;
S
Sagi Grimberg 已提交
271
	unsigned int kato;
272
	bool subsystem;
273
	unsigned long quirks;
274
	struct nvme_id_power_state psd[32];
275
	struct nvme_effects_log *effects;
276
	struct list_head cels;
277
	struct work_struct scan_work;
278
	struct work_struct async_event_work;
S
Sagi Grimberg 已提交
279
	struct delayed_work ka_work;
280
	struct nvme_command ka_cmd;
281
	struct work_struct fw_act_work;
282
	unsigned long events;
283
	bool created;
284

C
Christoph Hellwig 已提交
285 286 287 288 289 290 291 292 293 294 295 296 297
#ifdef CONFIG_NVME_MULTIPATH
	/* asymmetric namespace access: */
	u8 anacap;
	u8 anatt;
	u32 anagrpmax;
	u32 nanagrpid;
	struct mutex ana_lock;
	struct nvme_ana_rsp_hdr *ana_log_buf;
	size_t ana_log_size;
	struct timer_list anatt_timer;
	struct work_struct ana_work;
#endif

298 299
	/* Power saving configuration */
	u64 ps_max_latency_us;
300
	bool apst_enabled;
301

302
	/* PCIe only: */
303 304
	u32 hmpre;
	u32 hmmin;
305 306
	u32 hmminds;
	u16 hmmaxd;
307

308 309 310 311 312
	/* Fabrics only */
	u32 ioccsz;
	u32 iorcsz;
	u16 icdoff;
	u16 maxcmd;
313
	int nr_reconnects;
314
	struct nvmf_ctrl_options *opts;
315 316 317

	struct page *discard_page;
	unsigned long discard_page_busy;
318 319

	struct nvme_fault_inject fault_inject;
320 321
};

322 323 324 325 326
enum nvme_iopolicy {
	NVME_IOPOLICY_NUMA,
	NVME_IOPOLICY_RR,
};

C
Christoph Hellwig 已提交
327 328 329 330 331 332 333 334 335 336 337
struct nvme_subsystem {
	int			instance;
	struct device		dev;
	/*
	 * Because we unregister the device on the last put we need
	 * a separate refcount.
	 */
	struct kref		ref;
	struct list_head	entry;
	struct mutex		lock;
	struct list_head	ctrls;
C
Christoph Hellwig 已提交
338
	struct list_head	nsheads;
C
Christoph Hellwig 已提交
339 340 341 342 343 344
	char			subnqn[NVMF_NQN_SIZE];
	char			serial[20];
	char			model[40];
	char			firmware_rev[8];
	u8			cmic;
	u16			vendor_id;
345
	u16			awupf;	/* 0's based awupf value. */
C
Christoph Hellwig 已提交
346
	struct ida		ns_ida;
347 348 349
#ifdef CONFIG_NVME_MULTIPATH
	enum nvme_iopolicy	iopolicy;
#endif
C
Christoph Hellwig 已提交
350 351
};

352 353 354 355 356 357 358
/*
 * Container structure for uniqueue namespace identifiers.
 */
struct nvme_ns_ids {
	u8	eui64[8];
	u8	nguid[16];
	uuid_t	uuid;
359
	u8	csi;
360 361
};

C
Christoph Hellwig 已提交
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
/*
 * Anchor structure for namespaces.  There is one for each namespace in a
 * NVMe subsystem that any of our controllers can see, and the namespace
 * structure for each controller is chained of it.  For private namespaces
 * there is a 1:1 relation to our namespace structures, that is ->list
 * only ever has a single entry for private namespaces.
 */
struct nvme_ns_head {
	struct list_head	list;
	struct srcu_struct      srcu;
	struct nvme_subsystem	*subsys;
	unsigned		ns_id;
	struct nvme_ns_ids	ids;
	struct list_head	entry;
	struct kref		ref;
377
	bool			shared;
C
Christoph Hellwig 已提交
378
	int			instance;
379
	struct nvme_effects_log *effects;
380 381 382 383 384 385
#ifdef CONFIG_NVME_MULTIPATH
	struct gendisk		*disk;
	struct bio_list		requeue_list;
	spinlock_t		requeue_lock;
	struct work_struct	requeue_work;
	struct mutex		lock;
386 387
	unsigned long		flags;
#define NVME_NSHEAD_DISK_LIVE	0
388 389
	struct nvme_ns __rcu	*current_path[];
#endif
C
Christoph Hellwig 已提交
390 391
};

392 393
enum nvme_ns_features {
	NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
394
	NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
395 396
};

397 398 399
struct nvme_ns {
	struct list_head list;

400
	struct nvme_ctrl *ctrl;
401 402
	struct request_queue *queue;
	struct gendisk *disk;
C
Christoph Hellwig 已提交
403 404 405 406
#ifdef CONFIG_NVME_MULTIPATH
	enum nvme_ana_state ana_state;
	u32 ana_grpid;
#endif
C
Christoph Hellwig 已提交
407
	struct list_head siblings;
408
	struct nvm_dev *ndev;
409
	struct kref kref;
C
Christoph Hellwig 已提交
410
	struct nvme_ns_head *head;
411 412 413

	int lba_shift;
	u16 ms;
414 415
	u16 sgs;
	u32 sws;
416
	u8 pi_type;
K
Keith Busch 已提交
417 418 419
#ifdef CONFIG_BLK_DEV_ZONED
	u64 zsze;
#endif
420
	unsigned long features;
421
	unsigned long flags;
C
Christoph Hellwig 已提交
422 423 424
#define NVME_NS_REMOVING	0
#define NVME_NS_DEAD     	1
#define NVME_NS_ANA_PENDING	2
T
Thomas Tai 已提交
425 426 427

	struct nvme_fault_inject fault_inject;

428 429
};

430 431 432 433 434 435
/* NVMe ns supports metadata actions by the controller (generate/strip) */
static inline bool nvme_ns_has_pi(struct nvme_ns *ns)
{
	return ns->pi_type && ns->ms == sizeof(struct t10_pi_tuple);
}

436
struct nvme_ctrl_ops {
M
Ming Lin 已提交
437
	const char *name;
438
	struct module *module;
439 440
	unsigned int flags;
#define NVME_F_FABRICS			(1 << 0)
441
#define NVME_F_METADATA_SUPPORTED	(1 << 1)
442
#define NVME_F_PCI_P2PDMA		(1 << 2)
443
	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
444
	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
445
	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
446
	void (*free_ctrl)(struct nvme_ctrl *ctrl);
447
	void (*submit_async_event)(struct nvme_ctrl *ctrl);
448
	void (*delete_ctrl)(struct nvme_ctrl *ctrl);
M
Ming Lin 已提交
449
	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
450 451
};

T
Thomas Tai 已提交
452
#ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
453 454 455
void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
			    const char *dev_name);
void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
T
Thomas Tai 已提交
456 457
void nvme_should_fail(struct request *req);
#else
458 459 460 461 462 463 464
static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
					  const char *dev_name)
{
}
static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
{
}
T
Thomas Tai 已提交
465 466 467
static inline void nvme_should_fail(struct request *req) {}
#endif

468 469 470 471 472 473 474
static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
{
	if (!ctrl->subsystem)
		return -ENOTTY;
	return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
}

475 476 477 478
/*
 * Convert a 512B sector number to a device logical block number.
 */
static inline u64 nvme_sect_to_lba(struct nvme_ns *ns, sector_t sector)
479
{
480
	return sector >> (ns->lba_shift - SECTOR_SHIFT);
481 482
}

483 484 485 486
/*
 * Convert a device logical block number to a 512B sector number.
 */
static inline sector_t nvme_lba_to_sect(struct nvme_ns *ns, u64 lba)
487
{
488
	return lba << (ns->lba_shift - SECTOR_SHIFT);
489 490
}

K
Keith Busch 已提交
491 492 493 494 495 496 497 498
/*
 * Convert byte length to nvme's 0-based num dwords
 */
static inline u32 nvme_bytes_to_numd(size_t len)
{
	return (len >> 2) - 1;
}

499
static inline bool nvme_end_request(struct request *req, __le16 status,
500
		union nvme_result result)
501
{
502
	struct nvme_request *rq = nvme_req(req);
503

504 505
	rq->status = le16_to_cpu(status) >> 1;
	rq->result = result;
T
Thomas Tai 已提交
506 507
	/* inject error when permitted by fault injection framework */
	nvme_should_fail(req);
508 509 510
	if (unlikely(blk_should_fake_timeout(req->q)))
		return true;
	return blk_mq_complete_request_remote(req);
511 512
}

513 514 515 516 517 518 519 520 521 522
static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
{
	get_device(ctrl->device);
}

static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
{
	put_device(ctrl->device);
}

523 524 525 526 527
static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
{
	return !qid && command_id >= NVME_AQ_BLK_MQ_DEPTH;
}

528
void nvme_complete_rq(struct request *req);
529
bool nvme_cancel_request(struct request *req, void *data, bool reserved);
530 531
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state);
532
bool nvme_wait_reset(struct nvme_ctrl *ctrl);
533
int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
534
int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
535
int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
536 537
int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
		const struct nvme_ctrl_ops *ops, unsigned long quirks);
538
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
539 540
void nvme_start_ctrl(struct nvme_ctrl *ctrl);
void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
541
int nvme_init_identify(struct nvme_ctrl *ctrl);
542 543

void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
544

545 546
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send);
547

548
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
549
		volatile union nvme_result *res);
550

551 552
void nvme_stop_queues(struct nvme_ctrl *ctrl);
void nvme_start_queues(struct nvme_ctrl *ctrl);
553
void nvme_kill_queues(struct nvme_ctrl *ctrl);
K
Keith Busch 已提交
554
void nvme_sync_queues(struct nvme_ctrl *ctrl);
K
Keith Busch 已提交
555 556 557 558
void nvme_unfreeze(struct nvme_ctrl *ctrl);
void nvme_wait_freeze(struct nvme_ctrl *ctrl);
void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
void nvme_start_freeze(struct nvme_ctrl *ctrl);
559

560
#define NVME_QID_ANY -1
561
struct request *nvme_alloc_request(struct request_queue *q,
562
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
563
void nvme_cleanup_cmd(struct request *req);
564
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
565
		struct nvme_command *cmd);
566 567 568
int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
		void *buf, unsigned bufflen);
int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
569
		union nvme_result *result, void *buffer, unsigned bufflen,
570
		unsigned timeout, int qid, int at_head,
571
		blk_mq_req_flags_t flags, bool poll);
K
Keith Busch 已提交
572 573 574 575 576 577
int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
		      unsigned int dword11, void *buffer, size_t buflen,
		      u32 *result);
int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
		      unsigned int dword11, void *buffer, size_t buflen,
		      u32 *result);
C
Christoph Hellwig 已提交
578
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
S
Sagi Grimberg 已提交
579
void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
580
int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
S
Sagi Grimberg 已提交
581
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
582
int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
583
int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
584

585
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
586
		void *log, size_t size, u64 offset);
K
Keith Busch 已提交
587 588 589
struct nvme_ns *nvme_get_ns_from_disk(struct gendisk *disk,
		struct nvme_ns_head **head, int *srcu_idx);
void nvme_put_ns_from_disk(struct nvme_ns_head *head, int idx);
590

591
extern const struct attribute_group *nvme_ns_id_attr_groups[];
592 593 594
extern const struct block_device_operations nvme_ns_head_ops;

#ifdef CONFIG_NVME_MULTIPATH
595 596 597 598 599
static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
{
	return ctrl->ana_log_buf != NULL;
}

600 601 602
void nvme_mpath_unfreeze(struct nvme_subsystem *subsys);
void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys);
void nvme_mpath_start_freeze(struct nvme_subsystem *subsys);
603 604
void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
			struct nvme_ctrl *ctrl, int *flags);
605
bool nvme_failover_req(struct request *req);
606 607
void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
C
Christoph Hellwig 已提交
608
void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
609
void nvme_mpath_remove_disk(struct nvme_ns_head *head);
C
Christoph Hellwig 已提交
610 611 612
int nvme_mpath_init(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
void nvme_mpath_stop(struct nvme_ctrl *ctrl);
613 614
bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
615
struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
616
blk_qc_t nvme_ns_head_submit_bio(struct bio *bio);
617 618 619 620 621 622 623 624 625

static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
{
	struct nvme_ns_head *head = ns->head;

	if (head->disk && list_empty(&head->list))
		kblockd_schedule_work(&head->requeue_work);
}

H
Hannes Reinecke 已提交
626 627 628 629 630 631
static inline void nvme_trace_bio_complete(struct request *req,
        blk_status_t status)
{
	struct nvme_ns *ns = req->q->queuedata;

	if (req->cmd_flags & REQ_NVME_MPATH)
632
		trace_block_bio_complete(ns->head->disk->queue, req->bio);
H
Hannes Reinecke 已提交
633 634
}

C
Christoph Hellwig 已提交
635 636
extern struct device_attribute dev_attr_ana_grpid;
extern struct device_attribute dev_attr_ana_state;
637
extern struct device_attribute subsys_attr_iopolicy;
C
Christoph Hellwig 已提交
638

639
#else
C
Christoph Hellwig 已提交
640 641 642 643
static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
{
	return false;
}
644 645 646 647 648 649 650 651 652 653
/*
 * Without the multipath code enabled, multiple controller per subsystems are
 * visible as devices and thus we cannot use the subsystem instance.
 */
static inline void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
				      struct nvme_ctrl *ctrl, int *flags)
{
	sprintf(disk_name, "nvme%dn%d", ctrl->instance, ns->head->instance);
}

654
static inline bool nvme_failover_req(struct request *req)
655
{
656
	return false;
657 658 659 660 661 662 663 664 665
}
static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
{
}
static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
		struct nvme_ns_head *head)
{
	return 0;
}
C
Christoph Hellwig 已提交
666 667
static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
		struct nvme_id_ns *id)
668 669 670 671 672
{
}
static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
{
}
673 674 675 676 677
static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
{
	return false;
}
static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
678 679 680
{
}
static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
681 682
{
}
H
Hannes Reinecke 已提交
683 684 685 686
static inline void nvme_trace_bio_complete(struct request *req,
        blk_status_t status)
{
}
C
Christoph Hellwig 已提交
687 688 689
static inline int nvme_mpath_init(struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
{
690 691 692
	if (ctrl->subsys->cmic & (1 << 3))
		dev_warn(ctrl->device,
"Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
C
Christoph Hellwig 已提交
693 694 695 696 697 698 699 700
	return 0;
}
static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
{
}
static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
{
}
701 702 703 704 705 706 707 708 709
static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
{
}
static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
{
}
static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
{
}
710 711
#endif /* CONFIG_NVME_MULTIPATH */

K
Keith Busch 已提交
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
#ifdef CONFIG_BLK_DEV_ZONED
int nvme_update_zone_info(struct gendisk *disk, struct nvme_ns *ns,
			  unsigned lbaf);

int nvme_report_zones(struct gendisk *disk, sector_t sector,
		      unsigned int nr_zones, report_zones_cb cb, void *data);

blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req,
				       struct nvme_command *cmnd,
				       enum nvme_zone_mgmt_action action);
#else
#define nvme_report_zones NULL

static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns,
		struct request *req, struct nvme_command *cmnd,
		enum nvme_zone_mgmt_action action)
{
	return BLK_STS_NOTSUPP;
}

static inline int nvme_update_zone_info(struct gendisk *disk,
					struct nvme_ns *ns,
					unsigned lbaf)
{
	dev_warn(ns->ctrl->device,
		 "Please enable CONFIG_BLK_DEV_ZONED to support ZNS devices\n");
	return -EPROTONOSUPPORT;
}
#endif

742
#ifdef CONFIG_NVM
743
int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
744
void nvme_nvm_unregister(struct nvme_ns *ns);
745
extern const struct attribute_group nvme_nvm_attr_group;
746
int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
747
#else
748
static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
749
				    int node)
750 751 752 753
{
	return 0;
}

754
static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
755 756 757 758 759
static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
							unsigned long arg)
{
	return -ENOTTY;
}
760 761
#endif /* CONFIG_NVM */

762 763 764 765
static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
{
	return dev_to_disk(dev)->private_data;
}
M
Matias Bjørling 已提交
766

767 768 769 770 771 772
#ifdef CONFIG_NVME_HWMON
void nvme_hwmon_init(struct nvme_ctrl *ctrl);
#else
static inline void nvme_hwmon_init(struct nvme_ctrl *ctrl) { }
#endif

773
#endif /* _NVME_H */