[deliverable/linux.git] / drivers / infiniband / ulp / srp / ib_srp.h

/*
 * Copyright (c) 2005 Cisco Systems.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef IB_SRP_H
#define IB_SRP_H

#include <linux/types.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/scatterlist.h>

#include <scsi/scsi_host.h>
#include <scsi/scsi_cmnd.h>

#include <rdma/ib_verbs.h>
#include <rdma/ib_sa.h>
#include <rdma/ib_cm.h>
#include <rdma/ib_fmr_pool.h>

enum {
	SRP_PATH_REC_TIMEOUT_MS	= 1000,
	SRP_ABORT_TIMEOUT_MS	= 5000,

	SRP_PORT_REDIRECT	= 1,
	SRP_DLID_REDIRECT	= 2,
	SRP_STALE_CONN		= 3,

	SRP_MAX_LUN		= 512,
	SRP_DEF_SG_TABLESIZE	= 12,

	SRP_RQ_SHIFT    	= 6,
	SRP_RQ_SIZE		= 1 << SRP_RQ_SHIFT,

	SRP_SQ_SIZE		= SRP_RQ_SIZE,
	SRP_RSP_SQ_SIZE		= 1,
	SRP_REQ_SQ_SIZE		= SRP_SQ_SIZE - SRP_RSP_SQ_SIZE,
	SRP_TSK_MGMT_SQ_SIZE	= 1,
	SRP_CMD_SQ_SIZE		= SRP_REQ_SQ_SIZE - SRP_TSK_MGMT_SQ_SIZE,

	SRP_TAG_NO_REQ		= ~0U,
	SRP_TAG_TSK_MGMT	= 1U << 31,

	SRP_FMR_SIZE		= 512,
	SRP_FMR_MIN_SIZE	= 128,
	SRP_FMR_POOL_SIZE	= 1024,
	SRP_FMR_DIRTY_SIZE	= SRP_FMR_POOL_SIZE / 4,

	SRP_MAP_ALLOW_FMR	= 0,
	SRP_MAP_NO_FMR		= 1,
};

enum srp_target_state {
	SRP_TARGET_LIVE,
	SRP_TARGET_REMOVED,
};

enum srp_iu_type {
	SRP_IU_CMD,
	SRP_IU_TSK_MGMT,
	SRP_IU_RSP,
};

struct srp_device {
	struct list_head	dev_list;
	struct ib_device       *dev;
	struct ib_pd	       *pd;
	struct ib_mr	       *mr;
	struct ib_fmr_pool     *fmr_pool;
	u64			fmr_page_mask;
	int			fmr_page_size;
	int			fmr_max_size;
};

struct srp_host {
	struct srp_device      *srp_dev;
	u8			port;
	struct device		dev;
	struct list_head	target_list;
	spinlock_t		target_lock;
	struct completion	released;
	struct list_head	list;
};

struct srp_request {
	struct list_head	list;
	struct scsi_cmnd       *scmnd;
	struct srp_iu	       *cmd;
	struct ib_pool_fmr    **fmr_list;
	u64		       *map_page;
	struct srp_direct_buf  *indirect_desc;
	dma_addr_t		indirect_dma_addr;
	short			nfmr;
	short			index;
};

struct srp_target_port {
	/* These are RW in the hot path, and commonly used together */
	struct list_head	free_tx;
	struct list_head	free_reqs;
	spinlock_t		lock;
	s32			req_lim;

	/* These are read-only in the hot path */
	struct ib_cq	       *send_cq ____cacheline_aligned_in_smp;
	struct ib_cq	       *recv_cq;
	struct ib_qp	       *qp;
	u32			lkey;
	u32			rkey;
	enum srp_target_state	state;
	unsigned int		max_iu_len;
	unsigned int		cmd_sg_cnt;
	unsigned int		indirect_size;
	bool			allow_ext_sg;
	bool			transport_offline;

	/* Everything above this point is used in the hot path of
	 * command processing. Try to keep them packed into cachelines.
	 */

	__be64			id_ext;
	__be64			ioc_guid;
	__be64			service_id;
	__be64			initiator_ext;
	u16			io_class;
	struct srp_host	       *srp_host;
	struct Scsi_Host       *scsi_host;
	char			target_name[32];
	unsigned int		scsi_id;
	unsigned int		sg_tablesize;

	struct ib_sa_path_rec	path;
	__be16			orig_dgid[8];
	struct ib_sa_query     *path_query;
	int			path_query_id;

	u32			rq_tmo_jiffies;
	bool			connected;

	struct ib_cm_id	       *cm_id;

	int			max_ti_iu_len;

	int			zero_req_lim;

	struct srp_iu	       *tx_ring[SRP_SQ_SIZE];
	struct srp_iu	       *rx_ring[SRP_RQ_SIZE];
	struct srp_request	req_ring[SRP_CMD_SQ_SIZE];

	struct work_struct	remove_work;

	struct list_head	list;
	struct completion	done;
	int			status;
	bool			qp_in_error;

	struct completion	tsk_mgmt_done;
	u8			tsk_mgmt_status;
};

