[mirror_ubuntu-jammy-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/pci.h>
#include <linux/kref.h>
#include <linux/blk-mq.h>

enum {
	/*
	 * Driver internal status code for commands that were cancelled due
	 * to timeouts or controller shutdown.  The value is negative so
	 * that it a) doesn't overlap with the unsigned hardware error codes,
	 * and b) can easily be tested for.
	 */
	NVME_SC_CANCELLED		= -EINTR,
};

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

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

extern unsigned char shutdown_timeout;
#define SHUTDOWN_TIMEOUT	(shutdown_timeout * HZ)

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 discarded
	 * logical blocks.
	 */
	NVME_QUIRK_DISCARD_ZEROES		= (1 << 2),
};

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

struct nvme_ctrl {
	enum nvme_ctrl_state state;
	spinlock_t lock;
	const struct nvme_ctrl_ops *ops;
	struct request_queue *admin_q;
	struct device *dev;
	struct kref kref;
	int instance;
	struct blk_mq_tag_set *tagset;
	struct list_head namespaces;
	struct mutex namespaces_mutex;
	struct device *device;	/* char device */
	struct list_head node;
	struct ida ns_ida;

	char name[12];
	char serial[20];
	char model[40];
	char firmware_rev[8];
	u16 cntlid;

	u32 ctrl_config;

	u32 page_size;
	u32 max_hw_sectors;
	u32 stripe_size;
	u16 oncs;
	u16 vid;
	atomic_t abort_limit;
	u8 event_limit;
	u8 vwc;
	u32 vs;
	bool subsystem;
	unsigned long quirks;
	struct work_struct scan_work;
	struct work_struct async_event_work;
};

/*
 * An NVM Express namespace is equivalent to a SCSI LUN
 */
struct nvme_ns {
	struct list_head list;

	struct nvme_ctrl *ctrl;
	struct request_queue *queue;
	struct gendisk *disk;
	struct kref kref;
	int instance;

	u8 eui[8];
	u8 uuid[16];

	unsigned ns_id;
	int lba_shift;
	u16 ms;
	bool ext;
	u8 pi_type;
	int type;
	unsigned long flags;

#define NVME_NS_REMOVING 0
#define NVME_NS_DEAD     1

	u64 mode_select_num_blocks;
	u32 mode_select_block_len;
};

struct nvme_ctrl_ops {
	struct module *module;
	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);
	int (*reset_ctrl)(struct nvme_ctrl *ctrl);
	void (*free_ctrl)(struct nvme_ctrl *ctrl);
	void (*post_scan)(struct nvme_ctrl *ctrl);
	void (*submit_async_event)(struct nvme_ctrl *ctrl, int aer_idx);
};

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 unsigned nvme_map_len(struct request *rq)
{
	if (rq->cmd_flags & REQ_DISCARD)
		return sizeof(struct nvme_dsm_range);
	else
		return blk_rq_bytes(rq);
}

static inline void nvme_cleanup_cmd(struct request *req)
{
	if (req->cmd_flags & REQ_DISCARD)
		kfree(req->completion_data);
}

static inline int nvme_error_status(u16 status)
{
	switch (status & 0x7ff) {
	case NVME_SC_SUCCESS:
		return 0;
	case NVME_SC_CAP_EXCEEDED:
		return -ENOSPC;
	default:
		return -EIO;
	}
}

static inline bool nvme_req_needs_retry(struct request *req, u16 status)
{
	return !(status & NVME_SC_DNR || blk_noretry_request(req)) &&
		(jiffies - req->start_time) < req->timeout;
}

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

#define NVME_NR_AERS	1
void nvme_complete_async_event(struct nvme_ctrl *ctrl,
		struct nvme_completion *cqe);
void nvme_queue_async_events(struct nvme_ctrl *ctrl);

void nvme_stop_queues(struct nvme_ctrl *ctrl);
void nvme_start_queues(struct nvme_ctrl *ctrl);
void nvme_kill_queues(struct nvme_ctrl *ctrl);

struct request *nvme_alloc_request(struct request_queue *q,
		struct nvme_command *cmd, unsigned int flags);
void nvme_requeue_req(struct request *req);
int 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,
		struct nvme_completion *cqe, void *buffer, unsigned bufflen,
		unsigned timeout);
int nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
		void __user *ubuffer, unsigned bufflen, u32 *result,
		unsigned timeout);
int __nvme_submit_user_cmd(struct request_queue *q, struct nvme_command *cmd,
		void __user *ubuffer, unsigned bufflen,
		void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
		u32 *result, unsigned timeout);
