[mirror_ubuntu-bionic-kernel.git] / drivers / nvme / host / nvme.h

/*
 * Copyright (c) 2011-2014, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#ifndef _NVME_H
#define _NVME_H

#include <linux/nvme.h>
#include <linux/cdev.h>
#include <linux/pci.h>
#include <linux/kref.h>
#include <linux/blk-mq.h>
#include <linux/lightnvm.h>
#include <linux/sed-opal.h>

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

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

#define NVME_DEFAULT_KATO	5
#define NVME_KATO_GRACE		10

extern struct workqueue_struct *nvme_wq;

enum {
	NVME_NS_LBA		= 0,
	NVME_NS_LIGHTNVM	= 1,
};

/*
 * List of workarounds for devices that required behavior not specified in
 * the standard.
 */
enum nvme_quirks {
	/*
	 * Prefers I/O aligned to a stripe size specified in a vendor
	 * specific Identify field.
	 */
	NVME_QUIRK_STRIPE_SIZE			= (1 << 0),

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

	/*
	 * The controller deterministically returns O's on reads to
	 * logical blocks that deallocate was called on.
	 */
	NVME_QUIRK_DEALLOCATE_ZEROES		= (1 << 2),

	/*
	 * 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),

	/*
	 * APST should not be used.
	 */
	NVME_QUIRK_NO_APST			= (1 << 4),

	/*
	 * The deepest sleep state should not be used.
	 */
	NVME_QUIRK_NO_DEEPEST_PS		= (1 << 5),

	/*
	 * Supports the LighNVM command set if indicated in vs[1].
	 */
	NVME_QUIRK_LIGHTNVM			= (1 << 6),
};

/*
 * 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;
	u8			retries;
	u8			flags;
	u16			status;
};

/*
 * Mark a bio as coming in through the mpath node.
 */
#define REQ_NVME_MPATH		REQ_DRV

enum {
	NVME_REQ_CANCELLED		= (1 << 0),
};

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

/* 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.
 */
#define NVME_QUIRK_DELAY_AMOUNT		2000

enum nvme_ctrl_state {
	NVME_CTRL_NEW,
	NVME_CTRL_LIVE,
	NVME_CTRL_RESETTING,
	NVME_CTRL_RECONNECTING,
	NVME_CTRL_DELETING,
	NVME_CTRL_DEAD,
};

struct nvme_ctrl {
	enum nvme_ctrl_state state;
	bool identified;
	spinlock_t lock;
	const struct nvme_ctrl_ops *ops;
	struct request_queue *admin_q;
	struct request_queue *connect_q;
	struct device *dev;
	int instance;
	struct blk_mq_tag_set *tagset;
	struct blk_mq_tag_set *admin_tagset;
	struct list_head namespaces;
	struct mutex namespaces_mutex;
	struct device ctrl_device;
	struct device *device;	/* char device */
	struct cdev cdev;
	struct work_struct reset_work;
	struct work_struct delete_work;

	struct nvme_subsystem *subsys;
	struct list_head subsys_entry;

	struct opal_dev *opal_dev;

	char name[12];
	u16 cntlid;

	u32 ctrl_config;
	u16 mtfa;
	u32 queue_count;

	u64 cap;
	u32 page_size;
	u32 max_hw_sectors;
	u16 oncs;
	u16 oacs;
	u16 nssa;
	u16 nr_streams;
	atomic_t abort_limit;
	u8 vwc;
	u32 vs;
	u32 sgls;
	u16 kas;
	u8 npss;
	u8 apsta;
	u32 aen_result;
	unsigned int shutdown_timeout;
	unsigned int kato;
	bool subsystem;
	unsigned long quirks;
	struct nvme_id_power_state psd[32];
	struct nvme_effects_log *effects;
	struct work_struct scan_work;
	struct work_struct async_event_work;
	struct delayed_work ka_work;
	struct work_struct fw_act_work;

	/* Power saving configuration */
	u64 ps_max_latency_us;
	bool apst_enabled;

	/* PCIe only: */
	u32 hmpre;
	u32 hmmin;
	u32 hmminds;
	u16 hmmaxd;

