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