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