nvme.h 19.4 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
extern struct workqueue_struct *nvme_wq;
41 42
extern struct workqueue_struct *nvme_reset_wq;
extern struct workqueue_struct *nvme_delete_wq;
43

M
Matias Bjørling 已提交
44 45 46 47 48
enum {
	NVME_NS_LBA		= 0,
	NVME_NS_LIGHTNVM	= 1,
};

49
/*
50 51
 * List of workarounds for devices that required behavior not specified in
 * the standard.
52
 */
53 54 55 56 57 58
enum nvme_quirks {
	/*
	 * Prefers I/O aligned to a stripe size specified in a vendor
	 * specific Identify field.
	 */
	NVME_QUIRK_STRIPE_SIZE			= (1 << 0),
59 60 61 62 63 64

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

	/*
67 68
	 * The controller deterministically returns O's on reads to
	 * logical blocks that deallocate was called on.
69
	 */
70
	NVME_QUIRK_DEALLOCATE_ZEROES		= (1 << 2),
71 72 73 74 75 76

	/*
	 * 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),
77 78 79 80 81

	/*
	 * APST should not be used.
	 */
	NVME_QUIRK_NO_APST			= (1 << 4),
82 83 84 85 86

	/*
	 * The deepest sleep state should not be used.
	 */
	NVME_QUIRK_NO_DEEPEST_PS		= (1 << 5),
C
Christoph Hellwig 已提交
87 88 89 90 91

	/*
	 * Supports the LighNVM command set if indicated in vs[1].
	 */
	NVME_QUIRK_LIGHTNVM			= (1 << 6),
92 93 94 95 96

	/*
	 * Set MEDIUM priority on SQ creation
	 */
	NVME_QUIRK_MEDIUM_PRIO_SQ		= (1 << 7),
97 98 99 100 101

	/*
	 * Ignore device provided subnqn.
	 */
	NVME_QUIRK_IGNORE_DEV_SUBNQN		= (1 << 8),
102 103 104 105 106

	/*
	 * Broken Write Zeroes.
	 */
	NVME_QUIRK_DISABLE_WRITE_ZEROES		= (1 << 9),
107 108 109 110 111

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

113 114 115
	/*
	 * Use only one interrupt vector for all queues
	 */
116
	NVME_QUIRK_SINGLE_VECTOR		= (1 << 11),
117 118 119 120

	/*
	 * Use non-standard 128 bytes SQEs.
	 */
121
	NVME_QUIRK_128_BYTES_SQES		= (1 << 12),
122 123 124 125

	/*
	 * Prevent tag overlap between queues
	 */
126
	NVME_QUIRK_SHARED_TAGS                  = (1 << 13),
127 128 129 130 131

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

134 135 136 137 138 139 140
/*
 * 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;
141
	u8			retries;
142 143
	u8			flags;
	u16			status;
144
	struct nvme_ctrl	*ctrl;
145 146
};

147 148 149 150 151
/*
 * Mark a bio as coming in through the mpath node.
 */
#define REQ_NVME_MPATH		REQ_DRV

152 153
enum {
	NVME_REQ_CANCELLED		= (1 << 0),
154
	NVME_REQ_USERCMD		= (1 << 1),
155 156 157 158 159 160 161
};

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

K
Keith Busch 已提交
162 163 164 165 166 167 168
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;
}

169 170 171 172 173
/* 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.
 */
174
#define NVME_QUIRK_DELAY_AMOUNT		2300
175

176 177 178 179
enum nvme_ctrl_state {
	NVME_CTRL_NEW,
	NVME_CTRL_LIVE,
	NVME_CTRL_RESETTING,
180
	NVME_CTRL_CONNECTING,
181
	NVME_CTRL_DELETING,
182
	NVME_CTRL_DEAD,
183 184
};

185 186 187 188 189 190 191 192 193
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
};

194 195 196 197 198 199
struct nvme_cel {
	struct list_head	entry;
	struct nvme_effects_log	log;
	u8			csi;
};

