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