xref: /linux/drivers/scsi/lpfc/lpfc.h (revision 776cfebb430c7b22c208b1b17add97f354d97cab)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Enterprise Fibre Channel Host Bus Adapters.                     *
4  * Refer to the README file included with this package for         *
5  * driver version and adapter support.                             *
6  * Copyright (C) 2004 Emulex Corporation.                          *
7  * www.emulex.com                                                  *
8  *                                                                 *
9  * This program is free software; you can redistribute it and/or   *
10  * modify it under the terms of the GNU General Public License     *
11  * as published by the Free Software Foundation; either version 2  *
12  * of the License, or (at your option) any later version.          *
13  *                                                                 *
14  * This program is distributed in the hope that it will be useful, *
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of  *
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the   *
17  * GNU General Public License for more details, a copy of which    *
18  * can be found in the file COPYING included with this package.    *
19  *******************************************************************/
20 
21 /*
22  * $Id: lpfc.h 1.167 2005/04/07 08:47:05EDT sf_support Exp  $
23  */
24 
25 struct lpfc_sli2_slim;
26 
27 #define LPFC_MAX_TARGET         256	/* max targets supported */
28 #define LPFC_MAX_DISC_THREADS	64	/* max outstanding discovery els req */
29 #define LPFC_MAX_NS_RETRY       3	/* max NameServer retries */
30 
31 #define LPFC_DFT_HBA_Q_DEPTH	2048	/* max cmds per hba */
32 #define LPFC_LC_HBA_Q_DEPTH	1024	/* max cmds per low cost hba */
33 #define LPFC_LP101_HBA_Q_DEPTH	128	/* max cmds per low cost hba */
34 
35 #define LPFC_CMD_PER_LUN	30	/* max outstanding cmds per lun */
36 #define LPFC_SG_SEG_CNT		64	/* sg element count per scsi cmnd */
37 #define LPFC_IOCB_LIST_CNT	2250	/* list of IOCBs for fast-path usage. */
38 
39 /* Define macros for 64 bit support */
40 #define putPaddrLow(addr)    ((uint32_t) (0xffffffff & (u64)(addr)))
41 #define putPaddrHigh(addr)   ((uint32_t) (0xffffffff & (((u64)(addr))>>32)))
42 #define getPaddr(high, low)  ((dma_addr_t)( \
43 			     (( (u64)(high)<<16 ) << 16)|( (u64)(low))))
44 /* Provide maximum configuration definitions. */
45 #define LPFC_DRVR_TIMEOUT	16	/* driver iocb timeout value in sec */
46 #define MAX_FCP_TARGET		256	/* max num of FCP targets supported */
47 #define FC_MAX_ADPTMSG		64
48 
49 #define MAX_HBAEVT	32
50 
51 /* Provide DMA memory definitions the driver uses per port instance. */
52 struct lpfc_dmabuf {
53 	struct list_head list;
54 	void *virt;		/* virtual address ptr */
55 	dma_addr_t phys;	/* mapped address */
56 };
57 
58 struct lpfc_dma_pool {
59 	struct lpfc_dmabuf   *elements;
60 	uint32_t    max_count;
61 	uint32_t    current_count;
62 };
63 
64 /* Priority bit.  Set value to exceed low water mark in lpfc_mem. */
65 #define MEM_PRI		0x100
66 
67 
68 /****************************************************************************/
69 /*      Device VPD save area                                                */
70 /****************************************************************************/
71 typedef struct lpfc_vpd {
72 	uint32_t status;	/* vpd status value */
73 	uint32_t length;	/* number of bytes actually returned */
74 	struct {
75 		uint32_t rsvd1;	/* Revision numbers */
76 		uint32_t biuRev;
77 		uint32_t smRev;
78 		uint32_t smFwRev;
79 		uint32_t endecRev;
80 		uint16_t rBit;
81 		uint8_t fcphHigh;
82 		uint8_t fcphLow;
83 		uint8_t feaLevelHigh;
84 		uint8_t feaLevelLow;
85 		uint32_t postKernRev;
86 		uint32_t opFwRev;
87 		uint8_t opFwName[16];
88 		uint32_t sli1FwRev;
89 		uint8_t sli1FwName[16];
90 		uint32_t sli2FwRev;
91 		uint8_t sli2FwName[16];
92 	} rev;
93 } lpfc_vpd_t;
94 
95 struct lpfc_scsi_buf;
96 
97 
98 /*
99  * lpfc stat counters
100  */
101 struct lpfc_stats {
102 	/* Statistics for ELS commands */
103 	uint32_t elsLogiCol;
104 	uint32_t elsRetryExceeded;
105 	uint32_t elsXmitRetry;
106 	uint32_t elsDelayRetry;
107 	uint32_t elsRcvDrop;
108 	uint32_t elsRcvFrame;
109 	uint32_t elsRcvRSCN;
110 	uint32_t elsRcvRNID;
111 	uint32_t elsRcvFARP;
112 	uint32_t elsRcvFARPR;
113 	uint32_t elsRcvFLOGI;
114 	uint32_t elsRcvPLOGI;
115 	uint32_t elsRcvADISC;
116 	uint32_t elsRcvPDISC;
117 	uint32_t elsRcvFAN;
118 	uint32_t elsRcvLOGO;
119 	uint32_t elsRcvPRLO;
120 	uint32_t elsRcvPRLI;
121 	uint32_t elsRcvRRQ;
122 	uint32_t elsXmitFLOGI;
123 	uint32_t elsXmitPLOGI;
124 	uint32_t elsXmitPRLI;
125 	uint32_t elsXmitADISC;
126 	uint32_t elsXmitLOGO;
127 	uint32_t elsXmitSCR;
128 	uint32_t elsXmitRNID;
129 	uint32_t elsXmitFARP;
130 	uint32_t elsXmitFARPR;
131 	uint32_t elsXmitACC;
132 	uint32_t elsXmitLSRJT;
133 
134 	uint32_t frameRcvBcast;
135 	uint32_t frameRcvMulti;
136 	uint32_t strayXmitCmpl;
137 	uint32_t frameXmitDelay;
138 	uint32_t xriCmdCmpl;
139 	uint32_t xriStatErr;
140 	uint32_t LinkUp;
141 	uint32_t LinkDown;
142 	uint32_t LinkMultiEvent;
143 	uint32_t NoRcvBuf;
144 	uint32_t fcpCmd;
145 	uint32_t fcpCmpl;
146 	uint32_t fcpRspErr;
147 	uint32_t fcpRemoteStop;
148 	uint32_t fcpPortRjt;
149 	uint32_t fcpPortBusy;
150 	uint32_t fcpError;
151 	uint32_t fcpLocalErr;
152 };
153 
154 enum sysfs_mbox_state {
155 	SMBOX_IDLE,
156 	SMBOX_WRITING,
157 	SMBOX_READING
158 };
159 
160 struct lpfc_sysfs_mbox {
161 	enum sysfs_mbox_state state;
162 	size_t                offset;
163 	struct lpfcMboxq *    mbox;
164 };
165 
166 struct lpfc_hba {
167 	struct list_head hba_list;	/* List of hbas/ports */
168 	struct lpfc_sli sli;
169 	struct lpfc_sli2_slim *slim2p;
170 	dma_addr_t slim2p_mapping;
171 	uint16_t pci_cfg_value;
172 
173 	uint32_t hba_state;
174 
175 #define LPFC_INIT_START           1	/* Initial state after board reset */
176 #define LPFC_INIT_MBX_CMDS        2	/* Initialize HBA with mbox commands */
177 #define LPFC_LINK_DOWN            3	/* HBA initialized, link is down */
178 #define LPFC_LINK_UP              4	/* Link is up  - issue READ_LA */
179 #define LPFC_LOCAL_CFG_LINK       5	/* local NPORT Id configured */
180 #define LPFC_FLOGI                6	/* FLOGI sent to Fabric */
181 #define LPFC_FABRIC_CFG_LINK      7	/* Fabric assigned NPORT Id
182 					   configured */
183 #define LPFC_NS_REG               8	/* Register with NameServer */
184 #define LPFC_NS_QRY               9	/* Query NameServer for NPort ID list */
185 #define LPFC_BUILD_DISC_LIST      10	/* Build ADISC and PLOGI lists for
186 					 * device authentication / discovery */
187 #define LPFC_DISC_AUTH            11	/* Processing ADISC list */
188 #define LPFC_CLEAR_LA             12	/* authentication cmplt - issue
189 					   CLEAR_LA */
190 #define LPFC_HBA_READY            32
191 #define LPFC_HBA_ERROR            0xff
192 
193 	uint8_t fc_linkspeed;	/* Link speed after last READ_LA */
194 
195 	uint32_t fc_eventTag;	/* event tag for link attention */
196 	uint32_t fc_prli_sent;	/* cntr for outstanding PRLIs */
197 
198 	uint32_t num_disc_nodes;	/*in addition to hba_state */
199 
200 	struct timer_list fc_estabtmo;	/* link establishment timer */
201 	struct timer_list fc_disctmo;	/* Discovery rescue timer */
202 	struct timer_list fc_fdmitmo;	/* fdmi timer */
203 	/* These fields used to be binfo */
204 	struct lpfc_name fc_nodename;	/* fc nodename */
205 	struct lpfc_name fc_portname;	/* fc portname */
206 	uint32_t fc_pref_DID;	/* preferred D_ID */
207 	uint8_t fc_pref_ALPA;	/* preferred AL_PA */
208 	uint32_t fc_edtov;	/* E_D_TOV timer value */
209 	uint32_t fc_arbtov;	/* ARB_TOV timer value */
210 	uint32_t fc_ratov;	/* R_A_TOV timer value */
211 	uint32_t fc_rttov;	/* R_T_TOV timer value */
212 	uint32_t fc_altov;	/* AL_TOV timer value */
213 	uint32_t fc_crtov;	/* C_R_TOV timer value */
214 	uint32_t fc_citov;	/* C_I_TOV timer value */
215 	uint32_t fc_myDID;	/* fibre channel S_ID */
216 	uint32_t fc_prevDID;	/* previous fibre channel S_ID */
217 
218 	struct serv_parm fc_sparam;	/* buffer for our service parameters */
219 	struct serv_parm fc_fabparam;	/* fabric service parameters buffer */
220 	uint8_t alpa_map[128];	/* AL_PA map from READ_LA */
221 
222 	uint8_t fc_ns_retry;	/* retries for fabric nameserver */
223 	uint32_t fc_nlp_cnt;	/* outstanding NODELIST requests */
224 	uint32_t fc_rscn_id_cnt;	/* count of RSCNs payloads in list */
225 	struct lpfc_dmabuf *fc_rscn_id_list[FC_MAX_HOLD_RSCN];
226 	uint32_t lmt;
227 	uint32_t fc_flag;	/* FC flags */
228 #define FC_PT2PT                0x1	/* pt2pt with no fabric */
229 #define FC_PT2PT_PLOGI          0x2	/* pt2pt initiate PLOGI */
230 #define FC_DISC_TMO             0x4	/* Discovery timer running */
231 #define FC_PUBLIC_LOOP          0x8	/* Public loop */
232 #define FC_LBIT                 0x10	/* LOGIN bit in loopinit set */
233 #define FC_RSCN_MODE            0x20	/* RSCN cmd rcv'ed */
234 #define FC_NLP_MORE             0x40	/* More node to process in node tbl */
235 #define FC_OFFLINE_MODE         0x80	/* Interface is offline for diag */
236 #define FC_FABRIC               0x100	/* We are fabric attached */
237 #define FC_ESTABLISH_LINK       0x200	/* Reestablish Link */
238 #define FC_RSCN_DISCOVERY       0x400	/* Authenticate all devices after RSCN*/
239 #define FC_LOADING		0x1000	/* HBA in process of loading drvr */
240 #define FC_UNLOADING		0x2000	/* HBA in process of unloading drvr */
241 #define FC_SCSI_SCAN_TMO        0x4000	/* scsi scan timer running */
242 #define FC_ABORT_DISCOVERY      0x8000	/* we want to abort discovery */
243 #define FC_NDISC_ACTIVE         0x10000	/* NPort discovery active */
244 
245 	uint32_t fc_topology;	/* link topology, from LINK INIT */
246 
247 	struct lpfc_stats fc_stat;
248 
249 	/* These are the head/tail pointers for the bind, plogi, adisc, unmap,
250 	 *  and map lists.  Their counters are immediately following.
251 	 */
252 	struct list_head fc_plogi_list;
253 	struct list_head fc_adisc_list;
254 	struct list_head fc_reglogin_list;
255 	struct list_head fc_prli_list;
256 	struct list_head fc_nlpunmap_list;
257 	struct list_head fc_nlpmap_list;
258 	struct list_head fc_npr_list;
259 	struct list_head fc_unused_list;
260 
261 	/* Keep counters for the number of entries in each list. */
262 	uint16_t fc_plogi_cnt;
263 	uint16_t fc_adisc_cnt;
264 	uint16_t fc_reglogin_cnt;
265 	uint16_t fc_prli_cnt;
266 	uint16_t fc_unmap_cnt;
267 	uint16_t fc_map_cnt;
268 	uint16_t fc_npr_cnt;
269 	uint16_t fc_unused_cnt;
270 	struct lpfc_nodelist fc_fcpnodev; /* nodelist entry for no device */
271 	uint32_t nport_event_cnt;	/* timestamp for nlplist entry */
272 
273 #define LPFC_RPI_HASH_SIZE     64
274 #define LPFC_RPI_HASH_FUNC(x)  ((x) & (0x3f))
275 	/* ptr to active D_ID / RPIs */
276 	struct lpfc_nodelist *fc_nlplookup[LPFC_RPI_HASH_SIZE];
277 	uint32_t wwnn[2];
278 	uint32_t RandomData[7];
279 
280 	uint32_t cfg_log_verbose;
281 	uint32_t cfg_lun_queue_depth;
282 	uint32_t cfg_nodev_tmo;
283 	uint32_t cfg_hba_queue_depth;
284 	uint32_t cfg_fcp_class;
285 	uint32_t cfg_use_adisc;
286 	uint32_t cfg_ack0;
287 	uint32_t cfg_topology;
288 	uint32_t cfg_scan_down;
289 	uint32_t cfg_link_speed;
290 	uint32_t cfg_cr_delay;
291 	uint32_t cfg_cr_count;
292 	uint32_t cfg_fdmi_on;
293 	uint32_t cfg_fcp_bind_method;
294 	uint32_t cfg_discovery_threads;
295 	uint32_t cfg_max_luns;
296 	uint32_t cfg_sg_seg_cnt;
297 	uint32_t cfg_sg_dma_buf_size;
298 
299 	lpfc_vpd_t vpd;		/* vital product data */
300 
301 	struct Scsi_Host *host;
302 	struct pci_dev *pcidev;
303 	struct list_head      work_list;
304 	uint32_t              work_ha;      /* Host Attention Bits for WT */
305 	uint32_t              work_ha_mask; /* HA Bits owned by WT        */
306 	uint32_t              work_hs;      /* HS stored in case of ERRAT */
307 	uint32_t              work_status[2]; /* Extra status from SLIM */
308 	uint32_t              work_hba_events; /* Timeout to be handled  */
309 #define WORKER_DISC_TMO                0x1	/* Discovery timeout */
310 #define WORKER_ELS_TMO                 0x2	/* ELS timeout */
311 #define WORKER_MBOX_TMO                0x4	/* MBOX timeout */
312 #define WORKER_FDMI_TMO                0x8	/* FDMI timeout */
313 
314 	wait_queue_head_t    *work_wait;
315 	struct task_struct   *worker_thread;
316 
317 	unsigned long pci_bar0_map;     /* Physical address for PCI BAR0 */
318 	unsigned long pci_bar2_map;     /* Physical address for PCI BAR2 */
319 	void __iomem *slim_memmap_p;	/* Kernel memory mapped address for
320 					   PCI BAR0 */
321 	void __iomem *ctrl_regs_memmap_p;/* Kernel memory mapped address for
322 					    PCI BAR2 */
323 
324 	void __iomem *MBslimaddr;	/* virtual address for mbox cmds */
325 	void __iomem *HAregaddr;	/* virtual address for host attn reg */
326 	void __iomem *CAregaddr;	/* virtual address for chip attn reg */
327 	void __iomem *HSregaddr;	/* virtual address for host status
328 					   reg */
329 	void __iomem *HCregaddr;	/* virtual address for host ctl reg */
330 
331 	int brd_no;			/* FC board number */
332 
333 	char SerialNumber[32];		/* adapter Serial Number */
334 	char OptionROMVersion[32];	/* adapter BIOS / Fcode version */
335 	char ModelDesc[256];		/* Model Description */
336 	char ModelName[80];		/* Model Name */
337 	char ProgramType[256];		/* Program Type */
338 	char Port[20];			/* Port No */
339 	uint8_t vpd_flag;               /* VPD data flag */
340 
341 #define VPD_MODEL_DESC      0x1         /* valid vpd model description */
342 #define VPD_MODEL_NAME      0x2         /* valid vpd model name */
343 #define VPD_PROGRAM_TYPE    0x4         /* valid vpd program type */
344 #define VPD_PORT            0x8         /* valid vpd port data */
345 #define VPD_MASK            0xf         /* mask for any vpd data */
346 
347 	struct timer_list els_tmofunc;
348 
349 	void *link_stats;
350 
351 	/*
352 	 * stat  counters
353 	 */
354 	uint64_t fc4InputRequests;
355 	uint64_t fc4OutputRequests;
356 	uint64_t fc4ControlRequests;
357 
358 	struct lpfc_sysfs_mbox sysfs_mbox;
359 
360 	/* fastpath list. */
361 	struct list_head lpfc_scsi_buf_list;
362 	uint32_t total_scsi_bufs;
363 	struct list_head lpfc_iocb_list;
364 	uint32_t total_iocbq_bufs;
365 
366 	/* pci_mem_pools */
367 	struct pci_pool *lpfc_scsi_dma_buf_pool;
368 	struct pci_pool *lpfc_mbuf_pool;
369 	struct lpfc_dma_pool lpfc_mbuf_safety_pool;
370 
371 	mempool_t *mbox_mem_pool;
372 	mempool_t *nlp_mem_pool;
373 	struct list_head freebufList;
374 	struct list_head ctrspbuflist;
375 	struct list_head rnidrspbuflist;
376 };
377 
378 
379 struct rnidrsp {
380 	void *buf;
381 	uint32_t uniqueid;
382 	struct list_head list;
383 	uint32_t data;
384 };
385