2 The implementation of iSCSI protocol based on RFC3720.
4 Copyright (c) 2004 - 2013, 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.
26 IScsiAttatchConnection (
27 IN OUT ISCSI_SESSION
*Session
,
28 IN OUT 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, out] Conn The iSCSI connection.
42 IScsiDetatchConnection (
43 IN OUT ISCSI_CONNECTION
*Conn
46 RemoveEntryList (&Conn
->Link
);
47 Conn
->Session
->NumConns
--;
52 Check the sequence number according to RFC3720.
54 @param[in, out] 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, out] 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 OUT 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, out] 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 OUT 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, out] Conn The iSCSI connection to reset.
171 IN OUT 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
)) {
222 NetbufQueInit (&Conn
->RspQue
);
225 // set the default connection-only parameters
227 Conn
->MaxRecvDataSegmentLength
= DEFAULT_MAX_RECV_DATA_SEG_LEN
;
228 Conn
->HeaderDigest
= IScsiDigestNone
;
229 Conn
->DataDigest
= IScsiDigestNone
;
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
);
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
);
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 EFI_NO_MEDIA There was a media error.
280 @retval Others Other errors as indicated.
285 IN ISCSI_DRIVER_DATA
*Private
289 ISCSI_SESSION
*Session
;
290 ISCSI_CONNECTION
*Conn
;
291 EFI_TCP4_PROTOCOL
*Tcp4
;
292 BOOLEAN MediaPresent
;
294 Session
= &Private
->Session
;
297 // Check media status before session login
300 NetLibDetectMedia (Private
->Controller
, &MediaPresent
);
306 // Set session identifier
308 CopyMem (Session
->Isid
, Session
->ConfigData
.NvData
.IsId
, 6);
311 // Create a connection for the session.
313 Conn
= IScsiCreateConnection (Private
, Session
);
315 return EFI_OUT_OF_RESOURCES
;
318 IScsiAttatchConnection (Session
, Conn
);
321 // Login througth the newly created connection.
323 Status
= IScsiConnLogin (Conn
);
324 if (EFI_ERROR (Status
)) {
325 IScsiConnReset (Conn
);
326 IScsiDetatchConnection (Conn
);
327 IScsiDestroyConnection (Conn
);
329 Session
->State
= SESSION_STATE_LOGGED_IN
;
333 &gEfiTcp4ProtocolGuid
,
336 Private
->ExtScsiPassThruHandle
,
337 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
345 Build and send the iSCSI login request to the iSCSI target according to
346 the current login stage.
348 @param[in] Conn The connection in the iSCSI login phase.
350 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
352 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
353 @retval EFI_DEVICE_ERROR Some kind of device error happened.
357 IN ISCSI_CONNECTION
*Conn
364 // build the Login Request PDU
366 Pdu
= IScsiPrepareLoginReq (Conn
);
368 return EFI_DEVICE_ERROR
;
371 // Send it to the iSCSI target.
373 Status
= Tcp4IoTransmit (&Conn
->Tcp4Io
, Pdu
);
381 Receive and process the iSCSI login response.
383 @param[in] Conn The connection in the iSCSI login phase.
385 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
386 @retval Others Other errors as indicated.
389 IScsiReceiveLoginRsp (
390 IN ISCSI_CONNECTION
*Conn
397 // Receive the iSCSI login response.
399 Status
= IScsiReceivePdu (Conn
, &Pdu
, NULL
, FALSE
, FALSE
, NULL
);
400 if (EFI_ERROR (Status
)) {
404 // A Login Response is received, process it.
406 ASSERT (Pdu
!= NULL
);
407 Status
= IScsiProcessLoginRsp (Conn
, Pdu
);
415 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
416 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
419 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
421 @param[in] Key The key name string.
422 @param[in] Value The value string.
424 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
425 the correspondence length fields are updated.
426 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
430 IScsiAddKeyValuePair (
440 ISCSI_LOGIN_REQUEST
*LoginReq
;
443 LoginReq
= (ISCSI_LOGIN_REQUEST
*) NetbufGetByte (Pdu
, 0, NULL
);
444 if (LoginReq
== NULL
) {
445 return EFI_PROTOCOL_ERROR
;
447 DataSegLen
= NTOH24 (LoginReq
->DataSegmentLength
);
449 KeyLen
= (UINT32
) AsciiStrLen (Key
);
450 ValueLen
= (UINT32
) AsciiStrLen (Value
);
453 // 1 byte for the key value separator '=' and 1 byte for the null
454 // delimiter after the value.
456 TotalLen
= KeyLen
+ 1 + ValueLen
+ 1;
459 // Allocate the space for the key-value pair.
461 Data
= (CHAR8
*)NetbufAllocSpace (Pdu
, TotalLen
, NET_BUF_TAIL
);
463 return EFI_OUT_OF_RESOURCES
;
468 CopyMem (Data
, Key
, KeyLen
);
477 CopyMem (Data
, Value
, ValueLen
);
483 // update the DataSegmentLength
485 ISCSI_SET_DATASEG_LEN (LoginReq
, DataSegLen
+ TotalLen
);
491 Prepare the iSCSI login request to be sent according to the current login status.
493 @param[in, out] Conn The connection in the iSCSI login phase.
495 @return The pointer to the net buffer containing the iSCSI login request built.
496 @retval Others Other errors as indicated.
499 IScsiPrepareLoginReq (
500 IN OUT ISCSI_CONNECTION
*Conn
503 ISCSI_SESSION
*Session
;
505 ISCSI_LOGIN_REQUEST
*LoginReq
;
508 Session
= Conn
->Session
;
510 Nbuf
= NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST
) + DEFAULT_MAX_RECV_DATA_SEG_LEN
);
515 LoginReq
= (ISCSI_LOGIN_REQUEST
*) NetbufAllocSpace (Nbuf
, sizeof (ISCSI_LOGIN_REQUEST
), NET_BUF_TAIL
);
516 ASSERT (LoginReq
!= NULL
);
517 ZeroMem (LoginReq
, sizeof (ISCSI_LOGIN_REQUEST
));
520 // Init the login request pdu
522 ISCSI_SET_OPCODE (LoginReq
, ISCSI_OPCODE_LOGIN_REQ
, ISCSI_REQ_IMMEDIATE
);
523 ISCSI_SET_STAGES (LoginReq
, Conn
->CurrentStage
, Conn
->NextStage
);
524 LoginReq
->VersionMax
= ISCSI_VERSION_MAX
;
525 LoginReq
->VersionMin
= ISCSI_VERSION_MIN
;
526 LoginReq
->Tsih
= HTONS (Session
->Tsih
);
527 LoginReq
->InitiatorTaskTag
= HTONL (Session
->InitiatorTaskTag
);
528 LoginReq
->Cid
= HTONS (Conn
->Cid
);
529 LoginReq
->CmdSN
= HTONL (Session
->CmdSN
);
532 // For the first Login Request on a coonection this is ExpStatSN for the
533 // old connection and this field is only valid if the Login Request restarts
535 // For subsequent Login Requests it is used to acknowledge the Login Responses
536 // with their increasing StatSN values.
538 LoginReq
->ExpStatSN
= HTONL (Conn
->ExpStatSN
);
539 CopyMem (LoginReq
->Isid
, Session
->Isid
, sizeof (LoginReq
->Isid
));
541 if (Conn
->PartialRspRcvd
) {
543 // A partial response, initiator must send an empty Login Request.
548 switch (Conn
->CurrentStage
) {
549 case ISCSI_SECURITY_NEGOTIATION
:
550 Status
= IScsiCHAPToSendReq (Conn
, Nbuf
);
553 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
:
554 Status
= IScsiFillOpParams (Conn
, Nbuf
);
555 ISCSI_SET_FLAG (LoginReq
, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
);
560 // something error happens...
562 Status
= EFI_DEVICE_ERROR
;
566 if (EFI_ERROR (Status
)) {
571 // Pad the data segment if needed.
573 IScsiPadSegment (Nbuf
, ISCSI_GET_DATASEG_LEN (LoginReq
));
575 // Check whether we will issue the stage transition signal?
577 Conn
->TransitInitiated
= (BOOLEAN
) ISCSI_FLAG_ON (LoginReq
, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
);
584 Process the iSCSI Login Response.
586 @param[in, out] Conn The connection on which the iSCSI login response is received.
587 @param[in, out] Pdu The iSCSI login response PDU.
589 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.
590 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
591 @retval EFI_MEDIA_CHANGED Target is redirected.
592 @retval Others Other errors as indicated.
595 IScsiProcessLoginRsp (
596 IN OUT ISCSI_CONNECTION
*Conn
,
601 ISCSI_SESSION
*Session
;
602 ISCSI_LOGIN_RESPONSE
*LoginRsp
;
610 Session
= Conn
->Session
;
612 LoginRsp
= (ISCSI_LOGIN_RESPONSE
*) NetbufGetByte (Pdu
, 0, NULL
);
613 if (LoginRsp
== NULL
) {
614 return EFI_PROTOCOL_ERROR
;
616 if (!ISCSI_CHECK_OPCODE (LoginRsp
, ISCSI_OPCODE_LOGIN_RSP
)) {
618 // It's not a Login Response
620 return EFI_PROTOCOL_ERROR
;
623 // Get the data segment if any.
625 DataSegLen
= ISCSI_GET_DATASEG_LEN (LoginRsp
);
626 if (DataSegLen
!= 0) {
627 DataSeg
= NetbufGetByte (Pdu
, sizeof (ISCSI_LOGIN_RESPONSE
), NULL
);
632 // Check the status class in the login response PDU.
634 switch (LoginRsp
->StatusClass
) {
635 case ISCSI_LOGIN_STATUS_SUCCESS
:
637 // Just break here, the response and the data segment will be processed later.
641 case ISCSI_LOGIN_STATUS_REDIRECTION
:
643 // The target may be moved to a different address
645 if (DataSeg
== NULL
) {
646 return EFI_PROTOCOL_ERROR
;
649 // Process the TargetAddress key-value strings in the data segment to update the
650 // target address info.
652 Status
= IScsiUpdateTargetAddress (Session
, (CHAR8
*)DataSeg
, DataSegLen
);
653 if (EFI_ERROR (Status
)) {
657 // Session will be restarted on this error status because the Target is
658 // redirected by this Login Response.
660 return EFI_MEDIA_CHANGED
;
664 // Initiator Error, Target Error, or any other undefined error code.
666 return EFI_PROTOCOL_ERROR
;
669 // The status is sucess, extract the wanted fields from the header segment.
671 Transit
= (BOOLEAN
) ISCSI_FLAG_ON (LoginRsp
, ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT
);
672 Continue
= (BOOLEAN
) ISCSI_FLAG_ON (LoginRsp
, ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE
);
674 CurrentStage
= (UINT8
) ISCSI_GET_CURRENT_STAGE (LoginRsp
);
675 NextStage
= (UINT8
) ISCSI_GET_NEXT_STAGE (LoginRsp
);
677 LoginRsp
->InitiatorTaskTag
= NTOHL (LoginRsp
->InitiatorTaskTag
);
679 if ((Transit
&& Continue
) ||
680 (CurrentStage
!= Conn
->CurrentStage
) ||
681 (!Conn
->TransitInitiated
&& Transit
) ||
682 (Transit
&& (NextStage
!= Conn
->NextStage
)) ||
683 (CompareMem (Session
->Isid
, LoginRsp
->Isid
, sizeof (LoginRsp
->Isid
)) != 0) ||
684 (LoginRsp
->InitiatorTaskTag
!= Session
->InitiatorTaskTag
)
687 // A Login Response with the C bit set to 1 MUST have the T bit set to 0;
688 // The CSG in the Login Response MUST be the same with the I-end of this connection;
689 // The T bit can't be 1 if the last Login Response sent by the initiator doesn't
690 // initiate the transistion;
691 // The NSG MUST be the same with the I-end of this connection if Transit is required.
692 // The ISID in the Login Response MUST be the same with this session.
694 return EFI_PROTOCOL_ERROR
;
697 LoginRsp
->StatSN
= NTOHL (LoginRsp
->StatSN
);
698 LoginRsp
->ExpCmdSN
= NTOHL (LoginRsp
->ExpCmdSN
);
699 LoginRsp
->MaxCmdSN
= NTOHL (LoginRsp
->MaxCmdSN
);
701 if ((Conn
->CurrentStage
== ISCSI_SECURITY_NEGOTIATION
) && (Conn
->CHAPStep
== ISCSI_CHAP_INITIAL
)) {
703 // If the Login Request is a leading Login Request, the target MUST use
704 // the value presented in CmdSN as the target value for ExpCmdSN.
706 if ((Session
->State
== SESSION_STATE_FREE
) && (Session
->CmdSN
!= LoginRsp
->ExpCmdSN
)) {
707 return EFI_PROTOCOL_ERROR
;
711 // It's the initial Login Response, initialize the local ExpStatSN, MaxCmdSN
714 Conn
->ExpStatSN
= LoginRsp
->StatSN
+ 1;
715 Session
->MaxCmdSN
= LoginRsp
->MaxCmdSN
;
716 Session
->ExpCmdSN
= LoginRsp
->ExpCmdSN
;
719 // Check the StatSN of this PDU
721 Status
= IScsiCheckSN (&Conn
->ExpStatSN
, LoginRsp
->StatSN
);
722 if (!EFI_ERROR (Status
)) {
724 // Update the MaxCmdSN and ExpCmdSN
726 IScsiUpdateCmdSN (Session
, LoginRsp
->MaxCmdSN
, LoginRsp
->ExpCmdSN
);
732 // Trim off the header segment.
734 NetbufTrim (Pdu
, sizeof (ISCSI_LOGIN_RESPONSE
), NET_BUF_HEAD
);
737 // Queue this login response first in case it's a partial response so that
738 // later when the full response list is received we can combine these scattered
739 // responses' data segment and then process it.
742 NetbufQueAppend (&Conn
->RspQue
, Pdu
);
744 Conn
->PartialRspRcvd
= Continue
;
747 // It's a partial response, have to wait for another or more Request/Response
748 // conversations to get the full response.
753 switch (CurrentStage
) {
754 case ISCSI_SECURITY_NEGOTIATION
:
756 // In security negotiation stage, let CHAP module handle it.
758 Status
= IScsiCHAPOnRspReceived (Conn
);
761 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
:
763 // Response received with negotiation resonse on iSCSI parameters, check them.
765 Status
= IScsiCheckOpParams (Conn
);
770 // Should never get here.
772 Status
= EFI_PROTOCOL_ERROR
;
776 if (Transit
&& (Status
== EFI_SUCCESS
)) {
778 // Do the state transition.
780 Conn
->CurrentStage
= Conn
->NextStage
;
782 if (Conn
->CurrentStage
== ISCSI_LOGIN_OPERATIONAL_NEGOTIATION
) {
783 Conn
->NextStage
= ISCSI_FULL_FEATURE_PHASE
;
786 // CurrentStage is iSCSI Full Feature, it's the Login-Final Response,
787 // get the TSIH from the Login Response.
789 Session
->Tsih
= NTOHS (LoginRsp
->Tsih
);
793 // Flush the response(s) received.
795 NetbufQueFlush (&Conn
->RspQue
);
801 Updated the target information according the data received in the iSCSI
802 login response with an target redirection status.
804 @param[in, out] Session The iSCSI session.
805 @param[in] Data The data segment which should contain the
806 TargetAddress key-value list.
807 @param[in] Len Length of the data.
809 @retval EFI_SUCCESS The target address is updated.
810 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
811 @retval EFI_NOT_FOUND The TargetAddress key is not found.
812 @retval Others Other errors as indicated.
815 IScsiUpdateTargetAddress (
816 IN OUT ISCSI_SESSION
*Session
,
821 LIST_ENTRY
*KeyValueList
;
822 CHAR8
*TargetAddress
;
827 KeyValueList
= IScsiBuildKeyValueList (Data
, Len
);
828 if (KeyValueList
== NULL
) {
829 return EFI_OUT_OF_RESOURCES
;
832 Status
= EFI_NOT_FOUND
;
835 TargetAddress
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_ADDRESS
);
836 if (TargetAddress
== NULL
) {
840 if (!NET_IS_DIGIT (TargetAddress
[0])) {
842 // The domainname of the target may be presented in three formats: a DNS host name,
843 // a dotted-decimal IPv4 address, or a bracketed IPv6 address. Only accept dotted
849 IpStr
= TargetAddress
;
851 while ((*TargetAddress
!= 0) && (*TargetAddress
!= ':') && (*TargetAddress
!= ',')) {
853 // NULL, ':' or ',' ends the IPv4 string.
858 if (*TargetAddress
== ',') {
860 // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent
861 // as the result of a redirection.
864 } else if (*TargetAddress
== ':') {
865 *TargetAddress
= '\0';
869 Number
= AsciiStrDecimalToUintn (TargetAddress
);
870 if (Number
> 0xFFFF) {
873 Session
->ConfigData
.NvData
.TargetPort
= (UINT16
) Number
;
877 // The string only contains the IPv4 address. Use the well known port.
879 Session
->ConfigData
.NvData
.TargetPort
= ISCSI_WELL_KNOWN_PORT
;
882 // Update the target IP address.
884 Status
= IScsiAsciiStrToIp (IpStr
, &Session
->ConfigData
.NvData
.TargetIp
);
885 if (EFI_ERROR (Status
)) {
892 IScsiFreeKeyValueList (KeyValueList
);
898 The callback function to free the net buffer list.
900 @param[in] Arg The opaque parameter.
908 ASSERT (Arg
!= NULL
);
910 NetbufFreeList ((LIST_ENTRY
*) Arg
);
915 The callback function called in NetBufFree, it does nothing.
917 @param[in] Arg The opaque parameter.
928 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
929 an optional data segment. The two parts will be put into two blocks of buffers in the
930 net buffer. The digest check will be conducted in this function if needed and the digests
931 will be trimmed from the PDU buffer.
933 @param[in] Conn The iSCSI connection to receive data from.
934 @param[out] Pdu The received iSCSI pdu.
935 @param[in] Context The context used to describe information on the caller provided
936 buffer to receive data segment of the iSCSI pdu, it's optional.
937 @param[in] HeaderDigest Whether there will be header digest received.
938 @param[in] DataDigest Whether there will be data digest.
939 @param[in] TimeoutEvent The timeout event, it's optional.
941 @retval EFI_SUCCESS An iSCSI pdu is received.
942 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
943 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
944 @retval Others Other errors as indicated.
948 IN ISCSI_CONNECTION
*Conn
,
950 IN ISCSI_IN_BUFFER_CONTEXT
*Context
, OPTIONAL
951 IN BOOLEAN HeaderDigest
,
952 IN BOOLEAN DataDigest
,
953 IN EFI_EVENT TimeoutEvent OPTIONAL
956 LIST_ENTRY
*NbufList
;
963 NET_FRAGMENT Fragment
[2];
964 UINT32 FragmentCount
;
966 UINT32 PadAndCRC32
[2];
968 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
969 if (NbufList
== NULL
) {
970 return EFI_OUT_OF_RESOURCES
;
973 InitializeListHead (NbufList
);
976 // The header digest will be received together with the PDU header if exists.
978 Len
= sizeof (ISCSI_BASIC_HEADER
) + (HeaderDigest
? sizeof (UINT32
) : 0);
979 PduHdr
= NetbufAlloc (Len
);
980 if (PduHdr
== NULL
) {
982 return EFI_OUT_OF_RESOURCES
;
985 Header
= NetbufAllocSpace (PduHdr
, Len
, NET_BUF_TAIL
);
986 ASSERT (Header
!= NULL
);
987 InsertTailList (NbufList
, &PduHdr
->List
);
990 // First step, receive the BHS of the PDU.
992 Status
= Tcp4IoReceive (&Conn
->Tcp4Io
, PduHdr
, FALSE
, TimeoutEvent
);
993 if (EFI_ERROR (Status
)) {
999 // TODO: check the header-digest.
1002 // Trim off the digest.
1004 NetbufTrim (PduHdr
, sizeof (UINT32
), NET_BUF_TAIL
);
1007 Len
= ISCSI_GET_DATASEG_LEN (Header
);
1010 // No data segment.Form the pdu from a list of pdu segments.
1012 *Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
1014 Status
= EFI_OUT_OF_RESOURCES
;
1020 // Get the length of the padding bytes of the data segment.
1022 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1024 switch (ISCSI_GET_OPCODE (Header
)) {
1025 case ISCSI_OPCODE_SCSI_DATA_IN
:
1027 // Try to use the buffer described by Context if the PDU is an
1028 // iSCSI SCSI data in pdu so as to reduce memory copy overhead.
1030 InDataOffset
= ISCSI_GET_BUFFER_OFFSET (Header
);
1031 if ((Context
== NULL
) || ((InDataOffset
+ Len
) > Context
->InDataLen
)) {
1032 Status
= EFI_PROTOCOL_ERROR
;
1036 Fragment
[0].Len
= Len
;
1037 Fragment
[0].Bulk
= Context
->InData
+ InDataOffset
;
1039 if (DataDigest
|| (PadLen
!= 0)) {
1041 // The data segment is padded, use two fragments to receive it.
1042 // The first to receive the useful data. The second to receive the padding.
1044 Fragment
[1].Len
= PadLen
+ (DataDigest
? sizeof (UINT32
) : 0);
1045 Fragment
[1].Bulk
= (UINT8
*)PadAndCRC32
+ (4 - PadLen
);
1051 DataSeg
= NetbufFromExt (&Fragment
[0], FragmentCount
, 0, 0, IScsiNbufExtFree
, NULL
);
1052 if (DataSeg
== NULL
) {
1053 Status
= EFI_OUT_OF_RESOURCES
;
1059 case ISCSI_OPCODE_SCSI_RSP
:
1060 case ISCSI_OPCODE_NOP_IN
:
1061 case ISCSI_OPCODE_LOGIN_RSP
:
1062 case ISCSI_OPCODE_TEXT_RSP
:
1063 case ISCSI_OPCODE_ASYNC_MSG
:
1064 case ISCSI_OPCODE_REJECT
:
1065 case ISCSI_OPCODE_VENDOR_T0
:
1066 case ISCSI_OPCODE_VENDOR_T1
:
1067 case ISCSI_OPCODE_VENDOR_T2
:
1069 // Allocate buffer to receive the data segment.
1071 Len
+= PadLen
+ (DataDigest
? sizeof (UINT32
) : 0);
1072 DataSeg
= NetbufAlloc (Len
);
1073 if (DataSeg
== NULL
) {
1074 Status
= EFI_OUT_OF_RESOURCES
;
1078 NetbufAllocSpace (DataSeg
, Len
, NET_BUF_TAIL
);
1082 Status
= EFI_PROTOCOL_ERROR
;
1086 InsertTailList (NbufList
, &DataSeg
->List
);
1089 // Receive the data segment with the data digest if any.
1091 Status
= Tcp4IoReceive (&Conn
->Tcp4Io
, DataSeg
, FALSE
, TimeoutEvent
);
1092 if (EFI_ERROR (Status
)) {
1098 // TODO: Check the data digest.
1100 NetbufTrim (DataSeg
, sizeof (UINT32
), NET_BUF_TAIL
);
1105 // Trim off the padding bytes in the data segment.
1107 NetbufTrim (DataSeg
, PadLen
, NET_BUF_TAIL
);
1111 // Form the pdu from a list of pdu segments.
1113 *Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
1115 Status
= EFI_OUT_OF_RESOURCES
;
1120 if (EFI_ERROR (Status
)) {
1122 // Free the Nbufs in this NbufList and the NbufList itself.
1124 IScsiFreeNbufList (NbufList
);
1131 Check and get the result of the prameter negotiation.
1133 @param[in, out] Conn The connection in iSCSI login.
1135 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
1136 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
1137 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1140 IScsiCheckOpParams (
1141 IN OUT ISCSI_CONNECTION
*Conn
1145 LIST_ENTRY
*KeyValueList
;
1148 ISCSI_SESSION
*Session
;
1152 ASSERT (Conn
->RspQue
.BufNum
!= 0);
1154 Session
= Conn
->Session
;
1156 Len
= Conn
->RspQue
.BufSize
;
1157 Data
= AllocatePool (Len
);
1159 return EFI_OUT_OF_RESOURCES
;
1162 NetbufQueCopy (&Conn
->RspQue
, 0, Len
, (UINT8
*) Data
);
1164 Status
= EFI_PROTOCOL_ERROR
;
1167 // Extract the Key-Value pairs into a list.
1169 KeyValueList
= IScsiBuildKeyValueList (Data
, Len
);
1170 if (KeyValueList
== NULL
) {
1177 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_HEADER_DIGEST
);
1178 if (Value
== NULL
) {
1182 if (AsciiStrCmp (Value
, "CRC32") == 0) {
1183 if (Conn
->HeaderDigest
!= IScsiDigestCRC32
) {
1186 } else if (AsciiStrCmp (Value
, ISCSI_KEY_VALUE_NONE
) == 0) {
1187 Conn
->HeaderDigest
= IScsiDigestNone
;
1194 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_DIGEST
);
1195 if (Value
== NULL
) {
1199 if (AsciiStrCmp (Value
, "CRC32") == 0) {
1200 if (Conn
->DataDigest
!= IScsiDigestCRC32
) {
1203 } else if (AsciiStrCmp (Value
, ISCSI_KEY_VALUE_NONE
) == 0) {
1204 Conn
->DataDigest
= IScsiDigestNone
;
1209 // ErrorRecoveryLevel, result fuction is Minimum.
1211 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_ERROR_RECOVERY_LEVEL
);
1212 if (Value
== NULL
) {
1216 NumericValue
= AsciiStrDecimalToUintn (Value
);
1217 if (NumericValue
> 2) {
1221 Session
->ErrorRecoveryLevel
= (UINT8
) MIN (Session
->ErrorRecoveryLevel
, NumericValue
);
1224 // InitialR2T, result function is OR.
1226 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_INITIAL_R2T
);
1227 if (Value
== NULL
) {
1231 Session
->InitialR2T
= (BOOLEAN
) (Session
->InitialR2T
|| (AsciiStrCmp (Value
, "Yes") == 0));
1234 // ImmediateData, result function is AND.
1236 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_IMMEDIATE_DATA
);
1237 if (Value
== NULL
) {
1241 Session
->ImmediateData
= (BOOLEAN
) (Session
->ImmediateData
&& (AsciiStrCmp (Value
, "Yes") == 0));
1244 // MaxRecvDataSegmentLength is declarative.
1246 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH
);
1247 if (Value
!= NULL
) {
1248 Conn
->MaxRecvDataSegmentLength
= (UINT32
) AsciiStrDecimalToUintn (Value
);
1251 // MaxBurstLength, result funtion is Mininum.
1253 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_BURST_LENGTH
);
1254 if (Value
== NULL
) {
1258 NumericValue
= AsciiStrDecimalToUintn (Value
);
1259 Session
->MaxBurstLength
= (UINT32
) MIN (Session
->MaxBurstLength
, NumericValue
);
1262 // FirstBurstLength, result function is Minimum. Irrelevant when InitialR2T=Yes and
1263 // ImmediateData=No.
1264 // This Key/Value is negotiation type.
1266 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_FIRST_BURST_LENGTH
);
1267 if (Value
== NULL
) {
1271 NumericValue
= AsciiStrDecimalToUintn (Value
);
1272 Session
->FirstBurstLength
= (UINT32
) MIN (Session
->FirstBurstLength
, NumericValue
);
1275 // MaxConnections, result function is Minimum.
1277 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_CONNECTIONS
);
1278 if (Value
== NULL
) {
1282 NumericValue
= AsciiStrDecimalToUintn (Value
);
1283 if ((NumericValue
== 0) || (NumericValue
> 65535)) {
1287 Session
->MaxConnections
= (UINT32
) MIN (Session
->MaxConnections
, NumericValue
);
1290 // DataPDUInOrder, result function is OR.
1292 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_PDU_IN_ORDER
);
1293 if (Value
== NULL
) {
1297 Session
->DataPDUInOrder
= (BOOLEAN
) (Session
->DataPDUInOrder
|| (AsciiStrCmp (Value
, "Yes") == 0));
1300 // DataSequenceInorder, result function is OR.
1302 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
);
1303 if (Value
== NULL
) {
1307 Session
->DataSequenceInOrder
= (BOOLEAN
) (Session
->DataSequenceInOrder
|| (AsciiStrCmp (Value
, "Yes") == 0));
1310 // DefaultTime2Wait, result function is Maximum.
1312 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DEFAULT_TIME2WAIT
);
1313 if (Value
== NULL
) {
1317 NumericValue
= AsciiStrDecimalToUintn (Value
);
1318 if (NumericValue
== 0) {
1319 Session
->DefaultTime2Wait
= 0;
1320 } else if (NumericValue
> 3600) {
1323 Session
->DefaultTime2Wait
= (UINT32
) MAX (Session
->DefaultTime2Wait
, NumericValue
);
1326 // DefaultTime2Retain, result function is Minimum.
1328 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_DEFAULT_TIME2RETAIN
);
1329 if (Value
== NULL
) {
1333 NumericValue
= AsciiStrDecimalToUintn (Value
);
1334 if (NumericValue
== 0) {
1335 Session
->DefaultTime2Retain
= 0;
1336 } else if (NumericValue
> 3600) {
1339 Session
->DefaultTime2Retain
= (UINT32
) MIN (Session
->DefaultTime2Retain
, NumericValue
);
1342 // MaxOutstandingR2T, result function is Minimum.
1344 Value
= IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_MAX_OUTSTANDING_R2T
);
1345 if (Value
== NULL
) {
1349 NumericValue
= AsciiStrDecimalToUintn (Value
);
1350 if ((NumericValue
== 0) || (NumericValue
> 65535)) {
1354 Session
->MaxOutstandingR2T
= (UINT16
) MIN (Session
->MaxOutstandingR2T
, NumericValue
);
1357 // Remove declarative key-value paris if any.
1359 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_SESSION_TYPE
);
1360 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_ALIAS
);
1361 IScsiGetValueByKeyFromList (KeyValueList
, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG
);
1363 if (IsListEmpty (KeyValueList
)) {
1365 // Succeed if no more keys in the list.
1367 Status
= EFI_SUCCESS
;
1372 IScsiFreeKeyValueList (KeyValueList
);
1380 Fill the oprational prameters.
1382 @param[in] Conn The connection in iSCSI login.
1383 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
1385 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
1389 IN ISCSI_CONNECTION
*Conn
,
1393 ISCSI_SESSION
*Session
;
1396 Session
= Conn
->Session
;
1398 AsciiSPrint (Value
, sizeof (Value
), "%a", (Conn
->HeaderDigest
== IScsiDigestCRC32
) ? "None,CRC32" : "None");
1399 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_HEADER_DIGEST
, Value
);
1401 AsciiSPrint (Value
, sizeof (Value
), "%a", (Conn
->DataDigest
== IScsiDigestCRC32
) ? "None,CRC32" : "None");
1402 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_DIGEST
, Value
);
1404 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->ErrorRecoveryLevel
);
1405 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_ERROR_RECOVERY_LEVEL
, Value
);
1407 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->InitialR2T
? "Yes" : "No");
1408 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_INITIAL_R2T
, Value
);
1410 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->ImmediateData
? "Yes" : "No");
1411 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_IMMEDIATE_DATA
, Value
);
1413 AsciiSPrint (Value
, sizeof (Value
), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP
);
1414 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH
, Value
);
1416 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxBurstLength
);
1417 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_BURST_LENGTH
, Value
);
1419 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->FirstBurstLength
);
1420 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_FIRST_BURST_LENGTH
, Value
);
1422 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxConnections
);
1423 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_CONNECTIONS
, Value
);
1425 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->DataPDUInOrder
? "Yes" : "No");
1426 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_PDU_IN_ORDER
, Value
);
1428 AsciiSPrint (Value
, sizeof (Value
), "%a", Session
->DataSequenceInOrder
? "Yes" : "No");
1429 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER
, Value
);
1431 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->DefaultTime2Wait
);
1432 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DEFAULT_TIME2WAIT
, Value
);
1434 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->DefaultTime2Retain
);
1435 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_DEFAULT_TIME2RETAIN
, Value
);
1437 AsciiSPrint (Value
, sizeof (Value
), "%d", Session
->MaxOutstandingR2T
);
1438 IScsiAddKeyValuePair (Pdu
, ISCSI_KEY_MAX_OUTSTANDING_R2T
, Value
);
1444 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1446 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
1447 @param[in] Len The length of the last semgnet in the PDU.
1449 @retval EFI_SUCCESS The segment is padded or no need to pad it.
1450 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1455 IN OUT NET_BUF
*Pdu
,
1462 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1465 Data
= NetbufAllocSpace (Pdu
, PadLen
, NET_BUF_TAIL
);
1467 return EFI_OUT_OF_RESOURCES
;
1470 ZeroMem (Data
, PadLen
);
1477 Build a key-value list from the data segment.
1479 @param[in] Data The data segment containing the key-value pairs.
1480 @param[in] Len Length of the data segment.
1482 @return The key-value list.
1483 @retval NULL Other errors as indicated.
1486 IScsiBuildKeyValueList (
1491 LIST_ENTRY
*ListHead
;
1492 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1494 ListHead
= AllocatePool (sizeof (LIST_ENTRY
));
1495 if (ListHead
== NULL
) {
1499 InitializeListHead (ListHead
);
1502 KeyValuePair
= AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR
));
1503 if (KeyValuePair
== NULL
) {
1507 InitializeListHead (&KeyValuePair
->List
);
1509 KeyValuePair
->Key
= Data
;
1511 while ((Len
> 0) && (*Data
!= '=')) {
1522 FreePool (KeyValuePair
);
1526 KeyValuePair
->Value
= Data
;
1528 InsertTailList (ListHead
, &KeyValuePair
->List
);;
1530 Data
+= AsciiStrLen (KeyValuePair
->Value
) + 1;
1531 Len
-= (UINT32
) AsciiStrLen (KeyValuePair
->Value
) + 1;
1538 IScsiFreeKeyValueList (ListHead
);
1544 Get the value string by the key name from the key-value list. If found,
1545 the key-value entry will be removed from the list.
1547 @param[in, out] KeyValueList The key-value list.
1548 @param[in] Key The key name to find.
1550 @return The value string.
1553 IScsiGetValueByKeyFromList (
1554 IN OUT LIST_ENTRY
*KeyValueList
,
1559 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1564 NET_LIST_FOR_EACH (Entry
, KeyValueList
) {
1565 KeyValuePair
= NET_LIST_USER_STRUCT (Entry
, ISCSI_KEY_VALUE_PAIR
, List
);
1567 if (AsciiStrCmp (KeyValuePair
->Key
, Key
) == 0) {
1568 Value
= KeyValuePair
->Value
;
1570 RemoveEntryList (&KeyValuePair
->List
);
1571 FreePool (KeyValuePair
);
1580 Free the key-value list.
1582 @param[in] KeyValueList The key-value list.
1585 IScsiFreeKeyValueList (
1586 IN LIST_ENTRY
*KeyValueList
1590 ISCSI_KEY_VALUE_PAIR
*KeyValuePair
;
1592 while (!IsListEmpty (KeyValueList
)) {
1593 Entry
= NetListRemoveHead (KeyValueList
);
1594 KeyValuePair
= NET_LIST_USER_STRUCT (Entry
, ISCSI_KEY_VALUE_PAIR
, List
);
1596 FreePool (KeyValuePair
);
1599 FreePool (KeyValueList
);
1603 Normalize the iSCSI name according to RFC.
1605 @param[in, out] Name The iSCSI name.
1606 @param[in] Len length of the iSCSI name.
1608 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1609 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
1612 IScsiNormalizeName (
1619 for (Index
= 0; Index
< Len
; Index
++) {
1620 if (NET_IS_UPPER_CASE_CHAR (Name
[Index
])) {
1622 // Convert the upper-case characters to lower-case ones
1624 Name
[Index
] = (CHAR8
) (Name
[Index
] - 'A' + 'a');
1627 if (!NET_IS_LOWER_CASE_CHAR (Name
[Index
]) &&
1628 !NET_IS_DIGIT (Name
[Index
]) &&
1629 (Name
[Index
] != '-') &&
1630 (Name
[Index
] != '.') &&
1631 (Name
[Index
] != ':')
1634 // ASCII dash, dot, colon lower-case characters and digit characters
1637 return EFI_PROTOCOL_ERROR
;
1641 if ((Len
< 4) || (CompareMem (Name
, "iqn.", 4) != 0)) {
1643 // Only IQN format is accepted now.
1645 return EFI_PROTOCOL_ERROR
;
1652 Create an iSCSI task control block.
1654 @param[in] Conn The connection on which the task control block will be created.
1655 @param[out] Tcb The newly created task control block.
1657 @retval EFI_SUCCESS The task control block is created.
1658 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1659 @retval EFI_NOT_READY The target can not accept new commands.
1663 IN ISCSI_CONNECTION
*Conn
,
1667 ISCSI_SESSION
*Session
;
1670 ASSERT (Tcb
!= NULL
);
1672 Session
= Conn
->Session
;
1674 if (ISCSI_SEQ_GT (Session
->CmdSN
, Session
->MaxCmdSN
)) {
1675 return EFI_NOT_READY
;
1678 NewTcb
= AllocateZeroPool (sizeof (ISCSI_TCB
));
1679 if (NewTcb
== NULL
) {
1680 return EFI_OUT_OF_RESOURCES
;
1683 InitializeListHead (&NewTcb
->Link
);
1685 NewTcb
->SoFarInOrder
= TRUE
;
1686 NewTcb
->InitiatorTaskTag
= Session
->InitiatorTaskTag
;
1687 NewTcb
->CmdSN
= Session
->CmdSN
;
1688 NewTcb
->Conn
= Conn
;
1690 InsertTailList (&Session
->TcbList
, &NewTcb
->Link
);
1693 // Advance the initiator task tag.
1695 Session
->InitiatorTaskTag
++;
1704 Delete the tcb from the connection and destroy it.
1706 @param[in] Tcb The tcb to delete.
1713 RemoveEntryList (&Tcb
->Link
);
1719 Find the task control block by the initator task tag.
1721 @param[in] TcbList The tcb list.
1722 @param[in] InitiatorTaskTag The initiator task tag.
1724 @return The task control block found.
1728 IN LIST_ENTRY
*TcbList
,
1729 IN UINT32 InitiatorTaskTag
1737 NET_LIST_FOR_EACH (Entry
, TcbList
) {
1738 Tcb
= NET_LIST_USER_STRUCT (Entry
, ISCSI_TCB
, Link
);
1740 if (Tcb
->InitiatorTaskTag
== InitiatorTaskTag
) {
1751 Create a data segment, pad it and calculate the CRC if needed.
1753 @param[in] Data The data to fill into the data segment.
1754 @param[in] Len Length of the data.
1755 @param[in] DataDigest Whether to calculate CRC for this data segment.
1757 @return The net buffer wrapping the data segment.
1760 IScsiNewDataSegment (
1763 IN BOOLEAN DataDigest
1766 NET_FRAGMENT Fragment
[2];
1767 UINT32 FragmentCount
;
1771 Fragment
[0].Len
= Len
;
1772 Fragment
[0].Bulk
= Data
;
1774 PadLen
= ISCSI_GET_PAD_LEN (Len
);
1776 Fragment
[1].Len
= PadLen
;
1777 Fragment
[1].Bulk
= (UINT8
*) &mDataSegPad
;
1784 DataSeg
= NetbufFromExt (&Fragment
[0], FragmentCount
, 0, 0, IScsiNbufExtFree
, NULL
);
1790 Create a iSCSI SCSI command PDU to encapsulate the command issued
1791 by SCSI through the EXT SCSI PASS THRU Protocol.
1793 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
1794 @param[in] Lun The LUN.
1795 @param[in] Tcb The tcb assocated with this SCSI command.
1797 @return The created iSCSI SCSI command PDU.
1798 @retval NULL Other errors as indicated.
1801 IScsiNewScsiCmdPdu (
1802 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
,
1807 LIST_ENTRY
*NbufList
;
1811 SCSI_COMMAND
*ScsiCmd
;
1814 ISCSI_ADDITIONAL_HEADER
*Header
;
1815 ISCSI_BI_EXP_READ_DATA_LEN_AHS
*BiExpReadDataLenAHS
;
1816 ISCSI_SESSION
*Session
;
1817 UINT32 ImmediateDataLen
;
1821 if (Packet
->DataDirection
== DataBi
) {
1823 // Bi directional Read/Write command, the bidirectional expected
1824 // read data length AHS is required.
1826 AHSLength
+= sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS
);
1829 if (Packet
->CdbLength
> 16) {
1831 // The CDB exceeds 16 bytes, an extended CDB AHS is required.
1833 AHSLength
= (UINT8
) (AHSLength
+ (ISCSI_ROUNDUP (Packet
->CdbLength
- 16) + sizeof (ISCSI_ADDITIONAL_HEADER
)));
1836 Length
= sizeof (SCSI_COMMAND
) + AHSLength
;
1837 PduHeader
= NetbufAlloc (Length
);
1838 if (PduHeader
== NULL
) {
1842 ScsiCmd
= (SCSI_COMMAND
*) NetbufAllocSpace (PduHeader
, Length
, NET_BUF_TAIL
);
1843 if (ScsiCmd
== NULL
) {
1844 NetbufFree (PduHeader
);
1847 Header
= (ISCSI_ADDITIONAL_HEADER
*) (ScsiCmd
+ 1);
1849 ZeroMem (ScsiCmd
, Length
);
1851 ISCSI_SET_OPCODE (ScsiCmd
, ISCSI_OPCODE_SCSI_CMD
, 0);
1852 ISCSI_SET_FLAG (ScsiCmd
, ISCSI_TASK_ATTR_SIMPLE
);
1855 // Set the READ/WRITE flags according to the IO type of this request.
1857 switch (Packet
->DataDirection
) {
1859 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_READ
);
1860 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->InTransferLength
);
1864 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_WRITE
);
1865 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->OutTransferLength
);
1869 ISCSI_SET_FLAG (ScsiCmd
, SCSI_CMD_PDU_FLAG_READ
| SCSI_CMD_PDU_FLAG_WRITE
);
1870 ScsiCmd
->ExpDataXferLength
= NTOHL (Packet
->OutTransferLength
);
1873 // Fill the bidirectional expected read data length AHS.
1875 BiExpReadDataLenAHS
= (ISCSI_BI_EXP_READ_DATA_LEN_AHS
*) Header
;
1876 Header
= (ISCSI_ADDITIONAL_HEADER
*) (BiExpReadDataLenAHS
+ 1);
1878 BiExpReadDataLenAHS
->Length
= NTOHS (5);
1879 BiExpReadDataLenAHS
->Type
= ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN
;
1880 BiExpReadDataLenAHS
->ExpReadDataLength
= NTOHL (Packet
->InTransferLength
);
1885 ScsiCmd
->TotalAHSLength
= AHSLength
;
1886 CopyMem (ScsiCmd
->Lun
, &Lun
, sizeof (ScsiCmd
->Lun
));
1887 ScsiCmd
->InitiatorTaskTag
= NTOHL (Tcb
->InitiatorTaskTag
);
1888 ScsiCmd
->CmdSN
= NTOHL (Tcb
->CmdSN
);
1889 ScsiCmd
->ExpStatSN
= NTOHL (Tcb
->Conn
->ExpStatSN
);
1891 CopyMem (ScsiCmd
->Cdb
, Packet
->Cdb
, sizeof (ScsiCmd
->Cdb
));
1893 if (Packet
->CdbLength
> 16) {
1894 Header
->Length
= NTOHS ((UINT16
) (Packet
->CdbLength
- 15));
1895 Header
->Type
= ISCSI_AHS_TYPE_EXT_CDB
;
1897 CopyMem (Header
+ 1, (UINT8
*) Packet
->Cdb
+ 16, Packet
->CdbLength
- 16);
1901 Session
= Tcb
->Conn
->Session
;
1902 ImmediateDataLen
= 0;
1904 if (Session
->ImmediateData
&& (Packet
->OutTransferLength
!= 0)) {
1906 // Send immediate data in this SCSI Command PDU. The length of the immeidate
1907 // data is the minimum of FirstBurstLength, the data length to be xfered and
1908 // the MaxRecvdataSegmentLength on this connection.
1910 ImmediateDataLen
= MIN (Session
->FirstBurstLength
, Packet
->OutTransferLength
);
1911 ImmediateDataLen
= MIN (ImmediateDataLen
, Tcb
->Conn
->MaxRecvDataSegmentLength
);
1914 // Update the data segment length in the PDU header.
1916 ISCSI_SET_DATASEG_LEN (ScsiCmd
, ImmediateDataLen
);
1919 // Create the data segment.
1921 DataSeg
= IScsiNewDataSegment ((UINT8
*) Packet
->OutDataBuffer
, ImmediateDataLen
, FALSE
);
1922 if (DataSeg
== NULL
) {
1923 NetbufFree (PduHeader
);
1928 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
1929 if (NbufList
== NULL
) {
1930 NetbufFree (PduHeader
);
1931 NetbufFree (DataSeg
);
1937 InitializeListHead (NbufList
);
1938 InsertTailList (NbufList
, &PduHeader
->List
);
1939 InsertTailList (NbufList
, &DataSeg
->List
);
1941 Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
1943 IScsiFreeNbufList (NbufList
);
1947 if (Session
->InitialR2T
||
1948 (ImmediateDataLen
== Session
->FirstBurstLength
) ||
1949 (ImmediateDataLen
== Packet
->OutTransferLength
)
1952 // Unsolicited data out sequence is not allowed,
1953 // or FirstBurstLength data is already sent out by immediate data
1954 // or all the OUT data accompany this SCSI packet is sent as
1955 // immediate data, the final flag should be set on this SCSI Command
1958 ISCSI_SET_FLAG (ScsiCmd
, ISCSI_BHS_FLAG_FINAL
);
1967 Create a new iSCSI SCSI Data Out PDU.
1969 @param[in] Data The data to put into the Data Out PDU.
1970 @param[in] Len Length of the data.
1971 @param[in] DataSN The DataSN of the Data Out PDU.
1972 @param[in] Tcb The task control block of this Data Out PDU.
1973 @param[in] Lun The LUN.
1975 @return The net buffer wrapping the Data Out PDU.
1976 @retval NULL Other errors as indicated.
1979 IScsiNewDataOutPdu (
1987 LIST_ENTRY
*NbufList
;
1991 ISCSI_SCSI_DATA_OUT
*DataOutHdr
;
1992 ISCSI_XFER_CONTEXT
*XferContext
;
1994 NbufList
= AllocatePool (sizeof (LIST_ENTRY
));
1995 if (NbufList
== NULL
) {
1999 InitializeListHead (NbufList
);
2002 // Allocate memory for the BHS.
2004 PduHdr
= NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT
));
2005 if (PduHdr
== NULL
) {
2006 FreePool (NbufList
);
2010 // Insert the BHS into the buffer list.
2012 InsertTailList (NbufList
, &PduHdr
->List
);
2014 DataOutHdr
= (ISCSI_SCSI_DATA_OUT
*) NetbufAllocSpace (PduHdr
, sizeof (ISCSI_SCSI_DATA_OUT
), NET_BUF_TAIL
);
2015 ASSERT (DataOutHdr
!= NULL
);
2016 XferContext
= &Tcb
->XferContext
;
2018 ZeroMem (DataOutHdr
, sizeof (ISCSI_SCSI_DATA_OUT
));
2021 // Set the flags and fields of the Data Out PDU BHS.
2023 ISCSI_SET_OPCODE (DataOutHdr
, ISCSI_OPCODE_SCSI_DATA_OUT
, 0);
2024 ISCSI_SET_DATASEG_LEN (DataOutHdr
, Len
);
2026 DataOutHdr
->InitiatorTaskTag
= HTONL (Tcb
->InitiatorTaskTag
);
2027 DataOutHdr
->TargetTransferTag
= HTONL (XferContext
->TargetTransferTag
);
2028 DataOutHdr
->ExpStatSN
= HTONL (Tcb
->Conn
->ExpStatSN
);
2029 DataOutHdr
->DataSN
= HTONL (DataSN
);
2030 DataOutHdr
->BufferOffset
= HTONL (XferContext
->Offset
);
2032 if (XferContext
->TargetTransferTag
!= ISCSI_RESERVED_TAG
) {
2033 CopyMem (&DataOutHdr
->Lun
, &Lun
, sizeof (DataOutHdr
->Lun
));
2036 // Build the data segment for this Data Out PDU.
2038 DataSeg
= IScsiNewDataSegment (Data
, Len
, FALSE
);
2039 if (DataSeg
== NULL
) {
2040 IScsiFreeNbufList (NbufList
);
2044 // Put the data segment into the buffer list and combine it with the BHS
2045 // into a full Data Out PDU.
2047 InsertTailList (NbufList
, &DataSeg
->List
);
2048 Pdu
= NetbufFromBufList (NbufList
, 0, 0, IScsiFreeNbufList
, NbufList
);
2050 IScsiFreeNbufList (NbufList
);
2057 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2059 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2060 @param[in] Tcb The task control block of the data to send out.
2061 @param[in] Lun The LUN the data will be sent to.
2063 @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.
2064 @retval NULL Other errors as indicated.
2067 IScsiGenerateDataOutPduSequence (
2073 LIST_ENTRY
*PduList
;
2076 NET_BUF
*DataOutPdu
;
2077 ISCSI_CONNECTION
*Conn
;
2078 ISCSI_XFER_CONTEXT
*XferContext
;
2079 UINT8
*DataOutPacket
;
2081 PduList
= AllocatePool (sizeof (LIST_ENTRY
));
2082 if (PduList
== NULL
) {
2086 InitializeListHead (PduList
);
2091 XferContext
= &Tcb
->XferContext
;
2093 while (XferContext
->DesiredLength
> 0) {
2095 // Determine the length of data this Data Out PDU can carry.
2097 DataLen
= MIN (XferContext
->DesiredLength
, Conn
->MaxRecvDataSegmentLength
);
2100 // Create a Data Out PDU.
2102 DataOutPdu
= IScsiNewDataOutPdu (Data
, DataLen
, DataSN
, Tcb
, Lun
);
2103 if (DataOutPdu
== NULL
) {
2104 IScsiFreeNbufList (PduList
);
2110 InsertTailList (PduList
, &DataOutPdu
->List
);
2113 // Update the context and DataSN.
2115 XferContext
->Offset
+= DataLen
;
2116 XferContext
->DesiredLength
-= DataLen
;
2121 // Set the F bit for the last data out PDU in this sequence.
2123 DataOutPacket
= NetbufGetByte (DataOutPdu
, 0, NULL
);
2124 if (DataOutPacket
== NULL
) {
2125 IScsiFreeNbufList (PduList
);
2130 ISCSI_SET_FLAG (DataOutPacket
, ISCSI_BHS_FLAG_FINAL
);
2138 Send the Data in a sequence of Data Out PDUs one by one.
2140 @param[in] Data The data to carry by Data Out PDUs.
2141 @param[in] Lun The LUN the data will be sent to.
2142 @param[in] Tcb The task control block.
2144 @retval EFI_SUCCES The data is sent out to the LUN.
2145 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2146 @retval Others Other errors as indicated.
2149 IScsiSendDataOutPduSequence (
2155 LIST_ENTRY
*DataOutPduList
;
2161 // Generate the Data Out PDU sequence.
2163 DataOutPduList
= IScsiGenerateDataOutPduSequence (Data
, Tcb
, Lun
);
2164 if (DataOutPduList
== NULL
) {
2165 return EFI_OUT_OF_RESOURCES
;
2168 Status
= EFI_SUCCESS
;
2171 // Send the Data Out PDU's one by one.
2173 NET_LIST_FOR_EACH (Entry
, DataOutPduList
) {
2174 Pdu
= NET_LIST_USER_STRUCT (Entry
, NET_BUF
, List
);
2176 Status
= Tcp4IoTransmit (&Tcb
->Conn
->Tcp4Io
, Pdu
);
2177 if (EFI_ERROR (Status
)) {
2182 IScsiFreeNbufList (DataOutPduList
);
2188 Process the received iSCSI SCSI Data In PDU.
2190 @param[in] Pdu The Data In PDU received.
2191 @param[in] Tcb The task control block.
2192 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2194 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update
2196 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2197 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2198 @retval Others Other errors as indicated.
2204 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2207 ISCSI_SCSI_DATA_IN
*DataInHdr
;
2210 DataInHdr
= (ISCSI_SCSI_DATA_IN
*) NetbufGetByte (Pdu
, 0, NULL
);
2211 if (DataInHdr
== NULL
) {
2212 return EFI_PROTOCOL_ERROR
;
2215 DataInHdr
->InitiatorTaskTag
= NTOHL (DataInHdr
->InitiatorTaskTag
);
2216 DataInHdr
->ExpCmdSN
= NTOHL (DataInHdr
->ExpCmdSN
);
2217 DataInHdr
->MaxCmdSN
= NTOHL (DataInHdr
->MaxCmdSN
);
2218 DataInHdr
->DataSN
= NTOHL (DataInHdr
->DataSN
);
2221 // Check the DataSN.
2223 Status
= IScsiCheckSN (&Tcb
->ExpDataSN
, DataInHdr
->DataSN
);
2224 if (EFI_ERROR (Status
)) {
2228 if (DataInHdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) {
2229 return EFI_PROTOCOL_ERROR
;
2232 // Update the command related sequence numbers.
2234 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, DataInHdr
->MaxCmdSN
, DataInHdr
->ExpCmdSN
);
2236 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID
)) {
2237 if (!ISCSI_FLAG_ON (DataInHdr
, ISCSI_BHS_FLAG_FINAL
)) {
2239 // The S bit is on but the F bit is off.
2241 return EFI_PROTOCOL_ERROR
;
2244 Tcb
->StatusXferd
= TRUE
;
2246 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_DATA_IN_PDU_FLAG_OVERFLOW
| SCSI_DATA_IN_PDU_FLAG_UNDERFLOW
)) {
2248 // Underflow and Overflow are mutual flags.
2250 return EFI_PROTOCOL_ERROR
;
2253 // S bit is on, the StatSN is valid.
2255 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, NTOHL (DataInHdr
->StatSN
));
2256 if (EFI_ERROR (Status
)) {
2260 Packet
->HostAdapterStatus
= 0;
2261 Packet
->TargetStatus
= DataInHdr
->Status
;
2263 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
)) {
2264 Packet
->InTransferLength
+= NTOHL (DataInHdr
->ResidualCount
);
2265 Status
= EFI_BAD_BUFFER_SIZE
;
2268 if (ISCSI_FLAG_ON (DataInHdr
, SCSI_RSP_PDU_FLAG_UNDERFLOW
)) {
2269 Packet
->InTransferLength
-= NTOHL (DataInHdr
->ResidualCount
);
2277 Process the received iSCSI R2T PDU.
2279 @param[in] Pdu The R2T PDU received.
2280 @param[in] Tcb The task control block.
2281 @param[in] Lun The Lun.
2282 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2284 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.
2285 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2286 @retval Others Other errors as indicated.
2293 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2296 ISCSI_READY_TO_TRANSFER
*R2THdr
;
2298 ISCSI_XFER_CONTEXT
*XferContext
;
2301 R2THdr
= (ISCSI_READY_TO_TRANSFER
*) NetbufGetByte (Pdu
, 0, NULL
);
2302 if (R2THdr
== NULL
) {
2303 return EFI_PROTOCOL_ERROR
;
2306 R2THdr
->InitiatorTaskTag
= NTOHL (R2THdr
->InitiatorTaskTag
);
2307 R2THdr
->TargetTransferTag
= NTOHL (R2THdr
->TargetTransferTag
);
2308 R2THdr
->StatSN
= NTOHL (R2THdr
->StatSN
);
2309 R2THdr
->R2TSeqNum
= NTOHL (R2THdr
->R2TSeqNum
);
2310 R2THdr
->BufferOffset
= NTOHL (R2THdr
->BufferOffset
);
2311 R2THdr
->DesiredDataTransferLength
= NTOHL (R2THdr
->DesiredDataTransferLength
);
2313 if ((R2THdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) || !ISCSI_SEQ_EQ (R2THdr
->StatSN
, Tcb
->Conn
->ExpStatSN
)) {
2314 return EFI_PROTOCOL_ERROR
;;
2317 // Check the sequence number.
2319 Status
= IScsiCheckSN (&Tcb
->ExpDataSN
, R2THdr
->R2TSeqNum
);
2320 if (EFI_ERROR (Status
)) {
2324 XferContext
= &Tcb
->XferContext
;
2325 XferContext
->TargetTransferTag
= R2THdr
->TargetTransferTag
;
2326 XferContext
->Offset
= R2THdr
->BufferOffset
;
2327 XferContext
->DesiredLength
= R2THdr
->DesiredDataTransferLength
;
2329 if (((XferContext
->Offset
+ XferContext
->DesiredLength
) > Packet
->OutTransferLength
) ||
2330 (XferContext
->DesiredLength
> Tcb
->Conn
->Session
->MaxBurstLength
)
2332 return EFI_PROTOCOL_ERROR
;
2335 // Send the data solicited by this R2T.
2337 Data
= (UINT8
*) Packet
->OutDataBuffer
+ XferContext
->Offset
;
2338 Status
= IScsiSendDataOutPduSequence (Data
, Lun
, Tcb
);
2344 Process the received iSCSI SCSI Response PDU.
2346 @param[in] Pdu The Response PDU received.
2347 @param[in] Tcb The task control block.
2348 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2350 @retval EFI_SUCCES The Response PDU is processed.
2351 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2352 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2353 @retval Others Other errors as indicated.
2356 IScsiOnScsiRspRcvd (
2359 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2362 SCSI_RESPONSE
*ScsiRspHdr
;
2363 ISCSI_SENSE_DATA
*SenseData
;
2367 ScsiRspHdr
= (SCSI_RESPONSE
*) NetbufGetByte (Pdu
, 0, NULL
);
2368 if (ScsiRspHdr
== NULL
) {
2369 return EFI_PROTOCOL_ERROR
;
2372 ScsiRspHdr
->InitiatorTaskTag
= NTOHL (ScsiRspHdr
->InitiatorTaskTag
);
2373 if (ScsiRspHdr
->InitiatorTaskTag
!= Tcb
->InitiatorTaskTag
) {
2374 return EFI_PROTOCOL_ERROR
;
2377 ScsiRspHdr
->StatSN
= NTOHL (ScsiRspHdr
->StatSN
);
2379 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, ScsiRspHdr
->StatSN
);
2380 if (EFI_ERROR (Status
)) {
2384 ScsiRspHdr
->MaxCmdSN
= NTOHL (ScsiRspHdr
->MaxCmdSN
);
2385 ScsiRspHdr
->ExpCmdSN
= NTOHL (ScsiRspHdr
->ExpCmdSN
);
2386 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, ScsiRspHdr
->MaxCmdSN
, ScsiRspHdr
->ExpCmdSN
);
2388 Tcb
->StatusXferd
= TRUE
;
2390 Packet
->HostAdapterStatus
= ScsiRspHdr
->Response
;
2391 if (Packet
->HostAdapterStatus
!= ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET
) {
2395 Packet
->TargetStatus
= ScsiRspHdr
->Status
;
2397 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW
| SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW
) ||
2398 ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
| SCSI_RSP_PDU_FLAG_UNDERFLOW
)
2400 return EFI_PROTOCOL_ERROR
;
2403 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW
)) {
2404 Packet
->InTransferLength
+= NTOHL (ScsiRspHdr
->BiReadResidualCount
);
2405 Status
= EFI_BAD_BUFFER_SIZE
;
2408 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW
)) {
2409 Packet
->InTransferLength
-= NTOHL (ScsiRspHdr
->BiReadResidualCount
);
2412 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_OVERFLOW
)) {
2413 if (Packet
->DataDirection
== DataIn
) {
2414 Packet
->InTransferLength
+= NTOHL (ScsiRspHdr
->ResidualCount
);
2416 Packet
->OutTransferLength
+= NTOHL (ScsiRspHdr
->ResidualCount
);
2419 Status
= EFI_BAD_BUFFER_SIZE
;
2422 if (ISCSI_FLAG_ON (ScsiRspHdr
, SCSI_RSP_PDU_FLAG_UNDERFLOW
)) {
2423 if (Packet
->DataDirection
== DataIn
) {
2424 Packet
->InTransferLength
-= NTOHL (ScsiRspHdr
->ResidualCount
);
2426 Packet
->OutTransferLength
-= NTOHL (ScsiRspHdr
->ResidualCount
);
2430 DataSegLen
= ISCSI_GET_DATASEG_LEN (ScsiRspHdr
);
2431 if (DataSegLen
!= 0) {
2432 SenseData
= (ISCSI_SENSE_DATA
*) NetbufGetByte (Pdu
, sizeof (SCSI_RESPONSE
), NULL
);
2433 if (SenseData
== NULL
) {
2434 return EFI_PROTOCOL_ERROR
;
2437 SenseData
->Length
= NTOHS (SenseData
->Length
);
2439 Packet
->SenseDataLength
= (UINT8
) MIN (SenseData
->Length
, Packet
->SenseDataLength
);
2440 if (Packet
->SenseDataLength
!= 0) {
2441 CopyMem (Packet
->SenseData
, &SenseData
->Data
[0], Packet
->SenseDataLength
);
2444 Packet
->SenseDataLength
= 0;
2451 Process the received NOP In PDU.
2453 @param[in] Pdu The NOP In PDU received.
2454 @param[in] Tcb The task control block.
2456 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence
2457 numbers are updated.
2458 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2466 ISCSI_NOP_IN
*NopInHdr
;
2469 NopInHdr
= (ISCSI_NOP_IN
*) NetbufGetByte (Pdu
, 0, NULL
);
2470 if (NopInHdr
== NULL
) {
2471 return EFI_PROTOCOL_ERROR
;
2474 NopInHdr
->StatSN
= NTOHL (NopInHdr
->StatSN
);
2475 NopInHdr
->ExpCmdSN
= NTOHL (NopInHdr
->ExpCmdSN
);
2476 NopInHdr
->MaxCmdSN
= NTOHL (NopInHdr
->MaxCmdSN
);
2478 if (NopInHdr
->InitiatorTaskTag
== ISCSI_RESERVED_TAG
) {
2479 if (NopInHdr
->StatSN
!= Tcb
->Conn
->ExpStatSN
) {
2480 return EFI_PROTOCOL_ERROR
;
2483 Status
= IScsiCheckSN (&Tcb
->Conn
->ExpStatSN
, NopInHdr
->StatSN
);
2484 if (EFI_ERROR (Status
)) {
2489 IScsiUpdateCmdSN (Tcb
->Conn
->Session
, NopInHdr
->MaxCmdSN
, NopInHdr
->ExpCmdSN
);
2495 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2497 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2498 @param[in] Target The target ID.
2499 @param[in] Lun The LUN.
2500 @param[in, out] Packet The request packet containing IO request, SCSI command
2501 buffer and buffers to read/write.
2503 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
2505 @retval EFI_DEVICE_ERROR Session state was not as required.
2506 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2507 @retval Others Other errors as indicated.
2510 IScsiExecuteScsiCommand (
2511 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL
*PassThru
,
2514 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
*Packet
2518 ISCSI_DRIVER_DATA
*Private
;
2519 ISCSI_SESSION
*Session
;
2520 EFI_EVENT TimeoutEvent
;
2521 ISCSI_CONNECTION
*Conn
;
2524 ISCSI_XFER_CONTEXT
*XferContext
;
2526 ISCSI_IN_BUFFER_CONTEXT InBufferContext
;
2530 Private
= ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru
);
2531 Session
= &Private
->Session
;
2532 Status
= EFI_SUCCESS
;
2534 TimeoutEvent
= NULL
;
2537 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
2538 return EFI_DEVICE_ERROR
;
2541 Conn
= NET_LIST_USER_STRUCT_S (
2542 Session
->Conns
.ForwardLink
,
2545 ISCSI_CONNECTION_SIGNATURE
2548 if (Packet
->Timeout
!= 0) {
2549 Timeout
= MultU64x32 (Packet
->Timeout
, 2);
2552 Status
= IScsiNewTcb (Conn
, &Tcb
);
2553 if (EFI_ERROR (Status
)) {
2557 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2559 Pdu
= IScsiNewScsiCmdPdu (Packet
, Lun
, Tcb
);
2561 Status
= EFI_OUT_OF_RESOURCES
;
2565 XferContext
= &Tcb
->XferContext
;
2566 PduHdr
= NetbufGetByte (Pdu
, 0, NULL
);
2567 if (PduHdr
== NULL
) {
2568 Status
= EFI_PROTOCOL_ERROR
;
2572 XferContext
->Offset
= ISCSI_GET_DATASEG_LEN (PduHdr
);
2575 // Transmit the SCSI Command PDU.
2577 Status
= Tcp4IoTransmit (&Conn
->Tcp4Io
, Pdu
);
2581 if (EFI_ERROR (Status
)) {
2585 if (!Session
->InitialR2T
&&
2586 (XferContext
->Offset
< Session
->FirstBurstLength
) &&
2587 (XferContext
->Offset
< Packet
->OutTransferLength
)
2590 // Unsolicited Data-Out sequence is allowed, there is remaining SCSI
2591 // OUT data and the limit of FirstBurstLength is not reached.
2593 XferContext
->TargetTransferTag
= ISCSI_RESERVED_TAG
;
2594 XferContext
->DesiredLength
= MIN (
2595 Session
->FirstBurstLength
,
2596 Packet
->OutTransferLength
- XferContext
->Offset
2599 Data
= (UINT8
*) Packet
->OutDataBuffer
+ XferContext
->Offset
;
2600 Status
= IScsiSendDataOutPduSequence (Data
, Lun
, Tcb
);
2601 if (EFI_ERROR (Status
)) {
2606 InBufferContext
.InData
= (UINT8
*) Packet
->InDataBuffer
;
2607 InBufferContext
.InDataLen
= Packet
->InTransferLength
;
2609 while (!Tcb
->StatusXferd
) {
2611 // Start the timeout timer.
2614 Status
= gBS
->SetTimer (Conn
->TimeoutEvent
, TimerRelative
, Timeout
);
2615 if (EFI_ERROR (Status
)) {
2618 TimeoutEvent
= Conn
->TimeoutEvent
;
2621 // try to receive PDU from target.
2623 Status
= IScsiReceivePdu (Conn
, &Pdu
, &InBufferContext
, FALSE
, FALSE
, TimeoutEvent
);
2624 if (EFI_ERROR (Status
)) {
2628 PduHdr
= NetbufGetByte (Pdu
, 0, NULL
);
2629 if (PduHdr
== NULL
) {
2630 Status
= EFI_PROTOCOL_ERROR
;
2634 switch (ISCSI_GET_OPCODE (PduHdr
)) {
2635 case ISCSI_OPCODE_SCSI_DATA_IN
:
2636 Status
= IScsiOnDataInRcvd (Pdu
, Tcb
, Packet
);
2639 case ISCSI_OPCODE_R2T
:
2640 Status
= IScsiOnR2TRcvd (Pdu
, Tcb
, Lun
, Packet
);
2643 case ISCSI_OPCODE_SCSI_RSP
:
2644 Status
= IScsiOnScsiRspRcvd (Pdu
, Tcb
, Packet
);
2647 case ISCSI_OPCODE_NOP_IN
:
2648 Status
= IScsiOnNopInRcvd (Pdu
, Tcb
);
2651 case ISCSI_OPCODE_VENDOR_T0
:
2652 case ISCSI_OPCODE_VENDOR_T1
:
2653 case ISCSI_OPCODE_VENDOR_T2
:
2655 // These messages are vendor specific, skip them.
2660 Status
= EFI_PROTOCOL_ERROR
;
2666 if (EFI_ERROR (Status
)) {
2673 if (TimeoutEvent
!= NULL
) {
2674 gBS
->SetTimer (TimeoutEvent
, TimerCancel
, 0);
2681 if ((Status
!= EFI_SUCCESS
) && (Status
!= EFI_NOT_READY
)) {
2683 // Reinstate the session.
2685 if (EFI_ERROR (IScsiSessionReinstatement (Private
))) {
2686 Status
= EFI_DEVICE_ERROR
;
2694 Reinstate the session on some error.
2696 @param[in, out] Private The iSCSI driver data.
2698 @retval EFI_SUCCES The session is reinstated from some error.
2699 @retval Other Reinstatement failed.
2702 IScsiSessionReinstatement (
2703 IN OUT ISCSI_DRIVER_DATA
*Private
2706 ISCSI_SESSION
*Session
;
2709 Session
= &Private
->Session
;
2710 ASSERT (Session
->State
== SESSION_STATE_LOGGED_IN
);
2713 // Abort the session and re-init it.
2715 IScsiSessionAbort (Session
);
2716 IScsiSessionInit (Session
, TRUE
);
2721 Status
= IScsiSessionLogin (Private
);
2727 Initialize some session parameters before login.
2729 @param[in, out] Session The iSCSI session.
2730 @param[in] Recovery Whether the request is from a fresh new start or recovery.
2734 IN OUT ISCSI_SESSION
*Session
,
2739 Session
->Signature
= ISCSI_SESSION_SIGNATURE
;
2740 Session
->State
= SESSION_STATE_FREE
;
2742 InitializeListHead (&Session
->Conns
);
2743 InitializeListHead (&Session
->TcbList
);
2749 Session
->InitiatorTaskTag
= 1;
2750 Session
->NextCid
= 1;
2752 Session
->TargetPortalGroupTag
= 0;
2753 Session
->MaxConnections
= ISCSI_MAX_CONNS_PER_SESSION
;
2754 Session
->InitialR2T
= FALSE
;
2755 Session
->ImmediateData
= TRUE
;
2756 Session
->MaxBurstLength
= 262144;
2757 Session
->FirstBurstLength
= MAX_RECV_DATA_SEG_LEN_IN_FFP
;
2758 Session
->DefaultTime2Wait
= 2;
2759 Session
->DefaultTime2Retain
= 20;
2760 Session
->MaxOutstandingR2T
= DEFAULT_MAX_OUTSTANDING_R2T
;
2761 Session
->DataPDUInOrder
= TRUE
;
2762 Session
->DataSequenceInOrder
= TRUE
;
2763 Session
->ErrorRecoveryLevel
= 0;
2767 Abort the iSCSI session, that is, reset all the connection and free the
2770 @param[in, out] Session The iSCSI session.
2772 @retval EFI_SUCCES The session is aborted.
2776 IN OUT ISCSI_SESSION
*Session
2779 ISCSI_DRIVER_DATA
*Private
;
2780 ISCSI_CONNECTION
*Conn
;
2782 if (Session
->State
!= SESSION_STATE_LOGGED_IN
) {
2786 ASSERT (!IsListEmpty (&Session
->Conns
));
2788 Private
= ISCSI_DRIVER_DATA_FROM_SESSION (Session
);
2790 while (!IsListEmpty (&Session
->Conns
)) {
2791 Conn
= NET_LIST_USER_STRUCT_S (
2792 Session
->Conns
.ForwardLink
,
2795 ISCSI_CONNECTION_SIGNATURE
2798 gBS
->CloseProtocol (
2799 Conn
->Tcp4Io
.Handle
,
2800 &gEfiTcp4ProtocolGuid
,
2802 Private
->ExtScsiPassThruHandle
2805 IScsiConnReset (Conn
);
2807 IScsiDetatchConnection (Conn
);
2808 IScsiDestroyConnection (Conn
);
2811 Session
->State
= SESSION_STATE_FAILED
;