nvme.h

   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/sed-opal.h>
  15#include <linux/fault-inject.h>
  16#include <linux/rcupdate.h>
  17#include <linux/wait.h>
  18#include <linux/t10-pi.h>
  19#include <linux/ratelimit_types.h>
  20
  21#include <trace/events/block.h>
  22
  23extern const struct pr_ops nvme_pr_ops;
  24
  25extern unsigned int nvme_io_timeout;
  26#define NVME_IO_TIMEOUT	(nvme_io_timeout * HZ)
  27
  28extern unsigned int admin_timeout;
  29#define NVME_ADMIN_TIMEOUT	(admin_timeout * HZ)
  30
  31#define NVME_DEFAULT_KATO	5
  32
  33#ifdef CONFIG_ARCH_NO_SG_CHAIN
  34#define  NVME_INLINE_SG_CNT  0
  35#define  NVME_INLINE_METADATA_SG_CNT  0
  36#else
  37#define  NVME_INLINE_SG_CNT  2
  38#define  NVME_INLINE_METADATA_SG_CNT  1
  39#endif
  40
  41/*
  42 * Default to a 4K page size, with the intention to update this
  43 * path in the future to accommodate architectures with differing
  44 * kernel and IO page sizes.
  45 */
  46#define NVME_CTRL_PAGE_SHIFT	12
  47#define NVME_CTRL_PAGE_SIZE	(1 << NVME_CTRL_PAGE_SHIFT)
  48
  49extern struct workqueue_struct *nvme_wq;
  50extern struct workqueue_struct *nvme_reset_wq;
  51extern struct workqueue_struct *nvme_delete_wq;
  52extern struct mutex nvme_subsystems_lock;
  53
  54/*
  55 * List of workarounds for devices that required behavior not specified in
  56 * the standard.
  57 */
  58enum nvme_quirks {
  59	/*
  60	 * Prefers I/O aligned to a stripe size specified in a vendor
  61	 * specific Identify field.
  62	 */
  63	NVME_QUIRK_STRIPE_SIZE			= (1 << 0),
  64
  65	/*
  66	 * The controller doesn't handle Identify value others than 0 or 1
  67	 * correctly.
  68	 */
  69	NVME_QUIRK_IDENTIFY_CNS			= (1 << 1),
  70
  71	/*
  72	 * The controller deterministically returns 0's on reads to
  73	 * logical blocks that deallocate was called on.
  74	 */
  75	NVME_QUIRK_DEALLOCATE_ZEROES		= (1 << 2),
  76
  77	/*
  78	 * The controller needs a delay before starts checking the device
  79	 * readiness, which is done by reading the NVME_CSTS_RDY bit.
  80	 */
  81	NVME_QUIRK_DELAY_BEFORE_CHK_RDY		= (1 << 3),
  82
  83	/*
  84	 * APST should not be used.
  85	 */
  86	NVME_QUIRK_NO_APST			= (1 << 4),
  87
  88	/*
  89	 * The deepest sleep state should not be used.
  90	 */
  91	NVME_QUIRK_NO_DEEPEST_PS		= (1 << 5),
  92
  93	/*
  94	 *  Problems seen with concurrent commands
  95	 */
  96	NVME_QUIRK_QDEPTH_ONE			= (1 << 6),
  97
  98	/*
  99	 * Set MEDIUM priority on SQ creation
 100	 */
 101	NVME_QUIRK_MEDIUM_PRIO_SQ		= (1 << 7),
 102
 103	/*
 104	 * Ignore device provided subnqn.
 105	 */
 106	NVME_QUIRK_IGNORE_DEV_SUBNQN		= (1 << 8),
 107
 108	/*
 109	 * Broken Write Zeroes.
 110	 */
 111	NVME_QUIRK_DISABLE_WRITE_ZEROES		= (1 << 9),
 112
 113	/*
 114	 * Force simple suspend/resume path.
 115	 */
 116	NVME_QUIRK_SIMPLE_SUSPEND		= (1 << 10),
 117
 118	/*
 119	 * Use only one interrupt vector for all queues
 120	 */
 121	NVME_QUIRK_SINGLE_VECTOR		= (1 << 11),
 122
 123	/*
 124	 * Use non-standard 128 bytes SQEs.
 125	 */
 126	NVME_QUIRK_128_BYTES_SQES		= (1 << 12),
 127
 128	/*
 129	 * Prevent tag overlap between queues
 130	 */
 131	NVME_QUIRK_SHARED_TAGS                  = (1 << 13),
 132
 133	/*
 134	 * Don't change the value of the temperature threshold feature
 135	 */
 136	NVME_QUIRK_NO_TEMP_THRESH_CHANGE	= (1 << 14),
 137
 138	/*
 139	 * The controller doesn't handle the Identify Namespace
 140	 * Identification Descriptor list subcommand despite claiming
 141	 * NVMe 1.3 compliance.
 142	 */
 143	NVME_QUIRK_NO_NS_DESC_LIST		= (1 << 15),
 144
 145	/*
 146	 * The controller does not properly handle DMA addresses over
 147	 * 48 bits.
 148	 */
 149	NVME_QUIRK_DMA_ADDRESS_BITS_48		= (1 << 16),
 150
 151	/*
 152	 * The controller requires the command_id value be limited, so skip
 153	 * encoding the generation sequence number.
 154	 */
 155	NVME_QUIRK_SKIP_CID_GEN			= (1 << 17),
 156
 157	/*
 158	 * Reports garbage in the namespace identifiers (eui64, nguid, uuid).
 159	 */
 160	NVME_QUIRK_BOGUS_NID			= (1 << 18),
 161
 162	/*
 163	 * No temperature thresholds for channels other than 0 (Composite).
 164	 */
 165	NVME_QUIRK_NO_SECONDARY_TEMP_THRESH	= (1 << 19),
 166
 167	/*
 168	 * Disables simple suspend/resume path.
 169	 */
 170	NVME_QUIRK_FORCE_NO_SIMPLE_SUSPEND	= (1 << 20),
 171
 172	/*
 173	 * MSI (but not MSI-X) interrupts are broken and never fire.
 174	 */
 175	NVME_QUIRK_BROKEN_MSI			= (1 << 21),
 176
 177	/*
 178	 * Align dma pool segment size to 512 bytes
 179	 */
 180	NVME_QUIRK_DMAPOOL_ALIGN_512		= (1 << 22),
 181};
 182
 183/*
 184 * Common request structure for NVMe passthrough.  All drivers must have
 185 * this structure as the first member of their request-private data.
 186 */
 187struct nvme_request {
 188	struct nvme_command	*cmd;
 189	union nvme_result	result;
 190	u8			genctr;
 191	u8			retries;
 192	u8			flags;
 193	u16			status;
 194#ifdef CONFIG_NVME_MULTIPATH
 195	unsigned long		start_time;
 196#endif
 197	struct nvme_ctrl	*ctrl;
 198};
 199
 200/*
 201 * Mark a bio as coming in through the mpath node.
 202 */
 203#define REQ_NVME_MPATH		REQ_DRV
 204
 205enum {
 206	NVME_REQ_CANCELLED		= (1 << 0),
 207	NVME_REQ_USERCMD		= (1 << 1),
 208	NVME_MPATH_IO_STATS		= (1 << 2),
 209	NVME_MPATH_CNT_ACTIVE		= (1 << 3),
 210};
 211
 212static inline struct nvme_request *nvme_req(struct request *req)
 213{
 214	return blk_mq_rq_to_pdu(req);
 215}
 216
 217static inline u16 nvme_req_qid(struct request *req)
 218{
 219	if (!req->q->queuedata)
 220		return 0;
 221
 222	return req->mq_hctx->queue_num + 1;
 223}
 224
 225/* The below value is the specific amount of delay needed before checking
 226 * readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
 227 * NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
 228 * found empirically.
 229 */
 230#define NVME_QUIRK_DELAY_AMOUNT		2300
 231
 232/*
 233 * enum nvme_ctrl_state: Controller state
 234 *
 235 * @NVME_CTRL_NEW:		New controller just allocated, initial state
 236 * @NVME_CTRL_LIVE:		Controller is connected and I/O capable
 237 * @NVME_CTRL_RESETTING:	Controller is resetting (or scheduled reset)
 238 * @NVME_CTRL_CONNECTING:	Controller is disconnected, now connecting the
 239 *				transport
 240 * @NVME_CTRL_DELETING:		Controller is deleting (or scheduled deletion)
 241 * @NVME_CTRL_DELETING_NOIO:	Controller is deleting and I/O is not
 242 *				disabled/failed immediately. This state comes
 243 * 				after all async event processing took place and
 244 * 				before ns removal and the controller deletion
 245 * 				progress
 246 * @NVME_CTRL_DEAD:		Controller is non-present/unresponsive during
 247 *				shutdown or removal. In this case we forcibly
 248 *				kill all inflight I/O as they have no chance to
 249 *				complete
 250 */
 251enum nvme_ctrl_state {
 252	NVME_CTRL_NEW,
 253	NVME_CTRL_LIVE,
 254	NVME_CTRL_RESETTING,
 255	NVME_CTRL_CONNECTING,
 256	NVME_CTRL_DELETING,
 257	NVME_CTRL_DELETING_NOIO,
 258	NVME_CTRL_DEAD,
 259};
 260
 261struct nvme_fault_inject {
 262#ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
 263	struct fault_attr attr;
 264	struct dentry *parent;
 265	bool dont_retry;	/* DNR, do not retry */
 266	u16 status;		/* status code */
 267#endif
 268};
 269
 270enum nvme_ctrl_flags {
 271	NVME_CTRL_FAILFAST_EXPIRED	= 0,
 272	NVME_CTRL_ADMIN_Q_STOPPED	= 1,
 273	NVME_CTRL_STARTED_ONCE		= 2,
 274	NVME_CTRL_STOPPED		= 3,
 275	NVME_CTRL_SKIP_ID_CNS_CS	= 4,
 276	NVME_CTRL_DIRTY_CAPABILITY	= 5,
 277	NVME_CTRL_FROZEN		= 6,
 278};
 279
 280struct nvme_ctrl {
 281	bool comp_seen;
 282	bool identified;
 283	bool passthru_err_log_enabled;
 284	enum nvme_ctrl_state state;
 285	spinlock_t lock;
 286	struct mutex scan_lock;
 287	const struct nvme_ctrl_ops *ops;
 288	struct request_queue *admin_q;
 289	struct request_queue *connect_q;
 290	struct request_queue *fabrics_q;
 291	struct device *dev;
 292	int instance;
 293	int numa_node;
 294	struct blk_mq_tag_set *tagset;
 295	struct blk_mq_tag_set *admin_tagset;
 296	struct list_head namespaces;
 297	struct mutex namespaces_lock;
 298	struct srcu_struct srcu;
 299	struct device ctrl_device;
 300	struct device *device;	/* char device */
 301#ifdef CONFIG_NVME_HWMON
 302	struct device *hwmon_device;
 303#endif
 304	struct cdev cdev;
 305	struct work_struct reset_work;
 306	struct work_struct delete_work;
 307	wait_queue_head_t state_wq;
 308
 309	struct nvme_subsystem *subsys;
 310	struct list_head subsys_entry;
 311
 312	struct opal_dev *opal_dev;
 313
 314	u16 cntlid;
 315
 316	u16 mtfa;
 317	u32 ctrl_config;
 318	u32 queue_count;
 319
 320	u64 cap;
 321	u32 max_hw_sectors;
 322	u32 max_segments;
 323	u32 max_integrity_segments;
 324	u32 max_zeroes_sectors;
 325#ifdef CONFIG_BLK_DEV_ZONED
 326	u32 max_zone_append;
 327#endif
 328	u16 crdt[3];
 329	u16 oncs;
 330	u8 dmrl;
 331	u32 dmrsl;
 332	u16 oacs;
 333	u16 sqsize;
 334	u32 max_namespaces;
 335	atomic_t abort_limit;
 336	u8 vwc;
 337	u32 vs;
 338	u32 sgls;
 339	u16 kas;
 340	u8 npss;
 341	u8 apsta;
 342	u16 wctemp;
 343	u16 cctemp;
 344	u32 oaes;
 345	u32 aen_result;
 346	u32 ctratt;
 347	unsigned int shutdown_timeout;
 348	unsigned int kato;
 349	bool subsystem;
 350	unsigned long quirks;
 351	struct nvme_id_power_state psd[32];
 352	struct nvme_effects_log *effects;
 353	struct xarray cels;
 354	struct work_struct scan_work;
 355	struct work_struct async_event_work;
 356	struct delayed_work ka_work;
 357	struct delayed_work failfast_work;
 358	struct nvme_command ka_cmd;
 359	unsigned long ka_last_check_time;
 360	struct work_struct fw_act_work;
 361	unsigned long events;
 362
 363#ifdef CONFIG_NVME_MULTIPATH
 364	/* asymmetric namespace access: */
 365	u8 anacap;
 366	u8 anatt;
 367	u32 anagrpmax;
 368	u32 nanagrpid;
 369	struct mutex ana_lock;
 370	struct nvme_ana_rsp_hdr *ana_log_buf;
 371	size_t ana_log_size;
 372	struct timer_list anatt_timer;
 373	struct work_struct ana_work;
 374	atomic_t nr_active;
 375#endif
 376
 377#ifdef CONFIG_NVME_HOST_AUTH
 378	struct work_struct dhchap_auth_work;
 379	struct mutex dhchap_auth_mutex;
 380	struct nvme_dhchap_queue_context *dhchap_ctxs;
 381	struct nvme_dhchap_key *host_key;
 382	struct nvme_dhchap_key *ctrl_key;
 383	u16 transaction;
 384#endif
 385	key_serial_t tls_pskid;
 386
 387	/* Power saving configuration */
 388	u64 ps_max_latency_us;
 389	bool apst_enabled;
 390
 391	/* PCIe only: */
 392	u16 hmmaxd;
 393	u32 hmpre;
 394	u32 hmmin;
 395	u32 hmminds;
 396
 397	/* Fabrics only */
 398	u32 ioccsz;
 399	u32 iorcsz;
 400	u16 icdoff;
 401	u16 maxcmd;
 402	int nr_reconnects;
 403	unsigned long flags;
 404	struct nvmf_ctrl_options *opts;
 405
 406	struct page *discard_page;
 407	unsigned long discard_page_busy;
 408
 409	struct nvme_fault_inject fault_inject;
 410
 411	enum nvme_ctrl_type cntrltype;
 412	enum nvme_dctype dctype;
 413};
 414
 415static inline enum nvme_ctrl_state nvme_ctrl_state(struct nvme_ctrl *ctrl)
 416{
 417	return READ_ONCE(ctrl->state);
 418}
 419
 420enum nvme_iopolicy {
 421	NVME_IOPOLICY_NUMA,
 422	NVME_IOPOLICY_RR,
 423	NVME_IOPOLICY_QD,
 424};
 425
 426struct nvme_subsystem {
 427	int			instance;
 428	struct device		dev;
 429	/*
 430	 * Because we unregister the device on the last put we need
 431	 * a separate refcount.
 432	 */
 433	struct kref		ref;
 434	struct list_head	entry;
 435	struct mutex		lock;
 436	struct list_head	ctrls;
 437	struct list_head	nsheads;
 438	char			subnqn[NVMF_NQN_SIZE];
 439	char			serial[20];
 440	char			model[40];
 441	char			firmware_rev[8];
 442	u8			cmic;
 443	enum nvme_subsys_type	subtype;
 444	u16			vendor_id;
 445	u16			awupf; /* 0's based value. */
 446	struct ida		ns_ida;
 447#ifdef CONFIG_NVME_MULTIPATH
 448	enum nvme_iopolicy	iopolicy;
 449#endif
 450};
 451
 452/*
 453 * Container structure for uniqueue namespace identifiers.
 454 */
 455struct nvme_ns_ids {
 456	u8	eui64[8];
 457	u8	nguid[16];
 458	uuid_t	uuid;
 459	u8	csi;
 460};
 461
 462/*
 463 * Anchor structure for namespaces.  There is one for each namespace in a
 464 * NVMe subsystem that any of our controllers can see, and the namespace
 465 * structure for each controller is chained of it.  For private namespaces
 466 * there is a 1:1 relation to our namespace structures, that is ->list
 467 * only ever has a single entry for private namespaces.
 468 */
 469struct nvme_ns_head {
 470	struct list_head	list;
 471	struct srcu_struct      srcu;
 472	struct nvme_subsystem	*subsys;
 473	struct nvme_ns_ids	ids;
 474	u8			lba_shift;
 475	u16			ms;
 476	u16			pi_size;
 477	u8			pi_type;
 478	u8			guard_type;
 479	struct list_head	entry;
 480	struct kref		ref;
 481	bool			shared;
 482	bool			rotational;
 483	bool			passthru_err_log_enabled;
 484	struct nvme_effects_log *effects;
 485	u64			nuse;
 486	unsigned		ns_id;
 487	int			instance;
 488#ifdef CONFIG_BLK_DEV_ZONED
 489	u64			zsze;
 490#endif
 491	unsigned long		features;
 492
 493	struct ratelimit_state	rs_nuse;
 494
 495	struct cdev		cdev;
 496	struct device		cdev_device;
 497
 498	struct gendisk		*disk;
 499
 500	u16			nr_plids;
 501	u16			*plids;
 502#ifdef CONFIG_NVME_MULTIPATH
 503	struct bio_list		requeue_list;
 504	spinlock_t		requeue_lock;
 505	struct work_struct	requeue_work;
 506	struct work_struct	partition_scan_work;
 507	struct mutex		lock;
 508	unsigned long		flags;
 509	struct delayed_work	remove_work;
 510	unsigned int		delayed_removal_secs;
 511#define NVME_NSHEAD_DISK_LIVE		0
 512#define NVME_NSHEAD_QUEUE_IF_NO_PATH	1
 513	struct nvme_ns __rcu	*current_path[];
 514#endif
 515};
 516
 517static inline bool nvme_ns_head_multipath(struct nvme_ns_head *head)
 518{
 519	return IS_ENABLED(CONFIG_NVME_MULTIPATH) && head->disk;
 520}
 521
 522enum nvme_ns_features {
 523	NVME_NS_EXT_LBAS = 1 << 0, /* support extended LBA format */
 524	NVME_NS_METADATA_SUPPORTED = 1 << 1, /* support getting generated md */
 525	NVME_NS_DEAC = 1 << 2,		/* DEAC bit in Write Zeroes supported */
 526};
 527
 528struct nvme_ns {
 529	struct list_head list;
 530
 531	struct nvme_ctrl *ctrl;
 532	struct request_queue *queue;
 533	struct gendisk *disk;
 534#ifdef CONFIG_NVME_MULTIPATH
 535	enum nvme_ana_state ana_state;
 536	u32 ana_grpid;
 537#endif
 538	struct list_head siblings;
 539	struct kref kref;
 540	struct nvme_ns_head *head;
 541
 542	unsigned long flags;
 543#define NVME_NS_REMOVING		0
 544#define NVME_NS_ANA_PENDING		2
 545#define NVME_NS_FORCE_RO		3
 546#define NVME_NS_READY			4
 547#define NVME_NS_SYSFS_ATTR_LINK	5
 548
 549	struct cdev		cdev;
 550	struct device		cdev_device;
 551
 552	struct nvme_fault_inject fault_inject;
 553};
 554
 555/* NVMe ns supports metadata actions by the controller (generate/strip) */
 556static inline bool nvme_ns_has_pi(struct nvme_ns_head *head)
 557{
 558	return head->pi_type && head->ms == head->pi_size;
 559}
 560
 561static inline unsigned long nvme_get_virt_boundary(struct nvme_ctrl *ctrl,
 562						   bool is_admin)
 563{
 564	return NVME_CTRL_PAGE_SIZE - 1;
 565}
 566
 567struct nvme_ctrl_ops {
 568	const char *name;
 569	struct module *module;
 570	unsigned int flags;
 571#define NVME_F_FABRICS			(1 << 0)
 572#define NVME_F_METADATA_SUPPORTED	(1 << 1)
 573#define NVME_F_BLOCKING			(1 << 2)
 574
 575	const struct attribute_group **dev_attr_groups;
 576	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 577	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
 578	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 579	void (*free_ctrl)(struct nvme_ctrl *ctrl);
 580	void (*submit_async_event)(struct nvme_ctrl *ctrl);
 581	int (*subsystem_reset)(struct nvme_ctrl *ctrl);
 582	void (*delete_ctrl)(struct nvme_ctrl *ctrl);
 583	void (*stop_ctrl)(struct nvme_ctrl *ctrl);
 584	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
 585	void (*print_device_info)(struct nvme_ctrl *ctrl);
 586	bool (*supports_pci_p2pdma)(struct nvme_ctrl *ctrl);
 587	unsigned long (*get_virt_boundary)(struct nvme_ctrl *ctrl, bool is_admin);
 588};
 589
 590/*
 591 * nvme command_id is constructed as such:
 592 * | xxxx | xxxxxxxxxxxx |
 593 *   gen    request tag
 594 */
 595#define nvme_genctr_mask(gen)			(gen & 0xf)
 596#define nvme_cid_install_genctr(gen)		(nvme_genctr_mask(gen) << 12)
 597#define nvme_genctr_from_cid(cid)		((cid & 0xf000) >> 12)
 598#define nvme_tag_from_cid(cid)			(cid & 0xfff)
 599
 600static inline u16 nvme_cid(struct request *rq)
 601{
 602	return nvme_cid_install_genctr(nvme_req(rq)->genctr) | rq->tag;
 603}
 604
 605static inline struct request *nvme_find_rq(struct blk_mq_tags *tags,
 606		u16 command_id)
 607{
 608	u8 genctr = nvme_genctr_from_cid(command_id);
 609	u16 tag = nvme_tag_from_cid(command_id);
 610	struct request *rq;
 611
 612	rq = blk_mq_tag_to_rq(tags, tag);
 613	if (unlikely(!rq)) {
 614		pr_err("could not locate request for tag %#x\n",
 615			tag);
 616		return NULL;
 617	}
 618	if (unlikely(nvme_genctr_mask(nvme_req(rq)->genctr) != genctr)) {
 619		dev_err(nvme_req(rq)->ctrl->device,
 620			"request %#x genctr mismatch (got %#x expected %#x)\n",
 621			tag, genctr, nvme_genctr_mask(nvme_req(rq)->genctr));
 622		return NULL;
 623	}
 624	return rq;
 625}
 626
 627static inline struct request *nvme_cid_to_rq(struct blk_mq_tags *tags,
 628                u16 command_id)
 629{
 630	return blk_mq_tag_to_rq(tags, nvme_tag_from_cid(command_id));
 631}
 632
 633/*
 634 * Return the length of the string without the space padding
 635 */
 636static inline int nvme_strlen(char *s, int len)
 637{
 638	while (s[len - 1] == ' ')
 639		len--;
 640	return len;
 641}
 642
 643static inline void nvme_print_device_info(struct nvme_ctrl *ctrl)
 644{
 645	struct nvme_subsystem *subsys = ctrl->subsys;
 646
 647	if (ctrl->ops->print_device_info) {
 648		ctrl->ops->print_device_info(ctrl);
 649		return;
 650	}
 651
 652	dev_err(ctrl->device,
 653		"VID:%04x model:%.*s firmware:%.*s\n", subsys->vendor_id,
 654		nvme_strlen(subsys->model, sizeof(subsys->model)),
 655		subsys->model, nvme_strlen(subsys->firmware_rev,
 656					   sizeof(subsys->firmware_rev)),
 657		subsys->firmware_rev);
 658}
 659
 660#ifdef CONFIG_FAULT_INJECTION_DEBUG_FS
 661void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
 662			    const char *dev_name);
 663void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inject);
 664void nvme_should_fail(struct request *req);
 665#else
 666static inline void nvme_fault_inject_init(struct nvme_fault_inject *fault_inj,
 667					  const char *dev_name)
 668{
 669}
 670static inline void nvme_fault_inject_fini(struct nvme_fault_inject *fault_inj)
 671{
 672}
 673static inline void nvme_should_fail(struct request *req) {}
 674#endif
 675
 676bool nvme_wait_reset(struct nvme_ctrl *ctrl);
 677int nvme_try_sched_reset(struct nvme_ctrl *ctrl);
 678
 679static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
 680{
 681	if (!ctrl->subsystem || !ctrl->ops->subsystem_reset)
 682		return -ENOTTY;
 683	return ctrl->ops->subsystem_reset(ctrl);
 684}
 685
 686/*
 687 * Convert a 512B sector number to a device logical block number.
 688 */
 689static inline u64 nvme_sect_to_lba(struct nvme_ns_head *head, sector_t sector)
 690{
 691	return sector >> (head->lba_shift - SECTOR_SHIFT);
 692}
 693
 694/*
 695 * Convert a device logical block number to a 512B sector number.
 696 */
 697static inline sector_t nvme_lba_to_sect(struct nvme_ns_head *head, u64 lba)
 698{
 699	return lba << (head->lba_shift - SECTOR_SHIFT);
 700}
 701
 702/*
 703 * Convert byte length to nvme's 0-based num dwords
 704 */
 705static inline u32 nvme_bytes_to_numd(size_t len)
 706{
 707	return (len >> 2) - 1;
 708}
 709
 710static inline bool nvme_is_ana_error(u16 status)
 711{
 712	switch (status & NVME_SCT_SC_MASK) {
 713	case NVME_SC_ANA_TRANSITION:
 714	case NVME_SC_ANA_INACCESSIBLE:
 715	case NVME_SC_ANA_PERSISTENT_LOSS:
 716		return true;
 717	default:
 718		return false;
 719	}
 720}
 721
 722static inline bool nvme_is_path_error(u16 status)
 723{
 724	/* check for a status code type of 'path related status' */
 725	return (status & NVME_SCT_MASK) == NVME_SCT_PATH;
 726}
 727
 728/*
 729 * Fill in the status and result information from the CQE, and then figure out
 730 * if blk-mq will need to use IPI magic to complete the request, and if yes do
 731 * so.  If not let the caller complete the request without an indirect function
 732 * call.
 733 */
 734static inline bool nvme_try_complete_req(struct request *req, __le16 status,
 735		union nvme_result result)
 736{
 737	struct nvme_request *rq = nvme_req(req);
 738	struct nvme_ctrl *ctrl = rq->ctrl;
 739
 740	if (!(ctrl->quirks & NVME_QUIRK_SKIP_CID_GEN))
 741		rq->genctr++;
 742
 743	rq->status = le16_to_cpu(status) >> 1;
 744	rq->result = result;
 745	/* inject error when permitted by fault injection framework */
 746	nvme_should_fail(req);
 747	if (unlikely(blk_should_fake_timeout(req->q)))
 748		return true;
 749	return blk_mq_complete_request_remote(req);
 750}
 751
 752static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
 753{
 754	get_device(ctrl->device);
 755}
 756
 757static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
 758{
 759	put_device(ctrl->device);
 760}
 761
 762static inline bool nvme_is_aen_req(u16 qid, __u16 command_id)
 763{
 764	return !qid &&
 765		nvme_tag_from_cid(command_id) >= NVME_AQ_BLK_MQ_DEPTH;
 766}
 767
 768/*
 769 * Returns true for sink states that can't ever transition back to live.
 770 */
 771static inline bool nvme_state_terminal(struct nvme_ctrl *ctrl)
 772{
 773	switch (nvme_ctrl_state(ctrl)) {
 774	case NVME_CTRL_NEW:
 775	case NVME_CTRL_LIVE:
 776	case NVME_CTRL_RESETTING:
 777	case NVME_CTRL_CONNECTING:
 778		return false;
 779	case NVME_CTRL_DELETING:
 780	case NVME_CTRL_DELETING_NOIO:
 781	case NVME_CTRL_DEAD:
 782		return true;
 783	default:
 784		WARN_ONCE(1, "Unhandled ctrl state:%d", ctrl->state);
 785		return true;
 786	}
 787}
 788
 789void nvme_end_req(struct request *req);
 790void nvme_complete_rq(struct request *req);
 791void nvme_complete_batch_req(struct request *req);
 792
 793static __always_inline void nvme_complete_batch(struct io_comp_batch *iob,
 794						void (*fn)(struct request *rq))
 795{
 796	struct request *req;
 797
 798	rq_list_for_each(&iob->req_list, req) {
 799		fn(req);
 800		nvme_complete_batch_req(req);
 801	}
 802	blk_mq_end_request_batch(iob);
 803}
 804
 805blk_status_t nvme_host_path_error(struct request *req);
 806bool nvme_cancel_request(struct request *req, void *data);
 807void nvme_cancel_tagset(struct nvme_ctrl *ctrl);
 808void nvme_cancel_admin_tagset(struct nvme_ctrl *ctrl);
 809bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
 810		enum nvme_ctrl_state new_state);
 811int nvme_disable_ctrl(struct nvme_ctrl *ctrl, bool shutdown);
 812int nvme_enable_ctrl(struct nvme_ctrl *ctrl);
 813int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
 814		const struct nvme_ctrl_ops *ops, unsigned long quirks);
 815int nvme_add_ctrl(struct nvme_ctrl *ctrl);
 816void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
 817void nvme_start_ctrl(struct nvme_ctrl *ctrl);
 818void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
 819int nvme_init_ctrl_finish(struct nvme_ctrl *ctrl, bool was_suspended);
 820int nvme_alloc_admin_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
 821		const struct blk_mq_ops *ops, unsigned int cmd_size);
 822void nvme_remove_admin_tag_set(struct nvme_ctrl *ctrl);
 823int nvme_alloc_io_tag_set(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set,
 824		const struct blk_mq_ops *ops, unsigned int nr_maps,
 825		unsigned int cmd_size);
 826void nvme_remove_io_tag_set(struct nvme_ctrl *ctrl);
 827
 828void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
 829
 830void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
 831		volatile union nvme_result *res);
 832
 833void nvme_quiesce_io_queues(struct nvme_ctrl *ctrl);
 834void nvme_unquiesce_io_queues(struct nvme_ctrl *ctrl);
 835void nvme_quiesce_admin_queue(struct nvme_ctrl *ctrl);
 836void nvme_unquiesce_admin_queue(struct nvme_ctrl *ctrl);
 837void nvme_mark_namespaces_dead(struct nvme_ctrl *ctrl);
 838void nvme_sync_queues(struct nvme_ctrl *ctrl);
 839void nvme_sync_io_queues(struct nvme_ctrl *ctrl);
 840void nvme_unfreeze(struct nvme_ctrl *ctrl);
 841void nvme_wait_freeze(struct nvme_ctrl *ctrl);
 842int nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
 843void nvme_start_freeze(struct nvme_ctrl *ctrl);
 844
 845static inline enum req_op nvme_req_op(struct nvme_command *cmd)
 846{
 847	return nvme_is_write(cmd) ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN;
 848}
 849
 850#define NVME_QID_ANY -1
 851void nvme_init_request(struct request *req, struct nvme_command *cmd);
 852void nvme_cleanup_cmd(struct request *req);
 853blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req);
 854blk_status_t nvme_fail_nonready_command(struct nvme_ctrl *ctrl,
 855		struct request *req);
 856bool __nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
 857		bool queue_live, enum nvme_ctrl_state state);
 858
 859static inline bool nvme_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
 860		bool queue_live)
 861{
 862	enum nvme_ctrl_state state = nvme_ctrl_state(ctrl);
 863
 864	if (likely(state == NVME_CTRL_LIVE))
 865		return true;
 866	if (ctrl->ops->flags & NVME_F_FABRICS && state == NVME_CTRL_DELETING)
 867		return queue_live;
 868	return __nvme_check_ready(ctrl, rq, queue_live, state);
 869}
 870
 871/*
 872 * NSID shall be unique for all shared namespaces, or if at least one of the
 873 * following conditions is met:
 874 *   1. Namespace Management is supported by the controller
 875 *   2. ANA is supported by the controller
 876 *   3. NVM Set are supported by the controller
 877 *
 878 * In other case, private namespace are not required to report a unique NSID.
 879 */
 880static inline bool nvme_is_unique_nsid(struct nvme_ctrl *ctrl,
 881		struct nvme_ns_head *head)
 882{
 883	return head->shared ||
 884		(ctrl->oacs & NVME_CTRL_OACS_NS_MNGT_SUPP) ||
 885		(ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA) ||
 886		(ctrl->ctratt & NVME_CTRL_CTRATT_NVM_SETS);
 887}
 888
 889/*
 890 * Flags for __nvme_submit_sync_cmd()
 891 */
 892typedef __u32 __bitwise nvme_submit_flags_t;
 893
 894enum {
 895	/* Insert request at the head of the queue */
 896	NVME_SUBMIT_AT_HEAD  = (__force nvme_submit_flags_t)(1 << 0),
 897	/* Set BLK_MQ_REQ_NOWAIT when allocating request */
 898	NVME_SUBMIT_NOWAIT = (__force nvme_submit_flags_t)(1 << 1),
 899	/* Set BLK_MQ_REQ_RESERVED when allocating request */
 900	NVME_SUBMIT_RESERVED = (__force nvme_submit_flags_t)(1 << 2),
 901	/* Retry command when NVME_STATUS_DNR is not set in the result */
 902	NVME_SUBMIT_RETRY = (__force nvme_submit_flags_t)(1 << 3),
 903};
 904
 905int nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 906		void *buf, unsigned bufflen);
 907int __nvme_submit_sync_cmd(struct request_queue *q, struct nvme_command *cmd,
 908		union nvme_result *result, void *buffer, unsigned bufflen,
 909		int qid, nvme_submit_flags_t flags);
 910int nvme_set_features(struct nvme_ctrl *dev, unsigned int fid,
 911		      unsigned int dword11, void *buffer, size_t buflen,
 912		      void *result);
 913int nvme_get_features(struct nvme_ctrl *dev, unsigned int fid,
 914		      unsigned int dword11, void *buffer, size_t buflen,
 915		      void *result);
 916int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
 917void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
 918int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
 919int nvme_reset_ctrl_sync(struct nvme_ctrl *ctrl);
 920int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
 921void nvme_queue_scan(struct nvme_ctrl *ctrl);
 922int nvme_get_log(struct nvme_ctrl *ctrl, u32 nsid, u8 log_page, u8 lsp, u8 csi,
 923		void *log, size_t size, u64 offset);
 924bool nvme_tryget_ns_head(struct nvme_ns_head *head);
 925void nvme_put_ns_head(struct nvme_ns_head *head);
 926int nvme_cdev_add(struct cdev *cdev, struct device *cdev_device,
 927		const struct file_operations *fops, struct module *owner);
 928void nvme_cdev_del(struct cdev *cdev, struct device *cdev_device);
 929int nvme_ioctl(struct block_device *bdev, blk_mode_t mode,
 930		unsigned int cmd, unsigned long arg);
 931long nvme_ns_chr_ioctl(struct file *file, unsigned int cmd, unsigned long arg);
 932int nvme_ns_head_ioctl(struct block_device *bdev, blk_mode_t mode,
 933		unsigned int cmd, unsigned long arg);
 934long nvme_ns_head_chr_ioctl(struct file *file, unsigned int cmd,
 935		unsigned long arg);
 936long nvme_dev_ioctl(struct file *file, unsigned int cmd,
 937		unsigned long arg);
 938int nvme_ns_chr_uring_cmd_iopoll(struct io_uring_cmd *ioucmd,
 939		struct io_comp_batch *iob, unsigned int poll_flags);
 940int nvme_ns_chr_uring_cmd(struct io_uring_cmd *ioucmd,
 941		unsigned int issue_flags);
 942int nvme_ns_head_chr_uring_cmd(struct io_uring_cmd *ioucmd,
 943		unsigned int issue_flags);
 944int nvme_identify_ns(struct nvme_ctrl *ctrl, unsigned nsid,
 945		struct nvme_id_ns **id);
 946int nvme_getgeo(struct gendisk *disk, struct hd_geometry *geo);
 947int nvme_dev_uring_cmd(struct io_uring_cmd *ioucmd, unsigned int issue_flags);
 948
 949extern const struct attribute_group *nvme_ns_attr_groups[];
 950extern const struct attribute_group nvme_ns_mpath_attr_group;
 951extern const struct pr_ops nvme_pr_ops;
 952extern const struct block_device_operations nvme_ns_head_ops;
 953extern const struct attribute_group nvme_dev_attrs_group;
 954extern const struct attribute_group *nvme_subsys_attrs_groups[];
 955extern const struct attribute_group *nvme_dev_attr_groups[];
 956extern const struct block_device_operations nvme_bdev_ops;
 957
 958void nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl);
 959struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
 960#ifdef CONFIG_NVME_MULTIPATH
 961static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
 962{
 963	return ctrl->ana_log_buf != NULL;
 964}
 965
 966void nvme_mpath_unfreeze(struct nvme_subsystem *subsys);
 967void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys);
 968void nvme_mpath_start_freeze(struct nvme_subsystem *subsys);
 969void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys);
 970void nvme_failover_req(struct request *req);
 971void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
 972int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
 973void nvme_mpath_add_sysfs_link(struct nvme_ns_head *ns);
 974void nvme_mpath_remove_sysfs_link(struct nvme_ns *ns);
 975void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid);
 976void nvme_mpath_put_disk(struct nvme_ns_head *head);
 977int nvme_mpath_init_identify(struct nvme_ctrl *ctrl, struct nvme_id_ctrl *id);
 978void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl);
 979void nvme_mpath_update(struct nvme_ctrl *ctrl);
 980void nvme_mpath_uninit(struct nvme_ctrl *ctrl);
 981void nvme_mpath_stop(struct nvme_ctrl *ctrl);
 982bool nvme_mpath_clear_current_path(struct nvme_ns *ns);
 983void nvme_mpath_revalidate_paths(struct nvme_ns *ns);
 984void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl);
 985void nvme_mpath_remove_disk(struct nvme_ns_head *head);
 986void nvme_mpath_start_request(struct request *rq);
 987void nvme_mpath_end_request(struct request *rq);
 988
 989static inline void nvme_trace_bio_complete(struct request *req)
 990{
 991	struct nvme_ns *ns = req->q->queuedata;
 992
 993	if ((req->cmd_flags & REQ_NVME_MPATH) && req->bio)
 994		trace_block_bio_complete(ns->head->disk->queue, req->bio);
 995}
 996
 997extern bool multipath;
 998extern struct device_attribute dev_attr_ana_grpid;
 999extern struct device_attribute dev_attr_ana_state;
