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.                        *
8  * www.broadcom.com                                                *
9  *                                                                 *
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  *******************************************************************/
22 
23 /* forward declaration for LPFC_IOCB_t's use */
24 struct lpfc_hba;
25 struct lpfc_vport;
26 
27 /* Define the context types that SLI handles for abort and sums. */
28 typedef enum _lpfc_ctx_cmd {
29 	LPFC_CTX_LUN,
30 	LPFC_CTX_TGT,
31 	LPFC_CTX_HOST
32 } lpfc_ctx_cmd;
33 
34 struct lpfc_cq_event {
35 	struct list_head list;
36 	union {
37 		struct lpfc_mcqe		mcqe_cmpl;
38 		struct lpfc_acqe_link		acqe_link;
39 		struct lpfc_acqe_fip		acqe_fip;
40 		struct lpfc_acqe_dcbx		acqe_dcbx;
41 		struct lpfc_acqe_grp5		acqe_grp5;
42 		struct lpfc_acqe_fc_la		acqe_fc;
43 		struct lpfc_acqe_sli		acqe_sli;
44 		struct lpfc_rcqe		rcqe_cmpl;
45 		struct sli4_wcqe_xri_aborted	wcqe_axri;
46 		struct lpfc_wcqe_complete	wcqe_cmpl;
47 	} cqe;
48 };
49 
50 /* This structure is used to handle IOCB requests / responses */
51 struct lpfc_iocbq {
52 	/* lpfc_iocbqs are used in double linked lists */
53 	struct list_head list;
54 	struct list_head clist;
55 	struct list_head dlist;
56 	uint16_t iotag;         /* pre-assigned IO tag */
57 	uint16_t sli4_lxritag;  /* logical pre-assigned XRI. */
58 	uint16_t sli4_xritag;   /* pre-assigned XRI, (OXID) tag. */
59 	uint16_t hba_wqidx;     /* index to HBA work queue */
60 	struct lpfc_cq_event cq_event;
61 	struct lpfc_wcqe_complete wcqe_cmpl;	/* WQE cmpl */
62 	uint64_t isr_timestamp;
63 
64 	union lpfc_wqe128 wqe;	/* SLI-4 */
65 	IOCB_t iocb;		/* SLI-3 */
66 
67 	uint8_t rsvd2;
68 	uint8_t priority;	/* OAS priority */
69 	uint8_t retry;		/* retry counter for IOCB cmd - if needed */
70 	uint32_t iocb_flag;
71 #define LPFC_IO_LIBDFC		1	/* libdfc iocb */
72 #define LPFC_IO_WAKE		2	/* Synchronous I/O completed */
73 #define LPFC_IO_WAKE_TMO	LPFC_IO_WAKE /* Synchronous I/O timed out */
74 #define LPFC_IO_FCP		4	/* FCP command -- iocbq in scsi_buf */
75 #define LPFC_DRIVER_ABORTED	8	/* driver aborted this request */
76 #define LPFC_IO_FABRIC		0x10	/* Iocb send using fabric scheduler */
77 #define LPFC_DELAY_MEM_FREE	0x20    /* Defer free'ing of FC data */
78 #define LPFC_EXCHANGE_BUSY	0x40    /* SLI4 hba reported XB in response */
79 #define LPFC_USE_FCPWQIDX	0x80    /* Submit to specified FCPWQ index */
80 #define DSS_SECURITY_OP		0x100	/* security IO */
81 #define LPFC_IO_ON_TXCMPLQ	0x200	/* The IO is still on the TXCMPLQ */
82 #define LPFC_IO_DIF_PASS	0x400	/* T10 DIF IO pass-thru prot */
83 #define LPFC_IO_DIF_STRIP	0x800	/* T10 DIF IO strip prot */
84 #define LPFC_IO_DIF_INSERT	0x1000	/* T10 DIF IO insert prot */
85 #define LPFC_IO_CMD_OUTSTANDING	0x2000 /* timeout handler abort window */
86 
87 #define LPFC_FIP_ELS_ID_MASK	0xc000	/* ELS_ID range 0-3, non-shifted mask */
88 #define LPFC_FIP_ELS_ID_SHIFT	14
89 
90 #define LPFC_IO_OAS		0x10000 /* OAS FCP IO */
91 #define LPFC_IO_FOF		0x20000 /* FOF FCP IO */
92 #define LPFC_IO_LOOPBACK	0x40000 /* Loopback IO */
93 #define LPFC_PRLI_NVME_REQ	0x80000 /* This is an NVME PRLI. */
94 #define LPFC_PRLI_FCP_REQ	0x100000 /* This is an NVME PRLI. */
95 #define LPFC_IO_NVME	        0x200000 /* NVME FCP command */
96 #define LPFC_IO_NVME_LS		0x400000 /* NVME LS command */
97 #define LPFC_IO_NVMET		0x800000 /* NVMET command */
98 
99 	uint32_t drvrTimeout;	/* driver timeout in seconds */
100 	struct lpfc_vport *vport;/* virtual port pointer */
101 	void *context1;		/* caller context information */
102 	void *context2;		/* caller context information */
103 	void *context3;		/* caller context information */
104 	union {
105 		wait_queue_head_t    *wait_queue;
106 		struct lpfc_iocbq    *rsp_iocb;
107 		struct lpfcMboxq     *mbox;
108 		struct lpfc_nodelist *ndlp;
109 		struct lpfc_node_rrq *rrq;
110 	} context_un;
111 
112 	void (*fabric_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
113 			   struct lpfc_iocbq *);
114 	void (*wait_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
115 			   struct lpfc_iocbq *);
116 	void (*iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
117 			   struct lpfc_iocbq *);
118 	void (*wqe_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
119 			  struct lpfc_wcqe_complete *);
120 };
121 
122 #define SLI_IOCB_RET_IOCB      1	/* Return IOCB if cmd ring full */
123 
124 #define IOCB_SUCCESS        0
125 #define IOCB_BUSY           1
126 #define IOCB_ERROR          2
127 #define IOCB_TIMEDOUT       3
128 
129 #define SLI_WQE_RET_WQE    1    /* Return WQE if cmd ring full */
130 
131 #define WQE_SUCCESS        0
132 #define WQE_BUSY           1
133 #define WQE_ERROR          2
134 #define WQE_TIMEDOUT       3
135 #define WQE_ABORTED        4
136 
137 #define LPFC_MBX_WAKE		1
138 #define LPFC_MBX_IMED_UNREG	2
139 
140 typedef struct lpfcMboxq {
141 	/* MBOXQs are used in single linked lists */
142 	struct list_head list;	/* ptr to next mailbox command */
143 	union {
144 		MAILBOX_t mb;		/* Mailbox cmd */
145 		struct lpfc_mqe mqe;
146 	} u;
147 	struct lpfc_vport *vport;/* virtual port pointer */
148 	void *context1;		/* caller context information */
149 	void *context2;		/* caller context information */
150 	void *context3;
151 
152 	void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
153 	uint8_t mbox_flag;
154 	uint16_t in_ext_byte_len;
155 	uint16_t out_ext_byte_len;
156 	uint8_t  mbox_offset_word;
157 	struct lpfc_mcqe mcqe;
158 	struct lpfc_mbx_nembed_sge_virt *sge_array;
159 } LPFC_MBOXQ_t;
160 
161 #define MBX_POLL        1	/* poll mailbox till command done, then
162 				   return */
163 #define MBX_NOWAIT      2	/* issue command then return immediately */
164 
165 #define LPFC_MAX_RING_MASK  5	/* max num of rctl/type masks allowed per
166 				   ring */
167 #define LPFC_SLI3_MAX_RING  4	/* Max num of SLI3 rings used by driver.
168 				   For SLI4, an additional ring for each
169 				   FCP WQ will be allocated.  */
170 
171 struct lpfc_sli_ring;
172 
173 struct lpfc_sli_ring_mask {
174 	uint8_t profile;	/* profile associated with ring */
175 	uint8_t rctl;	/* rctl / type pair configured for ring */
176 	uint8_t type;	/* rctl / type pair configured for ring */
177 	uint8_t rsvd;
178 	/* rcv'd unsol event */
179 	void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
180 					 struct lpfc_sli_ring *,
181 					 struct lpfc_iocbq *);
182 };
183 
184 
185 /* Structure used to hold SLI statistical counters and info */
186 struct lpfc_sli_ring_stat {
187 	uint64_t iocb_event;	 /* IOCB event counters */
188 	uint64_t iocb_cmd;	 /* IOCB cmd issued */
189 	uint64_t iocb_rsp;	 /* IOCB rsp received */
190 	uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
191 	uint64_t iocb_cmd_full;	 /* IOCB cmd ring full */
192 	uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
193 	uint64_t iocb_rsp_full;	 /* IOCB rsp ring full */
194 };
195 
196 struct lpfc_sli3_ring {
197 	uint32_t local_getidx;  /* last available cmd index (from cmdGetInx) */
198 	uint32_t next_cmdidx;   /* next_cmd index */
199 	uint32_t rspidx;	/* current index in response ring */
200 	uint32_t cmdidx;	/* current index in command ring */
201 	uint16_t numCiocb;	/* number of command iocb's per ring */
202 	uint16_t numRiocb;	/* number of rsp iocb's per ring */
203 	uint16_t sizeCiocb;	/* Size of command iocb's in this ring */
204 	uint16_t sizeRiocb;	/* Size of response iocb's in this ring */
205 	uint32_t *cmdringaddr;	/* virtual address for cmd rings */
206 	uint32_t *rspringaddr;	/* virtual address for rsp rings */
207 };
208 
209 struct lpfc_sli4_ring {
210 	struct lpfc_queue *wqp;	/* Pointer to associated WQ */
211 };
212 
213 
214 /* Structure used to hold SLI ring information */
215 struct lpfc_sli_ring {
216 	uint16_t flag;		/* ring flags */
217 #define LPFC_DEFERRED_RING_EVENT 0x001	/* Deferred processing a ring event */
218 #define LPFC_CALL_RING_AVAILABLE 0x002	/* indicates cmd was full */
219 #define LPFC_STOP_IOCB_EVENT     0x020	/* Stop processing IOCB cmds event */
220 	uint16_t abtsiotag;	/* tracks next iotag to use for ABTS */
221 
222 	uint8_t rsvd;
223 	uint8_t ringno;		/* ring number */
224 
225 	spinlock_t ring_lock;	/* lock for issuing commands */
226 
227 	uint32_t fast_iotag;	/* max fastlookup based iotag           */
228 	uint32_t iotag_ctr;	/* keeps track of the next iotag to use */
229 	uint32_t iotag_max;	/* max iotag value to use               */
230 	struct list_head txq;
231 	uint16_t txq_cnt;	/* current length of queue */
232 	uint16_t txq_max;	/* max length */
233 	struct list_head txcmplq;
234 	uint16_t txcmplq_cnt;	/* current length of queue */
235 	uint16_t txcmplq_max;	/* max length */
236 	uint32_t missbufcnt;	/* keep track of buffers to post */
237 	struct list_head postbufq;
238 	uint16_t postbufq_cnt;	/* current length of queue */
239 	uint16_t postbufq_max;	/* max length */
240 	struct list_head iocb_continueq;
241 	uint16_t iocb_continueq_cnt;	/* current length of queue */
242 	uint16_t iocb_continueq_max;	/* max length */
243 	struct list_head iocb_continue_saveq;
244 
245 	struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
246 	uint32_t num_mask;	/* number of mask entries in prt array */
247 	void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
248 		struct lpfc_sli_ring *, struct lpfc_iocbq *);
249 
250 	struct lpfc_sli_ring_stat stats;	/* SLI statistical info */
251 
252 	/* cmd ring available */
253 	void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
254 					struct lpfc_sli_ring *);
255 	union {
256 		struct lpfc_sli3_ring sli3;
257 		struct lpfc_sli4_ring sli4;
258 	} sli;
259 };
260 
261 /* Structure used for configuring rings to a specific profile or rctl / type */
262 struct lpfc_hbq_init {
263 	uint32_t rn;		/* Receive buffer notification */
264 	uint32_t entry_count;	/* max # of entries in HBQ */
265 	uint32_t headerLen;	/* 0 if not profile 4 or 5 */
266 	uint32_t logEntry;	/* Set to 1 if this HBQ used for LogEntry */
267 	uint32_t profile;	/* Selection profile 0=all, 7=logentry */
268 	uint32_t ring_mask;	/* Binds HBQ to a ring e.g. Ring0=b0001,
269 				 * ring2=b0100 */
270 	uint32_t hbq_index;	/* index of this hbq in ring .HBQs[] */
271 
272 	uint32_t seqlenoff;
273 	uint32_t maxlen;
274 	uint32_t seqlenbcnt;
275 	uint32_t cmdcodeoff;
276 	uint32_t cmdmatch[8];
277 	uint32_t mask_count;	/* number of mask entries in prt array */
278 	struct hbq_mask hbqMasks[6];
279 
280 	/* Non-config rings fields to keep track of buffer allocations */
281 	uint32_t buffer_count;	/* number of buffers allocated */
282 	uint32_t init_count;	/* number to allocate when initialized */
283 	uint32_t add_count;	/* number to allocate when starved */
284 } ;
285 
286 /* Structure used to hold SLI statistical counters and info */
287 struct lpfc_sli_stat {
288 	uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
289 	uint64_t mbox_cmd;       /* Mailbox commands issued */
290 	uint64_t sli_intr;       /* Count of Host Attention interrupts */
291 	uint64_t sli_prev_intr;  /* Previous cnt of Host Attention interrupts */
292 	uint64_t sli_ips;        /* Host Attention interrupts per sec */
293 	uint32_t err_attn_event; /* Error Attn event counters */
294 	uint32_t link_event;     /* Link event counters */
295 	uint32_t mbox_event;     /* Mailbox event counters */
296 	uint32_t mbox_busy;	 /* Mailbox cmd busy */
297 };
298 
299 /* Structure to store link status values when port stats are reset */
300 struct lpfc_lnk_stat {
301 	uint32_t link_failure_count;
302 	uint32_t loss_of_sync_count;
303 	uint32_t loss_of_signal_count;
304 	uint32_t prim_seq_protocol_err_count;
305 	uint32_t invalid_tx_word_count;
306 	uint32_t invalid_crc_count;
307 	uint32_t error_frames;
308 	uint32_t link_events;
309 };
310 
311 /* Structure used to hold SLI information */
312 struct lpfc_sli {
313 	uint32_t num_rings;
314 	uint32_t sli_flag;
315 
316 	/* Additional sli_flags */
317 #define LPFC_SLI_MBOX_ACTIVE      0x100	/* HBA mailbox is currently active */
318 #define LPFC_SLI_ACTIVE           0x200	/* SLI in firmware is active */
319 #define LPFC_PROCESS_LA           0x400	/* Able to process link attention */
320 #define LPFC_BLOCK_MGMT_IO        0x800	/* Don't allow mgmt mbx or iocb cmds */
321 #define LPFC_MENLO_MAINT          0x1000 /* need for menl fw download */
322 #define LPFC_SLI_ASYNC_MBX_BLK    0x2000 /* Async mailbox is blocked */
323 #define LPFC_SLI_SUPPRESS_RSP     0x4000 /* Suppress RSP feature is supported */
324 #define LPFC_SLI_USE_EQDR         0x8000 /* EQ Delay Register is supported */
325 
326 	struct lpfc_sli_ring *sli3_ring;
327 
328 	struct lpfc_sli_stat slistat;	/* SLI statistical info */
329 	struct list_head mboxq;
330 	uint16_t mboxq_cnt;	/* current length of queue */
331 	uint16_t mboxq_max;	/* max length */
332 	LPFC_MBOXQ_t *mbox_active;	/* active mboxq information */
333 	struct list_head mboxq_cmpl;
334 
335 	struct timer_list mbox_tmo;	/* Hold clk to timeout active mbox
336 					   cmd */
337 
338 #define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
339 	struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
340 	size_t iocbq_lookup_len;           /* current lengs of the array */
341 	uint16_t  last_iotag;              /* last allocated IOTAG */
342 	time64_t  stats_start;		   /* in seconds */
343 	struct lpfc_lnk_stat lnk_stat_offsets;
344 };
345 
346 /* Timeout for normal outstanding mbox command (Seconds) */
347 #define LPFC_MBOX_TMO				30
348 /* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
349 #define LPFC_MBOX_SLI4_CONFIG_TMO		60
350 /* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
351 #define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO	300
352 /* Timeout for other flash-based outstanding mbox command (Seconds) */
353 #define LPFC_MBOX_TMO_FLASH_CMD			300
354