2 The implementation of IScsi protocol based on RFC3720.
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 #include "IScsiImpl.h"
17 UINT32 mDataSegPad
= 0;
20 Attach the iSCSI connection to the iSCSI session.
22 @param[in] Session The iSCSI session.
23 @param[in] Conn The iSCSI connection.
26 IScsiAttatchConnection (
27 IN ISCSI_SESSION
*Session
,
28 IN ISCSI_CONNECTION
*Conn
31 InsertTailList (&Session
->Conns
, &Conn
->Link
);
32 Conn
->Session
= Session
;
37 Detach the iSCSI connection from the session it belongs to.
39 @param[in] Conn The iSCSI connection.
42 IScsiDetatchConnection (
43 IN ISCSI_CONNECTION
*Conn
46 RemoveEntryList (&Conn
->Link
);
47 Conn
->Session
->NumConns
--;
52 Check the sequence number according to RFC3720.
54 @param[in] ExpSN The currently expected sequence number.
55 @param[in] NewSN The sequence number to check.
57 @retval EFI_SUCCESS The check passed and the ExpSN is increased.
58 @retval EFI_NOT_READY Response was sent due to a retransmission request.
59 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
67 if (!ISCSI_SEQ_EQ (NewSN
, *ExpSN
)) {
68 if (ISCSI_SEQ_LT (NewSN
, *ExpSN
)) {
74 return EFI_PROTOCOL_ERROR
;
86 Update the sequence numbers for the iSCSI command.
88 @param[in] Session The iSCSI session.
89 @param[in] MaxCmdSN Maximum CmdSN from the target.
90 @param[in] ExpCmdSN Next expected CmdSN from the target.
94 IN ISCSI_SESSION
*Session
,
99 if (ISCSI_SEQ_LT (MaxCmdSN
, ExpCmdSN
- 1)) {
103 if (ISCSI_SEQ_GT (MaxCmdSN
, Session
->MaxCmdSN
)) {
104 Session
->MaxCmdSN
= MaxCmdSN
;
107 if (ISCSI_SEQ_GT (ExpCmdSN
, Session
->ExpCmdSN
)) {
108 Session
->ExpCmdSN
= ExpCmdSN
;
113 This function does the iSCSI connection login.
115 @param[in] Conn The iSCSI connection to login.
117 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
118 @retval EFI_TIMEOUT Timeout happened during the login procedure.
119 @retval Others Other errors as indicated.
123 IN ISCSI_CONNECTION
*Conn
129 // Start the timer, wait 16 seconds to establish the TCP connection.
131 Status
= gBS
->SetTimer (Conn
->TimeoutEvent
, TimerRelative
, 16 * TICKS_PER_SECOND
);
132 if (EFI_ERROR (Status
)) {
136 // try to establish the tcp connection
138 Status
= Tcp4IoConnect (&Conn
->Tcp4Io
, Conn
->TimeoutEvent
);
139 if (EFI_ERROR (Status
)) {
143 gBS
->SetTimer (Conn
->TimeoutEvent
, TimerCancel
, 0);
144 Conn
->State
= CONN_STATE_IN_LOGIN
;
147 // connection is established, start the iSCSI Login
150 Status
= IScsiSendLoginReq (Conn
);
151 if (EFI_ERROR (Status
)) {
155 Status
= IScsiReceiveLoginRsp (Conn
);
156 if (EFI_ERROR (Status
)) {
159 } while (Conn
->CurrentStage
!= ISCSI_FULL_FEATURE_PHASE
);
165 Reset the iSCSI connection.
167 @param[in] Conn The iSCSI connection to reset.
171 IN ISCSI_CONNECTION
*Conn
174 Tcp4IoReset (&Conn
->Tcp4Io
);
178 Create a TCP connection for the iSCSI session.
180 @param[in] Private The iSCSI driver data.
181 @param[in] Session Maximum CmdSN from the target.
183 @return The newly created iSCSI connection.
186 IScsiCreateConnection (
187 IN ISCSI_DRIVER_DATA
*Private
,
188 IN ISCSI_SESSION
*Session
191 ISCSI_CONNECTION
*Conn
;
192 TCP4_IO_CONFIG_DATA Tcp4IoConfig
;
195 Conn
= AllocatePool (sizeof (ISCSI_CONNECTION
));
200 Conn
->Signature
= ISCSI_CONNECTION_SIGNATURE
;
201 Conn
->State
= CONN_STATE_FREE
;
202 Conn
->CurrentStage
= ISCSI_SECURITY_NEGOTIATION
;
203 Conn
->NextStage
= ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
;
204 Conn
->CHAPStep
= ISCSI_CHAP_INITIAL
;
206 Conn
->PartialReqSent
= FALSE
;
207 Conn
->PartialRspRcvd
= FALSE
;
208 Conn
->CID
= Session
->NextCID
++;
210 Status
= gBS
->CreateEvent (
217 if (EFI_ERROR (Status
)) {
218 gBS
->FreePool (Conn
);
222 NetbufQueInit (&Conn
->RspQue
);
225 // set the default connection-only parameters
227 Conn
->MaxRecvDataSegmentLength
= MAX_RECV_DATA_SEG_LEN_IN_FFP
;
228 Conn
->HeaderDigest
= ISCSI_DIGEST_NONE
;
229 Conn
->DataDigest
= ISCSI_DIGEST_NONE
;
231 CopyMem (&Tcp4IoConfig
.LocalIp
, &Session
->ConfigData
.NvData
.LocalIp
, sizeof (EFI_IPv4_ADDRESS
));
232 CopyMem (&Tcp4IoConfig
.SubnetMask
, &Session
->ConfigData
.NvData
.SubnetMask
, sizeof (EFI_IPv4_ADDRESS
));
233 CopyMem (&Tcp4IoConfig
.Gateway
, &Session
->ConfigData
.NvData
.Gateway
, sizeof (EFI_IPv4_ADDRESS
));
234 CopyMem (&Tcp4IoConfig
.RemoteIp
, &Session
->ConfigData
.NvData
.TargetIp
, sizeof (EFI_IPv4_ADDRESS
));
236 Tcp4IoConfig
.RemotePort
= Session
->ConfigData
.NvData
.TargetPort
;
239 // Create the tcp4 IO for this connection
241 Status
= Tcp4IoCreateSocket (
247 if (EFI_ERROR (Status
)) {
248 gBS
->CloseEvent (Conn
->TimeoutEvent
);
249 gBS
->FreePool (Conn
);
257 Destroy an iSCSI connection.
259 @param[in] Conn The connection to destroy.
262 IScsiDestroyConnection (
263 IN ISCSI_CONNECTION
*Conn
266 Tcp4IoDestroySocket (&Conn
->Tcp4Io
);
267 NetbufQueFlush (&Conn
->RspQue
);
268 gBS
->CloseEvent (Conn
->TimeoutEvent
);
269 gBS
->FreePool (Conn
);
273 Login the iSCSI session.
275 @param[in] Private The iSCSI driver data.
277 @retval EFI_SUCCESS The iSCSI session login procedure finished.
278 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
279 @retval Others Other errors as indicated.
283 IN ISCSI_DRIVER_DATA
*Private
287 ISCSI_SESSION
*Session
;
288 ISCSI_CONNECTION
*Conn
;
289 EFI_TCP4_PROTOCOL
*Tcp4
;
291 Session
= &Private
->Session
;
294 // Create a connection for the session.
296 Conn
= IScsiCreateConnection (Private
, Session
);
298 return EFI_OUT_OF_RESOURCES
;
301 IScsiAttatchConnection (Session
, Conn
);
304 // Login througth the newly created connection.
306 Status
= IScsiConnLogin (Conn
);
307 if (EFI_ERROR (Status
)) {
308 IScsiConnReset (Conn
);
309 IScsiDetatchConnection (Conn
);
310 IScsiDestroyConnection (Conn
);
312 Session
->State
= SESSION_STATE_LOGGED_IN
;
316 &gEfiTcp4ProtocolGuid
,
319 Private
->ExtScsiPassThruHandle
,
320 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
328 Build and send the iSCSI login request to the iSCSI target according to
329 the current login stage.
331 @param[in] Conn The connection in the iSCSI login phase.
333 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
335 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
336 @retval EFI_DEVICE_ERROR Some kind of device error happened.
340 IN ISCSI_CONNECTION
*Conn
347 // build the Login Request PDU
349 Pdu
= IScsiPrepareLoginReq (Conn
);
351 return EFI_DEVICE_ERROR
;
354 // Send it to the iSCSI target.
356 Status
= Tcp4IoTransmit (&Conn
->Tcp4Io
, Pdu
);
364 Receive and process the iSCSI login response.
366 @param[in] Conn The connection in the iSCSI login phase.
368 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
369 @retval Others Other errors as indicated.
372 IScsiReceiveLoginRsp (
373 IN ISCSI_CONNECTION
*Conn
380 // Receive the iSCSI login response.
382 Status
= IScsiReceivePdu (Conn
, &Pdu
, NULL
, FALSE
, FALSE
, NULL
);
383 if (EFI_ERROR (Status
)) {
387 // A Login Response is received, process it.
389 Status
= IScsiProcessLoginRsp (Conn
, Pdu
);
397 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
398 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
401 @param[in] Pdu The iSCSI PDU whose data segment the key-value pair will
403 @param[in] Key The key name string.
404 @param[in] Value The value string.
406 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
407 the correspondence length fields are updated.
408 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
412 IScsiAddKeyValuePair (
422 ISCSI_LOGIN_REQUEST
*LoginReq
;
425 LoginReq
= (ISCSI_LOGIN_REQUEST
*) NetbufGetByte (Pdu
, 0, NULL
);
426 DataSegLen
= NTOH24 (LoginReq
->DataSegmentLength
);
428 KeyLen
= (UINT32
) AsciiStrLen (Key
);
429 ValueLen
= (UINT32
) AsciiStrLen (Value
);
432 // 1 byte for the key value separator '=' and 1 byte for the null
433 // delimiter after the value.
435 TotalLen
= KeyLen
+ 1 + ValueLen
+ 1;
438 // Allocate the space for the key-value pair.
440 Data
= (CHAR8
*)NetbufAllocSpace (Pdu
, TotalLen
, NET_BUF_TAIL
);
442 return EFI_OUT_OF_RESOURCES
;
447 CopyMem (Data
, Key
, KeyLen
);
456 CopyMem (Data
, Value
, ValueLen
);
462 // update the DataSegmentLength
464 ISCSI_SET_DATASEG_LEN (LoginReq
, DataSegLen
+ TotalLen
);
470 Prepare the iSCSI login request to be sent according to the current login status.
472 @param[in] Conn The connection in the iSCSI login phase.
474 @return The pointer to the net buffer containing the iSCSI login request built.
475 @retval Others Other errors as indicated.
478 IScsiPrepareLoginReq (
479 IN ISCSI_CONNECTION
*Conn
482 ISCSI_SESSION
*Session
;
484 ISCSI_LOGIN_REQUEST
*LoginReq
;
487 Session
= Conn
->Session
;
489 Nbuf
= NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST
) + DEFAULT_MAX_RECV_DATA_SEG_LEN
);
494 LoginReq
= (ISCSI_LOGIN_REQUEST
*) NetbufAllocSpace (Nbuf
, sizeof (ISCSI_LOGIN_REQUEST
), NET_BUF_TAIL
);
495 ZeroMem (LoginReq
, sizeof (ISCSI_LOGIN_REQUEST
));
498 // Init the login request pdu
500 ISCSI_SET_OPCODE (LoginReq
, ISCSI_OPCODE_LOGIN_REQ
, ISCSI_REQ_IMMEDIATE
);
501 ISCSI_SET_STAGES (LoginReq
, Conn
->CurrentStage
, Conn
->NextStage
);
502 LoginReq
->VersionMax
= ISCSI_VERSION_MAX
;
503 LoginReq
->VersionMin
= ISCSI_VERSION_MIN
;
504 LoginReq
->TSIH
= HTONS (Session
->TSIH
);
505 LoginReq
->InitiatorTaskTag
= HTONL (Session
->InitiatorTaskTag
);
506 LoginReq
->CID
= HTONS (Conn
->CID
);
507 LoginReq
->CmdSN
= HTONL (Session
->CmdSN
);
510 // For the first Login Request on a coonection this is ExpStatSN for the
511 // old connection and this field is only valid if the Login Request restarts
513 // For subsequent Login Requests it is used to acknowledge the Login Responses
514 // with their increasing StatSN values.
516 LoginReq
->ExpStatSN
= HTONL (Conn
->ExpStatSN
);
517 CopyMem (LoginReq
->ISID
, Session
->ISID
, sizeof (LoginReq
->ISID
));
519 if (Conn
->PartialRspRcvd
) {
521 // A partial response, initiator must send an empty Login Request.
526 switch (Conn
->CurrentStage
) {
527 case ISCSI_SECURITY_NEGOTIATION
:
528 Status
= IScsiCHAPToSendReq (Conn
, Nbuf
);
531 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
:
532 Status
= IScsiFillOpParams (Conn
, Nbuf
);
533 ISCSI_SET_FLAG (LoginReq
, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
);
538 // something error happens...
540 Status
= EFI_DEVICE_ERROR
;
544 if (EFI_ERROR (Status
)) {
549 // Pad the data segment if needed.
551 IScsiPadSegment (Nbuf
, ISCSI_GET_DATASEG_LEN (LoginReq
));
553 // Check whether we will issue the stage transition signal?
555 Conn
->TransitInitiated
= (BOOLEAN
) ISCSI_FLAG_ON (LoginReq
, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
);
562 Process the iSCSI Login Response.
564 @param[in] Conn The connection on which the iSCSI login response is received.
565 @param[in] Pdu The iSCSI login response PDU.
567 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
568 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
569 @retval EFI_MEDIA_CHANGED Target is redirected.
570 @retval Others Other errors as indicated.
573 IScsiProcessLoginRsp (
574 IN ISCSI_CONNECTION
*Conn
,
579 ISCSI_SESSION
*Session
;
580 ISCSI_LOGIN_RESPONSE
*LoginRsp
;
588 Session
= Conn
->Session
;
590 LoginRsp
= (ISCSI_LOGIN_RESPONSE
*) NetbufGetByte (Pdu
, 0, NULL
);
591 if (!ISCSI_CHECK_OPCODE (LoginRsp
, ISCSI_OPCODE_LOGIN_RSP
)) {
593 // It's not a Login Response
595 return EFI_PROTOCOL_ERROR
;
598 // Get the data segment if any.
600 DataSegLen
= ISCSI_GET_DATASEG_LEN (LoginRsp
);
601 if (DataSegLen
!= 0) {
602 DataSeg
= NetbufGetByte (Pdu
, sizeof (ISCSI_LOGIN_RESPONSE
), NULL
);
607 // Check the status class in the login response PDU.
609 switch (LoginRsp
->StatusClass
) {
610 case ISCSI_LOGIN_STATUS_SUCCESS
:
612 // Just break here, the response and the data segment will be processed later.
616 case ISCSI_LOGIN_STATUS_REDIRECTION
:
618 // The target may be moved to a different address
620 if (DataSeg
== NULL
) {
621 return EFI_PROTOCOL_ERROR
;
624 // Process the TargetAddress key-value strings in the data segment to update the
625 // target address info.
627 Status
= IScsiUpdateTargetAddress (Session
, (CHAR8
*)DataSeg
, DataSegLen
);
628 if (EFI_ERROR (Status
)) {
632 // Session will be restarted on this error status because the Target is
633 // redirected by this Login Response.
635 return EFI_MEDIA_CHANGED
;
639 // Initiator Error, Target Error, or any other undefined error code.
641 return EFI_PROTOCOL_ERROR
;
644 // The status is sucess, extract the wanted fields from the header segment.
646 Transit
= (BOOLEAN
) ISCSI_FLAG_ON (LoginRsp
, ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT
);
647 Continue
= (BOOLEAN
) ISCSI_FLAG_ON (LoginRsp
, ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE
);
649 CurrentStage
= (UINT8
) ISCSI_GET_CURRENT_STAGE (LoginRsp
);
650 NextStage
= (UINT8
) ISCSI_GET_NEXT_STAGE (LoginRsp
);
652 LoginRsp
->InitiatorTaskTag
= NTOHL (LoginRsp
->InitiatorTaskTag
);
654 if ((Transit
&& Continue
) ||
655 (CurrentStage
!= Conn
->CurrentStage
) ||
656 (!Conn
->TransitInitiated
&& Transit
) ||
657 (Transit
&& (NextStage
!= Conn
->NextStage
)) ||
658 (CompareMem (Session
->ISID
, LoginRsp
->ISID
, sizeof (LoginRsp
->ISID
)) != 0) ||
659 (LoginRsp
->InitiatorTaskTag
!= Session
->InitiatorTaskTag
)
662 // A Login Response with the C bit set to 1 MUST have the T bit set to 0;
663 // The CSG in the Login Response MUST be the same with the I-end of this connection;
664 // The T bit can't be 1 if the last Login Response sent by the initiator doesn't
665 // initiate the transistion;
666 // The NSG MUST be the same with the I-end of this connection if Transit is required.
667 // The ISID in the Login Response MUST be the same with this session.
669 return EFI_PROTOCOL_ERROR
;
672 LoginRsp
->StatSN
= NTOHL (LoginRsp
->StatSN
);
673 LoginRsp
->ExpCmdSN
= NTOHL (LoginRsp
->ExpCmdSN
);
674 LoginRsp
->MaxCmdSN
= NTOHL (LoginRsp
->MaxCmdSN
);
676 if ((Conn
->CurrentStage
== ISCSI_SECURITY_NEGOTIATION
) && (Conn
->CHAPStep
== ISCSI_CHAP_INITIAL
)) {
678 // It's the initial Login Response, initialize the local ExpStatSN, MaxCmdSN
681 Conn
->ExpStatSN
= LoginRsp
->StatSN
+ 1;
682 Session
->MaxCmdSN
= LoginRsp
->MaxCmdSN
;
683 Session
->ExpCmdSN
= LoginRsp
->ExpCmdSN
;
686 // Check the StatSN of this PDU
688 Status
= IScsiCheckSN (&Conn
->ExpStatSN
, LoginRsp
->StatSN
);
689 if (!EFI_ERROR (Status
)) {
691 // Update the MaxCmdSN and ExpCmdSN
693 IScsiUpdateCmdSN (Session
, LoginRsp
->MaxCmdSN
, LoginRsp
->ExpCmdSN
);
699 // Trim off the header segment.
701 NetbufTrim (Pdu
, sizeof (ISCSI_LOGIN_RESPONSE
), NET_BUF_HEAD
);
704 // Queue this login response first in case it's a partial response so that
705 // later when the full response list is received we can combine these scattered
706 // responses' data segment and then process it.
709 NetbufQueAppend (&Conn
->RspQue
, Pdu
);
711 Conn
->PartialRspRcvd
= Continue
;
714 // It's a partial response, have to wait for another or more Request/Response
715 // conversations to get the full response.
720 switch (CurrentStage
) {
721 case ISCSI_SECURITY_NEGOTIATION
:
723 // In security negotiation stage, let CHAP module handle it.
725 Status
= IScsiCHAPOnRspReceived (Conn
, Transit
);
728 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
:
730 // Response received with negotiation resonse on iSCSI parameters, check them.
732 Status
= IScsiCheckOpParams (Conn
, Transit
);
737 // Should never get here.
739 Status
= EFI_PROTOCOL_ERROR
;
743 if (Transit
&& (Status
== EFI_SUCCESS
)) {
745 // Do the state transition.
747 Conn
->CurrentStage
= Conn
->NextStage
;
749 if (Conn
->CurrentStage
== ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
) {
750 Conn
->NextStage
= ISCSI_FULL_FEATURE_PHASE
;
753 // CurrentStage is iSCSI Full Feature, it's the Login-Final Response,
754 // get the TSIH from the Login Response.
756 Session
->TSIH
= NTOHS (LoginRsp
->TSIH
);
760 // Flush the response(s) received.
762 NetbufQueFlush (&Conn
->RspQue
);
768 Updated the target information according the data received in the iSCSI
769 login response with an target redirection status.
771 @param[in] Session The iSCSI session.
772 @param[in] Data The data segment which should contain the
773 TargetAddress key-value list.
774 @param[in] Len Length of the data.
776 @retval EFI_SUCCESS The target address is updated.
777 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
778 @retval EFI_NOT_FOUND The TargetAddress key is not found.
779 @retval Others Other errors as indicated.
782 IScsiUpdateTargetAddress (
783 IN ISCSI_SESSION
*Session
,
788 LIST_ENTRY
*KeyValueList
;
789 CHAR8
*TargetAddress
;
794 KeyValueList
= IScsiBuildKeyValueList (Data
, Len
);
795 if (KeyValueList
== NULL
) {
796 return EFI_OUT_OF_RESOURCES
;
799 Status
= EFI_NOT_FOUND
;
802 TargetAddress
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_ADDRESS
);
803 if (TargetAddress
== NULL
) {
807 if (!NET_IS_DIGIT (TargetAddress
[0])) {
809 // The domainname of the target may be presented in three formats: a DNS host name,
810 // a dotted-decimal IPv4 address, or a bracketed IPv6 address. Only accept dotted
816 IpStr
= TargetAddress
;
818 while ((*TargetAddress
!= 0) && (*TargetAddress
!= ':') && (*TargetAddress
!= ',')) {
820 // NULL, ':' or ',' ends the IPv4 string.
825 if (*TargetAddress
== ',') {
827 // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent
828 // as the result of a redirection.
831 } else if (*TargetAddress
== ':') {
832 *TargetAddress
= '\0';
836 Number
= AsciiStrDecimalToUintn (TargetAddress
);
837 if (Number
> 0xFFFF) {
840 Session
->ConfigData
.NvData
.TargetPort
= (UINT16
) Number
;
844 // The string only contains the IPv4 address. Use the well known port.
846 Session
->ConfigData
.NvData
.TargetPort
= ISCSI_WELL_KNOWN_PORT
;
849 // Update the target IP address.
851 Status
= IScsiAsciiStrToIp (IpStr
, &Session
->ConfigData
.NvData
.TargetIp
);
852 if (EFI_ERROR (Status
)) {
859 IScsiFreeKeyValueList (KeyValueList
);
865 The callback function to free the net buffer list.
867 @param[in] Arg The opaque parameter.
874 ASSERT (Arg
!= NULL
);
876 NetbufFreeList ((LIST_ENTRY
*) Arg
);
881 The callback function called in NetBufFree, it does nothing.
883 @param[in] Arg The opaque parameter.
893 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
894 an optional data segment. The two parts will be put into two blocks of buffers in the
895 net buffer. The digest check will be conducted in this function if needed and the digests
896 will be trimmed from the PDU buffer.
898 @param[in] Conn The iSCSI connection to receive data from.
899 @param[out] Pdu The received iSCSI pdu.
900 @param[in] Context The context used to describe information on the caller provided
901 buffer to receive data segment of the iSCSI pdu, it's optional.
902 @param[in] HeaderDigest Whether there will be header digest received.
903 @param[in] DataDigest Whether there will be data digest.
904 @param[in] TimeoutEvent The timeout event, it's optional.
906 @retval EFI_SUCCESS An iSCSI pdu is received.
907 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
908 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
909 @retval Others Other errors as indicated.
913 IN ISCSI_CONNECTION
*Conn
,
915 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
916 IN BOOLEAN HeaderDigest
,
917 IN BOOLEAN DataDigest
,
918 IN EFI_EVENT TimeoutEvent OPTIONAL
921 LIST_ENTRY
*NbufList
;
928 NET_FRAGMENT Fragment
[2];
929 UINT32 FragmentCount
;
931 UINT32 PadAndCRC32
[2];
933 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
934 if (NbufList
== NULL
) {
935 return EFI_OUT_OF_RESOURCES
;
938 InitializeListHead (NbufList
);
941 // The header digest will be received together with the PDU header if exists.
943 Len
= sizeof (ISCSI_BASIC_HEADER
) + (HeaderDigest
? sizeof (UINT32
) : 0);
944 PduHdr
= NetbufAlloc (Len
);
945 if (PduHdr
== NULL
) {
946 Status
= EFI_OUT_OF_RESOURCES
;
950 Header
= NetbufAllocSpace (PduHdr
, Len
, NET_BUF_TAIL
);
951 InsertTailList (NbufList
, &PduHdr
->List
);
954 // First step, receive the BHS of the PDU.
956 Status
= Tcp4IoReceive (&Conn
->Tcp4Io
, PduHdr
, FALSE
, TimeoutEvent
);
957 if (EFI_ERROR (Status
)) {
963 // TODO: check the header-digest.
966 // Trim off the digest.
968 NetbufTrim (PduHdr
, sizeof (UINT32
), NET_BUF_TAIL
);
971 Len
= ISCSI_GET_DATASEG_LEN (Header
);
979 // Get the length of the padding bytes of the data segment.
981 PadLen
= ISCSI_GET_PAD_LEN (Len
);
983 switch (ISCSI_GET_OPCODE (Header
)) {
984 case ISCSI_OPCODE_SCSI_DATA_IN
:
986 // Try to use the buffer described by Context if the PDU is an
987 // iSCSI SCSI data in pdu so as to reduce memory copy overhead.
989 InDataOffset
= ISCSI_GET_BUFFER_OFFSET (Header
);
990 if ((Context
== NULL
) || ((InDataOffset
+ Len
) > Context
->InDataLen
)) {
991 Status
= EFI_PROTOCOL_ERROR
;
995 Fragment
[0].Len
= Len
;
996 Fragment
[0].Bulk
= Context
->InData
+ InDataOffset
;
998 if (DataDigest
|| (PadLen
!= 0)) {
1000 // The data segment is padded, use two fragments to receive it.
1001 // The first to receive the useful data. The second to receive the padding.
1003 Fragment
[1].Len
= PadLen
+ (DataDigest
? sizeof (UINT32
) : 0);
1004 Fragment
[1].Bulk
= (UINT8
*) ((UINTN
) &PadAndCRC32
[1] - PadLen
);
1011 DataSeg
= NetbufFromExt (&Fragment
[0], FragmentCount
, 0, 0, IScsiNbufExtFree
, NULL
);
1012 if (DataSeg
== NULL
) {
1013 Status
= EFI_OUT_OF_RESOURCES
;
1019 case ISCSI_OPCODE_SCSI_RSP
:
1020 case ISCSI_OPCODE_NOP_IN
:
1021 case ISCSI_OPCODE_LOGIN_RSP
:
1022 case ISCSI_OPCODE_TEXT_RSP
:
1023 case ISCSI_OPCODE_ASYNC_MSG
:
1024 case ISCSI_OPCODE_REJECT
:
1025 case ISCSI_OPCODE_VENDOR_T0
:
1026 case ISCSI_OPCODE_VENDOR_T1
:
1027 case ISCSI_OPCODE_VENDOR_T2
:
1029 // Allocate buffer to receive the data segment.
1031 Len
+= PadLen
+ (DataDigest
? sizeof (UINT32
) : 0);
1032 DataSeg
= NetbufAlloc (Len
);
1033 if (DataSeg
== NULL
) {
1034 Status
= EFI_OUT_OF_RESOURCES
;
1038 NetbufAllocSpace (DataSeg
, Len
, NET_BUF_TAIL
);
1042 Status
= EFI_PROTOCOL_ERROR
;
1046 InsertTailList (NbufList
, &DataSeg
->List
);
1049 // Receive the data segment with the data digest if any.
1051 Status
= Tcp4IoReceive (&Conn
->Tcp4Io
, DataSeg
, FALSE
, TimeoutEvent
);
1052 if (EFI_ERROR (Status
)) {
1058 // TODO: Check the data digest.
1060 NetbufTrim (DataSeg
, sizeof (UINT32
), NET_BUF_TAIL
);
1065 // Trim off the padding bytes in the data segment.
1067 NetbufTrim (DataSeg
, PadLen
, NET_BUF_TAIL
);
1072 // Form the pdu from a list of pdu segments.
1074 *Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
1076 Status
= EFI_OUT_OF_RESOURCES
;
1081 if (EFI_ERROR (Status
)) {
1083 // Free the Nbufs in this NbufList and the NbufList itself.
1085 IScsiFreeNbufList (NbufList
);
1092 Check and get the result of the prameter negotiation.
1094 @param[in] Conn The connection in iSCSI login.
1095 @param[in] Transit Whether need transit.
1097 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
1098 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
1099 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1102 IScsiCheckOpParams (
1103 IN ISCSI_CONNECTION
*Conn
,
1108 LIST_ENTRY
*KeyValueList
;
1111 ISCSI_SESSION
*Session
;
1115 ASSERT (Conn
->RspQue
.BufNum
!= 0);
1117 Session
= Conn
->Session
;
1119 Len
= Conn
->RspQue
.BufSize
;
1120 Data
= AllocatePool (Len
);
1122 return EFI_OUT_OF_RESOURCES
;
1125 NetbufQueCopy (&Conn
->RspQue
, 0, Len
, (UINT8
*) Data
);
1127 Status
= EFI_PROTOCOL_ERROR
;
1130 // Extract the Key-Value pairs into a list.
1132 KeyValueList
= IScsiBuildKeyValueList (Data
, Len
);
1133 if (KeyValueList
== NULL
) {
1134 gBS
->FreePool (Data
);
1140 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_HEADER_DIGEST
);
1141 if (Value
== NULL
) {
1145 if (AsciiStrCmp (Value
, "CRC32") == 0) {
1146 if (Conn
->HeaderDigest
!= ISCSI_DIGEST_CRC32
) {
1149 } else if (AsciiStrCmp (Value
, ISCSI_KEY_VALUE_NONE
) == 0) {
1150 Conn
->HeaderDigest
= ISCSI_DIGEST_NONE
;
1157 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_DIGEST
);
1158 if (Value
== NULL
) {
1162 if (AsciiStrCmp (Value
, "CRC32") == 0) {
1163 if (Conn
->DataDigest
!= ISCSI_DIGEST_CRC32
) {
1166 } else if (AsciiStrCmp (Value
, ISCSI_KEY_VALUE_NONE
) == 0) {
1167 Conn
->DataDigest
= ISCSI_DIGEST_NONE
;
1172 // ErrorRecoveryLevel, result fuction is Minimum.
1174 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_ERROR_RECOVERY_LEVEL
);
1175 if (Value
== NULL
) {
1179 NumericValue
= AsciiStrDecimalToUintn (Value
);
1180 if (NumericValue
> 2) {
1184 Session
->ErrorRecoveryLevel
= (UINT8
) MIN (Session
->ErrorRecoveryLevel
, NumericValue
);
1187 // InitialR2T, result function is OR.
1189 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_INITIAL_R2T
);
1190 if (Value
== NULL
) {
1194 Session
->InitialR2T
= (BOOLEAN
) (Session
->InitialR2T
|| (AsciiStrCmp (Value
, "Yes") == 0));
1197 // ImmediateData, result function is AND.
1199 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_IMMEDIATE_DATA
);
1200 if (Value
== NULL
) {
1204 Session
->ImmediateData
= (BOOLEAN
) (Session
->ImmediateData
&& (AsciiStrCmp (Value
, "Yes") == 0));
1207 // MaxRecvDataSegmentLength, result function is Mininum.
1209 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH
);
1210 if (Value
!= NULL
) {
1212 // MaxRecvDataSegmentLength is declarative.
1214 NumericValue
= AsciiStrDecimalToUintn (Value
);
1216 Conn
->MaxRecvDataSegmentLength
= (UINT32
) MIN (Conn
->MaxRecvDataSegmentLength
, NumericValue
);
1219 // MaxBurstLength, result funtion is Mininum.
1221 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_BURST_LENGTH
);
1222 if (Value
== NULL
) {
1226 NumericValue
= AsciiStrDecimalToUintn (Value
);
1227 Session
->MaxBurstLength
= (UINT32
) MIN (Session
->MaxBurstLength
, NumericValue
);
1230 // FirstBurstLength, result function is Minimum. Irrelevant when InitialR2T=Yes and
1231 // ImmediateData=No.
1233 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_FIRST_BURST_LENGTH
);
1234 if ((Value
== NULL
) && !(Session
->InitialR2T
&& !Session
->ImmediateData
)) {
1238 NumericValue
= AsciiStrDecimalToUintn (Value
);
1239 Session
->FirstBurstLength
= (UINT32
) MIN (Session
->FirstBurstLength
, NumericValue
);
1242 // MaxConnections, result function is Minimum.
1244 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_CONNECTIONS
);
1245 if (Value
== NULL
) {
1249 NumericValue
= AsciiStrDecimalToUintn (Value
);
1250 if ((NumericValue
== 0) || (NumericValue
> 65535)) {
1254 Session
->MaxConnections
= (UINT32
) MIN (Session
->MaxConnections
, NumericValue
);
1257 // DataPDUInOrder, result function is OR.
1259 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_PDU_IN_ORDER
);
1260 if (Value
== NULL
) {
1264 Session
->DataPDUInOrder
= (BOOLEAN
) (Session
->DataPDUInOrder
|| (AsciiStrCmp (Value
, "Yes") == 0));
1267 // DataSequenceInorder, result function is OR.
1269 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
);
1270 if (Value
== NULL
) {
1274 Session
->DataSequenceInOrder
= (BOOLEAN
) (Session
->DataSequenceInOrder
|| (AsciiStrCmp (Value
, "Yes") == 0));
1277 // DefaultTime2Wait, result function is Maximum.
1279 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DEFAULT_TIME2WAIT
);
1280 if (Value
== NULL
) {
1284 NumericValue
= AsciiStrDecimalToUintn (Value
);
1285 if (NumericValue
== 0) {
1286 Session
->DefaultTime2Wait
= 0;
1287 } else if (NumericValue
> 3600) {
1290 Session
->DefaultTime2Wait
= (UINT32
) MAX (Session
->DefaultTime2Wait
, NumericValue
);
1293 // DefaultTime2Retain, result function is Minimum.
1295 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DEFAULT_TIME2RETAIN
);
1296 if (Value
== NULL
) {
1300 NumericValue
= AsciiStrDecimalToUintn (Value
);
1301 if (NumericValue
== 0) {
1302 Session
->DefaultTime2Retain
= 0;
1303 } else if (NumericValue
> 3600) {
1306 Session
->DefaultTime2Retain
= (UINT32
) MIN (Session
->DefaultTime2Retain
, NumericValue
);
1309 // MaxOutstandingR2T, result function is Minimum.
1311 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_OUTSTANDING_R2T
);
1312 if (Value
== NULL
) {
1316 NumericValue
= AsciiStrDecimalToUintn (Value
);
1317 if ((NumericValue
== 0) || (NumericValue
> 65535)) {
1321 Session
->MaxOutstandingR2T
= (UINT16
) MIN (Session
->MaxOutstandingR2T
, NumericValue
);
1324 // Remove declarative key-value paris if any.
1326 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_SESSION_TYPE
);
1327 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_ALIAS
);
1328 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG
);
1330 if (IsListEmpty (KeyValueList
)) {
1332 // Succeed if no more keys in the list.
1334 Status
= EFI_SUCCESS
;
1339 IScsiFreeKeyValueList (KeyValueList
);
1341 gBS
->FreePool (Data
);
1347 Fill the oprational prameters.
1349 @param[in] Conn The connection in iSCSI login.
1350 @param[in] Pdu The iSCSI login request PDU to fill the parameters.
1352 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
1356 IN ISCSI_CONNECTION
*Conn
,
1360 ISCSI_SESSION
*Session
;
1363 Session
= Conn
->Session
;
1365 AsciiSPrint (Value
, sizeof (Value
), "%a", (Conn
->HeaderDigest
== ISCSI_DIGEST_CRC32
) ? "None,CRC32" : "None");
1366 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_HEADER_DIGEST
, Value
);
1368 AsciiSPrint (Value
, sizeof (Value
), "%a", (Conn
->DataDigest
== ISCSI_DIGEST_CRC32
) ? "None,CRC32" : "None");
1369 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_DIGEST
, Value
);
1371 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->ErrorRecoveryLevel
);
1372 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_ERROR_RECOVERY_LEVEL
, Value
);
1374 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->InitialR2T
? "Yes" : "No");
1375 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_INITIAL_R2T
, Value
);
1377 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->ImmediateData
? "Yes" : "No");
1378 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_IMMEDIATE_DATA
, Value
);
1380 AsciiSPrint (Value
, sizeof (Value
), "%d", Conn
->MaxRecvDataSegmentLength
);
1381 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH
, Value
);
1383 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxBurstLength
);
1384 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_BURST_LENGTH
, Value
);
1386 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->FirstBurstLength
);
1387 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_FIRST_BURST_LENGTH
, Value
);
1389 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxConnections
);
1390 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_CONNECTIONS
, Value
);
1392 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->DataPDUInOrder
? "Yes" : "No");
1393 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_PDU_IN_ORDER
, Value
);
1395 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->DataSequenceInOrder
? "Yes" : "No");
1396 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
, Value
);
1398 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->DefaultTime2Wait
);
1399 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DEFAULT_TIME2WAIT
, Value
);
1401 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->DefaultTime2Retain
);
1402 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DEFAULT_TIME2RETAIN
, Value
);
1404 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxOutstandingR2T
);
1405 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_OUTSTANDING_R2T
, Value
);
1411 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1413 @param[in] Pdu The iSCSI pdu which contains segments to pad.
1414 @param[in] Len The length of the last semgnet in the PDU.
1416 @retval EFI_SUCCESS The segment is padded or no need to pad it.
1417 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1429 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1432 Data
= NetbufAllocSpace (Pdu
, PadLen
, NET_BUF_TAIL
);
1434 return EFI_OUT_OF_RESOURCES
;
1437 ZeroMem (Data
, PadLen
);
1444 Build a key-value list from the data segment.
1446 @param[in] Data The data segment containing the key-value pairs.
1447 @param[in] Len Length of the data segment.
1449 @return The key-value list.
1450 @retval NULL Other errors as indicated.
1453 IScsiBuildKeyValueList (
1458 LIST_ENTRY
*ListHead
;
1459 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1461 ListHead
= AllocatePool (sizeof (LIST_ENTRY
));
1462 if (ListHead
== NULL
) {
1466 InitializeListHead (ListHead
);
1469 KeyValuePair
= AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR
));
1470 if (KeyValuePair
== NULL
) {
1474 InitializeListHead (&KeyValuePair
->List
);
1476 KeyValuePair
->Key
= Data
;
1478 while ((Len
> 0) && (*Data
!= '=')) {
1489 gBS
->FreePool (KeyValuePair
);
1493 KeyValuePair
->Value
= Data
;
1495 InsertTailList (ListHead
, &KeyValuePair
->List
);;
1497 Data
+= AsciiStrLen (KeyValuePair
->Value
) + 1;
1498 Len
-= (UINT32
) AsciiStrLen (KeyValuePair
->Value
) + 1;
1505 IScsiFreeKeyValueList (ListHead
);
1511 Get the value string by the key name from the key-value list. If found,
1512 the key-value entry will be removed from the list.
1514 @param[in] KeyValueList The key-value list.
1515 @param[in] Key The key name to find.
1517 @return The value string.
1520 IScsiGetValueByKeyFromList (
1521 IN LIST_ENTRY
*KeyValueList
,
1526 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1531 NET_LIST_FOR_EACH (Entry
, KeyValueList
) {
1532 KeyValuePair
= NET_LIST_USER_STRUCT (Entry
, ISCSI_KEY_VALUE_PAIR
, List
);
1534 if (AsciiStrCmp (KeyValuePair
->Key
, Key
) == 0) {
1535 Value
= KeyValuePair
->Value
;
1537 RemoveEntryList (&KeyValuePair
->List
);
1538 gBS
->FreePool (KeyValuePair
);
1547 Free the key-value list.
1549 @param[in] KeyValueList The key-value list.
1552 IScsiFreeKeyValueList (
1553 IN LIST_ENTRY
*KeyValueList
1557 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1559 while (!IsListEmpty (KeyValueList
)) {
1560 Entry
= NetListRemoveHead (KeyValueList
);
1561 KeyValuePair
= NET_LIST_USER_STRUCT (Entry
, ISCSI_KEY_VALUE_PAIR
, List
);
1563 gBS
->FreePool (KeyValuePair
);
1566 gBS
->FreePool (KeyValueList
);
1570 Normalize the iSCSI name according to RFC.
1572 @param[in] Name The iSCSI name.
1573 @param[in] Len length of the iSCSI name.
1575 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1576 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
1579 IScsiNormalizeName (
1586 for (Index
= 0; Index
< Len
; Index
++) {
1587 if (NET_IS_UPPER_CASE_CHAR (Name
[Index
])) {
1589 // Convert the upper-case characters to lower-case ones
1591 Name
[Index
] = (CHAR8
) (Name
[Index
] - 'A' + 'a');
1594 if (!NET_IS_LOWER_CASE_CHAR (Name
[Index
]) &&
1595 !NET_IS_DIGIT (Name
[Index
]) &&
1596 (Name
[Index
] != '-') &&
1597 (Name
[Index
] != '.') &&
1598 (Name
[Index
] != ':')
1601 // ASCII dash, dot, colon lower-case characters and digit characters
1604 return EFI_PROTOCOL_ERROR
;
1608 if ((Len
< 4) || (CompareMem (Name
, "iqn.", 4) != 0)) {
1610 // Only IQN format is accepted now.
1612 return EFI_PROTOCOL_ERROR
;
1619 Create an iSCSI task control block.
1621 @param[in] Conn The connection on which the task control block will be created.
1622 @param[out] Tcb The newly created task control block.
1624 @retval EFI_SUCCESS The task control block is created.
1625 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1626 @retval EFI_NOT_READY The target can not accept new commands.
1630 IN ISCSI_CONNECTION
*Conn
,
1634 ISCSI_SESSION
*Session
;
1637 ASSERT (Tcb
!= NULL
);
1639 Session
= Conn
->Session
;
1641 if (ISCSI_SEQ_GT (Session
->CmdSN
, Session
->MaxCmdSN
)) {
1642 return EFI_NOT_READY
;
1645 NewTcb
= AllocateZeroPool (sizeof (ISCSI_TCB
));
1646 if (NewTcb
== NULL
) {
1647 return EFI_OUT_OF_RESOURCES
;
1650 InitializeListHead (&NewTcb
->Link
);
1652 NewTcb
->SoFarInOrder
= TRUE
;
1653 NewTcb
->InitiatorTaskTag
= Session
->InitiatorTaskTag
;
1654 NewTcb
->CmdSN
= Session
->CmdSN
;
1655 NewTcb
->Conn
= Conn
;
1657 InsertTailList (&Session
->TcbList
, &NewTcb
->Link
);
1660 // Advance the initiator task tag.
1662 Session
->InitiatorTaskTag
++;
1671 Delete the tcb from the connection and destroy it.
1673 @param[in] Tcb The tcb to delete.
1680 RemoveEntryList (&Tcb
->Link
);
1682 gBS
->FreePool (Tcb
);
1686 Find the task control block by the initator task tag.
1688 @param[in] TcbList The tcb list.
1689 @param[in] InitiatorTaskTag The initiator task tag.
1691 @return The task control block found.
1695 IN LIST_ENTRY
*TcbList
,
1696 IN UINT32 InitiatorTaskTag
1704 NET_LIST_FOR_EACH (Entry
, TcbList
) {
1705 Tcb
= NET_LIST_USER_STRUCT (Entry
, ISCSI_TCB
, Link
);
1707 if (Tcb
->InitiatorTaskTag
== InitiatorTaskTag
) {
1718 Create a data segment, pad it and calculate the CRC if needed.
1720 @param[in] Data The data to fill into the data segment.
1721 @param[in] Len Length of the data.
1722 @param[in] DataDigest Whether to calculate CRC for this data segment.
1724 @return The net buffer wrapping the data segment.
1727 IScsiNewDataSegment (
1730 IN BOOLEAN DataDigest
1733 NET_FRAGMENT Fragment
[2];
1734 UINT32 FragmentCount
;
1738 Fragment
[0].Len
= Len
;
1739 Fragment
[0].Bulk
= Data
;
1741 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1743 Fragment
[1].Len
= PadLen
;
1744 Fragment
[1].Bulk
= (UINT8
*) &mDataSegPad
;
1751 DataSeg
= NetbufFromExt (&Fragment
[0], FragmentCount
, 0, 0, IScsiNbufExtFree
, NULL
);
1757 Create a iSCSI SCSI command PDU to encapsulate the command issued
1758 by SCSI through the EXT SCSI PASS THRU Protocol.
1760 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
1761 @param[in] Lun The LUN.
1762 @param[in] Tcb The tcb assocated with this SCSI command.
1764 @return The created iSCSI SCSI command PDU.
1765 @retval NULL Other errors as indicated.
1768 IScsiNewScsiCmdPdu (
1769 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
1774 LIST_ENTRY
*NbufList
;
1778 SCSI_COMMAND
*ScsiCmd
;
1781 ISCSI_ADDITIONAL_HEADER
*Header
;
1782 ISCSI_BI_EXP_READ_DATA_LEN_AHS
*BiExpReadDataLenAHS
;
1783 ISCSI_SESSION
*Session
;
1784 UINT32 ImmediateDataLen
;
1788 if (Packet
->DataDirection
== DataBi
) {
1790 // Bi directional Read/Write command, the bidirectional expected
1791 // read data length AHS is required.
1793 AHSLength
+= sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS
);
1796 if (Packet
->CdbLength
> 16) {
1798 // The CDB exceeds 16 bytes, an extended CDB AHS is required.
1800 AHSLength
= (UINT8
) (AHSLength
+ (ISCSI_ROUNDUP (Packet
->CdbLength
- 16) + sizeof (ISCSI_ADDITIONAL_HEADER
)));
1803 Length
= sizeof (SCSI_COMMAND
) + AHSLength
;
1804 PduHeader
= NetbufAlloc (Length
);
1805 if (PduHeader
== NULL
) {
1809 ScsiCmd
= (SCSI_COMMAND
*) NetbufAllocSpace (PduHeader
, Length
, NET_BUF_TAIL
);
1810 Header
= (ISCSI_ADDITIONAL_HEADER
*) (ScsiCmd
+ 1);
1812 ZeroMem (ScsiCmd
, Length
);
1814 ISCSI_SET_OPCODE (ScsiCmd
, ISCSI_OPCODE_SCSI_CMD
, 0);
1815 ISCSI_SET_FLAG (ScsiCmd
, ISCSI_TASK_ATTR_SIMPLE
);
1818 // Set the READ/WRITE flags according to the IO type of this request.
1820 switch (Packet
->DataDirection
) {
1822 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_READ
);
1823 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->InTransferLength
);
1827 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_WRITE
);
1828 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->OutTransferLength
);
1832 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_READ
| SCSI_CMD_PDU_FLAG_WRITE
);
1833 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->OutTransferLength
);
1836 // Fill the bidirectional expected read data length AHS.
1838 BiExpReadDataLenAHS
= (ISCSI_BI_EXP_READ_DATA_LEN_AHS
*) Header
;
1839 Header
= (ISCSI_ADDITIONAL_HEADER
*) (BiExpReadDataLenAHS
+ 1);
1841 BiExpReadDataLenAHS
->Length
= NTOHS (5);
1842 BiExpReadDataLenAHS
->Type
= ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN
;
1843 BiExpReadDataLenAHS
->ExpReadDataLength
= NTOHL (Packet
->InTransferLength
);
1848 ScsiCmd
->TotalAHSLength
= AHSLength
;
1849 CopyMem (ScsiCmd
->Lun
, &Lun
, sizeof (ScsiCmd
->Lun
));
1850 ScsiCmd
->InitiatorTaskTag
= NTOHL (Tcb
->InitiatorTaskTag
);
1851 ScsiCmd
->CmdSN
= NTOHL (Tcb
->CmdSN
);
1852 ScsiCmd
->ExpStatSN
= NTOHL (Tcb
->Conn
->ExpStatSN
);
1854 CopyMem (ScsiCmd
->CDB
, Packet
->Cdb
, sizeof (ScsiCmd
->CDB
));
1856 if (Packet
->CdbLength
> 16) {
1857 Header
->Length
= NTOHS (Packet
->CdbLength
- 15);
1858 Header
->Type
= ISCSI_AHS_TYPE_EXT_CDB
;
1860 CopyMem (Header
+ 1, (UINT8
*) Packet
->Cdb
+ 16, Packet
->CdbLength
- 16);
1864 Session
= Tcb
->Conn
->Session
;
1865 ImmediateDataLen
= 0;
1867 if (Session
->ImmediateData
&& (Packet
->OutTransferLength
!= 0)) {
1869 // Send immediate data in this SCSI Command PDU. The length of the immeidate
1870 // data is the minimum of FirstBurstLength, the data length to be xfered and
1871 // the MaxRecvdataSegmentLength on this connection.
1873 ImmediateDataLen
= MIN (Session
->FirstBurstLength
, Packet
->OutTransferLength
);
1874 ImmediateDataLen
= MIN (ImmediateDataLen
, Tcb
->Conn
->MaxRecvDataSegmentLength
);
1877 // Update the data segment length in the PDU header.
1879 ISCSI_SET_DATASEG_LEN (ScsiCmd
, ImmediateDataLen
);
1882 // Create the data segment.
1884 DataSeg
= IScsiNewDataSegment ((UINT8
*) Packet
->OutDataBuffer
, ImmediateDataLen
, FALSE
);
1885 if (DataSeg
== NULL
) {
1886 NetbufFree (PduHeader
);
1891 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
1892 if (NbufList
== NULL
) {
1893 NetbufFree (PduHeader
);
1894 NetbufFree (DataSeg
);
1900 InitializeListHead (NbufList
);
1901 InsertTailList (NbufList
, &PduHeader
->List
);
1902 InsertTailList (NbufList
, &DataSeg
->List
);
1904 Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
1906 IScsiFreeNbufList (NbufList
);
1910 if (Session
->InitialR2T
||
1911 (ImmediateDataLen
== Session
->FirstBurstLength
) ||
1912 (ImmediateDataLen
== Packet
->OutTransferLength
)
1915 // Unsolicited data out sequence is not allowed,
1916 // or FirstBustLength data is already sent out by immediate data
1917 // or all the OUT data accompany this SCSI packet is sent as
1918 // immediate data, the final flag should be set on this SCSI Command
1921 ISCSI_SET_FLAG (ScsiCmd
, ISCSI_BHS_FLAG_FINAL
);
1930 Create a new iSCSI SCSI Data Out PDU.
1932 @param[in] Data The data to put into the Data Out PDU.
1933 @param[in] Len Length of the data.
1934 @param[in] DataSN The DataSN of the Data Out PDU.
1935 @param[in] Tcb The task control block of this Data Out PDU.
1936 @param[in] Lun The LUN.
1938 @return The net buffer wrapping the Data Out PDU.
1939 @retval NULL Other errors as indicated.
1942 IScsiNewDataOutPdu (
1950 LIST_ENTRY
*NbufList
;
1954 ISCSI_SCSI_DATA_OUT
*DataOutHdr
;
1955 ISCSI_XFER_CONTEXT
*XferContext
;
1957 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
1958 if (NbufList
== NULL
) {
1962 InitializeListHead (NbufList
);
1965 // Allocate memory for the BHS.
1967 PduHdr
= NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT
));
1968 if (PduHdr
== NULL
) {
1969 gBS
->FreePool (NbufList
);
1973 // Insert the BHS into the buffer list.
1975 InsertTailList (NbufList
, &PduHdr
->List
);
1977 DataOutHdr
= (ISCSI_SCSI_DATA_OUT
*) NetbufAllocSpace (PduHdr
, sizeof (ISCSI_SCSI_DATA_OUT
), NET_BUF_TAIL
);
1978 XferContext
= &Tcb
->XferContext
;
1980 ZeroMem (DataOutHdr
, sizeof (ISCSI_SCSI_DATA_OUT
));
1983 // Set the flags and fields of the Data Out PDU BHS.
1985 ISCSI_SET_OPCODE (DataOutHdr
, ISCSI_OPCODE_SCSI_DATA_OUT
, 0);
1986 ISCSI_SET_DATASEG_LEN (DataOutHdr
, Len
);
1988 DataOutHdr
->InitiatorTaskTag
= HTONL (Tcb
->InitiatorTaskTag
);
1989 DataOutHdr
->TargetTransferTag
= HTONL (XferContext
->TargetTransferTag
);
1990 DataOutHdr
->ExpStatSN
= HTONL (Tcb
->Conn
->ExpStatSN
);
1991 DataOutHdr
->DataSN
= HTONL (DataSN
);
1992 DataOutHdr
->BufferOffset
= HTONL (XferContext
->Offset
);
1994 if (XferContext
->TargetTransferTag
!= ISCSI_RESERVED_TAG
) {
1995 CopyMem (&DataOutHdr
->Lun
, &Lun
, sizeof (DataOutHdr
->Lun
));
1998 // Build the data segment for this Data Out PDU.
2000 DataSeg
= IScsiNewDataSegment (Data
, Len
, FALSE
);
2001 if (DataSeg
== NULL
) {
2002 IScsiFreeNbufList (NbufList
);
2006 // Put the data segment into the buffer list and combine it with the BHS
2007 // into a full Data Out PDU.
2009 InsertTailList (NbufList
, &DataSeg
->List
);
2010 Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
2012 IScsiFreeNbufList (NbufList
);
2019 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2021 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2022 @param[in] Tcb The task control block of the data to send out.
2023 @param[in] Lun The LUN the data will be sent to.
2025 @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.
2026 @retval NULL Other errors as indicated.
2029 IScsiGenerateDataOutPduSequence (
2035 LIST_ENTRY
*PduList
;
2038 NET_BUF
*DataOutPdu
;
2039 ISCSI_CONNECTION
*Conn
;
2040 ISCSI_XFER_CONTEXT
*XferContext
;
2042 PduList
= AllocatePool (sizeof (LIST_ENTRY
));
2043 if (PduList
== NULL
) {
2047 InitializeListHead (PduList
);
2052 XferContext
= &Tcb
->XferContext
;
2054 while (XferContext
->DesiredLength
> 0) {
2056 // Determine the length of data this Data Out PDU can carry.
2058 DataLen
= MIN (XferContext
->DesiredLength
, Conn
->MaxRecvDataSegmentLength
);
2061 // Create a Data Out PDU.
2063 DataOutPdu
= IScsiNewDataOutPdu (Data
, DataLen
, DataSN
, Tcb
, Lun
);
2064 if (DataOutPdu
== NULL
) {
2065 IScsiFreeNbufList (PduList
);
2071 InsertTailList (PduList
, &DataOutPdu
->List
);
2074 // Update the context and DataSN.
2076 XferContext
->Offset
+= DataLen
;
2077 XferContext
->DesiredLength
-= DataLen
;
2082 // Set the F bit for the last data out PDU in this sequence.
2084 ISCSI_SET_FLAG (NetbufGetByte (DataOutPdu
, 0, NULL
), ISCSI_BHS_FLAG_FINAL
);
2092 Send the Data in a sequence of Data Out PDUs one by one.
2094 @param[in] Data The data to carry by Data Out PDUs.
2095 @param[in] Lun The LUN the data will be sent to.
2096 @param[in] Tcb The task control block.
2098 @retval EFI_SUCCES The data is sent out to the LUN.
2099 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2100 @retval Others Other errors as indicated.
2103 IScsiSendDataOutPduSequence (
2109 LIST_ENTRY
*DataOutPduList
;
2115 // Generate the Data Out PDU sequence.
2117 DataOutPduList
= IScsiGenerateDataOutPduSequence (Data
, Tcb
, Lun
);
2118 if (DataOutPduList
== NULL
) {
2119 return EFI_OUT_OF_RESOURCES
;
2122 Status
= EFI_SUCCESS
;
2125 // Send the Data Out PDU's one by one.
2127 NET_LIST_FOR_EACH (Entry
, DataOutPduList
) {
2128 Pdu
= NET_LIST_USER_STRUCT (Entry
, NET_BUF
, List
);
2130 Status
= Tcp4IoTransmit (&Tcb
->Conn
->Tcp4Io
, Pdu
);
2131 if (EFI_ERROR (Status
)) {
2136 IScsiFreeNbufList (DataOutPduList
);
2142 Process the received iSCSI SCSI Data In PDU.
2144 @param[in] Pdu The Data In PDU received.
2145 @param[in] Tcb The task control block.
2146 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2148 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update
2150 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2151 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2152 @retval Others Other errors as indicated.
2158 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2161 ISCSI_SCSI_DATA_IN
*DataInHdr
;
2164 DataInHdr
= (ISCSI_SCSI_DATA_IN
*) NetbufGetByte (Pdu
, 0, NULL
);
2166 DataInHdr
->InitiatorTaskTag
= NTOHL (DataInHdr
->InitiatorTaskTag
);
2167 DataInHdr
->ExpCmdSN
= NTOHL (DataInHdr
->ExpCmdSN
);
2168 DataInHdr
->MaxCmdSN
= NTOHL (DataInHdr
->MaxCmdSN
);
2169 DataInHdr
->DataSN
= NTOHL (DataInHdr
->DataSN
);
2172 // Check the DataSN.
2174 Status
= IScsiCheckSN (&Tcb
->ExpDataSN
, DataInHdr
->DataSN
);
2175 if (EFI_ERROR (Status
)) {
2179 if (DataInHdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) {
2180 return EFI_PROTOCOL_ERROR
;
2183 // Update the command related sequence numbers.
2185 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, DataInHdr
->MaxCmdSN
, DataInHdr
->ExpCmdSN
);
2187 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID
)) {
2188 if (!ISCSI_FLAG_ON (DataInHdr
, ISCSI_BHS_FLAG_FINAL
)) {
2190 // The S bit is on but the F bit is off.
2192 return EFI_PROTOCOL_ERROR
;
2195 Tcb
->StatusXferd
= TRUE
;
2197 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_DATA_IN_PDU_FLAG_OVERFLOW
| SCSI_DATA_IN_PDU_FLAG_UNDERFLOW
)) {
2199 // Underflow and Overflow are mutual flags.
2201 return EFI_PROTOCOL_ERROR
;
2204 // S bit is on, the StatSN is valid.
2206 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, NTOHL (DataInHdr
->StatSN
));
2207 if (EFI_ERROR (Status
)) {
2211 Packet
->HostAdapterStatus
= 0;
2212 Packet
->TargetStatus
= DataInHdr
->Status
;
2214 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
)) {
2215 Packet
->InTransferLength
+= NTOHL (DataInHdr
->ResidualCount
);
2216 Status
= EFI_BAD_BUFFER_SIZE
;
2219 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_RSP_PDU_FLAG_UNDERFLOW
)) {
2220 Packet
->InTransferLength
-= NTOHL (DataInHdr
->ResidualCount
);
2228 Process the received iSCSI R2T PDU.
2230 @param[in] Pdu The R2T PDU received.
2231 @param[in] Tcb The task control block.
2232 @param[in] Lun The Lun.
2233 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2235 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.
2236 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2237 @retval Others Other errors as indicated.
2244 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2247 ISCSI_READY_TO_TRANSFER
*R2THdr
;
2249 ISCSI_XFER_CONTEXT
*XferContext
;
2252 R2THdr
= (ISCSI_READY_TO_TRANSFER
*) NetbufGetByte (Pdu
, 0, NULL
);
2254 R2THdr
->InitiatorTaskTag
= NTOHL (R2THdr
->InitiatorTaskTag
);
2255 R2THdr
->TargetTransferTag
= NTOHL (R2THdr
->TargetTransferTag
);
2256 R2THdr
->StatSN
= NTOHL (R2THdr
->StatSN
);
2257 R2THdr
->R2TSN
= NTOHL (R2THdr
->R2TSN
);
2258 R2THdr
->BufferOffset
= NTOHL (R2THdr
->BufferOffset
);
2259 R2THdr
->DesiredDataTransferLength
= NTOHL (R2THdr
->DesiredDataTransferLength
);
2261 if ((R2THdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) || !ISCSI_SEQ_EQ (R2THdr
->StatSN
, Tcb
->Conn
->ExpStatSN
)) {
2262 return EFI_PROTOCOL_ERROR
;;
2265 // Check the sequence number.
2267 Status
= IScsiCheckSN (&Tcb
->ExpDataSN
, R2THdr
->R2TSN
);
2268 if (EFI_ERROR (Status
)) {
2272 XferContext
= &Tcb
->XferContext
;
2273 XferContext
->TargetTransferTag
= R2THdr
->TargetTransferTag
;
2274 XferContext
->Offset
= R2THdr
->BufferOffset
;
2275 XferContext
->DesiredLength
= R2THdr
->DesiredDataTransferLength
;
2277 if (((XferContext
->Offset
+ XferContext
->DesiredLength
) > Packet
->OutTransferLength
) ||
2278 (XferContext
->DesiredLength
> Tcb
->Conn
->Session
->MaxBurstLength
)
2280 return EFI_PROTOCOL_ERROR
;
2283 // Send the data solicited by this R2T.
2285 Data
= (UINT8
*) Packet
->OutDataBuffer
+ XferContext
->Offset
;
2286 Status
= IScsiSendDataOutPduSequence (Data
, Lun
, Tcb
);
2292 Process the received iSCSI SCSI Response PDU.
2294 @param[in] Pdu The Response PDU received.
2295 @param[in] Tcb The task control block.
2296 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2298 @retval EFI_SUCCES The Response PDU is processed.
2299 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2300 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2301 @retval Others Other errors as indicated.
2304 IScsiOnScsiRspRcvd (
2307 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2310 SCSI_RESPONSE
*ScsiRspHdr
;
2311 ISCSI_SENSE_DATA
*SenseData
;
2315 ScsiRspHdr
= (SCSI_RESPONSE
*) NetbufGetByte (Pdu
, 0, NULL
);
2317 ScsiRspHdr
->InitiatorTaskTag
= NTOHL (ScsiRspHdr
->InitiatorTaskTag
);
2318 if (ScsiRspHdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) {
2319 return EFI_PROTOCOL_ERROR
;
2322 ScsiRspHdr
->StatSN
= NTOHL (ScsiRspHdr
->StatSN
);
2324 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, ScsiRspHdr
->StatSN
);
2325 if (EFI_ERROR (Status
)) {
2329 ScsiRspHdr
->MaxCmdSN
= NTOHL (ScsiRspHdr
->MaxCmdSN
);
2330 ScsiRspHdr
->ExpCmdSN
= NTOHL (ScsiRspHdr
->ExpCmdSN
);
2331 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, ScsiRspHdr
->MaxCmdSN
, ScsiRspHdr
->ExpCmdSN
);
2333 Tcb
->StatusXferd
= TRUE
;
2335 Packet
->HostAdapterStatus
= ScsiRspHdr
->Response
;
2336 if (Packet
->HostAdapterStatus
!= ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET
) {
2340 Packet
->TargetStatus
= ScsiRspHdr
->Status
;
2342 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW
| SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW
) ||
2343 ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
| SCSI_RSP_PDU_FLAG_UNDERFLOW
)
2345 return EFI_PROTOCOL_ERROR
;
2348 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW
)) {
2349 Packet
->InTransferLength
+= NTOHL (ScsiRspHdr
->BiReadResidualCount
);
2350 Status
= EFI_BAD_BUFFER_SIZE
;
2353 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW
)) {
2354 Packet
->InTransferLength
-= NTOHL (ScsiRspHdr
->BiReadResidualCount
);
2357 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
)) {
2358 if (Packet
->DataDirection
== DataIn
) {
2359 Packet
->InTransferLength
+= NTOHL (ScsiRspHdr
->ResidualCount
);
2361 Packet
->OutTransferLength
+= NTOHL (ScsiRspHdr
->ResidualCount
);
2364 Status
= EFI_BAD_BUFFER_SIZE
;
2367 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_UNDERFLOW
)) {
2368 if (Packet
->DataDirection
== DataIn
) {
2369 Packet
->InTransferLength
-= NTOHL (ScsiRspHdr
->ResidualCount
);
2371 Packet
->OutTransferLength
-= NTOHL (ScsiRspHdr
->ResidualCount
);
2375 DataSegLen
= ISCSI_GET_DATASEG_LEN (ScsiRspHdr
);
2376 if (DataSegLen
!= 0) {
2377 SenseData
= (ISCSI_SENSE_DATA
*) NetbufGetByte (Pdu
, sizeof (SCSI_RESPONSE
), NULL
);
2379 SenseData
->Length
= NTOHS (SenseData
->Length
);
2381 Packet
->SenseDataLength
= (UINT8
) MIN (SenseData
->Length
, Packet
->SenseDataLength
);
2382 if (Packet
->SenseDataLength
!= 0) {
2383 CopyMem (Packet
->SenseData
, &SenseData
->Data
[0], Packet
->SenseDataLength
);
2386 Packet
->SenseDataLength
= 0;
2393 Process the received NOP In PDU.
2395 @param[in] Pdu The NOP In PDU received.
2396 @param[in] Tcb The task control block.
2398 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence
2399 numbers are updated.
2400 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2408 ISCSI_NOP_IN
*NopInHdr
;
2411 NopInHdr
= (ISCSI_NOP_IN
*) NetbufGetByte (Pdu
, 0, NULL
);
2413 NopInHdr
->StatSN
= NTOHL (NopInHdr
->StatSN
);
2414 NopInHdr
->ExpCmdSN
= NTOHL (NopInHdr
->ExpCmdSN
);
2415 NopInHdr
->MaxCmdSN
= NTOHL (NopInHdr
->MaxCmdSN
);
2417 if (NopInHdr
->InitiatorTaskTag
== ISCSI_RESERVED_TAG
) {
2418 if (NopInHdr
->StatSN
!= Tcb
->Conn
->ExpStatSN
) {
2419 return EFI_PROTOCOL_ERROR
;
2422 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, NopInHdr
->StatSN
);
2423 if (EFI_ERROR (Status
)) {
2428 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, NopInHdr
->MaxCmdSN
, NopInHdr
->ExpCmdSN
);
2434 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2436 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2437 @param[in] Target The target ID.
2438 @param[in] Lun The LUN.
2439 @param[in, out] Packet The request packet containing IO request, SCSI command
2440 buffer and buffers to read/write.
2442 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
2444 @retval EFI_DEVICE_ERROR Session state was not as required.
2445 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2446 @retval Others Other errors as indicated.
2449 IScsiExecuteScsiCommand (
2450 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
2453 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2457 ISCSI_DRIVER_DATA
*Private
;
2458 ISCSI_SESSION
*Session
;
2459 EFI_EVENT TimeoutEvent
;
2460 ISCSI_CONNECTION
*Conn
;
2463 ISCSI_XFER_CONTEXT
*XferContext
;
2465 ISCSI_IN_BUFFER_CONTEXT InBufferContext
;
2469 Private
= ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru
);
2470 Session
= &Private
->Session
;
2471 Status
= EFI_SUCCESS
;
2473 TimeoutEvent
= NULL
;
2476 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
2477 return EFI_DEVICE_ERROR
;
2480 Conn
= NET_LIST_USER_STRUCT_S (
2481 Session
->Conns
.ForwardLink
,
2484 ISCSI_CONNECTION_SIGNATURE
2487 if (Packet
->Timeout
!= 0) {
2488 Timeout
= MultU64x32 (Packet
->Timeout
, 2);
2491 Status
= IScsiNewTcb (Conn
, &Tcb
);
2492 if (EFI_ERROR (Status
)) {
2496 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2498 Pdu
= IScsiNewScsiCmdPdu (Packet
, Lun
, Tcb
);
2500 Status
= EFI_OUT_OF_RESOURCES
;
2504 XferContext
= &Tcb
->XferContext
;
2505 Buffer
= NetbufGetByte (Pdu
, 0, NULL
);
2506 XferContext
->Offset
= ISCSI_GET_DATASEG_LEN (Buffer
);
2509 // Transmit the SCSI Command PDU.
2511 Status
= Tcp4IoTransmit (&Conn
->Tcp4Io
, Pdu
);
2515 if (EFI_ERROR (Status
)) {
2519 if (!Session
->InitialR2T
&&
2520 (XferContext
->Offset
< Session
->FirstBurstLength
) &&
2521 (XferContext
->Offset
< Packet
->OutTransferLength
)
2524 // Unsolicited Data-Out sequence is allowed, there is remaining SCSI
2525 // OUT data and the limit of FirstBurstLength is not reached.
2527 XferContext
->TargetTransferTag
= ISCSI_RESERVED_TAG
;
2528 XferContext
->DesiredLength
= MIN (
2529 Session
->FirstBurstLength
,
2530 Packet
->OutTransferLength
- XferContext
->Offset
2533 Data
= (UINT8
*) Packet
->OutDataBuffer
+ XferContext
->Offset
;
2534 Status
= IScsiSendDataOutPduSequence (Data
, Lun
, Tcb
);
2535 if (EFI_ERROR (Status
)) {
2540 InBufferContext
.InData
= (UINT8
*) Packet
->InDataBuffer
;
2541 InBufferContext
.InDataLen
= Packet
->InTransferLength
;
2543 while (!Tcb
->StatusXferd
) {
2545 // Start the timeout timer.
2548 Status
= gBS
->SetTimer (Conn
->TimeoutEvent
, TimerRelative
, Timeout
);
2549 if (EFI_ERROR (Status
)) {
2552 TimeoutEvent
= Conn
->TimeoutEvent
;
2555 // try to receive PDU from target.
2557 Status
= IScsiReceivePdu (Conn
, &Pdu
, &InBufferContext
, FALSE
, FALSE
, TimeoutEvent
);
2558 if (EFI_ERROR (Status
)) {
2562 switch (ISCSI_GET_OPCODE (NetbufGetByte (Pdu
, 0, NULL
))) {
2563 case ISCSI_OPCODE_SCSI_DATA_IN
:
2564 Status
= IScsiOnDataInRcvd (Pdu
, Tcb
, Packet
);
2567 case ISCSI_OPCODE_R2T
:
2568 Status
= IScsiOnR2TRcvd (Pdu
, Tcb
, Lun
, Packet
);
2571 case ISCSI_OPCODE_SCSI_RSP
:
2572 Status
= IScsiOnScsiRspRcvd (Pdu
, Tcb
, Packet
);
2575 case ISCSI_OPCODE_NOP_IN
:
2576 Status
= IScsiOnNopInRcvd (Pdu
, Tcb
);
2579 case ISCSI_OPCODE_VENDOR_T0
:
2580 case ISCSI_OPCODE_VENDOR_T1
:
2581 case ISCSI_OPCODE_VENDOR_T2
:
2583 // These messages are vendor specific, skip them.
2588 Status
= EFI_PROTOCOL_ERROR
;
2594 if (EFI_ERROR (Status
)) {
2601 if (TimeoutEvent
!= NULL
) {
2602 gBS
->SetTimer (TimeoutEvent
, TimerCancel
, 0);
2609 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_READY
)) {
2611 // Reinstate the session.
2613 if (EFI_ERROR (IScsiSessionReinstatement (Private
))) {
2614 Status
= EFI_DEVICE_ERROR
;
2622 Reinstate the session on some error.
2624 @param[in] Private The iSCSI driver data.
2626 @retval EFI_SUCCES The session is reinstated from some error.
2627 @retval Other Reinstatement failed.
2630 IScsiSessionReinstatement (
2631 IN ISCSI_DRIVER_DATA
*Private
2634 ISCSI_SESSION
*Session
;
2637 Session
= &Private
->Session
;
2638 ASSERT (Session
->State
== SESSION_STATE_LOGGED_IN
);
2641 // Abort the session and re-init it.
2643 IScsiSessionAbort (Session
);
2644 IScsiSessionInit (Session
, TRUE
);
2649 Status
= IScsiSessionLogin (Private
);
2655 Initialize some session parameters before login.
2657 @param[in, out] Session The iSCSI session.
2658 @param[in] Recovery Whether the request is from a fresh new start or recovery.
2662 IN OUT ISCSI_SESSION
*Session
,
2669 Session
->Signature
= ISCSI_SESSION_SIGNATURE
;
2670 Session
->State
= SESSION_STATE_FREE
;
2672 Random
= NET_RANDOM (NetRandomInitSeed ());
2674 Session
->ISID
[0] = ISID_BYTE_0
;
2675 Session
->ISID
[1] = ISID_BYTE_1
;
2676 Session
->ISID
[2] = ISID_BYTE_2
;
2677 Session
->ISID
[3] = ISID_BYTE_3
;
2678 Session
->ISID
[4] = (UINT8
) Random
;
2679 Session
->ISID
[5] = (UINT8
) (Random
>> 8);
2681 InitializeListHead (&Session
->Conns
);
2682 InitializeListHead (&Session
->TcbList
);
2688 Session
->InitiatorTaskTag
= 1;
2689 Session
->NextCID
= 1;
2691 Session
->TargetPortalGroupTag
= 0;
2692 Session
->MaxConnections
= ISCSI_MAX_CONNS_PER_SESSION
;
2693 Session
->InitialR2T
= FALSE
;
2694 Session
->ImmediateData
= TRUE
;
2695 Session
->MaxBurstLength
= 262144;
2696 Session
->FirstBurstLength
= MAX_RECV_DATA_SEG_LEN_IN_FFP
;
2697 Session
->DefaultTime2Wait
= 2;
2698 Session
->DefaultTime2Retain
= 20;
2699 Session
->MaxOutstandingR2T
= DEFAULT_MAX_OUTSTANDING_R2T
;
2700 Session
->DataPDUInOrder
= TRUE
;
2701 Session
->DataSequenceInOrder
= TRUE
;
2702 Session
->ErrorRecoveryLevel
= 0;
2706 Abort the iSCSI session, that is, reset all the connection and free the
2709 @param[in] Session The iSCSI session.
2711 @retval EFI_SUCCES The session is aborted.
2715 IN ISCSI_SESSION
*Session
2718 ISCSI_DRIVER_DATA
*Private
;
2719 ISCSI_CONNECTION
*Conn
;
2721 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
2725 ASSERT (!IsListEmpty (&Session
->Conns
));
2727 Private
= ISCSI_DRIVER_DATA_FROM_SESSION (Session
);
2729 while (!IsListEmpty (&Session
->Conns
)) {
2730 Conn
= NET_LIST_USER_STRUCT_S (
2731 Session
->Conns
.ForwardLink
,
2734 ISCSI_CONNECTION_SIGNATURE
2737 gBS
->CloseProtocol (
2738 Conn
->Tcp4Io
.Handle
,
2739 &gEfiTcp4ProtocolGuid
,
2741 Private
->ExtScsiPassThruHandle
2744 IScsiConnReset (Conn
);
2746 IScsiDetatchConnection (Conn
);
2747 IScsiDestroyConnection (Conn
);
2750 Session
->State
= SESSION_STATE_FAILED
;