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