	/* Fabrics only */
	u16 sqsize;
	u32 ioccsz;
	u32 iorcsz;
	u16 icdoff;
	u16 maxcmd;
	int nr_reconnects;
	struct nvmf_ctrl_options *opts;
};

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;
	struct list_head	nsheads;
	char			subnqn[NVMF_NQN_SIZE];
	char			serial[20];
	char			model[40];
	char			firmware_rev[8];
	u8			cmic;
	u16			vendor_id;
	struct ida		ns_ida;
};

/*
 * Container structure for uniqueue namespace identifiers.
 */
struct nvme_ns_ids {
	u8	eui64[8];
	u8	nguid[16];
	uuid_t	uuid;
};

/*
 * 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 {
#ifdef CONFIG_NVME_MULTIPATH
	struct gendisk		*disk;
	struct nvme_ns __rcu	*current_path;
	struct bio_list		requeue_list;
	spinlock_t		requeue_lock;
	struct work_struct	requeue_work;
#endif
	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;
	int			instance;
};

struct nvme_ns {
	struct list_head list;

	struct nvme_ctrl *ctrl;
	struct request_queue *queue;
	struct gendisk *disk;
	struct list_head siblings;
	struct nvm_dev *ndev;
	struct kref kref;
	struct nvme_ns_head *head;

	int lba_shift;
	u16 ms;
	u16 sgs;
	u32 sws;
	bool ext;
	u8 pi_type;
	unsigned long flags;
#define NVME_NS_REMOVING 0
#define NVME_NS_DEAD     1
	u16 noiob;
};

struct nvme_ctrl_ops {
	const char *name;
	struct module *module;
	unsigned int flags;
#define NVME_F_FABRICS			(1 << 0)
#define NVME_F_METADATA_SUPPORTED	(1 << 1)
	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
	int (*reg_write32)(struct nvme_ctrl *ctrl, u32 off, u32 val);
	int (*reg_read64)(struct nvme_ctrl *ctrl, u32 off, u64 *val);
	void (*free_ctrl)(struct nvme_ctrl *ctrl);
	void (*submit_async_event)(struct nvme_ctrl *ctrl);
	void (*delete_ctrl)(struct nvme_ctrl *ctrl);
	int (*get_address)(struct nvme_ctrl *ctrl, char *buf, int size);
	int (*reinit_request)(void *data, struct request *rq);
};

static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
{
	u32 val = 0;

	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
		return false;
	return val & NVME_CSTS_RDY;
}

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);
}

static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
{
	return (sector >> (ns->lba_shift - 9));
}

static inline void nvme_cleanup_cmd(struct request *req)
{
	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
		kfree(page_address(req->special_vec.bv_page) +
		      req->special_vec.bv_offset);
	}
}

static inline void nvme_end_request(struct request *req, __le16 status,
		union nvme_result result)
{
	struct nvme_request *rq = nvme_req(req);

	rq->status = le16_to_cpu(status) >> 1;
	rq->result = result;
	blk_mq_complete_request(req);
}

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);
}

void nvme_complete_rq(struct request *req);
void nvme_cancel_request(struct request *req, void *data, bool reserved);
bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
		enum nvme_ctrl_state new_state);
int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
int nvme_init_ctrl(struct nvme_ctrl *ctrl, struct device *dev,
		const struct nvme_ctrl_ops *ops, unsigned long quirks);
void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
void nvme_start_ctrl(struct nvme_ctrl *ctrl);
void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
void nvme_put_ctrl(struct nvme_ctrl *ctrl);
int nvme_init_identify(struct nvme_ctrl *ctrl);

void nvme_queue_scan(struct nvme_ctrl *ctrl);
void nvme_remove_namespaces(struct nvme_ctrl *ctrl);

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

void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
		union nvme_result *res);

void nvme_stop_queues(struct nvme_ctrl *ctrl);
void nvme_start_queues(struct nvme_ctrl *ctrl);
void nvme_kill_queues(struct nvme_ctrl *ctrl);
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);
int nvme_reinit_tagset(struct nvme_ctrl *ctrl, struct blk_mq_tag_set *set);

#define NVME_QID_ANY -1
struct request *nvme_alloc_request(struct request_queue *q,
		struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
blk_status_t nvme_setup_cmd(struct nvme_ns *ns, struct request *req,
		struct nvme_command *cmd);
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,
		union nvme_result *result, void *buffer, unsigned bufflen,
		unsigned timeout, int qid, int at_head,
		blk_mq_req_flags_t flags);
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);
void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
int nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl);

extern const struct block_device_operations nvme_ns_head_ops;

#ifdef CONFIG_NVME_MULTIPATH
void nvme_failover_req(struct request *req);
bool nvme_req_needs_failover(struct request *req);
void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,struct nvme_ns_head *head);
void nvme_mpath_add_disk(struct nvme_ns_head *head);
void nvme_mpath_remove_disk(struct nvme_ns_head *head);

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

	if (head && ns == srcu_dereference(head->current_path, &head->srcu))
		rcu_assign_pointer(head->current_path, NULL);
}
struct nvme_ns *nvme_find_path(struct nvme_ns_head *head);
#else
static inline void nvme_failover_req(struct request *req)
{
}
static inline bool nvme_req_needs_failover(struct request *req)
{
	return false;
}
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;
}
static inline void nvme_mpath_add_disk(struct nvme_ns_head *head)
{
}
static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
{
}
static inline void nvme_mpath_clear_current_path(struct nvme_ns *ns)
{
}
#endif /* CONFIG_NVME_MULTIPATH */

