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>
40 #include <linux/mutex.h>
41 #include <linux/scatterlist.h>
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>
49 #include <rdma/ib_fmr_pool.h>
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,
57 	SRP_STALE_CONN		= 3,
58 
59 	SRP_MAX_LUN		= 512,
60 	SRP_DEF_SG_TABLESIZE	= 12,
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 
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
72 };
73 
74 #define SRP_OP_RECV		(1 << 31)
75 
76 enum srp_target_state {
77 	SRP_TARGET_LIVE,
78 	SRP_TARGET_CONNECTING,
79 	SRP_TARGET_DEAD,
80 	SRP_TARGET_REMOVED
81 };
82 
83 enum srp_request_type {
84 	SRP_REQ_NORMAL,
85 	SRP_REQ_TASK_MGMT,
86 };
87 
88 struct srp_device {
89 	struct list_head	dev_list;
90 	struct ib_device       *dev;
91 	struct ib_pd	       *pd;
92 	struct ib_mr	       *mr;
93 	struct ib_fmr_pool     *fmr_pool;
94 	int			fmr_page_shift;
95 	int			fmr_page_size;
96 	u64			fmr_page_mask;
97 };
98 
99 struct srp_host {
100 	struct srp_device      *dev;
101 	u8			port;
102 	struct class_device	class_dev;
103 	struct list_head	target_list;
104 	spinlock_t		target_lock;
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;
114 	struct ib_pool_fmr     *fmr;
115 	struct completion	done;
116 	short			index;
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;
125 	__be64			initiator_ext;
126 	u16			io_class;
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;
133 	__be16			orig_dgid[8];
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 
144 	int			zero_req_lim;
145 
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 
153 	struct list_head	free_reqs;
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;
163 	int			qp_in_error;
164 };
165 
166 struct srp_iu {
167 	u64			dma;
168 	void		       *buf;
169 	size_t			size;
170 	enum dma_data_direction	direction;
171 };
172 
173 #endif /* IB_SRP_H */
174