xref: /openbmc/linux/drivers/scsi/lpfc/lpfc.h (revision df2634f43f5106947f3735a0b61a6527a4b278cd)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2010 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 #include <scsi/scsi_host.h>
23 struct lpfc_sli2_slim;
24 
25 #define LPFC_PCI_DEV_LP		0x1
26 #define LPFC_PCI_DEV_OC		0x2
27 
28 #define LPFC_SLI_REV2		2
29 #define LPFC_SLI_REV3		3
30 #define LPFC_SLI_REV4		4
31 
32 #define LPFC_MAX_TARGET		4096	/* max number of targets supported */
33 #define LPFC_MAX_DISC_THREADS	64	/* max outstanding discovery els
34 					   requests */
35 #define LPFC_MAX_NS_RETRY	3	/* Number of retry attempts to contact
36 					   the NameServer  before giving up. */
37 #define LPFC_CMD_PER_LUN	3	/* max outstanding cmds per lun */
38 #define LPFC_DEFAULT_SG_SEG_CNT 64	/* sg element count per scsi cmnd */
39 #define LPFC_DEFAULT_MENLO_SG_SEG_CNT 128	/* sg element count per scsi
40 		cmnd for menlo needs nearly twice as for firmware
41 		downloads using bsg */
42 #define LPFC_DEFAULT_PROT_SG_SEG_CNT 4096 /* sg protection elements count */
43 #define LPFC_MAX_SG_SEG_CNT	4096	/* sg element count per scsi cmnd */
44 #define LPFC_MAX_PROT_SG_SEG_CNT 4096	/* prot sg element count per scsi cmd*/
45 #define LPFC_IOCB_LIST_CNT	2250	/* list of IOCBs for fast-path usage. */
46 #define LPFC_Q_RAMP_UP_INTERVAL 120     /* lun q_depth ramp up interval */
47 #define LPFC_VNAME_LEN		100	/* vport symbolic name length */
48 #define LPFC_TGTQ_INTERVAL	40000	/* Min amount of time between tgt
49 					   queue depth change in millisecs */
50 #define LPFC_TGTQ_RAMPUP_PCENT	5	/* Target queue rampup in percentage */
51 #define LPFC_MIN_TGT_QDEPTH	10
52 #define LPFC_MAX_TGT_QDEPTH	0xFFFF
53 
54 #define  LPFC_MAX_BUCKET_COUNT 20	/* Maximum no. of buckets for stat data
55 					   collection. */
56 /*
57  * Following time intervals are used of adjusting SCSI device
58  * queue depths when there are driver resource error or Firmware
59  * resource error.
60  */
61 #define QUEUE_RAMP_DOWN_INTERVAL	(1 * HZ)   /* 1 Second */
62 #define QUEUE_RAMP_UP_INTERVAL		(300 * HZ) /* 5 minutes */
63 
64 /* Number of exchanges reserved for discovery to complete */
65 #define LPFC_DISC_IOCB_BUFF_COUNT 20
66 
67 #define LPFC_HB_MBOX_INTERVAL   5	/* Heart beat interval in seconds. */
68 #define LPFC_HB_MBOX_TIMEOUT    30	/* Heart beat timeout  in seconds. */
69 
70 /* Error Attention event polling interval */
71 #define LPFC_ERATT_POLL_INTERVAL	5 /* EATT poll interval in seconds */
72 
73 /* Define macros for 64 bit support */
74 #define putPaddrLow(addr)    ((uint32_t) (0xffffffff & (u64)(addr)))
75 #define putPaddrHigh(addr)   ((uint32_t) (0xffffffff & (((u64)(addr))>>32)))
76 #define getPaddr(high, low)  ((dma_addr_t)( \
77 			     (( (u64)(high)<<16 ) << 16)|( (u64)(low))))
78 /* Provide maximum configuration definitions. */
79 #define LPFC_DRVR_TIMEOUT	16	/* driver iocb timeout value in sec */
80 #define FC_MAX_ADPTMSG		64
81 
82 #define MAX_HBAEVT	32
83 
84 /* Number of MSI-X vectors the driver uses */
85 #define LPFC_MSIX_VECTORS	2
86 
87 /* lpfc wait event data ready flag */
88 #define LPFC_DATA_READY		(1<<0)
89 
90 enum lpfc_polling_flags {
91 	ENABLE_FCP_RING_POLLING = 0x1,
92 	DISABLE_FCP_RING_INT    = 0x2
93 };
94 
95 /* Provide DMA memory definitions the driver uses per port instance. */
96 struct lpfc_dmabuf {
97 	struct list_head list;
98 	void *virt;		/* virtual address ptr */
99 	dma_addr_t phys;	/* mapped address */
100 	uint32_t   buffer_tag;	/* used for tagged queue ring */
101 };
102 
103 struct lpfc_dma_pool {
104 	struct lpfc_dmabuf   *elements;
105 	uint32_t    max_count;
106 	uint32_t    current_count;
107 };
108 
109 struct hbq_dmabuf {
110 	struct lpfc_dmabuf hbuf;
111 	struct lpfc_dmabuf dbuf;
112 	uint32_t size;
113 	uint32_t tag;
114 	struct lpfc_cq_event cq_event;
115 	unsigned long time_stamp;
116 };
117 
118 /* Priority bit.  Set value to exceed low water mark in lpfc_mem. */
119 #define MEM_PRI		0x100
120 
121 
122 /****************************************************************************/
123 /*      Device VPD save area                                                */
124 /****************************************************************************/
125 typedef struct lpfc_vpd {
126 	uint32_t status;	/* vpd status value */
127 	uint32_t length;	/* number of bytes actually returned */
128 	struct {
129 		uint32_t rsvd1;	/* Revision numbers */
130 		uint32_t biuRev;
131 		uint32_t smRev;
132 		uint32_t smFwRev;
133 		uint32_t endecRev;
134 		uint16_t rBit;
135 		uint8_t fcphHigh;
136 		uint8_t fcphLow;
137 		uint8_t feaLevelHigh;
138 		uint8_t feaLevelLow;
139 		uint32_t postKernRev;
140 		uint32_t opFwRev;
141 		uint8_t opFwName[16];
142 		uint32_t sli1FwRev;
143 		uint8_t sli1FwName[16];
144 		uint32_t sli2FwRev;
145 		uint8_t sli2FwName[16];
146 	} rev;
147 	struct {
148 #ifdef __BIG_ENDIAN_BITFIELD
149 		uint32_t rsvd3  :19;  /* Reserved                             */
150 		uint32_t cdss	: 1;  /* Configure Data Security SLI          */
151 		uint32_t rsvd2	: 3;  /* Reserved                             */
152 		uint32_t cbg	: 1;  /* Configure BlockGuard                 */
153 		uint32_t cmv	: 1;  /* Configure Max VPIs                   */
154 		uint32_t ccrp   : 1;  /* Config Command Ring Polling          */
155 		uint32_t csah   : 1;  /* Configure Synchronous Abort Handling */
156 		uint32_t chbs   : 1;  /* Cofigure Host Backing store          */
157 		uint32_t cinb   : 1;  /* Enable Interrupt Notification Block  */
158 		uint32_t cerbm	: 1;  /* Configure Enhanced Receive Buf Mgmt  */
159 		uint32_t cmx	: 1;  /* Configure Max XRIs                   */
160 		uint32_t cmr	: 1;  /* Configure Max RPIs                   */
161 #else	/*  __LITTLE_ENDIAN */
162 		uint32_t cmr	: 1;  /* Configure Max RPIs                   */
163 		uint32_t cmx	: 1;  /* Configure Max XRIs                   */
164 		uint32_t cerbm	: 1;  /* Configure Enhanced Receive Buf Mgmt  */
165 		uint32_t cinb   : 1;  /* Enable Interrupt Notification Block  */
166 		uint32_t chbs   : 1;  /* Cofigure Host Backing store          */
167 		uint32_t csah   : 1;  /* Configure Synchronous Abort Handling */
168 		uint32_t ccrp   : 1;  /* Config Command Ring Polling          */
169 		uint32_t cmv	: 1;  /* Configure Max VPIs                   */
170 		uint32_t cbg	: 1;  /* Configure BlockGuard                 */
171 		uint32_t rsvd2	: 3;  /* Reserved                             */
172 		uint32_t cdss	: 1;  /* Configure Data Security SLI          */
173 		uint32_t rsvd3  :19;  /* Reserved                             */
174 #endif
175 	} sli3Feat;
176 } lpfc_vpd_t;
177 
178 struct lpfc_scsi_buf;
179 
180 
181 /*
182  * lpfc stat counters
183  */
184 struct lpfc_stats {
185 	/* Statistics for ELS commands */
186 	uint32_t elsLogiCol;
187 	uint32_t elsRetryExceeded;
188 	uint32_t elsXmitRetry;
189 	uint32_t elsDelayRetry;
190 	uint32_t elsRcvDrop;
191 	uint32_t elsRcvFrame;
192 	uint32_t elsRcvRSCN;
193 	uint32_t elsRcvRNID;
194 	uint32_t elsRcvFARP;
195 	uint32_t elsRcvFARPR;
196 	uint32_t elsRcvFLOGI;
197 	uint32_t elsRcvPLOGI;
198 	uint32_t elsRcvADISC;
199 	uint32_t elsRcvPDISC;
200 	uint32_t elsRcvFAN;
201 	uint32_t elsRcvLOGO;
202 	uint32_t elsRcvPRLO;
203 	uint32_t elsRcvPRLI;
204 	uint32_t elsRcvLIRR;
205 	uint32_t elsRcvRLS;
206 	uint32_t elsRcvRPS;
207 	uint32_t elsRcvRPL;
208 	uint32_t elsRcvRRQ;
209 	uint32_t elsRcvRTV;
210 	uint32_t elsRcvECHO;
211 	uint32_t elsXmitFLOGI;
212 	uint32_t elsXmitFDISC;
213 	uint32_t elsXmitPLOGI;
214 	uint32_t elsXmitPRLI;
215 	uint32_t elsXmitADISC;
216 	uint32_t elsXmitLOGO;
217 	uint32_t elsXmitSCR;
218 	uint32_t elsXmitRNID;
219 	uint32_t elsXmitFARP;
220 	uint32_t elsXmitFARPR;
221 	uint32_t elsXmitACC;
222 	uint32_t elsXmitLSRJT;
223 
224 	uint32_t frameRcvBcast;
225 	uint32_t frameRcvMulti;
226 	uint32_t strayXmitCmpl;
227 	uint32_t frameXmitDelay;
228 	uint32_t xriCmdCmpl;
229 	uint32_t xriStatErr;
230 	uint32_t LinkUp;
231 	uint32_t LinkDown;
232 	uint32_t LinkMultiEvent;
233 	uint32_t NoRcvBuf;
234 	uint32_t fcpCmd;
235 	uint32_t fcpCmpl;
236 	uint32_t fcpRspErr;
237 	uint32_t fcpRemoteStop;
238 	uint32_t fcpPortRjt;
239 	uint32_t fcpPortBusy;
240 	uint32_t fcpError;
241 	uint32_t fcpLocalErr;
242 };
243 
244 enum sysfs_mbox_state {
245 	SMBOX_IDLE,
246 	SMBOX_WRITING,
247 	SMBOX_READING
248 };
249 
250 struct lpfc_sysfs_mbox {
251 	enum sysfs_mbox_state state;
252 	size_t                offset;
253 	struct lpfcMboxq *    mbox;
254 };
255 
256 struct lpfc_hba;
257 
258 
259 enum discovery_state {
260 	LPFC_VPORT_UNKNOWN     =  0,    /* vport state is unknown */
261 	LPFC_VPORT_FAILED      =  1,    /* vport has failed */
262 	LPFC_LOCAL_CFG_LINK    =  6,    /* local NPORT Id configured */
263 	LPFC_FLOGI             =  7,    /* FLOGI sent to Fabric */
264 	LPFC_FDISC             =  8,    /* FDISC sent for vport */
265 	LPFC_FABRIC_CFG_LINK   =  9,    /* Fabric assigned NPORT Id
266 				         * configured */
267 	LPFC_NS_REG            =  10,   /* Register with NameServer */
268 	LPFC_NS_QRY            =  11,   /* Query NameServer for NPort ID list */
269 	LPFC_BUILD_DISC_LIST   =  12,   /* Build ADISC and PLOGI lists for
270 				         * device authentication / discovery */
271 	LPFC_DISC_AUTH         =  13,   /* Processing ADISC list */
272 	LPFC_VPORT_READY       =  32,
273 };
274 
275 enum hba_state {
276 	LPFC_LINK_UNKNOWN    =   0,   /* HBA state is unknown */
277 	LPFC_WARM_START      =   1,   /* HBA state after selective reset */
278 	LPFC_INIT_START      =   2,   /* Initial state after board reset */
279 	LPFC_INIT_MBX_CMDS   =   3,   /* Initialize HBA with mbox commands */
280 	LPFC_LINK_DOWN       =   4,   /* HBA initialized, link is down */
281 	LPFC_LINK_UP         =   5,   /* Link is up  - issue READ_LA */
282 	LPFC_CLEAR_LA        =   6,   /* authentication cmplt - issue
283 				       * CLEAR_LA */
284 	LPFC_HBA_READY       =  32,
285 	LPFC_HBA_ERROR       =  -1
286 };
287 
288 struct lpfc_vport {
289 	struct lpfc_hba *phba;
290 	struct list_head listentry;
291 	uint8_t port_type;
292 #define LPFC_PHYSICAL_PORT 1
293 #define LPFC_NPIV_PORT  2
294 #define LPFC_FABRIC_PORT 3
295 	enum discovery_state port_state;
296 
297 	uint16_t vpi;
298 	uint16_t vfi;
299 	uint8_t vpi_state;
300 #define LPFC_VPI_REGISTERED	0x1
301 
302 	uint32_t fc_flag;	/* FC flags */
303 /* Several of these flags are HBA centric and should be moved to
304  * phba->link_flag (e.g. FC_PTP, FC_PUBLIC_LOOP)
305  */
306 #define FC_PT2PT                0x1	 /* pt2pt with no fabric */
307 #define FC_PT2PT_PLOGI          0x2	 /* pt2pt initiate PLOGI */
308 #define FC_DISC_TMO             0x4	 /* Discovery timer running */
309 #define FC_PUBLIC_LOOP          0x8	 /* Public loop */
310 #define FC_LBIT                 0x10	 /* LOGIN bit in loopinit set */
311 #define FC_RSCN_MODE            0x20	 /* RSCN cmd rcv'ed */
312 #define FC_NLP_MORE             0x40	 /* More node to process in node tbl */
313 #define FC_OFFLINE_MODE         0x80	 /* Interface is offline for diag */
314 #define FC_FABRIC               0x100	 /* We are fabric attached */
315 #define FC_VPORT_LOGO_RCVD      0x200    /* LOGO received on vport */
316 #define FC_RSCN_DISCOVERY       0x400	 /* Auth all devices after RSCN */
317 #define FC_LOGO_RCVD_DID_CHNG   0x800    /* FDISC on phys port detect DID chng*/
318 #define FC_SCSI_SCAN_TMO        0x4000	 /* scsi scan timer running */
319 #define FC_ABORT_DISCOVERY      0x8000	 /* we want to abort discovery */
320 #define FC_NDISC_ACTIVE         0x10000	 /* NPort discovery active */
321 #define FC_BYPASSED_MODE        0x20000	 /* NPort is in bypassed mode */
322 #define FC_VPORT_NEEDS_REG_VPI	0x80000  /* Needs to have its vpi registered */
323 #define FC_RSCN_DEFERRED	0x100000 /* A deferred RSCN being processed */
324 #define FC_VPORT_NEEDS_INIT_VPI 0x200000 /* Need to INIT_VPI before FDISC */
325 #define FC_VPORT_CVL_RCVD	0x400000 /* VLink failed due to CVL	 */
326 #define FC_VFI_REGISTERED	0x800000 /* VFI is registered */
327 #define FC_FDISC_COMPLETED	0x1000000/* FDISC completed */
328 
329 	uint32_t ct_flags;
330 #define FC_CT_RFF_ID		0x1	 /* RFF_ID accepted by switch */
331 #define FC_CT_RNN_ID		0x2	 /* RNN_ID accepted by switch */
332 #define FC_CT_RSNN_NN		0x4	 /* RSNN_NN accepted by switch */
333 #define FC_CT_RSPN_ID		0x8	 /* RSPN_ID accepted by switch */
334 #define FC_CT_RFT_ID		0x10	 /* RFT_ID accepted by switch */
335 
336 	struct list_head fc_nodes;
337 
338 	/* Keep counters for the number of entries in each list. */
339 	uint16_t fc_plogi_cnt;
340 	uint16_t fc_adisc_cnt;
341 	uint16_t fc_reglogin_cnt;
342 	uint16_t fc_prli_cnt;
343 	uint16_t fc_unmap_cnt;
344 	uint16_t fc_map_cnt;
345 	uint16_t fc_npr_cnt;
346 	uint16_t fc_unused_cnt;
347 	struct serv_parm fc_sparam;	/* buffer for our service parameters */
348 
349 	uint32_t fc_myDID;	/* fibre channel S_ID */
350 	uint32_t fc_prevDID;	/* previous fibre channel S_ID */
351 
352 	int32_t stopped;   /* HBA has not been restarted since last ERATT */
353 	uint8_t fc_linkspeed;	/* Link speed after last READ_LA */
354 
355 	uint32_t num_disc_nodes;	/*in addition to hba_state */
356 
357 	uint32_t fc_nlp_cnt;	/* outstanding NODELIST requests */
358 	uint32_t fc_rscn_id_cnt;	/* count of RSCNs payloads in list */
359 	uint32_t fc_rscn_flush;		/* flag use of fc_rscn_id_list */
360 	struct lpfc_dmabuf *fc_rscn_id_list[FC_MAX_HOLD_RSCN];
361 	struct lpfc_name fc_nodename;	/* fc nodename */
362 	struct lpfc_name fc_portname;	/* fc portname */
363 
364 	struct lpfc_work_evt disc_timeout_evt;
365 
366 	struct timer_list fc_disctmo;	/* Discovery rescue timer */
367 	uint8_t fc_ns_retry;	/* retries for fabric nameserver */
368 	uint32_t fc_prli_sent;	/* cntr for outstanding PRLIs */
369 
370 	spinlock_t work_port_lock;
371 	uint32_t work_port_events; /* Timeout to be handled  */
372 #define WORKER_DISC_TMO                0x1	/* vport: Discovery timeout */
373 #define WORKER_ELS_TMO                 0x2	/* vport: ELS timeout */
374 #define WORKER_FDMI_TMO                0x4	/* vport: FDMI timeout */
375 
376 #define WORKER_MBOX_TMO                0x100	/* hba: MBOX timeout */
377 #define WORKER_HB_TMO                  0x200	/* hba: Heart beat timeout */
378 #define WORKER_FABRIC_BLOCK_TMO        0x400	/* hba: fabric block timeout */
379 #define WORKER_RAMP_DOWN_QUEUE         0x800	/* hba: Decrease Q depth */
380 #define WORKER_RAMP_UP_QUEUE           0x1000	/* hba: Increase Q depth */
381 #define WORKER_SERVICE_TXQ             0x2000	/* hba: IOCBs on the txq */
382 
383 	struct timer_list fc_fdmitmo;
384 	struct timer_list els_tmofunc;
385 
386 	int unreg_vpi_cmpl;
387 
388 	uint8_t load_flag;
389 #define FC_LOADING		0x1	/* HBA in process of loading drvr */
390 #define FC_UNLOADING		0x2	/* HBA in process of unloading drvr */
391 	/* Vport Config Parameters */
392 	uint32_t cfg_scan_down;
393 	uint32_t cfg_lun_queue_depth;
394 	uint32_t cfg_nodev_tmo;
395 	uint32_t cfg_devloss_tmo;
396 	uint32_t cfg_restrict_login;
397 	uint32_t cfg_peer_port_login;
398 	uint32_t cfg_fcp_class;
399 	uint32_t cfg_use_adisc;
400 	uint32_t cfg_fdmi_on;
401 	uint32_t cfg_discovery_threads;
402 	uint32_t cfg_log_verbose;
403 	uint32_t cfg_max_luns;
404 	uint32_t cfg_enable_da_id;
405 	uint32_t cfg_max_scsicmpl_time;
406 	uint32_t cfg_tgt_queue_depth;
407 
408 	uint32_t dev_loss_tmo_changed;
409 
410 	struct fc_vport *fc_vport;
411 
412 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
413 	struct dentry *debug_disc_trc;
414 	struct dentry *debug_nodelist;
415 	struct dentry *vport_debugfs_root;
416 	struct lpfc_debugfs_trc *disc_trc;
417 	atomic_t disc_trc_cnt;
418 #endif
419 	uint8_t stat_data_enabled;
420 	uint8_t stat_data_blocked;
421 	struct list_head rcv_buffer_list;
422 	unsigned long rcv_buffer_time_stamp;
423 	uint32_t vport_flag;
424 #define STATIC_VPORT	1
425 };
426 
427 struct hbq_s {
428 	uint16_t entry_count;	  /* Current number of HBQ slots */
429 	uint16_t buffer_count;	  /* Current number of buffers posted */
430 	uint32_t next_hbqPutIdx;  /* Index to next HBQ slot to use */
431 	uint32_t hbqPutIdx;	  /* HBQ slot to use */
432 	uint32_t local_hbqGetIdx; /* Local copy of Get index from Port */
433 	void    *hbq_virt;	  /* Virtual ptr to this hbq */
434 	struct list_head hbq_buffer_list;  /* buffers assigned to this HBQ */
435 				  /* Callback for HBQ buffer allocation */
436 	struct hbq_dmabuf *(*hbq_alloc_buffer) (struct lpfc_hba *);
437 				  /* Callback for HBQ buffer free */
438 	void               (*hbq_free_buffer) (struct lpfc_hba *,
439 					       struct hbq_dmabuf *);
440 };
441 
442 #define LPFC_MAX_HBQS  4
443 /* this matches the position in the lpfc_hbq_defs array */
444 #define LPFC_ELS_HBQ	0
445 #define LPFC_EXTRA_HBQ	1
446 
447 enum hba_temp_state {
448 	HBA_NORMAL_TEMP,
449 	HBA_OVER_TEMP
450 };
451 
452 enum intr_type_t {
453 	NONE = 0,
454 	INTx,
455 	MSI,
456 	MSIX,
457 };
458 
459 struct unsol_rcv_ct_ctx {
460 	uint32_t ctxt_id;
461 	uint32_t SID;
462 	uint32_t oxid;
463 	uint32_t flags;
464 #define UNSOL_VALID	0x00000001
465 };
466 
467 #define LPFC_USER_LINK_SPEED_AUTO	0	/* auto select (default)*/
468 #define LPFC_USER_LINK_SPEED_1G		1	/* 1 Gigabaud */
469 #define LPFC_USER_LINK_SPEED_2G		2	/* 2 Gigabaud */
470 #define LPFC_USER_LINK_SPEED_4G		4	/* 4 Gigabaud */
471 #define LPFC_USER_LINK_SPEED_8G		8	/* 8 Gigabaud */
472 #define LPFC_USER_LINK_SPEED_10G	10	/* 10 Gigabaud */
473 #define LPFC_USER_LINK_SPEED_16G	16	/* 16 Gigabaud */
474 #define LPFC_USER_LINK_SPEED_MAX	LPFC_USER_LINK_SPEED_16G
475 #define LPFC_USER_LINK_SPEED_BITMAP ((1 << LPFC_USER_LINK_SPEED_16G) | \
476 				     (1 << LPFC_USER_LINK_SPEED_10G) | \
477 				     (1 << LPFC_USER_LINK_SPEED_8G) | \
478 				     (1 << LPFC_USER_LINK_SPEED_4G) | \
479 				     (1 << LPFC_USER_LINK_SPEED_2G) | \
480 				     (1 << LPFC_USER_LINK_SPEED_1G) | \
481 				     (1 << LPFC_USER_LINK_SPEED_AUTO))
482 #define LPFC_LINK_SPEED_STRING "0, 1, 2, 4, 8, 10, 16"
483 
484 struct lpfc_hba {
485 	/* SCSI interface function jump table entries */
486 	int (*lpfc_new_scsi_buf)
487 		(struct lpfc_vport *, int);
488 	struct lpfc_scsi_buf * (*lpfc_get_scsi_buf)
489 		(struct lpfc_hba *, struct lpfc_nodelist *);
490 	int (*lpfc_scsi_prep_dma_buf)
491 		(struct lpfc_hba *, struct lpfc_scsi_buf *);
492 	void (*lpfc_scsi_unprep_dma_buf)
493 		(struct lpfc_hba *, struct lpfc_scsi_buf *);
494 	void (*lpfc_release_scsi_buf)
495 		(struct lpfc_hba *, struct lpfc_scsi_buf *);
496 	void (*lpfc_rampdown_queue_depth)
497 		(struct lpfc_hba *);
498 	void (*lpfc_scsi_prep_cmnd)
499 		(struct lpfc_vport *, struct lpfc_scsi_buf *,
500 		 struct lpfc_nodelist *);
501 	/* IOCB interface function jump table entries */
502 	int (*__lpfc_sli_issue_iocb)
503 		(struct lpfc_hba *, uint32_t,
504 		 struct lpfc_iocbq *, uint32_t);
505 	void (*__lpfc_sli_release_iocbq)(struct lpfc_hba *,
506 			 struct lpfc_iocbq *);
507 	int (*lpfc_hba_down_post)(struct lpfc_hba *phba);
508 
509 
510 	IOCB_t * (*lpfc_get_iocb_from_iocbq)
511 		(struct lpfc_iocbq *);
512 	void (*lpfc_scsi_cmd_iocb_cmpl)
513 		(struct lpfc_hba *, struct lpfc_iocbq *, struct lpfc_iocbq *);
514 
515 	/* MBOX interface function jump table entries */
516 	int (*lpfc_sli_issue_mbox)
517 		(struct lpfc_hba *, LPFC_MBOXQ_t *, uint32_t);
518 	/* Slow-path IOCB process function jump table entries */
519 	void (*lpfc_sli_handle_slow_ring_event)
520 		(struct lpfc_hba *phba, struct lpfc_sli_ring *pring,
521 		 uint32_t mask);
522 	/* INIT device interface function jump table entries */
523 	int (*lpfc_sli_hbq_to_firmware)
524 		(struct lpfc_hba *, uint32_t, struct hbq_dmabuf *);
525 	int (*lpfc_sli_brdrestart)
526 		(struct lpfc_hba *);
527 	int (*lpfc_sli_brdready)
528 		(struct lpfc_hba *, uint32_t);
529 	void (*lpfc_handle_eratt)
530 		(struct lpfc_hba *);
531 	void (*lpfc_stop_port)
532 		(struct lpfc_hba *);
533 	int (*lpfc_hba_init_link)
534 		(struct lpfc_hba *, uint32_t);
535 	int (*lpfc_hba_down_link)
536 		(struct lpfc_hba *, uint32_t);
537 
538 	/* SLI4 specific HBA data structure */
539 	struct lpfc_sli4_hba sli4_hba;
540 
541 	struct lpfc_sli sli;
542 	uint8_t pci_dev_grp;	/* lpfc PCI dev group: 0x0, 0x1, 0x2,... */
543 	uint32_t sli_rev;		/* SLI2, SLI3, or SLI4 */
544 	uint32_t sli3_options;		/* Mask of enabled SLI3 options */
545 #define LPFC_SLI3_HBQ_ENABLED		0x01
546 #define LPFC_SLI3_NPIV_ENABLED		0x02
547 #define LPFC_SLI3_VPORT_TEARDOWN	0x04
548 #define LPFC_SLI3_CRP_ENABLED		0x08
549 #define LPFC_SLI3_BG_ENABLED		0x20
550 #define LPFC_SLI3_DSS_ENABLED		0x40
551 	uint32_t iocb_cmd_size;
552 	uint32_t iocb_rsp_size;
553 
554 	enum hba_state link_state;
555 	uint32_t link_flag;	/* link state flags */
556 #define LS_LOOPBACK_MODE      0x1	/* NPort is in Loopback mode */
557 					/* This flag is set while issuing */
558 					/* INIT_LINK mailbox command */
559 #define LS_NPIV_FAB_SUPPORTED 0x2	/* Fabric supports NPIV */
560 #define LS_IGNORE_ERATT       0x4	/* intr handler should ignore ERATT */
561 
562 	uint32_t hba_flag;	/* hba generic flags */
563 #define HBA_ERATT_HANDLED	0x1 /* This flag is set when eratt handled */
564 #define DEFER_ERATT		0x2 /* Deferred error attention in progress */
565 #define HBA_FCOE_MODE		0x4 /* HBA function in FCoE Mode */
566 #define HBA_SP_QUEUE_EVT	0x8 /* Slow-path qevt posted to worker thread*/
567 #define HBA_POST_RECEIVE_BUFFER 0x10 /* Rcv buffers need to be posted */
568 #define FCP_XRI_ABORT_EVENT	0x20
569 #define ELS_XRI_ABORT_EVENT	0x40
570 #define ASYNC_EVENT		0x80
571 #define LINK_DISABLED		0x100 /* Link disabled by user */
572 #define FCF_TS_INPROG           0x200 /* FCF table scan in progress */
573 #define FCF_RR_INPROG           0x400 /* FCF roundrobin flogi in progress */
574 #define HBA_FIP_SUPPORT		0x800 /* FIP support in HBA */
575 #define HBA_AER_ENABLED		0x1000 /* AER enabled with HBA */
576 #define HBA_DEVLOSS_TMO         0x2000 /* HBA in devloss timeout */
577 #define HBA_RRQ_ACTIVE		0x4000 /* process the rrq active list */
578 	uint32_t fcp_ring_in_use; /* When polling test if intr-hndlr active*/
579 	struct lpfc_dmabuf slim2p;
580 
581 	MAILBOX_t *mbox;
582 	uint32_t *mbox_ext;
583 	uint32_t ha_copy;
584 	struct _PCB *pcb;
585 	struct _IOCB *IOCBs;
586 
587 	struct lpfc_dmabuf hbqslimp;
588 
589 	uint16_t pci_cfg_value;
590 
591 	uint8_t fc_linkspeed;	/* Link speed after last READ_LA */
592 
593 	uint32_t fc_eventTag;	/* event tag for link attention */
594 	uint32_t link_events;
595 
596 	/* These fields used to be binfo */
597 	uint32_t fc_pref_DID;	/* preferred D_ID */
598 	uint8_t  fc_pref_ALPA;	/* preferred AL_PA */
599 	uint32_t fc_edtovResol; /* E_D_TOV timer resolution */
600 	uint32_t fc_edtov;	/* E_D_TOV timer value */
601 	uint32_t fc_arbtov;	/* ARB_TOV timer value */
602 	uint32_t fc_ratov;	/* R_A_TOV timer value */
603 	uint32_t fc_rttov;	/* R_T_TOV timer value */
604 	uint32_t fc_altov;	/* AL_TOV timer value */
605 	uint32_t fc_crtov;	/* C_R_TOV timer value */
606 	uint32_t fc_citov;	/* C_I_TOV timer value */
607 
608 	struct serv_parm fc_fabparam;	/* fabric service parameters buffer */
609 	uint8_t alpa_map[128];	/* AL_PA map from READ_LA */
610 
611 	uint32_t lmt;
612 
613 	uint32_t fc_topology;	/* link topology, from LINK INIT */
614 
615 	struct lpfc_stats fc_stat;
616 
617 	struct lpfc_nodelist fc_fcpnodev; /* nodelist entry for no device */
618 	uint32_t nport_event_cnt;	/* timestamp for nlplist entry */
619 
620 	uint8_t  wwnn[8];
621 	uint8_t  wwpn[8];
622 	uint32_t RandomData[7];
623 
624 	/* HBA Config Parameters */
625 	uint32_t cfg_ack0;
626 	uint32_t cfg_enable_npiv;
627 	uint32_t cfg_enable_rrq;
628 	uint32_t cfg_topology;
629 	uint32_t cfg_link_speed;
630 	uint32_t cfg_cr_delay;
631 	uint32_t cfg_cr_count;
632 	uint32_t cfg_multi_ring_support;
633 	uint32_t cfg_multi_ring_rctl;
634 	uint32_t cfg_multi_ring_type;
635 	uint32_t cfg_poll;
636 	uint32_t cfg_poll_tmo;
637 	uint32_t cfg_use_msi;
638 	uint32_t cfg_fcp_imax;
639 	uint32_t cfg_fcp_wq_count;
640 	uint32_t cfg_fcp_eq_count;
641 	uint32_t cfg_sg_seg_cnt;
642 	uint32_t cfg_prot_sg_seg_cnt;
643 	uint32_t cfg_sg_dma_buf_size;
644 	uint64_t cfg_soft_wwnn;
645 	uint64_t cfg_soft_wwpn;
646 	uint32_t cfg_hba_queue_depth;
647 	uint32_t cfg_enable_hba_reset;
648 	uint32_t cfg_enable_hba_heartbeat;
649 	uint32_t cfg_enable_bg;
650 	uint32_t cfg_hostmem_hgp;
651 	uint32_t cfg_log_verbose;
652 	uint32_t cfg_aer_support;
653 	uint32_t cfg_iocb_cnt;
654 	uint32_t cfg_suppress_link_up;
655 #define LPFC_INITIALIZE_LINK              0	/* do normal init_link mbox */
656 #define LPFC_DELAY_INIT_LINK              1	/* layered driver hold off */
657 #define LPFC_DELAY_INIT_LINK_INDEFINITELY 2	/* wait, manual intervention */
658 
659 	lpfc_vpd_t vpd;		/* vital product data */
660 
661 	struct pci_dev *pcidev;
662 	struct list_head      work_list;
663 	uint32_t              work_ha;      /* Host Attention Bits for WT */
664 	uint32_t              work_ha_mask; /* HA Bits owned by WT        */
665 	uint32_t              work_hs;      /* HS stored in case of ERRAT */
666 	uint32_t              work_status[2]; /* Extra status from SLIM */
667 
668 	wait_queue_head_t    work_waitq;
669 	struct task_struct   *worker_thread;
670 	unsigned long data_flags;
671 
672 	uint32_t hbq_in_use;		/* HBQs in use flag */
673 	struct list_head rb_pend_list;  /* Received buffers to be processed */
674 	uint32_t hbq_count;	        /* Count of configured HBQs */
675 	struct hbq_s hbqs[LPFC_MAX_HBQS]; /* local copy of hbq indicies  */
676 
677 	uint32_t fcp_qidx;		/* next work queue to post work to */
678 
679 	unsigned long pci_bar0_map;     /* Physical address for PCI BAR0 */
680 	unsigned long pci_bar1_map;     /* Physical address for PCI BAR1 */
681 	unsigned long pci_bar2_map;     /* Physical address for PCI BAR2 */
682 	void __iomem *slim_memmap_p;	/* Kernel memory mapped address for
683 					   PCI BAR0 */
684 	void __iomem *ctrl_regs_memmap_p;/* Kernel memory mapped address for
685 					    PCI BAR2 */
686 
687 	void __iomem *MBslimaddr;	/* virtual address for mbox cmds */
688 	void __iomem *HAregaddr;	/* virtual address for host attn reg */
689 	void __iomem *CAregaddr;	/* virtual address for chip attn reg */
690 	void __iomem *HSregaddr;	/* virtual address for host status
691 					   reg */
692 	void __iomem *HCregaddr;	/* virtual address for host ctl reg */
693 
694 	struct lpfc_hgp __iomem *host_gp; /* Host side get/put pointers */
695 	struct lpfc_pgp   *port_gp;
696 	uint32_t __iomem  *hbq_put;     /* Address in SLIM to HBQ put ptrs */
697 	uint32_t          *hbq_get;     /* Host mem address of HBQ get ptrs */
698 
699 	int brd_no;			/* FC board number */
700 
701 	char SerialNumber[32];		/* adapter Serial Number */
702 	char OptionROMVersion[32];	/* adapter BIOS / Fcode version */
703 	char ModelDesc[256];		/* Model Description */
704 	char ModelName[80];		/* Model Name */
705 	char ProgramType[256];		/* Program Type */
706 	char Port[20];			/* Port No */
707 	uint8_t vpd_flag;               /* VPD data flag */
708 
709 #define VPD_MODEL_DESC      0x1         /* valid vpd model description */
710 #define VPD_MODEL_NAME      0x2         /* valid vpd model name */
711 #define VPD_PROGRAM_TYPE    0x4         /* valid vpd program type */
712 #define VPD_PORT            0x8         /* valid vpd port data */
713 #define VPD_MASK            0xf         /* mask for any vpd data */
714 
715 	uint8_t soft_wwn_enable;
716 
717 	struct timer_list fcp_poll_timer;
718 	struct timer_list eratt_poll;
719 
720 	/*
721 	 * stat  counters
722 	 */
723 	uint64_t fc4InputRequests;
724 	uint64_t fc4OutputRequests;
725 	uint64_t fc4ControlRequests;
726 	uint64_t bg_guard_err_cnt;
727 	uint64_t bg_apptag_err_cnt;
728 	uint64_t bg_reftag_err_cnt;
729 
730 	struct lpfc_sysfs_mbox sysfs_mbox;
731 
732 	/* fastpath list. */
733 	spinlock_t scsi_buf_list_lock;
734 	struct list_head lpfc_scsi_buf_list;
735 	uint32_t total_scsi_bufs;
736 	struct list_head lpfc_iocb_list;
737 	uint32_t total_iocbq_bufs;
738 	struct list_head active_rrq_list;
739 	spinlock_t hbalock;
740 
741 	/* pci_mem_pools */
742 	struct pci_pool *lpfc_scsi_dma_buf_pool;
743 	struct pci_pool *lpfc_mbuf_pool;
744 	struct pci_pool *lpfc_hrb_pool;	/* header receive buffer pool */
745 	struct pci_pool *lpfc_drb_pool; /* data receive buffer pool */
746 	struct pci_pool *lpfc_hbq_pool;	/* SLI3 hbq buffer pool */
747 	struct lpfc_dma_pool lpfc_mbuf_safety_pool;
748 
749 	mempool_t *mbox_mem_pool;
750 	mempool_t *nlp_mem_pool;
751 	mempool_t *rrq_pool;
752 
753 	struct fc_host_statistics link_stats;
754 	enum intr_type_t intr_type;
755 	uint32_t intr_mode;
756 #define LPFC_INTR_ERROR	0xFFFFFFFF
757 	struct msix_entry msix_entries[LPFC_MSIX_VECTORS];
758 
759 	struct list_head port_list;
760 	struct lpfc_vport *pport;	/* physical lpfc_vport pointer */
761 	uint16_t max_vpi;		/* Maximum virtual nports */
762 #define LPFC_MAX_VPI 0xFFFF		/* Max number of VPI supported */
763 	uint16_t max_vports;            /*
764 					 * For IOV HBAs max_vpi can change
765 					 * after a reset. max_vports is max
766 					 * number of vports present. This can
767 					 * be greater than max_vpi.
768 					 */
769 	uint16_t vpi_base;
770 	uint16_t vfi_base;
771 	unsigned long *vpi_bmask;	/* vpi allocation table */
772 
773 	/* Data structure used by fabric iocb scheduler */
774 	struct list_head fabric_iocb_list;
775 	atomic_t fabric_iocb_count;
776 	struct timer_list fabric_block_timer;
777 	unsigned long bit_flags;
778 #define	FABRIC_COMANDS_BLOCKED	0
779 	atomic_t num_rsrc_err;
780 	atomic_t num_cmd_success;
781 	unsigned long last_rsrc_error_time;
782 	unsigned long last_ramp_down_time;
783 	unsigned long last_ramp_up_time;
784 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
785 	struct dentry *hba_debugfs_root;
786 	atomic_t debugfs_vport_count;
787 	struct dentry *debug_hbqinfo;
788 	struct dentry *debug_dumpHostSlim;
789 	struct dentry *debug_dumpHBASlim;
790 	struct dentry *debug_dumpData;   /* BlockGuard BPL*/
791 	struct dentry *debug_dumpDif;    /* BlockGuard BPL*/
792 	struct dentry *debug_slow_ring_trc;
793 	struct lpfc_debugfs_trc *slow_ring_trc;
794 	atomic_t slow_ring_trc_cnt;
795 #endif
796 
797 	/* Used for deferred freeing of ELS data buffers */
798 	struct list_head elsbuf;
799 	int elsbuf_cnt;
800 	int elsbuf_prev_cnt;
801 
802 	uint8_t temp_sensor_support;
803 	/* Fields used for heart beat. */
804 	unsigned long last_completion_time;
805 	unsigned long skipped_hb;
806 	struct timer_list hb_tmofunc;
807 	uint8_t hb_outstanding;
808 	struct timer_list rrq_tmr;
809 	enum hba_temp_state over_temp_state;
810 	/* ndlp reference management */
811 	spinlock_t ndlp_lock;
812 	/*
813 	 * Following bit will be set for all buffer tags which are not
814 	 * associated with any HBQ.
815 	 */
816 #define QUE_BUFTAG_BIT  (1<<31)
817 	uint32_t buffer_tag_count;
818 	int wait_4_mlo_maint_flg;
819 	wait_queue_head_t wait_4_mlo_m_q;
820 	/* data structure used for latency data collection */
821 #define LPFC_NO_BUCKET	   0
822 #define LPFC_LINEAR_BUCKET 1
823 #define LPFC_POWER2_BUCKET 2
824 	uint8_t  bucket_type;
825 	uint32_t bucket_base;
826 	uint32_t bucket_step;
827 
828 /* Maximum number of events that can be outstanding at any time*/
829 #define LPFC_MAX_EVT_COUNT 512
830 	atomic_t fast_event_count;
831 	uint32_t fcoe_eventtag;
832 	uint32_t fcoe_eventtag_at_fcf_scan;
833 	struct lpfc_fcf fcf;
834 	uint8_t fc_map[3];
835 	uint8_t valid_vlan;
836 	uint16_t vlan_id;
837 	struct list_head fcf_conn_rec_list;
838 
839 	spinlock_t ct_ev_lock; /* synchronize access to ct_ev_waiters */
840 	struct list_head ct_ev_waiters;
841 	struct unsol_rcv_ct_ctx ct_ctx[64];
842 	uint32_t ctx_idx;
843 
844 	uint8_t menlo_flag;	/* menlo generic flags */
845 #define HBA_MENLO_SUPPORT	0x1 /* HBA supports menlo commands */
846 	uint32_t iocb_cnt;
847 	uint32_t iocb_max;
848 	atomic_t sdev_cnt;
849 	uint8_t fips_spec_rev;
850 	uint8_t fips_level;
851 };
852 
853 static inline struct Scsi_Host *
854 lpfc_shost_from_vport(struct lpfc_vport *vport)
855 {
856 	return container_of((void *) vport, struct Scsi_Host, hostdata[0]);
857 }
858 
859 static inline void
860 lpfc_set_loopback_flag(struct lpfc_hba *phba)
861 {
862 	if (phba->cfg_topology == FLAGS_LOCAL_LB)
863 		phba->link_flag |= LS_LOOPBACK_MODE;
864 	else
865 		phba->link_flag &= ~LS_LOOPBACK_MODE;
866 }
867 
868 static inline int
869 lpfc_is_link_up(struct lpfc_hba *phba)
870 {
871 	return  phba->link_state == LPFC_LINK_UP ||
872 		phba->link_state == LPFC_CLEAR_LA ||
873 		phba->link_state == LPFC_HBA_READY;
874 }
875 
876 static inline void
877 lpfc_worker_wake_up(struct lpfc_hba *phba)
878 {
879 	/* Set the lpfc data pending flag */
880 	set_bit(LPFC_DATA_READY, &phba->data_flags);
881 
882 	/* Wake up worker thread */
883 	wake_up(&phba->work_waitq);
884 	return;
885 }
886 
887 static inline void
888 lpfc_sli_read_hs(struct lpfc_hba *phba)
889 {
890 	/*
891 	 * There was a link/board error. Read the status register to retrieve
892 	 * the error event and process it.
893 	 */
894 	phba->sli.slistat.err_attn_event++;
895 
896 	/* Save status info */
897 	phba->work_hs = readl(phba->HSregaddr);
898 	phba->work_status[0] = readl(phba->MBslimaddr + 0xa8);
899 	phba->work_status[1] = readl(phba->MBslimaddr + 0xac);
900 
901 	/* Clear chip Host Attention error bit */
902 	writel(HA_ERATT, phba->HAregaddr);
903 	readl(phba->HAregaddr); /* flush */
904 	phba->pport->stopped = 1;
905 
906 	return;
907 }
908