#ifdef CONFIG_NVM
int nvme_nvm_register(struct nvme_ns *ns, char *disk_name, int node);
void nvme_nvm_unregister(struct nvme_ns *ns);
int nvme_nvm_register_sysfs(struct nvme_ns *ns);
void nvme_nvm_unregister_sysfs(struct nvme_ns *ns);
int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
#else
static inline int nvme_nvm_register(struct nvme_ns *ns, char *disk_name,
				    int node)
{
	return 0;
}

static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns)
{
	return 0;
}
static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {};
static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
							unsigned long arg)
{
	return -ENOTTY;
}
#endif /* CONFIG_NVM */

static inline struct nvme_ns *nvme_get_ns_from_dev(struct device *dev)
{
	return dev_to_disk(dev)->private_data;
}

int __init nvme_core_init(void);
void nvme_core_exit(void);

#endif /* _NVME_H */
Commit	Line	Data
f11bb3e2 CH	1	/*
	2	* Copyright (c) 2011-2014, Intel Corporation.
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms and conditions of the GNU General Public License,
	6	* version 2, as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*/
	13
	14	#ifndef _NVME_H
	15	#define _NVME_H
	16
	17	#include <linux/nvme.h>
a6a5149b	18	#include <linux/cdev.h>
f11bb3e2 CH	19	#include <linux/pci.h>
	20	#include <linux/kref.h>
	21	#include <linux/blk-mq.h>
b0b4e09c	22	#include <linux/lightnvm.h>
a98e58e5	23	#include <linux/sed-opal.h>
f11bb3e2	24
8ae4e447	25	extern unsigned int nvme_io_timeout;
f11bb3e2 CH	26	#define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
f11bb3e2 CH	27
8ae4e447	28	extern unsigned int admin_timeout;
21d34711 CH	29	#define ADMIN_TIMEOUT (admin_timeout * HZ)
21d34711 CH	30
038bd4cb SG	31	#define NVME_DEFAULT_KATO 5
	32	#define NVME_KATO_GRACE 10
	33
9a6327d2 SG	34	extern struct workqueue_struct *nvme_wq;
9a6327d2 SG	35
ca064085 MB	36	enum {
	37	NVME_NS_LBA = 0,
	38	NVME_NS_LIGHTNVM = 1,
	39	};
	40
