1 /*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
3 * Fibre Channel Host Bus Adapters. *
4 * Copyright (C) 2017-2018 Broadcom. All Rights Reserved. The term *
5 * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. *
6 * Copyright (C) 2004-2016 Emulex. All rights reserved. *
7 * EMULEX and SLI are trademarks of Emulex. *
10 * This program is free software; you can redistribute it and/or *
11 * modify it under the terms of version 2 of the GNU General *
12 * Public License as published by the Free Software Foundation. *
13 * This program is distributed in the hope that it will be useful. *
14 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND *
15 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, *
16 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE *
17 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
18 * TO BE LEGALLY INVALID. See the GNU General Public License for *
19 * more details, a copy of which can be found in the file COPYING *
20 * included with this package. *
21 *******************************************************************/
23 /* forward declaration for LPFC_IOCB_t's use */
27 /* Define the context types that SLI handles for abort and sums. */
28 typedef enum _lpfc_ctx_cmd {
34 struct lpfc_cq_event {
35 struct list_head list;
38 struct lpfc_mcqe mcqe_cmpl;
39 struct lpfc_acqe_link acqe_link;
40 struct lpfc_acqe_fip acqe_fip;
41 struct lpfc_acqe_dcbx acqe_dcbx;
42 struct lpfc_acqe_grp5 acqe_grp5;
43 struct lpfc_acqe_fc_la acqe_fc;
44 struct lpfc_acqe_sli acqe_sli;
45 struct lpfc_rcqe rcqe_cmpl;
46 struct sli4_wcqe_xri_aborted wcqe_axri;
47 struct lpfc_wcqe_complete wcqe_cmpl;
51 /* This structure is used to handle IOCB requests / responses */
53 /* lpfc_iocbqs are used in double linked lists */
54 struct list_head list;
55 struct list_head clist;
56 struct list_head dlist;
57 uint16_t iotag; /* pre-assigned IO tag */
58 uint16_t sli4_lxritag; /* logical pre-assigned XRI. */
59 uint16_t sli4_xritag; /* pre-assigned XRI, (OXID) tag. */
60 uint16_t hba_wqidx; /* index to HBA work queue */
61 struct lpfc_cq_event cq_event;
62 struct lpfc_wcqe_complete wcqe_cmpl; /* WQE cmpl */
63 uint64_t isr_timestamp;
65 union lpfc_wqe128 wqe; /* SLI-4 */
66 IOCB_t iocb; /* SLI-3 */
69 uint8_t priority; /* OAS priority */
70 uint8_t retry; /* retry counter for IOCB cmd - if needed */
72 #define LPFC_IO_LIBDFC 1 /* libdfc iocb */
73 #define LPFC_IO_WAKE 2 /* Synchronous I/O completed */
74 #define LPFC_IO_WAKE_TMO LPFC_IO_WAKE /* Synchronous I/O timed out */
75 #define LPFC_IO_FCP 4 /* FCP command -- iocbq in scsi_buf */
76 #define LPFC_DRIVER_ABORTED 8 /* driver aborted this request */
77 #define LPFC_IO_FABRIC 0x10 /* Iocb send using fabric scheduler */
78 #define LPFC_DELAY_MEM_FREE 0x20 /* Defer free'ing of FC data */
79 #define LPFC_EXCHANGE_BUSY 0x40 /* SLI4 hba reported XB in response */
80 #define LPFC_USE_FCPWQIDX 0x80 /* Submit to specified FCPWQ index */
81 #define DSS_SECURITY_OP 0x100 /* security IO */
82 #define LPFC_IO_ON_TXCMPLQ 0x200 /* The IO is still on the TXCMPLQ */
83 #define LPFC_IO_DIF_PASS 0x400 /* T10 DIF IO pass-thru prot */
84 #define LPFC_IO_DIF_STRIP 0x800 /* T10 DIF IO strip prot */
85 #define LPFC_IO_DIF_INSERT 0x1000 /* T10 DIF IO insert prot */
86 #define LPFC_IO_CMD_OUTSTANDING 0x2000 /* timeout handler abort window */
88 #define LPFC_FIP_ELS_ID_MASK 0xc000 /* ELS_ID range 0-3, non-shifted mask */
89 #define LPFC_FIP_ELS_ID_SHIFT 14
91 #define LPFC_IO_OAS 0x10000 /* OAS FCP IO */
92 #define LPFC_IO_FOF 0x20000 /* FOF FCP IO */
93 #define LPFC_IO_LOOPBACK 0x40000 /* Loopback IO */
94 #define LPFC_PRLI_NVME_REQ 0x80000 /* This is an NVME PRLI. */
95 #define LPFC_PRLI_FCP_REQ 0x100000 /* This is an NVME PRLI. */
96 #define LPFC_IO_NVME 0x200000 /* NVME FCP command */
97 #define LPFC_IO_NVME_LS 0x400000 /* NVME LS command */
98 #define LPFC_IO_NVMET 0x800000 /* NVMET command */
100 uint32_t drvrTimeout; /* driver timeout in seconds */
101 struct lpfc_vport *vport;/* virtual port pointer */
102 void *context1; /* caller context information */
103 void *context2; /* caller context information */
104 void *context3; /* caller context information */
106 wait_queue_head_t *wait_queue;
107 struct lpfc_iocbq *rsp_iocb;
108 struct lpfcMboxq *mbox;
109 struct lpfc_nodelist *ndlp;
110 struct lpfc_node_rrq *rrq;
113 void (*fabric_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
114 struct lpfc_iocbq *);
115 void (*wait_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
116 struct lpfc_iocbq *);
117 void (*iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
118 struct lpfc_iocbq *);
119 void (*wqe_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
120 struct lpfc_wcqe_complete *);
123 #define SLI_IOCB_RET_IOCB 1 /* Return IOCB if cmd ring full */
125 #define IOCB_SUCCESS 0
128 #define IOCB_TIMEDOUT 3
130 #define SLI_WQE_RET_WQE 1 /* Return WQE if cmd ring full */
132 #define WQE_SUCCESS 0
135 #define WQE_TIMEDOUT 3
136 #define WQE_ABORTED 4
138 #define LPFC_MBX_WAKE 1
139 #define LPFC_MBX_IMED_UNREG 2
141 typedef struct lpfcMboxq {
142 /* MBOXQs are used in single linked lists */
143 struct list_head list; /* ptr to next mailbox command */
145 MAILBOX_t mb; /* Mailbox cmd */
148 struct lpfc_vport *vport; /* virtual port pointer */
149 void *ctx_ndlp; /* caller ndlp information */
150 void *ctx_buf; /* caller buffer information */
153 void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
155 uint16_t in_ext_byte_len;
156 uint16_t out_ext_byte_len;
157 uint8_t mbox_offset_word;
158 struct lpfc_mcqe mcqe;
159 struct lpfc_mbx_nembed_sge_virt *sge_array;
162 #define MBX_POLL 1 /* poll mailbox till command done, then
164 #define MBX_NOWAIT 2 /* issue command then return immediately */
166 #define LPFC_MAX_RING_MASK 5 /* max num of rctl/type masks allowed per
168 #define LPFC_SLI3_MAX_RING 4 /* Max num of SLI3 rings used by driver.
169 For SLI4, an additional ring for each
170 FCP WQ will be allocated. */
172 struct lpfc_sli_ring;
174 struct lpfc_sli_ring_mask {
175 uint8_t profile; /* profile associated with ring */
176 uint8_t rctl; /* rctl / type pair configured for ring */
177 uint8_t type; /* rctl / type pair configured for ring */
179 /* rcv'd unsol event */
180 void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
181 struct lpfc_sli_ring *,
182 struct lpfc_iocbq *);
186 /* Structure used to hold SLI statistical counters and info */
187 struct lpfc_sli_ring_stat {
188 uint64_t iocb_event; /* IOCB event counters */
189 uint64_t iocb_cmd; /* IOCB cmd issued */
190 uint64_t iocb_rsp; /* IOCB rsp received */
191 uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
192 uint64_t iocb_cmd_full; /* IOCB cmd ring full */
193 uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
194 uint64_t iocb_rsp_full; /* IOCB rsp ring full */
197 struct lpfc_sli3_ring {
198 uint32_t local_getidx; /* last available cmd index (from cmdGetInx) */
199 uint32_t next_cmdidx; /* next_cmd index */
200 uint32_t rspidx; /* current index in response ring */
201 uint32_t cmdidx; /* current index in command ring */
202 uint16_t numCiocb; /* number of command iocb's per ring */
203 uint16_t numRiocb; /* number of rsp iocb's per ring */
204 uint16_t sizeCiocb; /* Size of command iocb's in this ring */
205 uint16_t sizeRiocb; /* Size of response iocb's in this ring */
206 uint32_t *cmdringaddr; /* virtual address for cmd rings */
207 uint32_t *rspringaddr; /* virtual address for rsp rings */
210 struct lpfc_sli4_ring {
211 struct lpfc_queue *wqp; /* Pointer to associated WQ */
215 /* Structure used to hold SLI ring information */
216 struct lpfc_sli_ring {
217 uint16_t flag; /* ring flags */
218 #define LPFC_DEFERRED_RING_EVENT 0x001 /* Deferred processing a ring event */
219 #define LPFC_CALL_RING_AVAILABLE 0x002 /* indicates cmd was full */
220 #define LPFC_STOP_IOCB_EVENT 0x020 /* Stop processing IOCB cmds event */
221 uint16_t abtsiotag; /* tracks next iotag to use for ABTS */
224 uint8_t ringno; /* ring number */
226 spinlock_t ring_lock; /* lock for issuing commands */
228 uint32_t fast_iotag; /* max fastlookup based iotag */
229 uint32_t iotag_ctr; /* keeps track of the next iotag to use */
230 uint32_t iotag_max; /* max iotag value to use */
231 struct list_head txq;
232 uint16_t txq_cnt; /* current length of queue */
233 uint16_t txq_max; /* max length */
234 struct list_head txcmplq;
235 uint16_t txcmplq_cnt; /* current length of queue */
236 uint16_t txcmplq_max; /* max length */
237 uint32_t missbufcnt; /* keep track of buffers to post */
238 struct list_head postbufq;
239 uint16_t postbufq_cnt; /* current length of queue */
240 uint16_t postbufq_max; /* max length */
241 struct list_head iocb_continueq;
242 uint16_t iocb_continueq_cnt; /* current length of queue */
243 uint16_t iocb_continueq_max; /* max length */
244 struct list_head iocb_continue_saveq;
246 struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
247 uint32_t num_mask; /* number of mask entries in prt array */
248 void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
249 struct lpfc_sli_ring *, struct lpfc_iocbq *);
251 struct lpfc_sli_ring_stat stats; /* SLI statistical info */
253 /* cmd ring available */
254 void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
255 struct lpfc_sli_ring *);
257 struct lpfc_sli3_ring sli3;
258 struct lpfc_sli4_ring sli4;
262 /* Structure used for configuring rings to a specific profile or rctl / type */
263 struct lpfc_hbq_init {
264 uint32_t rn; /* Receive buffer notification */
265 uint32_t entry_count; /* max # of entries in HBQ */
266 uint32_t headerLen; /* 0 if not profile 4 or 5 */
267 uint32_t logEntry; /* Set to 1 if this HBQ used for LogEntry */
268 uint32_t profile; /* Selection profile 0=all, 7=logentry */
269 uint32_t ring_mask; /* Binds HBQ to a ring e.g. Ring0=b0001,
271 uint32_t hbq_index; /* index of this hbq in ring .HBQs[] */
277 uint32_t cmdmatch[8];
278 uint32_t mask_count; /* number of mask entries in prt array */
279 struct hbq_mask hbqMasks[6];
281 /* Non-config rings fields to keep track of buffer allocations */
282 uint32_t buffer_count; /* number of buffers allocated */
283 uint32_t init_count; /* number to allocate when initialized */
284 uint32_t add_count; /* number to allocate when starved */
287 /* Structure used to hold SLI statistical counters and info */
288 struct lpfc_sli_stat {
289 uint64_t mbox_stat_err; /* Mbox cmds completed status error */
290 uint64_t mbox_cmd; /* Mailbox commands issued */
291 uint64_t sli_intr; /* Count of Host Attention interrupts */
292 uint64_t sli_prev_intr; /* Previous cnt of Host Attention interrupts */
293 uint64_t sli_ips; /* Host Attention interrupts per sec */
294 uint32_t err_attn_event; /* Error Attn event counters */
295 uint32_t link_event; /* Link event counters */
296 uint32_t mbox_event; /* Mailbox event counters */
297 uint32_t mbox_busy; /* Mailbox cmd busy */
300 /* Structure to store link status values when port stats are reset */
301 struct lpfc_lnk_stat {
302 uint32_t link_failure_count;
303 uint32_t loss_of_sync_count;
304 uint32_t loss_of_signal_count;
305 uint32_t prim_seq_protocol_err_count;
306 uint32_t invalid_tx_word_count;
307 uint32_t invalid_crc_count;
308 uint32_t error_frames;
309 uint32_t link_events;
312 /* Structure used to hold SLI information */
317 /* Additional sli_flags */
318 #define LPFC_SLI_MBOX_ACTIVE 0x100 /* HBA mailbox is currently active */
319 #define LPFC_SLI_ACTIVE 0x200 /* SLI in firmware is active */
320 #define LPFC_PROCESS_LA 0x400 /* Able to process link attention */
321 #define LPFC_BLOCK_MGMT_IO 0x800 /* Don't allow mgmt mbx or iocb cmds */
322 #define LPFC_MENLO_MAINT 0x1000 /* need for menl fw download */
323 #define LPFC_SLI_ASYNC_MBX_BLK 0x2000 /* Async mailbox is blocked */
324 #define LPFC_SLI_SUPPRESS_RSP 0x4000 /* Suppress RSP feature is supported */
325 #define LPFC_SLI_USE_EQDR 0x8000 /* EQ Delay Register is supported */
327 struct lpfc_sli_ring *sli3_ring;
329 struct lpfc_sli_stat slistat; /* SLI statistical info */
330 struct list_head mboxq;
331 uint16_t mboxq_cnt; /* current length of queue */
332 uint16_t mboxq_max; /* max length */
333 LPFC_MBOXQ_t *mbox_active; /* active mboxq information */
334 struct list_head mboxq_cmpl;
336 struct timer_list mbox_tmo; /* Hold clk to timeout active mbox
339 #define LPFC_IOCBQ_LOOKUP_INCREMENT 1024
340 struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
341 size_t iocbq_lookup_len; /* current lengs of the array */
342 uint16_t last_iotag; /* last allocated IOTAG */
343 time64_t stats_start; /* in seconds */
344 struct lpfc_lnk_stat lnk_stat_offsets;
347 /* Timeout for normal outstanding mbox command (Seconds) */
348 #define LPFC_MBOX_TMO 30
349 /* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
350 #define LPFC_MBOX_SLI4_CONFIG_TMO 60
351 /* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
352 #define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO 300
353 /* Timeout for other flash-based outstanding mbox command (Seconds) */
354 #define LPFC_MBOX_TMO_FLASH_CMD 300