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