1 /*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
3 * Fibre Channel Host Bus Adapters. *
4 * Copyright (C) 2004-2007 Emulex. All rights reserved. *
5 * EMULEX and SLI are trademarks of Emulex. *
8 * This program is free software; you can redistribute it and/or *
9 * modify it under the terms of version 2 of the GNU General *
10 * Public License as published by the Free Software Foundation. *
11 * This program is distributed in the hope that it will be useful. *
12 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND *
13 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, *
14 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE *
15 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
16 * TO BE LEGALLY INVALID. See the GNU General Public License for *
17 * more details, a copy of which can be found in the file COPYING *
18 * included with this package. *
19 *******************************************************************/
21 /* forward declaration for LPFC_IOCB_t's use */
25 /* Define the context types that SLI handles for abort and sums. */
26 typedef enum _lpfc_ctx_cmd
{
32 struct lpfc_cq_event
{
33 struct list_head list
;
35 struct lpfc_mcqe mcqe_cmpl
;
36 struct lpfc_acqe_link acqe_link
;
37 struct lpfc_acqe_fip acqe_fip
;
38 struct lpfc_acqe_dcbx acqe_dcbx
;
39 struct lpfc_acqe_grp5 acqe_grp5
;
40 struct lpfc_acqe_fc_la acqe_fc
;
41 struct lpfc_acqe_sli acqe_sli
;
42 struct lpfc_rcqe rcqe_cmpl
;
43 struct sli4_wcqe_xri_aborted wcqe_axri
;
44 struct lpfc_wcqe_complete wcqe_cmpl
;
48 /* This structure is used to handle IOCB requests / responses */
50 /* lpfc_iocbqs are used in double linked lists */
51 struct list_head list
;
52 struct list_head clist
;
53 struct list_head dlist
;
54 uint16_t iotag
; /* pre-assigned IO tag */
55 uint16_t sli4_lxritag
; /* logical pre-assigned XRI. */
56 uint16_t sli4_xritag
; /* pre-assigned XRI, (OXID) tag. */
57 struct lpfc_cq_event cq_event
;
59 IOCB_t iocb
; /* IOCB cmd */
60 uint8_t retry
; /* retry counter for IOCB cmd - if needed */
62 #define LPFC_IO_LIBDFC 1 /* libdfc iocb */
63 #define LPFC_IO_WAKE 2 /* High Priority Queue signal flag */
64 #define LPFC_IO_FCP 4 /* FCP command -- iocbq in scsi_buf */
65 #define LPFC_DRIVER_ABORTED 8 /* driver aborted this request */
66 #define LPFC_IO_FABRIC 0x10 /* Iocb send using fabric scheduler */
67 #define LPFC_DELAY_MEM_FREE 0x20 /* Defer free'ing of FC data */
68 #define LPFC_EXCHANGE_BUSY 0x40 /* SLI4 hba reported XB in response */
69 #define LPFC_USE_FCPWQIDX 0x80 /* Submit to specified FCPWQ index */
70 #define DSS_SECURITY_OP 0x100 /* security IO */
71 #define LPFC_IO_ON_TXCMPLQ 0x200 /* The IO is still on the TXCMPLQ */
72 #define LPFC_IO_DIF_PASS 0x400 /* T10 DIF IO pass-thru prot */
73 #define LPFC_IO_DIF_STRIP 0x800 /* T10 DIF IO strip prot */
74 #define LPFC_IO_DIF_INSERT 0x1000 /* T10 DIF IO insert prot */
76 #define LPFC_FIP_ELS_ID_MASK 0xc000 /* ELS_ID range 0-3, non-shifted mask */
77 #define LPFC_FIP_ELS_ID_SHIFT 14
80 uint32_t drvrTimeout
; /* driver timeout in seconds */
81 uint32_t fcp_wqidx
; /* index to FCP work queue */
82 struct lpfc_vport
*vport
;/* virtual port pointer */
83 void *context1
; /* caller context information */
84 void *context2
; /* caller context information */
85 void *context3
; /* caller context information */
87 wait_queue_head_t
*wait_queue
;
88 struct lpfc_iocbq
*rsp_iocb
;
89 struct lpfcMboxq
*mbox
;
90 struct lpfc_nodelist
*ndlp
;
91 struct lpfc_node_rrq
*rrq
;
94 void (*fabric_iocb_cmpl
) (struct lpfc_hba
*, struct lpfc_iocbq
*,
96 void (*iocb_cmpl
) (struct lpfc_hba
*, struct lpfc_iocbq
*,
100 #define SLI_IOCB_RET_IOCB 1 /* Return IOCB if cmd ring full */
102 #define IOCB_SUCCESS 0
105 #define IOCB_TIMEDOUT 3
107 #define LPFC_MBX_WAKE 1
108 #define LPFC_MBX_IMED_UNREG 2
110 typedef struct lpfcMboxq
{
111 /* MBOXQs are used in single linked lists */
112 struct list_head list
; /* ptr to next mailbox command */
114 MAILBOX_t mb
; /* Mailbox cmd */
117 struct lpfc_vport
*vport
;/* virtual port pointer */
118 void *context1
; /* caller context information */
119 void *context2
; /* caller context information */
121 void (*mbox_cmpl
) (struct lpfc_hba
*, struct lpfcMboxq
*);
123 uint16_t in_ext_byte_len
;
124 uint16_t out_ext_byte_len
;
125 uint8_t mbox_offset_word
;
126 struct lpfc_mcqe mcqe
;
127 struct lpfc_mbx_nembed_sge_virt
*sge_array
;
130 #define MBX_POLL 1 /* poll mailbox till command done, then
132 #define MBX_NOWAIT 2 /* issue command then return immediately */
134 #define LPFC_MAX_RING_MASK 5 /* max num of rctl/type masks allowed per
136 #define LPFC_SLI3_MAX_RING 4 /* Max num of SLI3 rings used by driver.
137 For SLI4, an additional ring for each
138 FCP WQ will be allocated. */
140 struct lpfc_sli_ring
;
142 struct lpfc_sli_ring_mask
{
143 uint8_t profile
; /* profile associated with ring */
144 uint8_t rctl
; /* rctl / type pair configured for ring */
145 uint8_t type
; /* rctl / type pair configured for ring */
147 /* rcv'd unsol event */
148 void (*lpfc_sli_rcv_unsol_event
) (struct lpfc_hba
*,
149 struct lpfc_sli_ring
*,
150 struct lpfc_iocbq
*);
154 /* Structure used to hold SLI statistical counters and info */
155 struct lpfc_sli_ring_stat
{
156 uint64_t iocb_event
; /* IOCB event counters */
157 uint64_t iocb_cmd
; /* IOCB cmd issued */
158 uint64_t iocb_rsp
; /* IOCB rsp received */
159 uint64_t iocb_cmd_delay
; /* IOCB cmd ring delay */
160 uint64_t iocb_cmd_full
; /* IOCB cmd ring full */
161 uint64_t iocb_cmd_empty
; /* IOCB cmd ring is now empty */
162 uint64_t iocb_rsp_full
; /* IOCB rsp ring full */
165 struct lpfc_sli3_ring
{
166 uint32_t local_getidx
; /* last available cmd index (from cmdGetInx) */
167 uint32_t next_cmdidx
; /* next_cmd index */
168 uint32_t rspidx
; /* current index in response ring */
169 uint32_t cmdidx
; /* current index in command ring */
170 uint16_t numCiocb
; /* number of command iocb's per ring */
171 uint16_t numRiocb
; /* number of rsp iocb's per ring */
172 uint16_t sizeCiocb
; /* Size of command iocb's in this ring */
173 uint16_t sizeRiocb
; /* Size of response iocb's in this ring */
174 uint32_t *cmdringaddr
; /* virtual address for cmd rings */
175 uint32_t *rspringaddr
; /* virtual address for rsp rings */
178 struct lpfc_sli4_ring
{
179 struct lpfc_queue
*wqp
; /* Pointer to associated WQ */
183 /* Structure used to hold SLI ring information */
184 struct lpfc_sli_ring
{
185 uint16_t flag
; /* ring flags */
186 #define LPFC_DEFERRED_RING_EVENT 0x001 /* Deferred processing a ring event */
187 #define LPFC_CALL_RING_AVAILABLE 0x002 /* indicates cmd was full */
188 #define LPFC_STOP_IOCB_EVENT 0x020 /* Stop processing IOCB cmds event */
189 uint16_t abtsiotag
; /* tracks next iotag to use for ABTS */
192 uint8_t ringno
; /* ring number */
194 spinlock_t ring_lock
; /* lock for issuing commands */
196 uint32_t fast_iotag
; /* max fastlookup based iotag */
197 uint32_t iotag_ctr
; /* keeps track of the next iotag to use */
198 uint32_t iotag_max
; /* max iotag value to use */
199 struct list_head txq
;
200 uint16_t txq_cnt
; /* current length of queue */
201 uint16_t txq_max
; /* max length */
202 struct list_head txcmplq
;
203 uint16_t txcmplq_cnt
; /* current length of queue */
204 uint16_t txcmplq_max
; /* max length */
205 uint32_t missbufcnt
; /* keep track of buffers to post */
206 struct list_head postbufq
;
207 uint16_t postbufq_cnt
; /* current length of queue */
208 uint16_t postbufq_max
; /* max length */
209 struct list_head iocb_continueq
;
210 uint16_t iocb_continueq_cnt
; /* current length of queue */
211 uint16_t iocb_continueq_max
; /* max length */
212 struct list_head iocb_continue_saveq
;
214 struct lpfc_sli_ring_mask prt
[LPFC_MAX_RING_MASK
];
215 uint32_t num_mask
; /* number of mask entries in prt array */
216 void (*lpfc_sli_rcv_async_status
) (struct lpfc_hba
*,
217 struct lpfc_sli_ring
*, struct lpfc_iocbq
*);
219 struct lpfc_sli_ring_stat stats
; /* SLI statistical info */
221 /* cmd ring available */
222 void (*lpfc_sli_cmd_available
) (struct lpfc_hba
*,
223 struct lpfc_sli_ring
*);
225 struct lpfc_sli3_ring sli3
;
226 struct lpfc_sli4_ring sli4
;
230 /* Structure used for configuring rings to a specific profile or rctl / type */
231 struct lpfc_hbq_init
{
232 uint32_t rn
; /* Receive buffer notification */
233 uint32_t entry_count
; /* max # of entries in HBQ */
234 uint32_t headerLen
; /* 0 if not profile 4 or 5 */
235 uint32_t logEntry
; /* Set to 1 if this HBQ used for LogEntry */
236 uint32_t profile
; /* Selection profile 0=all, 7=logentry */
237 uint32_t ring_mask
; /* Binds HBQ to a ring e.g. Ring0=b0001,
239 uint32_t hbq_index
; /* index of this hbq in ring .HBQs[] */
245 uint32_t cmdmatch
[8];
246 uint32_t mask_count
; /* number of mask entries in prt array */
247 struct hbq_mask hbqMasks
[6];
249 /* Non-config rings fields to keep track of buffer allocations */
250 uint32_t buffer_count
; /* number of buffers allocated */
251 uint32_t init_count
; /* number to allocate when initialized */
252 uint32_t add_count
; /* number to allocate when starved */
255 /* Structure used to hold SLI statistical counters and info */
256 struct lpfc_sli_stat
{
257 uint64_t mbox_stat_err
; /* Mbox cmds completed status error */
258 uint64_t mbox_cmd
; /* Mailbox commands issued */
259 uint64_t sli_intr
; /* Count of Host Attention interrupts */
260 uint64_t sli_prev_intr
; /* Previous cnt of Host Attention interrupts */
261 uint64_t sli_ips
; /* Host Attention interrupts per sec */
262 uint32_t err_attn_event
; /* Error Attn event counters */
263 uint32_t link_event
; /* Link event counters */
264 uint32_t mbox_event
; /* Mailbox event counters */
265 uint32_t mbox_busy
; /* Mailbox cmd busy */
268 /* Structure to store link status values when port stats are reset */
269 struct lpfc_lnk_stat
{
270 uint32_t link_failure_count
;
271 uint32_t loss_of_sync_count
;
272 uint32_t loss_of_signal_count
;
273 uint32_t prim_seq_protocol_err_count
;
274 uint32_t invalid_tx_word_count
;
275 uint32_t invalid_crc_count
;
276 uint32_t error_frames
;
277 uint32_t link_events
;
280 /* Structure used to hold SLI information */
285 /* Additional sli_flags */
286 #define LPFC_SLI_MBOX_ACTIVE 0x100 /* HBA mailbox is currently active */
287 #define LPFC_SLI_ACTIVE 0x200 /* SLI in firmware is active */
288 #define LPFC_PROCESS_LA 0x400 /* Able to process link attention */
289 #define LPFC_BLOCK_MGMT_IO 0x800 /* Don't allow mgmt mbx or iocb cmds */
290 #define LPFC_MENLO_MAINT 0x1000 /* need for menl fw download */
291 #define LPFC_SLI_ASYNC_MBX_BLK 0x2000 /* Async mailbox is blocked */
293 struct lpfc_sli_ring
*ring
;
294 int fcp_ring
; /* ring used for FCP initiator commands */
297 int extra_ring
; /* extra ring used for other protocols */
299 struct lpfc_sli_stat slistat
; /* SLI statistical info */
300 struct list_head mboxq
;
301 uint16_t mboxq_cnt
; /* current length of queue */
302 uint16_t mboxq_max
; /* max length */
303 LPFC_MBOXQ_t
*mbox_active
; /* active mboxq information */
304 struct list_head mboxq_cmpl
;
306 struct timer_list mbox_tmo
; /* Hold clk to timeout active mbox
309 #define LPFC_IOCBQ_LOOKUP_INCREMENT 1024
310 struct lpfc_iocbq
** iocbq_lookup
; /* array to lookup IOCB by IOTAG */
311 size_t iocbq_lookup_len
; /* current lengs of the array */
312 uint16_t last_iotag
; /* last allocated IOTAG */
313 unsigned long stats_start
; /* in seconds */
314 struct lpfc_lnk_stat lnk_stat_offsets
;
317 /* Timeout for normal outstanding mbox command (Seconds) */
318 #define LPFC_MBOX_TMO 30
319 /* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
320 #define LPFC_MBOX_SLI4_CONFIG_TMO 60
321 /* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
322 #define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO 300
323 /* Timeout for other flash-based outstanding mbox command (Seconds) */
324 #define LPFC_MBOX_TMO_FLASH_CMD 300