200
struct nvme_ctrl {
201
	bool comp_seen;
202
	enum nvme_ctrl_state state;
203
	bool identified;
204
	spinlock_t lock;
205
	struct mutex scan_lock;
206
	const struct nvme_ctrl_ops *ops;
207
	struct request_queue *admin_q;
208
	struct request_queue *connect_q;
209
	struct request_queue *fabrics_q;
210 211
	struct device *dev;
	int instance;
212
	int numa_node;
213
	struct blk_mq_tag_set *tagset;
214
	struct blk_mq_tag_set *admin_tagset;
215
	struct list_head namespaces;
216
	struct rw_semaphore namespaces_rwsem;
217
	struct device ctrl_device;
218
	struct device *device;	/* char device */
219
	struct cdev cdev;
220
	struct work_struct reset_work;
221
	struct work_struct delete_work;
222
	wait_queue_head_t state_wq;
223

C
Christoph Hellwig 已提交
224 225 226
	struct nvme_subsystem *subsys;
	struct list_head subsys_entry;

227
	struct opal_dev *opal_dev;
228

229
	char name[12];
C
Christoph Hellwig 已提交
230
	u16 cntlid;
231 232

	u32 ctrl_config;
233
	u16 mtfa;
234
	u32 queue_count;
235

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

C
Christoph Hellwig 已提交
278 279 280 281 282 283 284 285 286 287 288 289 290
#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

291 292
	/* Power saving configuration */
	u64 ps_max_latency_us;
293
	bool apst_enabled;
294

295
	/* PCIe only: */
296 297
	u32 hmpre;
	u32 hmmin;
298 299
	u32 hmminds;
	u16 hmmaxd;
300

301 302 303 304 305
	/* Fabrics only */
	u32 ioccsz;
	u32 iorcsz;
	u16 icdoff;
	u16 maxcmd;
306
	int nr_reconnects;
307
	struct nvmf_ctrl_options *opts;
308 309 310

	struct page *discard_page;
	unsigned long discard_page_busy;
311 312

	struct nvme_fault_inject fault_inject;
313 314
};

315 316 317 318 319
enum nvme_iopolicy {
	NVME_IOPOLICY_NUMA,
	NVME_IOPOLICY_RR,
};

C
Christoph Hellwig 已提交
320 321 322 323 324 325 326 327 328 329 330
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 已提交
331
	struct list_head	nsheads;
C
Christoph Hellwig 已提交
332 333 334 335 336 337
	char			subnqn[NVMF_NQN_SIZE];
	char			serial[20];
	char			model[40];
	char			firmware_rev[8];
	u8			cmic;
	u16			vendor_id;
338
	u16			awupf;	/* 0's based awupf value. */
C
Christoph Hellwig 已提交
339
	struct ida		ns_ida;
340 341 342
#ifdef CONFIG_NVME_MULTIPATH
	enum nvme_iopolicy	iopolicy;
#endif
C
Christoph Hellwig 已提交
343 344
};

345 346 347 348 349 350 351
/*
 * Container structure for uniqueue namespace identifiers.
 */
struct nvme_ns_ids {
	u8	eui64[8];
	u8	nguid[16];
	uuid_t	uuid;
352
	u8	csi;
353 354
};

