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