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