Commit | Line | Data |
---|---|---|
a36c61f9 KG |
1 | /* |
2 | * Copyright (c) 2005-2010 Brocade Communications Systems, Inc. | |
3 | * All rights reserved | |
4 | * www.brocade.com | |
5 | * | |
6 | * Linux driver for Brocade Fibre Channel Host Bus Adapter. | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify it | |
9 | * under the terms of the GNU General Public License (GPL) Version 2 as | |
10 | * published by the Free Software Foundation | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, but | |
13 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * General Public License for more details. | |
16 | */ | |
17 | ||
18 | #ifndef __BFA_FCPIM_H__ | |
19 | #define __BFA_FCPIM_H__ | |
20 | ||
21 | #include "bfa.h" | |
22 | #include "bfa_svc.h" | |
23 | #include "bfi_ms.h" | |
24 | #include "bfa_defs_svc.h" | |
25 | #include "bfa_cs.h" | |
26 | ||
e2187d7f KG |
27 | /* FCP module related definitions */ |
28 | #define BFA_IO_MAX 2000 | |
29 | #define BFA_FWTIO_MAX 0 | |
30 | ||
31 | struct bfa_fcp_mod_s; | |
32 | struct bfa_iotag_s { | |
33 | struct list_head qe; /* queue element */ | |
34 | u16 tag; /* FW IO tag */ | |
35 | }; | |
36 | ||
37 | struct bfa_itn_s { | |
38 | bfa_isr_func_t isr; | |
39 | }; | |
40 | ||
41 | void bfa_itn_create(struct bfa_s *bfa, struct bfa_rport_s *rport, | |
42 | void (*isr)(struct bfa_s *bfa, struct bfi_msg_s *m)); | |
43 | void bfa_itn_isr(struct bfa_s *bfa, struct bfi_msg_s *m); | |
44 | void bfa_iotag_attach(struct bfa_fcp_mod_s *fcp, struct bfa_meminfo_s *minfo); | |
45 | ||
46 | #define BFA_FCP_MOD(_hal) (&(_hal)->modules.fcp_mod) | |
47 | #define BFA_IOTAG_FROM_TAG(_fcp, _tag) \ | |
48 | (&(_fcp)->iotag_arr[(_tag & BFA_IOIM_IOTAG_MASK)]) | |
49 | #define BFA_ITN_FROM_TAG(_fcp, _tag) \ | |
50 | ((_fcp)->itn_arr + ((_tag) & ((_fcp)->num_itns - 1))) | |
51 | #define BFA_SNSINFO_FROM_TAG(_fcp, _tag) \ | |
52 | (((u8 *)(_fcp)->snsbase.kva) + (_tag * BFI_IOIM_SNSLEN)) | |
a36c61f9 KG |
53 | |
54 | #define BFA_ITNIM_MIN 32 | |
55 | #define BFA_ITNIM_MAX 1024 | |
56 | ||
57 | #define BFA_IOIM_MIN 8 | |
58 | #define BFA_IOIM_MAX 2000 | |
59 | ||
60 | #define BFA_TSKIM_MIN 4 | |
61 | #define BFA_TSKIM_MAX 512 | |
62 | #define BFA_FCPIM_PATHTOV_DEF (30 * 1000) /* in millisecs */ | |
63 | #define BFA_FCPIM_PATHTOV_MAX (90 * 1000) /* in millisecs */ | |
64 | ||
65 | ||
66 | #define bfa_itnim_ioprofile_update(__itnim, __index) \ | |
67 | (__itnim->ioprofile.iocomps[__index]++) | |
68 | ||
69 | #define BFA_IOIM_RETRY_TAG_OFFSET 11 | |
15821f05 | 70 | #define BFA_IOIM_IOTAG_MASK 0x07ff /* 2K IOs */ |
a36c61f9 KG |
71 | #define BFA_IOIM_RETRY_MAX 7 |
72 | ||
73 | /* Buckets are are 512 bytes to 2MB */ | |
74 | static inline u32 | |
75 | bfa_ioim_get_index(u32 n) { | |
76 | int pos = 0; | |
77 | if (n >= (1UL)<<22) | |
78 | return BFA_IOBUCKET_MAX - 1; | |
79 | n >>= 8; | |
80 | if (n >= (1UL)<<16) | |
81 | n >>= 16; pos += 16; | |
82 | if (n >= 1 << 8) | |
83 | n >>= 8; pos += 8; | |
84 | if (n >= 1 << 4) | |
85 | n >>= 4; pos += 4; | |
86 | if (n >= 1 << 2) | |
87 | n >>= 2; pos += 2; | |
88 | if (n >= 1 << 1) | |
89 | pos += 1; | |
90 | ||
91 | return (n == 0) ? (0) : pos; | |
92 | } | |
93 | ||
94 | /* | |
95 | * forward declarations | |
96 | */ | |
97 | struct bfa_ioim_s; | |
98 | struct bfa_tskim_s; | |
99 | struct bfad_ioim_s; | |
100 | struct bfad_tskim_s; | |
101 | ||
102 | typedef void (*bfa_fcpim_profile_t) (struct bfa_ioim_s *ioim); | |
103 | ||
e2187d7f | 104 | struct bfa_fcpim_s { |
a36c61f9 | 105 | struct bfa_s *bfa; |
e2187d7f | 106 | struct bfa_fcp_mod_s *fcp; |
a36c61f9 KG |
107 | struct bfa_itnim_s *itnim_arr; |
108 | struct bfa_ioim_s *ioim_arr; | |
109 | struct bfa_ioim_sp_s *ioim_sp_arr; | |
110 | struct bfa_tskim_s *tskim_arr; | |
a36c61f9 | 111 | int num_itnims; |
a36c61f9 KG |
112 | int num_tskim_reqs; |
113 | u32 path_tov; | |
114 | u16 q_depth; | |
115 | u8 reqq; /* Request queue to be used */ | |
116 | u8 rsvd; | |
117 | struct list_head itnim_q; /* queue of active itnim */ | |
a36c61f9 KG |
118 | struct list_head ioim_resfree_q; /* IOs waiting for f/w */ |
119 | struct list_head ioim_comp_q; /* IO global comp Q */ | |
120 | struct list_head tskim_free_q; | |
da99dcc9 MZ |
121 | u32 ios_active; /* current active IOs */ |
122 | u32 delay_comp; | |
a36c61f9 KG |
123 | struct bfa_fcpim_del_itn_stats_s del_itn_stats; |
124 | bfa_boolean_t ioredirect; | |
125 | bfa_boolean_t io_profile; | |
da99dcc9 | 126 | u32 io_profile_start_time; |
a36c61f9 KG |
127 | bfa_fcpim_profile_t profile_comp; |
128 | bfa_fcpim_profile_t profile_start; | |
129 | }; | |
130 | ||
e2187d7f KG |
131 | struct bfa_fcp_mod_s { |
132 | struct bfa_s *bfa; | |
133 | struct list_head iotag_ioim_free_q; /* free IO resources */ | |
134 | struct list_head iotag_tio_free_q; /* free IO resources */ | |
135 | struct bfa_iotag_s *iotag_arr; | |
136 | struct bfa_itn_s *itn_arr; | |
137 | int num_ioim_reqs; | |
138 | int num_fwtio_reqs; | |
139 | int num_itns; | |
140 | struct bfa_dma_s snsbase; | |
141 | struct bfa_fcpim_s fcpim; | |
142 | }; | |
143 | ||
acdc79a6 | 144 | /* |
a36c61f9 KG |
145 | * BFA IO (initiator mode) |
146 | */ | |
147 | struct bfa_ioim_s { | |
148 | struct list_head qe; /* queue elememt */ | |
149 | bfa_sm_t sm; /* BFA ioim state machine */ | |
150 | struct bfa_s *bfa; /* BFA module */ | |
e2187d7f | 151 | struct bfa_fcpim_s *fcpim; /* parent fcpim module */ |
a36c61f9 KG |
152 | struct bfa_itnim_s *itnim; /* i-t-n nexus for this IO */ |
153 | struct bfad_ioim_s *dio; /* driver IO handle */ | |
da99dcc9 MZ |
154 | u16 iotag; /* FWI IO tag */ |
155 | u16 abort_tag; /* unqiue abort request tag */ | |
156 | u16 nsges; /* number of SG elements */ | |
157 | u16 nsgpgs; /* number of SG pages */ | |
a36c61f9 KG |
158 | struct bfa_sgpg_s *sgpg; /* first SG page */ |
159 | struct list_head sgpg_q; /* allocated SG pages */ | |
160 | struct bfa_cb_qe_s hcb_qe; /* bfa callback qelem */ | |
161 | bfa_cb_cbfn_t io_cbfn; /* IO completion handler */ | |
da99dcc9 MZ |
162 | struct bfa_ioim_sp_s *iosp; /* slow-path IO handling */ |
163 | u8 reqq; /* Request queue for I/O */ | |
164 | u64 start_time; /* IO's Profile start val */ | |
a36c61f9 KG |
165 | }; |
166 | ||
a36c61f9 KG |
167 | struct bfa_ioim_sp_s { |
168 | struct bfi_msg_s comp_rspmsg; /* IO comp f/w response */ | |
da99dcc9 MZ |
169 | struct bfa_sgpg_wqe_s sgpg_wqe; /* waitq elem for sgpg */ |
170 | struct bfa_reqq_wait_s reqq_wait; /* to wait for room in reqq */ | |
a36c61f9 KG |
171 | bfa_boolean_t abort_explicit; /* aborted by OS */ |
172 | struct bfa_tskim_s *tskim; /* Relevant TM cmd */ | |
173 | }; | |
174 | ||
acdc79a6 | 175 | /* |
a36c61f9 KG |
176 | * BFA Task management command (initiator mode) |
177 | */ | |
178 | struct bfa_tskim_s { | |
179 | struct list_head qe; | |
180 | bfa_sm_t sm; | |
da99dcc9 | 181 | struct bfa_s *bfa; /* BFA module */ |
e2187d7f | 182 | struct bfa_fcpim_s *fcpim; /* parent fcpim module */ |
a36c61f9 | 183 | struct bfa_itnim_s *itnim; /* i-t-n nexus for this IO */ |
f314878a | 184 | struct bfad_tskim_s *dtsk; /* driver task mgmt cmnd */ |
da99dcc9 | 185 | bfa_boolean_t notify; /* notify itnim on TM comp */ |
f314878a | 186 | struct scsi_lun lun; /* lun if applicable */ |
da99dcc9 MZ |
187 | enum fcp_tm_cmnd tm_cmnd; /* task management command */ |
188 | u16 tsk_tag; /* FWI IO tag */ | |
189 | u8 tsecs; /* timeout in seconds */ | |
a36c61f9 KG |
190 | struct bfa_reqq_wait_s reqq_wait; /* to wait for room in reqq */ |
191 | struct list_head io_q; /* queue of affected IOs */ | |
da99dcc9 | 192 | struct bfa_wc_s wc; /* waiting counter */ |
a36c61f9 KG |
193 | struct bfa_cb_qe_s hcb_qe; /* bfa callback qelem */ |
194 | enum bfi_tskim_status tsk_status; /* TM status */ | |
195 | }; | |
196 | ||
acdc79a6 | 197 | /* |
a36c61f9 KG |
198 | * BFA i-t-n (initiator mode) |
199 | */ | |
200 | struct bfa_itnim_s { | |
da99dcc9 MZ |
201 | struct list_head qe; /* queue element */ |
202 | bfa_sm_t sm; /* i-t-n im BFA state machine */ | |
203 | struct bfa_s *bfa; /* bfa instance */ | |
204 | struct bfa_rport_s *rport; /* bfa rport */ | |
205 | void *ditn; /* driver i-t-n structure */ | |
a36c61f9 | 206 | struct bfi_mhdr_s mhdr; /* pre-built mhdr */ |
da99dcc9 MZ |
207 | u8 msg_no; /* itnim/rport firmware handle */ |
208 | u8 reqq; /* CQ for requests */ | |
a36c61f9 KG |
209 | struct bfa_cb_qe_s hcb_qe; /* bfa callback qelem */ |
210 | struct list_head pending_q; /* queue of pending IO requests */ | |
211 | struct list_head io_q; /* queue of active IO requests */ | |
212 | struct list_head io_cleanup_q; /* IO being cleaned up */ | |
213 | struct list_head tsk_q; /* queue of active TM commands */ | |
214 | struct list_head delay_comp_q; /* queue of failed inflight cmds */ | |
215 | bfa_boolean_t seq_rec; /* SQER supported */ | |
216 | bfa_boolean_t is_online; /* itnim is ONLINE for IO */ | |
217 | bfa_boolean_t iotov_active; /* IO TOV timer is active */ | |
da99dcc9 MZ |
218 | struct bfa_wc_s wc; /* waiting counter */ |
219 | struct bfa_timer_s timer; /* pending IO TOV */ | |
a36c61f9 | 220 | struct bfa_reqq_wait_s reqq_wait; /* to wait for room in reqq */ |
e2187d7f | 221 | struct bfa_fcpim_s *fcpim; /* fcpim module */ |
a36c61f9 KG |
222 | struct bfa_itnim_iostats_s stats; |
223 | struct bfa_itnim_ioprofile_s ioprofile; | |
224 | }; | |
225 | ||
a36c61f9 | 226 | #define bfa_itnim_is_online(_itnim) ((_itnim)->is_online) |
e2187d7f | 227 | #define BFA_FCPIM(_hal) (&(_hal)->modules.fcp_mod.fcpim) |
15821f05 | 228 | #define BFA_IOIM_TAG_2_ID(_iotag) ((_iotag) & BFA_IOIM_IOTAG_MASK) |
a36c61f9 | 229 | #define BFA_IOIM_FROM_TAG(_fcpim, _iotag) \ |
15821f05 | 230 | (&fcpim->ioim_arr[(_iotag & BFA_IOIM_IOTAG_MASK)]) |
a36c61f9 KG |
231 | #define BFA_TSKIM_FROM_TAG(_fcpim, _tmtag) \ |
232 | (&fcpim->tskim_arr[_tmtag & (fcpim->num_tskim_reqs - 1)]) | |
233 | ||
234 | #define bfa_io_profile_start_time(_bfa) \ | |
e2187d7f | 235 | ((_bfa)->modules.fcp_mod.fcpim.io_profile_start_time) |
a36c61f9 | 236 | #define bfa_fcpim_get_io_profile(_bfa) \ |
e2187d7f | 237 | ((_bfa)->modules.fcp_mod.fcpim.io_profile) |
15821f05 KG |
238 | #define bfa_ioim_update_iotag(__ioim) do { \ |
239 | uint16_t k = (__ioim)->iotag >> BFA_IOIM_RETRY_TAG_OFFSET; \ | |
240 | k++; (__ioim)->iotag &= BFA_IOIM_IOTAG_MASK; \ | |
241 | (__ioim)->iotag |= k << BFA_IOIM_RETRY_TAG_OFFSET; \ | |
242 | } while (0) | |
a36c61f9 KG |
243 | |
244 | static inline bfa_boolean_t | |
15821f05 | 245 | bfa_ioim_maxretry_reached(struct bfa_ioim_s *ioim) |
a36c61f9 | 246 | { |
15821f05 KG |
247 | uint16_t k = ioim->iotag >> BFA_IOIM_RETRY_TAG_OFFSET; |
248 | if (k < BFA_IOIM_RETRY_MAX) | |
a36c61f9 | 249 | return BFA_FALSE; |
a36c61f9 KG |
250 | return BFA_TRUE; |
251 | } | |
15821f05 | 252 | |
a36c61f9 KG |
253 | /* |
254 | * function prototypes | |
255 | */ | |
e2187d7f | 256 | void bfa_ioim_attach(struct bfa_fcpim_s *fcpim, |
a36c61f9 | 257 | struct bfa_meminfo_s *minfo); |
a36c61f9 KG |
258 | void bfa_ioim_isr(struct bfa_s *bfa, struct bfi_msg_s *msg); |
259 | void bfa_ioim_good_comp_isr(struct bfa_s *bfa, | |
260 | struct bfi_msg_s *msg); | |
261 | void bfa_ioim_cleanup(struct bfa_ioim_s *ioim); | |
262 | void bfa_ioim_cleanup_tm(struct bfa_ioim_s *ioim, | |
263 | struct bfa_tskim_s *tskim); | |
264 | void bfa_ioim_iocdisable(struct bfa_ioim_s *ioim); | |
265 | void bfa_ioim_tov(struct bfa_ioim_s *ioim); | |
266 | ||
e2187d7f | 267 | void bfa_tskim_attach(struct bfa_fcpim_s *fcpim, |
a36c61f9 | 268 | struct bfa_meminfo_s *minfo); |
a36c61f9 KG |
269 | void bfa_tskim_isr(struct bfa_s *bfa, struct bfi_msg_s *msg); |
270 | void bfa_tskim_iodone(struct bfa_tskim_s *tskim); | |
271 | void bfa_tskim_iocdisable(struct bfa_tskim_s *tskim); | |
272 | void bfa_tskim_cleanup(struct bfa_tskim_s *tskim); | |
273 | ||
274 | void bfa_itnim_meminfo(struct bfa_iocfc_cfg_s *cfg, u32 *km_len, | |
275 | u32 *dm_len); | |
e2187d7f | 276 | void bfa_itnim_attach(struct bfa_fcpim_s *fcpim, |
a36c61f9 | 277 | struct bfa_meminfo_s *minfo); |
a36c61f9 KG |
278 | void bfa_itnim_iocdisable(struct bfa_itnim_s *itnim); |
279 | void bfa_itnim_isr(struct bfa_s *bfa, struct bfi_msg_s *msg); | |
280 | void bfa_itnim_iodone(struct bfa_itnim_s *itnim); | |
281 | void bfa_itnim_tskdone(struct bfa_itnim_s *itnim); | |
282 | bfa_boolean_t bfa_itnim_hold_io(struct bfa_itnim_s *itnim); | |
a36c61f9 KG |
283 | |
284 | /* | |
285 | * bfa fcpim module API functions | |
286 | */ | |
da99dcc9 | 287 | void bfa_fcpim_path_tov_set(struct bfa_s *bfa, u16 path_tov); |
a36c61f9 | 288 | u16 bfa_fcpim_path_tov_get(struct bfa_s *bfa); |
a36c61f9 | 289 | u16 bfa_fcpim_qdepth_get(struct bfa_s *bfa); |
da99dcc9 | 290 | |
a36c61f9 | 291 | #define bfa_fcpim_ioredirect_enabled(__bfa) \ |
e2187d7f | 292 | (((struct bfa_fcpim_s *)(BFA_FCPIM(__bfa)))->ioredirect) |
a36c61f9 KG |
293 | |
294 | #define bfa_fcpim_get_next_reqq(__bfa, __qid) \ | |
295 | { \ | |
e2187d7f | 296 | struct bfa_fcpim_s *__fcpim = BFA_FCPIM(__bfa); \ |
a36c61f9 KG |
297 | __fcpim->reqq++; \ |
298 | __fcpim->reqq &= (BFI_IOC_MAX_CQS - 1); \ | |
299 | *(__qid) = __fcpim->reqq; \ | |
300 | } | |
301 | ||
302 | #define bfa_iocfc_map_msg_to_qid(__msg, __qid) \ | |
303 | *(__qid) = (u8)((__msg) & (BFI_IOC_MAX_CQS - 1)); | |
304 | /* | |
305 | * bfa itnim API functions | |
306 | */ | |
307 | struct bfa_itnim_s *bfa_itnim_create(struct bfa_s *bfa, | |
da99dcc9 MZ |
308 | struct bfa_rport_s *rport, void *itnim); |
309 | void bfa_itnim_delete(struct bfa_itnim_s *itnim); | |
310 | void bfa_itnim_online(struct bfa_itnim_s *itnim, bfa_boolean_t seq_rec); | |
311 | void bfa_itnim_offline(struct bfa_itnim_s *itnim); | |
312 | void bfa_itnim_clear_stats(struct bfa_itnim_s *itnim); | |
313 | bfa_status_t bfa_itnim_get_ioprofile(struct bfa_itnim_s *itnim, | |
314 | struct bfa_itnim_ioprofile_s *ioprofile); | |
315 | ||
a36c61f9 KG |
316 | #define bfa_itnim_get_reqq(__ioim) (((struct bfa_ioim_s *)__ioim)->itnim->reqq) |
317 | ||
acdc79a6 | 318 | /* |
da99dcc9 | 319 | * BFA completion callback for bfa_itnim_online(). |
a36c61f9 KG |
320 | */ |
321 | void bfa_cb_itnim_online(void *itnim); | |
322 | ||
acdc79a6 | 323 | /* |
da99dcc9 | 324 | * BFA completion callback for bfa_itnim_offline(). |
a36c61f9 KG |
325 | */ |
326 | void bfa_cb_itnim_offline(void *itnim); | |
327 | void bfa_cb_itnim_tov_begin(void *itnim); | |
328 | void bfa_cb_itnim_tov(void *itnim); | |
329 | ||
acdc79a6 | 330 | /* |
da99dcc9 | 331 | * BFA notification to FCS/driver for second level error recovery. |
a36c61f9 KG |
332 | * Atleast one I/O request has timedout and target is unresponsive to |
333 | * repeated abort requests. Second level error recovery should be initiated | |
334 | * by starting implicit logout and recovery procedures. | |
a36c61f9 KG |
335 | */ |
336 | void bfa_cb_itnim_sler(void *itnim); | |
337 | ||
338 | /* | |
339 | * bfa ioim API functions | |
340 | */ | |
341 | struct bfa_ioim_s *bfa_ioim_alloc(struct bfa_s *bfa, | |
342 | struct bfad_ioim_s *dio, | |
343 | struct bfa_itnim_s *itnim, | |
344 | u16 nsgles); | |
345 | ||
346 | void bfa_ioim_free(struct bfa_ioim_s *ioim); | |
347 | void bfa_ioim_start(struct bfa_ioim_s *ioim); | |
348 | bfa_status_t bfa_ioim_abort(struct bfa_ioim_s *ioim); | |
349 | void bfa_ioim_delayed_comp(struct bfa_ioim_s *ioim, | |
350 | bfa_boolean_t iotov); | |
acdc79a6 | 351 | /* |
da99dcc9 | 352 | * I/O completion notification. |
a36c61f9 KG |
353 | * |
354 | * @param[in] dio driver IO structure | |
355 | * @param[in] io_status IO completion status | |
356 | * @param[in] scsi_status SCSI status returned by target | |
357 | * @param[in] sns_len SCSI sense length, 0 if none | |
358 | * @param[in] sns_info SCSI sense data, if any | |
359 | * @param[in] residue Residual length | |
360 | * | |
361 | * @return None | |
362 | */ | |
da99dcc9 MZ |
363 | void bfa_cb_ioim_done(void *bfad, struct bfad_ioim_s *dio, |
364 | enum bfi_ioim_status io_status, | |
365 | u8 scsi_status, int sns_len, | |
366 | u8 *sns_info, s32 residue); | |
a36c61f9 | 367 | |
acdc79a6 | 368 | /* |
da99dcc9 | 369 | * I/O good completion notification. |
a36c61f9 | 370 | */ |
da99dcc9 | 371 | void bfa_cb_ioim_good_comp(void *bfad, struct bfad_ioim_s *dio); |
a36c61f9 | 372 | |
acdc79a6 | 373 | /* |
da99dcc9 | 374 | * I/O abort completion notification |
a36c61f9 | 375 | */ |
da99dcc9 | 376 | void bfa_cb_ioim_abort(void *bfad, struct bfad_ioim_s *dio); |
a36c61f9 KG |
377 | |
378 | /* | |
379 | * bfa tskim API functions | |
380 | */ | |
da99dcc9 MZ |
381 | struct bfa_tskim_s *bfa_tskim_alloc(struct bfa_s *bfa, |
382 | struct bfad_tskim_s *dtsk); | |
383 | void bfa_tskim_free(struct bfa_tskim_s *tskim); | |
384 | void bfa_tskim_start(struct bfa_tskim_s *tskim, | |
385 | struct bfa_itnim_s *itnim, struct scsi_lun lun, | |
386 | enum fcp_tm_cmnd tm, u8 t_secs); | |
387 | void bfa_cb_tskim_done(void *bfad, struct bfad_tskim_s *dtsk, | |
388 | enum bfi_tskim_status tsk_status); | |
a36c61f9 KG |
389 | |
390 | #endif /* __BFA_FCPIM_H__ */ |