C
Christoph Hellwig 已提交
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
/*
 * 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;
370
	bool			shared;
C
Christoph Hellwig 已提交
371
	int			instance;
372
	struct nvme_effects_log *effects;
373 374 375 376 377 378
#ifdef CONFIG_NVME_MULTIPATH
	struct gendisk		*disk;
	struct bio_list		requeue_list;
	spinlock_t		requeue_lock;
	struct work_struct	requeue_work;
	struct mutex		lock;
379 380
	unsigned long		flags;
#define NVME_NSHEAD_DISK_LIVE	0
381 382
	struct nvme_ns __rcu	*current_path[];
#endif
C
Christoph Hellwig 已提交
383 384
};

385 386
enum nvme_ns_features {
	NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
387
	NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
388 389
};

390 391 392
struct nvme_ns {
	struct list_head list;

393
	struct nvme_ctrl *ctrl;
394 395
	struct request_queue *queue;
	struct gendisk *disk;
C
Christoph Hellwig 已提交
396 397 398 399
#ifdef CONFIG_NVME_MULTIPATH
	enum nvme_ana_state ana_state;
	u32 ana_grpid;
#endif
C
Christoph Hellwig 已提交
400
	struct list_head siblings;
401
	struct nvm_dev *ndev;
402
	struct kref kref;
C
Christoph Hellwig 已提交
403
	struct nvme_ns_head *head;
404 405 406

	int lba_shift;
	u16 ms;
407 408
	u16 sgs;
	u32 sws;
409
	u8 pi_type;
K
Keith Busch 已提交
410 411 412
#ifdef CONFIG_BLK_DEV_ZONED
	u64 zsze;
#endif
413
	unsigned long features;
414
	unsigned long flags;
C
Christoph Hellwig 已提交
415 416 417
#define NVME_NS_REMOVING	0
#define NVME_NS_DEAD     	1
#define NVME_NS_ANA_PENDING	2
T
Thomas Tai 已提交
418 419 420

	struct nvme_fault_inject fault_inject;

421 422
};

423 424 425 426 427 428
/* 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);
}

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

T
Thomas Tai 已提交
445
#ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
446 447 448
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 已提交
449 450
void nvme_should_fail(struct request *req);
#else
451 452 453 454 455 456 457
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 已提交
458 459 460
static inline void nvme_should_fail(struct request *req) {}
#endif

461 462 463 464 465 466 467
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);
}

468 469 470 471
/*
 * 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)
472
{
473
	return sector >> (ns->lba_shift - SECTOR_SHIFT);
474 475
}

476 477 478 479
/*
 * 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)
480
{
481
	return lba << (ns->lba_shift - SECTOR_SHIFT);
482 483
}

K
Keith Busch 已提交
484 485 486 487 488 489 490 491
/*
 * Convert byte length to nvme's 0-based num dwords
 */
static inline u32 nvme_bytes_to_numd(size_t len)
{
	return (len >> 2) - 1;
}

492
static inline bool nvme_end_request(struct request *req, __le16 status,
493
		union nvme_result result)
494
{
495
	struct nvme_request *rq = nvme_req(req);
496

497 498
	rq->status = le16_to_cpu(status) >> 1;
	rq->result = result;
T
Thomas Tai 已提交
499 500
	/* inject error when permitted by fault injection framework */
	nvme_should_fail(req);
501 502 503
	if (unlikely(blk_should_fake_timeout(req->q)))
		return true;
	return blk_mq_complete_request_remote(req);
504 505
}

506 507 508 509 510 511 512 513 514 515
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);
}

516 517 518 519 520
static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
{
	return !qid && command_id >= NVME_AQ_BLK_MQ_DEPTH;
}

521
void nvme_complete_rq(struct request *req);
522
bool nvme_cancel_request(struct request *req, void *data, bool reserved);
523 524
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state);
525
bool nvme_wait_reset(struct nvme_ctrl *ctrl);
526
int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
527
int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
528
int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
529 530
int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
		const struct nvme_ctrl_ops *ops, unsigned long quirks);
531
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
532 533
void nvme_start_ctrl(struct nvme_ctrl *ctrl);
void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
534
int nvme_init_identify(struct nvme_ctrl *ctrl);
535 536

void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
537

538 539
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send);
540

541
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
542
		volatile union nvme_result *res);
543

544 545
void nvme_stop_queues(struct nvme_ctrl *ctrl);
void nvme_start_queues(struct nvme_ctrl *ctrl);
546
void nvme_kill_queues(struct nvme_ctrl *ctrl);
K
Keith Busch 已提交
547
void nvme_sync_queues(struct nvme_ctrl *ctrl);
K
Keith Busch 已提交
548 549 550 551
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);
552

