LXR linux/drivers/scsi/lpfc/lpfc

   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 *                                                                 *
   8 * This program is free software; you can redistribute it and/or   *
   9 * modify it under the terms of version 2 of the GNU General       *
  10 * Public License as published by the Free Software Foundation.    *
  11 * This program is distributed in the hope that it will be useful. *
  12 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
  13 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
  14 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
  15 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
  16 * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
  17 * more details, a copy of which can be found in the file COPYING  *
  18 * included with this package.                                     *
  19 *******************************************************************/
  20
  21/* forward declaration for LPFC_IOCB_t's use */
  22struct lpfc_hba;
  23struct lpfc_vport;
  24
  25/* Define the context types that SLI handles for abort and sums. */
  26typedef enum _lpfc_ctx_cmd {
  27        LPFC_CTX_LUN,
  28        LPFC_CTX_TGT,
  29        LPFC_CTX_HOST
  30} lpfc_ctx_cmd;
  31
  32struct lpfc_cq_event {
  33        struct list_head list;
  34        union {
  35                struct lpfc_mcqe                mcqe_cmpl;
  36                struct lpfc_acqe_link           acqe_link;
  37                struct lpfc_acqe_fip            acqe_fip;
  38                struct lpfc_acqe_dcbx           acqe_dcbx;
  39                struct lpfc_acqe_grp5           acqe_grp5;
  40                struct lpfc_acqe_fc_la          acqe_fc;
  41                struct lpfc_acqe_sli            acqe_sli;
  42                struct lpfc_rcqe                rcqe_cmpl;
  43                struct sli4_wcqe_xri_aborted    wcqe_axri;
  44                struct lpfc_wcqe_complete       wcqe_cmpl;
  45        } cqe;
  46};
  47
  48/* This structure is used to handle IOCB requests / responses */
  49struct lpfc_iocbq {
  50        /* lpfc_iocbqs are used in double linked lists */
  51        struct list_head list;
  52        struct list_head clist;
  53        struct list_head dlist;
  54        uint16_t iotag;         /* pre-assigned IO tag */
  55        uint16_t sli4_lxritag;  /* logical pre-assigned XRI. */
  56        uint16_t sli4_xritag;   /* pre-assigned XRI, (OXID) tag. */
  57        struct lpfc_cq_event cq_event;
  58
  59        IOCB_t iocb;            /* IOCB cmd */
  60        uint8_t retry;          /* retry counter for IOCB cmd - if needed */
  61        uint16_t iocb_flag;
  62#define LPFC_IO_LIBDFC          1       /* libdfc iocb */
  63#define LPFC_IO_WAKE            2       /* High Priority Queue signal flag */
  64#define LPFC_IO_FCP             4       /* FCP command -- iocbq in scsi_buf */
  65#define LPFC_DRIVER_ABORTED     8       /* driver aborted this request */
  66#define LPFC_IO_FABRIC          0x10    /* Iocb send using fabric scheduler */
  67#define LPFC_DELAY_MEM_FREE     0x20    /* Defer free'ing of FC data */
  68#define LPFC_EXCHANGE_BUSY      0x40    /* SLI4 hba reported XB in response */
  69#define LPFC_USE_FCPWQIDX       0x80    /* Submit to specified FCPWQ index */
  70#define DSS_SECURITY_OP         0x100   /* security IO */
  71#define LPFC_IO_ON_Q            0x200   /* The IO is still on the TXCMPLQ */
  72#define LPFC_IO_DIF             0x400   /* T10 DIF IO */
  73
  74#define LPFC_FIP_ELS_ID_MASK    0xc000  /* ELS_ID range 0-3, non-shifted mask */
  75#define LPFC_FIP_ELS_ID_SHIFT   14
  76
  77        uint8_t rsvd2;
  78        uint32_t drvrTimeout;   /* driver timeout in seconds */
  79        uint32_t fcp_wqidx;     /* index to FCP work queue */
  80        struct lpfc_vport *vport;/* virtual port pointer */
  81        void *context1;         /* caller context information */
  82        void *context2;         /* caller context information */
  83        void *context3;         /* caller context information */
  84        union {
  85                wait_queue_head_t    *wait_queue;
  86                struct lpfc_iocbq    *rsp_iocb;
  87                struct lpfcMboxq     *mbox;
  88                struct lpfc_nodelist *ndlp;
  89                struct lpfc_node_rrq *rrq;
  90        } context_un;
  91
  92        void (*fabric_iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
  93                           struct lpfc_iocbq *);
  94        void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
  95                           struct lpfc_iocbq *);
  96};
  97
  98#define SLI_IOCB_RET_IOCB      1        /* Return IOCB if cmd ring full */
  99
 100#define IOCB_SUCCESS        0
 101#define IOCB_BUSY           1
 102#define IOCB_ERROR          2
 103#define IOCB_TIMEDOUT       3
 104
 105#define LPFC_MBX_WAKE           1
 106#define LPFC_MBX_IMED_UNREG     2
 107
 108typedef struct lpfcMboxq {
 109        /* MBOXQs are used in single linked lists */
 110        struct list_head list;  /* ptr to next mailbox command */
 111        union {
 112                MAILBOX_t mb;           /* Mailbox cmd */
 113                struct lpfc_mqe mqe;
 114        } u;
 115        struct lpfc_vport *vport;/* virtual port pointer */
 116        void *context1;         /* caller context information */
 117        void *context2;         /* caller context information */
 118
 119        void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
 120        uint8_t mbox_flag;
 121        uint16_t in_ext_byte_len;
 122        uint16_t out_ext_byte_len;
 123        uint8_t  mbox_offset_word;
 124        struct lpfc_mcqe mcqe;
 125        struct lpfc_mbx_nembed_sge_virt *sge_array;
 126} LPFC_MBOXQ_t;
 127
 128#define MBX_POLL        1       /* poll mailbox till command done, then
 129                                   return */
 130#define MBX_NOWAIT      2       /* issue command then return immediately */
 131
 132#define LPFC_MAX_RING_MASK  5   /* max num of rctl/type masks allowed per
 133                                   ring */
 134#define LPFC_MAX_RING       4   /* max num of SLI rings used by driver */
 135
 136struct lpfc_sli_ring;
 137
 138struct lpfc_sli_ring_mask {
 139        uint8_t profile;        /* profile associated with ring */
 140        uint8_t rctl;   /* rctl / type pair configured for ring */
 141        uint8_t type;   /* rctl / type pair configured for ring */
 142        uint8_t rsvd;
 143        /* rcv'd unsol event */
 144        void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
 145                                         struct lpfc_sli_ring *,
 146                                         struct lpfc_iocbq *);
 147};
 148
 149
 150/* Structure used to hold SLI statistical counters and info */
 151struct lpfc_sli_ring_stat {
 152        uint64_t iocb_event;     /* IOCB event counters */
 153        uint64_t iocb_cmd;       /* IOCB cmd issued */
 154        uint64_t iocb_rsp;       /* IOCB rsp received */
 155        uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
 156        uint64_t iocb_cmd_full;  /* IOCB cmd ring full */
 157        uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
 158        uint64_t iocb_rsp_full;  /* IOCB rsp ring full */
 159};
 160
 161/* Structure used to hold SLI ring information */
 162struct lpfc_sli_ring {
 163        uint16_t flag;          /* ring flags */
 164#define LPFC_DEFERRED_RING_EVENT 0x001  /* Deferred processing a ring event */
 165#define LPFC_CALL_RING_AVAILABLE 0x002  /* indicates cmd was full */
 166#define LPFC_STOP_IOCB_EVENT     0x020  /* Stop processing IOCB cmds event */
 167        uint16_t abtsiotag;     /* tracks next iotag to use for ABTS */
 168
 169        uint32_t local_getidx;   /* last available cmd index (from cmdGetInx) */
 170        uint32_t next_cmdidx;    /* next_cmd index */
 171        uint32_t rspidx;        /* current index in response ring */
 172        uint32_t cmdidx;        /* current index in command ring */
 173        uint8_t rsvd;
 174        uint8_t ringno;         /* ring number */
 175        uint16_t numCiocb;      /* number of command iocb's per ring */
 176        uint16_t numRiocb;      /* number of rsp iocb's per ring */
 177        uint16_t sizeCiocb;     /* Size of command iocb's in this ring */
 178        uint16_t sizeRiocb;     /* Size of response iocb's in this ring */
 179
 180        uint32_t fast_iotag;    /* max fastlookup based iotag           */
 181        uint32_t iotag_ctr;     /* keeps track of the next iotag to use */
 182        uint32_t iotag_max;     /* max iotag value to use               */
 183        struct list_head txq;
 184        uint16_t txq_cnt;       /* current length of queue */
 185        uint16_t txq_max;       /* max length */
 186        struct list_head txcmplq;
 187        uint16_t txcmplq_cnt;   /* current length of queue */
 188        uint16_t txcmplq_max;   /* max length */
 189        uint32_t *cmdringaddr;  /* virtual address for cmd rings */
 190        uint32_t *rspringaddr;  /* virtual address for rsp rings */
 191        uint32_t missbufcnt;    /* keep track of buffers to post */
 192        struct list_head postbufq;
 193        uint16_t postbufq_cnt;  /* current length of queue */
 194        uint16_t postbufq_max;  /* max length */
 195        struct list_head iocb_continueq;
 196        uint16_t iocb_continueq_cnt;    /* current length of queue */
 197        uint16_t iocb_continueq_max;    /* max length */
 198        struct list_head iocb_continue_saveq;
 199
 200        struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
 201        uint32_t num_mask;      /* number of mask entries in prt array */
 202        void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
 203                struct lpfc_sli_ring *, struct lpfc_iocbq *);
 204
 205        struct lpfc_sli_ring_stat stats;        /* SLI statistical info */
 206
 207        /* cmd ring available */
 208        void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
 209                                        struct lpfc_sli_ring *);
 210};
 211
 212/* Structure used for configuring rings to a specific profile or rctl / type */
 213struct lpfc_hbq_init {
 214        uint32_t rn;            /* Receive buffer notification */
 215        uint32_t entry_count;   /* max # of entries in HBQ */
 216        uint32_t headerLen;     /* 0 if not profile 4 or 5 */
 217        uint32_t logEntry;      /* Set to 1 if this HBQ used for LogEntry */
 218        uint32_t profile;       /* Selection profile 0=all, 7=logentry */
 219        uint32_t ring_mask;     /* Binds HBQ to a ring e.g. Ring0=b0001,
 220                                 * ring2=b0100 */
 221        uint32_t hbq_index;     /* index of this hbq in ring .HBQs[] */
 222
 223        uint32_t seqlenoff;
 224        uint32_t maxlen;
 225        uint32_t seqlenbcnt;
 226        uint32_t cmdcodeoff;
 227        uint32_t cmdmatch[8];
 228        uint32_t mask_count;    /* number of mask entries in prt array */
 229        struct hbq_mask hbqMasks[6];
 230
 231        /* Non-config rings fields to keep track of buffer allocations */
 232        uint32_t buffer_count;  /* number of buffers allocated */
 233        uint32_t init_count;    /* number to allocate when initialized */
 234        uint32_t add_count;     /* number to allocate when starved */
 235} ;
 236
 237/* Structure used to hold SLI statistical counters and info */
 238struct lpfc_sli_stat {
 239        uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
 240        uint64_t mbox_cmd;       /* Mailbox commands issued */
 241        uint64_t sli_intr;       /* Count of Host Attention interrupts */
 242        uint32_t err_attn_event; /* Error Attn event counters */
 243        uint32_t link_event;     /* Link event counters */
 244        uint32_t mbox_event;     /* Mailbox event counters */
 245        uint32_t mbox_busy;      /* Mailbox cmd busy */
 246};
 247
 248/* Structure to store link status values when port stats are reset */
 249struct lpfc_lnk_stat {
 250        uint32_t link_failure_count;
 251        uint32_t loss_of_sync_count;
 252        uint32_t loss_of_signal_count;
 253        uint32_t prim_seq_protocol_err_count;
 254        uint32_t invalid_tx_word_count;
 255        uint32_t invalid_crc_count;
 256        uint32_t error_frames;
 257        uint32_t link_events;
 258};
 259
 260/* Structure used to hold SLI information */
 261struct lpfc_sli {
 262        uint32_t num_rings;
 263        uint32_t sli_flag;
 264
 265        /* Additional sli_flags */
 266#define LPFC_SLI_MBOX_ACTIVE      0x100 /* HBA mailbox is currently active */
 267#define LPFC_SLI_ACTIVE           0x200 /* SLI in firmware is active */
 268#define LPFC_PROCESS_LA           0x400 /* Able to process link attention */
 269#define LPFC_BLOCK_MGMT_IO        0x800 /* Don't allow mgmt mbx or iocb cmds */
 270#define LPFC_MENLO_MAINT          0x1000 /* need for menl fw download */
 271#define LPFC_SLI_ASYNC_MBX_BLK    0x2000 /* Async mailbox is blocked */
 272
 273        struct lpfc_sli_ring ring[LPFC_MAX_RING];
 274        int fcp_ring;           /* ring used for FCP initiator commands */
 275        int next_ring;
 276
 277        int extra_ring;         /* extra ring used for other protocols */
 278
 279        struct lpfc_sli_stat slistat;   /* SLI statistical info */
 280        struct list_head mboxq;
 281        uint16_t mboxq_cnt;     /* current length of queue */
 282        uint16_t mboxq_max;     /* max length */
 283        LPFC_MBOXQ_t *mbox_active;      /* active mboxq information */
 284        struct list_head mboxq_cmpl;
 285
 286        struct timer_list mbox_tmo;     /* Hold clk to timeout active mbox
 287                                           cmd */
 288
 289#define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
 290        struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
 291        size_t iocbq_lookup_len;           /* current lengs of the array */
 292        uint16_t  last_iotag;              /* last allocated IOTAG */
 293        unsigned long  stats_start;        /* in seconds */
 294        struct lpfc_lnk_stat lnk_stat_offsets;
 295};
 296
 297/* Timeout for normal outstanding mbox command (Seconds) */
 298#define LPFC_MBOX_TMO                           30
 299/* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
 300#define LPFC_MBOX_SLI4_CONFIG_TMO               60
 301/* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
 302#define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO      300
 303/* Timeout for other flash-based outstanding mbox command (Seconds) */
 304#define LPFC_MBOX_TMO_FLASH_CMD                 300
 305