[deliverable/linux.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>

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)

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

struct nvme_ctrl {
	const struct nvme_ctrl_ops *ops;
	struct request_queue *admin_q;
	struct device *dev;
	int instance;

	char name[12];
	char serial[20];
	char model[40];
	char firmware_rev[8];
	u16 oncs;
	u16 abort_limit;
	u8 event_limit;
	u8 vwc;
};

/*
 * 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;

	unsigned ns_id;
	int lba_shift;
	u16 ms;
	bool ext;
	u8 pi_type;
	int type;
	u64 mode_select_num_blocks;
	u32 mode_select_block_len;
};

struct nvme_ctrl_ops {
	int (*reg_read32)(struct nvme_ctrl *ctrl, u32 off, u32 *val);
};

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 u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
{
	return (sector >> (ns->lba_shift - 9));
}

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

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,
		void *buffer, void __user *ubuffer, unsigned bufflen,
		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);

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

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

#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
	22	extern unsigned char nvme_io_timeout;
	23	#define NVME_IO_TIMEOUT (nvme_io_timeout * HZ)
	24
21d34711 CH	25	extern unsigned char admin_timeout;
	26	#define ADMIN_TIMEOUT (admin_timeout * HZ)
	27
ca064085 MB	28	enum {
	29	NVME_NS_LBA = 0,
	30	NVME_NS_LIGHTNVM = 1,
	31	};
	32
1c63dc66 CH	33	struct nvme_ctrl {
1c63dc66 CH	34	const struct nvme_ctrl_ops *ops;
f11bb3e2	35	struct request_queue *admin_q;
f11bb3e2	36	struct device *dev;
f11bb3e2	37	int instance;
1c63dc66	38
f11bb3e2 CH	39	char name[12];
	40	char serial[20];
	41	char model[40];
	42	char firmware_rev[8];
f11bb3e2 CH	43	u16 oncs;
	44	u16 abort_limit;
	45	u8 event_limit;
	46	u8 vwc;
	47	};
	48
	49	/*
	50	* An NVM Express namespace is equivalent to a SCSI LUN
	51	*/
	52	struct nvme_ns {
	53	struct list_head list;
	54
1c63dc66	55	struct nvme_ctrl *ctrl;
f11bb3e2 CH	56	struct request_queue *queue;
	57	struct gendisk *disk;
	58	struct kref kref;
	59
	60	unsigned ns_id;
	61	int lba_shift;
	62	u16 ms;
	63	bool ext;
	64	u8 pi_type;
ca064085	65	int type;
f11bb3e2 CH	66	u64 mode_select_num_blocks;
	67	u32 mode_select_block_len;
	68	};
	69
1c63dc66 CH	70	struct nvme_ctrl_ops {
	71	int (reg_read32)(struct nvme_ctrl ctrl, u32 off, u32 *val);
	72	};
	73
	74	static inline bool nvme_ctrl_ready(struct nvme_ctrl *ctrl)
	75	{
	76	u32 val = 0;
	77
	78	if (ctrl->ops->reg_read32(ctrl, NVME_REG_CSTS, &val))
	79	return false;
	80	return val & NVME_CSTS_RDY;
	81	}
	82
f11bb3e2 CH	83	static inline u64 nvme_block_nr(struct nvme_ns *ns, sector_t sector)
	84	{
	85	return (sector >> (ns->lba_shift - 9));
	86	}
	87
15a190f7 CH	88	static inline int nvme_error_status(u16 status)
	89	{
	90	switch (status & 0x7ff) {
	91	case NVME_SC_SUCCESS:
	92	return 0;
	93	case NVME_SC_CAP_EXCEEDED:
	94	return -ENOSPC;
	95	default:
	96	return -EIO;
	97	}
	98	}
	99
f11bb3e2 CH	100	int nvme_submit_sync_cmd(struct request_queue q, struct nvme_command cmd,
	101	void *buf, unsigned bufflen);
	102	int __nvme_submit_sync_cmd(struct request_queue q, struct nvme_command cmd,
	103	void buffer, void __user ubuffer, unsigned bufflen,
	104	u32 *result, unsigned timeout);
1c63dc66 CH	105	int nvme_identify_ctrl(struct nvme_ctrl dev, struct nvme_id_ctrl *id);
1c63dc66 CH	106	int nvme_identify_ns(struct nvme_ctrl *dev, unsigned nsid,
f11bb3e2	107	struct nvme_id_ns **id);
1c63dc66 CH	108	int nvme_get_log_page(struct nvme_ctrl dev, struct nvme_smart_log *log);
1c63dc66 CH	109	int nvme_get_features(struct nvme_ctrl *dev, unsigned fid, unsigned nsid,
f11bb3e2	110	dma_addr_t dma_addr, u32 *result);
1c63dc66	111	int nvme_set_features(struct nvme_ctrl *dev, unsigned fid, unsigned dword11,
f11bb3e2 CH	112	dma_addr_t dma_addr, u32 *result);
	113
	114	struct sg_io_hdr;
	115
	116	int nvme_sg_io(struct nvme_ns ns, struct sg_io_hdr __user u_hdr);
	117	int nvme_sg_io32(struct nvme_ns *ns, unsigned long arg);
	118	int nvme_sg_get_version_num(int __user *ip);
	119
ca064085 MB	120	int nvme_nvm_ns_supported(struct nvme_ns ns, struct nvme_id_ns id);
	121	int nvme_nvm_register(struct request_queue q, char disk_name);
	122	void nvme_nvm_unregister(struct request_queue q, char disk_name);
	123
f11bb3e2	124	#endif /* _NVME_H */