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