2 The header file of IScsi Protocol that defines many specific data structures.
4 Copyright (c) 2004 - 2008, 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
84 CONN_STATE_LOGOUT_REQUESTED
,
85 CONN_STATE_CLEANUP_WAIT
,
90 /// session state for initiator
94 SESSION_STATE_LOGGED_IN
,
104 #define ISCSI_RESERVED_TAG 0xffffffff
106 #define ISCSI_REQ_IMMEDIATE 0x40
107 #define ISCSI_OPCODE_MASK 0x3F
109 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
110 #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
111 #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
112 #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
113 #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
114 #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
115 #define ISCSI_FLAG_ON(PduHdr, Flag) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag))
116 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
117 #define ISCSI_GET_CURRENT_STAGE(PduHdr) (((PduHdr)->Flags >> 2) & 0x3)
118 #define ISCSI_GET_NEXT_STAGE(PduHdr) (((PduHdr)->Flags) & 0x3)
120 #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)
121 #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))
123 #define HTON24(Dst, Src) \
125 (Dst)[0] = (UINT8) (((Src) >> 16) & 0xFF); \
126 (Dst)[1] = (UINT8) (((Src) >> 8) & 0xFF); \
127 (Dst)[2] = (UINT8) ((Src) & 0xFF); \
130 #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
132 #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
133 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
138 #define ISCSI_OPCODE_NOP_OUT 0x00
139 #define ISCSI_OPCODE_SCSI_CMD 0x01
140 #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02
141 #define ISCSI_OPCODE_LOGIN_REQ 0x03
142 #define ISCSI_OPCODE_TEXT_REQ 0x04
143 #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05
144 #define ISCSI_OPCODE_LOGOUT_REQ 0x06
145 #define ISCSI_OPCODE_SNACK_REQ 0x10
146 #define ISCSI_OPCODE_VENDOR_I0 0x1c
147 #define ISCSI_OPCODE_VENDOR_I1 0x1d
148 #define ISCSI_OPCODE_VENDOR_I2 0x1e
153 #define ISCSI_OPCODE_NOP_IN 0x20
154 #define ISCSI_OPCODE_SCSI_RSP 0x21
155 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
156 #define ISCSI_OPCODE_LOGIN_RSP 0x23
157 #define ISCSI_OPCODE_TEXT_RSP 0x24
158 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
159 #define ISCSI_OPCODE_LOGOUT_RSP 0x26
160 #define ISCSI_OPCODE_R2T 0x31
161 #define ISCSI_OPCODE_ASYNC_MSG 0x32
162 #define ISCSI_OPCODE_VENDOR_T0 0x3c
163 #define ISCSI_OPCODE_VENDOR_T1 0x3d
164 #define ISCSI_OPCODE_VENDOR_T2 0x3e
165 #define ISCSI_OPCODE_REJECT 0x3f
167 #define ISCSI_BHS_FLAG_FINAL 0x80
170 /// iSCSI Basic Header Segment
172 typedef struct _ISCSI_BASIC_HEADER
{
175 UINT16 OpCodeSpecific1
;
176 UINT8 TotalAHSLength
;
177 UINT8 DataSegmentLength
[3];
179 UINT32 InitiatorTaskTag
;
180 UINT32 OpCodeSpecific2
[7];
181 } ISCSI_BASIC_HEADER
;
184 // Defined AHS types, others are reserved.
186 #define ISCSI_AHS_TYPE_EXT_CDB 0x1
187 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
189 typedef struct _ISCSI_ADDTIONAL_HEADER
{
192 UINT8 TypeSpecific
[1];
193 } ISCSI_ADDITIONAL_HEADER
;
195 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS
{
199 UINT32 ExpReadDataLength
;
200 } ISCSI_BI_EXP_READ_DATA_LEN_AHS
;
202 #define SCSI_CMD_PDU_FLAG_READ 0x40
203 #define SCSI_CMD_PDU_FLAG_WRITE 0x20
205 #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07
210 #define ISCSI_TASK_ATTR_UNTAGGED 0x00
211 #define ISCSI_TASK_ATTR_SIMPLE 0x01
212 #define ISCSI_TASK_ATTR_ORDERD 0x02
213 #define ISCSI_TASK_ATTR_HOQ 0x03
214 #define ISCSI_TASK_ATTR_ACA 0x04
219 typedef struct _SCSI_COMMAND
{
223 UINT8 TotalAHSLength
;
224 UINT8 DataSegmentLength
[3];
226 UINT32 InitiatorTaskTag
;
227 UINT32 ExpDataXferLength
;
234 // flag bit definitions in SCSI response
236 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10
237 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
238 #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04
239 #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02
242 // iSCSI service response codes
244 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00
245 #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01
250 typedef struct _SCSI_RESPONSE
{
255 UINT8 TotalAHSLength
;
256 UINT8 DataSegmentLength
[3];
258 UINT32 InitiatorTaskTag
;
264 UINT32 BiReadResidualCount
;
265 UINT32 ResidualCount
;
268 typedef struct _ISCSI_SENSE_DATA
{
274 /// iSCSI Task Managment Function Request
276 typedef struct _ISCSI_TMF_REQUEST
{
280 UINT8 TotalAHSLength
;
281 UINT8 DataSegmentLength
[3];
283 UINT32 InitiatorTaskTag
;
284 UINT32 ReferencedTaskTag
;
292 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0
293 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1
294 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2
295 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3
296 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
297 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5
298 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6
299 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255
302 /// iSCSI Task Management Function Response
304 typedef struct _ISCSI_TMF_RESPONSE
{
309 UINT8 TotalAHSLength
;
310 UINT8 DataSegmentLength
[3];
312 UINT32 InitiatorTaskTag
;
318 } ISCSI_TMF_RESPONSE
;
323 typedef struct _ISCSI_SCSI_DATA_OUT
{
326 UINT8 TotalAHSLength
;
327 UINT8 DataSegmentLength
[3];
329 UINT32 InitiatorTaskTag
;
330 UINT32 TargetTransferTag
;
337 } ISCSI_SCSI_DATA_OUT
;
339 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40
340 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW
341 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW
342 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01
347 typedef struct _ISCSI_SCSI_DATA_IN
{
352 UINT8 TotalAHSLength
;
353 UINT8 DataSegmentLength
[3];
355 UINT32 InitiatorTaskTag
;
356 UINT32 TargetTransferTag
;
362 UINT32 ResidualCount
;
363 } ISCSI_SCSI_DATA_IN
;
365 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
368 /// Ready To Transfer
370 typedef struct _ISCSI_READY_TO_TRANSFER
{
373 UINT8 TotalAHSLength
;
374 UINT8 DataSegmentLength
[3];
376 UINT32 InitiatorTaskTag
;
377 UINT32 TargetTransferTag
;
383 UINT32 DesiredDataTransferLength
;
384 } ISCSI_READY_TO_TRANSFER
;
386 typedef struct _ISCSI_ASYNC_MESSAGE
{
389 UINT8 TotalAHSLength
;
390 UINT8 DataSegmentLength
[3];
392 UINT32 InitiatorTaskTag
;
403 } ISCSI_ASYNC_MESSAGE
;
405 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80
406 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
411 typedef struct _ISCSI_LOGIN_REQUEST
{
416 UINT8 TotalAHSLength
;
417 UINT8 DataSegmentLength
[3];
420 UINT32 InitiatorTaskTag
;
426 } ISCSI_LOGIN_REQUEST
;
428 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
429 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
431 #define ISCSI_LOGIN_STATUS_SUCCESS 0
432 #define ISCSI_LOGIN_STATUS_REDIRECTION 1
433 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2
434 #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3
439 typedef struct _ISCSI_LOGIN_RESPONSE
{
444 UINT8 TotalAHSLength
;
445 UINT8 DataSegmentLength
[3];
448 UINT32 InitiatorTaskTag
;
456 } ISCSI_LOGIN_RESPONSE
;
458 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
459 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
460 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2
465 typedef struct _ISCSI_LOGOUT_REQUEST
{
469 UINT8 TotalAHSLength
;
470 UINT8 DataSegmentLength
[3];
472 UINT32 InitiatorTaskTag
;
478 } ISCSI_LOGOUT_REQUEST
;
480 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0
481 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1
482 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2
483 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3
488 typedef struct _ISCSI_LOGOUT_RESPONSE
{
493 UINT8 TotalAHSLength
;
494 UINT8 DataSegmentLength
[3];
496 UINT32 InitiatorTaskTag
;
505 } ISCSI_LOGOUT_RESPONSE
;
507 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0
508 #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1
509 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2
510 #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3
515 typedef struct _ISCSI_SNACK_REQUEST
{
519 UINT8 TotalAHSLength
;
520 UINT8 DataSegmentLength
[3];
522 UINT32 InitiatorTaskTag
;
523 UINT32 TargetTransferTag
;
529 } ISCSI_SNACK_REQUEST
;
534 typedef struct _ISCSI_REJECT
{
539 UINT8 TotalAHSLength
;
540 UINT8 DataSegmentLength
[3];
542 UINT32 InitiatorTaskTag
;
554 typedef struct _ISCSI_NOP_OUT
{
557 UINT8 TotalAHSLength
;
558 UINT8 DataSegmentLength
[3];
560 UINT32 InitiatorTaskTag
;
561 UINT32 TargetTransferTag
;
570 typedef struct _ISCSI_NOP_IN
{
573 UINT8 TotalAHSLength
;
574 UINT8 DataSegmentLength
[3];
576 UINT32 InitiatorTaskTag
;
577 UINT32 TargetTransferTag
;
584 #define ISCSI_SECURITY_NEGOTIATION 0
585 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
586 #define ISCSI_FULL_FEATURE_PHASE 3
593 typedef struct _ISCSI_XFER_CONTEXT
{
594 UINT32 TargetTransferTag
;
596 UINT32 DesiredLength
;
598 } ISCSI_XFER_CONTEXT
;
600 typedef struct _ISCSI_IN_BUFFER_CONTEXT
{
603 } ISCSI_IN_BUFFER_CONTEXT
;
605 typedef struct _ISCSI_TCB
{
608 BOOLEAN SoFarInOrder
;
610 BOOLEAN FbitReceived
;
615 UINT32 InitiatorTaskTag
;
619 ISCSI_XFER_CONTEXT XferContext
;
621 ISCSI_CONNECTION
*Conn
;
624 typedef struct _ISCSI_KEY_VALUE_PAIR
{
629 } ISCSI_KEY_VALUE_PAIR
;
632 Attach the iSCSI connection to the iSCSI session.
634 @param[in, out] Session The iSCSI session.
635 @param[in, out] Conn The iSCSI connection.
638 IScsiAttatchConnection (
639 IN OUT ISCSI_SESSION
*Session
,
640 IN OUT ISCSI_CONNECTION
*Conn
644 Detach the iSCSI connection from the session it belongs to.
646 @param[in, out] Conn The iSCSI connection.
649 IScsiDetatchConnection (
650 IN OUT ISCSI_CONNECTION
*Conn
654 This function does the iSCSI connection login.
656 @param[in, out] Conn The iSCSI connection to login.
658 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
659 @retval EFI_TIMEOUT Timeout happened during the login procedure.
660 @retval Others Other errors as indicated.
664 IN OUT ISCSI_CONNECTION
*Conn
668 Create a TCP connection for the iSCSI session.
670 @param[in] Private The iSCSI driver data.
671 @param[in] Session Maximum CmdSN from the target.
673 @return The newly created iSCSI connection.
676 IScsiCreateConnection (
677 IN ISCSI_DRIVER_DATA
*Private
,
678 IN ISCSI_SESSION
*Session
682 Destroy an iSCSI connection.
684 @param[in] Conn The connection to destroy.
687 IScsiDestroyConnection (
688 IN ISCSI_CONNECTION
*Conn
692 Login the iSCSI session.
694 @param[in] Private The iSCSI driver data.
696 @retval EFI_SUCCESS The iSCSI session login procedure finished.
697 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
698 @retval Others Other errors as indicated.
702 IN ISCSI_DRIVER_DATA
*Private
706 Build and send the iSCSI login request to the iSCSI target according to
707 the current login stage.
709 @param[in] Conn The connection in the iSCSI login phase.
711 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
713 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
714 @retval EFI_DEVICE_ERROR Some kind of device error happened.
718 IN ISCSI_CONNECTION
*Conn
722 Receive and process the iSCSI login response.
724 @param[in] Conn The connection in the iSCSI login phase.
726 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
727 @retval Others Other errors as indicated.
730 IScsiReceiveLoginRsp (
731 IN ISCSI_CONNECTION
*Conn
735 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
736 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
739 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
741 @param[in] Key The key name string.
742 @param[in] Value The value string.
744 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
745 the correspondence length fields are updated.
746 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
750 IScsiAddKeyValuePair (
757 Prepare the iSCSI login request to be sent according to the current login status.
759 @param[in, out] Conn The connection in the iSCSI login phase.
761 @return The pointer to the net buffer containing the iSCSI login request built.
762 @retval Others Other errors as indicated.
765 IScsiPrepareLoginReq (
766 IN OUT ISCSI_CONNECTION
*Conn
770 Process the iSCSI Login Response.
772 @param[in, out] Conn The connection on which the iSCSI login response is received.
773 @param[in, out] Pdu The iSCSI login response PDU.
775 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
776 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
777 @retval EFI_MEDIA_CHANGED Target is redirected.
778 @retval Others Other errors as indicated.
781 IScsiProcessLoginRsp (
782 IN OUT ISCSI_CONNECTION
*Conn
,
787 Updated the target information according the data received in the iSCSI
788 login response with an target redirection status.
790 @param[in, out] Session The iSCSI session.
791 @param[in] Data The data segment which should contain the
792 TargetAddress key-value list.
793 @param[in] Len Length of the data.
795 @retval EFI_SUCCESS The target address is updated.
796 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
797 @retval EFI_NOT_FOUND The TargetAddress key is not found.
798 @retval Others Other errors as indicated.
801 IScsiUpdateTargetAddress (
802 IN OUT ISCSI_SESSION
*Session
,
808 The callback function to free the net buffer list.
810 @param[in] Arg The opaque parameter.
818 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
819 an optional data segment. The two parts will be put into two blocks of buffers in the
820 net buffer. The digest check will be conducted in this function if needed and the digests
821 will be trimmed from the PDU buffer.
823 @param[in] Conn The iSCSI connection to receive data from.
824 @param[out] Pdu The received iSCSI pdu.
825 @param[in] Context The context used to describe information on the caller provided
826 buffer to receive data segment of the iSCSI pdu, it's optional.
827 @param[in] HeaderDigest Whether there will be header digest received.
828 @param[in] DataDigest Whether there will be data digest.
829 @param[in] TimeoutEvent The timeout event, it's optional.
831 @retval EFI_SUCCESS An iSCSI pdu is received.
832 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
833 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
834 @retval Others Other errors as indicated.
838 IN ISCSI_CONNECTION
*Conn
,
840 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
841 IN BOOLEAN HeaderDigest
,
842 IN BOOLEAN DataDigest
,
843 IN EFI_EVENT TimeoutEvent OPTIONAL
847 Check and get the result of the prameter negotiation.
849 @param[in, out] Conn The connection in iSCSI login.
851 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
852 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
853 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
857 IN OUT ISCSI_CONNECTION
*Conn
861 Fill the oprational prameters.
863 @param[in] Conn The connection in iSCSI login.
864 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
866 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
870 IN ISCSI_CONNECTION
*Conn
,
875 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
877 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
878 @param[in] Len The length of the last semgnet in the PDU.
880 @retval EFI_SUCCESS The segment is padded or no need to pad it.
881 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
891 Build a key-value list from the data segment.
893 @param[in] Data The data segment containing the key-value pairs.
894 @param[in] Len Length of the data segment.
896 @return The key-value list.
897 @retval NULL Other errors as indicated.
900 IScsiBuildKeyValueList (
906 Get the value string by the key name from the key-value list. If found,
907 the key-value entry will be removed from the list.
909 @param[in, out] KeyValueList The key-value list.
910 @param[in] Key The key name to find.
912 @return The value string.
915 IScsiGetValueByKeyFromList (
916 IN OUT LIST_ENTRY
*KeyValueList
,
921 Free the key-value list.
923 @param[in] KeyValueList The key-value list.
926 IScsiFreeKeyValueList (
927 IN LIST_ENTRY
*KeyValueList
931 Normalize the iSCSI name according to RFC.
933 @param[in, out] Name The iSCSI name.
934 @param[in] Len length of the iSCSI name.
936 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
937 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
946 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
948 @param[in] PassThru The EXT SCSI PASS THRU protocol.
949 @param[in] Target The target ID.
950 @param[in] Lun The LUN.
951 @param[in, out] Packet The request packet containing IO request, SCSI command
952 buffer and buffers to read/write.
954 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
956 @retval EFI_DEVICE_ERROR Session state was not as required.
957 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
958 @retval Others Other errors as indicated.
961 IScsiExecuteScsiCommand (
962 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
965 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
969 Reinstate the session on some error.
971 @param[in, out] Private The iSCSI driver data.
973 @retval EFI_SUCCES The session is reinstated from some error.
974 @retval Other Reinstatement failed.
977 IScsiSessionReinstatement (
978 IN OUT ISCSI_DRIVER_DATA
*Private
982 Initialize some session parameters before login.
984 @param[in, out] Session The iSCSI session.
985 @param[in] Recovery Whether the request is from a fresh new start or recovery.
989 IN OUT ISCSI_SESSION
*Session
,
994 Abort the iSCSI session, that is, reset all the connection and free the
997 @param[in, out] Session The iSCSI session.
999 @retval EFI_SUCCES The session is aborted.
1003 IN OUT ISCSI_SESSION
*Session