int nvme_identify_ctrl(struct nvme_ctrl *dev, struct nvme_id_ctrl **id);
int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
		struct nvme_id_ns **id);
int nvme_get_log_page(struct nvme_ctrl *dev, struct nvme_smart_log **log);
int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
			dma_addr_t dma_addr, u32 *result);
int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
			dma_addr_t dma_addr, u32 *result);
int nvme_set_queue_count(struct nvme_ctrl *ctrl, int *count);

struct sg_io_hdr;

int nvme_sg_io(struct nvme_ns *ns, struct sg_io_hdr __user *u_hdr);
int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
int nvme_sg_get_version_num(int __user *ip);

#ifdef CONFIG_NVM
int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id);
int nvme_nvm_register(struct request_queue *q, char *disk_name);
void nvme_nvm_unregister(struct request_queue *q, char *disk_name);
#else
static inline int nvme_nvm_register(struct request_queue *q, char *disk_name)
{
	return 0;
}

static inline void nvme_nvm_unregister(struct request_queue *q, char *disk_name) {};

static inline int nvme_nvm_ns_supported(struct nvme_ns *ns, struct nvme_id_ns *id)
{
	return 0;
}
#endif /* CONFIG_NVM */

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>
	18	#include <linux/pci.h>
	19	#include <linux/kref.h>
	20	#include <linux/blk-mq.h>
	21
297465c8 CH	22	enum {
	23	/*
	24	* Driver internal status code for commands that were cancelled due
	25	* to timeouts or controller shutdown. The value is negative so
	26	* that it a) doesn't overlap with the unsigned hardware error codes,
	27	* and b) can easily be tested for.
	28	*/
	29	NVME_SC_CANCELLED = -EINTR,
	30	};
	31
f11bb3e2 CH	32	extern unsigned char nvme_io_timeout;
	33	#define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
	34
21d34711 CH	35	extern unsigned char admin_timeout;
	36	#define ADMIN_TIMEOUT (admin_timeout * HZ)
	37
5fd4ce1b CH	38	extern unsigned char shutdown_timeout;
	39	#define SHUTDOWN_TIMEOUT (shutdown_timeout * HZ)
	40
ca064085 MB	41	enum {
	42	NVME_NS_LBA = 0,
	43	NVME_NS_LIGHTNVM = 1,
	44	};
	45
f11bb3e2	46	/*
106198ed CH	47	* List of workarounds for devices that required behavior not specified in
106198ed CH	48	* the standard.
f11bb3e2	49	*/
106198ed CH	50	enum nvme_quirks {
	51	/*
	52	* Prefers I/O aligned to a stripe size specified in a vendor
	53	* specific Identify field.
	54	*/
	55	NVME_QUIRK_STRIPE_SIZE = (1 << 0),
540c801c KB	56
	57	/*
	58	* The controller doesn't handle Identify value others than 0 or 1
	59	* correctly.
	60	*/
	61	NVME_QUIRK_IDENTIFY_CNS = (1 << 1),
08095e70 KB	62
	63	/*
	64	* The controller deterministically returns O's on reads to discarded
	65	* logical blocks.
	66	*/
	67	NVME_QUIRK_DISCARD_ZEROES = (1 << 2),
106198ed CH	68	};
106198ed CH	69
bb8d261e CH	70	enum nvme_ctrl_state {
	71	NVME_CTRL_NEW,
	72	NVME_CTRL_LIVE,
	73	NVME_CTRL_RESETTING,
	74	NVME_CTRL_DELETING,
	75	};
	76
