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 | |
74b0a15b | 57 | SRP_DEF_SG_TABLESIZE = 12, |
aef9ec39 | 58 | |
4d73f95f | 59 | SRP_DEFAULT_QUEUE_SIZE = 1 << 6, |
dd5e6e38 | 60 | SRP_RSP_SQ_SIZE = 1, |
dd5e6e38 | 61 | SRP_TSK_MGMT_SQ_SIZE = 1, |
4d73f95f BVA |
62 | SRP_DEFAULT_CMD_SQ_SIZE = SRP_DEFAULT_QUEUE_SIZE - SRP_RSP_SQ_SIZE - |
63 | SRP_TSK_MGMT_SQ_SIZE, | |
aef9ec39 | 64 | |
f8b6e31e DD |
65 | SRP_TAG_NO_REQ = ~0U, |
66 | SRP_TAG_TSK_MGMT = 1U << 31, | |
f5358a17 | 67 | |
52ede08f | 68 | SRP_MAX_PAGES_PER_MR = 512, |
8f26c9ff | 69 | |
5cfb1782 BVA |
70 | LOCAL_INV_WR_ID_MASK = 1, |
71 | FAST_REG_WR_ID_MASK = 2, | |
7dad6b2e BVA |
72 | |
73 | SRP_LAST_WR_ID = 0xfffffffcU, | |
aef9ec39 RD |
74 | }; |
75 | ||
aef9ec39 | 76 | enum srp_target_state { |
34aa654e | 77 | SRP_TARGET_SCANNING, |
aef9ec39 | 78 | SRP_TARGET_LIVE, |
ef6c49d8 | 79 | SRP_TARGET_REMOVED, |
aef9ec39 RD |
80 | }; |
81 | ||
bb12588a DD |
82 | enum srp_iu_type { |
83 | SRP_IU_CMD, | |
84 | SRP_IU_TSK_MGMT, | |
85 | SRP_IU_RSP, | |
8cba2077 DD |
86 | }; |
87 | ||
5cfb1782 BVA |
88 | /* |
89 | * @mr_page_mask: HCA memory registration page mask. | |
90 | * @mr_page_size: HCA memory registration page size. | |
91 | * @mr_max_size: Maximum size in bytes of a single FMR / FR registration | |
92 | * request. | |
93 | */ | |
f5358a17 RD |
94 | struct srp_device { |
95 | struct list_head dev_list; | |
aef9ec39 | 96 | struct ib_device *dev; |
aef9ec39 RD |
97 | struct ib_pd *pd; |
98 | struct ib_mr *mr; | |
52ede08f BVA |
99 | u64 mr_page_mask; |
100 | int mr_page_size; | |
101 | int mr_max_size; | |
102 | int max_pages_per_mr; | |
d1b4289e | 103 | bool has_fmr; |
5cfb1782 BVA |
104 | bool has_fr; |
105 | bool use_fast_reg; | |
f5358a17 RD |
106 | }; |
107 | ||
108 | struct srp_host { | |
05321937 | 109 | struct srp_device *srp_dev; |
f5358a17 | 110 | u8 port; |
ee959b00 | 111 | struct device dev; |
aef9ec39 | 112 | struct list_head target_list; |
b3589fd4 | 113 | spinlock_t target_lock; |
aef9ec39 RD |
114 | struct completion released; |
115 | struct list_head list; | |
2d7091bc | 116 | struct mutex add_target_mutex; |
aef9ec39 RD |
117 | }; |
118 | ||
119 | struct srp_request { | |
aef9ec39 RD |
120 | struct scsi_cmnd *scmnd; |
121 | struct srp_iu *cmd; | |
5cfb1782 BVA |
122 | union { |
123 | struct ib_pool_fmr **fmr_list; | |
124 | struct srp_fr_desc **fr_list; | |
125 | }; | |
8f26c9ff | 126 | u64 *map_page; |
c07d424d DD |
127 | struct srp_direct_buf *indirect_desc; |
128 | dma_addr_t indirect_dma_addr; | |
52ede08f | 129 | short nmdesc; |
aef9ec39 RD |
130 | }; |
131 | ||
509c07bc BVA |
132 | /** |
133 | * struct srp_rdma_ch | |
134 | * @comp_vector: Completion vector used by this RDMA channel. | |
135 | */ | |
136 | struct srp_rdma_ch { | |
9af76271 DD |
137 | /* These are RW in the hot path, and commonly used together */ |
138 | struct list_head free_tx; | |
9af76271 DD |
139 | spinlock_t lock; |
140 | s32 req_lim; | |
141 | ||
142 | /* These are read-only in the hot path */ | |
509c07bc BVA |
143 | struct srp_target_port *target ____cacheline_aligned_in_smp; |
144 | struct ib_cq *send_cq; | |
9af76271 DD |
145 | struct ib_cq *recv_cq; |
146 | struct ib_qp *qp; | |
5cfb1782 BVA |
147 | union { |
148 | struct ib_fmr_pool *fmr_pool; | |
149 | struct srp_fr_pool *fr_pool; | |
150 | }; | |
509c07bc BVA |
151 | |
152 | /* Everything above this point is used in the hot path of | |
153 | * command processing. Try to keep them packed into cachelines. | |
154 | */ | |
155 | ||
156 | struct completion done; | |
157 | int status; | |
158 | ||
159 | struct ib_sa_path_rec path; | |
160 | struct ib_sa_query *path_query; | |
161 | int path_query_id; | |
162 | ||
163 | struct ib_cm_id *cm_id; | |
164 | struct srp_iu **tx_ring; | |
165 | struct srp_iu **rx_ring; | |
166 | struct srp_request *req_ring; | |
167 | int max_ti_iu_len; | |
168 | int comp_vector; | |
169 | ||
170 | struct completion tsk_mgmt_done; | |
171 | u8 tsk_mgmt_status; | |
c014c8cd | 172 | bool connected; |
509c07bc BVA |
173 | }; |
174 | ||
175 | /** | |
176 | * struct srp_target_port | |
177 | * @comp_vector: Completion vector used by the first RDMA channel created for | |
178 | * this target port. | |
179 | */ | |
180 | struct srp_target_port { | |
181 | /* read and written in the hot path */ | |
182 | spinlock_t lock; | |
183 | ||
509c07bc | 184 | /* read only in the hot path */ |
d92c0da7 BVA |
185 | struct srp_rdma_ch *ch; |
186 | u32 ch_count; | |
9af76271 DD |
187 | u32 lkey; |
188 | u32 rkey; | |
189 | enum srp_target_state state; | |
49248644 DD |
190 | unsigned int max_iu_len; |
191 | unsigned int cmd_sg_cnt; | |
c07d424d DD |
192 | unsigned int indirect_size; |
193 | bool allow_ext_sg; | |
9af76271 | 194 | |
509c07bc | 195 | /* other member variables */ |
747fe000 | 196 | union ib_gid sgid; |
aef9ec39 RD |
197 | __be64 id_ext; |
198 | __be64 ioc_guid; | |
199 | __be64 service_id; | |
01cb9bcb | 200 | __be64 initiator_ext; |
0c0450db | 201 | u16 io_class; |
aef9ec39 RD |
202 | struct srp_host *srp_host; |
203 | struct Scsi_Host *scsi_host; | |
9dd69a60 | 204 | struct srp_rport *rport; |
aef9ec39 RD |
205 | char target_name[32]; |
206 | unsigned int scsi_id; | |
c07d424d | 207 | unsigned int sg_tablesize; |
4d73f95f BVA |
208 | int queue_size; |
209 | int req_ring_size; | |
4b5e5f41 | 210 | int comp_vector; |
7bb312e4 | 211 | int tl_retry_count; |
aef9ec39 | 212 | |
747fe000 BVA |
213 | union ib_gid orig_dgid; |
214 | __be16 pkey; | |
aef9ec39 | 215 | |
c9b03c1a BVA |
216 | u32 rq_tmo_jiffies; |
217 | ||
6bfa24fa RD |
218 | int zero_req_lim; |
219 | ||
c1120f89 | 220 | struct work_struct tl_err_work; |
ef6c49d8 | 221 | struct work_struct remove_work; |
aef9ec39 RD |
222 | |
223 | struct list_head list; | |
948d1e88 | 224 | bool qp_in_error; |
aef9ec39 RD |
225 | }; |
226 | ||
227 | struct srp_iu { | |
dcb4cb85 | 228 | struct list_head list; |
85507bcc | 229 | u64 dma; |
aef9ec39 RD |
230 | void *buf; |
231 | size_t size; | |
232 | enum dma_data_direction direction; | |
233 | }; | |
234 | ||
5cfb1782 BVA |
235 | /** |
236 | * struct srp_fr_desc - fast registration work request arguments | |
237 | * @entry: Entry in srp_fr_pool.free_list. | |
238 | * @mr: Memory region. | |
239 | * @frpl: Fast registration page list. | |
240 | */ | |
241 | struct srp_fr_desc { | |
242 | struct list_head entry; | |
243 | struct ib_mr *mr; | |
244 | struct ib_fast_reg_page_list *frpl; | |
245 | }; | |
246 | ||
247 | /** | |
248 | * struct srp_fr_pool - pool of fast registration descriptors | |
249 | * | |
250 | * An entry is available for allocation if and only if it occurs in @free_list. | |
251 | * | |
252 | * @size: Number of descriptors in this pool. | |
253 | * @max_page_list_len: Maximum fast registration work request page list length. | |
254 | * @lock: Protects free_list. | |
255 | * @free_list: List of free descriptors. | |
256 | * @desc: Fast registration descriptor pool. | |
257 | */ | |
258 | struct srp_fr_pool { | |
259 | int size; | |
260 | int max_page_list_len; | |
261 | spinlock_t lock; | |
262 | struct list_head free_list; | |
263 | struct srp_fr_desc desc[0]; | |
264 | }; | |
265 | ||
266 | /** | |
267 | * struct srp_map_state - per-request DMA memory mapping state | |
268 | * @desc: Pointer to the element of the SRP buffer descriptor array | |
269 | * that is being filled in. | |
270 | * @pages: Array with DMA addresses of pages being considered for | |
271 | * memory registration. | |
272 | * @base_dma_addr: DMA address of the first page that has not yet been mapped. | |
273 | * @dma_len: Number of bytes that will be registered with the next | |
274 | * FMR or FR memory registration call. | |
275 | * @total_len: Total number of bytes in the sg-list being mapped. | |
276 | * @npages: Number of page addresses in the pages[] array. | |
277 | * @nmdesc: Number of FMR or FR memory descriptors used for mapping. | |
278 | * @ndesc: Number of SRP buffer descriptors that have been filled in. | |
5cfb1782 | 279 | */ |
8f26c9ff | 280 | struct srp_map_state { |
5cfb1782 | 281 | union { |
f731ed62 BVA |
282 | struct { |
283 | struct ib_pool_fmr **next; | |
284 | struct ib_pool_fmr **end; | |
285 | } fmr; | |
286 | struct { | |
287 | struct srp_fr_desc **next; | |
288 | struct srp_fr_desc **end; | |
289 | } fr; | |
5cfb1782 | 290 | }; |
8f26c9ff DD |
291 | struct srp_direct_buf *desc; |
292 | u64 *pages; | |
293 | dma_addr_t base_dma_addr; | |
52ede08f | 294 | u32 dma_len; |
8f26c9ff DD |
295 | u32 total_len; |
296 | unsigned int npages; | |
52ede08f | 297 | unsigned int nmdesc; |
8f26c9ff | 298 | unsigned int ndesc; |
8f26c9ff DD |
299 | }; |
300 | ||
aef9ec39 | 301 | #endif /* IB_SRP_H */ |