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