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