553
#define NVME_QID_ANY -1
554
struct request *nvme_alloc_request(struct request_queue *q,
555
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
556
void nvme_cleanup_cmd(struct request *req);
557
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
558
		struct nvme_command *cmd);
559 560 561
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,
562
		union nvme_result *result, void *buffer, unsigned bufflen,
563
		unsigned timeout, int qid, int at_head,
564
		blk_mq_req_flags_t flags, bool poll);
K
Keith Busch 已提交
565 566 567 568 569 570
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 已提交
571
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
S
Sagi Grimberg 已提交
572
void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
573
int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
S
Sagi Grimberg 已提交
574
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
575
int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
576
int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
577

578
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
579
		void *log, size_t size, u64 offset);
K
Keith Busch 已提交
580 581 582
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);
583

584
extern const struct attribute_group *nvme_ns_id_attr_groups[];
585 586 587
extern const struct block_device_operations nvme_ns_head_ops;

#ifdef CONFIG_NVME_MULTIPATH
588 589 590 591 592
static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
{
	return ctrl->ana_log_buf != NULL;
}

593 594 595
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);
596 597
void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
			struct nvme_ctrl *ctrl, int *flags);
598
bool nvme_failover_req(struct request *req);
599 600
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 已提交
601
void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
602
void nvme_mpath_remove_disk(struct nvme_ns_head *head);
C
Christoph Hellwig 已提交
603 604 605
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);
606 607
bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
608
struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
609
blk_qc_t nvme_ns_head_submit_bio(struct bio *bio);
610 611 612 613 614 615 616 617 618

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 已提交
619 620 621 622 623 624
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)
625
		trace_block_bio_complete(ns->head->disk->queue, req->bio);
H
Hannes Reinecke 已提交
626 627
}

C
Christoph Hellwig 已提交
628 629
extern struct device_attribute dev_attr_ana_grpid;
extern struct device_attribute dev_attr_ana_state;
630
extern struct device_attribute subsys_attr_iopolicy;
C
Christoph Hellwig 已提交
631

632
#else
C
Christoph Hellwig 已提交
633 634 635 636
static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
{
	return false;
}
637 638 639 640 641 642 643 644 645 646
/*
 * 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);
}

647
static inline bool nvme_failover_req(struct request *req)
648
{
649
	return false;
650 651 652 653 654 655 656 657 658
}
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 已提交
659 660
static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
		struct nvme_id_ns *id)
661 662 663 664 665
{
}
static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
{
}
666 667 668 669 670
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)
671 672 673
{
}
static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
674 675
{
}
H
Hannes Reinecke 已提交
676 677 678 679
static inline void nvme_trace_bio_complete(struct request *req,
        blk_status_t status)
{
}
C
Christoph Hellwig 已提交
680 681 682
static inline int nvme_mpath_init(struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
{
683 684 685
	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 已提交
686 687 688 689 690 691 692 693
	return 0;
}
static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
{
}
static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
{
}
694 695 696 697 698 699 700 701 702
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)
{
}
703 704
#endif /* CONFIG_NVME_MULTIPATH */

K
Keith Busch 已提交
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
#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

735
#ifdef CONFIG_NVM
736
int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
737
void nvme_nvm_unregister(struct nvme_ns *ns);
738
extern const struct attribute_group nvme_nvm_attr_group;
739
int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
740
#else
741
static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
742
				    int node)
743 744 745 746
{
	return 0;
}

747
static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
748 749 750 751 752
static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
							unsigned long arg)
{
	return -ENOTTY;
}
753 754
#endif /* CONFIG_NVM */

755 756 757 758
static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
{
	return dev_to_disk(dev)->private_data;
}
M
Matias Bjørling 已提交
759

760 761 762 763 764 765
#ifdef CONFIG_NVME_HWMON
void nvme_hwmon_init(struct nvme_ctrl *ctrl);
#else
static inline void nvme_hwmon_init(struct nvme_ctrl *ctrl) { }
#endif

766
#endif /* _NVME_H */