f11bb3e2	41	/*
106198ed CH	42	* List of workarounds for devices that required behavior not specified in
106198ed CH	43	* the standard.
f11bb3e2	44	*/
106198ed CH	45	enum nvme_quirks {
	46	/*
	47	* Prefers I/O aligned to a stripe size specified in a vendor
	48	* specific Identify field.
	49	*/
	50	NVME_QUIRK_STRIPE_SIZE = (1 << 0),
540c801c KB	51
	52	/*
	53	* The controller doesn't handle Identify value others than 0 or 1
	54	* correctly.
	55	*/
	56	NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
08095e70 KB	57
08095e70 KB	58	/*
e850fd16 CH	59	* The controller deterministically returns O's on reads to
e850fd16 CH	60	* logical blocks that deallocate was called on.
08095e70	61	*/
e850fd16	62	NVME_QUIRK_DEALLOCATE_ZEROES = (1 << 2),
54adc010 GP	63
	64	/*
	65	* The controller needs a delay before starts checking the device
	66	* readiness, which is done by reading the NVME_CSTS_RDY bit.
	67	*/
	68	NVME_QUIRK_DELAY_BEFORE_CHK_RDY = (1 << 3),
c5552fde AL	69
	70	/*
	71	* APST should not be used.
	72	*/
	73	NVME_QUIRK_NO_APST = (1 << 4),
ff5350a8 AL	74
	75	/*
	76	* The deepest sleep state should not be used.
	77	*/
	78	NVME_QUIRK_NO_DEEPEST_PS = (1 << 5),
608cc4b1 CH	79
	80	/*
	81	* Supports the LighNVM command set if indicated in vs[1].
	82	*/
	83	NVME_QUIRK_LIGHTNVM = (1 << 6),
106198ed CH	84	};
106198ed CH	85
d49187e9 CH	86	/*
	87	* Common request structure for NVMe passthrough. All drivers must have
	88	* this structure as the first member of their request-private data.
	89	*/
	90	struct nvme_request {
	91	struct nvme_command *cmd;
	92	union nvme_result result;
44e44b29	93	u8 retries;
27fa9bc5 CH	94	u8 flags;
	95	u16 status;
	96	};
	97
32acab31 CH	98	/*
	99	* Mark a bio as coming in through the mpath node.
	100	*/
	101	#define REQ_NVME_MPATH REQ_DRV
	102
27fa9bc5 CH	103	enum {
27fa9bc5 CH	104	NVME_REQ_CANCELLED = (1 << 0),
d49187e9 CH	105	};
	106
	107	static inline struct nvme_request nvme_req(struct request req)
	108	{
	109	return blk_mq_rq_to_pdu(req);
	110	}
	111
54adc010 GP	112	/* The below value is the specific amount of delay needed before checking
	113	* readiness in case of the PCI_DEVICE(0x1c58, 0x0003), which needs the
	114	* NVME_QUIRK_DELAY_BEFORE_CHK_RDY quirk enabled. The value (in ms) was
	115	* found empirically.
	116	*/
	117	#define NVME_QUIRK_DELAY_AMOUNT 2000
	118
