2 The implementation of iSCSI protocol based on RFC3720.
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 #include "IScsiImpl.h"
17 UINT32 mDataSegPad
= 0;
20 Attach the iSCSI connection to the iSCSI session.
22 @param[in, out] Session The iSCSI session.
23 @param[in, out] Conn The iSCSI connection.
27 IScsiAttatchConnection (
28 IN OUT ISCSI_SESSION
*Session
,
29 IN OUT ISCSI_CONNECTION
*Conn
32 InsertTailList (&Session
->Conns
, &Conn
->Link
);
33 Conn
->Session
= Session
;
38 Detach the iSCSI connection from the session it belongs to.
40 @param[in, out] Conn The iSCSI connection.
44 IScsiDetatchConnection (
45 IN OUT ISCSI_CONNECTION
*Conn
48 RemoveEntryList (&Conn
->Link
);
49 Conn
->Session
->NumConns
--;
55 Check the sequence number according to RFC3720.
57 @param[in, out] ExpSN The currently expected sequence number.
58 @param[in] NewSN The sequence number to check.
60 @retval EFI_SUCCESS The check passed and the ExpSN is increased.
61 @retval EFI_NOT_READY Response was sent due to a retransmission request.
62 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
71 if (!ISCSI_SEQ_EQ (NewSN
, *ExpSN
)) {
72 if (ISCSI_SEQ_LT (NewSN
, *ExpSN
)) {
78 return EFI_PROTOCOL_ERROR
;
91 Update the sequence numbers for the iSCSI command.
93 @param[in, out] Session The iSCSI session.
94 @param[in] MaxCmdSN Maximum CmdSN from the target.
95 @param[in] ExpCmdSN Next expected CmdSN from the target.
100 IN OUT ISCSI_SESSION
*Session
,
105 if (ISCSI_SEQ_LT (MaxCmdSN
, ExpCmdSN
- 1)) {
109 if (ISCSI_SEQ_GT (MaxCmdSN
, Session
->MaxCmdSN
)) {
110 Session
->MaxCmdSN
= MaxCmdSN
;
113 if (ISCSI_SEQ_GT (ExpCmdSN
, Session
->ExpCmdSN
)) {
114 Session
->ExpCmdSN
= ExpCmdSN
;
120 This function does the iSCSI connection login.
122 @param[in, out] Conn The iSCSI connection to login.
123 @param Timeout The timeout value in millisecond.
125 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
126 @retval EFI_TIMEOUT Timeout occurred during the login procedure.
127 @retval Others Other errors as indicated.
132 IN OUT ISCSI_CONNECTION
*Conn
,
139 // Start the timer, and wait Timeout seconds to establish the TCP connection.
141 Status
= gBS
->SetTimer (Conn
->TimeoutEvent
, TimerRelative
, Timeout
* TICKS_PER_MS
);
142 if (EFI_ERROR (Status
)) {
147 // Try to establish the tcp connection.
149 Status
= TcpIoConnect (&Conn
->TcpIo
, Conn
->TimeoutEvent
);
150 gBS
->SetTimer (Conn
->TimeoutEvent
, TimerCancel
, 0);
152 if (EFI_ERROR (Status
)) {
156 Conn
->State
= CONN_STATE_IN_LOGIN
;
159 // Connection is established, start the iSCSI Login.
162 Status
= IScsiSendLoginReq (Conn
);
163 if (EFI_ERROR (Status
)) {
167 Status
= IScsiReceiveLoginRsp (Conn
);
168 if (EFI_ERROR (Status
)) {
171 } while (Conn
->CurrentStage
!= ISCSI_FULL_FEATURE_PHASE
);
178 Reset the iSCSI connection.
180 @param[in, out] Conn The iSCSI connection to reset.
185 IN OUT ISCSI_CONNECTION
*Conn
188 TcpIoReset (&Conn
->TcpIo
);
193 Create a TCP connection for the iSCSI session.
195 @param[in] Session Points to the iSCSI session.
197 @return The newly created iSCSI connection.
201 IScsiCreateConnection (
202 IN ISCSI_SESSION
*Session
205 ISCSI_DRIVER_DATA
*Private
;
206 ISCSI_SESSION_CONFIG_NVDATA
*NvData
;
207 ISCSI_CONNECTION
*Conn
;
208 TCP_IO_CONFIG_DATA TcpIoConfig
;
209 TCP4_IO_CONFIG_DATA
*Tcp4IoConfig
;
210 TCP6_IO_CONFIG_DATA
*Tcp6IoConfig
;
213 Private
= Session
->Private
;
214 NvData
= &Session
->ConfigData
->SessionConfigData
;
216 Conn
= AllocateZeroPool (sizeof (ISCSI_CONNECTION
));
221 Conn
->Signature
= ISCSI_CONNECTION_SIGNATURE
;
222 Conn
->State
= CONN_STATE_FREE
;
223 Conn
->CurrentStage
= ISCSI_SECURITY_NEGOTIATION
;
224 Conn
->NextStage
= ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
;
225 Conn
->AuthStep
= ISCSI_AUTH_INITIAL
;
227 Conn
->PartialReqSent
= FALSE
;
228 Conn
->PartialRspRcvd
= FALSE
;
229 Conn
->ParamNegotiated
= FALSE
;
230 Conn
->Cid
= Session
->NextCid
++;
231 Conn
->Ipv6Flag
= NvData
->IpMode
== IP_MODE_IP6
|| Session
->ConfigData
->AutoConfigureMode
== IP_MODE_AUTOCONFIG_IP6
;
233 Status
= gBS
->CreateEvent (
240 if (EFI_ERROR (Status
)) {
245 NetbufQueInit (&Conn
->RspQue
);
248 // Set the default connection-only parameters.
250 Conn
->MaxRecvDataSegmentLength
= DEFAULT_MAX_RECV_DATA_SEG_LEN
;
251 Conn
->HeaderDigest
= IScsiDigestNone
;
252 Conn
->DataDigest
= IScsiDigestNone
;
254 if (!Conn
->Ipv6Flag
) {
255 Tcp4IoConfig
= &TcpIoConfig
.Tcp4IoConfigData
;
257 CopyMem (&Tcp4IoConfig
->LocalIp
, &NvData
->LocalIp
, sizeof (EFI_IPv4_ADDRESS
));
258 CopyMem (&Tcp4IoConfig
->SubnetMask
, &NvData
->SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
259 CopyMem (&Tcp4IoConfig
->Gateway
, &NvData
->Gateway
, sizeof (EFI_IPv4_ADDRESS
));
260 CopyMem (&Tcp4IoConfig
->RemoteIp
, &NvData
->TargetIp
, sizeof (EFI_IPv4_ADDRESS
));
262 Tcp4IoConfig
->RemotePort
= NvData
->TargetPort
;
263 Tcp4IoConfig
->ActiveFlag
= TRUE
;
264 Tcp4IoConfig
->StationPort
= 0;
266 Tcp6IoConfig
= &TcpIoConfig
.Tcp6IoConfigData
;
268 CopyMem (&Tcp6IoConfig
->RemoteIp
, &NvData
->TargetIp
, sizeof (EFI_IPv6_ADDRESS
));
269 Tcp6IoConfig
->RemotePort
= NvData
->TargetPort
;
270 Tcp6IoConfig
->ActiveFlag
= TRUE
;
271 Tcp6IoConfig
->StationPort
= 0;
275 // Create the TCP IO for this connection.
277 Status
= TcpIoCreateSocket (
280 (UINT8
) (!Conn
->Ipv6Flag
? TCP_VERSION_4
: TCP_VERSION_6
),
284 if (EFI_ERROR (Status
)) {
285 gBS
->CloseEvent (Conn
->TimeoutEvent
);
295 Destroy an iSCSI connection.
297 @param[in] Conn The connection to destroy.
301 IScsiDestroyConnection (
302 IN ISCSI_CONNECTION
*Conn
305 TcpIoDestroySocket (&Conn
->TcpIo
);
307 NetbufQueFlush (&Conn
->RspQue
);
308 gBS
->CloseEvent (Conn
->TimeoutEvent
);
313 Retrieve the IPv6 Address/Prefix/Gateway from the established TCP connection, these informations
314 will be filled in the iSCSI Boot Firmware Table.
316 @param[in] Conn The connection used in the iSCSI login phase.
318 @retval EFI_SUCCESS Get the NIC information successfully.
319 @retval Others Other errors as indicated.
324 IN ISCSI_CONNECTION
*Conn
327 ISCSI_SESSION_CONFIG_NVDATA
*NvData
;
328 EFI_TCP6_PROTOCOL
*Tcp6
;
329 EFI_IP6_MODE_DATA Ip6ModeData
;
331 EFI_IPv6_ADDRESS
*TargetIp
;
333 UINT8 SubnetPrefixLength
;
336 NvData
= &Conn
->Session
->ConfigData
->SessionConfigData
;
337 TargetIp
= &NvData
->TargetIp
.v6
;
338 Tcp6
= Conn
->TcpIo
.Tcp
.Tcp6
;
340 ZeroMem (&Ip6ModeData
, sizeof (EFI_IP6_MODE_DATA
));
341 Status
= Tcp6
->GetModeData (
349 if (EFI_ERROR (Status
)) {
353 if (!Ip6ModeData
.IsConfigured
) {
354 Status
= EFI_ABORTED
;
358 IP6_COPY_ADDRESS (&NvData
->LocalIp
, &Ip6ModeData
.ConfigData
.StationAddress
);
360 NvData
->PrefixLength
= 0;
361 for (Index
= 0; Index
< Ip6ModeData
.AddressCount
; Index
++) {
362 if (EFI_IP6_EQUAL (&NvData
->LocalIp
.v6
, &Ip6ModeData
.AddressList
[Index
].Address
)) {
363 NvData
->PrefixLength
= Ip6ModeData
.AddressList
[Index
].PrefixLength
;
368 SubnetPrefixLength
= 0;
369 RouteEntry
= Ip6ModeData
.RouteCount
;
370 for (Index
= 0; Index
< Ip6ModeData
.RouteCount
; Index
++) {
371 if (NetIp6IsNetEqual (TargetIp
, &Ip6ModeData
.RouteTable
[Index
].Destination
, Ip6ModeData
.RouteTable
[Index
].PrefixLength
)) {
372 if (SubnetPrefixLength
< Ip6ModeData
.RouteTable
[Index
].PrefixLength
) {
373 SubnetPrefixLength
= Ip6ModeData
.RouteTable
[Index
].PrefixLength
;
378 if (RouteEntry
!= Ip6ModeData
.RouteCount
) {
379 IP6_COPY_ADDRESS (&NvData
->Gateway
, &Ip6ModeData
.RouteTable
[RouteEntry
].Gateway
);
383 if (Ip6ModeData
.AddressList
!= NULL
) {
384 FreePool (Ip6ModeData
.AddressList
);
386 if (Ip6ModeData
.GroupTable
!= NULL
) {
387 FreePool (Ip6ModeData
.GroupTable
);
389 if (Ip6ModeData
.RouteTable
!= NULL
) {
390 FreePool (Ip6ModeData
.RouteTable
);
392 if (Ip6ModeData
.NeighborCache
!= NULL
) {
393 FreePool (Ip6ModeData
.NeighborCache
);
395 if (Ip6ModeData
.PrefixTable
!= NULL
) {
396 FreePool (Ip6ModeData
.PrefixTable
);
398 if (Ip6ModeData
.IcmpTypeList
!= NULL
) {
399 FreePool (Ip6ModeData
.IcmpTypeList
);
406 Login the iSCSI session.
408 @param[in] Session The iSCSI session.
410 @retval EFI_SUCCESS The iSCSI session login procedure finished.
411 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
412 @retval EFI_NO_MEDIA There was a media error.
413 @retval Others Other errors as indicated.
418 IN ISCSI_SESSION
*Session
422 ISCSI_CONNECTION
*Conn
;
424 EFI_GUID
*ProtocolGuid
;
426 BOOLEAN MediaPresent
;
429 // Check media status before session login.
432 NetLibDetectMedia (Session
->Private
->Controller
, &MediaPresent
);
438 // Set session identifier
440 CopyMem (Session
->Isid
, Session
->ConfigData
->SessionConfigData
.IsId
, 6);
446 // Create a connection for the session.
448 Conn
= IScsiCreateConnection (Session
);
450 return EFI_OUT_OF_RESOURCES
;
453 IScsiAttatchConnection (Session
, Conn
);
456 // Login througth the newly created connection.
458 Status
= IScsiConnLogin (Conn
, Session
->ConfigData
->SessionConfigData
.ConnectTimeout
);
459 if (EFI_ERROR (Status
)) {
460 IScsiConnReset (Conn
);
461 IScsiDetatchConnection (Conn
);
462 IScsiDestroyConnection (Conn
);
465 if (Status
!= EFI_TIMEOUT
) {
470 } while (RetryCount
<= Session
->ConfigData
->SessionConfigData
.ConnectRetryCount
);
472 if (!EFI_ERROR (Status
)) {
473 Session
->State
= SESSION_STATE_LOGGED_IN
;
475 if (!Conn
->Ipv6Flag
) {
476 ProtocolGuid
= &gEfiTcp4ProtocolGuid
;
478 ProtocolGuid
= &gEfiTcp6ProtocolGuid
;
481 Status
= gBS
->OpenProtocol (
485 Session
->Private
->Image
,
486 Session
->Private
->ExtScsiPassThruHandle
,
487 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
490 ASSERT_EFI_ERROR (Status
);
492 if (Conn
->Ipv6Flag
) {
493 Status
= IScsiGetIp6NicInfo (Conn
);
502 Wait for IPsec negotiation, then try to login the iSCSI session again.
504 @param[in] Session The iSCSI session.
506 @retval EFI_SUCCESS The iSCSI session login procedure finished.
507 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
508 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
512 IScsiSessionReLogin (
513 IN ISCSI_SESSION
*Session
518 EFI_STATUS TimerStatus
;
521 Status
= gBS
->CreateEvent (EVT_TIMER
, TPL_CALLBACK
, NULL
, NULL
, &Timer
);
522 if (EFI_ERROR (Status
)) {
526 Status
= gBS
->SetTimer (
529 ISCSI_WAIT_IPSEC_TIMEOUT
532 if (EFI_ERROR (Status
)) {
533 gBS
->CloseEvent (Timer
);
539 TimerStatus
= gBS
->CheckEvent (Timer
);
541 if (!EFI_ERROR (TimerStatus
)) {
542 Status
= IScsiSessionLogin (Session
);
545 } while (TimerStatus
== EFI_NOT_READY
);
547 gBS
->CloseEvent (Timer
);
553 Build and send the iSCSI login request to the iSCSI target according to
554 the current login stage.
556 @param[in] Conn The connection in the iSCSI login phase.
558 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
560 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
561 @retval EFI_DEVICE_ERROR Some kind of device error occurred.
566 IN ISCSI_CONNECTION
*Conn
573 // Build the Login Request PDU.
575 Pdu
= IScsiPrepareLoginReq (Conn
);
577 return EFI_DEVICE_ERROR
;
580 // Send it to the iSCSI target.
582 Status
= TcpIoTransmit (&Conn
->TcpIo
, Pdu
);
591 Receive and process the iSCSI login response.
593 @param[in] Conn The connection in the iSCSI login phase.
595 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
596 @retval Others Other errors as indicated.
600 IScsiReceiveLoginRsp (
601 IN ISCSI_CONNECTION
*Conn
610 // Receive the iSCSI login response.
612 Status
= IScsiReceivePdu (Conn
, &Pdu
, NULL
, FALSE
, FALSE
, NULL
);
613 if (EFI_ERROR (Status
)) {
616 ASSERT (Pdu
!= NULL
);
619 // A Login Response is received; process it.
621 Status
= IScsiProcessLoginRsp (Conn
, Pdu
);
630 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
631 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
634 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
636 @param[in] Key The key name string.
637 @param[in] Value The value string.
639 @retval EFI_SUCCESS The key-value pair is added to the PDU's data segment and
640 the correspondence length fields are updated.
641 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
643 @retval EFI_PROTOCOL_ERROR There is no such data in the net buffer.
646 IScsiAddKeyValuePair (
656 ISCSI_LOGIN_REQUEST
*LoginReq
;
659 LoginReq
= (ISCSI_LOGIN_REQUEST
*) NetbufGetByte (Pdu
, 0, NULL
);
660 if (LoginReq
== NULL
) {
661 return EFI_PROTOCOL_ERROR
;
663 DataSegLen
= NTOH24 (LoginReq
->DataSegmentLength
);
665 KeyLen
= (UINT32
) AsciiStrLen (Key
);
666 ValueLen
= (UINT32
) AsciiStrLen (Value
);
669 // 1 byte for the key value separator '=' and 1 byte for the null
670 // delimiter after the value.
672 TotalLen
= KeyLen
+ 1 + ValueLen
+ 1;
675 // Allocate the space for the key-value pair.
677 Data
= (CHAR8
*) NetbufAllocSpace (Pdu
, TotalLen
, NET_BUF_TAIL
);
679 return EFI_OUT_OF_RESOURCES
;
684 CopyMem (Data
, Key
, KeyLen
);
693 CopyMem (Data
, Value
, ValueLen
);
699 // Update the DataSegmentLength
701 ISCSI_SET_DATASEG_LEN (LoginReq
, DataSegLen
+ TotalLen
);
708 Prepare the iSCSI login request to be sent according to the current login status.
710 @param[in, out] Conn The connection in the iSCSI login phase.
712 @return The pointer to the net buffer containing the iSCSI login request built.
713 @retval NULL Other errors as indicated.
717 IScsiPrepareLoginReq (
718 IN OUT ISCSI_CONNECTION
*Conn
721 ISCSI_SESSION
*Session
;
723 ISCSI_LOGIN_REQUEST
*LoginReq
;
726 Session
= Conn
->Session
;
728 Nbuf
= NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST
) + DEFAULT_MAX_RECV_DATA_SEG_LEN
);
733 LoginReq
= (ISCSI_LOGIN_REQUEST
*) NetbufAllocSpace (Nbuf
, sizeof (ISCSI_LOGIN_REQUEST
), NET_BUF_TAIL
);
734 ASSERT (LoginReq
!= NULL
);
735 ZeroMem (LoginReq
, sizeof (ISCSI_LOGIN_REQUEST
));
738 // Init the login request pdu
740 ISCSI_SET_OPCODE (LoginReq
, ISCSI_OPCODE_LOGIN_REQ
, ISCSI_REQ_IMMEDIATE
);
741 ISCSI_SET_STAGES (LoginReq
, Conn
->CurrentStage
, Conn
->NextStage
);
742 LoginReq
->VersionMax
= ISCSI_VERSION_MAX
;
743 LoginReq
->VersionMin
= ISCSI_VERSION_MIN
;
744 LoginReq
->Tsih
= HTONS (Session
->Tsih
);
745 LoginReq
->InitiatorTaskTag
= HTONL (Session
->InitiatorTaskTag
);
746 LoginReq
->Cid
= HTONS (Conn
->Cid
);
747 LoginReq
->CmdSN
= HTONL (Session
->CmdSN
);
750 // For the first Login Request on a coonection this is ExpStatSN for the
751 // old connection, and this field is only valid if the Login Request restarts
753 // For subsequent Login Requests it is used to acknowledge the Login Responses
754 // with their increasing StatSN values.
756 LoginReq
->ExpStatSN
= HTONL (Conn
->ExpStatSN
);
757 CopyMem (LoginReq
->Isid
, Session
->Isid
, sizeof (LoginReq
->Isid
));
759 if (Conn
->PartialRspRcvd
) {
761 // A partial response. The initiator must send an empty Login Request.
766 Status
= EFI_SUCCESS
;
768 switch (Conn
->CurrentStage
) {
769 case ISCSI_SECURITY_NEGOTIATION
:
771 // Both none authentication and CHAP authentication share the CHAP path.
774 if (Session
->AuthType
!= ISCSI_AUTH_TYPE_KRB
) {
775 Status
= IScsiCHAPToSendReq (Conn
, Nbuf
);
780 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
:
782 // Only negotiate the paramter once.
784 if (!Conn
->ParamNegotiated
) {
785 IScsiFillOpParams (Conn
, Nbuf
);
788 ISCSI_SET_FLAG (LoginReq
, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
);
793 // An error occurs...
795 Status
= EFI_DEVICE_ERROR
;
799 if (EFI_ERROR (Status
)) {
804 // Pad the data segment if needed.
806 IScsiPadSegment (Nbuf
, ISCSI_GET_DATASEG_LEN (LoginReq
));
808 // Check whether we will issue the stage transition signal?
810 Conn
->TransitInitiated
= ISCSI_FLAG_ON (LoginReq
, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
);
818 Process the iSCSI Login Response.
820 @param[in, out] Conn The connection on which the iSCSI login response is received.
821 @param[in, out] Pdu The iSCSI login response PDU.
823 @retval EFI_SUCCESS The iSCSI login response PDU is processed, and all checks are passed.
824 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
825 @retval EFI_MEDIA_CHANGED Target is redirected.
826 @retval Others Other errors as indicated.
830 IScsiProcessLoginRsp (
831 IN OUT ISCSI_CONNECTION
*Conn
,
836 ISCSI_SESSION
*Session
;
837 ISCSI_LOGIN_RESPONSE
*LoginRsp
;
845 Status
= EFI_SUCCESS
;
846 Session
= Conn
->Session
;
848 LoginRsp
= (ISCSI_LOGIN_RESPONSE
*) NetbufGetByte (Pdu
, 0, NULL
);
849 if (LoginRsp
== NULL
) {
850 return EFI_PROTOCOL_ERROR
;
852 if (!ISCSI_CHECK_OPCODE (LoginRsp
, ISCSI_OPCODE_LOGIN_RSP
)) {
854 // It is not a Login Response.
856 return EFI_PROTOCOL_ERROR
;
859 // Get the data segment, if any.
861 DataSegLen
= ISCSI_GET_DATASEG_LEN (LoginRsp
);
862 if (DataSegLen
!= 0) {
863 DataSeg
= NetbufGetByte (Pdu
, sizeof (ISCSI_LOGIN_RESPONSE
), NULL
);
868 // Check the status class in the login response PDU.
870 switch (LoginRsp
->StatusClass
) {
871 case ISCSI_LOGIN_STATUS_SUCCESS
:
873 // Just break here; the response and the data segment will be processed later.
877 case ISCSI_LOGIN_STATUS_REDIRECTION
:
879 // The target may be moved to a different address.
881 if (DataSeg
== NULL
) {
882 return EFI_PROTOCOL_ERROR
;
885 // Process the TargetAddress key-value strings in the data segment to update the
886 // target address info.
888 Status
= IScsiUpdateTargetAddress (Session
, (CHAR8
*) DataSeg
, DataSegLen
);
889 if (EFI_ERROR (Status
)) {
893 // Session will be restarted on this error status because the Target is
894 // redirected by this Login Response.
896 return EFI_MEDIA_CHANGED
;
900 // Initiator Error, Target Error, or any other undefined error code.
902 return EFI_PROTOCOL_ERROR
;
905 // The status is success; extract the wanted fields from the header segment.
907 Transit
= ISCSI_FLAG_ON (LoginRsp
, ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT
);
908 Continue
= ISCSI_FLAG_ON (LoginRsp
, ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE
);
910 CurrentStage
= ISCSI_GET_CURRENT_STAGE (LoginRsp
);
911 NextStage
= ISCSI_GET_NEXT_STAGE (LoginRsp
);
913 LoginRsp
->InitiatorTaskTag
= NTOHL (LoginRsp
->InitiatorTaskTag
);
915 if ((Transit
&& Continue
) ||
916 (CurrentStage
!= Conn
->CurrentStage
) ||
917 (!Conn
->TransitInitiated
&& Transit
) ||
918 (Transit
&& (NextStage
!= Conn
->NextStage
)) ||
919 (CompareMem (Session
->Isid
, LoginRsp
->Isid
, sizeof (LoginRsp
->Isid
)) != 0) ||
920 (LoginRsp
->InitiatorTaskTag
!= Session
->InitiatorTaskTag
)
923 // A Login Response with the C bit set to 1 MUST have the T bit set to 0.
924 // The CSG in the Login Response MUST be the same with the I-end of this connection.
925 // The T bit can't be 1 if the last Login Response sent by the initiator doesn't
926 // initiate the transistion.
927 // The NSG MUST be the same with the I-end of this connection if Transit is required.
928 // The ISID in the Login Response MUST be the same with this session.
930 return EFI_PROTOCOL_ERROR
;
933 LoginRsp
->StatSN
= NTOHL (LoginRsp
->StatSN
);
934 LoginRsp
->ExpCmdSN
= NTOHL (LoginRsp
->ExpCmdSN
);
935 LoginRsp
->MaxCmdSN
= NTOHL (LoginRsp
->MaxCmdSN
);
937 if ((Conn
->CurrentStage
== ISCSI_SECURITY_NEGOTIATION
) && (Conn
->AuthStep
== ISCSI_AUTH_INITIAL
)) {
939 // If the Login Request is a leading Login Request, the target MUST use
940 // the value presented in CmdSN as the target value for ExpCmdSN.
942 if ((Session
->State
== SESSION_STATE_FREE
) && (Session
->CmdSN
!= LoginRsp
->ExpCmdSN
)) {
943 return EFI_PROTOCOL_ERROR
;
947 // It's the initial Login Response, initialize the local ExpStatSN, MaxCmdSN
950 Conn
->ExpStatSN
= LoginRsp
->StatSN
+ 1;
951 Session
->MaxCmdSN
= LoginRsp
->MaxCmdSN
;
952 Session
->ExpCmdSN
= LoginRsp
->ExpCmdSN
;
955 // Check the StatSN of this PDU.
957 Status
= IScsiCheckSN (&Conn
->ExpStatSN
, LoginRsp
->StatSN
);
958 if (!EFI_ERROR (Status
)) {
960 // Update the MaxCmdSN and ExpCmdSN.
962 IScsiUpdateCmdSN (Session
, LoginRsp
->MaxCmdSN
, LoginRsp
->ExpCmdSN
);
968 // Trim off the header segment.
970 NetbufTrim (Pdu
, sizeof (ISCSI_LOGIN_RESPONSE
), NET_BUF_HEAD
);
973 // Queue this login response first in case it's a partial response so that
974 // later when the full response list is received we can combine these scattered
975 // responses' data segment and then process it.
978 NetbufQueAppend (&Conn
->RspQue
, Pdu
);
980 Conn
->PartialRspRcvd
= Continue
;
983 // It is a partial response; must wait for another or more Request/Response
984 // conversations to get the full response.
989 switch (CurrentStage
) {
990 case ISCSI_SECURITY_NEGOTIATION
:
992 // In security negotiation stage, let CHAP module handle it.
994 if (Session
->AuthType
!= ISCSI_AUTH_TYPE_KRB
) {
995 Status
= IScsiCHAPOnRspReceived (Conn
);
999 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
:
1001 // Response received with negotiation response on iSCSI parameters: check them.
1003 Status
= IScsiCheckOpParams (Conn
);
1004 if (!EFI_ERROR (Status
)) {
1005 Conn
->ParamNegotiated
= TRUE
;
1012 // Should never get here.
1014 Status
= EFI_PROTOCOL_ERROR
;
1018 if (Transit
&& (Status
== EFI_SUCCESS
)) {
1020 // Do the state transition.
1022 Conn
->CurrentStage
= Conn
->NextStage
;
1024 if (Conn
->CurrentStage
== ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
) {
1025 Conn
->NextStage
= ISCSI_FULL_FEATURE_PHASE
;
1028 // CurrentStage is iSCSI Full Feature. It is the Login-Final Response;
1029 // get the TSIH from the Login Response.
1031 Session
->Tsih
= NTOHS (LoginRsp
->Tsih
);
1035 // Flush the response(s) received.
1037 NetbufQueFlush (&Conn
->RspQue
);
1044 Updated the target information according the data received in the iSCSI
1045 login response with an target redirection status.
1047 @param[in, out] Session The iSCSI session.
1048 @param[in] Data The data segment that should contain the
1049 TargetAddress key-value list.
1050 @param[in] Len Length of the data.
1052 @retval EFI_SUCCESS The target address is updated.
1053 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1054 @retval EFI_NOT_FOUND The TargetAddress key is not found.
1055 @retval Others Other errors as indicated.
1059 IScsiUpdateTargetAddress (
1060 IN OUT ISCSI_SESSION
*Session
,
1065 LIST_ENTRY
*KeyValueList
;
1066 CHAR8
*TargetAddress
;
1072 KeyValueList
= IScsiBuildKeyValueList (Data
, Len
);
1073 if (KeyValueList
== NULL
) {
1074 return EFI_OUT_OF_RESOURCES
;
1077 Status
= EFI_NOT_FOUND
;
1080 TargetAddress
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_ADDRESS
);
1081 if (TargetAddress
== NULL
) {
1085 if (!NET_IS_DIGIT (TargetAddress
[0])) {
1087 // The domainname of the target may be presented in three formats: a DNS host name,
1088 // a dotted-decimal IPv4 address, or a bracketed IPv6 address. Only accept dotted
1094 IpStr
= TargetAddress
;
1096 while ((*TargetAddress
!= 0) && (*TargetAddress
!= ':') && (*TargetAddress
!= ',')) {
1098 // NULL, ':', or ',' ends the IPv4 string.
1103 if (*TargetAddress
== ',') {
1105 // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent
1106 // as the result of a redirection.
1109 } else if (*TargetAddress
== ':') {
1110 *TargetAddress
= '\0';
1114 Number
= AsciiStrDecimalToUintn (TargetAddress
);
1115 if (Number
> 0xFFFF) {
1118 Session
->ConfigData
->SessionConfigData
.TargetPort
= (UINT16
) Number
;
1122 // The string only contains the IPv4 address. Use the well-known port.
1124 Session
->ConfigData
->SessionConfigData
.TargetPort
= ISCSI_WELL_KNOWN_PORT
;
1127 // Update the target IP address.
1129 if (Session
->ConfigData
->SessionConfigData
.IpMode
< IP_MODE_AUTOCONFIG
) {
1130 IpMode
= Session
->ConfigData
->SessionConfigData
.IpMode
;
1132 IpMode
= Session
->ConfigData
->AutoConfigureMode
;
1135 Status
= IScsiAsciiStrToIp (
1138 &Session
->ConfigData
->SessionConfigData
.TargetIp
1141 if (EFI_ERROR (Status
)) {
1148 IScsiFreeKeyValueList (KeyValueList
);
1155 The callback function to free the net buffer list.
1157 @param[in] Arg The opaque parameter.
1166 ASSERT (Arg
!= NULL
);
1168 NetbufFreeList ((LIST_ENTRY
*) Arg
);
1174 The callback function called in NetBufFree; it does nothing.
1176 @param[in] Arg The opaque parameter.
1189 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
1190 an optional data segment. The two parts will be put into two blocks of buffers in the
1191 net buffer. The digest check will be conducted in this function if needed and the digests
1192 will be trimmed from the PDU buffer.
1194 @param[in] Conn The iSCSI connection to receive data from.
1195 @param[out] Pdu The received iSCSI pdu.
1196 @param[in] Context The context used to describe information on the caller provided
1197 buffer to receive data segment of the iSCSI pdu. It is optional.
1198 @param[in] HeaderDigest Whether there will be header digest received.
1199 @param[in] DataDigest Whether there will be data digest.
1200 @param[in] TimeoutEvent The timeout event. It is optional.
1202 @retval EFI_SUCCESS An iSCSI pdu is received.
1203 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1204 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
1205 @retval Others Other errors as indicated.
1210 IN ISCSI_CONNECTION
*Conn
,
1212 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
1213 IN BOOLEAN HeaderDigest
,
1214 IN BOOLEAN DataDigest
,
1215 IN EFI_EVENT TimeoutEvent OPTIONAL
1218 LIST_ENTRY
*NbufList
;
1224 UINT32 InDataOffset
;
1225 NET_FRAGMENT Fragment
[2];
1226 UINT32 FragmentCount
;
1228 UINT32 PadAndCRC32
[2];
1230 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
1231 if (NbufList
== NULL
) {
1232 return EFI_OUT_OF_RESOURCES
;
1235 InitializeListHead (NbufList
);
1238 // The header digest will be received together with the PDU header, if exists.
1240 Len
= sizeof (ISCSI_BASIC_HEADER
) + (HeaderDigest
? sizeof (UINT32
) : 0);
1241 PduHdr
= NetbufAlloc (Len
);
1242 if (PduHdr
== NULL
) {
1243 Status
= EFI_OUT_OF_RESOURCES
;
1247 Header
= NetbufAllocSpace (PduHdr
, Len
, NET_BUF_TAIL
);
1248 ASSERT (Header
!= NULL
);
1249 InsertTailList (NbufList
, &PduHdr
->List
);
1252 // First step, receive the BHS of the PDU.
1254 Status
= TcpIoReceive (&Conn
->TcpIo
, PduHdr
, FALSE
, TimeoutEvent
);
1256 if (EFI_ERROR (Status
)) {
1262 // TODO: check the header-digest.
1265 // Trim off the digest.
1267 NetbufTrim (PduHdr
, sizeof (UINT32
), NET_BUF_TAIL
);
1270 Len
= ISCSI_GET_DATASEG_LEN (Header
);
1278 // Get the length of the padding bytes of the data segment.
1280 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1282 switch (ISCSI_GET_OPCODE (Header
)) {
1283 case ISCSI_OPCODE_SCSI_DATA_IN
:
1285 // To reduce memory copy overhead, try to use the buffer described by Context
1286 // if the PDU is an iSCSI SCSI data.
1288 InDataOffset
= ISCSI_GET_BUFFER_OFFSET (Header
);
1289 if ((Context
== NULL
) || ((InDataOffset
+ Len
) > Context
->InDataLen
)) {
1290 Status
= EFI_PROTOCOL_ERROR
;
1294 Fragment
[0].Len
= Len
;
1295 Fragment
[0].Bulk
= Context
->InData
+ InDataOffset
;
1297 if (DataDigest
|| (PadLen
!= 0)) {
1299 // The data segment is padded. Use two fragments to receive it:
1300 // the first to receive the useful data; the second to receive the padding.
1302 Fragment
[1].Len
= PadLen
+ (DataDigest
? sizeof (UINT32
) : 0);
1303 Fragment
[1].Bulk
= (UINT8
*)PadAndCRC32
+ (4 - PadLen
);
1310 DataSeg
= NetbufFromExt (&Fragment
[0], FragmentCount
, 0, 0, IScsiNbufExtFree
, NULL
);
1311 if (DataSeg
== NULL
) {
1312 Status
= EFI_OUT_OF_RESOURCES
;
1318 case ISCSI_OPCODE_SCSI_RSP
:
1319 case ISCSI_OPCODE_NOP_IN
:
1320 case ISCSI_OPCODE_LOGIN_RSP
:
1321 case ISCSI_OPCODE_TEXT_RSP
:
1322 case ISCSI_OPCODE_ASYNC_MSG
:
1323 case ISCSI_OPCODE_REJECT
:
1324 case ISCSI_OPCODE_VENDOR_T0
:
1325 case ISCSI_OPCODE_VENDOR_T1
:
1326 case ISCSI_OPCODE_VENDOR_T2
:
1328 // Allocate buffer to receive the data segment.
1330 Len
+= PadLen
+ (DataDigest
? sizeof (UINT32
) : 0);
1331 DataSeg
= NetbufAlloc (Len
);
1332 if (DataSeg
== NULL
) {
1333 Status
= EFI_OUT_OF_RESOURCES
;
1337 NetbufAllocSpace (DataSeg
, Len
, NET_BUF_TAIL
);
1341 Status
= EFI_PROTOCOL_ERROR
;
1345 InsertTailList (NbufList
, &DataSeg
->List
);
1348 // Receive the data segment with the data digest, if any.
1350 Status
= TcpIoReceive (&Conn
->TcpIo
, DataSeg
, FALSE
, TimeoutEvent
);
1352 if (EFI_ERROR (Status
)) {
1358 // TODO: Check the data digest.
1360 NetbufTrim (DataSeg
, sizeof (UINT32
), NET_BUF_TAIL
);
1365 // Trim off the padding bytes in the data segment.
1367 NetbufTrim (DataSeg
, PadLen
, NET_BUF_TAIL
);
1372 // Form the pdu from a list of pdu segments.
1374 *Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
1376 Status
= EFI_OUT_OF_RESOURCES
;
1381 if (EFI_ERROR (Status
)) {
1383 // Free the Nbufs in this NbufList and the NbufList itself.
1385 IScsiFreeNbufList (NbufList
);
1393 Check and get the result of the parameter negotiation.
1395 @param[in, out] Conn The connection in iSCSI login.
1397 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
1398 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
1399 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1403 IScsiCheckOpParams (
1404 IN OUT ISCSI_CONNECTION
*Conn
1408 LIST_ENTRY
*KeyValueList
;
1411 ISCSI_SESSION
*Session
;
1415 ASSERT (Conn
->RspQue
.BufNum
!= 0);
1417 Session
= Conn
->Session
;
1419 Len
= Conn
->RspQue
.BufSize
;
1420 Data
= AllocatePool (Len
);
1422 return EFI_OUT_OF_RESOURCES
;
1425 NetbufQueCopy (&Conn
->RspQue
, 0, Len
, (UINT8
*) Data
);
1427 Status
= EFI_PROTOCOL_ERROR
;
1430 // Extract the Key-Value pairs into a list.
1432 KeyValueList
= IScsiBuildKeyValueList (Data
, Len
);
1433 if (KeyValueList
== NULL
) {
1440 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_HEADER_DIGEST
);
1441 if (Value
== NULL
) {
1445 if (AsciiStrCmp (Value
, "CRC32") == 0) {
1446 if (Conn
->HeaderDigest
!= IScsiDigestCRC32
) {
1449 } else if (AsciiStrCmp (Value
, ISCSI_KEY_VALUE_NONE
) == 0) {
1450 Conn
->HeaderDigest
= IScsiDigestNone
;
1457 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_DIGEST
);
1458 if (Value
== NULL
) {
1462 if (AsciiStrCmp (Value
, "CRC32") == 0) {
1463 if (Conn
->DataDigest
!= IScsiDigestCRC32
) {
1466 } else if (AsciiStrCmp (Value
, ISCSI_KEY_VALUE_NONE
) == 0) {
1467 Conn
->DataDigest
= IScsiDigestNone
;
1472 // ErrorRecoveryLevel: result fuction is Minimum.
1474 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_ERROR_RECOVERY_LEVEL
);
1475 if (Value
== NULL
) {
1479 NumericValue
= IScsiNetNtoi (Value
);
1480 if (NumericValue
> 2) {
1484 Session
->ErrorRecoveryLevel
= (UINT8
) MIN (Session
->ErrorRecoveryLevel
, NumericValue
);
1487 // InitialR2T: result function is OR.
1489 if (!Session
->InitialR2T
) {
1490 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_INITIAL_R2T
);
1491 if (Value
== NULL
) {
1495 Session
->InitialR2T
= (BOOLEAN
) (AsciiStrCmp (Value
, "Yes") == 0);
1499 // ImmediateData: result function is AND.
1501 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_IMMEDIATE_DATA
);
1502 if (Value
== NULL
) {
1506 Session
->ImmediateData
= (BOOLEAN
) (Session
->ImmediateData
&& (BOOLEAN
) (AsciiStrCmp (Value
, "Yes") == 0));
1509 // MaxRecvDataSegmentLength is declarative.
1511 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH
);
1512 if (Value
!= NULL
) {
1513 Conn
->MaxRecvDataSegmentLength
= (UINT32
) IScsiNetNtoi (Value
);
1516 // MaxBurstLength: result funtion is Mininum.
1518 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_BURST_LENGTH
);
1519 if (Value
== NULL
) {
1523 NumericValue
= IScsiNetNtoi (Value
);
1524 Session
->MaxBurstLength
= (UINT32
) MIN (Session
->MaxBurstLength
, NumericValue
);
1527 // FirstBurstLength: result function is Minimum. Irrelevant when InitialR2T=Yes and
1528 // ImmediateData=No.
1530 if (!(Session
->InitialR2T
&& !Session
->ImmediateData
)) {
1531 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_FIRST_BURST_LENGTH
);
1532 if (Value
== NULL
) {
1536 NumericValue
= IScsiNetNtoi (Value
);
1537 Session
->FirstBurstLength
= (UINT32
) MIN (Session
->FirstBurstLength
, NumericValue
);
1541 // MaxConnections: result function is Minimum.
1543 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_CONNECTIONS
);
1544 if (Value
== NULL
) {
1548 NumericValue
= IScsiNetNtoi (Value
);
1549 if ((NumericValue
== 0) || (NumericValue
> 65535)) {
1553 Session
->MaxConnections
= (UINT32
) MIN (Session
->MaxConnections
, NumericValue
);
1556 // DataPDUInOrder: result function is OR.
1558 if (!Session
->DataPDUInOrder
) {
1559 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_PDU_IN_ORDER
);
1560 if (Value
== NULL
) {
1564 Session
->DataPDUInOrder
= (BOOLEAN
) (AsciiStrCmp (Value
, "Yes") == 0);
1568 // DataSequenceInorder: result function is OR.
1570 if (!Session
->DataSequenceInOrder
) {
1571 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
);
1572 if (Value
== NULL
) {
1576 Session
->DataSequenceInOrder
= (BOOLEAN
) (AsciiStrCmp (Value
, "Yes") == 0);
1580 // DefaultTime2Wait: result function is Maximum.
1582 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DEFAULT_TIME2WAIT
);
1583 if (Value
== NULL
) {
1587 NumericValue
= IScsiNetNtoi (Value
);
1588 if (NumericValue
== 0) {
1589 Session
->DefaultTime2Wait
= 0;
1590 } else if (NumericValue
> 3600) {
1593 Session
->DefaultTime2Wait
= (UINT32
) MAX (Session
->DefaultTime2Wait
, NumericValue
);
1596 // DefaultTime2Retain: result function is Minimum.
1598 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DEFAULT_TIME2RETAIN
);
1599 if (Value
== NULL
) {
1603 NumericValue
= IScsiNetNtoi (Value
);
1604 if (NumericValue
== 0) {
1605 Session
->DefaultTime2Retain
= 0;
1606 } else if (NumericValue
> 3600) {
1609 Session
->DefaultTime2Retain
= (UINT32
) MIN (Session
->DefaultTime2Retain
, NumericValue
);
1612 // MaxOutstandingR2T: result function is Minimum.
1614 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_OUTSTANDING_R2T
);
1615 if (Value
== NULL
) {
1619 NumericValue
= IScsiNetNtoi (Value
);
1620 if ((NumericValue
== 0) || (NumericValue
> 65535)) {
1624 Session
->MaxOutstandingR2T
= (UINT16
) MIN (Session
->MaxOutstandingR2T
, NumericValue
);
1627 // Remove declarative key-value pairs, if any.
1629 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_SESSION_TYPE
);
1630 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_ALIAS
);
1631 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG
);
1635 // Remove the key-value that may not needed for result function is OR.
1637 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_INITIAL_R2T
);
1638 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_PDU_IN_ORDER
);
1639 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
);
1642 // Remove irrelevant parameter, if any.
1644 if (Session
->InitialR2T
&& !Session
->ImmediateData
) {
1645 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_FIRST_BURST_LENGTH
);
1648 if (IsListEmpty (KeyValueList
)) {
1650 // Succeed if no more keys in the list.
1652 Status
= EFI_SUCCESS
;
1657 IScsiFreeKeyValueList (KeyValueList
);
1666 Fill the operational parameters.
1668 @param[in] Conn The connection in iSCSI login.
1669 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
1674 IN ISCSI_CONNECTION
*Conn
,
1678 ISCSI_SESSION
*Session
;
1681 Session
= Conn
->Session
;
1683 AsciiSPrint (Value
, sizeof (Value
), "%a", (Conn
->HeaderDigest
== IScsiDigestCRC32
) ? "None,CRC32" : "None");
1684 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_HEADER_DIGEST
, Value
);
1686 AsciiSPrint (Value
, sizeof (Value
), "%a", (Conn
->DataDigest
== IScsiDigestCRC32
) ? "None,CRC32" : "None");
1687 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_DIGEST
, Value
);
1689 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->ErrorRecoveryLevel
);
1690 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_ERROR_RECOVERY_LEVEL
, Value
);
1692 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->InitialR2T
? "Yes" : "No");
1693 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_INITIAL_R2T
, Value
);
1695 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->ImmediateData
? "Yes" : "No");
1696 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_IMMEDIATE_DATA
, Value
);
1698 AsciiSPrint (Value
, sizeof (Value
), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP
);
1699 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH
, Value
);
1701 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxBurstLength
);
1702 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_BURST_LENGTH
, Value
);
1704 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->FirstBurstLength
);
1705 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_FIRST_BURST_LENGTH
, Value
);
1707 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxConnections
);
1708 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_CONNECTIONS
, Value
);
1710 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->DataPDUInOrder
? "Yes" : "No");
1711 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_PDU_IN_ORDER
, Value
);
1713 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->DataSequenceInOrder
? "Yes" : "No");
1714 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
, Value
);
1716 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->DefaultTime2Wait
);
1717 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DEFAULT_TIME2WAIT
, Value
);
1719 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->DefaultTime2Retain
);
1720 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DEFAULT_TIME2RETAIN
, Value
);
1722 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxOutstandingR2T
);
1723 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_OUTSTANDING_R2T
, Value
);
1728 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1730 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
1731 @param[in] Len The length of the last segment in the PDU.
1733 @retval EFI_SUCCESS The segment is padded or there is no need to pad it.
1734 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1739 IN OUT NET_BUF
*Pdu
,
1746 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1749 Data
= NetbufAllocSpace (Pdu
, PadLen
, NET_BUF_TAIL
);
1751 return EFI_OUT_OF_RESOURCES
;
1754 ZeroMem (Data
, PadLen
);
1762 Build a key-value list from the data segment.
1764 @param[in] Data The data segment containing the key-value pairs.
1765 @param[in] Len Length of the data segment.
1767 @return The key-value list.
1768 @retval NULL Other errors as indicated.
1772 IScsiBuildKeyValueList (
1777 LIST_ENTRY
*ListHead
;
1778 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1780 ListHead
= AllocatePool (sizeof (LIST_ENTRY
));
1781 if (ListHead
== NULL
) {
1785 InitializeListHead (ListHead
);
1788 KeyValuePair
= AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR
));
1789 if (KeyValuePair
== NULL
) {
1793 InitializeListHead (&KeyValuePair
->List
);
1795 KeyValuePair
->Key
= Data
;
1797 while ((Len
> 0) && (*Data
!= '=')) {
1808 FreePool (KeyValuePair
);
1812 KeyValuePair
->Value
= Data
;
1814 InsertTailList (ListHead
, &KeyValuePair
->List
);;
1816 Data
+= AsciiStrLen (KeyValuePair
->Value
) + 1;
1817 Len
-= (UINT32
) AsciiStrLen (KeyValuePair
->Value
) + 1;
1824 IScsiFreeKeyValueList (ListHead
);
1831 Get the value string by the key name from the key-value list. If found,
1832 the key-value entry will be removed from the list.
1834 @param[in, out] KeyValueList The key-value list.
1835 @param[in] Key The key name to find.
1837 @return The value string.
1838 @retval NULL The key value pair cannot be found.
1842 IScsiGetValueByKeyFromList (
1843 IN OUT LIST_ENTRY
*KeyValueList
,
1848 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1853 NET_LIST_FOR_EACH (Entry
, KeyValueList
) {
1854 KeyValuePair
= NET_LIST_USER_STRUCT (Entry
, ISCSI_KEY_VALUE_PAIR
, List
);
1856 if (AsciiStrCmp (KeyValuePair
->Key
, Key
) == 0) {
1857 Value
= KeyValuePair
->Value
;
1859 RemoveEntryList (&KeyValuePair
->List
);
1860 FreePool (KeyValuePair
);
1870 Free the key-value list.
1872 @param[in] KeyValueList The key-value list.
1876 IScsiFreeKeyValueList (
1877 IN LIST_ENTRY
*KeyValueList
1881 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1883 while (!IsListEmpty (KeyValueList
)) {
1884 Entry
= NetListRemoveHead (KeyValueList
);
1885 KeyValuePair
= NET_LIST_USER_STRUCT (Entry
, ISCSI_KEY_VALUE_PAIR
, List
);
1887 FreePool (KeyValuePair
);
1890 FreePool (KeyValueList
);
1895 Normalize the iSCSI name according to RFC.
1897 @param[in, out] Name The iSCSI name.
1898 @param[in] Len Length of the iSCSI name.
1900 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1901 @retval EFI_PROTOCOL_ERROR The iSCSI name is malformatted or not in the IQN format.
1905 IScsiNormalizeName (
1912 for (Index
= 0; Index
< Len
; Index
++) {
1913 if (NET_IS_UPPER_CASE_CHAR (Name
[Index
])) {
1915 // Convert the upper-case characters to lower-case ones.
1917 Name
[Index
] = (CHAR8
) (Name
[Index
] - 'A' + 'a');
1920 if (!NET_IS_LOWER_CASE_CHAR (Name
[Index
]) &&
1921 !NET_IS_DIGIT (Name
[Index
]) &&
1922 (Name
[Index
] != '-') &&
1923 (Name
[Index
] != '.') &&
1924 (Name
[Index
] != ':')
1927 // ASCII dash, dot, colon lower-case characters and digit characters
1930 return EFI_PROTOCOL_ERROR
;
1934 if ((Len
< 4) || (CompareMem (Name
, "iqn.", 4) != 0)) {
1936 // Only IQN format is accepted now.
1938 return EFI_PROTOCOL_ERROR
;
1946 Create an iSCSI task control block.
1948 @param[in] Conn The connection on which the task control block will be created.
1949 @param[out] Tcb The newly created task control block.
1951 @retval EFI_SUCCESS The task control block is created.
1952 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1953 @retval EFI_NOT_READY The target cannot accept new commands.
1958 IN ISCSI_CONNECTION
*Conn
,
1962 ISCSI_SESSION
*Session
;
1965 ASSERT (Tcb
!= NULL
);
1967 Session
= Conn
->Session
;
1969 if (ISCSI_SEQ_GT (Session
->CmdSN
, Session
->MaxCmdSN
)) {
1970 return EFI_NOT_READY
;
1973 NewTcb
= AllocateZeroPool (sizeof (ISCSI_TCB
));
1974 if (NewTcb
== NULL
) {
1975 return EFI_OUT_OF_RESOURCES
;
1978 InitializeListHead (&NewTcb
->Link
);
1980 NewTcb
->SoFarInOrder
= TRUE
;
1981 NewTcb
->InitiatorTaskTag
= Session
->InitiatorTaskTag
;
1982 NewTcb
->CmdSN
= Session
->CmdSN
;
1983 NewTcb
->Conn
= Conn
;
1985 InsertTailList (&Session
->TcbList
, &NewTcb
->Link
);
1988 // Advance the initiator task tag.
1990 Session
->InitiatorTaskTag
++;
2000 Delete the tcb from the connection and destroy it.
2002 @param[in] Tcb The tcb to delete.
2010 RemoveEntryList (&Tcb
->Link
);
2017 Find the task control block by the initator task tag.
2019 @param[in] TcbList The tcb list.
2020 @param[in] InitiatorTaskTag The initiator task tag.
2022 @return The task control block found.
2023 @retval NULL The task control block cannot be found.
2028 IN LIST_ENTRY
*TcbList
,
2029 IN UINT32 InitiatorTaskTag
2037 NET_LIST_FOR_EACH (Entry
, TcbList
) {
2038 Tcb
= NET_LIST_USER_STRUCT (Entry
, ISCSI_TCB
, Link
);
2040 if (Tcb
->InitiatorTaskTag
== InitiatorTaskTag
) {
2050 Create a data segment, pad it, and calculate the CRC if needed.
2052 @param[in] Data The data to fill into the data segment.
2053 @param[in] Len Length of the data.
2054 @param[in] DataDigest Whether to calculate CRC for this data segment.
2056 @return The net buffer wrapping the data segment.
2060 IScsiNewDataSegment (
2063 IN BOOLEAN DataDigest
2066 NET_FRAGMENT Fragment
[2];
2067 UINT32 FragmentCount
;
2071 Fragment
[0].Len
= Len
;
2072 Fragment
[0].Bulk
= Data
;
2074 PadLen
= ISCSI_GET_PAD_LEN (Len
);
2076 Fragment
[1].Len
= PadLen
;
2077 Fragment
[1].Bulk
= (UINT8
*) &mDataSegPad
;
2084 DataSeg
= NetbufFromExt (&Fragment
[0], FragmentCount
, 0, 0, IScsiNbufExtFree
, NULL
);
2091 Create a iSCSI SCSI command PDU to encapsulate the command issued
2092 by SCSI through the EXT SCSI PASS THRU Protocol.
2094 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
2095 @param[in] Lun The LUN.
2096 @param[in] Tcb The tcb assocated with this SCSI command.
2098 @return The created iSCSI SCSI command PDU.
2099 @retval NULL Other errors as indicated.
2103 IScsiNewScsiCmdPdu (
2104 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
2109 LIST_ENTRY
*NbufList
;
2113 SCSI_COMMAND
*ScsiCmd
;
2116 ISCSI_ADDITIONAL_HEADER
*Header
;
2117 ISCSI_BI_EXP_READ_DATA_LEN_AHS
*BiExpReadDataLenAHS
;
2118 ISCSI_SESSION
*Session
;
2119 UINT32 ImmediateDataLen
;
2123 if (Packet
->DataDirection
== DataBi
) {
2125 // Bidirectional Read/Write command, the bidirectional expected
2126 // read data length AHS is required.
2128 AHSLength
+= sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS
);
2131 if (Packet
->CdbLength
> 16) {
2133 // The CDB exceeds 16 bytes. An extended CDB AHS is required.
2135 AHSLength
= (UINT8
) (AHSLength
+ ISCSI_ROUNDUP (Packet
->CdbLength
- 16) + sizeof (ISCSI_ADDITIONAL_HEADER
));
2138 Length
= sizeof (SCSI_COMMAND
) + AHSLength
;
2139 PduHeader
= NetbufAlloc (Length
);
2140 if (PduHeader
== NULL
) {
2144 ScsiCmd
= (SCSI_COMMAND
*) NetbufAllocSpace (PduHeader
, Length
, NET_BUF_TAIL
);
2145 if (ScsiCmd
== NULL
) {
2146 NetbufFree (PduHeader
);
2149 Header
= (ISCSI_ADDITIONAL_HEADER
*) (ScsiCmd
+ 1);
2151 ZeroMem (ScsiCmd
, Length
);
2153 ISCSI_SET_OPCODE (ScsiCmd
, ISCSI_OPCODE_SCSI_CMD
, 0);
2154 ISCSI_SET_FLAG (ScsiCmd
, ISCSI_TASK_ATTR_SIMPLE
);
2157 // Set the READ/WRITE flags according to the IO type of this request.
2159 switch (Packet
->DataDirection
) {
2161 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_READ
);
2162 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->InTransferLength
);
2166 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_WRITE
);
2167 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->OutTransferLength
);
2171 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_READ
| SCSI_CMD_PDU_FLAG_WRITE
);
2172 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->OutTransferLength
);
2175 // Fill the bidirectional expected read data length AHS.
2177 BiExpReadDataLenAHS
= (ISCSI_BI_EXP_READ_DATA_LEN_AHS
*) Header
;
2178 Header
= (ISCSI_ADDITIONAL_HEADER
*) (BiExpReadDataLenAHS
+ 1);
2180 BiExpReadDataLenAHS
->Length
= NTOHS (5);
2181 BiExpReadDataLenAHS
->Type
= ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN
;
2182 BiExpReadDataLenAHS
->ExpReadDataLength
= NTOHL (Packet
->InTransferLength
);
2187 ScsiCmd
->TotalAHSLength
= AHSLength
;
2188 CopyMem (ScsiCmd
->Lun
, &Lun
, sizeof (ScsiCmd
->Lun
));
2189 ScsiCmd
->InitiatorTaskTag
= NTOHL (Tcb
->InitiatorTaskTag
);
2190 ScsiCmd
->CmdSN
= NTOHL (Tcb
->CmdSN
);
2191 ScsiCmd
->ExpStatSN
= NTOHL (Tcb
->Conn
->ExpStatSN
);
2193 CopyMem (ScsiCmd
->Cdb
, Packet
->Cdb
, sizeof (ScsiCmd
->Cdb
));
2195 if (Packet
->CdbLength
> 16) {
2196 Header
->Length
= NTOHS ((UINT16
) (Packet
->CdbLength
- 15));
2197 Header
->Type
= ISCSI_AHS_TYPE_EXT_CDB
;
2199 CopyMem (Header
+ 1, (UINT8
*) Packet
->Cdb
+ 16, Packet
->CdbLength
- 16);
2203 Session
= Tcb
->Conn
->Session
;
2204 ImmediateDataLen
= 0;
2206 if (Session
->ImmediateData
&& (Packet
->OutTransferLength
!= 0)) {
2208 // Send immediate data in this SCSI Command PDU. The length of the immeidate
2209 // data is the minimum of FirstBurstLength, the data length to be xfered, and
2210 // the MaxRecvdataSegmentLength on this connection.
2212 ImmediateDataLen
= MIN (Session
->FirstBurstLength
, Packet
->OutTransferLength
);
2213 ImmediateDataLen
= MIN (ImmediateDataLen
, Tcb
->Conn
->MaxRecvDataSegmentLength
);
2216 // Update the data segment length in the PDU header.
2218 ISCSI_SET_DATASEG_LEN (ScsiCmd
, ImmediateDataLen
);
2221 // Create the data segment.
2223 DataSeg
= IScsiNewDataSegment ((UINT8
*) Packet
->OutDataBuffer
, ImmediateDataLen
, FALSE
);
2224 if (DataSeg
== NULL
) {
2225 NetbufFree (PduHeader
);
2230 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
2231 if (NbufList
== NULL
) {
2232 NetbufFree (PduHeader
);
2233 NetbufFree (DataSeg
);
2239 InitializeListHead (NbufList
);
2240 InsertTailList (NbufList
, &PduHeader
->List
);
2241 InsertTailList (NbufList
, &DataSeg
->List
);
2243 Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
2245 IScsiFreeNbufList (NbufList
);
2249 if (Session
->InitialR2T
||
2250 (ImmediateDataLen
== Session
->FirstBurstLength
) ||
2251 (ImmediateDataLen
== Packet
->OutTransferLength
)
2254 // Unsolicited data out sequence is not allowed,
2255 // or FirstBustLength data is already sent out by immediate data,
2256 // or all the OUT data accompany this SCSI packet are sent as
2257 // immediate data. The final flag should be set on this SCSI Command
2260 ISCSI_SET_FLAG (ScsiCmd
, ISCSI_BHS_FLAG_FINAL
);
2270 Create a new iSCSI SCSI Data Out PDU.
2272 @param[in] Data The data to put into the Data Out PDU.
2273 @param[in] Len Length of the data.
2274 @param[in] DataSN The DataSN of the Data Out PDU.
2275 @param[in] Tcb The task control block of this Data Out PDU.
2276 @param[in] Lun The LUN.
2278 @return The net buffer wrapping the Data Out PDU.
2279 @retval NULL Other errors as indicated.
2283 IScsiNewDataOutPdu (
2291 LIST_ENTRY
*NbufList
;
2295 ISCSI_SCSI_DATA_OUT
*DataOutHdr
;
2296 ISCSI_XFER_CONTEXT
*XferContext
;
2298 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
2299 if (NbufList
== NULL
) {
2303 InitializeListHead (NbufList
);
2306 // Allocate memory for the BHS.
2308 PduHdr
= NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT
));
2309 if (PduHdr
== NULL
) {
2310 FreePool (NbufList
);
2314 // Insert the BHS into the buffer list.
2316 InsertTailList (NbufList
, &PduHdr
->List
);
2318 DataOutHdr
= (ISCSI_SCSI_DATA_OUT
*) NetbufAllocSpace (PduHdr
, sizeof (ISCSI_SCSI_DATA_OUT
), NET_BUF_TAIL
);
2319 ASSERT (DataOutHdr
!= NULL
);
2320 XferContext
= &Tcb
->XferContext
;
2322 ZeroMem (DataOutHdr
, sizeof (ISCSI_SCSI_DATA_OUT
));
2325 // Set the flags and fields of the Data Out PDU BHS.
2327 ISCSI_SET_OPCODE (DataOutHdr
, ISCSI_OPCODE_SCSI_DATA_OUT
, 0);
2328 ISCSI_SET_DATASEG_LEN (DataOutHdr
, Len
);
2330 DataOutHdr
->InitiatorTaskTag
= HTONL (Tcb
->InitiatorTaskTag
);
2331 DataOutHdr
->TargetTransferTag
= HTONL (XferContext
->TargetTransferTag
);
2332 DataOutHdr
->ExpStatSN
= HTONL (Tcb
->Conn
->ExpStatSN
);
2333 DataOutHdr
->DataSN
= HTONL (DataSN
);
2334 DataOutHdr
->BufferOffset
= HTONL (XferContext
->Offset
);
2336 if (XferContext
->TargetTransferTag
!= ISCSI_RESERVED_TAG
) {
2337 CopyMem (&DataOutHdr
->Lun
, &Lun
, sizeof (DataOutHdr
->Lun
));
2340 // Build the data segment for this Data Out PDU.
2342 DataSeg
= IScsiNewDataSegment (Data
, Len
, FALSE
);
2343 if (DataSeg
== NULL
) {
2344 IScsiFreeNbufList (NbufList
);
2348 // Put the data segment into the buffer list and combine it with the BHS
2349 // into a full Data Out PDU.
2351 InsertTailList (NbufList
, &DataSeg
->List
);
2352 Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
2354 IScsiFreeNbufList (NbufList
);
2362 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2364 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2365 @param[in] Tcb The task control block of the data to send out.
2366 @param[in] Lun The LUN the data will be sent to.
2368 @return A list of net buffers with each of them wrapping an iSCSI SCSI Data Out PDU.
2369 @retval NULL Other errors as indicated.
2373 IScsiGenerateDataOutPduSequence (
2379 LIST_ENTRY
*PduList
;
2382 NET_BUF
*DataOutPdu
;
2383 ISCSI_CONNECTION
*Conn
;
2384 ISCSI_XFER_CONTEXT
*XferContext
;
2385 UINT8
*DataOutPacket
;
2387 PduList
= AllocatePool (sizeof (LIST_ENTRY
));
2388 if (PduList
== NULL
) {
2392 InitializeListHead (PduList
);
2397 XferContext
= &Tcb
->XferContext
;
2399 while (XferContext
->DesiredLength
> 0) {
2401 // Determine the length of data this Data Out PDU can carry.
2403 DataLen
= MIN (XferContext
->DesiredLength
, Conn
->MaxRecvDataSegmentLength
);
2406 // Create a Data Out PDU.
2408 DataOutPdu
= IScsiNewDataOutPdu (Data
, DataLen
, DataSN
, Tcb
, Lun
);
2409 if (DataOutPdu
== NULL
) {
2410 IScsiFreeNbufList (PduList
);
2416 InsertTailList (PduList
, &DataOutPdu
->List
);
2419 // Update the context and DataSN.
2422 XferContext
->Offset
+= DataLen
;
2423 XferContext
->DesiredLength
-= DataLen
;
2427 // Set the F bit for the last data out PDU in this sequence.
2429 DataOutPacket
= NetbufGetByte (DataOutPdu
, 0, NULL
);
2430 if (DataOutPacket
== NULL
) {
2431 IScsiFreeNbufList (PduList
);
2436 ISCSI_SET_FLAG (DataOutPacket
, ISCSI_BHS_FLAG_FINAL
);
2444 Send the Data in a sequence of Data Out PDUs one by one.
2446 @param[in] Data The data to carry by Data Out PDUs.
2447 @param[in] Lun The LUN the data will be sent to.
2448 @param[in] Tcb The task control block.
2450 @retval EFI_SUCCES The data is sent out to the LUN.
2451 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2452 @retval Others Other errors as indicated.
2456 IScsiSendDataOutPduSequence (
2462 LIST_ENTRY
*DataOutPduList
;
2468 // Generate the Data Out PDU sequence.
2470 DataOutPduList
= IScsiGenerateDataOutPduSequence (Data
, Tcb
, Lun
);
2471 if (DataOutPduList
== NULL
) {
2472 return EFI_OUT_OF_RESOURCES
;
2475 Status
= EFI_SUCCESS
;
2478 // Send the Data Out PDU's one by one.
2480 NET_LIST_FOR_EACH (Entry
, DataOutPduList
) {
2481 Pdu
= NET_LIST_USER_STRUCT (Entry
, NET_BUF
, List
);
2483 Status
= TcpIoTransmit (&Tcb
->Conn
->TcpIo
, Pdu
);
2485 if (EFI_ERROR (Status
)) {
2490 IScsiFreeNbufList (DataOutPduList
);
2497 Process the received iSCSI SCSI Data In PDU.
2499 @param[in] Pdu The Data In PDU received.
2500 @param[in] Tcb The task control block.
2501 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2503 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update
2505 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2506 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2507 @retval Others Other errors as indicated.
2514 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2517 ISCSI_SCSI_DATA_IN
*DataInHdr
;
2520 DataInHdr
= (ISCSI_SCSI_DATA_IN
*) NetbufGetByte (Pdu
, 0, NULL
);
2521 if (DataInHdr
== NULL
) {
2522 return EFI_PROTOCOL_ERROR
;
2525 DataInHdr
->InitiatorTaskTag
= NTOHL (DataInHdr
->InitiatorTaskTag
);
2526 DataInHdr
->ExpCmdSN
= NTOHL (DataInHdr
->ExpCmdSN
);
2527 DataInHdr
->MaxCmdSN
= NTOHL (DataInHdr
->MaxCmdSN
);
2528 DataInHdr
->DataSN
= NTOHL (DataInHdr
->DataSN
);
2531 // Check the DataSN.
2533 Status
= IScsiCheckSN (&Tcb
->ExpDataSN
, DataInHdr
->DataSN
);
2534 if (EFI_ERROR (Status
)) {
2538 if (DataInHdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) {
2539 return EFI_PROTOCOL_ERROR
;
2542 // Update the command related sequence numbers.
2544 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, DataInHdr
->MaxCmdSN
, DataInHdr
->ExpCmdSN
);
2546 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID
)) {
2547 if (!ISCSI_FLAG_ON (DataInHdr
, ISCSI_BHS_FLAG_FINAL
)) {
2549 // The S bit is on but the F bit is off.
2551 return EFI_PROTOCOL_ERROR
;
2554 Tcb
->StatusXferd
= TRUE
;
2556 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_DATA_IN_PDU_FLAG_OVERFLOW
| SCSI_DATA_IN_PDU_FLAG_UNDERFLOW
)) {
2558 // Underflow and Overflow are mutual flags.
2560 return EFI_PROTOCOL_ERROR
;
2563 // S bit is on, the StatSN is valid.
2565 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, NTOHL (DataInHdr
->StatSN
));
2566 if (EFI_ERROR (Status
)) {
2570 Packet
->HostAdapterStatus
= 0;
2571 Packet
->TargetStatus
= DataInHdr
->Status
;
2573 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
)) {
2574 Packet
->InTransferLength
+= NTOHL (DataInHdr
->ResidualCount
);
2575 Status
= EFI_BAD_BUFFER_SIZE
;
2578 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_RSP_PDU_FLAG_UNDERFLOW
)) {
2579 Packet
->InTransferLength
-= NTOHL (DataInHdr
->ResidualCount
);
2588 Process the received iSCSI R2T PDU.
2590 @param[in] Pdu The R2T PDU received.
2591 @param[in] Tcb The task control block.
2592 @param[in] Lun The Lun.
2593 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2595 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.
2596 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2597 @retval Others Other errors as indicated.
2605 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2608 ISCSI_READY_TO_TRANSFER
*R2THdr
;
2610 ISCSI_XFER_CONTEXT
*XferContext
;
2613 R2THdr
= (ISCSI_READY_TO_TRANSFER
*) NetbufGetByte (Pdu
, 0, NULL
);
2614 if (R2THdr
== NULL
) {
2615 return EFI_PROTOCOL_ERROR
;
2618 R2THdr
->InitiatorTaskTag
= NTOHL (R2THdr
->InitiatorTaskTag
);
2619 R2THdr
->TargetTransferTag
= NTOHL (R2THdr
->TargetTransferTag
);
2620 R2THdr
->StatSN
= NTOHL (R2THdr
->StatSN
);
2621 R2THdr
->R2TSeqNum
= NTOHL (R2THdr
->R2TSeqNum
);
2622 R2THdr
->BufferOffset
= NTOHL (R2THdr
->BufferOffset
);
2623 R2THdr
->DesiredDataTransferLength
= NTOHL (R2THdr
->DesiredDataTransferLength
);
2625 if ((R2THdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) || !ISCSI_SEQ_EQ (R2THdr
->StatSN
, Tcb
->Conn
->ExpStatSN
)) {
2626 return EFI_PROTOCOL_ERROR
;;
2629 // Check the sequence number.
2631 Status
= IScsiCheckSN (&Tcb
->ExpDataSN
, R2THdr
->R2TSeqNum
);
2632 if (EFI_ERROR (Status
)) {
2636 XferContext
= &Tcb
->XferContext
;
2637 XferContext
->TargetTransferTag
= R2THdr
->TargetTransferTag
;
2638 XferContext
->Offset
= R2THdr
->BufferOffset
;
2639 XferContext
->DesiredLength
= R2THdr
->DesiredDataTransferLength
;
2641 if (((XferContext
->Offset
+ XferContext
->DesiredLength
) > Packet
->OutTransferLength
) ||
2642 (XferContext
->DesiredLength
> Tcb
->Conn
->Session
->MaxBurstLength
)
2644 return EFI_PROTOCOL_ERROR
;
2647 // Send the data solicited by this R2T.
2649 Data
= (UINT8
*) Packet
->OutDataBuffer
+ XferContext
->Offset
;
2650 Status
= IScsiSendDataOutPduSequence (Data
, Lun
, Tcb
);
2657 Process the received iSCSI SCSI Response PDU.
2659 @param[in] Pdu The Response PDU received.
2660 @param[in] Tcb The task control block.
2661 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2663 @retval EFI_SUCCES The Response PDU is processed.
2664 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2665 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2666 @retval Others Other errors as indicated.
2670 IScsiOnScsiRspRcvd (
2673 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2676 SCSI_RESPONSE
*ScsiRspHdr
;
2677 ISCSI_SENSE_DATA
*SenseData
;
2681 ScsiRspHdr
= (SCSI_RESPONSE
*) NetbufGetByte (Pdu
, 0, NULL
);
2682 if (ScsiRspHdr
== NULL
) {
2683 return EFI_PROTOCOL_ERROR
;
2686 ScsiRspHdr
->InitiatorTaskTag
= NTOHL (ScsiRspHdr
->InitiatorTaskTag
);
2687 if (ScsiRspHdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) {
2688 return EFI_PROTOCOL_ERROR
;
2691 ScsiRspHdr
->StatSN
= NTOHL (ScsiRspHdr
->StatSN
);
2693 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, ScsiRspHdr
->StatSN
);
2694 if (EFI_ERROR (Status
)) {
2698 ScsiRspHdr
->MaxCmdSN
= NTOHL (ScsiRspHdr
->MaxCmdSN
);
2699 ScsiRspHdr
->ExpCmdSN
= NTOHL (ScsiRspHdr
->ExpCmdSN
);
2700 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, ScsiRspHdr
->MaxCmdSN
, ScsiRspHdr
->ExpCmdSN
);
2702 Tcb
->StatusXferd
= TRUE
;
2704 Packet
->HostAdapterStatus
= ScsiRspHdr
->Response
;
2705 if (Packet
->HostAdapterStatus
!= ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET
) {
2709 Packet
->TargetStatus
= ScsiRspHdr
->Status
;
2711 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW
| SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW
) ||
2712 ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
| SCSI_RSP_PDU_FLAG_UNDERFLOW
)
2714 return EFI_PROTOCOL_ERROR
;
2717 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW
)) {
2718 Packet
->InTransferLength
+= NTOHL (ScsiRspHdr
->BiReadResidualCount
);
2719 Status
= EFI_BAD_BUFFER_SIZE
;
2722 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW
)) {
2723 Packet
->InTransferLength
-= NTOHL (ScsiRspHdr
->BiReadResidualCount
);
2726 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
)) {
2727 if (Packet
->DataDirection
== DataIn
) {
2728 Packet
->InTransferLength
+= NTOHL (ScsiRspHdr
->ResidualCount
);
2730 Packet
->OutTransferLength
+= NTOHL (ScsiRspHdr
->ResidualCount
);
2733 Status
= EFI_BAD_BUFFER_SIZE
;
2736 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_UNDERFLOW
)) {
2737 if (Packet
->DataDirection
== DataIn
) {
2738 Packet
->InTransferLength
-= NTOHL (ScsiRspHdr
->ResidualCount
);
2740 Packet
->OutTransferLength
-= NTOHL (ScsiRspHdr
->ResidualCount
);
2744 DataSegLen
= ISCSI_GET_DATASEG_LEN (ScsiRspHdr
);
2745 if (DataSegLen
!= 0) {
2746 SenseData
= (ISCSI_SENSE_DATA
*) NetbufGetByte (Pdu
, sizeof (SCSI_RESPONSE
), NULL
);
2747 if (SenseData
== NULL
) {
2748 return EFI_PROTOCOL_ERROR
;
2751 SenseData
->Length
= NTOHS (SenseData
->Length
);
2753 Packet
->SenseDataLength
= (UINT8
) MIN (SenseData
->Length
, Packet
->SenseDataLength
);
2754 if (Packet
->SenseDataLength
!= 0) {
2755 CopyMem (Packet
->SenseData
, &SenseData
->Data
[0], Packet
->SenseDataLength
);
2758 Packet
->SenseDataLength
= 0;
2766 Process the received NOP In PDU.
2768 @param[in] Pdu The NOP In PDU received.
2769 @param[in] Tcb The task control block.
2771 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence
2772 numbers are updated.
2773 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2782 ISCSI_NOP_IN
*NopInHdr
;
2785 NopInHdr
= (ISCSI_NOP_IN
*) NetbufGetByte (Pdu
, 0, NULL
);
2786 if (NopInHdr
== NULL
) {
2787 return EFI_PROTOCOL_ERROR
;
2790 NopInHdr
->StatSN
= NTOHL (NopInHdr
->StatSN
);
2791 NopInHdr
->ExpCmdSN
= NTOHL (NopInHdr
->ExpCmdSN
);
2792 NopInHdr
->MaxCmdSN
= NTOHL (NopInHdr
->MaxCmdSN
);
2794 if (NopInHdr
->InitiatorTaskTag
== ISCSI_RESERVED_TAG
) {
2795 if (NopInHdr
->StatSN
!= Tcb
->Conn
->ExpStatSN
) {
2796 return EFI_PROTOCOL_ERROR
;
2799 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, NopInHdr
->StatSN
);
2800 if (EFI_ERROR (Status
)) {
2805 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, NopInHdr
->MaxCmdSN
, NopInHdr
->ExpCmdSN
);
2812 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2814 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2815 @param[in] Target The target ID.
2816 @param[in] Lun The LUN.
2817 @param[in, out] Packet The request packet containing IO request, SCSI command
2818 buffer and buffers to read/write.
2820 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
2822 @retval EFI_DEVICE_ERROR Session state was not as required.
2823 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2824 @retval EFI_PROTOCOL_ERROR There is no such data in the net buffer.
2825 @retval EFI_NOT_READY The target can not accept new commands.
2826 @retval Others Other errors as indicated.
2830 IScsiExecuteScsiCommand (
2831 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
2834 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2838 ISCSI_DRIVER_DATA
*Private
;
2839 ISCSI_SESSION
*Session
;
2840 EFI_EVENT TimeoutEvent
;
2841 ISCSI_CONNECTION
*Conn
;
2844 ISCSI_XFER_CONTEXT
*XferContext
;
2846 ISCSI_IN_BUFFER_CONTEXT InBufferContext
;
2850 Private
= ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru
);
2851 Session
= Private
->Session
;
2852 Status
= EFI_SUCCESS
;
2854 TimeoutEvent
= NULL
;
2857 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
2858 Status
= EFI_DEVICE_ERROR
;
2862 Conn
= NET_LIST_USER_STRUCT_S (
2863 Session
->Conns
.ForwardLink
,
2866 ISCSI_CONNECTION_SIGNATURE
2869 if (Packet
->Timeout
!= 0) {
2870 Timeout
= MultU64x32 (Packet
->Timeout
, 4);
2873 Status
= IScsiNewTcb (Conn
, &Tcb
);
2874 if (EFI_ERROR (Status
)) {
2878 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2880 Pdu
= IScsiNewScsiCmdPdu (Packet
, Lun
, Tcb
);
2882 Status
= EFI_OUT_OF_RESOURCES
;
2886 XferContext
= &Tcb
->XferContext
;
2887 PduHdr
= NetbufGetByte (Pdu
, 0, NULL
);
2888 if (PduHdr
== NULL
) {
2889 Status
= EFI_PROTOCOL_ERROR
;
2893 XferContext
->Offset
= ISCSI_GET_DATASEG_LEN (PduHdr
);
2896 // Transmit the SCSI Command PDU.
2898 Status
= TcpIoTransmit (&Conn
->TcpIo
, Pdu
);
2902 if (EFI_ERROR (Status
)) {
2906 if (!Session
->InitialR2T
&&
2907 (XferContext
->Offset
< Session
->FirstBurstLength
) &&
2908 (XferContext
->Offset
< Packet
->OutTransferLength
)
2911 // Unsolicited Data-Out sequence is allowed. There is remaining SCSI
2912 // OUT data, and the limit of FirstBurstLength is not reached.
2914 XferContext
->TargetTransferTag
= ISCSI_RESERVED_TAG
;
2915 XferContext
->DesiredLength
= MIN (
2916 Session
->FirstBurstLength
,
2917 Packet
->OutTransferLength
- XferContext
->Offset
2920 Data
= (UINT8
*) Packet
->OutDataBuffer
+ XferContext
->Offset
;
2921 Status
= IScsiSendDataOutPduSequence (Data
, Lun
, Tcb
);
2922 if (EFI_ERROR (Status
)) {
2927 InBufferContext
.InData
= (UINT8
*) Packet
->InDataBuffer
;
2928 InBufferContext
.InDataLen
= Packet
->InTransferLength
;
2930 while (!Tcb
->StatusXferd
) {
2932 // Start the timeout timer.
2935 Status
= gBS
->SetTimer (Conn
->TimeoutEvent
, TimerRelative
, Timeout
);
2936 if (EFI_ERROR (Status
)) {
2940 TimeoutEvent
= Conn
->TimeoutEvent
;
2944 // Try to receive PDU from target.
2946 Status
= IScsiReceivePdu (Conn
, &Pdu
, &InBufferContext
, FALSE
, FALSE
, TimeoutEvent
);
2947 if (EFI_ERROR (Status
)) {
2951 PduHdr
= NetbufGetByte (Pdu
, 0, NULL
);
2952 if (PduHdr
== NULL
) {
2953 Status
= EFI_PROTOCOL_ERROR
;
2957 switch (ISCSI_GET_OPCODE (PduHdr
)) {
2958 case ISCSI_OPCODE_SCSI_DATA_IN
:
2959 Status
= IScsiOnDataInRcvd (Pdu
, Tcb
, Packet
);
2962 case ISCSI_OPCODE_R2T
:
2963 Status
= IScsiOnR2TRcvd (Pdu
, Tcb
, Lun
, Packet
);
2966 case ISCSI_OPCODE_SCSI_RSP
:
2967 Status
= IScsiOnScsiRspRcvd (Pdu
, Tcb
, Packet
);
2970 case ISCSI_OPCODE_NOP_IN
:
2971 Status
= IScsiOnNopInRcvd (Pdu
, Tcb
);
2974 case ISCSI_OPCODE_VENDOR_T0
:
2975 case ISCSI_OPCODE_VENDOR_T1
:
2976 case ISCSI_OPCODE_VENDOR_T2
:
2978 // These messages are vendor specific. Skip them.
2983 Status
= EFI_PROTOCOL_ERROR
;
2989 if (EFI_ERROR (Status
)) {
2996 if (TimeoutEvent
!= NULL
) {
2997 gBS
->SetTimer (TimeoutEvent
, TimerCancel
, 0);
3009 Reinstate the session on some error.
3011 @param[in] Session The iSCSI session
3013 @retval EFI_SUCCESS The session is reinstated from some error.
3014 @retval Other Reinstatement failed.
3018 IScsiSessionReinstatement (
3019 IN ISCSI_SESSION
*Session
3024 ASSERT (Session
->State
!= SESSION_STATE_FREE
);
3027 // Abort the session and re-init it.
3029 IScsiSessionAbort (Session
);
3030 IScsiSessionInit (Session
, TRUE
);
3035 Status
= IScsiSessionLogin (Session
);
3042 Initialize some session parameters before login.
3044 @param[in, out] Session The iSCSI session.
3045 @param[in] Recovery Whether the request is from a fresh new start or recovery.
3050 IN OUT ISCSI_SESSION
*Session
,
3055 Session
->Signature
= ISCSI_SESSION_SIGNATURE
;
3056 Session
->State
= SESSION_STATE_FREE
;
3058 InitializeListHead (&Session
->Conns
);
3059 InitializeListHead (&Session
->TcbList
);
3065 Session
->InitiatorTaskTag
= 1;
3066 Session
->NextCid
= 1;
3068 Session
->TargetPortalGroupTag
= 0;
3069 Session
->MaxConnections
= ISCSI_MAX_CONNS_PER_SESSION
;
3070 Session
->InitialR2T
= FALSE
;
3071 Session
->ImmediateData
= TRUE
;
3072 Session
->MaxBurstLength
= 262144;
3073 Session
->FirstBurstLength
= MAX_RECV_DATA_SEG_LEN_IN_FFP
;
3074 Session
->DefaultTime2Wait
= 2;
3075 Session
->DefaultTime2Retain
= 20;
3076 Session
->MaxOutstandingR2T
= DEFAULT_MAX_OUTSTANDING_R2T
;
3077 Session
->DataPDUInOrder
= TRUE
;
3078 Session
->DataSequenceInOrder
= TRUE
;
3079 Session
->ErrorRecoveryLevel
= 0;
3084 Abort the iSCSI session. That is, reset all the connection(s), and free the
3087 @param[in, out] Session The iSCSI session.
3092 IN OUT ISCSI_SESSION
*Session
3095 ISCSI_CONNECTION
*Conn
;
3096 EFI_GUID
*ProtocolGuid
;
3098 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
3102 ASSERT (!IsListEmpty (&Session
->Conns
));
3104 while (!IsListEmpty (&Session
->Conns
)) {
3105 Conn
= NET_LIST_USER_STRUCT_S (
3106 Session
->Conns
.ForwardLink
,
3109 ISCSI_CONNECTION_SIGNATURE
3111 if (!Conn
->Ipv6Flag
) {
3112 ProtocolGuid
= &gEfiTcp4ProtocolGuid
;
3114 ProtocolGuid
= &gEfiTcp6ProtocolGuid
;
3117 gBS
->CloseProtocol (
3120 Session
->Private
->Image
,
3121 Session
->Private
->ExtScsiPassThruHandle
3124 IScsiConnReset (Conn
);
3126 IScsiDetatchConnection (Conn
);
3127 IScsiDestroyConnection (Conn
);
3130 Session
->State
= SESSION_STATE_FAILED
;