| 1 | /* bnx2fc_constants.h: QLogic Linux FCoE offload driver. |
|---|
| 2 | * Handles operations such as session offload/upload etc, and manages |
|---|
| 3 | * session resources such as connection id and qp resources. |
|---|
| 4 | * |
|---|
| 5 | * Copyright (c) 2008-2013 Broadcom Corporation |
|---|
| 6 | * Copyright (c) 2014-2016 QLogic Corporation |
|---|
| 7 | * Copyright (c) 2016-2017 Cavium Inc. |
|---|
| 8 | * |
|---|
| 9 | * This program is free software; you can redistribute it and/or modify |
|---|
| 10 | * it under the terms of the GNU General Public License as published by |
|---|
| 11 | * the Free Software Foundation. |
|---|
| 12 | * |
|---|
| 13 | */ |
|---|
| 14 | |
|---|
| 15 | #ifndef __BNX2FC_CONSTANTS_H_ |
|---|
| 16 | #define __BNX2FC_CONSTANTS_H_ |
|---|
| 17 | |
|---|
| 18 | /** |
|---|
| 19 | * This file defines HSI constants for the FCoE flows |
|---|
| 20 | */ |
|---|
| 21 | |
|---|
| 22 | /* Current FCoE HSI version number composed of two fields (16 bit) */ |
|---|
| 23 | /* Implies on a change broken previous HSI */ |
|---|
| 24 | #define FCOE_HSI_MAJOR_VERSION (2) |
|---|
| 25 | /* Implies on a change which does not broken previous HSI */ |
|---|
| 26 | #define FCOE_HSI_MINOR_VERSION (1) |
|---|
| 27 | |
|---|
| 28 | /* KWQ/KCQ FCoE layer code */ |
|---|
| 29 | #define FCOE_KWQE_LAYER_CODE (7) |
|---|
| 30 | |
|---|
| 31 | /* KWQ (kernel work queue) request op codes */ |
|---|
| 32 | #define FCOE_KWQE_OPCODE_INIT1 (0) |
|---|
| 33 | #define FCOE_KWQE_OPCODE_INIT2 (1) |
|---|
| 34 | #define FCOE_KWQE_OPCODE_INIT3 (2) |
|---|
| 35 | #define FCOE_KWQE_OPCODE_OFFLOAD_CONN1 (3) |
|---|
| 36 | #define FCOE_KWQE_OPCODE_OFFLOAD_CONN2 (4) |
|---|
| 37 | #define FCOE_KWQE_OPCODE_OFFLOAD_CONN3 (5) |
|---|
| 38 | #define FCOE_KWQE_OPCODE_OFFLOAD_CONN4 (6) |
|---|
| 39 | #define FCOE_KWQE_OPCODE_ENABLE_CONN (7) |
|---|
| 40 | #define FCOE_KWQE_OPCODE_DISABLE_CONN (8) |
|---|
| 41 | #define FCOE_KWQE_OPCODE_DESTROY_CONN (9) |
|---|
| 42 | #define FCOE_KWQE_OPCODE_DESTROY (10) |
|---|
| 43 | #define FCOE_KWQE_OPCODE_STAT (11) |
|---|
| 44 | |
|---|
| 45 | /* KCQ (kernel completion queue) response op codes */ |
|---|
| 46 | #define FCOE_KCQE_OPCODE_INIT_FUNC (0x10) |
|---|
| 47 | #define FCOE_KCQE_OPCODE_DESTROY_FUNC (0x11) |
|---|
| 48 | #define FCOE_KCQE_OPCODE_STAT_FUNC (0x12) |
|---|
| 49 | #define FCOE_KCQE_OPCODE_OFFLOAD_CONN (0x15) |
|---|
| 50 | #define FCOE_KCQE_OPCODE_ENABLE_CONN (0x16) |
|---|
| 51 | #define FCOE_KCQE_OPCODE_DISABLE_CONN (0x17) |
|---|
| 52 | #define FCOE_KCQE_OPCODE_DESTROY_CONN (0x18) |
|---|
| 53 | #define FCOE_KCQE_OPCODE_CQ_EVENT_NOTIFICATION (0x20) |
|---|
| 54 | #define FCOE_KCQE_OPCODE_FCOE_ERROR (0x21) |
|---|
| 55 | |
|---|
| 56 | /* KCQ (kernel completion queue) completion status */ |
|---|
| 57 | #define FCOE_KCQE_COMPLETION_STATUS_SUCCESS (0x0) |
|---|
| 58 | #define FCOE_KCQE_COMPLETION_STATUS_ERROR (0x1) |
|---|
| 59 | #define FCOE_KCQE_COMPLETION_STATUS_INVALID_OPCODE (0x2) |
|---|
| 60 | #define FCOE_KCQE_COMPLETION_STATUS_CTX_ALLOC_FAILURE (0x3) |
|---|
| 61 | #define FCOE_KCQE_COMPLETION_STATUS_CTX_FREE_FAILURE (0x4) |
|---|
| 62 | #define FCOE_KCQE_COMPLETION_STATUS_NIC_ERROR (0x5) |
|---|
| 63 | #define FCOE_KCQE_COMPLETION_STATUS_WRONG_HSI_VERSION (0x6) |
|---|
| 64 | #define FCOE_KCQE_COMPLETION_STATUS_PARITY_ERROR (0x81) |
|---|
| 65 | |
|---|
| 66 | /* CQE type */ |
|---|
| 67 | #define FCOE_PENDING_CQE_TYPE 0 |
|---|
| 68 | #define FCOE_UNSOLIC_CQE_TYPE 1 |
|---|
| 69 | |
|---|
| 70 | /* Unsolicited CQE type */ |
|---|
| 71 | #define FCOE_UNSOLICITED_FRAME_CQE_TYPE 0 |
|---|
| 72 | #define FCOE_ERROR_DETECTION_CQE_TYPE 1 |
|---|
| 73 | #define FCOE_WARNING_DETECTION_CQE_TYPE 2 |
|---|
| 74 | |
|---|
| 75 | /* E_D_TOV timer resolution in ms */ |
|---|
| 76 | #define FCOE_E_D_TOV_TIMER_RESOLUTION_MS (20) |
|---|
| 77 | |
|---|
| 78 | /* E_D_TOV timer resolution for SDM (4 micro) */ |
|---|
| 79 | #define FCOE_E_D_TOV_SDM_TIMER_RESOLUTION \ |
|---|
| 80 | (FCOE_E_D_TOV_TIMER_RESOLUTION_MS * 1000 / 4) |
|---|
| 81 | |
|---|
| 82 | /* REC timer resolution in ms */ |
|---|
| 83 | #define FCOE_REC_TIMER_RESOLUTION_MS (20) |
|---|
| 84 | |
|---|
| 85 | /* REC timer resolution for SDM (4 micro) */ |
|---|
| 86 | #define FCOE_REC_SDM_TIMER_RESOLUTION (FCOE_REC_TIMER_RESOLUTION_MS * 1000 / 4) |
|---|
| 87 | |
|---|
| 88 | /* E_D_TOV timer default wraparound value (2 sec) in 20 ms resolution */ |
|---|
| 89 | #define FCOE_E_D_TOV_DEFAULT_WRAPAROUND_VAL \ |
|---|
| 90 | (2000 / FCOE_E_D_TOV_TIMER_RESOLUTION_MS) |
|---|
| 91 | |
|---|
| 92 | /* REC_TOV timer default wraparound value (3 sec) in 20 ms resolution */ |
|---|
| 93 | #define FCOE_REC_TOV_DEFAULT_WRAPAROUND_VAL \ |
|---|
| 94 | (3000 / FCOE_REC_TIMER_RESOLUTION_MS) |
|---|
| 95 | |
|---|
| 96 | #define FCOE_NUM_OF_TIMER_TASKS (8 * 1024) |
|---|
| 97 | |
|---|
| 98 | #define FCOE_NUM_OF_CACHED_TASKS_TIMER (8) |
|---|
| 99 | |
|---|
| 100 | /* Task context constants */ |
|---|
| 101 | /******** Remove FCP_CMD write tce sleep ***********************/ |
|---|
| 102 | /* In case timer services are required then shall be updated by Xstorm after |
|---|
| 103 | * start processing the task. In case no timer facilities are required then the |
|---|
| 104 | * driver would initialize the state to this value |
|---|
| 105 | * |
|---|
| 106 | #define FCOE_TASK_TX_STATE_NORMAL 0 |
|---|
| 107 | * After driver has initialize the task in case timer services required * |
|---|
| 108 | #define FCOE_TASK_TX_STATE_INIT 1 |
|---|
| 109 | ******** Remove FCP_CMD write tce sleep ***********************/ |
|---|
| 110 | /* After driver has initialize the task in case timer services required */ |
|---|
| 111 | #define FCOE_TASK_TX_STATE_INIT 0 |
|---|
| 112 | /* In case timer services are required then shall be updated by Xstorm after |
|---|
| 113 | * start processing the task. In case no timer facilities are required then the |
|---|
| 114 | * driver would initialize the state to this value |
|---|
| 115 | */ |
|---|
| 116 | #define FCOE_TASK_TX_STATE_NORMAL 1 |
|---|
| 117 | /* Task is under abort procedure. Updated in order to stop processing of |
|---|
| 118 | * pending WQEs on this task |
|---|
| 119 | */ |
|---|
| 120 | #define FCOE_TASK_TX_STATE_ABORT 2 |
|---|
| 121 | /* For E_D_T_TOV timer expiration in Xstorm (Class 2 only) */ |
|---|
| 122 | #define FCOE_TASK_TX_STATE_ERROR 3 |
|---|
| 123 | /* For REC_TOV timer expiration indication received from Xstorm */ |
|---|
| 124 | #define FCOE_TASK_TX_STATE_WARNING 4 |
|---|
| 125 | /* For completed unsolicited task */ |
|---|
| 126 | #define FCOE_TASK_TX_STATE_UNSOLICITED_COMPLETED 5 |
|---|
| 127 | /* For exchange cleanup request task */ |
|---|
| 128 | #define FCOE_TASK_TX_STATE_EXCHANGE_CLEANUP 6 |
|---|
| 129 | /* For sequence cleanup request task */ |
|---|
| 130 | #define FCOE_TASK_TX_STATE_SEQUENCE_CLEANUP 7 |
|---|
| 131 | /* For completion the ABTS task. */ |
|---|
| 132 | #define FCOE_TASK_TX_STATE_ABTS_TX 8 |
|---|
| 133 | |
|---|
| 134 | #define FCOE_TASK_RX_STATE_NORMAL 0 |
|---|
| 135 | #define FCOE_TASK_RX_STATE_COMPLETED 1 |
|---|
| 136 | /* Obsolete: Intermediate completion (middle path with local completion) */ |
|---|
| 137 | #define FCOE_TASK_RX_STATE_INTER_COMP 2 |
|---|
| 138 | /* For REC_TOV timer expiration indication received from Xstorm */ |
|---|
| 139 | #define FCOE_TASK_RX_STATE_WARNING 3 |
|---|
| 140 | /* For E_D_T_TOV timer expiration in Ustorm */ |
|---|
| 141 | #define FCOE_TASK_RX_STATE_ERROR 4 |
|---|
| 142 | /* FW only: First visit at rx-path, part of the abts round trip */ |
|---|
| 143 | #define FCOE_TASK_RX_STATE_ABTS_IN_PROCESS 5 |
|---|
| 144 | /* FW only: Second visit at rx-path, after ABTS frame transmitted */ |
|---|
| 145 | #define FCOE_TASK_RX_STATE_ABTS_TRANSMITTED 6 |
|---|
| 146 | /* Special completion indication in case of task was aborted. */ |
|---|
| 147 | #define FCOE_TASK_RX_STATE_ABTS_COMPLETED 7 |
|---|
| 148 | /* FW only: First visit at rx-path, part of the cleanup round trip */ |
|---|
| 149 | #define FCOE_TASK_RX_STATE_EXCHANGE_CLEANUP_IN_PROCESS 8 |
|---|
| 150 | /* FW only: Special completion indication in case of task was cleaned. */ |
|---|
| 151 | #define FCOE_TASK_RX_STATE_EXCHANGE_CLEANUP_COMPLETED 9 |
|---|
| 152 | /* Not in used: Special completion indication (in task requested the exchange |
|---|
| 153 | * cleanup) in case cleaned task is in non-valid. |
|---|
| 154 | */ |
|---|
| 155 | #define FCOE_TASK_RX_STATE_ABORT_CLEANUP_COMPLETED 10 |
|---|
| 156 | /* Special completion indication (in task requested the sequence cleanup) in |
|---|
| 157 | * case cleaned task was already returned to normal. |
|---|
| 158 | */ |
|---|
| 159 | #define FCOE_TASK_RX_STATE_IGNORED_SEQUENCE_CLEANUP 11 |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | #define FCOE_TASK_TYPE_WRITE 0 |
|---|
| 163 | #define FCOE_TASK_TYPE_READ 1 |
|---|
| 164 | #define FCOE_TASK_TYPE_MIDPATH 2 |
|---|
| 165 | #define FCOE_TASK_TYPE_UNSOLICITED 3 |
|---|
| 166 | #define FCOE_TASK_TYPE_ABTS 4 |
|---|
| 167 | #define FCOE_TASK_TYPE_EXCHANGE_CLEANUP 5 |
|---|
| 168 | #define FCOE_TASK_TYPE_SEQUENCE_CLEANUP 6 |
|---|
| 169 | |
|---|
| 170 | #define FCOE_TASK_DEV_TYPE_DISK 0 |
|---|
| 171 | #define FCOE_TASK_DEV_TYPE_TAPE 1 |
|---|
| 172 | |
|---|
| 173 | #define FCOE_TASK_CLASS_TYPE_3 0 |
|---|
| 174 | #define FCOE_TASK_CLASS_TYPE_2 1 |
|---|
| 175 | |
|---|
| 176 | /* FCoE/FC packet fields */ |
|---|
| 177 | #define FCOE_ETH_TYPE 0x8906 |
|---|
| 178 | |
|---|
| 179 | /* FCoE maximum elements in hash table */ |
|---|
| 180 | #define FCOE_MAX_ELEMENTS_IN_HASH_TABLE_ROW 8 |
|---|
| 181 | |
|---|
| 182 | /* FCoE half of the elements in hash table */ |
|---|
| 183 | #define FCOE_HALF_ELEMENTS_IN_HASH_TABLE_ROW \ |
|---|
| 184 | (FCOE_MAX_ELEMENTS_IN_HASH_TABLE_ROW / 2) |
|---|
| 185 | |
|---|
| 186 | /* FcoE number of cached T2 entries */ |
|---|
| 187 | #define T_FCOE_NUMBER_OF_CACHED_T2_ENTRIES (4) |
|---|
| 188 | |
|---|
| 189 | /* FCoE maximum elements in hash table */ |
|---|
| 190 | #define FCOE_HASH_TBL_CHUNK_SIZE 16384 |
|---|
| 191 | |
|---|
| 192 | /* Everest FCoE connection type */ |
|---|
| 193 | #define B577XX_FCOE_CONNECTION_TYPE 4 |
|---|
| 194 | |
|---|
| 195 | /* FCoE number of rows (in log). This number derives |
|---|
| 196 | * from the maximum connections supported which is 2048. |
|---|
| 197 | * TBA: Need a different constant for E2 |
|---|
| 198 | */ |
|---|
| 199 | #define FCOE_MAX_NUM_SESSIONS_LOG 11 |
|---|
| 200 | |
|---|
| 201 | #define FC_ABTS_REPLY_MAX_PAYLOAD_LEN 12 |
|---|
| 202 | |
|---|
| 203 | /* Error codes for Error Reporting in slow path flows */ |
|---|
| 204 | #define FCOE_SLOW_PATH_ERROR_CODE_TOO_MANY_FUNCS 0 |
|---|
| 205 | #define FCOE_SLOW_PATH_ERROR_CODE_NO_LICENSE 1 |
|---|
| 206 | |
|---|
| 207 | /* Error codes for Error Reporting in fast path flows |
|---|
| 208 | * XFER error codes |
|---|
| 209 | */ |
|---|
| 210 | #define FCOE_ERROR_CODE_XFER_OOO_RO 0 |
|---|
| 211 | #define FCOE_ERROR_CODE_XFER_RO_NOT_ALIGNED 1 |
|---|
| 212 | #define FCOE_ERROR_CODE_XFER_NULL_BURST_LEN 2 |
|---|
| 213 | #define FCOE_ERROR_CODE_XFER_RO_GREATER_THAN_DATA2TRNS 3 |
|---|
| 214 | #define FCOE_ERROR_CODE_XFER_INVALID_PAYLOAD_SIZE 4 |
|---|
| 215 | #define FCOE_ERROR_CODE_XFER_TASK_TYPE_NOT_WRITE 5 |
|---|
| 216 | #define FCOE_ERROR_CODE_XFER_PEND_XFER_SET 6 |
|---|
| 217 | #define FCOE_ERROR_CODE_XFER_OPENED_SEQ 7 |
|---|
| 218 | #define FCOE_ERROR_CODE_XFER_FCTL 8 |
|---|
| 219 | |
|---|
| 220 | /* FCP RSP error codes */ |
|---|
| 221 | #define FCOE_ERROR_CODE_FCP_RSP_BIDI_FLAGS_SET 9 |
|---|
| 222 | #define FCOE_ERROR_CODE_FCP_RSP_UNDERFLOW 10 |
|---|
| 223 | #define FCOE_ERROR_CODE_FCP_RSP_OVERFLOW 11 |
|---|
| 224 | #define FCOE_ERROR_CODE_FCP_RSP_INVALID_LENGTH_FIELD 12 |
|---|
| 225 | #define FCOE_ERROR_CODE_FCP_RSP_INVALID_SNS_FIELD 13 |
|---|
| 226 | #define FCOE_ERROR_CODE_FCP_RSP_INVALID_PAYLOAD_SIZE 14 |
|---|
| 227 | #define FCOE_ERROR_CODE_FCP_RSP_PEND_XFER_SET 15 |
|---|
| 228 | #define FCOE_ERROR_CODE_FCP_RSP_OPENED_SEQ 16 |
|---|
| 229 | #define FCOE_ERROR_CODE_FCP_RSP_FCTL 17 |
|---|
| 230 | #define FCOE_ERROR_CODE_FCP_RSP_LAST_SEQ_RESET 18 |
|---|
| 231 | #define FCOE_ERROR_CODE_FCP_RSP_CONF_REQ_NOT_SUPPORTED_YET 19 |
|---|
| 232 | |
|---|
| 233 | /* FCP DATA error codes */ |
|---|
| 234 | #define FCOE_ERROR_CODE_DATA_OOO_RO 20 |
|---|
| 235 | #define FCOE_ERROR_CODE_DATA_EXCEEDS_DEFINED_MAX_FRAME_SIZE 21 |
|---|
| 236 | #define FCOE_ERROR_CODE_DATA_EXCEEDS_DATA2TRNS 22 |
|---|
| 237 | #define FCOE_ERROR_CODE_DATA_SOFI3_SEQ_ACTIVE_SET 23 |
|---|
| 238 | #define FCOE_ERROR_CODE_DATA_SOFN_SEQ_ACTIVE_RESET 24 |
|---|
| 239 | #define FCOE_ERROR_CODE_DATA_EOFN_END_SEQ_SET 25 |
|---|
| 240 | #define FCOE_ERROR_CODE_DATA_EOFT_END_SEQ_RESET 26 |
|---|
| 241 | #define FCOE_ERROR_CODE_DATA_TASK_TYPE_NOT_READ 27 |
|---|
| 242 | #define FCOE_ERROR_CODE_DATA_FCTL 28 |
|---|
| 243 | |
|---|
| 244 | /* Middle path error codes */ |
|---|
| 245 | #define FCOE_ERROR_CODE_MIDPATH_INVALID_TYPE 29 |
|---|
| 246 | #define FCOE_ERROR_CODE_MIDPATH_SOFI3_SEQ_ACTIVE_SET 30 |
|---|
| 247 | #define FCOE_ERROR_CODE_MIDPATH_SOFN_SEQ_ACTIVE_RESET 31 |
|---|
| 248 | #define FCOE_ERROR_CODE_MIDPATH_EOFN_END_SEQ_SET 32 |
|---|
| 249 | #define FCOE_ERROR_CODE_MIDPATH_EOFT_END_SEQ_RESET 33 |
|---|
| 250 | #define FCOE_ERROR_CODE_MIDPATH_REPLY_FCTL 34 |
|---|
| 251 | #define FCOE_ERROR_CODE_MIDPATH_INVALID_REPLY 35 |
|---|
| 252 | #define FCOE_ERROR_CODE_MIDPATH_ELS_REPLY_RCTL 36 |
|---|
| 253 | |
|---|
| 254 | /* ABTS error codes */ |
|---|
| 255 | #define FCOE_ERROR_CODE_ABTS_REPLY_F_CTL 37 |
|---|
| 256 | #define FCOE_ERROR_CODE_ABTS_REPLY_DDF_RCTL_FIELD 38 |
|---|
| 257 | #define FCOE_ERROR_CODE_ABTS_REPLY_INVALID_BLS_RCTL 39 |
|---|
| 258 | #define FCOE_ERROR_CODE_ABTS_REPLY_INVALID_RCTL 40 |
|---|
| 259 | #define FCOE_ERROR_CODE_ABTS_REPLY_RCTL_GENERAL_MISMATCH 41 |
|---|
| 260 | |
|---|
| 261 | /* Common error codes */ |
|---|
| 262 | #define FCOE_ERROR_CODE_COMMON_MIDDLE_FRAME_WITH_PAD 42 |
|---|
| 263 | #define FCOE_ERROR_CODE_COMMON_SEQ_INIT_IN_TCE 43 |
|---|
| 264 | #define FCOE_ERROR_CODE_COMMON_FC_HDR_RX_ID_MISMATCH 44 |
|---|
| 265 | #define FCOE_ERROR_CODE_COMMON_INCORRECT_SEQ_CNT 45 |
|---|
| 266 | #define FCOE_ERROR_CODE_COMMON_DATA_FC_HDR_FCP_TYPE_MISMATCH 46 |
|---|
| 267 | #define FCOE_ERROR_CODE_COMMON_DATA_NO_MORE_SGES 47 |
|---|
| 268 | #define FCOE_ERROR_CODE_COMMON_OPTIONAL_FC_HDR 48 |
|---|
| 269 | #define FCOE_ERROR_CODE_COMMON_READ_TCE_OX_ID_TOO_BIG 49 |
|---|
| 270 | #define FCOE_ERROR_CODE_COMMON_DATA_WAS_NOT_TRANSMITTED 50 |
|---|
| 271 | |
|---|
| 272 | /* Unsolicited Rx error codes */ |
|---|
| 273 | #define FCOE_ERROR_CODE_UNSOLICITED_TYPE_NOT_ELS 51 |
|---|
| 274 | #define FCOE_ERROR_CODE_UNSOLICITED_TYPE_NOT_BLS 52 |
|---|
| 275 | #define FCOE_ERROR_CODE_UNSOLICITED_FCTL_ELS 53 |
|---|
| 276 | #define FCOE_ERROR_CODE_UNSOLICITED_FCTL_BLS 54 |
|---|
| 277 | #define FCOE_ERROR_CODE_UNSOLICITED_R_CTL 55 |
|---|
| 278 | |
|---|
| 279 | #define FCOE_ERROR_CODE_RW_TASK_DDF_RCTL_INFO_FIELD 56 |
|---|
| 280 | #define FCOE_ERROR_CODE_RW_TASK_INVALID_RCTL 57 |
|---|
| 281 | #define FCOE_ERROR_CODE_RW_TASK_RCTL_GENERAL_MISMATCH 58 |
|---|
| 282 | |
|---|
| 283 | /* Timer error codes */ |
|---|
| 284 | #define FCOE_ERROR_CODE_E_D_TOV_TIMER_EXPIRATION 60 |
|---|
| 285 | #define FCOE_ERROR_CODE_REC_TOV_TIMER_EXPIRATION 61 |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | #endif /* BNX2FC_CONSTANTS_H_ */ |
|---|
| 289 | |
|---|
