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