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