1000extern struct device_attribute dev_attr_queue_depth;
1001extern struct device_attribute dev_attr_numa_nodes;
1002extern struct device_attribute dev_attr_delayed_removal_secs;
1003extern struct device_attribute subsys_attr_iopolicy;
1004
1005static inline bool nvme_disk_is_ns_head(struct gendisk *disk)
1006{
1007	return disk->fops == &nvme_ns_head_ops;
1008}
1009static inline bool nvme_mpath_queue_if_no_path(struct nvme_ns_head *head)
1010{
1011	if (test_bit(NVME_NSHEAD_QUEUE_IF_NO_PATH, &head->flags))
1012		return true;
1013	return false;
1014}
1015#else
1016#define multipath false
1017static inline bool nvme_ctrl_use_ana(struct nvme_ctrl *ctrl)
1018{
1019	return false;
1020}
1021static inline void nvme_failover_req(struct request *req)
1022{
1023}
1024static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
1025{
1026}
1027static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
1028		struct nvme_ns_head *head)
1029{
1030	return 0;
1031}
1032static inline void nvme_mpath_add_disk(struct nvme_ns *ns, __le32 anagrpid)
1033{
1034}
1035static inline void nvme_mpath_put_disk(struct nvme_ns_head *head)
1036{
1037}
1038static inline void nvme_mpath_add_sysfs_link(struct nvme_ns *ns)
1039{
1040}
1041static inline void nvme_mpath_remove_sysfs_link(struct nvme_ns *ns)
1042{
1043}
1044static inline bool nvme_mpath_clear_current_path(struct nvme_ns *ns)
1045{
1046	return false;
1047}
1048static inline void nvme_mpath_revalidate_paths(struct nvme_ns *ns)
1049{
1050}
1051static inline void nvme_mpath_clear_ctrl_paths(struct nvme_ctrl *ctrl)
1052{
1053}
1054static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
1055{
1056}
1057static inline void nvme_trace_bio_complete(struct request *req)
1058{
1059}
1060static inline void nvme_mpath_init_ctrl(struct nvme_ctrl *ctrl)
1061{
1062}
1063static inline int nvme_mpath_init_identify(struct nvme_ctrl *ctrl,
1064		struct nvme_id_ctrl *id)
1065{
1066	if (ctrl->subsys->cmic & NVME_CTRL_CMIC_ANA)
1067		dev_warn(ctrl->device,
1068"Please enable CONFIG_NVME_MULTIPATH for full support of multi-port devices.\n");
1069	return 0;
1070}
1071static inline void nvme_mpath_update(struct nvme_ctrl *ctrl)
1072{
1073}
1074static inline void nvme_mpath_uninit(struct nvme_ctrl *ctrl)
1075{
1076}
1077static inline void nvme_mpath_stop(struct nvme_ctrl *ctrl)
1078{
1079}
1080static inline void nvme_mpath_unfreeze(struct nvme_subsystem *subsys)
1081{
1082}
1083static inline void nvme_mpath_wait_freeze(struct nvme_subsystem *subsys)
1084{
1085}
1086static inline void nvme_mpath_start_freeze(struct nvme_subsystem *subsys)
1087{
1088}
1089static inline void nvme_mpath_default_iopolicy(struct nvme_subsystem *subsys)
1090{
1091}
1092static inline void nvme_mpath_start_request(struct request *rq)
1093{
1094}
1095static inline void nvme_mpath_end_request(struct request *rq)
1096{
1097}
1098static inline bool nvme_disk_is_ns_head(struct gendisk *disk)
1099{
1100	return false;
1101}
1102static inline bool nvme_mpath_queue_if_no_path(struct nvme_ns_head *head)
1103{
1104	return false;
1105}
1106#endif /* CONFIG_NVME_MULTIPATH */
1107
1108int nvme_ns_get_unique_id(struct nvme_ns *ns, u8 id[16],
1109		enum blk_unique_id type);
1110
1111struct nvme_zone_info {
1112	u64 zone_size;
1113	unsigned int max_open_zones;
1114	unsigned int max_active_zones;
1115};
1116
1117int nvme_ns_report_zones(struct nvme_ns *ns, sector_t sector,
1118		unsigned int nr_zones, struct blk_report_zones_args *args);
1119int nvme_query_zone_info(struct nvme_ns *ns, unsigned lbaf,
1120		struct nvme_zone_info *zi);
1121void nvme_update_zone_info(struct nvme_ns *ns, struct queue_limits *lim,
1122		struct nvme_zone_info *zi);
1123#ifdef CONFIG_BLK_DEV_ZONED
1124blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns, struct request *req,
1125				       struct nvme_command *cmnd,
1126				       enum nvme_zone_mgmt_action action);
1127#else
1128static inline blk_status_t nvme_setup_zone_mgmt_send(struct nvme_ns *ns,
1129		struct request *req, struct nvme_command *cmnd,
1130		enum nvme_zone_mgmt_action action)
1131{
1132	return BLK_STS_NOTSUPP;
1133}
1134#endif
1135
1136static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
1137{
1138	struct gendisk *disk = dev_to_disk(dev);
1139
1140	WARN_ON(nvme_disk_is_ns_head(disk));
1141	return disk->private_data;
1142}
1143
1144#ifdef CONFIG_NVME_HWMON
1145int nvme_hwmon_init(struct nvme_ctrl *ctrl);
1146void nvme_hwmon_exit(struct nvme_ctrl *ctrl);
1147#else
1148static inline int nvme_hwmon_init(struct nvme_ctrl *ctrl)
1149{
1150	return 0;
1151}
1152
1153static inline void nvme_hwmon_exit(struct nvme_ctrl *ctrl)
1154{
1155}
1156#endif
1157
1158static inline void nvme_start_request(struct request *rq)
1159{
1160	if (rq->cmd_flags & REQ_NVME_MPATH)
1161		nvme_mpath_start_request(rq);
1162	blk_mq_start_request(rq);
1163}
1164
1165static inline bool nvme_ctrl_sgl_supported(struct nvme_ctrl *ctrl)
1166{
1167	return ctrl->sgls & (NVME_CTRL_SGLS_BYTE_ALIGNED |
1168			     NVME_CTRL_SGLS_DWORD_ALIGNED);
1169}
1170
1171static inline bool nvme_ctrl_meta_sgl_supported(struct nvme_ctrl *ctrl)
1172{
1173	if (ctrl->ops->flags & NVME_F_FABRICS)
1174		return true;
1175	return ctrl->sgls & NVME_CTRL_SGLS_MSDS;
1176}
1177
1178#ifdef CONFIG_NVME_HOST_AUTH
1179int __init nvme_init_auth(void);
1180void __exit nvme_exit_auth(void);
1181int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl);
1182void nvme_auth_stop(struct nvme_ctrl *ctrl);
1183int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid);
1184int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid);
1185void nvme_auth_free(struct nvme_ctrl *ctrl);
1186void nvme_auth_revoke_tls_key(struct nvme_ctrl *ctrl);
1187#else
1188static inline int nvme_auth_init_ctrl(struct nvme_ctrl *ctrl)
1189{
1190	return 0;
1191}
1192static inline int __init nvme_init_auth(void)
1193{
1194	return 0;
1195}
1196static inline void __exit nvme_exit_auth(void)
1197{
1198}
1199static inline void nvme_auth_stop(struct nvme_ctrl *ctrl) {};
1200static inline int nvme_auth_negotiate(struct nvme_ctrl *ctrl, int qid)
1201{
1202	return -EPROTONOSUPPORT;
1203}
1204static inline int nvme_auth_wait(struct nvme_ctrl *ctrl, int qid)
1205{
1206	return -EPROTONOSUPPORT;
1207}
1208static inline void nvme_auth_free(struct nvme_ctrl *ctrl) {};
1209static inline void nvme_auth_revoke_tls_key(struct nvme_ctrl *ctrl) {};
1210#endif
1211
1212u32 nvme_command_effects(struct nvme_ctrl *ctrl, struct nvme_ns *ns,
1213			 u8 opcode);
1214u32 nvme_passthru_start(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u8 opcode);
1215int nvme_execute_rq(struct request *rq, bool at_head);
1216void nvme_passthru_end(struct nvme_ctrl *ctrl, struct nvme_ns *ns, u32 effects,
1217		       struct nvme_command *cmd, int status);
1218struct nvme_ctrl *nvme_ctrl_from_file(struct file *file);
1219struct nvme_ns *nvme_find_get_ns(struct nvme_ctrl *ctrl, unsigned nsid);
1220bool nvme_get_ns(struct nvme_ns *ns);
1221void nvme_put_ns(struct nvme_ns *ns);
1222
1223static inline bool nvme_multi_css(struct nvme_ctrl *ctrl)
1224{
1225	return (ctrl->ctrl_config & NVME_CC_CSS_MASK) == NVME_CC_CSS_CSI;
1226}
1227
1228#endif /* _NVME_H */