74f4d18842cc1766d4a67130cc3154c340eb2c3b
[safe/jmp/linux-2.6] / drivers / scsi / lpfc / lpfc.h
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2007 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 struct lpfc_sli2_slim;
25
26
27 #define LPFC_MAX_TARGET         256     /* max number of targets supported */
28 #define LPFC_MAX_DISC_THREADS   64      /* max outstanding discovery els
29                                            requests */
30 #define LPFC_MAX_NS_RETRY       3       /* Number of retry attempts to contact
31                                            the NameServer  before giving up. */
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 FC_MAX_ADPTMSG          64
45
46 #define MAX_HBAEVT      32
47
48 enum lpfc_polling_flags {
49         ENABLE_FCP_RING_POLLING = 0x1,
50         DISABLE_FCP_RING_INT    = 0x2
51 };
52
53 /* Provide DMA memory definitions the driver uses per port instance. */
54 struct lpfc_dmabuf {
55         struct list_head list;
56         void *virt;             /* virtual address ptr */
57         dma_addr_t phys;        /* mapped address */
58 };
59
60 struct lpfc_dma_pool {
61         struct lpfc_dmabuf   *elements;
62         uint32_t    max_count;
63         uint32_t    current_count;
64 };
65
66 struct hbq_dmabuf {
67         struct lpfc_dmabuf dbuf;
68         uint32_t tag;
69 };
70
71 /* Priority bit.  Set value to exceed low water mark in lpfc_mem. */
72 #define MEM_PRI         0x100
73
74
75 /****************************************************************************/
76 /*      Device VPD save area                                                */
77 /****************************************************************************/
78 typedef struct lpfc_vpd {
79         uint32_t status;        /* vpd status value */
80         uint32_t length;        /* number of bytes actually returned */
81         struct {
82                 uint32_t rsvd1; /* Revision numbers */
83                 uint32_t biuRev;
84                 uint32_t smRev;
85                 uint32_t smFwRev;
86                 uint32_t endecRev;
87                 uint16_t rBit;
88                 uint8_t fcphHigh;
89                 uint8_t fcphLow;
90                 uint8_t feaLevelHigh;
91                 uint8_t feaLevelLow;
92                 uint32_t postKernRev;
93                 uint32_t opFwRev;
94                 uint8_t opFwName[16];
95                 uint32_t sli1FwRev;
96                 uint8_t sli1FwName[16];
97                 uint32_t sli2FwRev;
98                 uint8_t sli2FwName[16];
99         } rev;
100 } lpfc_vpd_t;
101
102 struct lpfc_scsi_buf;
103
104
105 /*
106  * lpfc stat counters
107  */
108 struct lpfc_stats {
109         /* Statistics for ELS commands */
110         uint32_t elsLogiCol;
111         uint32_t elsRetryExceeded;
112         uint32_t elsXmitRetry;
113         uint32_t elsDelayRetry;
114         uint32_t elsRcvDrop;
115         uint32_t elsRcvFrame;
116         uint32_t elsRcvRSCN;
117         uint32_t elsRcvRNID;
118         uint32_t elsRcvFARP;
119         uint32_t elsRcvFARPR;
120         uint32_t elsRcvFLOGI;
121         uint32_t elsRcvPLOGI;
122         uint32_t elsRcvADISC;
123         uint32_t elsRcvPDISC;
124         uint32_t elsRcvFAN;
125         uint32_t elsRcvLOGO;
126         uint32_t elsRcvPRLO;
127         uint32_t elsRcvPRLI;
128         uint32_t elsRcvLIRR;
129         uint32_t elsRcvRPS;
130         uint32_t elsRcvRPL;
131         uint32_t elsXmitFLOGI;
132         uint32_t elsXmitPLOGI;
133         uint32_t elsXmitPRLI;
134         uint32_t elsXmitADISC;
135         uint32_t elsXmitLOGO;
136         uint32_t elsXmitSCR;
137         uint32_t elsXmitRNID;
138         uint32_t elsXmitFARP;
139         uint32_t elsXmitFARPR;
140         uint32_t elsXmitACC;
141         uint32_t elsXmitLSRJT;
142
143         uint32_t frameRcvBcast;
144         uint32_t frameRcvMulti;
145         uint32_t strayXmitCmpl;
146         uint32_t frameXmitDelay;
147         uint32_t xriCmdCmpl;
148         uint32_t xriStatErr;
149         uint32_t LinkUp;
150         uint32_t LinkDown;
151         uint32_t LinkMultiEvent;
152         uint32_t NoRcvBuf;
153         uint32_t fcpCmd;
154         uint32_t fcpCmpl;
155         uint32_t fcpRspErr;
156         uint32_t fcpRemoteStop;
157         uint32_t fcpPortRjt;
158         uint32_t fcpPortBusy;
159         uint32_t fcpError;
160         uint32_t fcpLocalErr;
161 };
162
163 enum sysfs_mbox_state {
164         SMBOX_IDLE,
165         SMBOX_WRITING,
166         SMBOX_READING
167 };
168
169 struct lpfc_sysfs_mbox {
170         enum sysfs_mbox_state state;
171         size_t                offset;
172         struct lpfcMboxq *    mbox;
173 };
174
175 struct lpfc_hba;
176
177 enum discovery_state {
178         LPFC_STATE_UNKNOWN   =  0,    /* HBA state is unknown */
179         LPFC_LOCAL_CFG_LINK  =  6,    /* local NPORT Id configured */
180         LPFC_FLOGI           =  7,    /* FLOGI sent to Fabric */
181         LPFC_FABRIC_CFG_LINK =  8,    /* Fabric assigned NPORT Id
182                                        * configured */
183         LPFC_NS_REG          =  9,    /* Register with NameServer */
184         LPFC_NS_QRY          =  10,   /* Query NameServer for NPort ID list */
185         LPFC_BUILD_DISC_LIST =  11,   /* Build ADISC and PLOGI lists for
186                                        * device authentication / discovery */
187         LPFC_DISC_AUTH       =  12,   /* Processing ADISC list */
188         LPFC_VPORT_READY     =  32,
189 };
190
191 enum hba_state {
192         LPFC_LINK_UNKNOWN    =   0,   /* HBA state is unknown */
193         LPFC_WARM_START      =   1,   /* HBA state after selective reset */
194         LPFC_INIT_START      =   2,   /* Initial state after board reset */
195         LPFC_INIT_MBX_CMDS   =   3,   /* Initialize HBA with mbox commands */
196         LPFC_LINK_DOWN       =   4,   /* HBA initialized, link is down */
197         LPFC_LINK_UP         =   5,   /* Link is up  - issue READ_LA */
198         LPFC_CLEAR_LA        =  13,   /* authentication cmplt - issue
199                                        * CLEAR_LA */
200         LPFC_HBA_ERROR       =  -1
201 };
202
203 struct lpfc_vport {
204         struct list_head listentry;
205         struct lpfc_hba *phba;
206         uint8_t port_type;
207 #define LPFC_PHYSICAL_PORT 1
208 #define LPFC_NPIV_PORT  2
209 #define LPFC_FABRIC_PORT 3
210         enum discovery_state port_state;
211
212
213         uint32_t fc_flag;       /* FC flags */
214 /* Several of these flags are HBA centric and should be moved to
215  * phba->link_flag (e.g. FC_PTP, FC_PUBLIC_LOOP)
216  */
217 #define FC_PT2PT                0x1     /* pt2pt with no fabric */
218 #define FC_PT2PT_PLOGI          0x2     /* pt2pt initiate PLOGI */
219 #define FC_DISC_TMO             0x4     /* Discovery timer running */
220 #define FC_PUBLIC_LOOP          0x8     /* Public loop */
221 #define FC_LBIT                 0x10    /* LOGIN bit in loopinit set */
222 #define FC_RSCN_MODE            0x20    /* RSCN cmd rcv'ed */
223 #define FC_NLP_MORE             0x40    /* More node to process in node tbl */
224 #define FC_OFFLINE_MODE         0x80    /* Interface is offline for diag */
225 #define FC_FABRIC               0x100   /* We are fabric attached */
226 #define FC_ESTABLISH_LINK       0x200   /* Reestablish Link */
227 #define FC_RSCN_DISCOVERY       0x400   /* Authenticate all devices after RSCN*/
228 #define FC_SCSI_SCAN_TMO        0x4000  /* scsi scan timer running */
229 #define FC_ABORT_DISCOVERY      0x8000  /* we want to abort discovery */
230 #define FC_NDISC_ACTIVE         0x10000 /* NPort discovery active */
231 #define FC_BYPASSED_MODE        0x20000 /* NPort is in bypassed mode */
232
233         struct list_head fc_nodes;
234
235         /* Keep counters for the number of entries in each list. */
236         uint16_t fc_plogi_cnt;
237         uint16_t fc_adisc_cnt;
238         uint16_t fc_reglogin_cnt;
239         uint16_t fc_prli_cnt;
240         uint16_t fc_unmap_cnt;
241         uint16_t fc_map_cnt;
242         uint16_t fc_npr_cnt;
243         uint16_t fc_unused_cnt;
244         struct serv_parm fc_sparam;     /* buffer for our service parameters */
245
246         uint32_t fc_myDID;      /* fibre channel S_ID */
247         uint32_t fc_prevDID;    /* previous fibre channel S_ID */
248
249         int32_t stopped;   /* HBA has not been restarted since last ERATT */
250         uint8_t fc_linkspeed;   /* Link speed after last READ_LA */
251
252         uint32_t num_disc_nodes;        /*in addition to hba_state */
253
254         uint32_t fc_nlp_cnt;    /* outstanding NODELIST requests */
255         uint32_t fc_rscn_id_cnt;        /* count of RSCNs payloads in list */
256         struct lpfc_dmabuf *fc_rscn_id_list[FC_MAX_HOLD_RSCN];
257         struct lpfc_name fc_nodename;   /* fc nodename */
258         struct lpfc_name fc_portname;   /* fc portname */
259
260         struct lpfc_work_evt disc_timeout_evt;
261
262         struct timer_list fc_disctmo;   /* Discovery rescue timer */
263         uint8_t fc_ns_retry;    /* retries for fabric nameserver */
264         uint32_t fc_prli_sent;  /* cntr for outstanding PRLIs */
265
266         spinlock_t work_port_lock;
267         uint32_t work_port_events; /* Timeout to be handled  */
268 #define WORKER_DISC_TMO                0x1      /* Discovery timeout */
269 #define WORKER_ELS_TMO                 0x2      /* ELS timeout */
270 #define WORKER_MBOX_TMO                0x4      /* MBOX timeout */
271 #define WORKER_FDMI_TMO                0x8      /* FDMI timeout */
272
273         struct timer_list fc_fdmitmo;
274         struct timer_list els_tmofunc;
275
276         int unreg_vpi_cmpl;
277
278         uint8_t load_flag;
279 #define FC_LOADING              0x1     /* HBA in process of loading drvr */
280 #define FC_UNLOADING            0x2     /* HBA in process of unloading drvr */
281
282 };
283
284
285 struct hbq_s {
286         uint16_t entry_count;     /* Current number of HBQ slots */
287         uint32_t next_hbqPutIdx;  /* Index to next HBQ slot to use */
288         uint32_t hbqPutIdx;       /* HBQ slot to use */
289         uint32_t local_hbqGetIdx; /* Local copy of Get index from Port */
290 };
291
292 #define MAX_HBQS  16
293
294 struct lpfc_hba {
295         struct lpfc_sli sli;
296         uint32_t sli_rev;               /* SLI2 or SLI3 */
297         uint32_t sli3_options;          /* Mask of enabled SLI3 options */
298 #define LPFC_SLI3_ENABLED       0x01
299 #define LPFC_SLI3_HBQ_ENABLED   0x02
300 #define LPFC_SLI3_INB_ENABLED   0x04
301         uint32_t iocb_cmd_size;
302         uint32_t iocb_rsp_size;
303
304         enum hba_state link_state;
305         uint32_t link_flag;     /* link state flags */
306 #define LS_LOOPBACK_MODE        0x40000 /* NPort is in Loopback mode */
307                                         /* This flag is set while issuing */
308                                         /* INIT_LINK mailbox command */
309 #define LS_IGNORE_ERATT         0x80000 /* intr handler should ignore ERATT */
310
311         struct lpfc_sli2_slim *slim2p;
312         struct lpfc_dmabuf hbqslimp;
313
314         dma_addr_t slim2p_mapping;
315
316
317         uint16_t pci_cfg_value;
318
319
320         uint8_t fc_linkspeed;   /* Link speed after last READ_LA */
321
322         uint32_t fc_eventTag;   /* event tag for link attention */
323
324
325         struct timer_list fc_estabtmo;  /* link establishment timer */
326         /* These fields used to be binfo */
327         uint32_t fc_pref_DID;   /* preferred D_ID */
328         uint8_t fc_pref_ALPA;   /* preferred AL_PA */
329         uint32_t fc_edtov;      /* E_D_TOV timer value */
330         uint32_t fc_arbtov;     /* ARB_TOV timer value */
331         uint32_t fc_ratov;      /* R_A_TOV timer value */
332         uint32_t fc_rttov;      /* R_T_TOV timer value */
333         uint32_t fc_altov;      /* AL_TOV timer value */
334         uint32_t fc_crtov;      /* C_R_TOV timer value */
335         uint32_t fc_citov;      /* C_I_TOV timer value */
336
337         struct serv_parm fc_fabparam;   /* fabric service parameters buffer */
338         uint8_t alpa_map[128];  /* AL_PA map from READ_LA */
339
340         uint32_t lmt;
341
342         uint32_t fc_topology;   /* link topology, from LINK INIT */
343
344         struct lpfc_stats fc_stat;
345
346         struct lpfc_nodelist fc_fcpnodev; /* nodelist entry for no device */
347         uint32_t nport_event_cnt;       /* timestamp for nlplist entry */
348
349         uint8_t  wwnn[8];
350         uint8_t  wwpn[8];
351         uint32_t RandomData[7];
352
353         uint32_t cfg_log_verbose;
354         uint32_t cfg_lun_queue_depth;
355         uint32_t cfg_nodev_tmo;
356         uint32_t cfg_devloss_tmo;
357         uint32_t cfg_hba_queue_depth;
358         uint32_t cfg_fcp_class;
359         uint32_t cfg_use_adisc;
360         uint32_t cfg_ack0;
361         uint32_t cfg_topology;
362         uint32_t cfg_scan_down;
363         uint32_t cfg_link_speed;
364         uint32_t cfg_cr_delay;
365         uint32_t cfg_cr_count;
366         uint32_t cfg_multi_ring_support;
367         uint32_t cfg_multi_ring_rctl;
368         uint32_t cfg_multi_ring_type;
369         uint32_t cfg_fdmi_on;
370         uint32_t cfg_discovery_threads;
371         uint32_t cfg_max_luns;
372         uint32_t cfg_poll;
373         uint32_t cfg_poll_tmo;
374         uint32_t cfg_use_msi;
375         uint32_t cfg_sg_seg_cnt;
376         uint32_t cfg_sg_dma_buf_size;
377         uint64_t cfg_soft_wwnn;
378         uint64_t cfg_soft_wwpn;
379
380         uint32_t dev_loss_tmo_changed;
381
382         lpfc_vpd_t vpd;         /* vital product data */
383
384         struct pci_dev *pcidev;
385         struct list_head      work_list;
386         uint32_t              work_ha;      /* Host Attention Bits for WT */
387         uint32_t              work_ha_mask; /* HA Bits owned by WT        */
388         uint32_t              work_hs;      /* HS stored in case of ERRAT */
389         uint32_t              work_status[2]; /* Extra status from SLIM */
390
391         wait_queue_head_t    *work_wait;
392         struct task_struct   *worker_thread;
393
394         struct   hbq_dmabuf *hbq_buffer_pool;
395         uint32_t hbq_buffer_count;
396         uint32_t hbq_buff_count;        /* Current hbq buffers */
397         uint32_t hbq_count;             /* Count of configured HBQs */
398         struct hbq_s hbqs[MAX_HBQS];    /* local copy of hbq indicies  */
399
400         unsigned long pci_bar0_map;     /* Physical address for PCI BAR0 */
401         unsigned long pci_bar2_map;     /* Physical address for PCI BAR2 */
402         void __iomem *slim_memmap_p;    /* Kernel memory mapped address for
403                                            PCI BAR0 */
404         void __iomem *ctrl_regs_memmap_p;/* Kernel memory mapped address for
405                                             PCI BAR2 */
406
407         void __iomem *MBslimaddr;       /* virtual address for mbox cmds */
408         void __iomem *HAregaddr;        /* virtual address for host attn reg */
409         void __iomem *CAregaddr;        /* virtual address for chip attn reg */
410         void __iomem *HSregaddr;        /* virtual address for host status
411                                            reg */
412         void __iomem *HCregaddr;        /* virtual address for host ctl reg */
413
414         struct lpfc_hgp __iomem *host_gp; /* Host side get/put pointers */
415         uint32_t __iomem  *hbq_put;     /* Address in SLIM to HBQ put ptrs */
416         uint32_t __iomem  *hbq_get;     /* Address in SLIM to HBQ get ptrs */
417
418         int brd_no;                     /* FC board number */
419
420         char SerialNumber[32];          /* adapter Serial Number */
421         char OptionROMVersion[32];      /* adapter BIOS / Fcode version */
422         char ModelDesc[256];            /* Model Description */
423         char ModelName[80];             /* Model Name */
424         char ProgramType[256];          /* Program Type */
425         char Port[20];                  /* Port No */
426         uint8_t vpd_flag;               /* VPD data flag */
427
428 #define VPD_MODEL_DESC      0x1         /* valid vpd model description */
429 #define VPD_MODEL_NAME      0x2         /* valid vpd model name */
430 #define VPD_PROGRAM_TYPE    0x4         /* valid vpd program type */
431 #define VPD_PORT            0x8         /* valid vpd port data */
432 #define VPD_MASK            0xf         /* mask for any vpd data */
433
434         uint8_t soft_wwn_enable;
435
436         struct timer_list fcp_poll_timer;
437
438         /*
439          * stat  counters
440          */
441         uint64_t fc4InputRequests;
442         uint64_t fc4OutputRequests;
443         uint64_t fc4ControlRequests;
444
445         struct lpfc_sysfs_mbox sysfs_mbox;
446
447         /* fastpath list. */
448         spinlock_t scsi_buf_list_lock;
449         struct list_head lpfc_scsi_buf_list;
450         uint32_t total_scsi_bufs;
451         struct list_head lpfc_iocb_list;
452         uint32_t total_iocbq_bufs;
453         spinlock_t hbalock;
454
455         /* pci_mem_pools */
456         struct pci_pool *lpfc_scsi_dma_buf_pool;
457         struct pci_pool *lpfc_mbuf_pool;
458         struct pci_pool *lpfc_hbq_pool;
459         struct lpfc_dma_pool lpfc_mbuf_safety_pool;
460
461         mempool_t *mbox_mem_pool;
462         mempool_t *nlp_mem_pool;
463
464         struct fc_host_statistics link_stats;
465         struct list_head port_list;
466         struct lpfc_vport *pport; /* physical lpfc_vport pointer */
467 };
468
469 static inline struct Scsi_Host *
470 lpfc_shost_from_vport(struct lpfc_vport *vport)
471 {
472         return container_of((void *) vport, struct Scsi_Host, hostdata[0]);
473 }
474
475 static inline void
476 lpfc_set_loopback_flag(struct lpfc_hba *phba)
477 {
478         if (phba->cfg_topology == FLAGS_LOCAL_LB)
479                 phba->link_flag |= LS_LOOPBACK_MODE;
480         else
481                 phba->link_flag &= ~LS_LOOPBACK_MODE;
482 }
483
484 static inline int
485 lpfc_is_link_up(struct lpfc_hba *phba)
486 {
487         return  phba->link_state == LPFC_LINK_UP ||
488                 phba->link_state == LPFC_CLEAR_LA;
489 }
490
491
492
493 #define FC_REG_DUMP_EVENT       0x10    /* Register for Dump events */
494