2 The header file of iSCSI Protocol that defines many specific data structures.
4 Copyright (c) 2004 - 2014, 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_CHECK_MEDIA_LOGIN_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)
46 #define ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)
48 #define ISCSI_KEY_AUTH_METHOD "AuthMethod"
49 #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"
50 #define ISCSI_KEY_DATA_DIGEST "DataDigest"
51 #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"
52 #define ISCSI_KEY_TARGET_NAME "TargetName"
53 #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"
54 #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"
55 #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"
56 #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"
57 #define ISCSI_KEY_INITIAL_R2T "InitialR2T"
58 #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"
59 #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"
60 #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"
61 #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"
62 #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"
63 #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"
64 #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"
65 #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"
66 #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"
67 #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"
68 #define ISCSI_KEY_SESSION_TYPE "SessionType"
69 #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"
71 #define ISCSI_KEY_VALUE_NONE "None"
74 /// connection state for initiator
77 #define CONN_STATE_FREE 0
78 #define CONN_STATE_XPT_WAIT 1
79 #define CONN_STATE_IN_LOGIN 2
80 #define CONN_STATE_LOGGED_IN 3
81 #define CONN_STATE_IN_LOGOUT 4
82 #define CONN_STATE_LOGOUT_REQUESTED 5
83 #define CONN_STATE_CLEANUP_WAIT 6
84 #define CONN_STATE_IN_CLEANUP 7
87 /// session state for initiator
89 #define SESSION_STATE_FREE 0
90 #define SESSION_STATE_LOGGED_IN 1
91 #define SESSION_STATE_FAILED 2
99 #define ISCSI_RESERVED_TAG 0xffffffff
101 #define ISCSI_REQ_IMMEDIATE 0x40
102 #define ISCSI_OPCODE_MASK 0x3F
104 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
105 #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
106 #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
107 #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
108 #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
109 #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
110 #define ISCSI_FLAG_ON(PduHdr, Flag) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag))
111 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
112 #define ISCSI_GET_CURRENT_STAGE(PduHdr) (((PduHdr)->Flags >> 2) & 0x3)
113 #define ISCSI_GET_NEXT_STAGE(PduHdr) (((PduHdr)->Flags) & 0x3)
115 #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)
116 #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))
118 #define HTON24(Dst, Src) \
120 (Dst)[0] = (UINT8) (((Src) >> 16) & 0xFF); \
121 (Dst)[1] = (UINT8) (((Src) >> 8) & 0xFF); \
122 (Dst)[2] = (UINT8) ((Src) & 0xFF); \
125 #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
127 #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
128 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
133 #define ISCSI_OPCODE_NOP_OUT 0x00
134 #define ISCSI_OPCODE_SCSI_CMD 0x01
135 #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02
136 #define ISCSI_OPCODE_LOGIN_REQ 0x03
137 #define ISCSI_OPCODE_TEXT_REQ 0x04
138 #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05
139 #define ISCSI_OPCODE_LOGOUT_REQ 0x06
140 #define ISCSI_OPCODE_SNACK_REQ 0x10
141 #define ISCSI_OPCODE_VENDOR_I0 0x1c
142 #define ISCSI_OPCODE_VENDOR_I1 0x1d
143 #define ISCSI_OPCODE_VENDOR_I2 0x1e
148 #define ISCSI_OPCODE_NOP_IN 0x20
149 #define ISCSI_OPCODE_SCSI_RSP 0x21
150 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
151 #define ISCSI_OPCODE_LOGIN_RSP 0x23
152 #define ISCSI_OPCODE_TEXT_RSP 0x24
153 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
154 #define ISCSI_OPCODE_LOGOUT_RSP 0x26
155 #define ISCSI_OPCODE_R2T 0x31
156 #define ISCSI_OPCODE_ASYNC_MSG 0x32
157 #define ISCSI_OPCODE_VENDOR_T0 0x3c
158 #define ISCSI_OPCODE_VENDOR_T1 0x3d
159 #define ISCSI_OPCODE_VENDOR_T2 0x3e
160 #define ISCSI_OPCODE_REJECT 0x3f
162 #define ISCSI_BHS_FLAG_FINAL 0x80
165 /// iSCSI Basic Header Segment
167 typedef struct _ISCSI_BASIC_HEADER
{
170 UINT16 OpCodeSpecific1
;
171 UINT8 TotalAHSLength
;
172 UINT8 DataSegmentLength
[3];
174 UINT32 InitiatorTaskTag
;
175 UINT32 OpCodeSpecific2
[7];
176 } ISCSI_BASIC_HEADER
;
179 // Defined AHS types, others are reserved.
181 #define ISCSI_AHS_TYPE_EXT_CDB 0x1
182 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
184 typedef struct _ISCSI_ADDTIONAL_HEADER
{
187 UINT8 TypeSpecific
[1];
188 } ISCSI_ADDITIONAL_HEADER
;
190 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS
{
194 UINT32 ExpReadDataLength
;
195 } ISCSI_BI_EXP_READ_DATA_LEN_AHS
;
197 #define SCSI_CMD_PDU_FLAG_READ 0x40
198 #define SCSI_CMD_PDU_FLAG_WRITE 0x20
200 #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07
205 #define ISCSI_TASK_ATTR_UNTAGGED 0x00
206 #define ISCSI_TASK_ATTR_SIMPLE 0x01
207 #define ISCSI_TASK_ATTR_ORDERD 0x02
208 #define ISCSI_TASK_ATTR_HOQ 0x03
209 #define ISCSI_TASK_ATTR_ACA 0x04
214 typedef struct _SCSI_COMMAND
{
218 UINT8 TotalAHSLength
;
219 UINT8 DataSegmentLength
[3];
221 UINT32 InitiatorTaskTag
;
222 UINT32 ExpDataXferLength
;
229 // flag bit definitions in SCSI response
231 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10
232 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
233 #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04
234 #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02
237 // iSCSI service response codes
239 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00
240 #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01
245 typedef struct _SCSI_RESPONSE
{
250 UINT8 TotalAHSLength
;
251 UINT8 DataSegmentLength
[3];
253 UINT32 InitiatorTaskTag
;
259 UINT32 BiReadResidualCount
;
260 UINT32 ResidualCount
;
263 typedef struct _ISCSI_SENSE_DATA
{
269 /// iSCSI Task Managment Function Request
271 typedef struct _ISCSI_TMF_REQUEST
{
275 UINT8 TotalAHSLength
;
276 UINT8 DataSegmentLength
[3];
278 UINT32 InitiatorTaskTag
;
279 UINT32 ReferencedTaskTag
;
287 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0
288 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1
289 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2
290 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3
291 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
292 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5
293 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6
294 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255
297 /// iSCSI Task Management Function Response
299 typedef struct _ISCSI_TMF_RESPONSE
{
304 UINT8 TotalAHSLength
;
305 UINT8 DataSegmentLength
[3];
307 UINT32 InitiatorTaskTag
;
313 } ISCSI_TMF_RESPONSE
;
318 typedef struct _ISCSI_SCSI_DATA_OUT
{
321 UINT8 TotalAHSLength
;
322 UINT8 DataSegmentLength
[3];
324 UINT32 InitiatorTaskTag
;
325 UINT32 TargetTransferTag
;
332 } ISCSI_SCSI_DATA_OUT
;
334 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40
335 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW
336 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW
337 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01
342 typedef struct _ISCSI_SCSI_DATA_IN
{
347 UINT8 TotalAHSLength
;
348 UINT8 DataSegmentLength
[3];
350 UINT32 InitiatorTaskTag
;
351 UINT32 TargetTransferTag
;
357 UINT32 ResidualCount
;
358 } ISCSI_SCSI_DATA_IN
;
360 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
363 /// Ready To Transfer
365 typedef struct _ISCSI_READY_TO_TRANSFER
{
368 UINT8 TotalAHSLength
;
369 UINT8 DataSegmentLength
[3];
371 UINT32 InitiatorTaskTag
;
372 UINT32 TargetTransferTag
;
378 UINT32 DesiredDataTransferLength
;
379 } ISCSI_READY_TO_TRANSFER
;
381 typedef struct _ISCSI_ASYNC_MESSAGE
{
384 UINT8 TotalAHSLength
;
385 UINT8 DataSegmentLength
[3];
387 UINT32 InitiatorTaskTag
;
398 } ISCSI_ASYNC_MESSAGE
;
400 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80
401 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
406 typedef struct _ISCSI_LOGIN_REQUEST
{
411 UINT8 TotalAHSLength
;
412 UINT8 DataSegmentLength
[3];
415 UINT32 InitiatorTaskTag
;
421 } ISCSI_LOGIN_REQUEST
;
423 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
424 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
426 #define ISCSI_LOGIN_STATUS_SUCCESS 0
427 #define ISCSI_LOGIN_STATUS_REDIRECTION 1
428 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2
429 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3
434 typedef struct _ISCSI_LOGIN_RESPONSE
{
439 UINT8 TotalAHSLength
;
440 UINT8 DataSegmentLength
[3];
443 UINT32 InitiatorTaskTag
;
451 } ISCSI_LOGIN_RESPONSE
;
453 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
454 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
455 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2
460 typedef struct _ISCSI_LOGOUT_REQUEST
{
464 UINT8 TotalAHSLength
;
465 UINT8 DataSegmentLength
[3];
467 UINT32 InitiatorTaskTag
;
473 } ISCSI_LOGOUT_REQUEST
;
475 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0
476 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1
477 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2
478 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3
483 typedef struct _ISCSI_LOGOUT_RESPONSE
{
488 UINT8 TotalAHSLength
;
489 UINT8 DataSegmentLength
[3];
491 UINT32 InitiatorTaskTag
;
500 } ISCSI_LOGOUT_RESPONSE
;
502 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0
503 #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1
504 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2
505 #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3
510 typedef struct _ISCSI_SNACK_REQUEST
{
514 UINT8 TotalAHSLength
;
515 UINT8 DataSegmentLength
[3];
517 UINT32 InitiatorTaskTag
;
518 UINT32 TargetTransferTag
;
524 } ISCSI_SNACK_REQUEST
;
529 typedef struct _ISCSI_REJECT
{
534 UINT8 TotalAHSLength
;
535 UINT8 DataSegmentLength
[3];
537 UINT32 InitiatorTaskTag
;
549 typedef struct _ISCSI_NOP_OUT
{
552 UINT8 TotalAHSLength
;
553 UINT8 DataSegmentLength
[3];
555 UINT32 InitiatorTaskTag
;
556 UINT32 TargetTransferTag
;
565 typedef struct _ISCSI_NOP_IN
{
568 UINT8 TotalAHSLength
;
569 UINT8 DataSegmentLength
[3];
571 UINT32 InitiatorTaskTag
;
572 UINT32 TargetTransferTag
;
579 #define ISCSI_SECURITY_NEGOTIATION 0
580 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
581 #define ISCSI_FULL_FEATURE_PHASE 3
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.
633 IScsiAttatchConnection (
634 IN OUT ISCSI_SESSION
*Session
,
635 IN OUT ISCSI_CONNECTION
*Conn
639 Detach the iSCSI connection from the session it belongs to.
641 @param[in, out] Conn The iSCSI connection.
644 IScsiDetatchConnection (
645 IN OUT ISCSI_CONNECTION
*Conn
649 This function does the iSCSI connection login.
651 @param[in, out] Conn The iSCSI connection to login.
653 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
654 @retval EFI_TIMEOUT Timeout happened during the login procedure.
655 @retval Others Other errors as indicated.
659 IN OUT ISCSI_CONNECTION
*Conn
663 Create a TCP connection for the iSCSI session.
665 @param[in] Private The iSCSI driver data.
666 @param[in] Session Maximum CmdSN from the target.
668 @return The newly created iSCSI connection.
671 IScsiCreateConnection (
672 IN ISCSI_DRIVER_DATA
*Private
,
673 IN ISCSI_SESSION
*Session
677 Destroy an iSCSI connection.
679 @param[in] Conn The connection to destroy.
682 IScsiDestroyConnection (
683 IN ISCSI_CONNECTION
*Conn
687 Login the iSCSI session.
689 @param[in] Private The iSCSI driver data.
691 @retval EFI_SUCCESS The iSCSI session login procedure finished.
692 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
693 @retval EFI_NO_MEDIA There was a media error.
694 @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.
816 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
817 an optional data segment. The two parts will be put into two blocks of buffers in the
818 net buffer. The digest check will be conducted in this function if needed and the digests
819 will be trimmed from the PDU buffer.
821 @param[in] Conn The iSCSI connection to receive data from.
822 @param[out] Pdu The received iSCSI pdu.
823 @param[in] Context The context used to describe information on the caller provided
824 buffer to receive data segment of the iSCSI pdu, it's optional.
825 @param[in] HeaderDigest Whether there will be header digest received.
826 @param[in] DataDigest Whether there will be data digest.
827 @param[in] TimeoutEvent The timeout event, it's optional.
829 @retval EFI_SUCCESS An iSCSI pdu is received.
830 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
831 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
832 @retval Others Other errors as indicated.
836 IN ISCSI_CONNECTION
*Conn
,
838 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
839 IN BOOLEAN HeaderDigest
,
840 IN BOOLEAN DataDigest
,
841 IN EFI_EVENT TimeoutEvent OPTIONAL
845 Check and get the result of the prameter negotiation.
847 @param[in, out] Conn The connection in iSCSI login.
849 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
850 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
851 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
855 IN OUT ISCSI_CONNECTION
*Conn
859 Fill the oprational prameters.
861 @param[in] Conn The connection in iSCSI login.
862 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
864 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
868 IN ISCSI_CONNECTION
*Conn
,
873 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
875 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
876 @param[in] Len The length of the last semgnet in the PDU.
878 @retval EFI_SUCCESS The segment is padded or no need to pad it.
879 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
889 Build a key-value list from the data segment.
891 @param[in] Data The data segment containing the key-value pairs.
892 @param[in] Len Length of the data segment.
894 @return The key-value list.
895 @retval NULL Other errors as indicated.
898 IScsiBuildKeyValueList (
904 Get the value string by the key name from the key-value list. If found,
905 the key-value entry will be removed from the list.
907 @param[in, out] KeyValueList The key-value list.
908 @param[in] Key The key name to find.
910 @return The value string.
913 IScsiGetValueByKeyFromList (
914 IN OUT LIST_ENTRY
*KeyValueList
,
919 Free the key-value list.
921 @param[in] KeyValueList The key-value list.
924 IScsiFreeKeyValueList (
925 IN LIST_ENTRY
*KeyValueList
929 Normalize the iSCSI name according to RFC.
931 @param[in, out] Name The iSCSI name.
932 @param[in] Len length of the iSCSI name.
934 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
935 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
944 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
946 @param[in] PassThru The EXT SCSI PASS THRU protocol.
947 @param[in] Target The target ID.
948 @param[in] Lun The LUN.
949 @param[in, out] Packet The request packet containing IO request, SCSI command
950 buffer and buffers to read/write.
952 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
954 @retval EFI_DEVICE_ERROR Session state was not as required.
955 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
956 @retval EFI_NOT_READY The target can not accept new commands.
957 @retval Others Other errors as indicated.
960 IScsiExecuteScsiCommand (
961 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
964 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
968 Reinstate the session on some error.
970 @param[in, out] Private The iSCSI driver data.
972 @retval EFI_SUCCES The session is reinstated from some error.
973 @retval Other Reinstatement failed.
976 IScsiSessionReinstatement (
977 IN OUT ISCSI_DRIVER_DATA
*Private
981 Initialize some session parameters before login.
983 @param[in, out] Session The iSCSI session.
984 @param[in] Recovery Whether the request is from a fresh new start or recovery.
988 IN OUT ISCSI_SESSION
*Session
,
993 Abort the iSCSI session, that is, reset all the connection and free the
996 @param[in, out] Session The iSCSI session.
998 @retval EFI_SUCCES The session is aborted.
1002 IN OUT ISCSI_SESSION
*Session