nvme.h 20.5 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 188 189 190 191 192
/*
 * enum nvme_ctrl_state: Controller state
 *
 * @NVME_CTRL_NEW:		New controller just allocated, initial state
 * @NVME_CTRL_LIVE:		Controller is connected and I/O capable
 * @NVME_CTRL_RESETTING:	Controller is resetting (or scheduled reset)
 * @NVME_CTRL_CONNECTING:	Controller is disconnected, now connecting the
 *				transport
 * @NVME_CTRL_DELETING:		Controller is deleting (or scheduled deletion)
193 194 195 196 197
 * @NVME_CTRL_DELETING_NOIO:	Controller is deleting and I/O is not
 *				disabled/failed immediately. This state comes
 * 				after all async event processing took place and
 * 				before ns removal and the controller deletion
 * 				progress
198 199 200 201 202
 * @NVME_CTRL_DEAD:		Controller is non-present/unresponsive during
 *				shutdown or removal. In this case we forcibly
 *				kill all inflight I/O as they have no chance to
 *				complete
 */
203 204 205 206
enum nvme_ctrl_state {
	NVME_CTRL_NEW,
	NVME_CTRL_LIVE,
	NVME_CTRL_RESETTING,
207
	NVME_CTRL_CONNECTING,
208
	NVME_CTRL_DELETING,
209
	NVME_CTRL_DELETING_NOIO,
210
	NVME_CTRL_DEAD,
211 212
};

213 214 215 216 217 218 219 220 221
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
};

222 223 224 225 226 227
struct nvme_cel {
	struct list_head	entry;
	struct nvme_effects_log	log;
	u8			csi;
};

228
struct nvme_ctrl {
229
	bool comp_seen;
230
	enum nvme_ctrl_state state;
231
	bool identified;
232
	spinlock_t lock;
233
	struct mutex scan_lock;
234
	const struct nvme_ctrl_ops *ops;
235
	struct request_queue *admin_q;
236
	struct request_queue *connect_q;
237
	struct request_queue *fabrics_q;
238 239
	struct device *dev;
	int instance;
240
	int numa_node;
241
	struct blk_mq_tag_set *tagset;
242
	struct blk_mq_tag_set *admin_tagset;
243
	struct list_head namespaces;
244
	struct rw_semaphore namespaces_rwsem;
245
	struct device ctrl_device;
246
	struct device *device;	/* char device */
247
	struct cdev cdev;
248
	struct work_struct reset_work;
249
	struct work_struct delete_work;
250
	wait_queue_head_t state_wq;
251

C
Christoph Hellwig 已提交
252 253 254
	struct nvme_subsystem *subsys;
	struct list_head subsys_entry;

255
	struct opal_dev *opal_dev;
256

257
	char name[12];
C
Christoph Hellwig 已提交
258
	u16 cntlid;
259 260

	u32 ctrl_config;
261
	u16 mtfa;
262
	u32 queue_count;
263

264
	u64 cap;
265
	u32 max_hw_sectors;
266
	u32 max_segments;
267
	u32 max_integrity_segments;
K
Keith Busch 已提交
268 269 270
#ifdef CONFIG_BLK_DEV_ZONED
	u32 max_zone_append;
#endif
271
	u16 crdt[3];
272
	u16 oncs;
273
	u16 oacs;
274 275
	u16 nssa;
	u16 nr_streams;
276
	u16 sqsize;
C
Christoph Hellwig 已提交
277
	u32 max_namespaces;
278
	atomic_t abort_limit;
279
	u8 vwc;
280
	u32 vs;
281
	u32 sgls;
S
Sagi Grimberg 已提交
282
	u16 kas;
283 284
	u8 npss;
	u8 apsta;
285 286
	u16 wctemp;
	u16 cctemp;
287
	u32 oaes;
288
	u32 aen_result;
S
Sagi Grimberg 已提交
289
	u32 ctratt;
290
	unsigned int shutdown_timeout;
S
Sagi Grimberg 已提交
291
	unsigned int kato;
292
	bool subsystem;
293
	unsigned long quirks;
294
	struct nvme_id_power_state psd[32];
295
	struct nvme_effects_log *effects;
296
	struct list_head cels;
297
	struct work_struct scan_work;
298
	struct work_struct async_event_work;
S
Sagi Grimberg 已提交
299
	struct delayed_work ka_work;
300
	struct nvme_command ka_cmd;
301
	struct work_struct fw_act_work;
302
	unsigned long events;
303
	bool created;
304

C
Christoph Hellwig 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317
#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

318 319
	/* Power saving configuration */
	u64 ps_max_latency_us;
320
	bool apst_enabled;
321

322
	/* PCIe only: */
323 324
	u32 hmpre;
	u32 hmmin;
325 326
	u32 hmminds;
	u16 hmmaxd;
327

328 329 330 331 332
	/* Fabrics only */
	u32 ioccsz;
	u32 iorcsz;
	u16 icdoff;
	u16 maxcmd;
333
	int nr_reconnects;
334
	struct nvmf_ctrl_options *opts;
335 336 337

