1 /*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
3 * Fibre Channel Host Bus Adapters. *
4 * Copyright (C) 2017-2023 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 #if defined(CONFIG_DEBUG_FS) && !defined(CONFIG_SCSI_LPFC_DEBUG_FS)
24 #define CONFIG_SCSI_LPFC_DEBUG_FS
27 /* forward declaration for LPFC_IOCB_t's use */
31 /* Define the context types that SLI handles for abort and sums. */
32 typedef enum _lpfc_ctx_cmd {
38 /* Enumeration to describe the thread lock context. */
47 struct lpfc_vmid_context *vmid_context; /* UVEM context information */
50 struct lpfc_cq_event {
51 struct list_head list;
54 struct lpfc_mcqe mcqe_cmpl;
55 struct lpfc_acqe_link acqe_link;
56 struct lpfc_acqe_fip acqe_fip;
57 struct lpfc_acqe_dcbx acqe_dcbx;
58 struct lpfc_acqe_grp5 acqe_grp5;
59 struct lpfc_acqe_fc_la acqe_fc;
60 struct lpfc_acqe_sli acqe_sli;
61 struct lpfc_rcqe rcqe_cmpl;
62 struct sli4_wcqe_xri_aborted wcqe_axri;
63 struct lpfc_wcqe_complete wcqe_cmpl;
67 /* This structure is used to handle IOCB requests / responses */
69 /* lpfc_iocbqs are used in double linked lists */
70 struct list_head list;
71 struct list_head clist;
72 struct list_head dlist;
73 uint16_t iotag; /* pre-assigned IO tag */
74 uint16_t sli4_lxritag; /* logical pre-assigned XRI. */
75 uint16_t sli4_xritag; /* pre-assigned XRI, (OXID) tag. */
76 uint16_t hba_wqidx; /* index to HBA work queue */
77 struct lpfc_cq_event cq_event;
78 uint64_t isr_timestamp;
80 union lpfc_wqe128 wqe; /* SLI-4 */
81 IOCB_t iocb; /* SLI-3 */
82 struct lpfc_wcqe_complete wcqe_cmpl; /* WQE cmpl */
84 u32 unsol_rcv_len; /* Receive len in usol path */
86 /* Pack the u8's together and make them module-4. */
87 u8 num_bdes; /* Number of BDEs */
88 u8 abort_bls; /* ABTS by initiator or responder */
89 u8 abort_rctl; /* ACC or RJT flag */
90 u8 priority; /* OAS priority */
91 u8 retry; /* retry counter for IOCB cmd - if needed */
92 u8 rsvd1; /* Pad for u32 */
93 u8 rsvd2; /* Pad for u32 */
94 u8 rsvd3; /* Pad for u32 */
97 #define LPFC_IO_LIBDFC 1 /* libdfc iocb */
98 #define LPFC_IO_WAKE 2 /* Synchronous I/O completed */
99 #define LPFC_IO_WAKE_TMO LPFC_IO_WAKE /* Synchronous I/O timed out */
100 #define LPFC_IO_FCP 4 /* FCP command -- iocbq in scsi_buf */
101 #define LPFC_DRIVER_ABORTED 8 /* driver aborted this request */
102 #define LPFC_IO_FABRIC 0x10 /* Iocb send using fabric scheduler */
103 #define LPFC_DELAY_MEM_FREE 0x20 /* Defer free'ing of FC data */
104 #define LPFC_EXCHANGE_BUSY 0x40 /* SLI4 hba reported XB in response */
105 #define LPFC_USE_FCPWQIDX 0x80 /* Submit to specified FCPWQ index */
106 #define DSS_SECURITY_OP 0x100 /* security IO */
107 #define LPFC_IO_ON_TXCMPLQ 0x200 /* The IO is still on the TXCMPLQ */
108 #define LPFC_IO_DIF_PASS 0x400 /* T10 DIF IO pass-thru prot */
109 #define LPFC_IO_DIF_STRIP 0x800 /* T10 DIF IO strip prot */
110 #define LPFC_IO_DIF_INSERT 0x1000 /* T10 DIF IO insert prot */
111 #define LPFC_IO_CMD_OUTSTANDING 0x2000 /* timeout handler abort window */
113 #define LPFC_FIP_ELS_ID_MASK 0xc000 /* ELS_ID range 0-3, non-shifted mask */
114 #define LPFC_FIP_ELS_ID_SHIFT 14
116 #define LPFC_IO_OAS 0x10000 /* OAS FCP IO */
117 #define LPFC_IO_FOF 0x20000 /* FOF FCP IO */
118 #define LPFC_IO_LOOPBACK 0x40000 /* Loopback IO */
119 #define LPFC_PRLI_NVME_REQ 0x80000 /* This is an NVME PRLI. */
120 #define LPFC_PRLI_FCP_REQ 0x100000 /* This is an NVME PRLI. */
121 #define LPFC_IO_NVME 0x200000 /* NVME FCP command */
122 #define LPFC_IO_NVME_LS 0x400000 /* NVME LS command */
123 #define LPFC_IO_NVMET 0x800000 /* NVMET command */
124 #define LPFC_IO_VMID 0x1000000 /* VMID tagged IO */
125 #define LPFC_IO_CMF 0x4000000 /* CMF command */
127 uint32_t drvrTimeout; /* driver timeout in seconds */
128 struct lpfc_vport *vport;/* virtual port pointer */
129 struct lpfc_dmabuf *cmd_dmabuf;
130 struct lpfc_dmabuf *rsp_dmabuf;
131 struct lpfc_dmabuf *bpl_dmabuf;
132 uint32_t event_tag; /* LA Event tag */
134 wait_queue_head_t *wait_queue;
135 struct lpfcMboxq *mbox;
136 struct lpfc_node_rrq *rrq;
137 struct nvmefc_ls_req *nvme_lsreq;
138 struct lpfc_async_xchg_ctx *axchg;
139 struct bsg_job_data *dd_data;
142 struct lpfc_io_buf *io_buf;
143 struct lpfc_iocbq *rsp_iocb;
144 struct lpfc_nodelist *ndlp;
145 union lpfc_vmid_tag vmid_tag;
146 void (*fabric_cmd_cmpl)(struct lpfc_hba *phba, struct lpfc_iocbq *cmd,
147 struct lpfc_iocbq *rsp);
148 void (*wait_cmd_cmpl)(struct lpfc_hba *phba, struct lpfc_iocbq *cmd,
149 struct lpfc_iocbq *rsp);
150 void (*cmd_cmpl)(struct lpfc_hba *phba, struct lpfc_iocbq *cmd,
151 struct lpfc_iocbq *rsp);
154 #define SLI_IOCB_RET_IOCB 1 /* Return IOCB if cmd ring full */
156 #define IOCB_SUCCESS 0
159 #define IOCB_TIMEDOUT 3
160 #define IOCB_ABORTED 4
161 #define IOCB_ABORTING 5
162 #define IOCB_NORESOURCE 6
164 #define SLI_WQE_RET_WQE 1 /* Return WQE if cmd ring full */
166 #define WQE_SUCCESS 0
169 #define WQE_TIMEDOUT 3
170 #define WQE_ABORTED 4
171 #define WQE_ABORTING 5
172 #define WQE_NORESOURCE 6
174 #define LPFC_MBX_WAKE 1
175 #define LPFC_MBX_IMED_UNREG 2
177 typedef struct lpfcMboxq {
178 /* MBOXQs are used in single linked lists */
179 struct list_head list; /* ptr to next mailbox command */
181 MAILBOX_t mb; /* Mailbox cmd */
184 struct lpfc_vport *vport; /* virtual port pointer */
185 void *ctx_ndlp; /* an lpfc_nodelist pointer */
186 void *ctx_buf; /* an lpfc_dmabuf pointer */
187 void *context3; /* a generic pointer. Code must
188 * accommodate the actual datatype.
191 void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
193 uint16_t in_ext_byte_len;
194 uint16_t out_ext_byte_len;
195 uint8_t mbox_offset_word;
196 struct lpfc_mcqe mcqe;
197 struct lpfc_mbx_nembed_sge_virt *sge_array;
200 #define MBX_POLL 1 /* poll mailbox till command done, then
202 #define MBX_NOWAIT 2 /* issue command then return immediately */
204 #define LPFC_MAX_RING_MASK 5 /* max num of rctl/type masks allowed per
206 #define LPFC_SLI3_MAX_RING 4 /* Max num of SLI3 rings used by driver.
207 For SLI4, an additional ring for each
208 FCP WQ will be allocated. */
210 struct lpfc_sli_ring;
212 struct lpfc_sli_ring_mask {
213 uint8_t profile; /* profile associated with ring */
214 uint8_t rctl; /* rctl / type pair configured for ring */
215 uint8_t type; /* rctl / type pair configured for ring */
217 /* rcv'd unsol event */
218 void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
219 struct lpfc_sli_ring *,
220 struct lpfc_iocbq *);
224 /* Structure used to hold SLI statistical counters and info */
225 struct lpfc_sli_ring_stat {
226 uint64_t iocb_event; /* IOCB event counters */
227 uint64_t iocb_cmd; /* IOCB cmd issued */
228 uint64_t iocb_rsp; /* IOCB rsp received */
229 uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
230 uint64_t iocb_cmd_full; /* IOCB cmd ring full */
231 uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
232 uint64_t iocb_rsp_full; /* IOCB rsp ring full */
235 struct lpfc_sli3_ring {
236 uint32_t local_getidx; /* last available cmd index (from cmdGetInx) */
237 uint32_t next_cmdidx; /* next_cmd index */
238 uint32_t rspidx; /* current index in response ring */
239 uint32_t cmdidx; /* current index in command ring */
240 uint16_t numCiocb; /* number of command iocb's per ring */
241 uint16_t numRiocb; /* number of rsp iocb's per ring */
242 uint16_t sizeCiocb; /* Size of command iocb's in this ring */
243 uint16_t sizeRiocb; /* Size of response iocb's in this ring */
244 uint32_t *cmdringaddr; /* virtual address for cmd rings */
245 uint32_t *rspringaddr; /* virtual address for rsp rings */
248 struct lpfc_sli4_ring {
249 struct lpfc_queue *wqp; /* Pointer to associated WQ */
253 /* Structure used to hold SLI ring information */
254 struct lpfc_sli_ring {
255 uint16_t flag; /* ring flags */
256 #define LPFC_DEFERRED_RING_EVENT 0x001 /* Deferred processing a ring event */
257 #define LPFC_CALL_RING_AVAILABLE 0x002 /* indicates cmd was full */
258 #define LPFC_STOP_IOCB_EVENT 0x020 /* Stop processing IOCB cmds event */
259 uint16_t abtsiotag; /* tracks next iotag to use for ABTS */
262 uint8_t ringno; /* ring number */
264 spinlock_t ring_lock; /* lock for issuing commands */
266 uint32_t fast_iotag; /* max fastlookup based iotag */
267 uint32_t iotag_ctr; /* keeps track of the next iotag to use */
268 uint32_t iotag_max; /* max iotag value to use */
269 struct list_head txq;
270 uint16_t txq_cnt; /* current length of queue */
271 uint16_t txq_max; /* max length */
272 struct list_head txcmplq;
273 uint16_t txcmplq_cnt; /* current length of queue */
274 uint16_t txcmplq_max; /* max length */
275 uint32_t missbufcnt; /* keep track of buffers to post */
276 struct list_head postbufq;
277 uint16_t postbufq_cnt; /* current length of queue */
278 uint16_t postbufq_max; /* max length */
279 struct list_head iocb_continueq;
280 uint16_t iocb_continueq_cnt; /* current length of queue */
281 uint16_t iocb_continueq_max; /* max length */
282 struct list_head iocb_continue_saveq;
284 struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
285 uint32_t num_mask; /* number of mask entries in prt array */
286 void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
287 struct lpfc_sli_ring *, struct lpfc_iocbq *);
289 struct lpfc_sli_ring_stat stats; /* SLI statistical info */
291 /* cmd ring available */
292 void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
293 struct lpfc_sli_ring *);
295 struct lpfc_sli3_ring sli3;
296 struct lpfc_sli4_ring sli4;
300 /* Structure used for configuring rings to a specific profile or rctl / type */
301 struct lpfc_hbq_init {
302 uint32_t rn; /* Receive buffer notification */
303 uint32_t entry_count; /* max # of entries in HBQ */
304 uint32_t headerLen; /* 0 if not profile 4 or 5 */
305 uint32_t logEntry; /* Set to 1 if this HBQ used for LogEntry */
306 uint32_t profile; /* Selection profile 0=all, 7=logentry */
307 uint32_t ring_mask; /* Binds HBQ to a ring e.g. Ring0=b0001,
309 uint32_t hbq_index; /* index of this hbq in ring .HBQs[] */
315 uint32_t cmdmatch[8];
316 uint32_t mask_count; /* number of mask entries in prt array */
317 struct hbq_mask hbqMasks[6];
319 /* Non-config rings fields to keep track of buffer allocations */
320 uint32_t buffer_count; /* number of buffers allocated */
321 uint32_t init_count; /* number to allocate when initialized */
322 uint32_t add_count; /* number to allocate when starved */
325 /* Structure used to hold SLI statistical counters and info */
326 struct lpfc_sli_stat {
327 uint64_t mbox_stat_err; /* Mbox cmds completed status error */
328 uint64_t mbox_cmd; /* Mailbox commands issued */
329 uint64_t sli_intr; /* Count of Host Attention interrupts */
330 uint64_t sli_prev_intr; /* Previous cnt of Host Attention interrupts */
331 uint64_t sli_ips; /* Host Attention interrupts per sec */
332 uint32_t err_attn_event; /* Error Attn event counters */
333 uint32_t link_event; /* Link event counters */
334 uint32_t mbox_event; /* Mailbox event counters */
335 uint32_t mbox_busy; /* Mailbox cmd busy */
338 /* Structure to store link status values when port stats are reset */
339 struct lpfc_lnk_stat {
340 uint32_t link_failure_count;
341 uint32_t loss_of_sync_count;
342 uint32_t loss_of_signal_count;
343 uint32_t prim_seq_protocol_err_count;
344 uint32_t invalid_tx_word_count;
345 uint32_t invalid_crc_count;
346 uint32_t error_frames;
347 uint32_t link_events;
350 /* Structure used to hold SLI information */
355 /* Additional sli_flags */
356 #define LPFC_SLI_MBOX_ACTIVE 0x100 /* HBA mailbox is currently active */
357 #define LPFC_SLI_ACTIVE 0x200 /* SLI in firmware is active */
358 #define LPFC_PROCESS_LA 0x400 /* Able to process link attention */
359 #define LPFC_BLOCK_MGMT_IO 0x800 /* Don't allow mgmt mbx or iocb cmds */
360 #define LPFC_SLI_ASYNC_MBX_BLK 0x2000 /* Async mailbox is blocked */
361 #define LPFC_SLI_SUPPRESS_RSP 0x4000 /* Suppress RSP feature is supported */
362 #define LPFC_SLI_USE_EQDR 0x8000 /* EQ Delay Register is supported */
363 #define LPFC_QUEUE_FREE_INIT 0x10000 /* Queue freeing is in progress */
364 #define LPFC_QUEUE_FREE_WAIT 0x20000 /* Hold Queue free as it is being
365 * used outside worker thread
368 struct lpfc_sli_ring *sli3_ring;
370 struct lpfc_sli_stat slistat; /* SLI statistical info */
371 struct list_head mboxq;
372 uint16_t mboxq_cnt; /* current length of queue */
373 uint16_t mboxq_max; /* max length */
374 LPFC_MBOXQ_t *mbox_active; /* active mboxq information */
375 struct list_head mboxq_cmpl;
377 struct timer_list mbox_tmo; /* Hold clk to timeout active mbox
380 #define LPFC_IOCBQ_LOOKUP_INCREMENT 1024
381 struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
382 size_t iocbq_lookup_len; /* current lengs of the array */
383 uint16_t last_iotag; /* last allocated IOTAG */
384 time64_t stats_start; /* in seconds */
385 struct lpfc_lnk_stat lnk_stat_offsets;
388 /* Timeout for normal outstanding mbox command (Seconds) */
389 #define LPFC_MBOX_TMO 30
390 /* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
391 #define LPFC_MBOX_SLI4_CONFIG_TMO 60
392 /* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
393 #define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO 300
394 /* Timeout for other flash-based outstanding mbox command (Seconds) */
395 #define LPFC_MBOX_TMO_FLASH_CMD 300
399 struct list_head list;
402 dma_addr_t dma_handle;
403 dma_addr_t dma_phys_sgl;
405 struct sli4_sge *dma_sgl; /* initial segment chunk */
407 /* linked list of extra sli4_hybrid_sge */
408 struct list_head dma_sgl_xtra_list;
410 /* list head for fcp_cmd_rsp buf */
411 struct list_head dma_cmd_rsp_list;
413 struct lpfc_iocbq cur_iocbq;
414 struct lpfc_sli4_hdw_queue *hdwq;
418 struct lpfc_nodelist *ndlp;
421 #define LPFC_SBUF_XBUSY 0x1 /* SLI4 hba reported XB on WCQE cmpl */
422 #define LPFC_SBUF_BUMP_QDEPTH 0x2 /* bumped queue depth counter */
423 /* External DIF device IO conversions */
424 #define LPFC_SBUF_NORMAL_DIF 0x4 /* normal mode to insert/strip */
425 #define LPFC_SBUF_PASS_DIF 0x8 /* insert/strip mode to passthru */
426 #define LPFC_SBUF_NOT_POSTED 0x10 /* SGL failed post to FW. */
427 uint16_t status; /* From IOCB Word 7- ulpStatus */
428 uint32_t result; /* From IOCB Word 4. */
430 uint32_t seg_cnt; /* Number of scatter-gather segments returned by
431 * dma_map_sg. The driver needs this for calls
434 unsigned long start_time;
435 spinlock_t buf_lock; /* lock used in case of simultaneous abort */
436 bool expedite; /* this is an expedite io_buf */
439 /* SCSI specific fields */
441 struct scsi_cmnd *pCmd;
442 struct lpfc_rport_data *rdata;
443 uint32_t prot_seg_cnt; /* seg_cnt's counterpart for
448 * data and dma_handle are the kernel virtual and bus
449 * address of the dma-able buffer containing the
450 * fcp_cmd, fcp_rsp and a scatter gather bde list that
451 * supports the sg_tablesize value.
453 struct fcp_cmnd *fcp_cmnd;
454 struct fcp_rsp *fcp_rsp;
456 wait_queue_head_t *waitq;
458 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
459 /* Used to restore any changes to protection data for
462 void *prot_data_segment;
464 uint32_t prot_data_type;
465 #define LPFC_INJERR_REFTAG 1
466 #define LPFC_INJERR_APPTAG 2
467 #define LPFC_INJERR_GUARD 3
471 /* NVME specific fields */
473 struct nvmefc_fcp_req *nvmeCmd;
477 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
478 uint64_t ts_cmd_start;
479 uint64_t ts_last_cmd;
480 uint64_t ts_cmd_wqput;
481 uint64_t ts_isr_cmpl;
484 uint64_t rx_cmd_start;