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