]>
Commit | Line | Data |
---|---|---|
12618416 | 1 | /** @file\r |
55a64ae0 | 2 | The header file of iSCSI Protocol that defines many specific data structures.\r |
6a690e23 | 3 | \r |
d1102dba | 4 | Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
7a444476 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
6a690e23 | 12 | \r |
12618416 | 13 | **/\r |
6a690e23 | 14 | \r |
15 | #ifndef _ISCSI_PROTO_H_\r | |
16 | #define _ISCSI_PROTO_H_\r | |
17 | \r | |
9cb8724d | 18 | #include <Protocol/ScsiPassThruExt.h>\r |
6a690e23 | 19 | \r |
20 | //\r | |
21 | // RFC 1982 Serial Number Arithmetic, SERIAL_BITS = 32\r | |
22 | //\r | |
23 | #define ISCSI_SEQ_EQ(s1, s2) ((s1) == (s2))\r | |
24 | #define ISCSI_SEQ_LT(s1, s2) \\r | |
25 | ( \\r | |
1c574ee4 | 26 | (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) < ((UINT32) 1 << 31)) || \\r |
27 | (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) > ((UINT32) 1 << 31)) \\r | |
6a690e23 | 28 | )\r |
29 | #define ISCSI_SEQ_GT(s1, s2) \\r | |
30 | ( \\r | |
1c574ee4 | 31 | (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) > ((UINT32) 1 << 31)) || \\r |
32 | (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) < ((UINT32) 1 << 31)) \\r | |
6a690e23 | 33 | )\r |
34 | \r | |
35 | #define ISCSI_WELL_KNOWN_PORT 3260\r | |
36 | #define ISCSI_MAX_CONNS_PER_SESSION 1\r | |
37 | \r | |
38 | #define DEFAULT_MAX_RECV_DATA_SEG_LEN 8192\r | |
39 | #define MAX_RECV_DATA_SEG_LEN_IN_FFP 65536\r | |
40 | #define DEFAULT_MAX_OUTSTANDING_R2T 1\r | |
41 | \r | |
42 | #define ISCSI_VERSION_MAX 0x00\r | |
43 | #define ISCSI_VERSION_MIN 0x00\r | |
44 | \r | |
8ce6b650 | 45 | #define ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)\r |
46 | #define ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)\r | |
47 | \r | |
6a690e23 | 48 | #define ISCSI_KEY_AUTH_METHOD "AuthMethod"\r |
49 | #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"\r | |
50 | #define ISCSI_KEY_DATA_DIGEST "DataDigest"\r | |
51 | #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"\r | |
52 | #define ISCSI_KEY_TARGET_NAME "TargetName"\r | |
53 | #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"\r | |
54 | #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"\r | |
55 | #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"\r | |
56 | #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"\r | |
57 | #define ISCSI_KEY_INITIAL_R2T "InitialR2T"\r | |
58 | #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"\r | |
59 | #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"\r | |
60 | #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"\r | |
61 | #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"\r | |
62 | #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"\r | |
63 | #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"\r | |
64 | #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"\r | |
65 | #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"\r | |
66 | #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"\r | |
67 | #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"\r | |
68 | #define ISCSI_KEY_SESSION_TYPE "SessionType"\r | |
69 | #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"\r | |
70 | \r | |
71 | #define ISCSI_KEY_VALUE_NONE "None"\r | |
72 | \r | |
db3e605d | 73 | ///\r |
74 | /// connection state for initiator\r | |
75 | ///\r | |
f6b7393c | 76 | \r |
77 | #define CONN_STATE_FREE 0\r | |
78 | #define CONN_STATE_XPT_WAIT 1\r | |
79 | #define CONN_STATE_IN_LOGIN 2\r | |
80 | #define CONN_STATE_LOGGED_IN 3\r | |
81 | #define CONN_STATE_IN_LOGOUT 4\r | |
82 | #define CONN_STATE_LOGOUT_REQUESTED 5\r | |
83 | #define CONN_STATE_CLEANUP_WAIT 6\r | |
84 | #define CONN_STATE_IN_CLEANUP 7\r | |
6a690e23 | 85 | \r |
db3e605d | 86 | ///\r |
87 | /// session state for initiator\r | |
88 | ///\r | |
f6b7393c | 89 | #define SESSION_STATE_FREE 0\r |
90 | #define SESSION_STATE_LOGGED_IN 1\r | |
91 | #define SESSION_STATE_FAILED 2\r | |
6a690e23 | 92 | \r |
93 | typedef enum {\r | |
94 | DataIn = 0,\r | |
95 | DataOut = 1,\r | |
96 | DataBi = 2\r | |
97 | } DATA_DIRECTION;\r | |
98 | \r | |
99 | #define ISCSI_RESERVED_TAG 0xffffffff\r | |
100 | \r | |
101 | #define ISCSI_REQ_IMMEDIATE 0x40\r | |
102 | #define ISCSI_OPCODE_MASK 0x3F\r | |
103 | \r | |
104 | #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))\r | |
105 | #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)\r | |
106 | #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))\r | |
107 | #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)\r | |
69b0882d | 108 | #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))\r |
6a690e23 | 109 | #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))\r |
93e3992d | 110 | #define ISCSI_FLAG_ON(PduHdr, Flag) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag))\r |
69b0882d | 111 | #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))\r |
6a690e23 | 112 | #define ISCSI_GET_CURRENT_STAGE(PduHdr) (((PduHdr)->Flags >> 2) & 0x3)\r |
113 | #define ISCSI_GET_NEXT_STAGE(PduHdr) (((PduHdr)->Flags) & 0x3)\r | |
114 | \r | |
115 | #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)\r | |
116 | #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))\r | |
117 | \r | |
118 | #define HTON24(Dst, Src) \\r | |
119 | do { \\r | |
69b0882d | 120 | (Dst)[0] = (UINT8) (((Src) >> 16) & 0xFF); \\r |
121 | (Dst)[1] = (UINT8) (((Src) >> 8) & 0xFF); \\r | |
122 | (Dst)[2] = (UINT8) ((Src) & 0xFF); \\r | |
6a690e23 | 123 | } while (0);\r |
124 | \r | |
125 | #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))\r | |
126 | \r | |
127 | #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)\r | |
128 | #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))\r | |
129 | \r | |
130 | //\r | |
131 | // initiator opcodes\r | |
132 | //\r | |
133 | #define ISCSI_OPCODE_NOP_OUT 0x00\r | |
134 | #define ISCSI_OPCODE_SCSI_CMD 0x01\r | |
135 | #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02\r | |
136 | #define ISCSI_OPCODE_LOGIN_REQ 0x03\r | |
137 | #define ISCSI_OPCODE_TEXT_REQ 0x04\r | |
138 | #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05\r | |
139 | #define ISCSI_OPCODE_LOGOUT_REQ 0x06\r | |
140 | #define ISCSI_OPCODE_SNACK_REQ 0x10\r | |
141 | #define ISCSI_OPCODE_VENDOR_I0 0x1c\r | |
142 | #define ISCSI_OPCODE_VENDOR_I1 0x1d\r | |
143 | #define ISCSI_OPCODE_VENDOR_I2 0x1e\r | |
144 | \r | |
145 | //\r | |
146 | // target opcodes\r | |
147 | //\r | |
148 | #define ISCSI_OPCODE_NOP_IN 0x20\r | |
149 | #define ISCSI_OPCODE_SCSI_RSP 0x21\r | |
150 | #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22\r | |
151 | #define ISCSI_OPCODE_LOGIN_RSP 0x23\r | |
152 | #define ISCSI_OPCODE_TEXT_RSP 0x24\r | |
153 | #define ISCSI_OPCODE_SCSI_DATA_IN 0x25\r | |
154 | #define ISCSI_OPCODE_LOGOUT_RSP 0x26\r | |
155 | #define ISCSI_OPCODE_R2T 0x31\r | |
156 | #define ISCSI_OPCODE_ASYNC_MSG 0x32\r | |
157 | #define ISCSI_OPCODE_VENDOR_T0 0x3c\r | |
158 | #define ISCSI_OPCODE_VENDOR_T1 0x3d\r | |
159 | #define ISCSI_OPCODE_VENDOR_T2 0x3e\r | |
160 | #define ISCSI_OPCODE_REJECT 0x3f\r | |
161 | \r | |
162 | #define ISCSI_BHS_FLAG_FINAL 0x80\r | |
163 | \r | |
db3e605d | 164 | ///\r |
165 | /// iSCSI Basic Header Segment\r | |
166 | ///\r | |
6a690e23 | 167 | typedef struct _ISCSI_BASIC_HEADER {\r |
168 | UINT8 OpCode;\r | |
169 | UINT8 Flags;\r | |
170 | UINT16 OpCodeSpecific1;\r | |
171 | UINT8 TotalAHSLength;\r | |
172 | UINT8 DataSegmentLength[3];\r | |
173 | UINT8 Lun[8];\r | |
174 | UINT32 InitiatorTaskTag;\r | |
175 | UINT32 OpCodeSpecific2[7];\r | |
176 | } ISCSI_BASIC_HEADER;\r | |
177 | \r | |
178 | //\r | |
179 | // Defined AHS types, others are reserved.\r | |
180 | //\r | |
181 | #define ISCSI_AHS_TYPE_EXT_CDB 0x1\r | |
182 | #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2\r | |
183 | \r | |
184 | typedef struct _ISCSI_ADDTIONAL_HEADER {\r | |
185 | UINT16 Length;\r | |
186 | UINT8 Type;\r | |
187 | UINT8 TypeSpecific[1];\r | |
188 | } ISCSI_ADDITIONAL_HEADER;\r | |
189 | \r | |
190 | typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS {\r | |
191 | UINT16 Length;\r | |
192 | UINT8 Type;\r | |
193 | UINT8 Reserved;\r | |
194 | UINT32 ExpReadDataLength;\r | |
195 | } ISCSI_BI_EXP_READ_DATA_LEN_AHS;\r | |
196 | \r | |
197 | #define SCSI_CMD_PDU_FLAG_READ 0x40\r | |
198 | #define SCSI_CMD_PDU_FLAG_WRITE 0x20\r | |
199 | \r | |
200 | #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07\r | |
201 | \r | |
202 | //\r | |
203 | // task attributes\r | |
204 | //\r | |
205 | #define ISCSI_TASK_ATTR_UNTAGGED 0x00\r | |
206 | #define ISCSI_TASK_ATTR_SIMPLE 0x01\r | |
207 | #define ISCSI_TASK_ATTR_ORDERD 0x02\r | |
208 | #define ISCSI_TASK_ATTR_HOQ 0x03\r | |
209 | #define ISCSI_TASK_ATTR_ACA 0x04\r | |
210 | \r | |
db3e605d | 211 | ///\r |
212 | /// SCSI Command\r | |
213 | ///\r | |
6a690e23 | 214 | typedef struct _SCSI_COMMAND {\r |
215 | UINT8 OpCode;\r | |
216 | UINT8 Flags;\r | |
217 | UINT16 Reserved;\r | |
218 | UINT8 TotalAHSLength;\r | |
219 | UINT8 DataSegmentLength[3];\r | |
220 | UINT8 Lun[8];\r | |
221 | UINT32 InitiatorTaskTag;\r | |
222 | UINT32 ExpDataXferLength;\r | |
223 | UINT32 CmdSN;\r | |
224 | UINT32 ExpStatSN;\r | |
f6b7393c | 225 | UINT8 Cdb[16];\r |
6a690e23 | 226 | } SCSI_COMMAND;\r |
227 | \r | |
228 | //\r | |
229 | // flag bit definitions in SCSI response\r | |
230 | //\r | |
231 | #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10\r | |
232 | #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08\r | |
233 | #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04\r | |
234 | #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02\r | |
235 | \r | |
236 | //\r | |
237 | // iSCSI service response codes\r | |
238 | //\r | |
239 | #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00\r | |
240 | #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01\r | |
241 | \r | |
db3e605d | 242 | ///\r |
243 | /// SCSI Response\r | |
244 | ///\r | |
6a690e23 | 245 | typedef struct _SCSI_RESPONSE {\r |
246 | UINT8 OpCode;\r | |
247 | UINT8 Flags;\r | |
248 | UINT8 Response;\r | |
249 | UINT8 Status;\r | |
250 | UINT8 TotalAHSLength;\r | |
251 | UINT8 DataSegmentLength[3];\r | |
252 | UINT8 Reserved[8];\r | |
253 | UINT32 InitiatorTaskTag;\r | |
254 | UINT32 SNACKTag;\r | |
255 | UINT32 StatSN;\r | |
256 | UINT32 ExpCmdSN;\r | |
257 | UINT32 MaxCmdSN;\r | |
258 | UINT32 ExpDataSN;\r | |
259 | UINT32 BiReadResidualCount;\r | |
260 | UINT32 ResidualCount;\r | |
261 | } SCSI_RESPONSE;\r | |
262 | \r | |
263 | typedef struct _ISCSI_SENSE_DATA {\r | |
264 | UINT16 Length;\r | |
265 | UINT8 Data[2];\r | |
266 | } ISCSI_SENSE_DATA;\r | |
267 | \r | |
db3e605d | 268 | ///\r |
269 | /// iSCSI Task Managment Function Request\r | |
270 | ///\r | |
6a690e23 | 271 | typedef struct _ISCSI_TMF_REQUEST {\r |
272 | UINT8 OpCode;\r | |
273 | UINT8 Fuction;\r | |
274 | UINT16 Reserved1;\r | |
275 | UINT8 TotalAHSLength;\r | |
276 | UINT8 DataSegmentLength[3];\r | |
277 | UINT8 Lun[8];\r | |
278 | UINT32 InitiatorTaskTag;\r | |
279 | UINT32 ReferencedTaskTag;\r | |
280 | UINT32 CmdSN;\r | |
281 | UINT32 ExpStatSN;\r | |
282 | UINT32 RefCmdSN;\r | |
283 | UINT32 ExpDataSN;\r | |
284 | UINT32 Reserved2[2];\r | |
285 | } ISCSI_TMF_REQUEST;\r | |
286 | \r | |
287 | #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0\r | |
288 | #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1\r | |
289 | #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2\r | |
290 | #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3\r | |
291 | #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4\r | |
292 | #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5\r | |
293 | #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6\r | |
294 | #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255\r | |
295 | \r | |
db3e605d | 296 | ///\r |
297 | /// iSCSI Task Management Function Response\r | |
298 | ///\r | |
6a690e23 | 299 | typedef struct _ISCSI_TMF_RESPONSE {\r |
300 | UINT8 OpCode;\r | |
301 | UINT8 Reserved1;\r | |
302 | UINT8 Response;\r | |
303 | UINT8 Reserved2;\r | |
304 | UINT8 TotalAHSLength;\r | |
305 | UINT8 DataSegmentLength[3];\r | |
306 | UINT32 Reserver3[2];\r | |
307 | UINT32 InitiatorTaskTag;\r | |
308 | UINT32 Reserved4;\r | |
309 | UINT32 StatSN;\r | |
310 | UINT32 ExpCmdSN;\r | |
311 | UINT32 MaxCmdSN;\r | |
312 | UINT32 Reserved[3];\r | |
313 | } ISCSI_TMF_RESPONSE;\r | |
314 | \r | |
db3e605d | 315 | ///\r |
316 | /// SCSI Data-Out\r | |
317 | ///\r | |
6a690e23 | 318 | typedef struct _ISCSI_SCSI_DATA_OUT {\r |
319 | UINT8 OpCode;\r | |
320 | UINT8 Reserved1[3];\r | |
321 | UINT8 TotalAHSLength;\r | |
322 | UINT8 DataSegmentLength[3];\r | |
323 | UINT8 Lun[8];\r | |
324 | UINT32 InitiatorTaskTag;\r | |
325 | UINT32 TargetTransferTag;\r | |
326 | UINT32 Reserved2;\r | |
327 | UINT32 ExpStatSN;\r | |
328 | UINT32 Reserved3;\r | |
329 | UINT32 DataSN;\r | |
330 | UINT32 BufferOffset;\r | |
331 | UINT32 Reserved4;\r | |
332 | } ISCSI_SCSI_DATA_OUT;\r | |
333 | \r | |
334 | #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40\r | |
335 | #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW\r | |
336 | #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW\r | |
337 | #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01\r | |
db3e605d | 338 | \r |
339 | ///\r | |
340 | /// SCSI Data-In\r | |
341 | ///\r | |
6a690e23 | 342 | typedef struct _ISCSI_SCSI_DATA_IN {\r |
343 | UINT8 OpCode;\r | |
344 | UINT8 Flags;\r | |
345 | UINT8 Reserved1;\r | |
346 | UINT8 Status;\r | |
347 | UINT8 TotalAHSLength;\r | |
348 | UINT8 DataSegmentLength[3];\r | |
349 | UINT8 Lun[8];\r | |
350 | UINT32 InitiatorTaskTag;\r | |
351 | UINT32 TargetTransferTag;\r | |
352 | UINT32 StatSN;\r | |
353 | UINT32 ExpCmdSN;\r | |
354 | UINT32 MaxCmdSN;\r | |
355 | UINT32 DataSN;\r | |
356 | UINT32 BufferOffset;\r | |
357 | UINT32 ResidualCount;\r | |
358 | } ISCSI_SCSI_DATA_IN;\r | |
359 | \r | |
360 | #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)\r | |
db3e605d | 361 | \r |
362 | ///\r | |
363 | /// Ready To Transfer\r | |
364 | ///\r | |
6a690e23 | 365 | typedef struct _ISCSI_READY_TO_TRANSFER {\r |
366 | UINT8 OpCode;\r | |
367 | UINT8 Reserved1[3];\r | |
368 | UINT8 TotalAHSLength;\r | |
369 | UINT8 DataSegmentLength[3];\r | |
370 | UINT8 Lun[8];\r | |
371 | UINT32 InitiatorTaskTag;\r | |
372 | UINT32 TargetTransferTag;\r | |
373 | UINT32 StatSN;\r | |
374 | UINT32 ExpCmdSN;\r | |
375 | UINT32 MaxCmdSN;\r | |
f6b7393c | 376 | UINT32 R2TSeqNum;\r |
6a690e23 | 377 | UINT32 BufferOffset;\r |
378 | UINT32 DesiredDataTransferLength;\r | |
379 | } ISCSI_READY_TO_TRANSFER;\r | |
380 | \r | |
381 | typedef struct _ISCSI_ASYNC_MESSAGE {\r | |
382 | UINT8 OpCode;\r | |
383 | UINT8 Reserved1[8];\r | |
384 | UINT8 TotalAHSLength;\r | |
385 | UINT8 DataSegmentLength[3];\r | |
386 | UINT8 Lun[8];\r | |
387 | UINT32 InitiatorTaskTag;\r | |
388 | UINT32 Reserved2;\r | |
389 | UINT32 StatSN;\r | |
390 | UINT32 ExpCmdSN;\r | |
391 | UINT32 MaxCmdSN;\r | |
392 | UINT8 AsyncEvent;\r | |
393 | UINT8 AsyncVCode;\r | |
394 | UINT16 Parameter1;\r | |
395 | UINT16 Parameter2;\r | |
396 | UINT16 Parameter3;\r | |
397 | UINT32 Reserved3;\r | |
398 | } ISCSI_ASYNC_MESSAGE;\r | |
399 | \r | |
400 | #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80\r | |
401 | #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40\r | |
402 | \r | |
db3e605d | 403 | ///\r |
404 | /// Login Request\r | |
405 | ///\r | |
6a690e23 | 406 | typedef struct _ISCSI_LOGIN_REQUEST {\r |
407 | UINT8 OpCode;\r | |
408 | UINT8 Flags;\r | |
409 | UINT8 VersionMax;\r | |
410 | UINT8 VersionMin;\r | |
411 | UINT8 TotalAHSLength;\r | |
412 | UINT8 DataSegmentLength[3];\r | |
a78d176c | 413 | UINT8 Isid[6];\r |
414 | UINT16 Tsih;\r | |
6a690e23 | 415 | UINT32 InitiatorTaskTag;\r |
a78d176c | 416 | UINT16 Cid;\r |
6a690e23 | 417 | UINT16 Reserved1;\r |
418 | UINT32 CmdSN;\r | |
419 | UINT32 ExpStatSN;\r | |
420 | UINT32 Reserved2[4];\r | |
421 | } ISCSI_LOGIN_REQUEST;\r | |
422 | \r | |
423 | #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT\r | |
424 | #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE\r | |
425 | \r | |
426 | #define ISCSI_LOGIN_STATUS_SUCCESS 0\r | |
427 | #define ISCSI_LOGIN_STATUS_REDIRECTION 1\r | |
428 | #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2\r | |
429 | #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3\r | |
430 | \r | |
db3e605d | 431 | ///\r |
432 | /// Login Response\r | |
433 | ///\r | |
6a690e23 | 434 | typedef struct _ISCSI_LOGIN_RESPONSE {\r |
435 | UINT8 OpCode;\r | |
436 | UINT8 Flags;\r | |
437 | UINT8 VersionMax;\r | |
438 | UINT8 VersionActive;\r | |
439 | UINT8 TotalAHSLength;\r | |
440 | UINT8 DataSegmentLength[3];\r | |
a78d176c | 441 | UINT8 Isid[6];\r |
442 | UINT16 Tsih;\r | |
6a690e23 | 443 | UINT32 InitiatorTaskTag;\r |
444 | UINT32 Reserved1;\r | |
445 | UINT32 StatSN;\r | |
446 | UINT32 ExpCmdSN;\r | |
447 | UINT32 MaxCmdSN;\r | |
448 | UINT8 StatusClass;\r | |
449 | UINT8 StatusDetail;\r | |
450 | UINT8 Reserved2[10];\r | |
451 | } ISCSI_LOGIN_RESPONSE;\r | |
452 | \r | |
453 | #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0\r | |
454 | #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1\r | |
455 | #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2\r | |
456 | \r | |
db3e605d | 457 | ///\r |
458 | /// Logout Request\r | |
459 | ///\r | |
6a690e23 | 460 | typedef struct _ISCSI_LOGOUT_REQUEST {\r |
461 | UINT8 OpCode;\r | |
462 | UINT8 ReasonCode;\r | |
463 | UINT16 Reserved1;\r | |
464 | UINT8 TotalAHSLength;\r | |
465 | UINT8 DataSegmentLength[3];\r | |
466 | UINT32 Reserved2[2];\r | |
467 | UINT32 InitiatorTaskTag;\r | |
a78d176c | 468 | UINT16 Cid;\r |
6a690e23 | 469 | UINT16 Reserved3;\r |
470 | UINT32 CmdSN;\r | |
471 | UINT32 ExpStatSN;\r | |
472 | UINT32 Reserved4[4];\r | |
473 | } ISCSI_LOGOUT_REQUEST;\r | |
474 | \r | |
475 | #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0\r | |
476 | #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1\r | |
477 | #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2\r | |
478 | #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3\r | |
479 | \r | |
db3e605d | 480 | ///\r |
481 | /// Logout Response\r | |
482 | ///\r | |
6a690e23 | 483 | typedef struct _ISCSI_LOGOUT_RESPONSE {\r |
484 | UINT8 OpCode;\r | |
485 | UINT8 Reserved1;\r | |
486 | UINT8 Response;\r | |
487 | UINT8 Reserved2;\r | |
488 | UINT8 TotalAHSLength;\r | |
489 | UINT8 DataSegmentLength[3];\r | |
490 | UINT32 Reserved3[2];\r | |
491 | UINT32 InitiatorTaskTag;\r | |
492 | UINT32 Reserved4;\r | |
493 | UINT32 StatSN;\r | |
494 | UINT32 ExpCmdSN;\r | |
495 | UINT32 MaxCmdSN;\r | |
496 | UINT32 Reserved5;\r | |
497 | UINT16 Time2Wait;\r | |
498 | UINT16 Time2Retain;\r | |
499 | UINT32 Reserved6;\r | |
500 | } ISCSI_LOGOUT_RESPONSE;\r | |
501 | \r | |
502 | #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0\r | |
503 | #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1\r | |
504 | #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2\r | |
505 | #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3\r | |
506 | \r | |
db3e605d | 507 | ///\r |
508 | /// SNACK Request\r | |
509 | ///\r | |
6a690e23 | 510 | typedef struct _ISCSI_SNACK_REQUEST {\r |
511 | UINT8 OpCode;\r | |
512 | UINT8 Type;\r | |
513 | UINT16 Reserved1;\r | |
514 | UINT8 TotalAHSLength;\r | |
515 | UINT8 DataSegmentLength[3];\r | |
516 | UINT8 Lun[8];\r | |
517 | UINT32 InitiatorTaskTag;\r | |
518 | UINT32 TargetTransferTag;\r | |
519 | UINT32 Reserved2;\r | |
520 | UINT32 ExpStatSN;\r | |
521 | UINT32 Reserved[2];\r | |
522 | UINT32 BegRun;\r | |
523 | UINT32 RunLength;\r | |
524 | } ISCSI_SNACK_REQUEST;\r | |
525 | \r | |
db3e605d | 526 | ///\r |
527 | /// Reject\r | |
528 | ///\r | |
6a690e23 | 529 | typedef struct _ISCSI_REJECT {\r |
530 | UINT8 OpCode;\r | |
531 | UINT8 Reserved1;\r | |
532 | UINT8 Reason;\r | |
533 | UINT8 Reserved2;\r | |
534 | UINT8 TotalAHSLength;\r | |
535 | UINT8 DataSegmentLength[3];\r | |
536 | UINT32 Reserved3[2];\r | |
537 | UINT32 InitiatorTaskTag;\r | |
538 | UINT32 Reserved4;\r | |
539 | UINT32 StatSN;\r | |
540 | UINT32 ExpCmdSN;\r | |
541 | UINT32 MaxCmdSN;\r | |
542 | UINT32 DataSN;\r | |
543 | UINT32 Reserved5[2];\r | |
544 | } ISCSI_REJECT;\r | |
545 | \r | |
db3e605d | 546 | ///\r |
547 | /// NOP-Out\r | |
548 | ///\r | |
6a690e23 | 549 | typedef struct _ISCSI_NOP_OUT {\r |
550 | UINT8 OpCode;\r | |
551 | UINT8 Reserved1[3];\r | |
552 | UINT8 TotalAHSLength;\r | |
553 | UINT8 DataSegmentLength[3];\r | |
554 | UINT8 Lun[8];\r | |
555 | UINT32 InitiatorTaskTag;\r | |
556 | UINT32 TargetTransferTag;\r | |
557 | UINT32 CmdSN;\r | |
558 | UINT32 ExpStatSN;\r | |
559 | UINT32 Reserved2[4];\r | |
560 | } ISCSI_NOP_OUT;\r | |
561 | \r | |
db3e605d | 562 | ///\r |
563 | /// NOP-In\r | |
564 | ///\r | |
6a690e23 | 565 | typedef struct _ISCSI_NOP_IN {\r |
566 | UINT8 OpCode;\r | |
567 | UINT8 Reserved1[3];\r | |
568 | UINT8 TotalAHSLength;\r | |
569 | UINT8 DataSegmentLength[3];\r | |
570 | UINT8 Lun[8];\r | |
571 | UINT32 InitiatorTaskTag;\r | |
572 | UINT32 TargetTransferTag;\r | |
573 | UINT32 StatSN;\r | |
574 | UINT32 ExpCmdSN;\r | |
575 | UINT32 MaxCmdSN;\r | |
576 | UINT32 Reserved2[3];\r | |
577 | } ISCSI_NOP_IN;\r | |
578 | \r | |
579 | #define ISCSI_SECURITY_NEGOTIATION 0\r | |
580 | #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1\r | |
581 | #define ISCSI_FULL_FEATURE_PHASE 3\r | |
582 | \r | |
583 | typedef enum {\r | |
f6b7393c | 584 | IScsiDigestNone,\r |
585 | IScsiDigestCRC32\r | |
6a690e23 | 586 | } ISCSI_DIGEST_TYPE;\r |
587 | \r | |
588 | typedef struct _ISCSI_XFER_CONTEXT {\r | |
589 | UINT32 TargetTransferTag;\r | |
590 | UINT32 Offset;\r | |
591 | UINT32 DesiredLength;\r | |
592 | UINT32 ExpDataSN;\r | |
593 | } ISCSI_XFER_CONTEXT;\r | |
594 | \r | |
595 | typedef struct _ISCSI_IN_BUFFER_CONTEXT {\r | |
596 | UINT8 *InData;\r | |
597 | UINT32 InDataLen;\r | |
598 | } ISCSI_IN_BUFFER_CONTEXT;\r | |
599 | \r | |
600 | typedef struct _ISCSI_TCB {\r | |
e48e37fc | 601 | LIST_ENTRY Link;\r |
6a690e23 | 602 | \r |
603 | BOOLEAN SoFarInOrder;\r | |
604 | UINT32 ExpDataSN;\r | |
605 | BOOLEAN FbitReceived;\r | |
606 | BOOLEAN StatusXferd;\r | |
607 | UINT32 ActiveR2Ts;\r | |
608 | UINT32 Response;\r | |
609 | CHAR8 *Reason;\r | |
610 | UINT32 InitiatorTaskTag;\r | |
611 | UINT32 CmdSN;\r | |
612 | UINT32 SNACKTag;\r | |
613 | \r | |
614 | ISCSI_XFER_CONTEXT XferContext;\r | |
615 | \r | |
616 | ISCSI_CONNECTION *Conn;\r | |
617 | } ISCSI_TCB;\r | |
618 | \r | |
619 | typedef struct _ISCSI_KEY_VALUE_PAIR {\r | |
e48e37fc | 620 | LIST_ENTRY List;\r |
6a690e23 | 621 | \r |
622 | CHAR8 *Key;\r | |
623 | CHAR8 *Value;\r | |
624 | } ISCSI_KEY_VALUE_PAIR;\r | |
625 | \r | |
12618416 | 626 | /**\r |
d1102dba | 627 | Attach the iSCSI connection to the iSCSI session.\r |
12618416 | 628 | \r |
c5de0d55 | 629 | @param[in, out] Session The iSCSI session.\r |
630 | @param[in, out] Conn The iSCSI connection.\r | |
12618416 | 631 | **/\r |
6a690e23 | 632 | VOID\r |
633 | IScsiAttatchConnection (\r | |
c5de0d55 | 634 | IN OUT ISCSI_SESSION *Session,\r |
635 | IN OUT ISCSI_CONNECTION *Conn\r | |
6a690e23 | 636 | );\r |
637 | \r | |
12618416 | 638 | /**\r |
d1102dba | 639 | Detach the iSCSI connection from the session it belongs to.\r |
12618416 | 640 | \r |
c5de0d55 | 641 | @param[in, out] Conn The iSCSI connection.\r |
12618416 | 642 | **/\r |
6a690e23 | 643 | VOID\r |
644 | IScsiDetatchConnection (\r | |
c5de0d55 | 645 | IN OUT ISCSI_CONNECTION *Conn\r |
6a690e23 | 646 | );\r |
647 | \r | |
12618416 | 648 | /**\r |
649 | This function does the iSCSI connection login.\r | |
650 | \r | |
c5de0d55 | 651 | @param[in, out] Conn The iSCSI connection to login.\r |
12618416 | 652 | \r |
653 | @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.\r | |
12618416 | 654 | @retval EFI_TIMEOUT Timeout happened during the login procedure.\r |
d1102dba | 655 | @retval Others Other errors as indicated.\r |
12618416 | 656 | **/\r |
6a690e23 | 657 | EFI_STATUS\r |
658 | IScsiConnLogin (\r | |
c5de0d55 | 659 | IN OUT ISCSI_CONNECTION *Conn\r |
6a690e23 | 660 | );\r |
661 | \r | |
12618416 | 662 | /**\r |
663 | Create a TCP connection for the iSCSI session.\r | |
664 | \r | |
db3e605d | 665 | @param[in] Private The iSCSI driver data.\r |
666 | @param[in] Session Maximum CmdSN from the target.\r | |
12618416 | 667 | \r |
db3e605d | 668 | @return The newly created iSCSI connection.\r |
12618416 | 669 | **/\r |
db3e605d | 670 | ISCSI_CONNECTION *\r |
6a690e23 | 671 | IScsiCreateConnection (\r |
672 | IN ISCSI_DRIVER_DATA *Private,\r | |
673 | IN ISCSI_SESSION *Session\r | |
674 | );\r | |
675 | \r | |
12618416 | 676 | /**\r |
677 | Destroy an iSCSI connection.\r | |
678 | \r | |
db3e605d | 679 | @param[in] Conn The connection to destroy.\r |
12618416 | 680 | **/\r |
6a690e23 | 681 | VOID\r |
682 | IScsiDestroyConnection (\r | |
683 | IN ISCSI_CONNECTION *Conn\r | |
684 | );\r | |
685 | \r | |
12618416 | 686 | /**\r |
687 | Login the iSCSI session.\r | |
688 | \r | |
db3e605d | 689 | @param[in] Private The iSCSI driver data.\r |
12618416 | 690 | \r |
691 | @retval EFI_SUCCESS The iSCSI session login procedure finished.\r | |
12618416 | 692 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r |
dd29f3ed | 693 | @retval EFI_NO_MEDIA There was a media error.\r |
963dbb30 | 694 | @retval Others Other errors as indicated.\r |
dd29f3ed | 695 | \r |
12618416 | 696 | **/\r |
6a690e23 | 697 | EFI_STATUS\r |
698 | IScsiSessionLogin (\r | |
699 | IN ISCSI_DRIVER_DATA *Private\r | |
700 | );\r | |
701 | \r | |
12618416 | 702 | /**\r |
703 | Build and send the iSCSI login request to the iSCSI target according to\r | |
704 | the current login stage.\r | |
705 | \r | |
db3e605d | 706 | @param[in] Conn The connection in the iSCSI login phase.\r |
12618416 | 707 | \r |
708 | @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this\r | |
709 | connection.\r | |
12618416 | 710 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r |
db3e605d | 711 | @retval EFI_DEVICE_ERROR Some kind of device error happened.\r |
12618416 | 712 | **/\r |
6a690e23 | 713 | EFI_STATUS\r |
714 | IScsiSendLoginReq (\r | |
715 | IN ISCSI_CONNECTION *Conn\r | |
716 | );\r | |
717 | \r | |
12618416 | 718 | /**\r |
719 | Receive and process the iSCSI login response.\r | |
720 | \r | |
db3e605d | 721 | @param[in] Conn The connection in the iSCSI login phase.\r |
d1102dba | 722 | \r |
12618416 | 723 | @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.\r |
963dbb30 | 724 | @retval Others Other errors as indicated.\r |
12618416 | 725 | **/\r |
6a690e23 | 726 | EFI_STATUS\r |
727 | IScsiReceiveLoginRsp (\r | |
728 | IN ISCSI_CONNECTION *Conn\r | |
729 | );\r | |
730 | \r | |
12618416 | 731 | /**\r |
732 | Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.\r | |
733 | The DataSegmentLength and the actual size of the net buffer containing this PDU will be\r | |
734 | updated.\r | |
735 | \r | |
c5de0d55 | 736 | @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will\r |
12618416 | 737 | be added to.\r |
c5de0d55 | 738 | @param[in] Key The key name string.\r |
739 | @param[in] Value The value string.\r | |
12618416 | 740 | \r |
741 | @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and\r | |
742 | the correspondence length fields are updated.\r | |
12618416 | 743 | @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value\r |
744 | pair.\r | |
12618416 | 745 | **/\r |
6a690e23 | 746 | EFI_STATUS\r |
747 | IScsiAddKeyValuePair (\r | |
c5de0d55 | 748 | IN OUT NET_BUF *Pdu,\r |
6a690e23 | 749 | IN CHAR8 *Key,\r |
750 | IN CHAR8 *Value\r | |
751 | );\r | |
752 | \r | |
12618416 | 753 | /**\r |
754 | Prepare the iSCSI login request to be sent according to the current login status.\r | |
755 | \r | |
c5de0d55 | 756 | @param[in, out] Conn The connection in the iSCSI login phase.\r |
12618416 | 757 | \r |
db3e605d | 758 | @return The pointer to the net buffer containing the iSCSI login request built.\r |
963dbb30 | 759 | @retval Others Other errors as indicated.\r |
12618416 | 760 | **/\r |
761 | NET_BUF *\r | |
6a690e23 | 762 | IScsiPrepareLoginReq (\r |
c5de0d55 | 763 | IN OUT ISCSI_CONNECTION *Conn\r |
6a690e23 | 764 | );\r |
765 | \r | |
12618416 | 766 | /**\r |
767 | Process the iSCSI Login Response.\r | |
768 | \r | |
c5de0d55 | 769 | @param[in, out] Conn The connection on which the iSCSI login response is received.\r |
770 | @param[in, out] Pdu The iSCSI login response PDU.\r | |
12618416 | 771 | \r |
772 | @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.\r | |
12618416 | 773 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r |
db3e605d | 774 | @retval EFI_MEDIA_CHANGED Target is redirected.\r |
963dbb30 | 775 | @retval Others Other errors as indicated.\r |
12618416 | 776 | **/\r |
6a690e23 | 777 | EFI_STATUS\r |
778 | IScsiProcessLoginRsp (\r | |
c5de0d55 | 779 | IN OUT ISCSI_CONNECTION *Conn,\r |
780 | IN OUT NET_BUF *Pdu\r | |
6a690e23 | 781 | );\r |
782 | \r | |
12618416 | 783 | /**\r |
784 | Updated the target information according the data received in the iSCSI\r | |
785 | login response with an target redirection status.\r | |
786 | \r | |
c5de0d55 | 787 | @param[in, out] Session The iSCSI session.\r |
788 | @param[in] Data The data segment which should contain the\r | |
789 | TargetAddress key-value list.\r | |
790 | @param[in] Len Length of the data.\r | |
d1102dba | 791 | \r |
12618416 | 792 | @retval EFI_SUCCESS The target address is updated.\r |
12618416 | 793 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r |
12618416 | 794 | @retval EFI_NOT_FOUND The TargetAddress key is not found.\r |
963dbb30 | 795 | @retval Others Other errors as indicated.\r |
12618416 | 796 | **/\r |
6a690e23 | 797 | EFI_STATUS\r |
798 | IScsiUpdateTargetAddress (\r | |
c5de0d55 | 799 | IN OUT ISCSI_SESSION *Session,\r |
800 | IN CHAR8 *Data,\r | |
801 | IN UINT32 Len\r | |
6a690e23 | 802 | );\r |
803 | \r | |
12618416 | 804 | /**\r |
805 | The callback function to free the net buffer list.\r | |
806 | \r | |
db3e605d | 807 | @param[in] Arg The opaque parameter.\r |
12618416 | 808 | **/\r |
6a690e23 | 809 | VOID\r |
e798cd87 | 810 | EFIAPI\r |
6a690e23 | 811 | IScsiFreeNbufList (\r |
812 | VOID *Arg\r | |
813 | );\r | |
814 | \r | |
12618416 | 815 | /**\r |
816 | Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and\r | |
817 | an optional data segment. The two parts will be put into two blocks of buffers in the\r | |
818 | net buffer. The digest check will be conducted in this function if needed and the digests\r | |
819 | will be trimmed from the PDU buffer.\r | |
820 | \r | |
db3e605d | 821 | @param[in] Conn The iSCSI connection to receive data from.\r |
822 | @param[out] Pdu The received iSCSI pdu.\r | |
823 | @param[in] Context The context used to describe information on the caller provided\r | |
12618416 | 824 | buffer to receive data segment of the iSCSI pdu, it's optional.\r |
db3e605d | 825 | @param[in] HeaderDigest Whether there will be header digest received.\r |
826 | @param[in] DataDigest Whether there will be data digest.\r | |
827 | @param[in] TimeoutEvent The timeout event, it's optional.\r | |
12618416 | 828 | \r |
db3e605d | 829 | @retval EFI_SUCCESS An iSCSI pdu is received.\r |
830 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
831 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r | |
963dbb30 | 832 | @retval Others Other errors as indicated.\r |
12618416 | 833 | **/\r |
6a690e23 | 834 | EFI_STATUS\r |
835 | IScsiReceivePdu (\r | |
836 | IN ISCSI_CONNECTION *Conn,\r | |
837 | OUT NET_BUF **Pdu,\r | |
838 | IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL\r | |
839 | IN BOOLEAN HeaderDigest,\r | |
840 | IN BOOLEAN DataDigest,\r | |
841 | IN EFI_EVENT TimeoutEvent OPTIONAL\r | |
842 | );\r | |
843 | \r | |
12618416 | 844 | /**\r |
845 | Check and get the result of the prameter negotiation.\r | |
846 | \r | |
c5de0d55 | 847 | @param[in, out] Conn The connection in iSCSI login.\r |
12618416 | 848 | \r |
db3e605d | 849 | @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.\r |
850 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r | |
851 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
12618416 | 852 | **/\r |
6a690e23 | 853 | EFI_STATUS\r |
854 | IScsiCheckOpParams (\r | |
c5de0d55 | 855 | IN OUT ISCSI_CONNECTION *Conn\r |
6a690e23 | 856 | );\r |
857 | \r | |
12618416 | 858 | /**\r |
859 | Fill the oprational prameters.\r | |
860 | \r | |
c5de0d55 | 861 | @param[in] Conn The connection in iSCSI login.\r |
862 | @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.\r | |
12618416 | 863 | \r |
864 | @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.\r | |
12618416 | 865 | **/\r |
6a690e23 | 866 | EFI_STATUS\r |
867 | IScsiFillOpParams (\r | |
868 | IN ISCSI_CONNECTION *Conn,\r | |
c5de0d55 | 869 | IN OUT NET_BUF *Pdu\r |
6a690e23 | 870 | );\r |
871 | \r | |
12618416 | 872 | /**\r |
873 | Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r | |
874 | \r | |
c5de0d55 | 875 | @param[in, out] Pdu The iSCSI pdu which contains segments to pad.\r |
876 | @param[in] Len The length of the last semgnet in the PDU.\r | |
12618416 | 877 | \r |
878 | @retval EFI_SUCCESS The segment is padded or no need to pad it.\r | |
12618416 | 879 | @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the\r |
880 | padding bytes.\r | |
12618416 | 881 | **/\r |
6a690e23 | 882 | EFI_STATUS\r |
883 | IScsiPadSegment (\r | |
c5de0d55 | 884 | IN OUT NET_BUF *Pdu,\r |
885 | IN UINT32 Len\r | |
6a690e23 | 886 | );\r |
887 | \r | |
12618416 | 888 | /**\r |
889 | Build a key-value list from the data segment.\r | |
890 | \r | |
db3e605d | 891 | @param[in] Data The data segment containing the key-value pairs.\r |
892 | @param[in] Len Length of the data segment.\r | |
12618416 | 893 | \r |
db3e605d | 894 | @return The key-value list.\r |
963dbb30 | 895 | @retval NULL Other errors as indicated.\r |
12618416 | 896 | **/\r |
897 | LIST_ENTRY *\r | |
6a690e23 | 898 | IScsiBuildKeyValueList (\r |
899 | IN CHAR8 *Data,\r | |
900 | IN UINT32 Len\r | |
901 | );\r | |
902 | \r | |
12618416 | 903 | /**\r |
904 | Get the value string by the key name from the key-value list. If found,\r | |
905 | the key-value entry will be removed from the list.\r | |
906 | \r | |
c5de0d55 | 907 | @param[in, out] KeyValueList The key-value list.\r |
908 | @param[in] Key The key name to find.\r | |
12618416 | 909 | \r |
db3e605d | 910 | @return The value string.\r |
12618416 | 911 | **/\r |
912 | CHAR8 *\r | |
6a690e23 | 913 | IScsiGetValueByKeyFromList (\r |
c5de0d55 | 914 | IN OUT LIST_ENTRY *KeyValueList,\r |
6a690e23 | 915 | IN CHAR8 *Key\r |
916 | );\r | |
917 | \r | |
12618416 | 918 | /**\r |
919 | Free the key-value list.\r | |
920 | \r | |
db3e605d | 921 | @param[in] KeyValueList The key-value list.\r |
12618416 | 922 | **/\r |
6a690e23 | 923 | VOID\r |
924 | IScsiFreeKeyValueList (\r | |
e48e37fc | 925 | IN LIST_ENTRY *KeyValueList\r |
6a690e23 | 926 | );\r |
927 | \r | |
12618416 | 928 | /**\r |
929 | Normalize the iSCSI name according to RFC.\r | |
930 | \r | |
c5de0d55 | 931 | @param[in, out] Name The iSCSI name.\r |
932 | @param[in] Len length of the iSCSI name.\r | |
12618416 | 933 | \r |
934 | @retval EFI_SUCCESS The iSCSI name is valid and normalized.\r | |
12618416 | 935 | @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.\r |
12618416 | 936 | **/\r |
6a690e23 | 937 | EFI_STATUS\r |
938 | IScsiNormalizeName (\r | |
c5de0d55 | 939 | IN OUT CHAR8 *Name,\r |
940 | IN UINTN Len\r | |
6a690e23 | 941 | );\r |
942 | \r | |
12618416 | 943 | /**\r |
944 | Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.\r | |
945 | \r | |
db3e605d | 946 | @param[in] PassThru The EXT SCSI PASS THRU protocol.\r |
947 | @param[in] Target The target ID.\r | |
948 | @param[in] Lun The LUN.\r | |
949 | @param[in, out] Packet The request packet containing IO request, SCSI command\r | |
950 | buffer and buffers to read/write.\r | |
d1102dba LG |
951 | \r |
952 | @retval EFI_SUCCES The SCSI command is executed and the result is updated to\r | |
db3e605d | 953 | the Packet.\r |
c5de0d55 | 954 | @retval EFI_DEVICE_ERROR Session state was not as required.\r |
db3e605d | 955 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r |
f20fc992 | 956 | @retval EFI_NOT_READY The target can not accept new commands.\r |
963dbb30 | 957 | @retval Others Other errors as indicated.\r |
12618416 | 958 | **/\r |
6a690e23 | 959 | EFI_STATUS\r |
960 | IScsiExecuteScsiCommand (\r | |
961 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,\r | |
962 | IN UINT8 *Target,\r | |
963 | IN UINT64 Lun,\r | |
964 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r | |
965 | );\r | |
966 | \r | |
12618416 | 967 | /**\r |
968 | Reinstate the session on some error.\r | |
969 | \r | |
c5de0d55 | 970 | @param[in, out] Private The iSCSI driver data.\r |
12618416 | 971 | \r |
972 | @retval EFI_SUCCES The session is reinstated from some error.\r | |
db3e605d | 973 | @retval Other Reinstatement failed.\r |
12618416 | 974 | **/\r |
6a690e23 | 975 | EFI_STATUS\r |
976 | IScsiSessionReinstatement (\r | |
c5de0d55 | 977 | IN OUT ISCSI_DRIVER_DATA *Private\r |
6a690e23 | 978 | );\r |
979 | \r | |
12618416 | 980 | /**\r |
981 | Initialize some session parameters before login.\r | |
982 | \r | |
963dbb30 | 983 | @param[in, out] Session The iSCSI session.\r |
984 | @param[in] Recovery Whether the request is from a fresh new start or recovery.\r | |
12618416 | 985 | **/\r |
6a690e23 | 986 | VOID\r |
987 | IScsiSessionInit (\r | |
963dbb30 | 988 | IN OUT ISCSI_SESSION *Session,\r |
989 | IN BOOLEAN Recovery\r | |
6a690e23 | 990 | );\r |
d1102dba | 991 | \r |
12618416 | 992 | /**\r |
993 | Abort the iSCSI session, that is, reset all the connection and free the\r | |
994 | resources.\r | |
995 | \r | |
c5de0d55 | 996 | @param[in, out] Session The iSCSI session.\r |
12618416 | 997 | \r |
998 | @retval EFI_SUCCES The session is aborted.\r | |
12618416 | 999 | **/\r |
6a690e23 | 1000 | EFI_STATUS\r |
1001 | IScsiSessionAbort (\r | |
c5de0d55 | 1002 | IN OUT ISCSI_SESSION *Session\r |
6a690e23 | 1003 | );\r |
1004 | \r | |
1005 | #endif\r |