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