1c63dc66	77	struct nvme_ctrl {
bb8d261e CH	78	enum nvme_ctrl_state state;
bb8d261e CH	79	spinlock_t lock;
1c63dc66	80	const struct nvme_ctrl_ops *ops;
f11bb3e2	81	struct request_queue *admin_q;
f11bb3e2	82	struct device *dev;
1673f1f0	83	struct kref kref;
f11bb3e2	84	int instance;
5bae7f73	85	struct blk_mq_tag_set *tagset;
f11bb3e2	86	struct list_head namespaces;
69d3b8ac	87	struct mutex namespaces_mutex;
5bae7f73	88	struct device device; / char device */
f3ca80fc	89	struct list_head node;
075790eb	90	struct ida ns_ida;
1c63dc66	91
f11bb3e2 CH	92	char name[12];
	93	char serial[20];
	94	char model[40];
	95	char firmware_rev[8];
76e3914a	96	u16 cntlid;
5fd4ce1b CH	97
	98	u32 ctrl_config;
	99
	100	u32 page_size;
f11bb3e2 CH	101	u32 max_hw_sectors;
f11bb3e2 CH	102	u32 stripe_size;
f11bb3e2	103	u16 oncs;
118472ab	104	u16 vid;
6bf25d16	105	atomic_t abort_limit;
f11bb3e2 CH	106	u8 event_limit;
f11bb3e2 CH	107	u8 vwc;
f3ca80fc CH	108	u32 vs;
f3ca80fc CH	109	bool subsystem;
106198ed	110	unsigned long quirks;
5955be21	111	struct work_struct scan_work;
f866fc42	112	struct work_struct async_event_work;
f11bb3e2 CH	113	};
	114
	115	/*
	116	* An NVM Express namespace is equivalent to a SCSI LUN
	117	*/
	118	struct nvme_ns {
	119	struct list_head list;
	120
1c63dc66	121	struct nvme_ctrl *ctrl;
f11bb3e2 CH	122	struct request_queue *queue;
	123	struct gendisk *disk;
	124	struct kref kref;
075790eb	125	int instance;
f11bb3e2	126
2b9b6e86 KB	127	u8 eui[8];
	128	u8 uuid[16];
	129
f11bb3e2 CH	130	unsigned ns_id;
	131	int lba_shift;
	132	u16 ms;
	133	bool ext;
	134	u8 pi_type;
ca064085	135	int type;
646017a6 KB	136	unsigned long flags;
	137
	138	#define NVME_NS_REMOVING 0
69d9a99c	139	#define NVME_NS_DEAD 1
646017a6	140
f11bb3e2 CH	141	u64 mode_select_num_blocks;
	142	u32 mode_select_block_len;
	143	};
	144
1c63dc66	145	struct nvme_ctrl_ops {
e439bb12	146	struct module *module;
1c63dc66	147	int (reg_read32)(struct nvme_ctrl ctrl, u32 off, u32 *val);
5fd4ce1b	148	int (reg_write32)(struct nvme_ctrl ctrl, u32 off, u32 val);
7fd8930f	149	int (reg_read64)(struct nvme_ctrl ctrl, u32 off, u64 *val);
f3ca80fc	150	int (reset_ctrl)(struct nvme_ctrl ctrl);
1673f1f0	151	void (free_ctrl)(struct nvme_ctrl ctrl);
5955be21	152	void (post_scan)(struct nvme_ctrl ctrl);
f866fc42	153	void (submit_async_event)(struct nvme_ctrl ctrl, int aer_idx);
f11bb3e2 CH	154	};
f11bb3e2 CH	155
1c63dc66 CH	156	static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
	157	{
	158	u32 val = 0;
	159
	160	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
	161	return false;
	162	return val & NVME_CSTS_RDY;
	163	}
	164
f3ca80fc CH	165	static inline int nvme_reset_subsystem(struct nvme_ctrl *ctrl)
	166	{
	167	if (!ctrl->subsystem)
	168	return -ENOTTY;
	169	return ctrl->ops->reg_write32(ctrl, NVME_REG_NSSR, 0x4E564D65);
	170	}
	171
f11bb3e2 CH	172	static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
	173	{
	174	return (sector >> (ns->lba_shift - 9));
	175	}
	176
58b45602 ML	177	static inline unsigned nvme_map_len(struct request *rq)
	178	{
	179	if (rq->cmd_flags & REQ_DISCARD)
	180	return sizeof(struct nvme_dsm_range);
	181	else
	182	return blk_rq_bytes(rq);
	183	}
	184
6904242d ML	185	static inline void nvme_cleanup_cmd(struct request *req)
	186	{
	187	if (req->cmd_flags & REQ_DISCARD)
	188	kfree(req->completion_data);
	189	}
	190
15a190f7 CH	191	static inline int nvme_error_status(u16 status)
	192	{
	193	switch (status & 0x7ff) {
	194	case NVME_SC_SUCCESS:
	195	return 0;
	196	case NVME_SC_CAP_EXCEEDED:
	197	return -ENOSPC;
	198	default:
	199	return -EIO;
	200	}
	201	}
	202
7688faa6 CH	203	static inline bool nvme_req_needs_retry(struct request *req, u16 status)
	204	{
	205	return !(status & NVME_SC_DNR \|\| blk_noretry_request(req)) &&
	206	(jiffies - req->start_time) < req->timeout;
	207	}
	208
bb8d261e CH	209	bool nvme_change_ctrl_state(struct nvme_ctrl *ctrl,
bb8d261e CH	210	enum nvme_ctrl_state new_state);
5fd4ce1b CH	211	int nvme_disable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
	212	int nvme_enable_ctrl(struct nvme_ctrl *ctrl, u64 cap);
	213	int nvme_shutdown_ctrl(struct nvme_ctrl *ctrl);
