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_fcoe acqe_fcoe;
38 struct lpfc_acqe_dcbx acqe_dcbx;
39 struct lpfc_acqe_grp5 acqe_grp5;
40 struct lpfc_rcqe rcqe_cmpl;
41 struct sli4_wcqe_xri_aborted wcqe_axri;
42 struct lpfc_wcqe_complete wcqe_cmpl;
46 /* This structure is used to handle IOCB requests / responses */
48 /* lpfc_iocbqs are used in double linked lists */
49 struct list_head list;
50 struct list_head clist;
51 uint16_t iotag; /* pre-assigned IO tag */
52 uint16_t sli4_xritag; /* pre-assigned XRI, (OXID) tag. */
53 struct lpfc_cq_event cq_event;
55 IOCB_t iocb; /* IOCB cmd */
56 uint8_t retry; /* retry counter for IOCB cmd - if needed */
58 #define LPFC_IO_LIBDFC 1 /* libdfc iocb */
59 #define LPFC_IO_WAKE 2 /* High Priority Queue signal flag */
60 #define LPFC_IO_FCP 4 /* FCP command -- iocbq in scsi_buf */
61 #define LPFC_DRIVER_ABORTED 8 /* driver aborted this request */
62 #define LPFC_IO_FABRIC 0x10 /* Iocb send using fabric scheduler */
63 #define LPFC_DELAY_MEM_FREE 0x20 /* Defer free'ing of FC data */
64 #define LPFC_EXCHANGE_BUSY 0x40 /* SLI4 hba reported XB in response */
65 #define LPFC_USE_FCPWQIDX 0x80 /* Submit to specified FCPWQ index */
66 #define DSS_SECURITY_OP 0x100 /* security IO */
68 #define LPFC_FIP_ELS_ID_MASK 0xc000 /* ELS_ID range 0-3, non-shifted mask */
69 #define LPFC_FIP_ELS_ID_SHIFT 14
72 uint32_t drvrTimeout; /* driver timeout in seconds */
73 uint32_t fcp_wqidx; /* index to FCP work queue */
74 struct lpfc_vport *vport;/* virtual port pointer */
75 void *context1; /* caller context information */
76 void *context2; /* caller context information */
77 void *context3; /* caller context information */
79 wait_queue_head_t *wait_queue;
80 struct lpfc_iocbq *rsp_iocb;
81 struct lpfcMboxq *mbox;
82 struct lpfc_nodelist *ndlp;
85 void (*fabric_iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
87 void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
91 #define SLI_IOCB_RET_IOCB 1 /* Return IOCB if cmd ring full */
93 #define IOCB_SUCCESS 0
96 #define IOCB_TIMEDOUT 3
98 #define LPFC_MBX_WAKE 1
99 #define LPFC_MBX_IMED_UNREG 2
101 typedef struct lpfcMboxq {
102 /* MBOXQs are used in single linked lists */
103 struct list_head list; /* ptr to next mailbox command */
105 MAILBOX_t mb; /* Mailbox cmd */
108 struct lpfc_vport *vport;/* virtual port pointer */
109 void *context1; /* caller context information */
110 void *context2; /* caller context information */
112 void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
114 uint16_t in_ext_byte_len;
115 uint16_t out_ext_byte_len;
116 uint8_t mbox_offset_word;
117 struct lpfc_mcqe mcqe;
118 struct lpfc_mbx_nembed_sge_virt *sge_array;
121 #define MBX_POLL 1 /* poll mailbox till command done, then
123 #define MBX_NOWAIT 2 /* issue command then return immediately */
125 #define LPFC_MAX_RING_MASK 5 /* max num of rctl/type masks allowed per
127 #define LPFC_MAX_RING 4 /* max num of SLI rings used by driver */
129 struct lpfc_sli_ring;
131 struct lpfc_sli_ring_mask {
132 uint8_t profile; /* profile associated with ring */
133 uint8_t rctl; /* rctl / type pair configured for ring */
134 uint8_t type; /* rctl / type pair configured for ring */
136 /* rcv'd unsol event */
137 void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
138 struct lpfc_sli_ring *,
139 struct lpfc_iocbq *);
143 /* Structure used to hold SLI statistical counters and info */
144 struct lpfc_sli_ring_stat {
145 uint64_t iocb_event; /* IOCB event counters */
146 uint64_t iocb_cmd; /* IOCB cmd issued */
147 uint64_t iocb_rsp; /* IOCB rsp received */
148 uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
149 uint64_t iocb_cmd_full; /* IOCB cmd ring full */
150 uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
151 uint64_t iocb_rsp_full; /* IOCB rsp ring full */
154 /* Structure used to hold SLI ring information */
155 struct lpfc_sli_ring {
156 uint16_t flag; /* ring flags */
157 #define LPFC_DEFERRED_RING_EVENT 0x001 /* Deferred processing a ring event */
158 #define LPFC_CALL_RING_AVAILABLE 0x002 /* indicates cmd was full */
159 #define LPFC_STOP_IOCB_EVENT 0x020 /* Stop processing IOCB cmds event */
160 uint16_t abtsiotag; /* tracks next iotag to use for ABTS */
162 uint32_t local_getidx; /* last available cmd index (from cmdGetInx) */
163 uint32_t next_cmdidx; /* next_cmd index */
164 uint32_t rspidx; /* current index in response ring */
165 uint32_t cmdidx; /* current index in command ring */
167 uint8_t ringno; /* ring number */
168 uint16_t numCiocb; /* number of command iocb's per ring */
169 uint16_t numRiocb; /* number of rsp iocb's per ring */
170 uint16_t sizeCiocb; /* Size of command iocb's in this ring */
171 uint16_t sizeRiocb; /* Size of response iocb's in this ring */
173 uint32_t fast_iotag; /* max fastlookup based iotag */
174 uint32_t iotag_ctr; /* keeps track of the next iotag to use */
175 uint32_t iotag_max; /* max iotag value to use */
176 struct list_head txq;
177 uint16_t txq_cnt; /* current length of queue */
178 uint16_t txq_max; /* max length */
179 struct list_head txcmplq;
180 uint16_t txcmplq_cnt; /* current length of queue */
181 uint16_t txcmplq_max; /* max length */
182 uint32_t *cmdringaddr; /* virtual address for cmd rings */
183 uint32_t *rspringaddr; /* virtual address for rsp rings */
184 uint32_t missbufcnt; /* keep track of buffers to post */
185 struct list_head postbufq;
186 uint16_t postbufq_cnt; /* current length of queue */
187 uint16_t postbufq_max; /* max length */
188 struct list_head iocb_continueq;
189 uint16_t iocb_continueq_cnt; /* current length of queue */
190 uint16_t iocb_continueq_max; /* max length */
191 struct list_head iocb_continue_saveq;
193 struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
194 uint32_t num_mask; /* number of mask entries in prt array */
195 void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
196 struct lpfc_sli_ring *, struct lpfc_iocbq *);
198 struct lpfc_sli_ring_stat stats; /* SLI statistical info */
200 /* cmd ring available */
201 void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
202 struct lpfc_sli_ring *);
205 /* Structure used for configuring rings to a specific profile or rctl / type */
206 struct lpfc_hbq_init {
207 uint32_t rn; /* Receive buffer notification */
208 uint32_t entry_count; /* max # of entries in HBQ */
209 uint32_t headerLen; /* 0 if not profile 4 or 5 */
210 uint32_t logEntry; /* Set to 1 if this HBQ used for LogEntry */
211 uint32_t profile; /* Selection profile 0=all, 7=logentry */
212 uint32_t ring_mask; /* Binds HBQ to a ring e.g. Ring0=b0001,
214 uint32_t hbq_index; /* index of this hbq in ring .HBQs[] */
220 uint32_t cmdmatch[8];
221 uint32_t mask_count; /* number of mask entries in prt array */
222 struct hbq_mask hbqMasks[6];
224 /* Non-config rings fields to keep track of buffer allocations */
225 uint32_t buffer_count; /* number of buffers allocated */
226 uint32_t init_count; /* number to allocate when initialized */
227 uint32_t add_count; /* number to allocate when starved */
230 /* Structure used to hold SLI statistical counters and info */
231 struct lpfc_sli_stat {
232 uint64_t mbox_stat_err; /* Mbox cmds completed status error */
233 uint64_t mbox_cmd; /* Mailbox commands issued */
234 uint64_t sli_intr; /* Count of Host Attention interrupts */
235 uint32_t err_attn_event; /* Error Attn event counters */
236 uint32_t link_event; /* Link event counters */
237 uint32_t mbox_event; /* Mailbox event counters */
238 uint32_t mbox_busy; /* Mailbox cmd busy */
241 /* Structure to store link status values when port stats are reset */
242 struct lpfc_lnk_stat {
243 uint32_t link_failure_count;
244 uint32_t loss_of_sync_count;
245 uint32_t loss_of_signal_count;
246 uint32_t prim_seq_protocol_err_count;
247 uint32_t invalid_tx_word_count;
248 uint32_t invalid_crc_count;
249 uint32_t error_frames;
250 uint32_t link_events;
253 /* Structure used to hold SLI information */
258 /* Additional sli_flags */
259 #define LPFC_SLI_MBOX_ACTIVE 0x100 /* HBA mailbox is currently active */
260 #define LPFC_SLI_ACTIVE 0x200 /* SLI in firmware is active */
261 #define LPFC_PROCESS_LA 0x400 /* Able to process link attention */
262 #define LPFC_BLOCK_MGMT_IO 0x800 /* Don't allow mgmt mbx or iocb cmds */
263 #define LPFC_MENLO_MAINT 0x1000 /* need for menl fw download */
264 #define LPFC_SLI_ASYNC_MBX_BLK 0x2000 /* Async mailbox is blocked */
266 struct lpfc_sli_ring ring[LPFC_MAX_RING];
267 int fcp_ring; /* ring used for FCP initiator commands */
270 int extra_ring; /* extra ring used for other protocols */
272 struct lpfc_sli_stat slistat; /* SLI statistical info */
273 struct list_head mboxq;
274 uint16_t mboxq_cnt; /* current length of queue */
275 uint16_t mboxq_max; /* max length */
276 LPFC_MBOXQ_t *mbox_active; /* active mboxq information */
277 struct list_head mboxq_cmpl;
279 struct timer_list mbox_tmo; /* Hold clk to timeout active mbox
282 #define LPFC_IOCBQ_LOOKUP_INCREMENT 1024
283 struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
284 size_t iocbq_lookup_len; /* current lengs of the array */
285 uint16_t last_iotag; /* last allocated IOTAG */
286 unsigned long stats_start; /* in seconds */
287 struct lpfc_lnk_stat lnk_stat_offsets;
290 #define LPFC_MBOX_TMO 30 /* Sec tmo for outstanding mbox
292 #define LPFC_MBOX_SLI4_CONFIG_TMO 60 /* Sec tmo for outstanding mbox
294 #define LPFC_MBOX_TMO_FLASH_CMD 300 /* Sec tmo for outstanding FLASH write
295 * or erase cmds. This is especially
296 * long because of the potential of
297 * multiple flash erases that can be