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