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-2015 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        uint32_t iocb_flag;
  62#define LPFC_IO_LIBDFC          1       /* libdfc iocb */
  63#define LPFC_IO_WAKE            2       /* Synchronous I/O completed */
  64#define LPFC_IO_WAKE_TMO        LPFC_IO_WAKE /* Synchronous I/O timed out */
  65#define LPFC_IO_FCP             4       /* FCP command -- iocbq in scsi_buf */
  66#define LPFC_DRIVER_ABORTED     8       /* driver aborted this request */
  67#define LPFC_IO_FABRIC          0x10    /* Iocb send using fabric scheduler */
  68#define LPFC_DELAY_MEM_FREE     0x20    /* Defer free'ing of FC data */
  69#define LPFC_EXCHANGE_BUSY      0x40    /* SLI4 hba reported XB in response */
  70#define LPFC_USE_FCPWQIDX       0x80    /* Submit to specified FCPWQ index */
  71#define DSS_SECURITY_OP         0x100   /* security IO */
  72#define LPFC_IO_ON_TXCMPLQ      0x200   /* The IO is still on the TXCMPLQ */
  73#define LPFC_IO_DIF_PASS        0x400   /* T10 DIF IO pass-thru prot */
  74#define LPFC_IO_DIF_STRIP       0x800   /* T10 DIF IO strip prot */
  75#define LPFC_IO_DIF_INSERT      0x1000  /* T10 DIF IO insert prot */
  76#define LPFC_IO_CMD_OUTSTANDING 0x2000 /* timeout handler abort window */
  77
  78#define LPFC_FIP_ELS_ID_MASK    0xc000  /* ELS_ID range 0-3, non-shifted mask */
  79#define LPFC_FIP_ELS_ID_SHIFT   14
  80
  81#define LPFC_IO_OAS             0x10000 /* OAS FCP IO */
  82#define LPFC_IO_FOF             0x20000 /* FOF FCP IO */
  83#define LPFC_IO_LOOPBACK        0x40000 /* Loopback IO */
  84
  85        uint32_t drvrTimeout;   /* driver timeout in seconds */
  86        uint32_t fcp_wqidx;     /* index to FCP work queue */
  87        struct lpfc_vport *vport;/* virtual port pointer */
  88        void *context1;         /* caller context information */
  89        void *context2;         /* caller context information */
  90        void *context3;         /* caller context information */
  91        union {
  92                wait_queue_head_t    *wait_queue;
  93                struct lpfc_iocbq    *rsp_iocb;
  94                struct lpfcMboxq     *mbox;
  95                struct lpfc_nodelist *ndlp;
  96                struct lpfc_node_rrq *rrq;
  97        } context_un;
  98
  99        void (*fabric_iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
 100                           struct lpfc_iocbq *);
 101        void (*wait_iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
 102                           struct lpfc_iocbq *);
 103        void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
 104                           struct lpfc_iocbq *);
 105};
 106
 107#define SLI_IOCB_RET_IOCB      1        /* Return IOCB if cmd ring full */
 108
 109#define IOCB_SUCCESS        0
 110#define IOCB_BUSY           1
 111#define IOCB_ERROR          2
 112#define IOCB_TIMEDOUT       3
 113
 114#define LPFC_MBX_WAKE           1
 115#define LPFC_MBX_IMED_UNREG     2
 116
 117typedef struct lpfcMboxq {
 118        /* MBOXQs are used in single linked lists */
 119        struct list_head list;  /* ptr to next mailbox command */
 120        union {
 121                MAILBOX_t mb;           /* Mailbox cmd */
 122                struct lpfc_mqe mqe;
 123        } u;
 124        struct lpfc_vport *vport;/* virtual port pointer */
 125        void *context1;         /* caller context information */
 126        void *context2;         /* caller context information */
 127
 128        void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
 129        uint8_t mbox_flag;
 130        uint16_t in_ext_byte_len;
 131        uint16_t out_ext_byte_len;
 132        uint8_t  mbox_offset_word;
 133        struct lpfc_mcqe mcqe;
 134        struct lpfc_mbx_nembed_sge_virt *sge_array;
 135} LPFC_MBOXQ_t;
 136
 137#define MBX_POLL        1       /* poll mailbox till command done, then
 138                                   return */
 139#define MBX_NOWAIT      2       /* issue command then return immediately */
 140
 141#define LPFC_MAX_RING_MASK  5   /* max num of rctl/type masks allowed per
 142                                   ring */
 143#define LPFC_SLI3_MAX_RING  4   /* Max num of SLI3 rings used by driver.
 144                                   For SLI4, an additional ring for each
 145                                   FCP WQ will be allocated.  */
 146
 147struct lpfc_sli_ring;
 148
 149struct lpfc_sli_ring_mask {
 150        uint8_t profile;        /* profile associated with ring */
 151        uint8_t rctl;   /* rctl / type pair configured for ring */
 152        uint8_t type;   /* rctl / type pair configured for ring */
 153        uint8_t rsvd;
 154        /* rcv'd unsol event */
 155        void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
 156                                         struct lpfc_sli_ring *,
 157                                         struct lpfc_iocbq *);
 158};
 159
 160
 161/* Structure used to hold SLI statistical counters and info */
 162struct lpfc_sli_ring_stat {
 163        uint64_t iocb_event;     /* IOCB event counters */
 164        uint64_t iocb_cmd;       /* IOCB cmd issued */
 165        uint64_t iocb_rsp;       /* IOCB rsp received */
 166        uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
 167        uint64_t iocb_cmd_full;  /* IOCB cmd ring full */
 168        uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
 169        uint64_t iocb_rsp_full;  /* IOCB rsp ring full */
 170};
 171
 172struct lpfc_sli3_ring {
 173        uint32_t local_getidx;  /* last available cmd index (from cmdGetInx) */
 174        uint32_t next_cmdidx;   /* next_cmd index */
 175        uint32_t rspidx;        /* current index in response ring */
 176        uint32_t cmdidx;        /* current index in command ring */
 177        uint16_t numCiocb;      /* number of command iocb's per ring */
 178        uint16_t numRiocb;      /* number of rsp iocb's per ring */
 179        uint16_t sizeCiocb;     /* Size of command iocb's in this ring */
 180        uint16_t sizeRiocb;     /* Size of response iocb's in this ring */
 181        uint32_t *cmdringaddr;  /* virtual address for cmd rings */
 182        uint32_t *rspringaddr;  /* virtual address for rsp rings */
 183};
 184
 185struct lpfc_sli4_ring {
 186        struct lpfc_queue *wqp; /* Pointer to associated WQ */
 187};
 188
 189
 190/* Structure used to hold SLI ring information */
 191struct lpfc_sli_ring {
 192        uint16_t flag;          /* ring flags */
 193#define LPFC_DEFERRED_RING_EVENT 0x001  /* Deferred processing a ring event */
 194#define LPFC_CALL_RING_AVAILABLE 0x002  /* indicates cmd was full */
 195#define LPFC_STOP_IOCB_EVENT     0x020  /* Stop processing IOCB cmds event */
 196        uint16_t abtsiotag;     /* tracks next iotag to use for ABTS */
 197
 198        uint8_t rsvd;
 199        uint8_t ringno;         /* ring number */
 200
 201        spinlock_t ring_lock;   /* lock for issuing commands */
 202
 203        uint32_t fast_iotag;    /* max fastlookup based iotag           */
 204        uint32_t iotag_ctr;     /* keeps track of the next iotag to use */
 205        uint32_t iotag_max;     /* max iotag value to use               */
 206        struct list_head txq;
 207        uint16_t txq_cnt;       /* current length of queue */
 208        uint16_t txq_max;       /* max length */
 209        struct list_head txcmplq;
 210        uint16_t txcmplq_cnt;   /* current length of queue */
 211        uint16_t txcmplq_max;   /* max length */
 212        uint32_t missbufcnt;    /* keep track of buffers to post */
 213        struct list_head postbufq;
 214        uint16_t postbufq_cnt;  /* current length of queue */
 215        uint16_t postbufq_max;  /* max length */
 216        struct list_head iocb_continueq;
 217        uint16_t iocb_continueq_cnt;    /* current length of queue */
 218        uint16_t iocb_continueq_max;    /* max length */
 219        struct list_head iocb_continue_saveq;
 220
 221        struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
 222        uint32_t num_mask;      /* number of mask entries in prt array */
 223        void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
 224                struct lpfc_sli_ring *, struct lpfc_iocbq *);
 225
 226        struct lpfc_sli_ring_stat stats;        /* SLI statistical info */
 227
 228        /* cmd ring available */
 229        void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
 230                                        struct lpfc_sli_ring *);
 231        union {
 232                struct lpfc_sli3_ring sli3;
 233                struct lpfc_sli4_ring sli4;
 234        } sli;
 235};
 236
 237/* Structure used for configuring rings to a specific profile or rctl / type */
 238struct lpfc_hbq_init {
 239        uint32_t rn;            /* Receive buffer notification */
 240        uint32_t entry_count;   /* max # of entries in HBQ */
 241        uint32_t headerLen;     /* 0 if not profile 4 or 5 */
 242        uint32_t logEntry;      /* Set to 1 if this HBQ used for LogEntry */
 243        uint32_t profile;       /* Selection profile 0=all, 7=logentry */
 244        uint32_t ring_mask;     /* Binds HBQ to a ring e.g. Ring0=b0001,
 245                                 * ring2=b0100 */
 246        uint32_t hbq_index;     /* index of this hbq in ring .HBQs[] */
 247
 248        uint32_t seqlenoff;
 249        uint32_t maxlen;
 250        uint32_t seqlenbcnt;
 251        uint32_t cmdcodeoff;
 252        uint32_t cmdmatch[8];
 253        uint32_t mask_count;    /* number of mask entries in prt array */
 254        struct hbq_mask hbqMasks[6];
 255
 256        /* Non-config rings fields to keep track of buffer allocations */
 257        uint32_t buffer_count;  /* number of buffers allocated */
 258        uint32_t init_count;    /* number to allocate when initialized */
 259        uint32_t add_count;     /* number to allocate when starved */
 260} ;
 261
 262/* Structure used to hold SLI statistical counters and info */
 263struct lpfc_sli_stat {
 264        uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
 265        uint64_t mbox_cmd;       /* Mailbox commands issued */
 266        uint64_t sli_intr;       /* Count of Host Attention interrupts */
 267        uint64_t sli_prev_intr;  /* Previous cnt of Host Attention interrupts */
 268        uint64_t sli_ips;        /* Host Attention interrupts per sec */
 269        uint32_t err_attn_event; /* Error Attn event counters */
 270        uint32_t link_event;     /* Link event counters */
 271        uint32_t mbox_event;     /* Mailbox event counters */
 272        uint32_t mbox_busy;      /* Mailbox cmd busy */
 273};
 274
 275/* Structure to store link status values when port stats are reset */
 276struct lpfc_lnk_stat {
 277        uint32_t link_failure_count;
 278        uint32_t loss_of_sync_count;
 279        uint32_t loss_of_signal_count;
 280        uint32_t prim_seq_protocol_err_count;
 281        uint32_t invalid_tx_word_count;
 282        uint32_t invalid_crc_count;
 283        uint32_t error_frames;
 284        uint32_t link_events;
 285};
 286
 287/* Structure used to hold SLI information */
 288struct lpfc_sli {
 289        uint32_t num_rings;
 290        uint32_t sli_flag;
 291
 292        /* Additional sli_flags */
 293#define LPFC_SLI_MBOX_ACTIVE      0x100 /* HBA mailbox is currently active */
 294#define LPFC_SLI_ACTIVE           0x200 /* SLI in firmware is active */
 295#define LPFC_PROCESS_LA           0x400 /* Able to process link attention */
 296#define LPFC_BLOCK_MGMT_IO        0x800 /* Don't allow mgmt mbx or iocb cmds */
 297#define LPFC_MENLO_MAINT          0x1000 /* need for menl fw download */
 298#define LPFC_SLI_ASYNC_MBX_BLK    0x2000 /* Async mailbox is blocked */
 299
 300        struct lpfc_sli_ring *ring;
 301        int fcp_ring;           /* ring used for FCP initiator commands */
 302        int next_ring;
 303
 304        int extra_ring;         /* extra ring used for other protocols */
 305
 306        struct lpfc_sli_stat slistat;   /* SLI statistical info */
 307        struct list_head mboxq;
 308        uint16_t mboxq_cnt;     /* current length of queue */
 309        uint16_t mboxq_max;     /* max length */
 310        LPFC_MBOXQ_t *mbox_active;      /* active mboxq information */
 311        struct list_head mboxq_cmpl;
 312
 313        struct timer_list mbox_tmo;     /* Hold clk to timeout active mbox
 314                                           cmd */
 315
 316#define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
 317        struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
 318        size_t iocbq_lookup_len;           /* current lengs of the array */
 319        uint16_t  last_iotag;              /* last allocated IOTAG */
 320        unsigned long  stats_start;        /* in seconds */
 321        struct lpfc_lnk_stat lnk_stat_offsets;
 322};
 323
 324/* Timeout for normal outstanding mbox command (Seconds) */
 325#define LPFC_MBOX_TMO                           30
 326/* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
 327#define LPFC_MBOX_SLI4_CONFIG_TMO               60
 328/* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
 329#define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO      300
 330/* Timeout for other flash-based outstanding mbox command (Seconds) */
 331#define LPFC_MBOX_TMO_FLASH_CMD                 300
 332