2 The header file of iSCSI Protocol that defines many specific data structures.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _ISCSI_PROTO_H_
16 #define _ISCSI_PROTO_H_
19 // RFC 1982 Serial Number Arithmetic, SERIAL_BITS = 32
21 #define ISCSI_SEQ_EQ(s1, s2) ((s1) == (s2))
22 #define ISCSI_SEQ_LT(s1, s2) \
24 (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) < ((UINT32) 1 << 31)) || \
25 (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) > ((UINT32) 1 << 31)) \
27 #define ISCSI_SEQ_GT(s1, s2) \
29 (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) > ((UINT32) 1 << 31)) || \
30 (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) < ((UINT32) 1 << 31)) \
33 #define ISCSI_WELL_KNOWN_PORT 3260
34 #define ISCSI_MAX_CONNS_PER_SESSION 1
36 #define DEFAULT_MAX_RECV_DATA_SEG_LEN 8192
37 #define MAX_RECV_DATA_SEG_LEN_IN_FFP 65536
38 #define DEFAULT_MAX_OUTSTANDING_R2T 1
40 #define ISCSI_VERSION_MAX 0x00
41 #define ISCSI_VERSION_MIN 0x00
43 #define ISCSI_REDIRECT_ADDR_START_DELIMITER '['
44 #define ISCSI_REDIRECT_ADDR_END_DELIMITER ']'
46 #define ISCSI_KEY_AUTH_METHOD "AuthMethod"
47 #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"
48 #define ISCSI_KEY_DATA_DIGEST "DataDigest"
49 #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"
50 #define ISCSI_KEY_TARGET_NAME "TargetName"
51 #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"
52 #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"
53 #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"
54 #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"
55 #define ISCSI_KEY_INITIAL_R2T "InitialR2T"
56 #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"
57 #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"
58 #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"
59 #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"
60 #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"
61 #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"
62 #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"
63 #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"
64 #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"
65 #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"
66 #define ISCSI_KEY_SESSION_TYPE "SessionType"
67 #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"
69 #define ISCSI_KEY_VALUE_NONE "None"
72 /// connection state for initiator
75 #define CONN_STATE_FREE 0
76 #define CONN_STATE_XPT_WAIT 1
77 #define CONN_STATE_IN_LOGIN 2
78 #define CONN_STATE_LOGGED_IN 3
79 #define CONN_STATE_IN_LOGOUT 4
80 #define CONN_STATE_LOGOUT_REQUESTED 5
81 #define CONN_STATE_CLEANUP_WAIT 6
82 #define CONN_STATE_IN_CLEANUP 7
85 /// session state for initiator
87 #define SESSION_STATE_FREE 0
88 #define SESSION_STATE_LOGGED_IN 1
89 #define SESSION_STATE_FAILED 2
91 #define ISCSI_RESERVED_TAG 0xffffffff
93 #define ISCSI_REQ_IMMEDIATE 0x40
94 #define ISCSI_OPCODE_MASK 0x3F
96 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
97 #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
98 #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
99 #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
100 #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
101 #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
102 #define ISCSI_FLAG_ON(PduHdr, Flag) ((BOOLEAN) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag)))
103 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
104 #define ISCSI_GET_CURRENT_STAGE(PduHdr) ((UINT8) (((PduHdr)->Flags >> 2) & 0x3))
105 #define ISCSI_GET_NEXT_STAGE(PduHdr) ((UINT8) (((PduHdr)->Flags) & 0x3))
107 #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)
108 #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))
110 #define HTON24(Dst, Src) \
112 (Dst)[0] = (UINT8) ((UINT8) ((Src) >> 16) & 0xFF); \
113 (Dst)[1] = (UINT8) ((UINT8) ((Src) >> 8) & 0xFF); \
114 (Dst)[2] = (UINT8) ((UINT8) (Src) & 0xFF); \
117 #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
119 #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
120 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
121 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
124 // Initiator opcodes.
126 #define ISCSI_OPCODE_NOP_OUT 0x00
127 #define ISCSI_OPCODE_SCSI_CMD 0x01
128 #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02
129 #define ISCSI_OPCODE_LOGIN_REQ 0x03
130 #define ISCSI_OPCODE_TEXT_REQ 0x04
131 #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05
132 #define ISCSI_OPCODE_LOGOUT_REQ 0x06
133 #define ISCSI_OPCODE_SNACK_REQ 0x10
134 #define ISCSI_OPCODE_VENDOR_I0 0x1c
135 #define ISCSI_OPCODE_VENDOR_I1 0x1d
136 #define ISCSI_OPCODE_VENDOR_I2 0x1e
141 #define ISCSI_OPCODE_NOP_IN 0x20
142 #define ISCSI_OPCODE_SCSI_RSP 0x21
143 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
144 #define ISCSI_OPCODE_LOGIN_RSP 0x23
145 #define ISCSI_OPCODE_TEXT_RSP 0x24
146 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
147 #define ISCSI_OPCODE_LOGOUT_RSP 0x26
148 #define ISCSI_OPCODE_R2T 0x31
149 #define ISCSI_OPCODE_ASYNC_MSG 0x32
150 #define ISCSI_OPCODE_VENDOR_T0 0x3c
151 #define ISCSI_OPCODE_VENDOR_T1 0x3d
152 #define ISCSI_OPCODE_VENDOR_T2 0x3e
153 #define ISCSI_OPCODE_REJECT 0x3f
155 #define ISCSI_BHS_FLAG_FINAL 0x80
158 // Defined AHS types, others are reserved.
160 #define ISCSI_AHS_TYPE_EXT_CDB 0x1
161 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
163 #define SCSI_CMD_PDU_FLAG_READ 0x40
164 #define SCSI_CMD_PDU_FLAG_WRITE 0x20
166 #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07
171 #define ISCSI_TASK_ATTR_UNTAGGED 0x00
172 #define ISCSI_TASK_ATTR_SIMPLE 0x01
173 #define ISCSI_TASK_ATTR_ORDERD 0x02
174 #define ISCSI_TASK_ATTR_HOQ 0x03
175 #define ISCSI_TASK_ATTR_ACA 0x04
178 // Flag bit definitions in SCSI response.
180 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10
181 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
182 #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04
183 #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02
186 // iSCSI service response codes.
188 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00
189 #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01
191 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0
192 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1
193 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2
194 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3
195 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
196 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5
197 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6
198 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255
200 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40
201 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW
202 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW
203 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01
205 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80
206 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
208 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
209 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
211 #define ISCSI_LOGIN_STATUS_SUCCESS 0
212 #define ISCSI_LOGIN_STATUS_REDIRECTION 1
213 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2
214 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3
216 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
217 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
218 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2
220 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0
221 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1
222 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2
223 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3
225 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0
226 #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1
227 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2
228 #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3
230 #define ISCSI_SECURITY_NEGOTIATION 0
231 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
232 #define ISCSI_FULL_FEATURE_PHASE 3
234 typedef struct _ISCSI_SESSION ISCSI_SESSION
;
235 typedef struct _ISCSI_CONNECTION ISCSI_CONNECTION
;
244 /// iSCSI Basic Header Segment
246 typedef struct _ISCSI_BASIC_HEADER
{
249 UINT16 OpCodeSpecific1
;
250 UINT8 TotalAHSLength
;
251 UINT8 DataSegmentLength
[3];
253 UINT32 InitiatorTaskTag
;
254 UINT32 OpCodeSpecific2
[7];
255 } ISCSI_BASIC_HEADER
;
257 typedef struct _ISCSI_ADDTIONAL_HEADER
{
260 UINT8 TypeSpecific
[1];
261 } ISCSI_ADDITIONAL_HEADER
;
263 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS
{
267 UINT32 ExpReadDataLength
;
268 } ISCSI_BI_EXP_READ_DATA_LEN_AHS
;
273 typedef struct _SCSI_COMMAND
{
277 UINT8 TotalAHSLength
;
278 UINT8 DataSegmentLength
[3];
280 UINT32 InitiatorTaskTag
;
281 UINT32 ExpDataXferLength
;
290 typedef struct _SCSI_RESPONSE
{
295 UINT8 TotalAHSLength
;
296 UINT8 DataSegmentLength
[3];
298 UINT32 InitiatorTaskTag
;
304 UINT32 BiReadResidualCount
;
305 UINT32 ResidualCount
;
308 typedef struct _ISCSI_SENSE_DATA
{
314 /// iSCSI Task Managment Function Request.
316 typedef struct _ISCSI_TMF_REQUEST
{
320 UINT8 TotalAHSLength
;
321 UINT8 DataSegmentLength
[3];
323 UINT32 InitiatorTaskTag
;
324 UINT32 ReferencedTaskTag
;
333 /// iSCSI Task Management Function Response.
335 typedef struct _ISCSI_TMF_RESPONSE
{
340 UINT8 TotalAHSLength
;
341 UINT8 DataSegmentLength
[3];
343 UINT32 InitiatorTaskTag
;
349 } ISCSI_TMF_RESPONSE
;
354 typedef struct _ISCSI_SCSI_DATA_OUT
{
357 UINT8 TotalAHSLength
;
358 UINT8 DataSegmentLength
[3];
360 UINT32 InitiatorTaskTag
;
361 UINT32 TargetTransferTag
;
368 } ISCSI_SCSI_DATA_OUT
;
373 typedef struct _ISCSI_SCSI_DATA_IN
{
378 UINT8 TotalAHSLength
;
379 UINT8 DataSegmentLength
[3];
381 UINT32 InitiatorTaskTag
;
382 UINT32 TargetTransferTag
;
388 UINT32 ResidualCount
;
389 } ISCSI_SCSI_DATA_IN
;
392 /// Ready To Transfer.
394 typedef struct _ISCSI_READY_TO_TRANSFER
{
397 UINT8 TotalAHSLength
;
398 UINT8 DataSegmentLength
[3];
400 UINT32 InitiatorTaskTag
;
401 UINT32 TargetTransferTag
;
407 UINT32 DesiredDataTransferLength
;
408 } ISCSI_READY_TO_TRANSFER
;
410 typedef struct _ISCSI_ASYNC_MESSAGE
{
413 UINT8 TotalAHSLength
;
414 UINT8 DataSegmentLength
[3];
416 UINT32 InitiatorTaskTag
;
427 } ISCSI_ASYNC_MESSAGE
;
432 typedef struct _ISCSI_LOGIN_REQUEST
{
437 UINT8 TotalAHSLength
;
438 UINT8 DataSegmentLength
[3];
441 UINT32 InitiatorTaskTag
;
447 } ISCSI_LOGIN_REQUEST
;
452 typedef struct _ISCSI_LOGIN_RESPONSE
{
457 UINT8 TotalAHSLength
;
458 UINT8 DataSegmentLength
[3];
461 UINT32 InitiatorTaskTag
;
469 } ISCSI_LOGIN_RESPONSE
;
474 typedef struct _ISCSI_LOGOUT_REQUEST
{
478 UINT8 TotalAHSLength
;
479 UINT8 DataSegmentLength
[3];
481 UINT32 InitiatorTaskTag
;
487 } ISCSI_LOGOUT_REQUEST
;
492 typedef struct _ISCSI_LOGOUT_RESPONSE
{
497 UINT8 TotalAHSLength
;
498 UINT8 DataSegmentLength
[3];
500 UINT32 InitiatorTaskTag
;
509 } ISCSI_LOGOUT_RESPONSE
;
514 typedef struct _ISCSI_SNACK_REQUEST
{
518 UINT8 TotalAHSLength
;
519 UINT8 DataSegmentLength
[3];
521 UINT32 InitiatorTaskTag
;
522 UINT32 TargetTransferTag
;
528 } ISCSI_SNACK_REQUEST
;
533 typedef struct _ISCSI_REJECT
{
538 UINT8 TotalAHSLength
;
539 UINT8 DataSegmentLength
[3];
541 UINT32 InitiatorTaskTag
;
553 typedef struct _ISCSI_NOP_OUT
{
556 UINT8 TotalAHSLength
;
557 UINT8 DataSegmentLength
[3];
559 UINT32 InitiatorTaskTag
;
560 UINT32 TargetTransferTag
;
569 typedef struct _ISCSI_NOP_IN
{
572 UINT8 TotalAHSLength
;
573 UINT8 DataSegmentLength
[3];
575 UINT32 InitiatorTaskTag
;
576 UINT32 TargetTransferTag
;
588 typedef struct _ISCSI_XFER_CONTEXT
{
589 UINT32 TargetTransferTag
;
591 UINT32 DesiredLength
;
593 } ISCSI_XFER_CONTEXT
;
595 typedef struct _ISCSI_IN_BUFFER_CONTEXT
{
598 } ISCSI_IN_BUFFER_CONTEXT
;
600 typedef struct _ISCSI_TCB
{
603 BOOLEAN SoFarInOrder
;
605 BOOLEAN FbitReceived
;
610 UINT32 InitiatorTaskTag
;
614 ISCSI_XFER_CONTEXT XferContext
;
616 ISCSI_CONNECTION
*Conn
;
619 typedef struct _ISCSI_KEY_VALUE_PAIR
{
624 } ISCSI_KEY_VALUE_PAIR
;
627 Attach the iSCSI connection to the iSCSI session.
629 @param[in, out] Session The iSCSI session.
630 @param[in, out] Conn The iSCSI connection.
634 IScsiAttatchConnection (
635 IN OUT ISCSI_SESSION
*Session
,
636 IN OUT ISCSI_CONNECTION
*Conn
640 Detach the iSCSI connection from the session it belongs to.
642 @param[in, out] Conn The iSCSI connection.
646 IScsiDetatchConnection (
647 IN OUT ISCSI_CONNECTION
*Conn
651 This function performs the iSCSI connection login.
653 @param[in, out] Conn The iSCSI connection to login.
654 @param Timeout The timeout value in milliseconds.
656 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
657 @retval EFI_TIMEOUT Timeout occurred during the login procedure.
658 @retval Others Other errors as indicated.
663 IN OUT ISCSI_CONNECTION
*Conn
,
668 Create a TCP connection for the iSCSI session.
670 @param[in] Session Points to the iSCSI session.
672 @return The newly created iSCSI connection.
676 IScsiCreateConnection (
677 IN ISCSI_SESSION
*Session
681 Destroy an iSCSI connection.
683 @param[in] Conn The connection to destroy.
687 IScsiDestroyConnection (
688 IN ISCSI_CONNECTION
*Conn
692 Login the iSCSI session.
694 @param[in] Session The iSCSI session
696 @retval EFI_SUCCESS The iSCSI session login procedure finished.
697 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
698 @retval EFI_NO_MEDIA There was a media error.
699 @retval Others Other errors as indicated.
704 IN ISCSI_SESSION
*Session
708 Wait for IPsec negotiation, then try to login the iSCSI session again.
710 @param[in] Session The iSCSI session
712 @retval EFI_SUCCESS The iSCSI session login procedure finished.
713 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
714 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
718 IScsiSessionReLogin (
719 IN ISCSI_SESSION
*Session
723 Build and send the iSCSI login request to the iSCSI target according to
724 the current login stage.
726 @param[in] Conn The connection in the iSCSI login phase.
728 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
730 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
731 @retval EFI_DEVICE_ERROR Some kind of device error happened.
736 IN ISCSI_CONNECTION
*Conn
740 Receive and process the iSCSI login response.
742 @param[in] Conn The connection in the iSCSI login phase.
744 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
745 @retval Others Other errors as indicated.
749 IScsiReceiveLoginRsp (
750 IN ISCSI_CONNECTION
*Conn
754 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
755 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
758 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
760 @param[in] Key The key name string.
761 @param[in] Value The value string.
763 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
764 the correspondence length fields are updated.
765 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
769 IScsiAddKeyValuePair (
776 Prepare the iSCSI login request to be sent according to the current login status.
778 @param[in, out] Conn The connection in the iSCSI login phase.
780 @return The pointer to the net buffer containing the iSCSI login request built.
781 @retval NULL Other errors as indicated.
785 IScsiPrepareLoginReq (
786 IN OUT ISCSI_CONNECTION
*Conn
790 Process the iSCSI Login Response.
792 @param[in, out] Conn The connection on which the iSCSI login response is received.
793 @param[in, out] Pdu The iSCSI login response PDU.
795 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
796 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
797 @retval EFI_MEDIA_CHANGED Target is redirected.
798 @retval Others Other errors as indicated.
802 IScsiProcessLoginRsp (
803 IN OUT ISCSI_CONNECTION
*Conn
,
808 Updated the target information according the data received in the iSCSI
809 login response with an target redirection status.
811 @param[in, out] Session The iSCSI session.
812 @param[in] Data The data segment which should contain the
813 TargetAddress key-value list.
814 @param[in] Len Length of the data.
816 @retval EFI_SUCCESS The target address is updated.
817 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
818 @retval EFI_NOT_FOUND The TargetAddress key is not found.
819 @retval Others Other errors as indicated.
823 IScsiUpdateTargetAddress (
824 IN OUT ISCSI_SESSION
*Session
,
830 The callback function to free the net buffer list.
832 @param[in] Arg The opaque parameter.
842 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
843 an optional data segment. The two parts will be put into two blocks of buffers in the
844 net buffer. The digest check will be conducted in this function if needed and the digests
845 will be trimmed from the PDU buffer.
847 @param[in] Conn The iSCSI connection to receive data from.
848 @param[out] Pdu The received iSCSI pdu.
849 @param[in] Context The context used to describe information on the caller provided
850 buffer to receive data segment of the iSCSI pdu, it's optional.
851 @param[in] HeaderDigest Whether there will be header digest received.
852 @param[in] DataDigest Whether there will be data digest.
853 @param[in] TimeoutEvent The timeout event, it's optional.
855 @retval EFI_SUCCESS An iSCSI pdu is received.
856 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
857 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
858 @retval Others Other errors as indicated.
863 IN ISCSI_CONNECTION
*Conn
,
865 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
866 IN BOOLEAN HeaderDigest
,
867 IN BOOLEAN DataDigest
,
868 IN EFI_EVENT TimeoutEvent OPTIONAL
872 Check and get the result of the parameter negotiation.
874 @param[in, out] Conn The connection in iSCSI login.
876 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
877 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
878 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
883 IN OUT ISCSI_CONNECTION
*Conn
887 Fill the operational parameters.
889 @param[in] Conn The connection in iSCSI login.
890 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
895 IN ISCSI_CONNECTION
*Conn
,
900 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
902 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
903 @param[in] Len The length of the last semgnet in the PDU.
905 @retval EFI_SUCCESS The segment is padded or no need to pad it.
906 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
916 Build a key-value list from the data segment.
918 @param[in] Data The data segment containing the key-value pairs.
919 @param[in] Len Length of the data segment.
921 @return The key-value list.
922 @retval NULL Other errors as indicated.
926 IScsiBuildKeyValueList (
932 Get the value string by the key name from the key-value list. If found,
933 the key-value entry will be removed from the list.
935 @param[in, out] KeyValueList The key-value list.
936 @param[in] Key The key name to find.
938 @return The value string.
939 @retval NULL The key value pair can not be found.
943 IScsiGetValueByKeyFromList (
944 IN OUT LIST_ENTRY
*KeyValueList
,
949 Free the key-value list.
951 @param[in] KeyValueList The key-value list.
955 IScsiFreeKeyValueList (
956 IN LIST_ENTRY
*KeyValueList
960 Normalize the iSCSI name according to RFC.
962 @param[in, out] Name The iSCSI name.
963 @param[in] Len length of the iSCSI name.
965 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
966 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
976 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
978 @param[in] PassThru The EXT SCSI PASS THRU protocol.
979 @param[in] Target The target ID.
980 @param[in] Lun The LUN.
981 @param[in, out] Packet The request packet containing IO request, SCSI command
982 buffer and buffers to read/write.
984 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
986 @retval EFI_DEVICE_ERROR Session state was not as required.
987 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
988 @retval EFI_NOT_READY The target can not accept new commands.
989 @retval Others Other errors as indicated.
993 IScsiExecuteScsiCommand (
994 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
997 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
1001 Reinstate the session on some error.
1003 @param[in] Session The iSCSI session
1005 @retval EFI_SUCCES The session is reinstated from some error.
1006 @retval Other Reinstatement failed.
1010 IScsiSessionReinstatement (
1011 IN ISCSI_SESSION
*Session
1015 Initialize some session parameters before login.
1017 @param[in, out] Session The iSCSI session.
1018 @param[in] Recovery Whether the request is from a fresh new start or recovery.
1023 IN OUT ISCSI_SESSION
*Session
,
1028 Abort the iSCSI session, that is, reset all the connection and free the
1031 @param[in, out] Session The iSCSI session.
1036 IN OUT ISCSI_SESSION
*Session