	struct page *discard_page;
	unsigned long discard_page_busy;
338 339

	struct nvme_fault_inject fault_inject;
340 341
};

342 343 344 345 346
enum nvme_iopolicy {
	NVME_IOPOLICY_NUMA,
	NVME_IOPOLICY_RR,
};

C
Christoph Hellwig 已提交
347 348 349 350 351 352 353 354 355 356 357
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 已提交
358
	struct list_head	nsheads;
C
Christoph Hellwig 已提交
359 360 361 362 363 364
	char			subnqn[NVMF_NQN_SIZE];
	char			serial[20];
	char			model[40];
	char			firmware_rev[8];
	u8			cmic;
	u16			vendor_id;
365
	u16			awupf;	/* 0's based awupf value. */
C
Christoph Hellwig 已提交
366
	struct ida		ns_ida;
367 368 369
#ifdef CONFIG_NVME_MULTIPATH
	enum nvme_iopolicy	iopolicy;
#endif
C
Christoph Hellwig 已提交
370 371
};

372 373 374 375 376 377 378
/*
 * Container structure for uniqueue namespace identifiers.
 */
struct nvme_ns_ids {
	u8	eui64[8];
	u8	nguid[16];
	uuid_t	uuid;
379
	u8	csi;
380 381
};

C
Christoph Hellwig 已提交
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
/*
 * 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;
397
	bool			shared;
C
Christoph Hellwig 已提交
398
	int			instance;
399
	struct nvme_effects_log *effects;
400 401 402 403 404 405
#ifdef CONFIG_NVME_MULTIPATH
	struct gendisk		*disk;
	struct bio_list		requeue_list;
	spinlock_t		requeue_lock;
	struct work_struct	requeue_work;
	struct mutex		lock;
406 407
	unsigned long		flags;
#define NVME_NSHEAD_DISK_LIVE	0
408 409
	struct nvme_ns __rcu	*current_path[];
#endif
C
Christoph Hellwig 已提交
410 411
};

412 413
enum nvme_ns_features {
	NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
414
	NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
415 416
};

417 418 419
struct nvme_ns {
	struct list_head list;

420
	struct nvme_ctrl *ctrl;
421 422
	struct request_queue *queue;
	struct gendisk *disk;
C
Christoph Hellwig 已提交
423 424 425 426
#ifdef CONFIG_NVME_MULTIPATH
	enum nvme_ana_state ana_state;
	u32 ana_grpid;
#endif
C
Christoph Hellwig 已提交
427
	struct list_head siblings;
428
	struct nvm_dev *ndev;
429
	struct kref kref;
C
Christoph Hellwig 已提交
430
	struct nvme_ns_head *head;
431 432 433

	int lba_shift;
	u16 ms;
434 435
	u16 sgs;
	u32 sws;
436
	u8 pi_type;
K
Keith Busch 已提交
437 438 439
#ifdef CONFIG_BLK_DEV_ZONED
	u64 zsze;
#endif
440
	unsigned long features;
441
	unsigned long flags;
C
Christoph Hellwig 已提交
442 443 444
#define NVME_NS_REMOVING	0
#define NVME_NS_DEAD     	1
#define NVME_NS_ANA_PENDING	2
T
Thomas Tai 已提交
445 446 447

	struct nvme_fault_inject fault_inject;

448 449
};

450 451 452 453 454 455
/* 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);
}

456
struct nvme_ctrl_ops {
M
Ming Lin 已提交
457
	const char *name;
458
	struct module *module;
459 460
	unsigned int flags;
#define NVME_F_FABRICS			(1 << 0)
461
#define NVME_F_METADATA_SUPPORTED	(1 << 1)
462
#define NVME_F_PCI_P2PDMA		(1 << 2)
463
	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
464
	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
465
	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
466
	void (*free_ctrl)(struct nvme_ctrl *ctrl);
467
	void (*submit_async_event)(struct nvme_ctrl *ctrl);
468
	void (*delete_ctrl)(struct nvme_ctrl *ctrl);
M
Ming Lin 已提交
469
	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
470 471
};

T
Thomas Tai 已提交
472
#ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
473 474 475
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 已提交
476 477
void nvme_should_fail(struct request *req);
#else
478 479 480 481 482 483 484
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 已提交
485 486 487
static inline void nvme_should_fail(struct request *req) {}
#endif

488 489 490 491 492 493 494
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);
}

495 496 497 498
/*
 * 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)
499
{
500
	return sector >> (ns->lba_shift - SECTOR_SHIFT);
501 502
}

503 504 505 506
/*
 * 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)
507
{
508
	return lba << (ns->lba_shift - SECTOR_SHIFT);
509 510
}

K
Keith Busch 已提交
511 512 513 514 515 516 517 518
/*
 * Convert byte length to nvme's 0-based num dwords
 */
