2 The header file of iSCSI Protocol that defines many specific data structures.
4 Copyright (c) 2004 - 2011, 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_
18 #include <Protocol/ScsiPassThruExt.h>
21 // RFC 1982 Serial Number Arithmetic, SERIAL_BITS = 32
23 #define ISCSI_SEQ_EQ(s1, s2) ((s1) == (s2))
24 #define ISCSI_SEQ_LT(s1, s2) \
26 (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) < ((UINT32) 1 << 31)) || \
27 (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) > ((UINT32) 1 << 31)) \
29 #define ISCSI_SEQ_GT(s1, s2) \
31 (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) > ((UINT32) 1 << 31)) || \
32 (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) < ((UINT32) 1 << 31)) \
35 #define ISCSI_WELL_KNOWN_PORT 3260
36 #define ISCSI_MAX_CONNS_PER_SESSION 1
38 #define DEFAULT_MAX_RECV_DATA_SEG_LEN 8192
39 #define MAX_RECV_DATA_SEG_LEN_IN_FFP 65536
40 #define DEFAULT_MAX_OUTSTANDING_R2T 1
42 #define ISCSI_VERSION_MAX 0x00
43 #define ISCSI_VERSION_MIN 0x00
45 #define ISCSI_KEY_AUTH_METHOD "AuthMethod"
46 #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"
47 #define ISCSI_KEY_DATA_DIGEST "DataDigest"
48 #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"
49 #define ISCSI_KEY_TARGET_NAME "TargetName"
50 #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"
51 #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"
52 #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"
53 #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"
54 #define ISCSI_KEY_INITIAL_R2T "InitialR2T"
55 #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"
56 #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"
57 #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"
58 #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"
59 #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"
60 #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"
61 #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"
62 #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"
63 #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"
64 #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"
65 #define ISCSI_KEY_SESSION_TYPE "SessionType"
66 #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"
68 #define ISCSI_KEY_VALUE_NONE "None"
71 /// connection state for initiator
74 #define CONN_STATE_FREE 0
75 #define CONN_STATE_XPT_WAIT 1
76 #define CONN_STATE_IN_LOGIN 2
77 #define CONN_STATE_LOGGED_IN 3
78 #define CONN_STATE_IN_LOGOUT 4
79 #define CONN_STATE_LOGOUT_REQUESTED 5
80 #define CONN_STATE_CLEANUP_WAIT 6
81 #define CONN_STATE_IN_CLEANUP 7
84 /// session state for initiator
86 #define SESSION_STATE_FREE 0
87 #define SESSION_STATE_LOGGED_IN 1
88 #define SESSION_STATE_FAILED 2
96 #define ISCSI_RESERVED_TAG 0xffffffff
98 #define ISCSI_REQ_IMMEDIATE 0x40
99 #define ISCSI_OPCODE_MASK 0x3F
101 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
102 #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
103 #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
104 #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
105 #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
106 #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
107 #define ISCSI_FLAG_ON(PduHdr, Flag) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag))
108 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
109 #define ISCSI_GET_CURRENT_STAGE(PduHdr) (((PduHdr)->Flags >> 2) & 0x3)
110 #define ISCSI_GET_NEXT_STAGE(PduHdr) (((PduHdr)->Flags) & 0x3)
112 #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)
113 #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))
115 #define HTON24(Dst, Src) \
117 (Dst)[0] = (UINT8) (((Src) >> 16) & 0xFF); \
118 (Dst)[1] = (UINT8) (((Src) >> 8) & 0xFF); \
119 (Dst)[2] = (UINT8) ((Src) & 0xFF); \
122 #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
124 #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
125 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
130 #define ISCSI_OPCODE_NOP_OUT 0x00
131 #define ISCSI_OPCODE_SCSI_CMD 0x01
132 #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02
133 #define ISCSI_OPCODE_LOGIN_REQ 0x03
134 #define ISCSI_OPCODE_TEXT_REQ 0x04
135 #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05
136 #define ISCSI_OPCODE_LOGOUT_REQ 0x06
137 #define ISCSI_OPCODE_SNACK_REQ 0x10
138 #define ISCSI_OPCODE_VENDOR_I0 0x1c
139 #define ISCSI_OPCODE_VENDOR_I1 0x1d
140 #define ISCSI_OPCODE_VENDOR_I2 0x1e
145 #define ISCSI_OPCODE_NOP_IN 0x20
146 #define ISCSI_OPCODE_SCSI_RSP 0x21
147 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
148 #define ISCSI_OPCODE_LOGIN_RSP 0x23
149 #define ISCSI_OPCODE_TEXT_RSP 0x24
150 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
151 #define ISCSI_OPCODE_LOGOUT_RSP 0x26
152 #define ISCSI_OPCODE_R2T 0x31
153 #define ISCSI_OPCODE_ASYNC_MSG 0x32
154 #define ISCSI_OPCODE_VENDOR_T0 0x3c
155 #define ISCSI_OPCODE_VENDOR_T1 0x3d
156 #define ISCSI_OPCODE_VENDOR_T2 0x3e
157 #define ISCSI_OPCODE_REJECT 0x3f
159 #define ISCSI_BHS_FLAG_FINAL 0x80
162 /// iSCSI Basic Header Segment
164 typedef struct _ISCSI_BASIC_HEADER
{
167 UINT16 OpCodeSpecific1
;
168 UINT8 TotalAHSLength
;
169 UINT8 DataSegmentLength
[3];
171 UINT32 InitiatorTaskTag
;
172 UINT32 OpCodeSpecific2
[7];
173 } ISCSI_BASIC_HEADER
;
176 // Defined AHS types, others are reserved.
178 #define ISCSI_AHS_TYPE_EXT_CDB 0x1
179 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
181 typedef struct _ISCSI_ADDTIONAL_HEADER
{
184 UINT8 TypeSpecific
[1];
185 } ISCSI_ADDITIONAL_HEADER
;
187 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS
{
191 UINT32 ExpReadDataLength
;
192 } ISCSI_BI_EXP_READ_DATA_LEN_AHS
;
194 #define SCSI_CMD_PDU_FLAG_READ 0x40
195 #define SCSI_CMD_PDU_FLAG_WRITE 0x20
197 #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07
202 #define ISCSI_TASK_ATTR_UNTAGGED 0x00
203 #define ISCSI_TASK_ATTR_SIMPLE 0x01
204 #define ISCSI_TASK_ATTR_ORDERD 0x02
205 #define ISCSI_TASK_ATTR_HOQ 0x03
206 #define ISCSI_TASK_ATTR_ACA 0x04
211 typedef struct _SCSI_COMMAND
{
215 UINT8 TotalAHSLength
;
216 UINT8 DataSegmentLength
[3];
218 UINT32 InitiatorTaskTag
;
219 UINT32 ExpDataXferLength
;
226 // flag bit definitions in SCSI response
228 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10
229 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
230 #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04
231 #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02
234 // iSCSI service response codes
236 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00
237 #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01
242 typedef struct _SCSI_RESPONSE
{
247 UINT8 TotalAHSLength
;
248 UINT8 DataSegmentLength
[3];
250 UINT32 InitiatorTaskTag
;
256 UINT32 BiReadResidualCount
;
257 UINT32 ResidualCount
;
260 typedef struct _ISCSI_SENSE_DATA
{
266 /// iSCSI Task Managment Function Request
268 typedef struct _ISCSI_TMF_REQUEST
{
272 UINT8 TotalAHSLength
;
273 UINT8 DataSegmentLength
[3];
275 UINT32 InitiatorTaskTag
;
276 UINT32 ReferencedTaskTag
;
284 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0
285 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1
286 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2
287 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3
288 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
289 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5
290 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6
291 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255
294 /// iSCSI Task Management Function Response
296 typedef struct _ISCSI_TMF_RESPONSE
{
301 UINT8 TotalAHSLength
;
302 UINT8 DataSegmentLength
[3];
304 UINT32 InitiatorTaskTag
;
310 } ISCSI_TMF_RESPONSE
;
315 typedef struct _ISCSI_SCSI_DATA_OUT
{
318 UINT8 TotalAHSLength
;
319 UINT8 DataSegmentLength
[3];
321 UINT32 InitiatorTaskTag
;
322 UINT32 TargetTransferTag
;
329 } ISCSI_SCSI_DATA_OUT
;
331 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40
332 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW
333 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW
334 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01
339 typedef struct _ISCSI_SCSI_DATA_IN
{
344 UINT8 TotalAHSLength
;
345 UINT8 DataSegmentLength
[3];
347 UINT32 InitiatorTaskTag
;
348 UINT32 TargetTransferTag
;
354 UINT32 ResidualCount
;
355 } ISCSI_SCSI_DATA_IN
;
357 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
360 /// Ready To Transfer
362 typedef struct _ISCSI_READY_TO_TRANSFER
{
365 UINT8 TotalAHSLength
;
366 UINT8 DataSegmentLength
[3];
368 UINT32 InitiatorTaskTag
;
369 UINT32 TargetTransferTag
;
375 UINT32 DesiredDataTransferLength
;
376 } ISCSI_READY_TO_TRANSFER
;
378 typedef struct _ISCSI_ASYNC_MESSAGE
{
381 UINT8 TotalAHSLength
;
382 UINT8 DataSegmentLength
[3];
384 UINT32 InitiatorTaskTag
;
395 } ISCSI_ASYNC_MESSAGE
;
397 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80
398 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
403 typedef struct _ISCSI_LOGIN_REQUEST
{
408 UINT8 TotalAHSLength
;
409 UINT8 DataSegmentLength
[3];
412 UINT32 InitiatorTaskTag
;
418 } ISCSI_LOGIN_REQUEST
;
420 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
421 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
423 #define ISCSI_LOGIN_STATUS_SUCCESS 0
424 #define ISCSI_LOGIN_STATUS_REDIRECTION 1
425 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2
426 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3
431 typedef struct _ISCSI_LOGIN_RESPONSE
{
436 UINT8 TotalAHSLength
;
437 UINT8 DataSegmentLength
[3];
440 UINT32 InitiatorTaskTag
;
448 } ISCSI_LOGIN_RESPONSE
;
450 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
451 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
452 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2
457 typedef struct _ISCSI_LOGOUT_REQUEST
{
461 UINT8 TotalAHSLength
;
462 UINT8 DataSegmentLength
[3];
464 UINT32 InitiatorTaskTag
;
470 } ISCSI_LOGOUT_REQUEST
;
472 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0
473 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1
474 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2
475 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3
480 typedef struct _ISCSI_LOGOUT_RESPONSE
{
485 UINT8 TotalAHSLength
;
486 UINT8 DataSegmentLength
[3];
488 UINT32 InitiatorTaskTag
;
497 } ISCSI_LOGOUT_RESPONSE
;
499 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0
500 #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1
501 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2
502 #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3
507 typedef struct _ISCSI_SNACK_REQUEST
{
511 UINT8 TotalAHSLength
;
512 UINT8 DataSegmentLength
[3];
514 UINT32 InitiatorTaskTag
;
515 UINT32 TargetTransferTag
;
521 } ISCSI_SNACK_REQUEST
;
526 typedef struct _ISCSI_REJECT
{
531 UINT8 TotalAHSLength
;
532 UINT8 DataSegmentLength
[3];
534 UINT32 InitiatorTaskTag
;
546 typedef struct _ISCSI_NOP_OUT
{
549 UINT8 TotalAHSLength
;
550 UINT8 DataSegmentLength
[3];
552 UINT32 InitiatorTaskTag
;
553 UINT32 TargetTransferTag
;
562 typedef struct _ISCSI_NOP_IN
{
565 UINT8 TotalAHSLength
;
566 UINT8 DataSegmentLength
[3];
568 UINT32 InitiatorTaskTag
;
569 UINT32 TargetTransferTag
;
576 #define ISCSI_SECURITY_NEGOTIATION 0
577 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
578 #define ISCSI_FULL_FEATURE_PHASE 3
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.
630 IScsiAttatchConnection (
631 IN OUT ISCSI_SESSION
*Session
,
632 IN OUT ISCSI_CONNECTION
*Conn
636 Detach the iSCSI connection from the session it belongs to.
638 @param[in, out] Conn The iSCSI connection.
641 IScsiDetatchConnection (
642 IN OUT ISCSI_CONNECTION
*Conn
646 This function does the iSCSI connection login.
648 @param[in, out] Conn The iSCSI connection to login.
650 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
651 @retval EFI_TIMEOUT Timeout happened during the login procedure.
652 @retval Others Other errors as indicated.
656 IN OUT ISCSI_CONNECTION
*Conn
660 Create a TCP connection for the iSCSI session.
662 @param[in] Private The iSCSI driver data.
663 @param[in] Session Maximum CmdSN from the target.
665 @return The newly created iSCSI connection.
668 IScsiCreateConnection (
669 IN ISCSI_DRIVER_DATA
*Private
,
670 IN ISCSI_SESSION
*Session
674 Destroy an iSCSI connection.
676 @param[in] Conn The connection to destroy.
679 IScsiDestroyConnection (
680 IN ISCSI_CONNECTION
*Conn
684 Login the iSCSI session.
686 @param[in] Private The iSCSI driver data.
688 @retval EFI_SUCCESS The iSCSI session login procedure finished.
689 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
690 @retval EFI_NO_MEDIA There was a media error.
691 @retval Others Other errors as indicated.
696 IN ISCSI_DRIVER_DATA
*Private
700 Build and send the iSCSI login request to the iSCSI target according to
701 the current login stage.
703 @param[in] Conn The connection in the iSCSI login phase.
705 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
707 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
708 @retval EFI_DEVICE_ERROR Some kind of device error happened.
712 IN ISCSI_CONNECTION
*Conn
716 Receive and process the iSCSI login response.
718 @param[in] Conn The connection in the iSCSI login phase.
720 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
721 @retval Others Other errors as indicated.
724 IScsiReceiveLoginRsp (
725 IN ISCSI_CONNECTION
*Conn
729 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
730 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
733 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
735 @param[in] Key The key name string.
736 @param[in] Value The value string.
738 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
739 the correspondence length fields are updated.
740 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
744 IScsiAddKeyValuePair (
751 Prepare the iSCSI login request to be sent according to the current login status.
753 @param[in, out] Conn The connection in the iSCSI login phase.
755 @return The pointer to the net buffer containing the iSCSI login request built.
756 @retval Others Other errors as indicated.
759 IScsiPrepareLoginReq (
760 IN OUT ISCSI_CONNECTION
*Conn
764 Process the iSCSI Login Response.
766 @param[in, out] Conn The connection on which the iSCSI login response is received.
767 @param[in, out] Pdu The iSCSI login response PDU.
769 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
770 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
771 @retval EFI_MEDIA_CHANGED Target is redirected.
772 @retval Others Other errors as indicated.
775 IScsiProcessLoginRsp (
776 IN OUT ISCSI_CONNECTION
*Conn
,
781 Updated the target information according the data received in the iSCSI
782 login response with an target redirection status.
784 @param[in, out] Session The iSCSI session.
785 @param[in] Data The data segment which should contain the
786 TargetAddress key-value list.
787 @param[in] Len Length of the data.
789 @retval EFI_SUCCESS The target address is updated.
790 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
791 @retval EFI_NOT_FOUND The TargetAddress key is not found.
792 @retval Others Other errors as indicated.
795 IScsiUpdateTargetAddress (
796 IN OUT ISCSI_SESSION
*Session
,
802 The callback function to free the net buffer list.
804 @param[in] Arg The opaque parameter.
813 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
814 an optional data segment. The two parts will be put into two blocks of buffers in the
815 net buffer. The digest check will be conducted in this function if needed and the digests
816 will be trimmed from the PDU buffer.
818 @param[in] Conn The iSCSI connection to receive data from.
819 @param[out] Pdu The received iSCSI pdu.
820 @param[in] Context The context used to describe information on the caller provided
821 buffer to receive data segment of the iSCSI pdu, it's optional.
822 @param[in] HeaderDigest Whether there will be header digest received.
823 @param[in] DataDigest Whether there will be data digest.
824 @param[in] TimeoutEvent The timeout event, it's optional.
826 @retval EFI_SUCCESS An iSCSI pdu is received.
827 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
828 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
829 @retval Others Other errors as indicated.
833 IN ISCSI_CONNECTION
*Conn
,
835 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
836 IN BOOLEAN HeaderDigest
,
837 IN BOOLEAN DataDigest
,
838 IN EFI_EVENT TimeoutEvent OPTIONAL
842 Check and get the result of the prameter negotiation.
844 @param[in, out] Conn The connection in iSCSI login.
846 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
847 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
848 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
852 IN OUT ISCSI_CONNECTION
*Conn
856 Fill the oprational prameters.
858 @param[in] Conn The connection in iSCSI login.
859 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
861 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
865 IN ISCSI_CONNECTION
*Conn
,
870 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
872 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
873 @param[in] Len The length of the last semgnet in the PDU.
875 @retval EFI_SUCCESS The segment is padded or no need to pad it.
876 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
886 Build a key-value list from the data segment.
888 @param[in] Data The data segment containing the key-value pairs.
889 @param[in] Len Length of the data segment.
891 @return The key-value list.
892 @retval NULL Other errors as indicated.
895 IScsiBuildKeyValueList (
901 Get the value string by the key name from the key-value list. If found,
902 the key-value entry will be removed from the list.
904 @param[in, out] KeyValueList The key-value list.
905 @param[in] Key The key name to find.
907 @return The value string.
910 IScsiGetValueByKeyFromList (
911 IN OUT LIST_ENTRY
*KeyValueList
,
916 Free the key-value list.
918 @param[in] KeyValueList The key-value list.
921 IScsiFreeKeyValueList (
922 IN LIST_ENTRY
*KeyValueList
926 Normalize the iSCSI name according to RFC.
928 @param[in, out] Name The iSCSI name.
929 @param[in] Len length of the iSCSI name.
931 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
932 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
941 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
943 @param[in] PassThru The EXT SCSI PASS THRU protocol.
944 @param[in] Target The target ID.
945 @param[in] Lun The LUN.
946 @param[in, out] Packet The request packet containing IO request, SCSI command
947 buffer and buffers to read/write.
949 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
951 @retval EFI_DEVICE_ERROR Session state was not as required.
952 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
953 @retval Others Other errors as indicated.
956 IScsiExecuteScsiCommand (
957 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
960 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
964 Reinstate the session on some error.
966 @param[in, out] Private The iSCSI driver data.
968 @retval EFI_SUCCES The session is reinstated from some error.
969 @retval Other Reinstatement failed.
972 IScsiSessionReinstatement (
973 IN OUT ISCSI_DRIVER_DATA
*Private
977 Initialize some session parameters before login.
979 @param[in, out] Session The iSCSI session.
980 @param[in] Recovery Whether the request is from a fresh new start or recovery.
984 IN OUT ISCSI_SESSION
*Session
,
989 Abort the iSCSI session, that is, reset all the connection and free the
992 @param[in, out] Session The iSCSI session.
994 @retval EFI_SUCCES The session is aborted.
998 IN OUT ISCSI_SESSION
*Session