struct srp_iu {
	struct list_head	list;
	u64			dma;
	void		       *buf;
	size_t			size;
	enum dma_data_direction	direction;
};

struct srp_map_state {
	struct ib_pool_fmr    **next_fmr;
	struct srp_direct_buf  *desc;
	u64		       *pages;
	dma_addr_t		base_dma_addr;
	u32			fmr_len;
	u32			total_len;
	unsigned int		npages;
	unsigned int		nfmr;
	unsigned int		ndesc;
	struct scatterlist     *unmapped_sg;
	int			unmapped_index;
	dma_addr_t		unmapped_addr;
};

#endif /* IB_SRP_H */
Commit	Line	Data
aef9ec39 RD	1	/*
	2	* Copyright (c) 2005 Cisco Systems. All rights reserved.
	3	*
	4	* This software is available to you under a choice of one of two
	5	* licenses. You may choose to be licensed under the terms of the GNU
	6	* General Public License (GPL) Version 2, available from the file
	7	* COPYING in the main directory of this source tree, or the
	8	* OpenIB.org BSD license below:
	9	*
	10	* Redistribution and use in source and binary forms, with or
	11	* without modification, are permitted provided that the following
	12	* conditions are met:
	13	*
	14	* - Redistributions of source code must retain the above
	15	* copyright notice, this list of conditions and the following
	16	* disclaimer.
	17	*
	18	* - Redistributions in binary form must reproduce the above
	19	* copyright notice, this list of conditions and the following
	20	* disclaimer in the documentation and/or other materials
	21	* provided with the distribution.
	22	*
	23	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	24	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	25	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	26	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	27	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	28	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	29	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	30	* SOFTWARE.
aef9ec39 RD	31	*/
	32
	33	#ifndef IB_SRP_H
	34	#define IB_SRP_H
	35
	36	#include <linux/types.h>
	37	#include <linux/list.h>
8e9e5f4f	38	#include <linux/mutex.h>
cf368713	39	#include <linux/scatterlist.h>
aef9ec39 RD	40
	41	#include <scsi/scsi_host.h>
	42	#include <scsi/scsi_cmnd.h>
	43
	44	#include <rdma/ib_verbs.h>
	45	#include <rdma/ib_sa.h>
	46	#include <rdma/ib_cm.h>