static inline u32 nvme_bytes_to_numd(size_t len)
{
	return (len >> 2) - 1;
}

519
static inline bool nvme_end_request(struct request *req, __le16 status,
520
		union nvme_result result)
521
{
522
	struct nvme_request *rq = nvme_req(req);
523

524 525
	rq->status = le16_to_cpu(status) >> 1;
	rq->result = result;
T
Thomas Tai 已提交
526 527
	/* inject error when permitted by fault injection framework */
	nvme_should_fail(req);
528 529 530
	if (unlikely(blk_should_fake_timeout(req->q)))
		return true;
	return blk_mq_complete_request_remote(req);
531 532
}

533 534 535 536 537 538 539 540 541 542
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);
}

543 544 545 546 547
static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
{
	return !qid && command_id >= NVME_AQ_BLK_MQ_DEPTH;
}

548
void nvme_complete_rq(struct request *req);
549
bool nvme_cancel_request(struct request *req, void *data, bool reserved);
550 551
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state);
552
bool nvme_wait_reset(struct nvme_ctrl *ctrl);
553
int nvme_disable_ctrl(struct nvme_ctrl *ctrl);
554
int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
555
int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
556 557
int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
		const struct nvme_ctrl_ops *ops, unsigned long quirks);
558
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
559 560
void nvme_start_ctrl(struct nvme_ctrl *ctrl);
void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
561
int nvme_init_identify(struct nvme_ctrl *ctrl);
562 563

void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
564

565 566
int nvme_sec_submit(void *data, u16 spsp, u8 secp, void *buffer, size_t len,
		bool send);
567

568
void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
569
		volatile union nvme_result *res);
570

571 572
void nvme_stop_queues(struct nvme_ctrl *ctrl);
void nvme_start_queues(struct nvme_ctrl *ctrl);
573
void nvme_kill_queues(struct nvme_ctrl *ctrl);
K
Keith Busch 已提交
574
void nvme_sync_queues(struct nvme_ctrl *ctrl);
K
Keith Busch 已提交
575 576 577 578
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);
579

580
#define NVME_QID_ANY -1
581
struct request *nvme_alloc_request(struct request_queue *q,
582
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
583
void nvme_cleanup_cmd(struct request *req);
584
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
M
Ming Lin 已提交
585
		struct nvme_command *cmd);
586 587 588
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,
589
		union nvme_result *result, void *buffer, unsigned bufflen,