bb8d261e CH	119	enum nvme_ctrl_state {
	120	NVME_CTRL_NEW,
	121	NVME_CTRL_LIVE,
	122	NVME_CTRL_RESETTING,
def61eca	123	NVME_CTRL_RECONNECTING,
bb8d261e	124	NVME_CTRL_DELETING,
0ff9d4e1	125	NVME_CTRL_DEAD,
bb8d261e CH	126	};
bb8d261e CH	127
1c63dc66	128	struct nvme_ctrl {
bb8d261e	129	enum nvme_ctrl_state state;
bd4da3ab	130	bool identified;
bb8d261e	131	spinlock_t lock;
1c63dc66	132	const struct nvme_ctrl_ops *ops;
f11bb3e2	133	struct request_queue *admin_q;
07bfcd09	134	struct request_queue *connect_q;
f11bb3e2	135	struct device *dev;
f11bb3e2	136	int instance;
5bae7f73	137	struct blk_mq_tag_set *tagset;
34b6c231	138	struct blk_mq_tag_set *admin_tagset;
f11bb3e2	139	struct list_head namespaces;
69d3b8ac	140	struct mutex namespaces_mutex;
d22524a4	141	struct device ctrl_device;
5bae7f73	142	struct device device; / char device */
a6a5149b	143	struct cdev cdev;
d86c4d8e	144	struct work_struct reset_work;
c5017e85	145	struct work_struct delete_work;
1c63dc66	146
ab9e00cc CH	147	struct nvme_subsystem *subsys;
	148	struct list_head subsys_entry;
	149
4f1244c8	150	struct opal_dev *opal_dev;
a98e58e5	151
f11bb3e2	152	char name[12];
76e3914a	153	u16 cntlid;
5fd4ce1b CH	154
5fd4ce1b CH	155	u32 ctrl_config;
b6dccf7f	156	u16 mtfa;
d858e5f0	157	u32 queue_count;
5fd4ce1b	158
20d0dfe6	159	u64 cap;
5fd4ce1b	160	u32 page_size;
f11bb3e2	161	u32 max_hw_sectors;
f11bb3e2	162	u16 oncs;
8a9ae523	163	u16 oacs;
f5d11840 JA	164	u16 nssa;
f5d11840 JA	165	u16 nr_streams;
6bf25d16	166	atomic_t abort_limit;
f11bb3e2	167	u8 vwc;
f3ca80fc	168	u32 vs;
07bfcd09	169	u32 sgls;
038bd4cb	170	u16 kas;
c5552fde AL	171	u8 npss;
c5552fde AL	172	u8 apsta;
e3d7874d	173	u32 aen_result;
07fbd32a	174	unsigned int shutdown_timeout;
038bd4cb	175	unsigned int kato;
f3ca80fc	176	bool subsystem;
106198ed	177	unsigned long quirks;
c5552fde	178	struct nvme_id_power_state psd[32];
84fef62d	179	struct nvme_effects_log *effects;
5955be21	180	struct work_struct scan_work;
f866fc42	181	struct work_struct async_event_work;
038bd4cb	182	struct delayed_work ka_work;
b6dccf7f	183	struct work_struct fw_act_work;
07bfcd09	184
c5552fde AL	185	/* Power saving configuration */
c5552fde AL	186	u64 ps_max_latency_us;
76a5af84	187	bool apst_enabled;
c5552fde	188
044a9df1	189	/* PCIe only: */
fe6d53c9 CH	190	u32 hmpre;
fe6d53c9 CH	191	u32 hmmin;
044a9df1 CH	192	u32 hmminds;
044a9df1 CH	193	u16 hmmaxd;
fe6d53c9	194
07bfcd09 CH	195	/* Fabrics only */
	196	u16 sqsize;
	197	u32 ioccsz;
	198	u32 iorcsz;
	199	u16 icdoff;
	200	u16 maxcmd;
fdf9dfa8	201	int nr_reconnects;
07bfcd09	202	struct nvmf_ctrl_options *opts;
f11bb3e2 CH	203	};
f11bb3e2 CH	204
ab9e00cc CH	205	struct nvme_subsystem {
	206	int instance;
	207	struct device dev;
	208	/*
	209	* Because we unregister the device on the last put we need
	210	* a separate refcount.
	211	*/
	212	struct kref ref;
	213	struct list_head entry;
	214	struct mutex lock;
	215	struct list_head ctrls;
ed754e5d	216	struct list_head nsheads;
ab9e00cc CH	217	char subnqn[NVMF_NQN_SIZE];
	218	char serial[20];
	219	char model[40];
	220	char firmware_rev[8];
	221	u8 cmic;
	222	u16 vendor_id;
ed754e5d	223	struct ida ns_ida;
ab9e00cc CH	224	};
ab9e00cc CH	225
002fab04 CH	226	/*
	227	* Container structure for uniqueue namespace identifiers.
	228	*/
	229	struct nvme_ns_ids {
	230	u8 eui64[8];
	231	u8 nguid[16];
	232	uuid_t uuid;
	233	};
	234
