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