590
		unsigned timeout, int qid, int at_head,
591
		blk_mq_req_flags_t flags, bool poll);
K
Keith Busch 已提交
592 593 594 595 596 597
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 已提交
598
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
S
Sagi Grimberg 已提交
599
void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
600
int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
S
Sagi Grimberg 已提交
601
int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
602
int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
603
int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
604

605
int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
606
		void *log, size_t size, u64 offset);
K
Keith Busch 已提交
607 608 609
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);
610

611
extern const struct attribute_group *nvme_ns_id_attr_groups[];
612 613 614
extern const struct block_device_operations nvme_ns_head_ops;

#ifdef CONFIG_NVME_MULTIPATH
615 616 617 618 619
static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
{
	return ctrl->ana_log_buf != NULL;
}

620 621 622
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);
623 624
void nvme_set_disk_name(char *disk_name, struct nvme_ns *ns,
			struct nvme_ctrl *ctrl, int *flags);
625
bool nvme_failover_req(struct request *req);
626 627
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 已提交
628
void nvme_mpath_add_disk(struct nvme_ns *ns, struct nvme_id_ns *id);
629
void nvme_mpath_remove_disk(struct nvme_ns_head *head);
C
Christoph Hellwig 已提交
630 631 632
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);
633 634
bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
635
struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
636
blk_qc_t nvme_ns_head_submit_bio(struct bio *bio);
637 638 639 640 641 642 643 644 645

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 已提交
646 647 648 649 650 651
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)
652
		trace_block_bio_complete(ns->head->disk->queue, req->bio);
H
Hannes Reinecke 已提交
653 654
}

C
Christoph Hellwig 已提交
655 656
extern struct device_attribute dev_attr_ana_grpid;
extern struct device_attribute dev_attr_ana_state;
657
extern struct device_attribute subsys_attr_iopolicy;
C
Christoph Hellwig 已提交
658

659
#else
C
Christoph Hellwig 已提交
660 661 662 663
static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
{
	return false;
}
664 665 666 667 668 669 670 671 672 673
/*
 * 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);
}

674
static inline bool nvme_failover_req(struct request *req)
675
{
676
	return false;
677 678 679 680 681 682 683 684 685
}
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 已提交
686 687
static inline void nvme_mpath_add_disk(struct nvme_ns *ns,
		struct nvme_id_ns *id)
688 689 690 691 692
{
}
static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
{
}
693 694 695 696 697
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)
698 699 700
{
}
static inline void nvme_mpath_check_last_path(struct nvme_ns *ns)
701 702
{
}
H
Hannes Reinecke 已提交
703 704 705 706
static inline void nvme_trace_bio_complete(struct request *req,
        blk_status_t status)
{
}
C
Christoph Hellwig 已提交
707 708 709
static inline int nvme_mpath_init(struct nvme_ctrl *ctrl,
		struct nvme_id_ctrl *id)
{
710 711 712
	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 已提交
713 714 715 716 717 718 719 720
	return 0;
}
static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
{
}
static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
{
}
721 722 723 724 725 726 727 728 729
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)
{
}
730 731
#endif /* CONFIG_NVME_MULTIPATH */

K
Keith Busch 已提交
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
#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

762
#ifdef CONFIG_NVM
763
int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
764
void nvme_nvm_unregister(struct nvme_ns *ns);
765
extern const struct attribute_group nvme_nvm_attr_group;
766
int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
767
#else
768
static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
769
				    int node)
770 771 772 773
{
	return 0;
}

774
static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
775 776 777 778 779
static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
							unsigned long arg)
{
	return -ENOTTY;
}
780 781
#endif /* CONFIG_NVM */

782 783 784 785
static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
{
	return dev_to_disk(dev)->private_data;
}
M
Matias Bjørling 已提交
786

787 788 789 790 791 792
#ifdef CONFIG_NVME_HWMON
void nvme_hwmon_init(struct nvme_ctrl *ctrl);
#else
static inline void nvme_hwmon_init(struct nvme_ctrl *ctrl) { }
#endif

793
#endif /* _NVME_H */