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