f3ca80fc CH	214	int nvme_init_ctrl(struct nvme_ctrl ctrl, struct device dev,
f3ca80fc CH	215	const struct nvme_ctrl_ops *ops, unsigned long quirks);
53029b04	216	void nvme_uninit_ctrl(struct nvme_ctrl *ctrl);
1673f1f0	217	void nvme_put_ctrl(struct nvme_ctrl *ctrl);
7fd8930f	218	int nvme_init_identify(struct nvme_ctrl *ctrl);
5bae7f73	219
5955be21	220	void nvme_queue_scan(struct nvme_ctrl *ctrl);
5bae7f73	221	void nvme_remove_namespaces(struct nvme_ctrl *ctrl);
1673f1f0	222
f866fc42 CH	223	#define NVME_NR_AERS 1
	224	void nvme_complete_async_event(struct nvme_ctrl *ctrl,
	225	struct nvme_completion *cqe);
	226	void nvme_queue_async_events(struct nvme_ctrl *ctrl);
	227
25646264 KB	228	void nvme_stop_queues(struct nvme_ctrl *ctrl);
25646264 KB	229	void nvme_start_queues(struct nvme_ctrl *ctrl);
69d9a99c	230	void nvme_kill_queues(struct nvme_ctrl *ctrl);
363c9aac	231
4160982e CH	232	struct request nvme_alloc_request(struct request_queue q,
4160982e CH	233	struct nvme_command *cmd, unsigned int flags);
7688faa6	234	void nvme_requeue_req(struct request *req);
8093f7ca ML	235	int nvme_setup_cmd(struct nvme_ns ns, struct request req,
8093f7ca ML	236	struct nvme_command *cmd);
f11bb3e2 CH	237	int nvme_submit_sync_cmd(struct request_queue q, struct nvme_command cmd,
	238	void *buf, unsigned bufflen);
	239	int __nvme_submit_sync_cmd(struct request_queue q, struct nvme_command cmd,
1cb3cce5 CH	240	struct nvme_completion cqe, void buffer, unsigned bufflen,
1cb3cce5 CH	241	unsigned timeout);
4160982e CH	242	int nvme_submit_user_cmd(struct request_queue q, struct nvme_command cmd,
	243	void __user ubuffer, unsigned bufflen, u32 result,
	244	unsigned timeout);
0b7f1f26 KB	245	int __nvme_submit_user_cmd(struct request_queue q, struct nvme_command cmd,
	246	void __user *ubuffer, unsigned bufflen,
	247	void __user *meta_buffer, unsigned meta_len, u32 meta_seed,
f11bb3e2	248	u32 *result, unsigned timeout);
1c63dc66 CH	249	int nvme_identify_ctrl(struct nvme_ctrl dev, struct nvme_id_ctrl *id);
1c63dc66 CH	250	int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
f11bb3e2	251	struct nvme_id_ns **id);
1c63dc66 CH	252	int nvme_get_log_page(struct nvme_ctrl dev, struct nvme_smart_log *log);
1c63dc66 CH	253	int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
f11bb3e2	254	dma_addr_t dma_addr, u32 *result);
1c63dc66	255	int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
f11bb3e2	256	dma_addr_t dma_addr, u32 *result);
9a0be7ab	257	int nvme_set_queue_count(struct nvme_ctrl ctrl, int count);
f11bb3e2 CH	258
	259	struct sg_io_hdr;
	260
	261	int nvme_sg_io(struct nvme_ns ns, struct sg_io_hdr __user u_hdr);
	262	int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
	263	int nvme_sg_get_version_num(int __user *ip);
	264
c4699e70	265	#ifdef CONFIG_NVM
ca064085 MB	266	int nvme_nvm_ns_supported(struct nvme_ns ns, struct nvme_id_ns id);
	267	int nvme_nvm_register(struct request_queue q, char disk_name);
	268	void nvme_nvm_unregister(struct request_queue q, char disk_name);
c4699e70 KB	269	#else
	270	static inline int nvme_nvm_register(struct request_queue q, char disk_name)
	271	{
	272	return 0;
	273	}
	274
	275	static inline void nvme_nvm_unregister(struct request_queue q, char disk_name) {};
	276
	277	static inline int nvme_nvm_ns_supported(struct nvme_ns ns, struct nvme_id_ns id)
	278	{
	279	return 0;
	280	}
	281	#endif /* CONFIG_NVM */
ca064085	282
5bae7f73 CH	283	int __init nvme_core_init(void);
	284	void nvme_core_exit(void);
	285
f11bb3e2	286	#endif /* _NVME_H */