[mirror_ubuntu-focal-kernel.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.
 *
 * $Id: ib_srp.h 3932 2005-11-01 17:19:29Z roland $
 */

#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 - 1,
	SRP_CQ_SIZE		= SRP_SQ_SIZE + SRP_RQ_SIZE,

	SRP_TAG_TSK_MGMT	= 1 << (SRP_RQ_SHIFT + 1),

	SRP_FMR_SIZE		= 256,
	SRP_FMR_POOL_SIZE	= 1024,
	SRP_FMR_DIRTY_SIZE	= SRP_FMR_POOL_SIZE / 4
};

#define SRP_OP_RECV		(1 << 31)

enum srp_target_state {
	SRP_TARGET_LIVE,
	SRP_TARGET_CONNECTING,
	SRP_TARGET_DEAD,
	SRP_TARGET_REMOVED
};

enum srp_request_type {
	SRP_REQ_NORMAL,
	SRP_REQ_TASK_MGMT,
};

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;
	int			fmr_page_shift;
	int			fmr_page_size;
	u64			fmr_page_mask;
};

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 srp_iu	       *tsk_mgmt;
	struct ib_pool_fmr     *fmr;
	struct completion	done;
	short			index;
	u8			cmd_done;
	u8			tsk_status;
};

struct srp_target_port {
	__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;

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

	struct ib_cm_id	       *cm_id;
	struct ib_cq	       *cq;
	struct ib_qp	       *qp;

	int			max_ti_iu_len;
	s32			req_lim;

	int			zero_req_lim;

	unsigned		rx_head;
	struct srp_iu	       *rx_ring[SRP_RQ_SIZE];

	unsigned		tx_head;
	unsigned		tx_tail;
	struct srp_iu	       *tx_ring[SRP_SQ_SIZE + 1];

	struct list_head	free_reqs;
	struct list_head	req_queue;
	struct srp_request	req_ring[SRP_SQ_SIZE];

	struct work_struct	work;

	struct list_head	list;
	struct completion	done;
	int			status;
	enum srp_target_state	state;
	int			qp_in_error;
};

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

#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.
	31	*
	32	* $Id: ib_srp.h 3932 2005-11-01 17:19:29Z roland $
	33	*/
	34
	35	#ifndef IB_SRP_H
	36	#define IB_SRP_H
	37
	38	#include <linux/types.h>
	39	#include <linux/list.h>
8e9e5f4f	40	#include <linux/mutex.h>
cf368713	41	#include <linux/scatterlist.h>
aef9ec39 RD	42
	43	#include <scsi/scsi_host.h>
	44	#include <scsi/scsi_cmnd.h>
	45
	46	#include <rdma/ib_verbs.h>
	47	#include <rdma/ib_sa.h>
	48	#include <rdma/ib_cm.h>
f5358a17	49	#include <rdma/ib_fmr_pool.h>
aef9ec39 RD	50
	51	enum {
	52	SRP_PATH_REC_TIMEOUT_MS = 1000,
	53	SRP_ABORT_TIMEOUT_MS = 5000,
	54
	55	SRP_PORT_REDIRECT = 1,
	56	SRP_DLID_REDIRECT = 2,
9fe4bcf4	57	SRP_STALE_CONN = 3,
aef9ec39	58
5f068992	59	SRP_MAX_LUN = 512,
74b0a15b	60	SRP_DEF_SG_TABLESIZE = 12,
aef9ec39 RD	61
	62	SRP_RQ_SHIFT = 6,
	63	SRP_RQ_SIZE = 1 << SRP_RQ_SHIFT,
	64	SRP_SQ_SIZE = SRP_RQ_SIZE - 1,
	65	SRP_CQ_SIZE = SRP_SQ_SIZE + SRP_RQ_SIZE,
	66
f5358a17 RD	67	SRP_TAG_TSK_MGMT = 1 << (SRP_RQ_SHIFT + 1),
	68
	69	SRP_FMR_SIZE = 256,
	70	SRP_FMR_POOL_SIZE = 1024,
	71	SRP_FMR_DIRTY_SIZE = SRP_FMR_POOL_SIZE / 4
aef9ec39 RD	72	};
	73
	74	#define SRP_OP_RECV (1 << 31)