ed754e5d CH	235	/*
	236	* Anchor structure for namespaces. There is one for each namespace in a
	237	* NVMe subsystem that any of our controllers can see, and the namespace
	238	* structure for each controller is chained of it. For private namespaces
	239	* there is a 1:1 relation to our namespace structures, that is ->list
	240	* only ever has a single entry for private namespaces.
	241	*/
	242	struct nvme_ns_head {
32acab31 CH	243	#ifdef CONFIG_NVME_MULTIPATH
	244	struct gendisk *disk;
	245	struct nvme_ns __rcu *current_path;
	246	struct bio_list requeue_list;
	247	spinlock_t requeue_lock;
	248	struct work_struct requeue_work;
	249	#endif
ed754e5d CH	250	struct list_head list;
	251	struct srcu_struct srcu;
	252	struct nvme_subsystem *subsys;
	253	unsigned ns_id;
	254	struct nvme_ns_ids ids;
	255	struct list_head entry;
	256	struct kref ref;
	257	int instance;
	258	};
	259
f11bb3e2 CH	260	struct nvme_ns {
	261	struct list_head list;
	262
1c63dc66	263	struct nvme_ctrl *ctrl;
f11bb3e2 CH	264	struct request_queue *queue;
f11bb3e2 CH	265	struct gendisk *disk;
ed754e5d	266	struct list_head siblings;
b0b4e09c	267	struct nvm_dev *ndev;
f11bb3e2	268	struct kref kref;
ed754e5d	269	struct nvme_ns_head *head;
f11bb3e2	270
f11bb3e2 CH	271	int lba_shift;
f11bb3e2 CH	272	u16 ms;
f5d11840 JA	273	u16 sgs;
f5d11840 JA	274	u32 sws;
f11bb3e2 CH	275	bool ext;
f11bb3e2 CH	276	u8 pi_type;
646017a6	277	unsigned long flags;
646017a6	278	#define NVME_NS_REMOVING 0
69d9a99c	279	#define NVME_NS_DEAD 1
57eeaf8e	280	u16 noiob;
f11bb3e2 CH	281	};
f11bb3e2 CH	282
1c63dc66	283	struct nvme_ctrl_ops {
1a353d85	284	const char *name;
e439bb12	285	struct module *module;
d3d5b87d CH	286	unsigned int flags;
d3d5b87d CH	287	#define NVME_F_FABRICS (1 << 0)
c81bfba9	288	#define NVME_F_METADATA_SUPPORTED (1 << 1)
1c63dc66	289	int (reg_read32)(struct nvme_ctrl ctrl, u32 off, u32 *val);
5fd4ce1b	290	int (reg_write32)(struct nvme_ctrl ctrl, u32 off, u32 val);
7fd8930f	291	int (reg_read64)(struct nvme_ctrl ctrl, u32 off, u64 *val);
1673f1f0	292	void (free_ctrl)(struct nvme_ctrl ctrl);
ad22c355	293	void (submit_async_event)(struct nvme_ctrl ctrl);
c5017e85	294	void (delete_ctrl)(struct nvme_ctrl ctrl);
1a353d85	295	int (get_address)(struct nvme_ctrl ctrl, char *buf, int size);
31b84460	296	int (reinit_request)(void data, struct request *rq);
f11bb3e2 CH	297	};
f11bb3e2 CH	298
1c63dc66 CH	299	static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
	300	{
	301	u32 val = 0;
	302
	303	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
	304	return false;
	305	return val & NVME_CSTS_RDY;
	306	}
	307
f3ca80fc CH	308	static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
	309	{
	310	if (!ctrl->subsystem)
	311	return -ENOTTY;
	312	return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
	313	}
	314
f11bb3e2 CH	315	static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
	316	{
	317	return (sector >> (ns->lba_shift - 9));
	318	}
	319
