lpfc_sli.h revision 0c2875893ef27b93d5d3221f8f98ae944d6be5fa 
1/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for         *
3 * Fibre Channel Host Bus Adapters.                                *
4 * Copyright (C) 2004-2007 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
32/* This structure is used to carry the needed response IOCB states */
33struct lpfc_sli4_rspiocb_info {
34	uint8_t hw_status;
35	uint8_t bfield;
36#define LPFC_XB	0x1
37#define LPFC_PV	0x2
38	uint8_t priority;
39	uint8_t reserved;
40};
41
42/* This structure is used to handle IOCB requests / responses */
43struct lpfc_iocbq {
44	/* lpfc_iocbqs are used in double linked lists */
45	struct list_head list;
46	struct list_head clist;
47	uint16_t iotag;         /* pre-assigned IO tag */
48	uint16_t sli4_xritag;   /* pre-assigned XRI, (OXID) tag. */
49
50	IOCB_t iocb;		/* IOCB cmd */
51	uint8_t retry;		/* retry counter for IOCB cmd - if needed */
52	uint8_t iocb_flag;
53#define LPFC_IO_LIBDFC		1	/* libdfc iocb */
54#define LPFC_IO_WAKE		2	/* High Priority Queue signal flag */
55#define LPFC_IO_FCP		4	/* FCP command -- iocbq in scsi_buf */
56#define LPFC_DRIVER_ABORTED	8	/* driver aborted this request */
57#define LPFC_IO_FABRIC		0x10	/* Iocb send using fabric scheduler */
58#define LPFC_DELAY_MEM_FREE	0x20    /* Defer free'ing of FC data */
59#define LPFC_FIP_ELS		0x40
60
61	uint8_t abort_count;
62	uint8_t rsvd2;
63	uint32_t drvrTimeout;	/* driver timeout in seconds */
64	struct lpfc_vport *vport;/* virtual port pointer */
65	void *context1;		/* caller context information */
66	void *context2;		/* caller context information */
67	void *context3;		/* caller context information */
68	union {
69		wait_queue_head_t    *wait_queue;
70		struct lpfc_iocbq    *rsp_iocb;
71		struct lpfcMboxq     *mbox;
72		struct lpfc_nodelist *ndlp;
73	} context_un;
74
75	void (*fabric_iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
76			   struct lpfc_iocbq *);
77	void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
78			   struct lpfc_iocbq *);
79	struct lpfc_sli4_rspiocb_info sli4_info;
80};
81
82#define SLI_IOCB_RET_IOCB      1	/* Return IOCB if cmd ring full */
83
84#define IOCB_SUCCESS        0
85#define IOCB_BUSY           1
86#define IOCB_ERROR          2
87#define IOCB_TIMEDOUT       3
88
89#define LPFC_MBX_WAKE		1
90#define LPFC_MBX_IMED_UNREG	2
91
92typedef struct lpfcMboxq {
93	/* MBOXQs are used in single linked lists */
94	struct list_head list;	/* ptr to next mailbox command */
95	union {
96		MAILBOX_t mb;		/* Mailbox cmd */
97		struct lpfc_mqe mqe;
98	} u;
99	struct lpfc_vport *vport;/* virtual port pointer */
100	void *context1;		/* caller context information */
101	void *context2;		/* caller context information */
102
103	void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
104	uint8_t mbox_flag;
105	struct lpfc_mcqe mcqe;
106	struct lpfc_mbx_nembed_sge_virt *sge_array;
107} LPFC_MBOXQ_t;
108
109#define MBX_POLL        1	/* poll mailbox till command done, then
110				   return */
111#define MBX_NOWAIT      2	/* issue command then return immediately */
112
113#define LPFC_MAX_RING_MASK  4	/* max num of rctl/type masks allowed per
114				   ring */
115#define LPFC_MAX_RING       4	/* max num of SLI rings used by driver */
116
117struct lpfc_sli_ring;
118
119struct lpfc_sli_ring_mask {
120	uint8_t profile;	/* profile associated with ring */
121	uint8_t rctl;	/* rctl / type pair configured for ring */
122	uint8_t type;	/* rctl / type pair configured for ring */
123	uint8_t rsvd;
124	/* rcv'd unsol event */
125	void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
126					 struct lpfc_sli_ring *,
127					 struct lpfc_iocbq *);
128};
129
130
131/* Structure used to hold SLI statistical counters and info */
132struct lpfc_sli_ring_stat {
133	uint64_t iocb_event;	 /* IOCB event counters */
134	uint64_t iocb_cmd;	 /* IOCB cmd issued */
135	uint64_t iocb_rsp;	 /* IOCB rsp received */
136	uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
137	uint64_t iocb_cmd_full;	 /* IOCB cmd ring full */
138	uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
139	uint64_t iocb_rsp_full;	 /* IOCB rsp ring full */
140};
141
142/* Structure used to hold SLI ring information */
143struct lpfc_sli_ring {
144	uint16_t flag;		/* ring flags */
145#define LPFC_DEFERRED_RING_EVENT 0x001	/* Deferred processing a ring event */
146#define LPFC_CALL_RING_AVAILABLE 0x002	/* indicates cmd was full */
147#define LPFC_STOP_IOCB_EVENT     0x020	/* Stop processing IOCB cmds event */
148	uint16_t abtsiotag;	/* tracks next iotag to use for ABTS */
149
150	uint32_t local_getidx;   /* last available cmd index (from cmdGetInx) */
151	uint32_t next_cmdidx;    /* next_cmd index */
152	uint32_t rspidx;	/* current index in response ring */
153	uint32_t cmdidx;	/* current index in command ring */
154	uint8_t rsvd;
155	uint8_t ringno;		/* ring number */
156	uint16_t numCiocb;	/* number of command iocb's per ring */
157	uint16_t numRiocb;	/* number of rsp iocb's per ring */
158	uint16_t sizeCiocb;	/* Size of command iocb's in this ring */
159	uint16_t sizeRiocb;	/* Size of response iocb's in this ring */
160
161	uint32_t fast_iotag;	/* max fastlookup based iotag           */
162	uint32_t iotag_ctr;	/* keeps track of the next iotag to use */
163	uint32_t iotag_max;	/* max iotag value to use               */
164	struct list_head txq;
165	uint16_t txq_cnt;	/* current length of queue */
166	uint16_t txq_max;	/* max length */
167	struct list_head txcmplq;
168	uint16_t txcmplq_cnt;	/* current length of queue */
169	uint16_t txcmplq_max;	/* max length */
170	uint32_t *cmdringaddr;	/* virtual address for cmd rings */
171	uint32_t *rspringaddr;	/* virtual address for rsp rings */
172	uint32_t missbufcnt;	/* keep track of buffers to post */
173	struct list_head postbufq;
174	uint16_t postbufq_cnt;	/* current length of queue */
175	uint16_t postbufq_max;	/* max length */
176	struct list_head iocb_continueq;
177	uint16_t iocb_continueq_cnt;	/* current length of queue */
178	uint16_t iocb_continueq_max;	/* max length */
179	struct list_head iocb_continue_saveq;
180
181	struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
182	uint32_t num_mask;	/* number of mask entries in prt array */
183	void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
184		struct lpfc_sli_ring *, struct lpfc_iocbq *);
185
186	struct lpfc_sli_ring_stat stats;	/* SLI statistical info */
187
188	/* cmd ring available */
189	void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
190					struct lpfc_sli_ring *);
191};
192
193/* Structure used for configuring rings to a specific profile or rctl / type */
194struct lpfc_hbq_init {
195	uint32_t rn;		/* Receive buffer notification */
196	uint32_t entry_count;	/* max # of entries in HBQ */
197	uint32_t headerLen;	/* 0 if not profile 4 or 5 */
198	uint32_t logEntry;	/* Set to 1 if this HBQ used for LogEntry */
199	uint32_t profile;	/* Selection profile 0=all, 7=logentry */
200	uint32_t ring_mask;	/* Binds HBQ to a ring e.g. Ring0=b0001,
201				 * ring2=b0100 */
202	uint32_t hbq_index;	/* index of this hbq in ring .HBQs[] */
203
204	uint32_t seqlenoff;
205	uint32_t maxlen;
206	uint32_t seqlenbcnt;
207	uint32_t cmdcodeoff;
208	uint32_t cmdmatch[8];
209	uint32_t mask_count;	/* number of mask entries in prt array */
210	struct hbq_mask hbqMasks[6];
211
212	/* Non-config rings fields to keep track of buffer allocations */
213	uint32_t buffer_count;	/* number of buffers allocated */
214	uint32_t init_count;	/* number to allocate when initialized */
215	uint32_t add_count;	/* number to allocate when starved */
216} ;
217
218/* Structure used to hold SLI statistical counters and info */
219struct lpfc_sli_stat {
220	uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
221	uint64_t mbox_cmd;       /* Mailbox commands issued */
222	uint64_t sli_intr;       /* Count of Host Attention interrupts */
223	uint32_t err_attn_event; /* Error Attn event counters */
224	uint32_t link_event;     /* Link event counters */
225	uint32_t mbox_event;     /* Mailbox event counters */
226	uint32_t mbox_busy;	 /* Mailbox cmd busy */
227};
228
229/* Structure to store link status values when port stats are reset */
230struct lpfc_lnk_stat {
231	uint32_t link_failure_count;
232	uint32_t loss_of_sync_count;
233	uint32_t loss_of_signal_count;
234	uint32_t prim_seq_protocol_err_count;
235	uint32_t invalid_tx_word_count;
236	uint32_t invalid_crc_count;
237	uint32_t error_frames;
238	uint32_t link_events;
239};
240
241/* Structure used to hold SLI information */
242struct lpfc_sli {
243	uint32_t num_rings;
244	uint32_t sli_flag;
245
246	/* Additional sli_flags */
247#define LPFC_SLI_MBOX_ACTIVE      0x100	/* HBA mailbox is currently active */
248#define LPFC_SLI_ACTIVE           0x200	/* SLI in firmware is active */
249#define LPFC_PROCESS_LA           0x400	/* Able to process link attention */
250#define LPFC_BLOCK_MGMT_IO        0x800	/* Don't allow mgmt mbx or iocb cmds */
251#define LPFC_MENLO_MAINT          0x1000 /* need for menl fw download */
252#define LPFC_SLI_ASYNC_MBX_BLK    0x2000 /* Async mailbox is blocked */
253
254	struct lpfc_sli_ring ring[LPFC_MAX_RING];
255	int fcp_ring;		/* ring used for FCP initiator commands */
256	int next_ring;
257
258	int extra_ring;		/* extra ring used for other protocols */
259
260	struct lpfc_sli_stat slistat;	/* SLI statistical info */
261	struct list_head mboxq;
262	uint16_t mboxq_cnt;	/* current length of queue */
263	uint16_t mboxq_max;	/* max length */
264	LPFC_MBOXQ_t *mbox_active;	/* active mboxq information */
265	struct list_head mboxq_cmpl;
266
267	struct timer_list mbox_tmo;	/* Hold clk to timeout active mbox
268					   cmd */
269
270#define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
271	struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
272	size_t iocbq_lookup_len;           /* current lengs of the array */
273	uint16_t  last_iotag;              /* last allocated IOTAG */
274	unsigned long  stats_start;        /* in seconds */
275	struct lpfc_lnk_stat lnk_stat_offsets;
276};
277
278#define LPFC_MBOX_TMO           30	/* Sec tmo for outstanding mbox
279					   command */
280#define LPFC_MBOX_SLI4_CONFIG_TMO 60	/* Sec tmo for outstanding mbox
281					   command */
282#define LPFC_MBOX_TMO_FLASH_CMD 300     /* Sec tmo for outstanding FLASH write
283					 * or erase cmds. This is especially
284					 * long because of the potential of
285					 * multiple flash erases that can be
286					 * spawned.
287					 */
288