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