2 The header file of iSCSI Protocol that defines many specific data structures.
4 Copyright (c) 2004 - 2009, Intel Corporation.<BR>
5 All rights reserved. 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 ISID_BYTE_0 0 // OUI format
47 #define ISID_BYTE_2 0xaa
48 #define ISID_BYTE_3 0x1
50 #define ISCSI_KEY_AUTH_METHOD "AuthMethod"
51 #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"
52 #define ISCSI_KEY_DATA_DIGEST "DataDigest"
53 #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"
54 #define ISCSI_KEY_TARGET_NAME "TargetName"
55 #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"
56 #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"
57 #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"
58 #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"
59 #define ISCSI_KEY_INITIAL_R2T "InitialR2T"
60 #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"
61 #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"
62 #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"
63 #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"
64 #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"
65 #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"
66 #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"
67 #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"
68 #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"
69 #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"
70 #define ISCSI_KEY_SESSION_TYPE "SessionType"
71 #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"
73 #define ISCSI_KEY_VALUE_NONE "None"
76 /// connection state for initiator
79 #define CONN_STATE_FREE 0
80 #define CONN_STATE_XPT_WAIT 1
81 #define CONN_STATE_IN_LOGIN 2
82 #define CONN_STATE_LOGGED_IN 3
83 #define CONN_STATE_IN_LOGOUT 4
84 #define CONN_STATE_LOGOUT_REQUESTED 5
85 #define CONN_STATE_CLEANUP_WAIT 6
86 #define CONN_STATE_IN_CLEANUP 7
89 /// session state for initiator
91 #define SESSION_STATE_FREE 0
92 #define SESSION_STATE_LOGGED_IN 1
93 #define SESSION_STATE_FAILED 2
101 #define ISCSI_RESERVED_TAG 0xffffffff
103 #define ISCSI_REQ_IMMEDIATE 0x40
104 #define ISCSI_OPCODE_MASK 0x3F
106 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
107 #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
108 #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
109 #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
110 #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
111 #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
112 #define ISCSI_FLAG_ON(PduHdr, Flag) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag))
113 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
114 #define ISCSI_GET_CURRENT_STAGE(PduHdr) (((PduHdr)->Flags >> 2) & 0x3)
115 #define ISCSI_GET_NEXT_STAGE(PduHdr) (((PduHdr)->Flags) & 0x3)
117 #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)
118 #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))
120 #define HTON24(Dst, Src) \
122 (Dst)[0] = (UINT8) (((Src) >> 16) & 0xFF); \
123 (Dst)[1] = (UINT8) (((Src) >> 8) & 0xFF); \
124 (Dst)[2] = (UINT8) ((Src) & 0xFF); \
127 #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
129 #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
130 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
135 #define ISCSI_OPCODE_NOP_OUT 0x00
136 #define ISCSI_OPCODE_SCSI_CMD 0x01
137 #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02
138 #define ISCSI_OPCODE_LOGIN_REQ 0x03
139 #define ISCSI_OPCODE_TEXT_REQ 0x04
140 #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05
141 #define ISCSI_OPCODE_LOGOUT_REQ 0x06
142 #define ISCSI_OPCODE_SNACK_REQ 0x10
143 #define ISCSI_OPCODE_VENDOR_I0 0x1c
144 #define ISCSI_OPCODE_VENDOR_I1 0x1d
145 #define ISCSI_OPCODE_VENDOR_I2 0x1e
150 #define ISCSI_OPCODE_NOP_IN 0x20
151 #define ISCSI_OPCODE_SCSI_RSP 0x21
152 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
153 #define ISCSI_OPCODE_LOGIN_RSP 0x23
154 #define ISCSI_OPCODE_TEXT_RSP 0x24
155 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
156 #define ISCSI_OPCODE_LOGOUT_RSP 0x26
157 #define ISCSI_OPCODE_R2T 0x31
158 #define ISCSI_OPCODE_ASYNC_MSG 0x32
159 #define ISCSI_OPCODE_VENDOR_T0 0x3c
160 #define ISCSI_OPCODE_VENDOR_T1 0x3d
161 #define ISCSI_OPCODE_VENDOR_T2 0x3e
162 #define ISCSI_OPCODE_REJECT 0x3f
164 #define ISCSI_BHS_FLAG_FINAL 0x80
167 /// iSCSI Basic Header Segment
169 typedef struct _ISCSI_BASIC_HEADER
{
172 UINT16 OpCodeSpecific1
;
173 UINT8 TotalAHSLength
;
174 UINT8 DataSegmentLength
[3];
176 UINT32 InitiatorTaskTag
;
177 UINT32 OpCodeSpecific2
[7];
178 } ISCSI_BASIC_HEADER
;
181 // Defined AHS types, others are reserved.
183 #define ISCSI_AHS_TYPE_EXT_CDB 0x1
184 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
186 typedef struct _ISCSI_ADDTIONAL_HEADER
{
189 UINT8 TypeSpecific
[1];
190 } ISCSI_ADDITIONAL_HEADER
;
192 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS
{
196 UINT32 ExpReadDataLength
;
197 } ISCSI_BI_EXP_READ_DATA_LEN_AHS
;
199 #define SCSI_CMD_PDU_FLAG_READ 0x40
200 #define SCSI_CMD_PDU_FLAG_WRITE 0x20
202 #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07
207 #define ISCSI_TASK_ATTR_UNTAGGED 0x00
208 #define ISCSI_TASK_ATTR_SIMPLE 0x01
209 #define ISCSI_TASK_ATTR_ORDERD 0x02
210 #define ISCSI_TASK_ATTR_HOQ 0x03
211 #define ISCSI_TASK_ATTR_ACA 0x04
216 typedef struct _SCSI_COMMAND
{
220 UINT8 TotalAHSLength
;
221 UINT8 DataSegmentLength
[3];
223 UINT32 InitiatorTaskTag
;
224 UINT32 ExpDataXferLength
;
231 // flag bit definitions in SCSI response
233 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10
234 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
235 #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04
236 #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02
239 // iSCSI service response codes
241 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00
242 #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01
247 typedef struct _SCSI_RESPONSE
{
252 UINT8 TotalAHSLength
;
253 UINT8 DataSegmentLength
[3];
255 UINT32 InitiatorTaskTag
;
261 UINT32 BiReadResidualCount
;
262 UINT32 ResidualCount
;
265 typedef struct _ISCSI_SENSE_DATA
{
271 /// iSCSI Task Managment Function Request
273 typedef struct _ISCSI_TMF_REQUEST
{
277 UINT8 TotalAHSLength
;
278 UINT8 DataSegmentLength
[3];
280 UINT32 InitiatorTaskTag
;
281 UINT32 ReferencedTaskTag
;
289 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0
290 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1
291 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2
292 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3
293 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
294 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5
295 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6
296 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255
299 /// iSCSI Task Management Function Response
301 typedef struct _ISCSI_TMF_RESPONSE
{
306 UINT8 TotalAHSLength
;
307 UINT8 DataSegmentLength
[3];
309 UINT32 InitiatorTaskTag
;
315 } ISCSI_TMF_RESPONSE
;
320 typedef struct _ISCSI_SCSI_DATA_OUT
{
323 UINT8 TotalAHSLength
;
324 UINT8 DataSegmentLength
[3];
326 UINT32 InitiatorTaskTag
;
327 UINT32 TargetTransferTag
;
334 } ISCSI_SCSI_DATA_OUT
;
336 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40
337 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW
338 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW
339 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01
344 typedef struct _ISCSI_SCSI_DATA_IN
{
349 UINT8 TotalAHSLength
;
350 UINT8 DataSegmentLength
[3];
352 UINT32 InitiatorTaskTag
;
353 UINT32 TargetTransferTag
;
359 UINT32 ResidualCount
;
360 } ISCSI_SCSI_DATA_IN
;
362 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
365 /// Ready To Transfer
367 typedef struct _ISCSI_READY_TO_TRANSFER
{
370 UINT8 TotalAHSLength
;
371 UINT8 DataSegmentLength
[3];
373 UINT32 InitiatorTaskTag
;
374 UINT32 TargetTransferTag
;
380 UINT32 DesiredDataTransferLength
;
381 } ISCSI_READY_TO_TRANSFER
;
383 typedef struct _ISCSI_ASYNC_MESSAGE
{
386 UINT8 TotalAHSLength
;
387 UINT8 DataSegmentLength
[3];
389 UINT32 InitiatorTaskTag
;
400 } ISCSI_ASYNC_MESSAGE
;
402 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80
403 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
408 typedef struct _ISCSI_LOGIN_REQUEST
{
413 UINT8 TotalAHSLength
;
414 UINT8 DataSegmentLength
[3];
417 UINT32 InitiatorTaskTag
;
423 } ISCSI_LOGIN_REQUEST
;
425 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
426 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
428 #define ISCSI_LOGIN_STATUS_SUCCESS 0
429 #define ISCSI_LOGIN_STATUS_REDIRECTION 1
430 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2
431 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3
436 typedef struct _ISCSI_LOGIN_RESPONSE
{
441 UINT8 TotalAHSLength
;
442 UINT8 DataSegmentLength
[3];
445 UINT32 InitiatorTaskTag
;
453 } ISCSI_LOGIN_RESPONSE
;
455 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
456 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
457 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2
462 typedef struct _ISCSI_LOGOUT_REQUEST
{
466 UINT8 TotalAHSLength
;
467 UINT8 DataSegmentLength
[3];
469 UINT32 InitiatorTaskTag
;
475 } ISCSI_LOGOUT_REQUEST
;
477 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0
478 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1
479 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2
480 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3
485 typedef struct _ISCSI_LOGOUT_RESPONSE
{
490 UINT8 TotalAHSLength
;
491 UINT8 DataSegmentLength
[3];
493 UINT32 InitiatorTaskTag
;
502 } ISCSI_LOGOUT_RESPONSE
;
504 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0
505 #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1
506 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2
507 #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3
512 typedef struct _ISCSI_SNACK_REQUEST
{
516 UINT8 TotalAHSLength
;
517 UINT8 DataSegmentLength
[3];
519 UINT32 InitiatorTaskTag
;
520 UINT32 TargetTransferTag
;
526 } ISCSI_SNACK_REQUEST
;
531 typedef struct _ISCSI_REJECT
{
536 UINT8 TotalAHSLength
;
537 UINT8 DataSegmentLength
[3];
539 UINT32 InitiatorTaskTag
;
551 typedef struct _ISCSI_NOP_OUT
{
554 UINT8 TotalAHSLength
;
555 UINT8 DataSegmentLength
[3];
557 UINT32 InitiatorTaskTag
;
558 UINT32 TargetTransferTag
;
567 typedef struct _ISCSI_NOP_IN
{
570 UINT8 TotalAHSLength
;
571 UINT8 DataSegmentLength
[3];
573 UINT32 InitiatorTaskTag
;
574 UINT32 TargetTransferTag
;
581 #define ISCSI_SECURITY_NEGOTIATION 0
582 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
583 #define ISCSI_FULL_FEATURE_PHASE 3
590 typedef struct _ISCSI_XFER_CONTEXT
{
591 UINT32 TargetTransferTag
;
593 UINT32 DesiredLength
;
595 } ISCSI_XFER_CONTEXT
;
597 typedef struct _ISCSI_IN_BUFFER_CONTEXT
{
600 } ISCSI_IN_BUFFER_CONTEXT
;
602 typedef struct _ISCSI_TCB
{
605 BOOLEAN SoFarInOrder
;
607 BOOLEAN FbitReceived
;
612 UINT32 InitiatorTaskTag
;
616 ISCSI_XFER_CONTEXT XferContext
;
618 ISCSI_CONNECTION
*Conn
;
621 typedef struct _ISCSI_KEY_VALUE_PAIR
{
626 } ISCSI_KEY_VALUE_PAIR
;
629 Attach the iSCSI connection to the iSCSI session.
631 @param[in, out] Session The iSCSI session.
632 @param[in, out] Conn The iSCSI connection.
635 IScsiAttatchConnection (
636 IN OUT ISCSI_SESSION
*Session
,
637 IN OUT ISCSI_CONNECTION
*Conn
641 Detach the iSCSI connection from the session it belongs to.
643 @param[in, out] Conn The iSCSI connection.
646 IScsiDetatchConnection (
647 IN OUT ISCSI_CONNECTION
*Conn
651 This function does the iSCSI connection login.
653 @param[in, out] Conn The iSCSI connection to login.
655 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
656 @retval EFI_TIMEOUT Timeout happened during the login procedure.
657 @retval Others Other errors as indicated.
661 IN OUT ISCSI_CONNECTION
*Conn
665 Create a TCP connection for the iSCSI session.
667 @param[in] Private The iSCSI driver data.
668 @param[in] Session Maximum CmdSN from the target.
670 @return The newly created iSCSI connection.
673 IScsiCreateConnection (
674 IN ISCSI_DRIVER_DATA
*Private
,
675 IN ISCSI_SESSION
*Session
679 Destroy an iSCSI connection.
681 @param[in] Conn The connection to destroy.
684 IScsiDestroyConnection (
685 IN ISCSI_CONNECTION
*Conn
689 Login the iSCSI session.
691 @param[in] Private The iSCSI driver data.
693 @retval EFI_SUCCESS The iSCSI session login procedure finished.
694 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
695 @retval Others Other errors as indicated.
699 IN ISCSI_DRIVER_DATA
*Private
703 Build and send the iSCSI login request to the iSCSI target according to
704 the current login stage.
706 @param[in] Conn The connection in the iSCSI login phase.
708 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
710 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
711 @retval EFI_DEVICE_ERROR Some kind of device error happened.
715 IN ISCSI_CONNECTION
*Conn
719 Receive and process the iSCSI login response.
721 @param[in] Conn The connection in the iSCSI login phase.
723 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
724 @retval Others Other errors as indicated.
727 IScsiReceiveLoginRsp (
728 IN ISCSI_CONNECTION
*Conn
732 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
733 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
736 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
738 @param[in] Key The key name string.
739 @param[in] Value The value string.
741 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
742 the correspondence length fields are updated.
743 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
747 IScsiAddKeyValuePair (
754 Prepare the iSCSI login request to be sent according to the current login status.
756 @param[in, out] Conn The connection in the iSCSI login phase.
758 @return The pointer to the net buffer containing the iSCSI login request built.
759 @retval Others Other errors as indicated.
762 IScsiPrepareLoginReq (
763 IN OUT ISCSI_CONNECTION
*Conn
767 Process the iSCSI Login Response.
769 @param[in, out] Conn The connection on which the iSCSI login response is received.
770 @param[in, out] Pdu The iSCSI login response PDU.
772 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
773 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
774 @retval EFI_MEDIA_CHANGED Target is redirected.
775 @retval Others Other errors as indicated.
778 IScsiProcessLoginRsp (
779 IN OUT ISCSI_CONNECTION
*Conn
,
784 Updated the target information according the data received in the iSCSI
785 login response with an target redirection status.
787 @param[in, out] Session The iSCSI session.
788 @param[in] Data The data segment which should contain the
789 TargetAddress key-value list.
790 @param[in] Len Length of the data.
792 @retval EFI_SUCCESS The target address is updated.
793 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
794 @retval EFI_NOT_FOUND The TargetAddress key is not found.
795 @retval Others Other errors as indicated.
798 IScsiUpdateTargetAddress (
799 IN OUT ISCSI_SESSION
*Session
,
805 The callback function to free the net buffer list.
807 @param[in] Arg The opaque parameter.
815 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
816 an optional data segment. The two parts will be put into two blocks of buffers in the
817 net buffer. The digest check will be conducted in this function if needed and the digests
818 will be trimmed from the PDU buffer.
820 @param[in] Conn The iSCSI connection to receive data from.
821 @param[out] Pdu The received iSCSI pdu.
822 @param[in] Context The context used to describe information on the caller provided
823 buffer to receive data segment of the iSCSI pdu, it's optional.
824 @param[in] HeaderDigest Whether there will be header digest received.
825 @param[in] DataDigest Whether there will be data digest.
826 @param[in] TimeoutEvent The timeout event, it's optional.
828 @retval EFI_SUCCESS An iSCSI pdu is received.
829 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
830 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
831 @retval Others Other errors as indicated.
835 IN ISCSI_CONNECTION
*Conn
,
837 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
838 IN BOOLEAN HeaderDigest
,
839 IN BOOLEAN DataDigest
,
840 IN EFI_EVENT TimeoutEvent OPTIONAL
844 Check and get the result of the prameter negotiation.
846 @param[in, out] Conn The connection in iSCSI login.
848 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
849 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
850 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
854 IN OUT ISCSI_CONNECTION
*Conn
858 Fill the oprational prameters.
860 @param[in] Conn The connection in iSCSI login.
861 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
863 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
867 IN ISCSI_CONNECTION
*Conn
,
872 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
874 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
875 @param[in] Len The length of the last semgnet in the PDU.
877 @retval EFI_SUCCESS The segment is padded or no need to pad it.
878 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
888 Build a key-value list from the data segment.
890 @param[in] Data The data segment containing the key-value pairs.
891 @param[in] Len Length of the data segment.
893 @return The key-value list.
894 @retval NULL Other errors as indicated.
897 IScsiBuildKeyValueList (
903 Get the value string by the key name from the key-value list. If found,
904 the key-value entry will be removed from the list.
906 @param[in, out] KeyValueList The key-value list.
907 @param[in] Key The key name to find.
909 @return The value string.
912 IScsiGetValueByKeyFromList (
913 IN OUT LIST_ENTRY
*KeyValueList
,
918 Free the key-value list.
920 @param[in] KeyValueList The key-value list.
923 IScsiFreeKeyValueList (
924 IN LIST_ENTRY
*KeyValueList
928 Normalize the iSCSI name according to RFC.
930 @param[in, out] Name The iSCSI name.
931 @param[in] Len length of the iSCSI name.
933 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
934 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
943 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
945 @param[in] PassThru The EXT SCSI PASS THRU protocol.
946 @param[in] Target The target ID.
947 @param[in] Lun The LUN.
948 @param[in, out] Packet The request packet containing IO request, SCSI command
949 buffer and buffers to read/write.
951 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
953 @retval EFI_DEVICE_ERROR Session state was not as required.
954 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
955 @retval Others Other errors as indicated.
958 IScsiExecuteScsiCommand (
959 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
962 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
966 Reinstate the session on some error.
968 @param[in, out] Private The iSCSI driver data.
970 @retval EFI_SUCCES The session is reinstated from some error.
971 @retval Other Reinstatement failed.
974 IScsiSessionReinstatement (
975 IN OUT ISCSI_DRIVER_DATA
*Private
979 Initialize some session parameters before login.
981 @param[in, out] Session The iSCSI session.
982 @param[in] Recovery Whether the request is from a fresh new start or recovery.
986 IN OUT ISCSI_SESSION
*Session
,
991 Abort the iSCSI session, that is, reset all the connection and free the
994 @param[in, out] Session The iSCSI session.
996 @retval EFI_SUCCES The session is aborted.
1000 IN OUT ISCSI_SESSION
*Session