6904242d ML	320	static inline void nvme_cleanup_cmd(struct request *req)
6904242d ML	321	{
f9d03f96 CH	322	if (req->rq_flags & RQF_SPECIAL_PAYLOAD) {
	323	kfree(page_address(req->special_vec.bv_page) +
	324	req->special_vec.bv_offset);
	325	}
6904242d ML	326	}
6904242d ML	327
27fa9bc5 CH	328	static inline void nvme_end_request(struct request *req, __le16 status,
27fa9bc5 CH	329	union nvme_result result)
15a190f7	330	{
27fa9bc5	331	struct nvme_request *rq = nvme_req(req);
15a190f7	332
27fa9bc5 CH	333	rq->status = le16_to_cpu(status) >> 1;
27fa9bc5 CH	334	rq->result = result;
08e0029a	335	blk_mq_complete_request(req);
7688faa6 CH	336	}
7688faa6 CH	337
d22524a4 CH	338	static inline void nvme_get_ctrl(struct nvme_ctrl *ctrl)
	339	{
	340	get_device(ctrl->device);
	341	}
	342
	343	static inline void nvme_put_ctrl(struct nvme_ctrl *ctrl)
	344	{
	345	put_device(ctrl->device);
	346	}
	347
77f02a7a	348	void nvme_complete_rq(struct request *req);
c55a2fd4	349	void nvme_cancel_request(struct request req, void data, bool reserved);
bb8d261e CH	350	bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
bb8d261e CH	351	enum nvme_ctrl_state new_state);
5fd4ce1b CH	352	int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
	353	int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
	354	int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
f3ca80fc CH	355	int nvme_init_ctrl(struct nvme_ctrl ctrl, struct device dev,
f3ca80fc CH	356	const struct nvme_ctrl_ops *ops, unsigned long quirks);
53029b04	357	void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
d09f2b45 SG	358	void nvme_start_ctrl(struct nvme_ctrl *ctrl);
d09f2b45 SG	359	void nvme_stop_ctrl(struct nvme_ctrl *ctrl);
1673f1f0	360	void nvme_put_ctrl(struct nvme_ctrl *ctrl);
7fd8930f	361	int nvme_init_identify(struct nvme_ctrl *ctrl);
5bae7f73	362
5955be21	363	void nvme_queue_scan(struct nvme_ctrl *ctrl);
5bae7f73	364	void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
1673f1f0	365
4f1244c8 CH	366	int nvme_sec_submit(void data, u16 spsp, u8 secp, void buffer, size_t len,
4f1244c8 CH	367	bool send);
a98e58e5	368
7bf58533 CH	369	void nvme_complete_async_event(struct nvme_ctrl *ctrl, __le16 status,
7bf58533 CH	370	union nvme_result *res);
f866fc42	371
25646264 KB	372	void nvme_stop_queues(struct nvme_ctrl *ctrl);
25646264 KB	373	void nvme_start_queues(struct nvme_ctrl *ctrl);
69d9a99c	374	void nvme_kill_queues(struct nvme_ctrl *ctrl);
302ad8cc KB	375	void nvme_unfreeze(struct nvme_ctrl *ctrl);
	376	void nvme_wait_freeze(struct nvme_ctrl *ctrl);
	377	void nvme_wait_freeze_timeout(struct nvme_ctrl *ctrl, long timeout);
	378	void nvme_start_freeze(struct nvme_ctrl *ctrl);