f5358a17	47	#include <rdma/ib_fmr_pool.h>
aef9ec39 RD	48
	49	enum {
	50	SRP_PATH_REC_TIMEOUT_MS = 1000,
	51	SRP_ABORT_TIMEOUT_MS = 5000,
	52
	53	SRP_PORT_REDIRECT = 1,
	54	SRP_DLID_REDIRECT = 2,
9fe4bcf4	55	SRP_STALE_CONN = 3,
aef9ec39	56
5f068992	57	SRP_MAX_LUN = 512,
74b0a15b	58	SRP_DEF_SG_TABLESIZE = 12,
aef9ec39 RD	59
	60	SRP_RQ_SHIFT = 6,
	61	SRP_RQ_SIZE = 1 << SRP_RQ_SHIFT,
dd5e6e38 BVA	62
dd5e6e38 BVA	63	SRP_SQ_SIZE = SRP_RQ_SIZE,
dd5e6e38 BVA	64	SRP_RSP_SQ_SIZE = 1,
	65	SRP_REQ_SQ_SIZE = SRP_SQ_SIZE - SRP_RSP_SQ_SIZE,
	66	SRP_TSK_MGMT_SQ_SIZE = 1,
	67	SRP_CMD_SQ_SIZE = SRP_REQ_SQ_SIZE - SRP_TSK_MGMT_SQ_SIZE,
aef9ec39	68
f8b6e31e DD	69	SRP_TAG_NO_REQ = ~0U,
f8b6e31e DD	70	SRP_TAG_TSK_MGMT = 1U << 31,
f5358a17	71
be8b9814 DD	72	SRP_FMR_SIZE = 512,
be8b9814 DD	73	SRP_FMR_MIN_SIZE = 128,
f5358a17	74	SRP_FMR_POOL_SIZE = 1024,
8f26c9ff DD	75	SRP_FMR_DIRTY_SIZE = SRP_FMR_POOL_SIZE / 4,
	76
	77	SRP_MAP_ALLOW_FMR = 0,
	78	SRP_MAP_NO_FMR = 1,
aef9ec39 RD	79	};
aef9ec39 RD	80
aef9ec39 RD	81	enum srp_target_state {
aef9ec39 RD	82	SRP_TARGET_LIVE,
ef6c49d8	83	SRP_TARGET_REMOVED,
aef9ec39 RD	84	};
aef9ec39 RD	85
bb12588a DD	86	enum srp_iu_type {
	87	SRP_IU_CMD,
	88	SRP_IU_TSK_MGMT,
	89	SRP_IU_RSP,
8cba2077 DD	90	};
8cba2077 DD	91
f5358a17 RD	92	struct srp_device {
f5358a17 RD	93	struct list_head dev_list;
aef9ec39	94	struct ib_device *dev;
aef9ec39 RD	95	struct ib_pd *pd;
aef9ec39 RD	96	struct ib_mr *mr;
f5358a17	97	struct ib_fmr_pool *fmr_pool;
bf628dc2	98	u64 fmr_page_mask;
8f26c9ff DD	99	int fmr_page_size;
8f26c9ff DD	100	int fmr_max_size;
f5358a17 RD	101	};
	102
	103	struct srp_host {
05321937	104	struct srp_device *srp_dev;
f5358a17	105	u8 port;
ee959b00	106	struct device dev;
aef9ec39	107	struct list_head target_list;
b3589fd4	108	spinlock_t target_lock;
aef9ec39 RD	109	struct completion released;
	110	struct list_head list;
	111	};
	112
	113	struct srp_request {
	114	struct list_head list;
	115	struct scsi_cmnd *scmnd;
	116	struct srp_iu *cmd;
8f26c9ff DD	117	struct ib_pool_fmr **fmr_list;
8f26c9ff DD	118	u64 *map_page;
c07d424d DD	119	struct srp_direct_buf *indirect_desc;
c07d424d DD	120	dma_addr_t indirect_dma_addr;
8f26c9ff	121	short nfmr;
d945e1df	122	short index;
aef9ec39 RD	123	};
	124
	125	struct srp_target_port {
9af76271 DD	126	/* These are RW in the hot path, and commonly used together */
	127	struct list_head free_tx;
	128	struct list_head free_reqs;
	129	spinlock_t lock;
	130	s32 req_lim;
	131
	132	/* These are read-only in the hot path */
	133	struct ib_cq *send_cq ____cacheline_aligned_in_smp;
	134	struct ib_cq *recv_cq;
	135	struct ib_qp *qp;
	136	u32 lkey;
	137	u32 rkey;
	138	enum srp_target_state state;
49248644 DD	139	unsigned int max_iu_len;
49248644 DD	140	unsigned int cmd_sg_cnt;
c07d424d DD	141	unsigned int indirect_size;
c07d424d DD	142	bool allow_ext_sg;
2ce19e72	143	bool transport_offline;
9af76271 DD	144
	145	/* Everything above this point is used in the hot path of
	146	* command processing. Try to keep them packed into cachelines.
	147	*/
	148
aef9ec39 RD	149	__be64 id_ext;
	150	__be64 ioc_guid;
	151	__be64 service_id;
01cb9bcb	152	__be64 initiator_ext;
0c0450db	153	u16 io_class;
aef9ec39 RD	154	struct srp_host *srp_host;
	155	struct Scsi_Host *scsi_host;
	156	char target_name[32];
	157	unsigned int scsi_id;
c07d424d	158	unsigned int sg_tablesize;
aef9ec39 RD	159
aef9ec39 RD	160	struct ib_sa_path_rec path;
3633b3d0	161	__be16 orig_dgid[8];
aef9ec39 RD	162	struct ib_sa_query *path_query;
	163	int path_query_id;
	164
c9b03c1a	165	u32 rq_tmo_jiffies;
294c875a	166	bool connected;
c9b03c1a	167
aef9ec39	168	struct ib_cm_id *cm_id;
aef9ec39 RD	169
aef9ec39 RD	170	int max_ti_iu_len;
aef9ec39	171
6bfa24fa RD	172	int zero_req_lim;
6bfa24fa RD	173
dd5e6e38	174	struct srp_iu *tx_ring[SRP_SQ_SIZE];
9af76271	175	struct srp_iu *rx_ring[SRP_RQ_SIZE];
dd5e6e38	176	struct srp_request req_ring[SRP_CMD_SQ_SIZE];
aef9ec39	177
ef6c49d8	178	struct work_struct remove_work;
aef9ec39 RD	179
	180	struct list_head list;
	181	struct completion done;
	182	int status;
948d1e88	183	bool qp_in_error;
f8b6e31e DD	184
	185	struct completion tsk_mgmt_done;
	186	u8 tsk_mgmt_status;
aef9ec39 RD	187	};
	188
	189	struct srp_iu {
dcb4cb85	190	struct list_head list;
85507bcc	191	u64 dma;
aef9ec39 RD	192	void *buf;
	193	size_t size;
	194	enum dma_data_direction direction;
	195	};
	196
8f26c9ff DD	197	struct srp_map_state {
	198	struct ib_pool_fmr **next_fmr;
	199	struct srp_direct_buf *desc;
	200	u64 *pages;
	201	dma_addr_t base_dma_addr;
	202	u32 fmr_len;
	203	u32 total_len;
	204	unsigned int npages;
	205	unsigned int nfmr;
	206	unsigned int ndesc;
	207	struct scatterlist *unmapped_sg;
	208	int unmapped_index;
	209	dma_addr_t unmapped_addr;
	210	};
	211
aef9ec39	212	#endif /* IB_SRP_H */