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-2005 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
  24 /* Define the context types that SLI handles for abort and sums. */
  25 typedef enum _lpfc_ctx_cmd {
  26         LPFC_CTX_LUN,
  27         LPFC_CTX_TGT,
  28         LPFC_CTX_CTX,
  29         LPFC_CTX_HOST
  30 } lpfc_ctx_cmd;
  31
  32 /* This structure is used to handle IOCB requests / responses */
  33 struct lpfc_iocbq {
  34         /* lpfc_iocbqs are used in double linked lists */
  35         struct list_head list;
  36         uint16_t iotag;         /* pre-assigned IO tag */
  37         uint16_t rsvd1;
  38
  39         IOCB_t iocb;            /* IOCB cmd */
  40         uint8_t retry;          /* retry counter for IOCB cmd - if needed */
  41         uint8_t iocb_flag;
  42 #define LPFC_IO_POLL    1       /* Polling mode iocb */
  43 #define LPFC_IO_LIBDFC  2       /* libdfc iocb */
  44 #define LPFC_IO_WAIT    4
  45 #define LPFC_IO_HIPRI   8       /* High Priority Queue signal flag */
  46
  47         uint8_t abort_count;
  48         uint8_t rsvd2;
  49         uint32_t drvrTimeout;   /* driver timeout in seconds */
  50         void *context1;         /* caller context information */
  51         void *context2;         /* caller context information */
  52         void *context3;         /* caller context information */
  53         union {
  54                 wait_queue_head_t *hipri_wait_queue; /* High Priority Queue wait
  55                                                         queue */
  56                 struct lpfc_iocbq  *rsp_iocb;
  57                 struct lpfcMboxq   *mbox;
  58         } context_un;
  59
  60         void (*iocb_cmpl) (struct lpfc_hba *, struct lpfc_iocbq *,
  61                            struct lpfc_iocbq *);
  62
  63 };
  64
  65 #define SLI_IOCB_RET_IOCB      1        /* Return IOCB if cmd ring full */
  66 #define SLI_IOCB_HIGH_PRIORITY 2        /* High priority command */
  67
  68 #define IOCB_SUCCESS        0
  69 #define IOCB_BUSY           1
  70 #define IOCB_ERROR          2
  71 #define IOCB_TIMEDOUT       3
  72
  73 typedef struct lpfcMboxq {
  74         /* MBOXQs are used in single linked lists */
  75         struct list_head list;  /* ptr to next mailbox command */
  76         MAILBOX_t mb;           /* Mailbox cmd */
  77         void *context1;         /* caller context information */
  78         void *context2;         /* caller context information */
  79
  80         void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
  81
  82 } LPFC_MBOXQ_t;
  83
  84 #define MBX_POLL        1       /* poll mailbox till command done, then
  85                                    return */
  86 #define MBX_NOWAIT      2       /* issue command then return immediately */
  87 #define MBX_STOP_IOCB   4       /* Stop iocb processing till mbox cmds
  88                                    complete */
  89
  90 #define LPFC_MAX_RING_MASK  4   /* max num of rctl/type masks allowed per
  91                                    ring */
  92 #define LPFC_MAX_RING       4   /* max num of SLI rings used by driver */
  93
  94 struct lpfc_sli_ring;
  95
  96 struct lpfc_sli_ring_mask {
  97         uint8_t profile;        /* profile associated with ring */
  98         uint8_t rctl;   /* rctl / type pair configured for ring */
  99         uint8_t type;   /* rctl / type pair configured for ring */
 100         uint8_t rsvd;
 101         /* rcv'd unsol event */
 102         void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
 103                                          struct lpfc_sli_ring *,
 104                                          struct lpfc_iocbq *);
 105 };
 106
 107
 108 /* Structure used to hold SLI statistical counters and info */
 109 struct lpfc_sli_ring_stat {
 110         uint64_t iocb_event;     /* IOCB event counters */
 111         uint64_t iocb_cmd;       /* IOCB cmd issued */
 112         uint64_t iocb_rsp;       /* IOCB rsp received */
 113         uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
 114         uint64_t iocb_cmd_full;  /* IOCB cmd ring full */
 115         uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
 116         uint64_t iocb_rsp_full;  /* IOCB rsp ring full */
 117 };
 118
 119 /* Structure used to hold SLI ring information */
 120 struct lpfc_sli_ring {
 121         uint16_t flag;          /* ring flags */
 122 #define LPFC_DEFERRED_RING_EVENT 0x001  /* Deferred processing a ring event */
 123 #define LPFC_CALL_RING_AVAILABLE 0x002  /* indicates cmd was full */
 124 #define LPFC_STOP_IOCB_MBX       0x010  /* Stop processing IOCB cmds mbox */
 125 #define LPFC_STOP_IOCB_EVENT     0x020  /* Stop processing IOCB cmds event */
 126 #define LPFC_STOP_IOCB_MASK      0x030  /* Stop processing IOCB cmds mask */
 127         uint16_t abtsiotag;     /* tracks next iotag to use for ABTS */
 128
 129         uint32_t local_getidx;   /* last available cmd index (from cmdGetInx) */
 130         uint32_t next_cmdidx;    /* next_cmd index */
 131         uint32_t rspidx;        /* current index in response ring */
 132         uint32_t cmdidx;        /* current index in command ring */
 133         uint8_t rsvd;
 134         uint8_t ringno;         /* ring number */
 135         uint16_t numCiocb;      /* number of command iocb's per ring */
 136         uint16_t numRiocb;      /* number of rsp iocb's per ring */
 137
 138         uint32_t fast_iotag;    /* max fastlookup based iotag           */
 139         uint32_t iotag_ctr;     /* keeps track of the next iotag to use */
 140         uint32_t iotag_max;     /* max iotag value to use               */
 141         struct lpfc_iocbq ** fast_lookup; /* array of IOCB ptrs indexed by
 142                                            iotag */
 143         struct list_head txq;
 144         uint16_t txq_cnt;       /* current length of queue */
 145         uint16_t txq_max;       /* max length */
 146         struct list_head txcmplq;
 147         uint16_t txcmplq_cnt;   /* current length of queue */
 148         uint16_t txcmplq_max;   /* max length */
 149         uint32_t *cmdringaddr;  /* virtual address for cmd rings */
 150         uint32_t *rspringaddr;  /* virtual address for rsp rings */
 151         uint32_t missbufcnt;    /* keep track of buffers to post */
 152         struct list_head postbufq;
 153         uint16_t postbufq_cnt;  /* current length of queue */
 154         uint16_t postbufq_max;  /* max length */
 155         struct list_head iocb_continueq;
 156         uint16_t iocb_continueq_cnt;    /* current length of queue */
 157         uint16_t iocb_continueq_max;    /* max length */
 158
 159         struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
 160         uint32_t num_mask;      /* number of mask entries in prt array */
 161
 162         struct lpfc_sli_ring_stat stats;        /* SLI statistical info */
 163
 164         /* cmd ring available */
 165         void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
 166                                         struct lpfc_sli_ring *);
 167 };
 168
 169 /* Structure used to hold SLI statistical counters and info */
 170 struct lpfc_sli_stat {
 171         uint64_t mbox_stat_err;  /* Mbox cmds completed status error */
 172         uint64_t mbox_cmd;       /* Mailbox commands issued */
 173         uint64_t sli_intr;       /* Count of Host Attention interrupts */
 174         uint32_t err_attn_event; /* Error Attn event counters */
 175         uint32_t link_event;     /* Link event counters */
 176         uint32_t mbox_event;     /* Mailbox event counters */
 177         uint32_t mbox_busy;      /* Mailbox cmd busy */
 178 };
 179
 180 /* Structure used to hold SLI information */
 181 struct lpfc_sli {
 182         uint32_t num_rings;
 183         uint32_t sli_flag;
 184
 185         /* Additional sli_flags */
 186 #define LPFC_SLI_MBOX_ACTIVE      0x100 /* HBA mailbox is currently active */
 187 #define LPFC_SLI2_ACTIVE          0x200 /* SLI2 overlay in firmware is active */
 188 #define LPFC_PROCESS_LA           0x400 /* Able to process link attention */
 189
 190         struct lpfc_sli_ring ring[LPFC_MAX_RING];
 191         int fcp_ring;           /* ring used for FCP initiator commands */
 192         int next_ring;
 193
 194         int ip_ring;            /* ring used for IP network drv cmds */
 195
 196         struct lpfc_sli_stat slistat;   /* SLI statistical info */
 197         struct list_head mboxq;
 198         uint16_t mboxq_cnt;     /* current length of queue */
 199         uint16_t mboxq_max;     /* max length */
 200         LPFC_MBOXQ_t *mbox_active;      /* active mboxq information */
 201
 202         struct timer_list mbox_tmo;     /* Hold clk to timeout active mbox
 203                                            cmd */
 204
 205         uint32_t *MBhostaddr;   /* virtual address for mbox cmds */
 206
 207 #define LPFC_IOCBQ_LOOKUP_INCREMENT  1024
 208         struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
 209         size_t iocbq_lookup_len;           /* current lengs of the array */
 210         uint16_t  last_iotag;              /* last allocated IOTAG */
 211 };
 212
 213 /* Given a pointer to the start of the ring, and the slot number of
 214  * the desired iocb entry, calc a pointer to that entry.
 215  * (assume iocb entry size is 32 bytes, or 8 words)
 216  */
 217 #define IOCB_ENTRY(ring,slot) ((IOCB_t *)(((char *)(ring)) + ((slot) * 32)))
 218
 219 #define LPFC_MBOX_TMO           30      /* Sec tmo for outstanding mbox
 220                                            command */