31b84460	379	int nvme_reinit_tagset(struct nvme_ctrl ctrl, struct blk_mq_tag_set set);
363c9aac	380
eb71f435	381	#define NVME_QID_ANY -1
4160982e	382	struct request nvme_alloc_request(struct request_queue q,
9a95e4ef	383	struct nvme_command *cmd, blk_mq_req_flags_t flags, int qid);
fc17b653	384	blk_status_t nvme_setup_cmd(struct nvme_ns ns, struct request req,
8093f7ca	385	struct nvme_command *cmd);
f11bb3e2 CH	386	int nvme_submit_sync_cmd(struct request_queue q, struct nvme_command cmd,
	387	void *buf, unsigned bufflen);
	388	int __nvme_submit_sync_cmd(struct request_queue q, struct nvme_command cmd,
d49187e9	389	union nvme_result result, void buffer, unsigned bufflen,
9a95e4ef BVA	390	unsigned timeout, int qid, int at_head,
9a95e4ef BVA	391	blk_mq_req_flags_t flags);
9a0be7ab	392	int nvme_set_queue_count(struct nvme_ctrl ctrl, int count);
038bd4cb SG	393	void nvme_start_keep_alive(struct nvme_ctrl *ctrl);
038bd4cb SG	394	void nvme_stop_keep_alive(struct nvme_ctrl *ctrl);
d86c4d8e	395	int nvme_reset_ctrl(struct nvme_ctrl *ctrl);
c5017e85 CH	396	int nvme_delete_ctrl(struct nvme_ctrl *ctrl);
c5017e85 CH	397	int nvme_delete_ctrl_sync(struct nvme_ctrl *ctrl);
f11bb3e2	398
32acab31 CH	399	extern const struct block_device_operations nvme_ns_head_ops;
	400
	401	#ifdef CONFIG_NVME_MULTIPATH
	402	void nvme_failover_req(struct request *req);
	403	bool nvme_req_needs_failover(struct request *req);
	404	void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl);
	405	int nvme_mpath_alloc_disk(struct nvme_ctrl ctrl,struct nvme_ns_head head);
	406	void nvme_mpath_add_disk(struct nvme_ns_head *head);
	407	void nvme_mpath_remove_disk(struct nvme_ns_head *head);
	408
	409	static inline void nvme_mpath_clear_current_path(struct nvme_ns *ns)
	410	{
	411	struct nvme_ns_head *head = ns->head;
	412
	413	if (head && ns == srcu_dereference(head->current_path, &head->srcu))
	414	rcu_assign_pointer(head->current_path, NULL);
	415	}
	416	struct nvme_ns nvme_find_path(struct nvme_ns_head head);
	417	#else
	418	static inline void nvme_failover_req(struct request *req)
	419	{
	420	}
	421	static inline bool nvme_req_needs_failover(struct request *req)
	422	{
	423	return false;
	424	}
	425	static inline void nvme_kick_requeue_lists(struct nvme_ctrl *ctrl)
	426	{
	427	}
	428	static inline int nvme_mpath_alloc_disk(struct nvme_ctrl *ctrl,
	429	struct nvme_ns_head *head)
	430	{
	431	return 0;
	432	}
	433	static inline void nvme_mpath_add_disk(struct nvme_ns_head *head)
	434	{
	435	}
	436	static inline void nvme_mpath_remove_disk(struct nvme_ns_head *head)
	437	{
	438	}
	439	static inline void nvme_mpath_clear_current_path(struct nvme_ns *ns)
	440	{
	441	}
	442	#endif /* CONFIG_NVME_MULTIPATH */
	443
c4699e70	444	#ifdef CONFIG_NVM
3dc87dd0	445	int nvme_nvm_register(struct nvme_ns ns, char disk_name, int node);
b0b4e09c	446	void nvme_nvm_unregister(struct nvme_ns *ns);
3dc87dd0 MB	447	int nvme_nvm_register_sysfs(struct nvme_ns *ns);
3dc87dd0 MB	448	void nvme_nvm_unregister_sysfs(struct nvme_ns *ns);
84d4add7	449	int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd, unsigned long arg);
c4699e70	450	#else
b0b4e09c	451	static inline int nvme_nvm_register(struct nvme_ns ns, char disk_name,
3dc87dd0	452	int node)
c4699e70 KB	453	{
	454	return 0;
	455	}
	456
b0b4e09c	457	static inline void nvme_nvm_unregister(struct nvme_ns *ns) {};
3dc87dd0 MB	458	static inline int nvme_nvm_register_sysfs(struct nvme_ns *ns)
	459	{
	460	return 0;
	461	}
	462	static inline void nvme_nvm_unregister_sysfs(struct nvme_ns *ns) {};
84d4add7 MB	463	static inline int nvme_nvm_ioctl(struct nvme_ns *ns, unsigned int cmd,
	464	unsigned long arg)
	465	{
	466	return -ENOTTY;
	467	}
3dc87dd0 MB	468	#endif /* CONFIG_NVM */
3dc87dd0 MB	469
40267efd SL	470	static inline struct nvme_ns nvme_get_ns_from_dev(struct device dev)
	471	{
	472	return dev_to_disk(dev)->private_data;
	473	}
ca064085	474
5bae7f73 CH	475	int __init nvme_core_init(void);
	476	void nvme_core_exit(void);
	477
f11bb3e2	478	#endif /* _NVME_H */