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 
58 	SRP_MAX_LUN		= 512,
59 	SRP_DEF_SG_TABLESIZE	= 12,
60 
61 	SRP_RQ_SHIFT    	= 6,
62 	SRP_RQ_SIZE		= 1 << SRP_RQ_SHIFT,
63 	SRP_SQ_SIZE		= SRP_RQ_SIZE - 1,
64 	SRP_CQ_SIZE		= SRP_SQ_SIZE + SRP_RQ_SIZE,
65 
66 	SRP_TAG_TSK_MGMT	= 1 << (SRP_RQ_SHIFT + 1),
67 
68 	SRP_FMR_SIZE		= 256,
69 	SRP_FMR_POOL_SIZE	= 1024,
70 	SRP_FMR_DIRTY_SIZE	= SRP_FMR_POOL_SIZE / 4
71 };
72 
73 #define SRP_OP_RECV		(1 << 31)
74 
75 enum srp_target_state {
76 	SRP_TARGET_LIVE,
77 	SRP_TARGET_CONNECTING,
78 	SRP_TARGET_DEAD,
79 	SRP_TARGET_REMOVED
80 };
81 
82 enum srp_request_type {
83 	SRP_REQ_NORMAL,
84 	SRP_REQ_TASK_MGMT,
85 };
86 
87 struct srp_device {
88 	struct list_head	dev_list;
89 	struct ib_device       *dev;
90 	struct ib_pd	       *pd;
91 	struct ib_mr	       *mr;
92 	struct ib_fmr_pool     *fmr_pool;
93 	int			fmr_page_shift;
94 	int			fmr_page_size;
95 	u64			fmr_page_mask;
96 };
97 
98 struct srp_host {
99 	struct srp_device      *dev;
100 	u8			port;
101 	struct class_device	class_dev;
102 	struct list_head	target_list;
103 	spinlock_t		target_lock;
104 	struct completion	released;
105 	struct list_head	list;
106 };
107 
108 struct srp_request {
109 	struct list_head	list;
110 	struct scsi_cmnd       *scmnd;
111 	struct srp_iu	       *cmd;
112 	struct srp_iu	       *tsk_mgmt;
113 	struct ib_pool_fmr     *fmr;
114 	struct completion	done;
115 	short			index;
116 	u8			cmd_done;
117 	u8			tsk_status;
118 };
119 
120 struct srp_target_port {
121 	__be64			id_ext;
122 	__be64			ioc_guid;
123 	__be64			service_id;
124 	__be64			initiator_ext;
125 	u16			io_class;
126 	struct srp_host	       *srp_host;
127 	struct Scsi_Host       *scsi_host;
128 	char			target_name[32];
129 	unsigned int		scsi_id;
130 
131 	struct ib_sa_path_rec	path;
132 	__be16			orig_dgid[8];
133 	struct ib_sa_query     *path_query;
134 	int			path_query_id;
135 
136 	struct ib_cm_id	       *cm_id;
137 	struct ib_cq	       *cq;
138 	struct ib_qp	       *qp;
139 
140 	int			max_ti_iu_len;
141 	s32			req_lim;
142 
143 	int			zero_req_lim;
144 
145 	unsigned		rx_head;
146 	struct srp_iu	       *rx_ring[SRP_RQ_SIZE];
147 
148 	unsigned		tx_head;
149 	unsigned		tx_tail;
150 	struct srp_iu	       *tx_ring[SRP_SQ_SIZE + 1];
151 
152 	struct list_head	free_reqs;
153 	struct list_head	req_queue;
154 	struct srp_request	req_ring[SRP_SQ_SIZE];
155 
156 	struct work_struct	work;
157 
158 	struct list_head	list;
159 	struct completion	done;
160 	int			status;
161 	enum srp_target_state	state;
162 	int			qp_in_error;
163 };
164 
165 struct srp_iu {
166 	u64			dma;
167 	void		       *buf;
168 	size_t			size;
169 	enum dma_data_direction	direction;
170 };
171 
172 #endif /* IB_SRP_H */
173