aef9ec39 RD	75
	76	enum srp_target_state {
	77	SRP_TARGET_LIVE,
	78	SRP_TARGET_CONNECTING,
	79	SRP_TARGET_DEAD,
	80	SRP_TARGET_REMOVED
	81	};
	82
8cba2077 DD	83	enum srp_request_type {
	84	SRP_REQ_NORMAL,
	85	SRP_REQ_TASK_MGMT,
	86	};
	87
f5358a17 RD	88	struct srp_device {
f5358a17 RD	89	struct list_head dev_list;
aef9ec39	90	struct ib_device *dev;
aef9ec39 RD	91	struct ib_pd *pd;
aef9ec39 RD	92	struct ib_mr *mr;
f5358a17 RD	93	struct ib_fmr_pool *fmr_pool;
	94	int fmr_page_shift;
	95	int fmr_page_size;
bf628dc2	96	u64 fmr_page_mask;
f5358a17 RD	97	};
	98
	99	struct srp_host {
05321937	100	struct srp_device *srp_dev;
f5358a17	101	u8 port;
ee959b00	102	struct device dev;
aef9ec39	103	struct list_head target_list;
b3589fd4	104	spinlock_t target_lock;
aef9ec39 RD	105	struct completion released;
	106	struct list_head list;
	107	};
	108
	109	struct srp_request {
	110	struct list_head list;
	111	struct scsi_cmnd *scmnd;
	112	struct srp_iu *cmd;
	113	struct srp_iu *tsk_mgmt;
f5358a17	114	struct ib_pool_fmr *fmr;
aef9ec39	115	struct completion done;
d945e1df	116	short index;
aef9ec39 RD	117	u8 cmd_done;
	118	u8 tsk_status;
	119	};
	120
	121	struct srp_target_port {
	122	__be64 id_ext;
	123	__be64 ioc_guid;
	124	__be64 service_id;
01cb9bcb	125	__be64 initiator_ext;
0c0450db	126	u16 io_class;
aef9ec39 RD	127	struct srp_host *srp_host;
	128	struct Scsi_Host *scsi_host;
	129	char target_name[32];
	130	unsigned int scsi_id;
	131
	132	struct ib_sa_path_rec path;
3633b3d0	133	__be16 orig_dgid[8];
aef9ec39 RD	134	struct ib_sa_query *path_query;
	135	int path_query_id;
	136
	137	struct ib_cm_id *cm_id;
	138	struct ib_cq *cq;
	139	struct ib_qp *qp;
	140
	141	int max_ti_iu_len;
	142	s32 req_lim;
	143
6bfa24fa RD	144	int zero_req_lim;
6bfa24fa RD	145
aef9ec39 RD	146	unsigned rx_head;
	147	struct srp_iu *rx_ring[SRP_RQ_SIZE];
	148
	149	unsigned tx_head;
	150	unsigned tx_tail;
	151	struct srp_iu *tx_ring[SRP_SQ_SIZE + 1];
	152
d945e1df	153	struct list_head free_reqs;
aef9ec39 RD	154	struct list_head req_queue;
	155	struct srp_request req_ring[SRP_SQ_SIZE];
	156
	157	struct work_struct work;
	158
	159	struct list_head list;
	160	struct completion done;
	161	int status;
	162	enum srp_target_state state;
1033ff67	163	int qp_in_error;
aef9ec39 RD	164	};
	165
	166	struct srp_iu {
85507bcc	167	u64 dma;
aef9ec39 RD	168	void *buf;
	169	size_t size;
	170	enum dma_data_direction direction;
	171	};
	172
	173	#endif /* IB_SRP_H */