1 /*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
3 * Fibre Channel Host Bus Adapters. *
4 * Copyright (C) 2004-2016 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 uint16_t hba_wqidx
; /* index to HBA work queue */
58 struct lpfc_cq_event cq_event
;
59 struct lpfc_wcqe_complete wcqe_cmpl
; /* WQE cmpl */
60 uint64_t isr_timestamp
;
63 union lpfc_wqe wqe
; /* WQE cmd */
64 IOCB_t iocb
; /* For IOCB cmd or if we want 128 byte WQE */
67 uint8_t priority
; /* OAS priority */
68 uint8_t retry
; /* retry counter for IOCB cmd - if needed */
70 #define LPFC_IO_LIBDFC 1 /* libdfc iocb */
71 #define LPFC_IO_WAKE 2 /* Synchronous I/O completed */
72 #define LPFC_IO_WAKE_TMO LPFC_IO_WAKE /* Synchronous I/O timed out */
73 #define LPFC_IO_FCP 4 /* FCP command -- iocbq in scsi_buf */
74 #define LPFC_DRIVER_ABORTED 8 /* driver aborted this request */
75 #define LPFC_IO_FABRIC 0x10 /* Iocb send using fabric scheduler */
76 #define LPFC_DELAY_MEM_FREE 0x20 /* Defer free'ing of FC data */
77 #define LPFC_EXCHANGE_BUSY 0x40 /* SLI4 hba reported XB in response */
78 #define LPFC_USE_FCPWQIDX 0x80 /* Submit to specified FCPWQ index */
79 #define DSS_SECURITY_OP 0x100 /* security IO */
80 #define LPFC_IO_ON_TXCMPLQ 0x200 /* The IO is still on the TXCMPLQ */
81 #define LPFC_IO_DIF_PASS 0x400 /* T10 DIF IO pass-thru prot */
82 #define LPFC_IO_DIF_STRIP 0x800 /* T10 DIF IO strip prot */
83 #define LPFC_IO_DIF_INSERT 0x1000 /* T10 DIF IO insert prot */
84 #define LPFC_IO_CMD_OUTSTANDING 0x2000 /* timeout handler abort window */
86 #define LPFC_FIP_ELS_ID_MASK 0xc000 /* ELS_ID range 0-3, non-shifted mask */
87 #define LPFC_FIP_ELS_ID_SHIFT 14
89 #define LPFC_IO_OAS 0x10000 /* OAS FCP IO */
90 #define LPFC_IO_FOF 0x20000 /* FOF FCP IO */
91 #define LPFC_IO_LOOPBACK 0x40000 /* Loopback IO */
92 #define LPFC_PRLI_NVME_REQ 0x80000 /* This is an NVME PRLI. */
93 #define LPFC_PRLI_FCP_REQ 0x100000 /* This is an NVME PRLI. */
94 #define LPFC_IO_NVME 0x200000 /* NVME FCP command */
95 #define LPFC_IO_NVME_LS 0x400000 /* NVME LS command */
96 #define LPFC_IO_NVMET 0x800000 /* NVMET command */
98 uint32_t drvrTimeout
; /* driver timeout in seconds */
99 struct lpfc_vport
*vport
;/* virtual port pointer */
100 void *context1
; /* caller context information */
101 void *context2
; /* caller context information */
102 void *context3
; /* caller context information */
104 wait_queue_head_t
*wait_queue
;
105 struct lpfc_iocbq
*rsp_iocb
;
106 struct lpfcMboxq
*mbox
;
107 struct lpfc_nodelist
*ndlp
;
108 struct lpfc_node_rrq
*rrq
;
111 void (*fabric_iocb_cmpl
)(struct lpfc_hba
*, struct lpfc_iocbq
*,
112 struct lpfc_iocbq
*);
113 void (*wait_iocb_cmpl
)(struct lpfc_hba
*, struct lpfc_iocbq
*,
114 struct lpfc_iocbq
*);
115 void (*iocb_cmpl
)(struct lpfc_hba
*, struct lpfc_iocbq
*,
116 struct lpfc_iocbq
*);
117 void (*wqe_cmpl
)(struct lpfc_hba
*, struct lpfc_iocbq
*,
118 struct lpfc_wcqe_complete
*);
121 #define SLI_IOCB_RET_IOCB 1 /* Return IOCB if cmd ring full */
123 #define IOCB_SUCCESS 0
126 #define IOCB_TIMEDOUT 3
128 #define SLI_WQE_RET_WQE 1 /* Return WQE if cmd ring full */
130 #define WQE_SUCCESS 0
133 #define WQE_TIMEDOUT 3
134 #define WQE_ABORTED 4
136 #define LPFC_MBX_WAKE 1
137 #define LPFC_MBX_IMED_UNREG 2
139 typedef struct lpfcMboxq
{
140 /* MBOXQs are used in single linked lists */
141 struct list_head list
; /* ptr to next mailbox command */
143 MAILBOX_t mb
; /* Mailbox cmd */
146 struct lpfc_vport
*vport
;/* virtual port pointer */
147 void *context1
; /* caller context information */
148 void *context2
; /* caller context information */
150 void (*mbox_cmpl
) (struct lpfc_hba
*, struct lpfcMboxq
*);
152 uint16_t in_ext_byte_len
;
153 uint16_t out_ext_byte_len
;
154 uint8_t mbox_offset_word
;
155 struct lpfc_mcqe mcqe
;
156 struct lpfc_mbx_nembed_sge_virt
*sge_array
;
159 #define MBX_POLL 1 /* poll mailbox till command done, then
161 #define MBX_NOWAIT 2 /* issue command then return immediately */
163 #define LPFC_MAX_RING_MASK 5 /* max num of rctl/type masks allowed per
165 #define LPFC_SLI3_MAX_RING 4 /* Max num of SLI3 rings used by driver.
166 For SLI4, an additional ring for each
167 FCP WQ will be allocated. */
169 struct lpfc_sli_ring
;
171 struct lpfc_sli_ring_mask
{
172 uint8_t profile
; /* profile associated with ring */
173 uint8_t rctl
; /* rctl / type pair configured for ring */
174 uint8_t type
; /* rctl / type pair configured for ring */
176 /* rcv'd unsol event */
177 void (*lpfc_sli_rcv_unsol_event
) (struct lpfc_hba
*,
178 struct lpfc_sli_ring
*,
179 struct lpfc_iocbq
*);
183 /* Structure used to hold SLI statistical counters and info */
184 struct lpfc_sli_ring_stat
{
185 uint64_t iocb_event
; /* IOCB event counters */
186 uint64_t iocb_cmd
; /* IOCB cmd issued */
187 uint64_t iocb_rsp
; /* IOCB rsp received */
188 uint64_t iocb_cmd_delay
; /* IOCB cmd ring delay */
189 uint64_t iocb_cmd_full
; /* IOCB cmd ring full */
190 uint64_t iocb_cmd_empty
; /* IOCB cmd ring is now empty */
191 uint64_t iocb_rsp_full
; /* IOCB rsp ring full */
194 struct lpfc_sli3_ring
{
195 uint32_t local_getidx
; /* last available cmd index (from cmdGetInx) */
196 uint32_t next_cmdidx
; /* next_cmd index */
197 uint32_t rspidx
; /* current index in response ring */
198 uint32_t cmdidx
; /* current index in command ring */
199 uint16_t numCiocb
; /* number of command iocb's per ring */
200 uint16_t numRiocb
; /* number of rsp iocb's per ring */
201 uint16_t sizeCiocb
; /* Size of command iocb's in this ring */
202 uint16_t sizeRiocb
; /* Size of response iocb's in this ring */
203 uint32_t *cmdringaddr
; /* virtual address for cmd rings */
204 uint32_t *rspringaddr
; /* virtual address for rsp rings */
207 struct lpfc_sli4_ring
{
208 struct lpfc_queue
*wqp
; /* Pointer to associated WQ */
212 /* Structure used to hold SLI ring information */
213 struct lpfc_sli_ring
{
214 uint16_t flag
; /* ring flags */
215 #define LPFC_DEFERRED_RING_EVENT 0x001 /* Deferred processing a ring event */
216 #define LPFC_CALL_RING_AVAILABLE 0x002 /* indicates cmd was full */
217 #define LPFC_STOP_IOCB_EVENT 0x020 /* Stop processing IOCB cmds event */
218 uint16_t abtsiotag
; /* tracks next iotag to use for ABTS */
221 uint8_t ringno
; /* ring number */
223 spinlock_t ring_lock
; /* lock for issuing commands */
225 uint32_t fast_iotag
; /* max fastlookup based iotag */
226 uint32_t iotag_ctr
; /* keeps track of the next iotag to use */
227 uint32_t iotag_max
; /* max iotag value to use */
228 struct list_head txq
;
229 uint16_t txq_cnt
; /* current length of queue */
230 uint16_t txq_max
; /* max length */
231 struct list_head txcmplq
;
232 uint16_t txcmplq_cnt
; /* current length of queue */
233 uint16_t txcmplq_max
; /* max length */
234 uint32_t missbufcnt
; /* keep track of buffers to post */
235 struct list_head postbufq
;
236 uint16_t postbufq_cnt
; /* current length of queue */
237 uint16_t postbufq_max
; /* max length */
238 struct list_head iocb_continueq
;
239 uint16_t iocb_continueq_cnt
; /* current length of queue */
240 uint16_t iocb_continueq_max
; /* max length */
241 struct list_head iocb_continue_saveq
;
243 struct lpfc_sli_ring_mask prt
[LPFC_MAX_RING_MASK
];
244 uint32_t num_mask
; /* number of mask entries in prt array */
245 void (*lpfc_sli_rcv_async_status
) (struct lpfc_hba
*,
246 struct lpfc_sli_ring
*, struct lpfc_iocbq
*);
248 struct lpfc_sli_ring_stat stats
; /* SLI statistical info */
250 /* cmd ring available */
251 void (*lpfc_sli_cmd_available
) (struct lpfc_hba
*,
252 struct lpfc_sli_ring
*);
254 struct lpfc_sli3_ring sli3
;
255 struct lpfc_sli4_ring sli4
;
259 /* Structure used for configuring rings to a specific profile or rctl / type */
260 struct lpfc_hbq_init
{
261 uint32_t rn
; /* Receive buffer notification */
262 uint32_t entry_count
; /* max # of entries in HBQ */
263 uint32_t headerLen
; /* 0 if not profile 4 or 5 */
264 uint32_t logEntry
; /* Set to 1 if this HBQ used for LogEntry */
265 uint32_t profile
; /* Selection profile 0=all, 7=logentry */
266 uint32_t ring_mask
; /* Binds HBQ to a ring e.g. Ring0=b0001,
268 uint32_t hbq_index
; /* index of this hbq in ring .HBQs[] */
274 uint32_t cmdmatch
[8];
275 uint32_t mask_count
; /* number of mask entries in prt array */
276 struct hbq_mask hbqMasks
[6];
278 /* Non-config rings fields to keep track of buffer allocations */
279 uint32_t buffer_count
; /* number of buffers allocated */
280 uint32_t init_count
; /* number to allocate when initialized */
281 uint32_t add_count
; /* number to allocate when starved */
284 /* Structure used to hold SLI statistical counters and info */
285 struct lpfc_sli_stat
{
286 uint64_t mbox_stat_err
; /* Mbox cmds completed status error */
287 uint64_t mbox_cmd
; /* Mailbox commands issued */
288 uint64_t sli_intr
; /* Count of Host Attention interrupts */
289 uint64_t sli_prev_intr
; /* Previous cnt of Host Attention interrupts */
290 uint64_t sli_ips
; /* Host Attention interrupts per sec */
291 uint32_t err_attn_event
; /* Error Attn event counters */
292 uint32_t link_event
; /* Link event counters */
293 uint32_t mbox_event
; /* Mailbox event counters */
294 uint32_t mbox_busy
; /* Mailbox cmd busy */
297 /* Structure to store link status values when port stats are reset */
298 struct lpfc_lnk_stat
{
299 uint32_t link_failure_count
;
300 uint32_t loss_of_sync_count
;
301 uint32_t loss_of_signal_count
;
302 uint32_t prim_seq_protocol_err_count
;
303 uint32_t invalid_tx_word_count
;
304 uint32_t invalid_crc_count
;
305 uint32_t error_frames
;
306 uint32_t link_events
;
309 /* Structure used to hold SLI information */
314 /* Additional sli_flags */
315 #define LPFC_SLI_MBOX_ACTIVE 0x100 /* HBA mailbox is currently active */
316 #define LPFC_SLI_ACTIVE 0x200 /* SLI in firmware is active */
317 #define LPFC_PROCESS_LA 0x400 /* Able to process link attention */
318 #define LPFC_BLOCK_MGMT_IO 0x800 /* Don't allow mgmt mbx or iocb cmds */
319 #define LPFC_MENLO_MAINT 0x1000 /* need for menl fw download */
320 #define LPFC_SLI_ASYNC_MBX_BLK 0x2000 /* Async mailbox is blocked */
321 #define LPFC_SLI_SUPPRESS_RSP 0x4000 /* Suppress RSP feature is supported */
323 struct lpfc_sli_ring
*sli3_ring
;
325 struct lpfc_sli_stat slistat
; /* SLI statistical info */
326 struct list_head mboxq
;
327 uint16_t mboxq_cnt
; /* current length of queue */
328 uint16_t mboxq_max
; /* max length */
329 LPFC_MBOXQ_t
*mbox_active
; /* active mboxq information */
330 struct list_head mboxq_cmpl
;
332 struct timer_list mbox_tmo
; /* Hold clk to timeout active mbox
335 #define LPFC_IOCBQ_LOOKUP_INCREMENT 1024
336 struct lpfc_iocbq
** iocbq_lookup
; /* array to lookup IOCB by IOTAG */
337 size_t iocbq_lookup_len
; /* current lengs of the array */
338 uint16_t last_iotag
; /* last allocated IOTAG */
339 unsigned long stats_start
; /* in seconds */
340 struct lpfc_lnk_stat lnk_stat_offsets
;
343 /* Timeout for normal outstanding mbox command (Seconds) */
344 #define LPFC_MBOX_TMO 30
345 /* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
346 #define LPFC_MBOX_SLI4_CONFIG_TMO 60
347 /* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
348 #define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO 300
349 /* Timeout for other flash-based outstanding mbox command (Seconds) */
350 #define LPFC_MBOX_TMO_FLASH_CMD 300