2 The header file of iSCSI Protocol that defines many specific data structures.
4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _ISCSI_PROTO_H_
10 #define _ISCSI_PROTO_H_
13 // RFC 1982 Serial Number Arithmetic, SERIAL_BITS = 32
15 #define ISCSI_SEQ_EQ(s1, s2) ((s1) == (s2))
16 #define ISCSI_SEQ_LT(s1, s2) \
18 (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) < ((UINT32) 1 << 31)) || \
19 (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) > ((UINT32) 1 << 31)) \
21 #define ISCSI_SEQ_GT(s1, s2) \
23 (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) > ((UINT32) 1 << 31)) || \
24 (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) < ((UINT32) 1 << 31)) \
27 #define ISCSI_WELL_KNOWN_PORT 3260
28 #define ISCSI_MAX_CONNS_PER_SESSION 1
30 #define DEFAULT_MAX_RECV_DATA_SEG_LEN 8192
31 #define MAX_RECV_DATA_SEG_LEN_IN_FFP 65536
32 #define DEFAULT_MAX_OUTSTANDING_R2T 1
34 #define ISCSI_VERSION_MAX 0x00
35 #define ISCSI_VERSION_MIN 0x00
37 #define ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)
38 #define ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)
40 #define ISCSI_REDIRECT_ADDR_START_DELIMITER '['
41 #define ISCSI_REDIRECT_ADDR_END_DELIMITER ']'
43 #define ISCSI_KEY_AUTH_METHOD "AuthMethod"
44 #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"
45 #define ISCSI_KEY_DATA_DIGEST "DataDigest"
46 #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"
47 #define ISCSI_KEY_TARGET_NAME "TargetName"
48 #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"
49 #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"
50 #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"
51 #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"
52 #define ISCSI_KEY_INITIAL_R2T "InitialR2T"
53 #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"
54 #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"
55 #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"
56 #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"
57 #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"
58 #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"
59 #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"
60 #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"
61 #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"
62 #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"
63 #define ISCSI_KEY_SESSION_TYPE "SessionType"
64 #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"
66 #define ISCSI_KEY_VALUE_NONE "None"
69 /// connection state for initiator
72 #define CONN_STATE_FREE 0
73 #define CONN_STATE_XPT_WAIT 1
74 #define CONN_STATE_IN_LOGIN 2
75 #define CONN_STATE_LOGGED_IN 3
76 #define CONN_STATE_IN_LOGOUT 4
77 #define CONN_STATE_LOGOUT_REQUESTED 5
78 #define CONN_STATE_CLEANUP_WAIT 6
79 #define CONN_STATE_IN_CLEANUP 7
82 /// session state for initiator
84 #define SESSION_STATE_FREE 0
85 #define SESSION_STATE_LOGGED_IN 1
86 #define SESSION_STATE_FAILED 2
88 #define ISCSI_RESERVED_TAG 0xffffffff
90 #define ISCSI_REQ_IMMEDIATE 0x40
91 #define ISCSI_OPCODE_MASK 0x3F
93 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
94 #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
95 #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
96 #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
97 #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
98 #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
99 #define ISCSI_FLAG_ON(PduHdr, Flag) ((BOOLEAN) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag)))
100 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
101 #define ISCSI_GET_CURRENT_STAGE(PduHdr) ((UINT8) (((PduHdr)->Flags >> 2) & 0x3))
102 #define ISCSI_GET_NEXT_STAGE(PduHdr) ((UINT8) (((PduHdr)->Flags) & 0x3))
104 #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)
105 #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))
107 #define HTON24(Dst, Src) \
109 (Dst)[0] = (UINT8) ((UINT8) ((Src) >> 16) & 0xFF); \
110 (Dst)[1] = (UINT8) ((UINT8) ((Src) >> 8) & 0xFF); \
111 (Dst)[2] = (UINT8) ((UINT8) (Src) & 0xFF); \
114 #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
116 #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
117 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
118 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
121 // Initiator opcodes.
123 #define ISCSI_OPCODE_NOP_OUT 0x00
124 #define ISCSI_OPCODE_SCSI_CMD 0x01
125 #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02
126 #define ISCSI_OPCODE_LOGIN_REQ 0x03
127 #define ISCSI_OPCODE_TEXT_REQ 0x04
128 #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05
129 #define ISCSI_OPCODE_LOGOUT_REQ 0x06
130 #define ISCSI_OPCODE_SNACK_REQ 0x10
131 #define ISCSI_OPCODE_VENDOR_I0 0x1c
132 #define ISCSI_OPCODE_VENDOR_I1 0x1d
133 #define ISCSI_OPCODE_VENDOR_I2 0x1e
138 #define ISCSI_OPCODE_NOP_IN 0x20
139 #define ISCSI_OPCODE_SCSI_RSP 0x21
140 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
141 #define ISCSI_OPCODE_LOGIN_RSP 0x23
142 #define ISCSI_OPCODE_TEXT_RSP 0x24
143 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
144 #define ISCSI_OPCODE_LOGOUT_RSP 0x26
145 #define ISCSI_OPCODE_R2T 0x31
146 #define ISCSI_OPCODE_ASYNC_MSG 0x32
147 #define ISCSI_OPCODE_VENDOR_T0 0x3c
148 #define ISCSI_OPCODE_VENDOR_T1 0x3d
149 #define ISCSI_OPCODE_VENDOR_T2 0x3e
150 #define ISCSI_OPCODE_REJECT 0x3f
152 #define ISCSI_BHS_FLAG_FINAL 0x80
155 // Defined AHS types, others are reserved.
157 #define ISCSI_AHS_TYPE_EXT_CDB 0x1
158 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
160 #define SCSI_CMD_PDU_FLAG_READ 0x40
161 #define SCSI_CMD_PDU_FLAG_WRITE 0x20
163 #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07
168 #define ISCSI_TASK_ATTR_UNTAGGED 0x00
169 #define ISCSI_TASK_ATTR_SIMPLE 0x01
170 #define ISCSI_TASK_ATTR_ORDERD 0x02
171 #define ISCSI_TASK_ATTR_HOQ 0x03
172 #define ISCSI_TASK_ATTR_ACA 0x04
175 // Flag bit definitions in SCSI response.
177 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10
178 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
179 #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04
180 #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02
183 // iSCSI service response codes.
185 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00
186 #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01
188 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0
189 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1
190 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2
191 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3
192 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
193 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5
194 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6
195 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255
197 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40
198 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW
199 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW
200 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01
202 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80
203 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
205 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
206 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
208 #define ISCSI_LOGIN_STATUS_SUCCESS 0
209 #define ISCSI_LOGIN_STATUS_REDIRECTION 1
210 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2
211 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3
213 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
214 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
215 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2
217 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0
218 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1
219 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2
220 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3
222 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0
223 #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1
224 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2
225 #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3
227 #define ISCSI_SECURITY_NEGOTIATION 0
228 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
229 #define ISCSI_FULL_FEATURE_PHASE 3
231 typedef struct _ISCSI_SESSION ISCSI_SESSION
;
232 typedef struct _ISCSI_CONNECTION ISCSI_CONNECTION
;
241 /// iSCSI Basic Header Segment
243 typedef struct _ISCSI_BASIC_HEADER
{
246 UINT16 OpCodeSpecific1
;
247 UINT8 TotalAHSLength
;
248 UINT8 DataSegmentLength
[3];
250 UINT32 InitiatorTaskTag
;
251 UINT32 OpCodeSpecific2
[7];
252 } ISCSI_BASIC_HEADER
;
254 typedef struct _ISCSI_ADDTIONAL_HEADER
{
257 UINT8 TypeSpecific
[1];
258 } ISCSI_ADDITIONAL_HEADER
;
260 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS
{
264 UINT32 ExpReadDataLength
;
265 } ISCSI_BI_EXP_READ_DATA_LEN_AHS
;
270 typedef struct _SCSI_COMMAND
{
274 UINT8 TotalAHSLength
;
275 UINT8 DataSegmentLength
[3];
277 UINT32 InitiatorTaskTag
;
278 UINT32 ExpDataXferLength
;
287 typedef struct _SCSI_RESPONSE
{
292 UINT8 TotalAHSLength
;
293 UINT8 DataSegmentLength
[3];
295 UINT32 InitiatorTaskTag
;
301 UINT32 BiReadResidualCount
;
302 UINT32 ResidualCount
;
305 typedef struct _ISCSI_SENSE_DATA
{
311 /// iSCSI Task Managment Function Request.
313 typedef struct _ISCSI_TMF_REQUEST
{
317 UINT8 TotalAHSLength
;
318 UINT8 DataSegmentLength
[3];
320 UINT32 InitiatorTaskTag
;
321 UINT32 ReferencedTaskTag
;
330 /// iSCSI Task Management Function Response.
332 typedef struct _ISCSI_TMF_RESPONSE
{
337 UINT8 TotalAHSLength
;
338 UINT8 DataSegmentLength
[3];
340 UINT32 InitiatorTaskTag
;
346 } ISCSI_TMF_RESPONSE
;
351 typedef struct _ISCSI_SCSI_DATA_OUT
{
354 UINT8 TotalAHSLength
;
355 UINT8 DataSegmentLength
[3];
357 UINT32 InitiatorTaskTag
;
358 UINT32 TargetTransferTag
;
365 } ISCSI_SCSI_DATA_OUT
;
370 typedef struct _ISCSI_SCSI_DATA_IN
{
375 UINT8 TotalAHSLength
;
376 UINT8 DataSegmentLength
[3];
378 UINT32 InitiatorTaskTag
;
379 UINT32 TargetTransferTag
;
385 UINT32 ResidualCount
;
386 } ISCSI_SCSI_DATA_IN
;
389 /// Ready To Transfer.
391 typedef struct _ISCSI_READY_TO_TRANSFER
{
394 UINT8 TotalAHSLength
;
395 UINT8 DataSegmentLength
[3];
397 UINT32 InitiatorTaskTag
;
398 UINT32 TargetTransferTag
;
404 UINT32 DesiredDataTransferLength
;
405 } ISCSI_READY_TO_TRANSFER
;
407 typedef struct _ISCSI_ASYNC_MESSAGE
{
410 UINT8 TotalAHSLength
;
411 UINT8 DataSegmentLength
[3];
413 UINT32 InitiatorTaskTag
;
424 } ISCSI_ASYNC_MESSAGE
;
429 typedef struct _ISCSI_LOGIN_REQUEST
{
434 UINT8 TotalAHSLength
;
435 UINT8 DataSegmentLength
[3];
438 UINT32 InitiatorTaskTag
;
444 } ISCSI_LOGIN_REQUEST
;
449 typedef struct _ISCSI_LOGIN_RESPONSE
{
454 UINT8 TotalAHSLength
;
455 UINT8 DataSegmentLength
[3];
458 UINT32 InitiatorTaskTag
;
466 } ISCSI_LOGIN_RESPONSE
;
471 typedef struct _ISCSI_LOGOUT_REQUEST
{
475 UINT8 TotalAHSLength
;
476 UINT8 DataSegmentLength
[3];
478 UINT32 InitiatorTaskTag
;
484 } ISCSI_LOGOUT_REQUEST
;
489 typedef struct _ISCSI_LOGOUT_RESPONSE
{
494 UINT8 TotalAHSLength
;
495 UINT8 DataSegmentLength
[3];
497 UINT32 InitiatorTaskTag
;
506 } ISCSI_LOGOUT_RESPONSE
;
511 typedef struct _ISCSI_SNACK_REQUEST
{
515 UINT8 TotalAHSLength
;
516 UINT8 DataSegmentLength
[3];
518 UINT32 InitiatorTaskTag
;
519 UINT32 TargetTransferTag
;
525 } ISCSI_SNACK_REQUEST
;
530 typedef struct _ISCSI_REJECT
{
535 UINT8 TotalAHSLength
;
536 UINT8 DataSegmentLength
[3];
538 UINT32 InitiatorTaskTag
;
550 typedef struct _ISCSI_NOP_OUT
{
553 UINT8 TotalAHSLength
;
554 UINT8 DataSegmentLength
[3];
556 UINT32 InitiatorTaskTag
;
557 UINT32 TargetTransferTag
;
566 typedef struct _ISCSI_NOP_IN
{
569 UINT8 TotalAHSLength
;
570 UINT8 DataSegmentLength
[3];
572 UINT32 InitiatorTaskTag
;
573 UINT32 TargetTransferTag
;
585 typedef struct _ISCSI_XFER_CONTEXT
{
586 UINT32 TargetTransferTag
;
588 UINT32 DesiredLength
;
590 } ISCSI_XFER_CONTEXT
;
592 typedef struct _ISCSI_IN_BUFFER_CONTEXT
{
595 } ISCSI_IN_BUFFER_CONTEXT
;
597 typedef struct _ISCSI_TCB
{
600 BOOLEAN SoFarInOrder
;
602 BOOLEAN FbitReceived
;
607 UINT32 InitiatorTaskTag
;
611 ISCSI_XFER_CONTEXT XferContext
;
613 ISCSI_CONNECTION
*Conn
;
616 typedef struct _ISCSI_KEY_VALUE_PAIR
{
621 } ISCSI_KEY_VALUE_PAIR
;
624 Attach the iSCSI connection to the iSCSI session.
626 @param[in, out] Session The iSCSI session.
627 @param[in, out] Conn The iSCSI connection.
631 IScsiAttatchConnection (
632 IN OUT ISCSI_SESSION
*Session
,
633 IN OUT ISCSI_CONNECTION
*Conn
637 Detach the iSCSI connection from the session it belongs to.
639 @param[in, out] Conn The iSCSI connection.
643 IScsiDetatchConnection (
644 IN OUT ISCSI_CONNECTION
*Conn
648 This function performs the iSCSI connection login.
650 @param[in, out] Conn The iSCSI connection to login.
651 @param Timeout The timeout value in milliseconds.
653 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
654 @retval EFI_TIMEOUT Timeout occurred during the login procedure.
655 @retval Others Other errors as indicated.
660 IN OUT ISCSI_CONNECTION
*Conn
,
665 Create a TCP connection for the iSCSI session.
667 @param[in] Session Points to the iSCSI session.
669 @return The newly created iSCSI connection.
673 IScsiCreateConnection (
674 IN ISCSI_SESSION
*Session
678 Destroy an iSCSI connection.
680 @param[in] Conn The connection to destroy.
684 IScsiDestroyConnection (
685 IN ISCSI_CONNECTION
*Conn
689 Login the iSCSI session.
691 @param[in] Session The iSCSI session
693 @retval EFI_SUCCESS The iSCSI session login procedure finished.
694 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
695 @retval EFI_NO_MEDIA There was a media error.
696 @retval Others Other errors as indicated.
701 IN ISCSI_SESSION
*Session
705 Wait for IPsec negotiation, then try to login the iSCSI session again.
707 @param[in] Session The iSCSI session
709 @retval EFI_SUCCESS The iSCSI session login procedure finished.
710 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
711 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
715 IScsiSessionReLogin (
716 IN ISCSI_SESSION
*Session
720 Build and send the iSCSI login request to the iSCSI target according to
721 the current login stage.
723 @param[in] Conn The connection in the iSCSI login phase.
725 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
727 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
728 @retval EFI_DEVICE_ERROR Some kind of device error happened.
733 IN ISCSI_CONNECTION
*Conn
737 Receive and process the iSCSI login response.
739 @param[in] Conn The connection in the iSCSI login phase.
741 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
742 @retval Others Other errors as indicated.
746 IScsiReceiveLoginRsp (
747 IN ISCSI_CONNECTION
*Conn
751 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
752 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
755 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
757 @param[in] Key The key name string.
758 @param[in] Value The value string.
760 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
761 the correspondence length fields are updated.
762 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
766 IScsiAddKeyValuePair (
773 Prepare the iSCSI login request to be sent according to the current login status.
775 @param[in, out] Conn The connection in the iSCSI login phase.
777 @return The pointer to the net buffer containing the iSCSI login request built.
778 @retval NULL Other errors as indicated.
782 IScsiPrepareLoginReq (
783 IN OUT ISCSI_CONNECTION
*Conn
787 Process the iSCSI Login Response.
789 @param[in, out] Conn The connection on which the iSCSI login response is received.
790 @param[in, out] Pdu The iSCSI login response PDU.
792 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
793 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
794 @retval EFI_MEDIA_CHANGED Target is redirected.
795 @retval Others Other errors as indicated.
799 IScsiProcessLoginRsp (
800 IN OUT ISCSI_CONNECTION
*Conn
,
805 Updated the target information according the data received in the iSCSI
806 login response with an target redirection status.
808 @param[in, out] Session The iSCSI session.
809 @param[in] Data The data segment which should contain the
810 TargetAddress key-value list.
811 @param[in] Len Length of the data.
813 @retval EFI_SUCCESS The target address is updated.
814 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
815 @retval EFI_NOT_FOUND The TargetAddress key is not found.
816 @retval Others Other errors as indicated.
820 IScsiUpdateTargetAddress (
821 IN OUT ISCSI_SESSION
*Session
,
827 The callback function to free the net buffer list.
829 @param[in] Arg The opaque parameter.
839 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
840 an optional data segment. The two parts will be put into two blocks of buffers in the
841 net buffer. The digest check will be conducted in this function if needed and the digests
842 will be trimmed from the PDU buffer.
844 @param[in] Conn The iSCSI connection to receive data from.
845 @param[out] Pdu The received iSCSI pdu.
846 @param[in] Context The context used to describe information on the caller provided
847 buffer to receive data segment of the iSCSI pdu, it's optional.
848 @param[in] HeaderDigest Whether there will be header digest received.
849 @param[in] DataDigest Whether there will be data digest.
850 @param[in] TimeoutEvent The timeout event, it's optional.
852 @retval EFI_SUCCESS An iSCSI pdu is received.
853 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
854 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
855 @retval Others Other errors as indicated.
860 IN ISCSI_CONNECTION
*Conn
,
862 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
863 IN BOOLEAN HeaderDigest
,
864 IN BOOLEAN DataDigest
,
865 IN EFI_EVENT TimeoutEvent OPTIONAL
869 Check and get the result of the parameter negotiation.
871 @param[in, out] Conn The connection in iSCSI login.
873 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
874 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
875 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
880 IN OUT ISCSI_CONNECTION
*Conn
884 Fill the operational parameters.
886 @param[in] Conn The connection in iSCSI login.
887 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
892 IN ISCSI_CONNECTION
*Conn
,
897 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
899 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
900 @param[in] Len The length of the last semgnet in the PDU.
902 @retval EFI_SUCCESS The segment is padded or no need to pad it.
903 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
913 Build a key-value list from the data segment.
915 @param[in] Data The data segment containing the key-value pairs.
916 @param[in] Len Length of the data segment.
918 @return The key-value list.
919 @retval NULL Other errors as indicated.
923 IScsiBuildKeyValueList (
929 Get the value string by the key name from the key-value list. If found,
930 the key-value entry will be removed from the list.
932 @param[in, out] KeyValueList The key-value list.
933 @param[in] Key The key name to find.
935 @return The value string.
936 @retval NULL The key value pair can not be found.
940 IScsiGetValueByKeyFromList (
941 IN OUT LIST_ENTRY
*KeyValueList
,
946 Free the key-value list.
948 @param[in] KeyValueList The key-value list.
952 IScsiFreeKeyValueList (
953 IN LIST_ENTRY
*KeyValueList
957 Normalize the iSCSI name according to RFC.
959 @param[in, out] Name The iSCSI name.
960 @param[in] Len length of the iSCSI name.
962 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
963 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
973 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
975 @param[in] PassThru The EXT SCSI PASS THRU protocol.
976 @param[in] Target The target ID.
977 @param[in] Lun The LUN.
978 @param[in, out] Packet The request packet containing IO request, SCSI command
979 buffer and buffers to read/write.
981 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
983 @retval EFI_DEVICE_ERROR Session state was not as required.
984 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
985 @retval EFI_NOT_READY The target can not accept new commands.
986 @retval Others Other errors as indicated.
990 IScsiExecuteScsiCommand (
991 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
994 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
998 Reinstate the session on some error.
1000 @param[in] Session The iSCSI session
1002 @retval EFI_SUCCES The session is reinstated from some error.
1003 @retval Other Reinstatement failed.
1007 IScsiSessionReinstatement (
1008 IN ISCSI_SESSION
*Session
1012 Initialize some session parameters before login.
1014 @param[in, out] Session The iSCSI session.
1015 @param[in] Recovery Whether the request is from a fresh new start or recovery.
1020 IN OUT ISCSI_SESSION
*Session
,
1025 Abort the iSCSI session, that is, reset all the connection and free the
1028 @param[in, out] Session The iSCSI session.
1033 IN OUT ISCSI_SESSION
*Session