lpfc_sli.h revision a4bc3379fbc368597024104727fdf14ced483c14 
1/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for         *
3 * Fibre Channel Host Bus Adapters.                                *
4 * Copyright (C) 2004-2006 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;
23
24/* Define the context types that SLI handles for abort and sums. */
25typedef enum _lpfc_ctx_cmd {
26	LPFC_CTX_LUN,
27	LPFC_CTX_TGT,
28	LPFC_CTX_CTX,
29	LPFC_CTX_HOST
30} lpfc_ctx_cmd;
31
32/* This structure is used to handle IOCB requests / responses */
33struct lpfc_iocbq {
34	/* lpfc_iocbqs are used in double linked lists */
35	struct list_head list;
36	uint16_t iotag;         /* pre-assigned IO tag */
37	uint16_t rsvd1;
38
39	IOCB_t iocb;		/* IOCB cmd */
40	uint8_t retry;		/* retry counter for IOCB cmd - if needed */
41	uint8_t iocb_flag;
42#define LPFC_IO_LIBDFC	1	/* libdfc iocb */
43#define LPFC_IO_WAKE	2	/* High Priority Queue signal flag */
44#define LPFC_IO_FCP	4	/* FCP command -- iocbq in scsi_buf */
45
46	uint8_t abort_count;
47	uint8_t rsvd2;
48	uint32_t drvrTimeout;	/* driver timeout in seconds */
49	void *context1;		/* caller context information */
50	void *context2;		/* caller context information */
51	void *context3;		/* caller context information */
52	union {
53		wait_queue_head_t  *wait_queue;
54		struct lpfc_iocbq  *rsp_iocb;
55		struct lpfcMboxq   *mbox;
56	} context_un;
57
58	void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
59			   struct lpfc_iocbq *);
60
61};
62
63#define SLI_IOCB_RET_IOCB      1	/* Return IOCB if cmd ring full */
64
65#define IOCB_SUCCESS        0
66#define IOCB_BUSY           1
67#define IOCB_ERROR          2
68#define IOCB_TIMEDOUT       3
69
70typedef struct lpfcMboxq {
71	/* MBOXQs are used in single linked lists */
72	struct list_head list;	/* ptr to next mailbox command */
73	MAILBOX_t mb;		/* Mailbox cmd */
74	void *context1;		/* caller context information */
75	void *context2;		/* caller context information */
76
77	void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
78
79} LPFC_MBOXQ_t;
80
81#define MBX_POLL        1	/* poll mailbox till command done, then
82				   return */
83#define MBX_NOWAIT      2	/* issue command then return immediately */
84#define MBX_STOP_IOCB   4	/* Stop iocb processing till mbox cmds
85				   complete */
86
87#define LPFC_MAX_RING_MASK  4	/* max num of rctl/type masks allowed per
88				   ring */
89#define LPFC_MAX_RING       4	/* max num of SLI rings used by driver */
90
91struct lpfc_sli_ring;
92
93struct lpfc_sli_ring_mask {
94	uint8_t profile;	/* profile associated with ring */
95	uint8_t rctl;	/* rctl / type pair configured for ring */
96	uint8_t type;	/* rctl / type pair configured for ring */
97	uint8_t rsvd;
98	/* rcv'd unsol event */
99	void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
100					 struct lpfc_sli_ring *,
101					 struct lpfc_iocbq *);
102};
103
104
105/* Structure used to hold SLI statistical counters and info */
106struct lpfc_sli_ring_stat {
107	uint64_t iocb_event;	 /* IOCB event counters */
108	uint64_t iocb_cmd;	 /* IOCB cmd issued */
109	uint64_t iocb_rsp;	 /* IOCB rsp received */
110	uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
111	uint64_t iocb_cmd_full;	 /* IOCB cmd ring full */
112	uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
113	uint64_t iocb_rsp_full;	 /* IOCB rsp ring full */
114};
115
116/* Structure used to hold SLI ring information */
117struct lpfc_sli_ring {
118	uint16_t flag;		/* ring flags */
119#define LPFC_DEFERRED_RING_EVENT 0x001	/* Deferred processing a ring event */
120#define LPFC_CALL_RING_AVAILABLE 0x002	/* indicates cmd was full */
121#define LPFC_STOP_IOCB_MBX       0x010	/* Stop processing IOCB cmds mbox */
122#define LPFC_STOP_IOCB_EVENT     0x020	/* Stop processing IOCB cmds event */
123#define LPFC_STOP_IOCB_MASK      0x030	/* Stop processing IOCB cmds mask */
124	uint16_t abtsiotag;	/* tracks next iotag to use for ABTS */
125
126	uint32_t local_getidx;   /* last available cmd index (from cmdGetInx) */
127	uint32_t next_cmdidx;    /* next_cmd index */
128	uint32_t rspidx;	/* current index in response ring */
129	uint32_t cmdidx;	/* current index in command ring */
130	uint8_t rsvd;
131	uint8_t ringno;		/* ring number */
132	uint16_t numCiocb;	/* number of command iocb's per ring */
133	uint16_t numRiocb;	/* number of rsp iocb's per ring */
134
135	uint32_t fast_iotag;	/* max fastlookup based iotag           */
136	uint32_t iotag_ctr;	/* keeps track of the next iotag to use */
137	uint32_t iotag_max;	/* max iotag value to use               */
138	struct list_head txq;
139	uint16_t txq_cnt;	/* current length of queue */
140	uint16_t txq_max;	/* max length */
141	struct list_head txcmplq;
142	uint16_t txcmplq_cnt;	/* current length of queue */
143	uint16_t txcmplq_max;	/* max length */
144	uint32_t *cmdringaddr;	/* virtual address for cmd rings */
145	uint32_t *rspringaddr;	/* virtual address for rsp rings */
146	uint32_t missbufcnt;	/* keep track of buffers to post */
147	struct list_head postbufq;
148	uint16_t postbufq_cnt;	/* current length of queue */
149	uint16_t postbufq_max;	/* max length */
150	struct list_head iocb_continueq;
151	uint16_t iocb_continueq_cnt;	/* current length of queue */
152	uint16_t iocb_continueq_max;	/* max length */
153
154	struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
155	uint32_t num_mask;	/* number of mask entries in prt array */
156
157	struct lpfc_sli_ring_stat stats;	/* SLI statistical info */
158
159	/* cmd ring available */
160	void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
161					struct lpfc_sli_ring *);
162};
163
164/* Structure used to hold SLI statistical counters and info */
165struct lpfc_sli_stat {
166	uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
167	uint64_t mbox_cmd;       /* Mailbox commands issued */
168	uint64_t sli_intr;       /* Count of Host Attention interrupts */
169	uint32_t err_attn_event; /* Error Attn event counters */
170	uint32_t link_event;     /* Link event counters */
171	uint32_t mbox_event;     /* Mailbox event counters */
172	uint32_t mbox_busy;	 /* Mailbox cmd busy */
173};
174
175/* Structure to store link status values when port stats are reset */
176struct lpfc_lnk_stat {
177	uint32_t link_failure_count;
178	uint32_t loss_of_sync_count;
179	uint32_t loss_of_signal_count;
180	uint32_t prim_seq_protocol_err_count;
181	uint32_t invalid_tx_word_count;
182	uint32_t invalid_crc_count;
183	uint32_t error_frames;
184	uint32_t link_events;
185};
186
187/* Structure used to hold SLI information */
188struct lpfc_sli {
189	uint32_t num_rings;
190	uint32_t sli_flag;
191
192	/* Additional sli_flags */
193#define LPFC_SLI_MBOX_ACTIVE      0x100	/* HBA mailbox is currently active */
194#define LPFC_SLI2_ACTIVE          0x200	/* SLI2 overlay in firmware is active */
195#define LPFC_PROCESS_LA           0x400	/* Able to process link attention */
196
197	struct lpfc_sli_ring ring[LPFC_MAX_RING];
198	int fcp_ring;		/* ring used for FCP initiator commands */
199	int next_ring;
200
201	int extra_ring;		/* extra ring used for other protocols */
202
203	struct lpfc_sli_stat slistat;	/* SLI statistical info */
204	struct list_head mboxq;
205	uint16_t mboxq_cnt;	/* current length of queue */
206	uint16_t mboxq_max;	/* max length */
207	LPFC_MBOXQ_t *mbox_active;	/* active mboxq information */
208
209	struct timer_list mbox_tmo;	/* Hold clk to timeout active mbox
210					   cmd */
211
212#define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
213	struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
214	size_t iocbq_lookup_len;           /* current lengs of the array */
215	uint16_t  last_iotag;              /* last allocated IOTAG */
216	unsigned long  stats_start;        /* in seconds */
217	struct lpfc_lnk_stat lnk_stat_offsets;
218};
219
220/* Given a pointer to the start of the ring, and the slot number of
221 * the desired iocb entry, calc a pointer to that entry.
222 * (assume iocb entry size is 32 bytes, or 8 words)
223 */
224#define IOCB_ENTRY(ring,slot) ((IOCB_t *)(((char *)(ring)) + ((slot) * 32)))
225
226#define LPFC_MBOX_TMO           30	/* Sec tmo for outstanding mbox
227					   command */
228#define LPFC_MBOX_TMO_FLASH_CMD 300     /* Sec tmo for outstanding FLASH write
229					 * or erase cmds. This is especially
230					 * long because of the potential of
231					 * multiple flash erases that can be
232					 * spawned.
233					 */
234