+++ /dev/null
-/** @file\r
- The implementation of iSCSI protocol based on RFC3720.\r
-\r
-Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-**/\r
-\r
-#include "IScsiImpl.h"\r
-\r
-UINT32 mDataSegPad = 0;\r
-\r
-/**\r
- Attach the iSCSI connection to the iSCSI session.\r
-\r
- @param[in, out] Session The iSCSI session.\r
- @param[in, out] Conn The iSCSI connection.\r
-**/\r
-VOID\r
-IScsiAttatchConnection (\r
- IN OUT ISCSI_SESSION *Session,\r
- IN OUT ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- InsertTailList (&Session->Conns, &Conn->Link);\r
- Conn->Session = Session;\r
- Session->NumConns++;\r
-}\r
-\r
-/**\r
- Detach the iSCSI connection from the session it belongs to.\r
-\r
- @param[in, out] Conn The iSCSI connection.\r
-**/\r
-VOID\r
-IScsiDetatchConnection (\r
- IN OUT ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- RemoveEntryList (&Conn->Link);\r
- Conn->Session->NumConns--;\r
- Conn->Session = NULL;\r
-}\r
-\r
-/**\r
- Check the sequence number according to RFC3720.\r
-\r
- @param[in, out] ExpSN The currently expected sequence number.\r
- @param[in] NewSN The sequence number to check.\r
-\r
- @retval EFI_SUCCESS The check passed and the ExpSN is increased.\r
- @retval EFI_NOT_READY Response was sent due to a retransmission request.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
-**/\r
-EFI_STATUS\r
-IScsiCheckSN (\r
- IN OUT UINT32 *ExpSN,\r
- IN UINT32 NewSN\r
- )\r
-{\r
- if (!ISCSI_SEQ_EQ (NewSN, *ExpSN)) {\r
- if (ISCSI_SEQ_LT (NewSN, *ExpSN)) {\r
- //\r
- // Duplicate\r
- //\r
- return EFI_NOT_READY;\r
- } else {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- } else {\r
- //\r
- // Advance the ExpSN\r
- //\r
- (*ExpSN)++;\r
- return EFI_SUCCESS;\r
- }\r
-}\r
-\r
-/**\r
- Update the sequence numbers for the iSCSI command.\r
-\r
- @param[in, out] Session The iSCSI session.\r
- @param[in] MaxCmdSN Maximum CmdSN from the target.\r
- @param[in] ExpCmdSN Next expected CmdSN from the target.\r
-**/\r
-VOID\r
-IScsiUpdateCmdSN (\r
- IN OUT ISCSI_SESSION *Session,\r
- IN UINT32 MaxCmdSN,\r
- IN UINT32 ExpCmdSN\r
- )\r
-{\r
- if (ISCSI_SEQ_LT (MaxCmdSN, ExpCmdSN - 1)) {\r
- return ;\r
- }\r
-\r
- if (ISCSI_SEQ_GT (MaxCmdSN, Session->MaxCmdSN)) {\r
- Session->MaxCmdSN = MaxCmdSN;\r
- }\r
-\r
- if (ISCSI_SEQ_GT (ExpCmdSN, Session->ExpCmdSN)) {\r
- Session->ExpCmdSN = ExpCmdSN;\r
- }\r
-}\r
-\r
-/**\r
- This function does the iSCSI connection login.\r
-\r
- @param[in, out] Conn The iSCSI connection to login.\r
-\r
- @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.\r
- @retval EFI_TIMEOUT Timeout happened during the login procedure.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiConnLogin (\r
- IN OUT ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- EFI_STATUS Status;\r
-\r
- //\r
- // Start the timer, wait 16 seconds to establish the TCP connection.\r
- //\r
- Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, 16 * TICKS_PER_SECOND);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- //\r
- // try to establish the tcp connection\r
- //\r
- Status = Tcp4IoConnect (&Conn->Tcp4Io, Conn->TimeoutEvent);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- gBS->SetTimer (Conn->TimeoutEvent, TimerCancel, 0);\r
- Conn->State = CONN_STATE_IN_LOGIN;\r
-\r
- //\r
- // connection is established, start the iSCSI Login\r
- //\r
- do {\r
- Status = IScsiSendLoginReq (Conn);\r
- if (EFI_ERROR (Status)) {\r
- break;\r
- }\r
-\r
- Status = IScsiReceiveLoginRsp (Conn);\r
- if (EFI_ERROR (Status)) {\r
- break;\r
- }\r
- } while (Conn->CurrentStage != ISCSI_FULL_FEATURE_PHASE);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Reset the iSCSI connection.\r
-\r
- @param[in, out] Conn The iSCSI connection to reset.\r
-**/\r
-VOID\r
-IScsiConnReset (\r
- IN OUT ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- Tcp4IoReset (&Conn->Tcp4Io);\r
-}\r
-\r
-/**\r
- Create a TCP connection for the iSCSI session.\r
-\r
- @param[in] Private The iSCSI driver data.\r
- @param[in] Session Maximum CmdSN from the target.\r
-\r
- @return The newly created iSCSI connection.\r
-**/\r
-ISCSI_CONNECTION *\r
-IScsiCreateConnection (\r
- IN ISCSI_DRIVER_DATA *Private,\r
- IN ISCSI_SESSION *Session\r
- )\r
-{\r
- ISCSI_CONNECTION *Conn;\r
- TCP4_IO_CONFIG_DATA Tcp4IoConfig;\r
- EFI_STATUS Status;\r
-\r
- Conn = AllocatePool (sizeof (ISCSI_CONNECTION));\r
- if (Conn == NULL) {\r
- return NULL;\r
- }\r
-\r
- Conn->Signature = ISCSI_CONNECTION_SIGNATURE;\r
- Conn->State = CONN_STATE_FREE;\r
- Conn->CurrentStage = ISCSI_SECURITY_NEGOTIATION;\r
- Conn->NextStage = ISCSI_LOGIN_OPERATIONAL_NEGOTIATION;\r
- Conn->CHAPStep = ISCSI_CHAP_INITIAL;\r
- Conn->ExpStatSN = 0;\r
- Conn->PartialReqSent = FALSE;\r
- Conn->PartialRspRcvd = FALSE;\r
- Conn->Cid = Session->NextCid++;\r
-\r
- Status = gBS->CreateEvent (\r
- EVT_TIMER,\r
- TPL_CALLBACK,\r
- NULL,\r
- NULL,\r
- &Conn->TimeoutEvent\r
- );\r
- if (EFI_ERROR (Status)) {\r
- FreePool (Conn);\r
- return NULL;\r
- }\r
-\r
- NetbufQueInit (&Conn->RspQue);\r
-\r
- //\r
- // set the default connection-only parameters\r
- //\r
- Conn->MaxRecvDataSegmentLength = DEFAULT_MAX_RECV_DATA_SEG_LEN;\r
- Conn->HeaderDigest = IScsiDigestNone;\r
- Conn->DataDigest = IScsiDigestNone;\r
-\r
- CopyMem (&Tcp4IoConfig.LocalIp, &Session->ConfigData.NvData.LocalIp, sizeof (EFI_IPv4_ADDRESS));\r
- CopyMem (&Tcp4IoConfig.SubnetMask, &Session->ConfigData.NvData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
- CopyMem (&Tcp4IoConfig.Gateway, &Session->ConfigData.NvData.Gateway, sizeof (EFI_IPv4_ADDRESS));\r
- CopyMem (&Tcp4IoConfig.RemoteIp, &Session->ConfigData.NvData.TargetIp, sizeof (EFI_IPv4_ADDRESS));\r
-\r
- Tcp4IoConfig.RemotePort = Session->ConfigData.NvData.TargetPort;\r
-\r
- //\r
- // Create the tcp4 IO for this connection\r
- //\r
- Status = Tcp4IoCreateSocket (\r
- Private->Image,\r
- Private->Controller,\r
- &Tcp4IoConfig,\r
- &Conn->Tcp4Io\r
- );\r
- if (EFI_ERROR (Status)) {\r
- gBS->CloseEvent (Conn->TimeoutEvent);\r
- FreePool (Conn);\r
- Conn = NULL;\r
- }\r
-\r
- return Conn;\r
-}\r
-\r
-/**\r
- Destroy an iSCSI connection.\r
-\r
- @param[in] Conn The connection to destroy.\r
-**/\r
-VOID\r
-IScsiDestroyConnection (\r
- IN ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- Tcp4IoDestroySocket (&Conn->Tcp4Io);\r
- NetbufQueFlush (&Conn->RspQue);\r
- gBS->CloseEvent (Conn->TimeoutEvent);\r
- FreePool (Conn);\r
-}\r
-\r
-/**\r
- Login the iSCSI session.\r
-\r
- @param[in] Private The iSCSI driver data.\r
-\r
- @retval EFI_SUCCESS The iSCSI session login procedure finished.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval EFI_NO_MEDIA There was a media error.\r
- @retval Others Other errors as indicated.\r
-\r
-**/\r
-EFI_STATUS\r
-IScsiSessionLogin (\r
- IN ISCSI_DRIVER_DATA *Private\r
- )\r
-{\r
- EFI_STATUS Status;\r
- ISCSI_SESSION *Session;\r
- ISCSI_CONNECTION *Conn;\r
- EFI_TCP4_PROTOCOL *Tcp4;\r
- EFI_STATUS MediaStatus;\r
-\r
- Session = &Private->Session;\r
-\r
- //\r
- // Check media status before session login\r
- //\r
- MediaStatus = EFI_SUCCESS;\r
- NetLibDetectMediaWaitTimeout (Private->Controller, ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME, &MediaStatus);\r
- if (MediaStatus != EFI_SUCCESS) {\r
- return EFI_NO_MEDIA;\r
- }\r
-\r
- //\r
- // Set session identifier\r
- //\r
- CopyMem (Session->Isid, Session->ConfigData.NvData.IsId, 6);\r
-\r
- //\r
- // Create a connection for the session.\r
- //\r
- Conn = IScsiCreateConnection (Private, Session);\r
- if (Conn == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- IScsiAttatchConnection (Session, Conn);\r
-\r
- //\r
- // Login througth the newly created connection.\r
- //\r
- Status = IScsiConnLogin (Conn);\r
- if (EFI_ERROR (Status)) {\r
- IScsiConnReset (Conn);\r
- IScsiDetatchConnection (Conn);\r
- IScsiDestroyConnection (Conn);\r
- } else {\r
- Session->State = SESSION_STATE_LOGGED_IN;\r
-\r
- gBS->OpenProtocol (\r
- Conn->Tcp4Io.Handle,\r
- &gEfiTcp4ProtocolGuid,\r
- (VOID **)&Tcp4,\r
- Private->Image,\r
- Private->ExtScsiPassThruHandle,\r
- EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
- );\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Build and send the iSCSI login request to the iSCSI target according to\r
- the current login stage.\r
-\r
- @param[in] Conn The connection in the iSCSI login phase.\r
-\r
- @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this\r
- connection.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval EFI_DEVICE_ERROR Some kind of device error happened.\r
-**/\r
-EFI_STATUS\r
-IScsiSendLoginReq (\r
- IN ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- NET_BUF *Pdu;\r
- EFI_STATUS Status;\r
-\r
- //\r
- // build the Login Request PDU\r
- //\r
- Pdu = IScsiPrepareLoginReq (Conn);\r
- if (Pdu == NULL) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
- //\r
- // Send it to the iSCSI target.\r
- //\r
- Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);\r
-\r
- NetbufFree (Pdu);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Receive and process the iSCSI login response.\r
-\r
- @param[in] Conn The connection in the iSCSI login phase.\r
-\r
- @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiReceiveLoginRsp (\r
- IN ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- EFI_STATUS Status;\r
- NET_BUF *Pdu;\r
-\r
- Pdu = NULL;\r
-\r
- //\r
- // Receive the iSCSI login response.\r
- //\r
- Status = IScsiReceivePdu (Conn, &Pdu, NULL, FALSE, FALSE, NULL);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- //\r
- // A Login Response is received, process it.\r
- //\r
- ASSERT (Pdu != NULL);\r
- Status = IScsiProcessLoginRsp (Conn, Pdu);\r
-\r
- NetbufFree (Pdu);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.\r
- The DataSegmentLength and the actual size of the net buffer containing this PDU will be\r
- updated.\r
-\r
- @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will\r
- be added to.\r
- @param[in] Key The key name string.\r
- @param[in] Value The value string.\r
-\r
- @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and\r
- the correspondence length fields are updated.\r
- @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value\r
- pair.\r
-**/\r
-EFI_STATUS\r
-IScsiAddKeyValuePair (\r
- IN OUT NET_BUF *Pdu,\r
- IN CHAR8 *Key,\r
- IN CHAR8 *Value\r
- )\r
-{\r
- UINT32 DataSegLen;\r
- UINT32 KeyLen;\r
- UINT32 ValueLen;\r
- UINT32 TotalLen;\r
- ISCSI_LOGIN_REQUEST *LoginReq;\r
- CHAR8 *Data;\r
-\r
- LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufGetByte (Pdu, 0, NULL);\r
- if (LoginReq == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- DataSegLen = NTOH24 (LoginReq->DataSegmentLength);\r
-\r
- KeyLen = (UINT32) AsciiStrLen (Key);\r
- ValueLen = (UINT32) AsciiStrLen (Value);\r
-\r
- //\r
- // 1 byte for the key value separator '=' and 1 byte for the null\r
- // delimiter after the value.\r
- //\r
- TotalLen = KeyLen + 1 + ValueLen + 1;\r
-\r
- //\r
- // Allocate the space for the key-value pair.\r
- //\r
- Data = (CHAR8 *)NetbufAllocSpace (Pdu, TotalLen, NET_BUF_TAIL);\r
- if (Data == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
- //\r
- // Add the key.\r
- //\r
- CopyMem (Data, Key, KeyLen);\r
- Data += KeyLen;\r
-\r
- *Data = '=';\r
- Data++;\r
-\r
- //\r
- // Add the value.\r
- //\r
- CopyMem (Data, Value, ValueLen);\r
- Data += ValueLen;\r
-\r
- *Data = '\0';\r
-\r
- //\r
- // update the DataSegmentLength\r
- //\r
- ISCSI_SET_DATASEG_LEN (LoginReq, DataSegLen + TotalLen);\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Prepare the iSCSI login request to be sent according to the current login status.\r
-\r
- @param[in, out] Conn The connection in the iSCSI login phase.\r
-\r
- @return The pointer to the net buffer containing the iSCSI login request built.\r
- @retval Others Other errors as indicated.\r
-**/\r
-NET_BUF *\r
-IScsiPrepareLoginReq (\r
- IN OUT ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- ISCSI_SESSION *Session;\r
- NET_BUF *Nbuf;\r
- ISCSI_LOGIN_REQUEST *LoginReq;\r
- EFI_STATUS Status;\r
-\r
- Session = Conn->Session;\r
-\r
- Nbuf = NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST) + DEFAULT_MAX_RECV_DATA_SEG_LEN);\r
- if (Nbuf == NULL) {\r
- return NULL;\r
- }\r
-\r
- LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufAllocSpace (Nbuf, sizeof (ISCSI_LOGIN_REQUEST), NET_BUF_TAIL);\r
- ASSERT (LoginReq != NULL);\r
- ZeroMem (LoginReq, sizeof (ISCSI_LOGIN_REQUEST));\r
-\r
- //\r
- // Init the login request pdu\r
- //\r
- ISCSI_SET_OPCODE (LoginReq, ISCSI_OPCODE_LOGIN_REQ, ISCSI_REQ_IMMEDIATE);\r
- ISCSI_SET_STAGES (LoginReq, Conn->CurrentStage, Conn->NextStage);\r
- LoginReq->VersionMax = ISCSI_VERSION_MAX;\r
- LoginReq->VersionMin = ISCSI_VERSION_MIN;\r
- LoginReq->Tsih = HTONS (Session->Tsih);\r
- LoginReq->InitiatorTaskTag = HTONL (Session->InitiatorTaskTag);\r
- LoginReq->Cid = HTONS (Conn->Cid);\r
- LoginReq->CmdSN = HTONL (Session->CmdSN);\r
-\r
- //\r
- // For the first Login Request on a coonection this is ExpStatSN for the\r
- // old connection and this field is only valid if the Login Request restarts\r
- // a connection.\r
- // For subsequent Login Requests it is used to acknowledge the Login Responses\r
- // with their increasing StatSN values.\r
- //\r
- LoginReq->ExpStatSN = HTONL (Conn->ExpStatSN);\r
- CopyMem (LoginReq->Isid, Session->Isid, sizeof (LoginReq->Isid));\r
-\r
- if (Conn->PartialRspRcvd) {\r
- //\r
- // A partial response, initiator must send an empty Login Request.\r
- //\r
- return Nbuf;\r
- }\r
-\r
- switch (Conn->CurrentStage) {\r
- case ISCSI_SECURITY_NEGOTIATION:\r
- Status = IScsiCHAPToSendReq (Conn, Nbuf);\r
- break;\r
-\r
- case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION:\r
- Status = IScsiFillOpParams (Conn, Nbuf);\r
- ISCSI_SET_FLAG (LoginReq, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT);\r
- break;\r
-\r
- default:\r
- //\r
- // something error happens...\r
- //\r
- Status = EFI_DEVICE_ERROR;\r
- break;\r
- }\r
-\r
- if (EFI_ERROR (Status)) {\r
- NetbufFree (Nbuf);\r
- Nbuf = NULL;\r
- } else {\r
- //\r
- // Pad the data segment if needed.\r
- //\r
- IScsiPadSegment (Nbuf, ISCSI_GET_DATASEG_LEN (LoginReq));\r
- //\r
- // Check whether we will issue the stage transition signal?\r
- //\r
- Conn->TransitInitiated = (BOOLEAN) ISCSI_FLAG_ON (LoginReq, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT);\r
- }\r
-\r
- return Nbuf;\r
-}\r
-\r
-/**\r
- Process the iSCSI Login Response.\r
-\r
- @param[in, out] Conn The connection on which the iSCSI login response is received.\r
- @param[in, out] Pdu The iSCSI login response PDU.\r
-\r
- @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
- @retval EFI_MEDIA_CHANGED Target is redirected.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiProcessLoginRsp (\r
- IN OUT ISCSI_CONNECTION *Conn,\r
- IN OUT NET_BUF *Pdu\r
- )\r
-{\r
- EFI_STATUS Status;\r
- ISCSI_SESSION *Session;\r
- ISCSI_LOGIN_RESPONSE *LoginRsp;\r
- BOOLEAN Transit;\r
- BOOLEAN Continue;\r
- UINT8 CurrentStage;\r
- UINT8 NextStage;\r
- UINT8 *DataSeg;\r
- UINT32 DataSegLen;\r
-\r
- Session = Conn->Session;\r
-\r
- LoginRsp = (ISCSI_LOGIN_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);\r
- if (LoginRsp == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- if (!ISCSI_CHECK_OPCODE (LoginRsp, ISCSI_OPCODE_LOGIN_RSP)) {\r
- //\r
- // It's not a Login Response\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- //\r
- // Get the data segment if any.\r
- //\r
- DataSegLen = ISCSI_GET_DATASEG_LEN (LoginRsp);\r
- if (DataSegLen != 0) {\r
- DataSeg = NetbufGetByte (Pdu, sizeof (ISCSI_LOGIN_RESPONSE), NULL);\r
- } else {\r
- DataSeg = NULL;\r
- }\r
- //\r
- // Check the status class in the login response PDU.\r
- //\r
- switch (LoginRsp->StatusClass) {\r
- case ISCSI_LOGIN_STATUS_SUCCESS:\r
- //\r
- // Just break here, the response and the data segment will be processed later.\r
- //\r
- break;\r
-\r
- case ISCSI_LOGIN_STATUS_REDIRECTION:\r
- //\r
- // The target may be moved to a different address\r
- //\r
- if (DataSeg == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- //\r
- // Process the TargetAddress key-value strings in the data segment to update the\r
- // target address info.\r
- //\r
- Status = IScsiUpdateTargetAddress (Session, (CHAR8 *)DataSeg, DataSegLen);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- //\r
- // Session will be restarted on this error status because the Target is\r
- // redirected by this Login Response.\r
- //\r
- return EFI_MEDIA_CHANGED;\r
-\r
- default:\r
- //\r
- // Initiator Error, Target Error, or any other undefined error code.\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- //\r
- // The status is sucess, extract the wanted fields from the header segment.\r
- //\r
- Transit = (BOOLEAN) ISCSI_FLAG_ON (LoginRsp, ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT);\r
- Continue = (BOOLEAN) ISCSI_FLAG_ON (LoginRsp, ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE);\r
-\r
- CurrentStage = (UINT8) ISCSI_GET_CURRENT_STAGE (LoginRsp);\r
- NextStage = (UINT8) ISCSI_GET_NEXT_STAGE (LoginRsp);\r
-\r
- LoginRsp->InitiatorTaskTag = NTOHL (LoginRsp->InitiatorTaskTag);\r
-\r
- if ((Transit && Continue) ||\r
- (CurrentStage != Conn->CurrentStage) ||\r
- (!Conn->TransitInitiated && Transit) ||\r
- (Transit && (NextStage != Conn->NextStage)) ||\r
- (CompareMem (Session->Isid, LoginRsp->Isid, sizeof (LoginRsp->Isid)) != 0) ||\r
- (LoginRsp->InitiatorTaskTag != Session->InitiatorTaskTag)\r
- ) {\r
- //\r
- // A Login Response with the C bit set to 1 MUST have the T bit set to 0;\r
- // The CSG in the Login Response MUST be the same with the I-end of this connection;\r
- // The T bit can't be 1 if the last Login Response sent by the initiator doesn't\r
- // initiate the transistion;\r
- // The NSG MUST be the same with the I-end of this connection if Transit is required.\r
- // The ISID in the Login Response MUST be the same with this session.\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- LoginRsp->StatSN = NTOHL (LoginRsp->StatSN);\r
- LoginRsp->ExpCmdSN = NTOHL (LoginRsp->ExpCmdSN);\r
- LoginRsp->MaxCmdSN = NTOHL (LoginRsp->MaxCmdSN);\r
-\r
- if ((Conn->CurrentStage == ISCSI_SECURITY_NEGOTIATION) && (Conn->CHAPStep == ISCSI_CHAP_INITIAL)) {\r
- //\r
- // If the Login Request is a leading Login Request, the target MUST use\r
- // the value presented in CmdSN as the target value for ExpCmdSN.\r
- //\r
- if ((Session->State == SESSION_STATE_FREE) && (Session->CmdSN != LoginRsp->ExpCmdSN)) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- //\r
- // It's the initial Login Response, initialize the local ExpStatSN, MaxCmdSN\r
- // and ExpCmdSN.\r
- //\r
- Conn->ExpStatSN = LoginRsp->StatSN + 1;\r
- Session->MaxCmdSN = LoginRsp->MaxCmdSN;\r
- Session->ExpCmdSN = LoginRsp->ExpCmdSN;\r
- } else {\r
- //\r
- // Check the StatSN of this PDU\r
- //\r
- Status = IScsiCheckSN (&Conn->ExpStatSN, LoginRsp->StatSN);\r
- if (!EFI_ERROR (Status)) {\r
- //\r
- // Update the MaxCmdSN and ExpCmdSN\r
- //\r
- IScsiUpdateCmdSN (Session, LoginRsp->MaxCmdSN, LoginRsp->ExpCmdSN);\r
- } else {\r
- return Status;\r
- }\r
- }\r
- //\r
- // Trim off the header segment.\r
- //\r
- NetbufTrim (Pdu, sizeof (ISCSI_LOGIN_RESPONSE), NET_BUF_HEAD);\r
-\r
- //\r
- // Queue this login response first in case it's a partial response so that\r
- // later when the full response list is received we can combine these scattered\r
- // responses' data segment and then process it.\r
- //\r
- NET_GET_REF (Pdu);\r
- NetbufQueAppend (&Conn->RspQue, Pdu);\r
-\r
- Conn->PartialRspRcvd = Continue;\r
- if (Continue) {\r
- //\r
- // It's a partial response, have to wait for another or more Request/Response\r
- // conversations to get the full response.\r
- //\r
- return EFI_SUCCESS;\r
- }\r
-\r
- switch (CurrentStage) {\r
- case ISCSI_SECURITY_NEGOTIATION:\r
- //\r
- // In security negotiation stage, let CHAP module handle it.\r
- //\r
- Status = IScsiCHAPOnRspReceived (Conn);\r
- break;\r
-\r
- case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION:\r
- //\r
- // Response received with negotiation resonse on iSCSI parameters, check them.\r
- //\r
- Status = IScsiCheckOpParams (Conn);\r
- break;\r
-\r
- default:\r
- //\r
- // Should never get here.\r
- //\r
- Status = EFI_PROTOCOL_ERROR;\r
- break;\r
- }\r
-\r
- if (Transit && (Status == EFI_SUCCESS)) {\r
- //\r
- // Do the state transition.\r
- //\r
- Conn->CurrentStage = Conn->NextStage;\r
-\r
- if (Conn->CurrentStage == ISCSI_LOGIN_OPERATIONAL_NEGOTIATION) {\r
- Conn->NextStage = ISCSI_FULL_FEATURE_PHASE;\r
- } else {\r
- //\r
- // CurrentStage is iSCSI Full Feature, it's the Login-Final Response,\r
- // get the TSIH from the Login Response.\r
- //\r
- Session->Tsih = NTOHS (LoginRsp->Tsih);\r
- }\r
- }\r
- //\r
- // Flush the response(s) received.\r
- //\r
- NetbufQueFlush (&Conn->RspQue);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Updated the target information according the data received in the iSCSI\r
- login response with an target redirection status.\r
-\r
- @param[in, out] Session The iSCSI session.\r
- @param[in] Data The data segment which should contain the\r
- TargetAddress key-value list.\r
- @param[in] Len Length of the data.\r
-\r
- @retval EFI_SUCCESS The target address is updated.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval EFI_NOT_FOUND The TargetAddress key is not found.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiUpdateTargetAddress (\r
- IN OUT ISCSI_SESSION *Session,\r
- IN CHAR8 *Data,\r
- IN UINT32 Len\r
- )\r
-{\r
- LIST_ENTRY *KeyValueList;\r
- CHAR8 *TargetAddress;\r
- CHAR8 *IpStr;\r
- EFI_STATUS Status;\r
- UINTN Number;\r
-\r
- KeyValueList = IScsiBuildKeyValueList (Data, Len);\r
- if (KeyValueList == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- Status = EFI_NOT_FOUND;\r
-\r
- while (TRUE) {\r
- TargetAddress = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ADDRESS);\r
- if (TargetAddress == NULL) {\r
- break;\r
- }\r
-\r
- if (!NET_IS_DIGIT (TargetAddress[0])) {\r
- //\r
- // The domainname of the target may be presented in three formats: a DNS host name,\r
- // a dotted-decimal IPv4 address, or a bracketed IPv6 address. Only accept dotted\r
- // IPv4 address.\r
- //\r
- continue;\r
- }\r
-\r
- IpStr = TargetAddress;\r
-\r
- while ((*TargetAddress != 0) && (*TargetAddress != ':') && (*TargetAddress != ',')) {\r
- //\r
- // NULL, ':' or ',' ends the IPv4 string.\r
- //\r
- TargetAddress++;\r
- }\r
-\r
- if (*TargetAddress == ',') {\r
- //\r
- // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent\r
- // as the result of a redirection.\r
- //\r
- continue;\r
- } else if (*TargetAddress == ':') {\r
- *TargetAddress = '\0';\r
-\r
- TargetAddress++;\r
-\r
- Number = AsciiStrDecimalToUintn (TargetAddress);\r
- if (Number > 0xFFFF) {\r
- continue;\r
- } else {\r
- Session->ConfigData.NvData.TargetPort = (UINT16) Number;\r
- }\r
- } else {\r
- //\r
- // The string only contains the IPv4 address. Use the well known port.\r
- //\r
- Session->ConfigData.NvData.TargetPort = ISCSI_WELL_KNOWN_PORT;\r
- }\r
- //\r
- // Update the target IP address.\r
- //\r
- Status = IScsiAsciiStrToIp (IpStr, &Session->ConfigData.NvData.TargetIp);\r
- if (EFI_ERROR (Status)) {\r
- continue;\r
- } else {\r
- break;\r
- }\r
- }\r
-\r
- IScsiFreeKeyValueList (KeyValueList);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- The callback function to free the net buffer list.\r
-\r
- @param[in] Arg The opaque parameter.\r
-**/\r
-VOID\r
-EFIAPI\r
-IScsiFreeNbufList (\r
- VOID *Arg\r
- )\r
-{\r
- ASSERT (Arg != NULL);\r
-\r
- NetbufFreeList ((LIST_ENTRY *) Arg);\r
- FreePool (Arg);\r
-}\r
-\r
-/**\r
- The callback function called in NetBufFree, it does nothing.\r
-\r
- @param[in] Arg The opaque parameter.\r
-**/\r
-VOID\r
-EFIAPI\r
-IScsiNbufExtFree (\r
- VOID *Arg\r
- )\r
-{\r
-}\r
-\r
-/**\r
- Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and\r
- an optional data segment. The two parts will be put into two blocks of buffers in the\r
- net buffer. The digest check will be conducted in this function if needed and the digests\r
- will be trimmed from the PDU buffer.\r
-\r
- @param[in] Conn The iSCSI connection to receive data from.\r
- @param[out] Pdu The received iSCSI pdu.\r
- @param[in] Context The context used to describe information on the caller provided\r
- buffer to receive data segment of the iSCSI pdu, it's optional.\r
- @param[in] HeaderDigest Whether there will be header digest received.\r
- @param[in] DataDigest Whether there will be data digest.\r
- @param[in] TimeoutEvent The timeout event, it's optional.\r
-\r
- @retval EFI_SUCCESS An iSCSI pdu is received.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiReceivePdu (\r
- IN ISCSI_CONNECTION *Conn,\r
- OUT NET_BUF **Pdu,\r
- IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL\r
- IN BOOLEAN HeaderDigest,\r
- IN BOOLEAN DataDigest,\r
- IN EFI_EVENT TimeoutEvent OPTIONAL\r
- )\r
-{\r
- LIST_ENTRY *NbufList;\r
- UINT32 Len;\r
- NET_BUF *PduHdr;\r
- UINT8 *Header;\r
- EFI_STATUS Status;\r
- UINT32 PadLen;\r
- UINT32 InDataOffset;\r
- NET_FRAGMENT Fragment[2];\r
- UINT32 FragmentCount;\r
- NET_BUF *DataSeg;\r
- UINT32 PadAndCRC32[2];\r
-\r
- NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
- if (NbufList == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- InitializeListHead (NbufList);\r
-\r
- //\r
- // The header digest will be received together with the PDU header if exists.\r
- //\r
- Len = sizeof (ISCSI_BASIC_HEADER) + (HeaderDigest ? sizeof (UINT32) : 0);\r
- PduHdr = NetbufAlloc (Len);\r
- if (PduHdr == NULL) {\r
- FreePool (NbufList);\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- Header = NetbufAllocSpace (PduHdr, Len, NET_BUF_TAIL);\r
- ASSERT (Header != NULL);\r
- InsertTailList (NbufList, &PduHdr->List);\r
-\r
- //\r
- // First step, receive the BHS of the PDU.\r
- //\r
- Status = Tcp4IoReceive (&Conn->Tcp4Io, PduHdr, FALSE, TimeoutEvent);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
-\r
- if (HeaderDigest) {\r
- //\r
- // TODO: check the header-digest.\r
- //\r
- //\r
- // Trim off the digest.\r
- //\r
- NetbufTrim (PduHdr, sizeof (UINT32), NET_BUF_TAIL);\r
- }\r
-\r
- Len = ISCSI_GET_DATASEG_LEN (Header);\r
- if (Len == 0) {\r
- //\r
- // No data segment.Form the pdu from a list of pdu segments.\r
- //\r
- *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
- if (*Pdu == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto ON_EXIT;\r
- }\r
- return Status;\r
- }\r
- //\r
- // Get the length of the padding bytes of the data segment.\r
- //\r
- PadLen = ISCSI_GET_PAD_LEN (Len);\r
-\r
- switch (ISCSI_GET_OPCODE (Header)) {\r
- case ISCSI_OPCODE_SCSI_DATA_IN:\r
- //\r
- // Try to use the buffer described by Context if the PDU is an\r
- // iSCSI SCSI data in pdu so as to reduce memory copy overhead.\r
- //\r
- InDataOffset = ISCSI_GET_BUFFER_OFFSET (Header);\r
- if ((Context == NULL) || ((InDataOffset + Len) > Context->InDataLen)) {\r
- Status = EFI_PROTOCOL_ERROR;\r
- goto ON_EXIT;\r
- }\r
-\r
- Fragment[0].Len = Len;\r
- Fragment[0].Bulk = Context->InData + InDataOffset;\r
-\r
- if (DataDigest || (PadLen != 0)) {\r
- //\r
- // The data segment is padded, use two fragments to receive it.\r
- // The first to receive the useful data. The second to receive the padding.\r
- //\r
- Fragment[1].Len = PadLen + (DataDigest ? sizeof (UINT32) : 0);\r
- Fragment[1].Bulk = (UINT8 *)PadAndCRC32 + (4 - PadLen);\r
- FragmentCount = 2;\r
- } else {\r
- FragmentCount = 1;\r
- }\r
-\r
- DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);\r
- if (DataSeg == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto ON_EXIT;\r
- }\r
-\r
- break;\r
-\r
- case ISCSI_OPCODE_SCSI_RSP:\r
- case ISCSI_OPCODE_NOP_IN:\r
- case ISCSI_OPCODE_LOGIN_RSP:\r
- case ISCSI_OPCODE_TEXT_RSP:\r
- case ISCSI_OPCODE_ASYNC_MSG:\r
- case ISCSI_OPCODE_REJECT:\r
- case ISCSI_OPCODE_VENDOR_T0:\r
- case ISCSI_OPCODE_VENDOR_T1:\r
- case ISCSI_OPCODE_VENDOR_T2:\r
- //\r
- // Allocate buffer to receive the data segment.\r
- //\r
- Len += PadLen + (DataDigest ? sizeof (UINT32) : 0);\r
- DataSeg = NetbufAlloc (Len);\r
- if (DataSeg == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto ON_EXIT;\r
- }\r
-\r
- NetbufAllocSpace (DataSeg, Len, NET_BUF_TAIL);\r
- break;\r
-\r
- default:\r
- Status = EFI_PROTOCOL_ERROR;\r
- goto ON_EXIT;\r
- }\r
-\r
- InsertTailList (NbufList, &DataSeg->List);\r
-\r
- //\r
- // Receive the data segment with the data digest if any.\r
- //\r
- Status = Tcp4IoReceive (&Conn->Tcp4Io, DataSeg, FALSE, TimeoutEvent);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
-\r
- if (DataDigest) {\r
- //\r
- // TODO: Check the data digest.\r
- //\r
- NetbufTrim (DataSeg, sizeof (UINT32), NET_BUF_TAIL);\r
- }\r
-\r
- if (PadLen != 0) {\r
- //\r
- // Trim off the padding bytes in the data segment.\r
- //\r
- NetbufTrim (DataSeg, PadLen, NET_BUF_TAIL);\r
- }\r
-\r
- //\r
- // Form the pdu from a list of pdu segments.\r
- //\r
- *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
- if (*Pdu == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
-ON_EXIT:\r
-\r
- if (EFI_ERROR (Status)) {\r
- //\r
- // Free the Nbufs in this NbufList and the NbufList itself.\r
- //\r
- IScsiFreeNbufList (NbufList);\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Check and get the result of the prameter negotiation.\r
-\r
- @param[in, out] Conn The connection in iSCSI login.\r
-\r
- @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
-**/\r
-EFI_STATUS\r
-IScsiCheckOpParams (\r
- IN OUT ISCSI_CONNECTION *Conn\r
- )\r
-{\r
- EFI_STATUS Status;\r
- LIST_ENTRY *KeyValueList;\r
- CHAR8 *Data;\r
- UINT32 Len;\r
- ISCSI_SESSION *Session;\r
- CHAR8 *Value;\r
- UINTN NumericValue;\r
-\r
- ASSERT (Conn->RspQue.BufNum != 0);\r
-\r
- Session = Conn->Session;\r
-\r
- Len = Conn->RspQue.BufSize;\r
- Data = AllocatePool (Len);\r
- if (Data == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- NetbufQueCopy (&Conn->RspQue, 0, Len, (UINT8 *) Data);\r
-\r
- Status = EFI_PROTOCOL_ERROR;\r
-\r
- //\r
- // Extract the Key-Value pairs into a list.\r
- //\r
- KeyValueList = IScsiBuildKeyValueList (Data, Len);\r
- if (KeyValueList == NULL) {\r
- FreePool (Data);\r
- return Status;\r
- }\r
- //\r
- // HeaderDigest\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_HEADER_DIGEST);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- if (AsciiStrCmp (Value, "CRC32") == 0) {\r
- if (Conn->HeaderDigest != IScsiDigestCRC32) {\r
- goto ON_ERROR;\r
- }\r
- } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {\r
- Conn->HeaderDigest = IScsiDigestNone;\r
- } else {\r
- goto ON_ERROR;\r
- }\r
- //\r
- // DataDigest\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_DIGEST);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- if (AsciiStrCmp (Value, "CRC32") == 0) {\r
- if (Conn->DataDigest != IScsiDigestCRC32) {\r
- goto ON_ERROR;\r
- }\r
- } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {\r
- Conn->DataDigest = IScsiDigestNone;\r
- } else {\r
- goto ON_ERROR;\r
- }\r
- //\r
- // ErrorRecoveryLevel, result fuction is Minimum.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- if (NumericValue > 2) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->ErrorRecoveryLevel = (UINT8) MIN (Session->ErrorRecoveryLevel, NumericValue);\r
-\r
- //\r
- // InitialR2T, result function is OR.\r
- //\r
- if (!Session->InitialR2T) {\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->InitialR2T = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);\r
- }\r
-\r
- //\r
- // ImmediateData, result function is AND.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_IMMEDIATE_DATA);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0));\r
-\r
- //\r
- // MaxRecvDataSegmentLength is declarative.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);\r
- if (Value != NULL) {\r
- Conn->MaxRecvDataSegmentLength = (UINT32) AsciiStrDecimalToUintn (Value);\r
- }\r
- //\r
- // MaxBurstLength, result funtion is Mininum.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_LENGTH);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- Session->MaxBurstLength = (UINT32) MIN (Session->MaxBurstLength, NumericValue);\r
-\r
- //\r
- // FirstBurstLength, result function is Minimum. Irrelevant when InitialR2T=Yes and\r
- // ImmediateData=No.\r
- // This Key/Value is negotiation type.\r
- //\r
- if (!(Session->InitialR2T && !Session->ImmediateData)) {\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- Session->FirstBurstLength = (UINT32) MIN (Session->FirstBurstLength, NumericValue);\r
- }\r
-\r
- //\r
- // MaxConnections, result function is Minimum.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_CONNECTIONS);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- if ((NumericValue == 0) || (NumericValue > 65535)) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->MaxConnections = (UINT32) MIN (Session->MaxConnections, NumericValue);\r
-\r
- //\r
- // DataPDUInOrder, result function is OR.\r
- //\r
- if (!Session->DataPDUInOrder) {\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->DataPDUInOrder = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);\r
- }\r
-\r
- //\r
- // DataSequenceInorder, result function is OR.\r
- //\r
- if (!Session->DataSequenceInOrder) {\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->DataSequenceInOrder = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);\r
- }\r
-\r
- //\r
- // DefaultTime2Wait, result function is Maximum.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2WAIT);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- if (NumericValue == 0) {\r
- Session->DefaultTime2Wait = 0;\r
- } else if (NumericValue > 3600) {\r
- goto ON_ERROR;\r
- } else {\r
- Session->DefaultTime2Wait = (UINT32) MAX (Session->DefaultTime2Wait, NumericValue);\r
- }\r
- //\r
- // DefaultTime2Retain, result function is Minimum.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2RETAIN);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- if (NumericValue == 0) {\r
- Session->DefaultTime2Retain = 0;\r
- } else if (NumericValue > 3600) {\r
- goto ON_ERROR;\r
- } else {\r
- Session->DefaultTime2Retain = (UINT32) MIN (Session->DefaultTime2Retain, NumericValue);\r
- }\r
- //\r
- // MaxOutstandingR2T, result function is Minimum.\r
- //\r
- Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_OUTSTANDING_R2T);\r
- if (Value == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
- if ((NumericValue == 0) || (NumericValue > 65535)) {\r
- goto ON_ERROR;\r
- }\r
-\r
- Session->MaxOutstandingR2T = (UINT16) MIN (Session->MaxOutstandingR2T, NumericValue);\r
-\r
- //\r
- // Remove declarative key-value pairs, if any.\r
- //\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_SESSION_TYPE);\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ALIAS);\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG);\r
- //\r
- // Remove the key-value that may not needed for result function is OR.\r
- //\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);\r
-\r
- //\r
- // Remove irrelevant parameter, if any.\r
- //\r
- if (Session->InitialR2T && !Session->ImmediateData) {\r
- IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);\r
- }\r
-\r
- if (IsListEmpty (KeyValueList)) {\r
- //\r
- // Succeed if no more keys in the list.\r
- //\r
- Status = EFI_SUCCESS;\r
- }\r
-\r
-ON_ERROR:\r
-\r
- IScsiFreeKeyValueList (KeyValueList);\r
-\r
- FreePool (Data);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Fill the oprational prameters.\r
-\r
- @param[in] Conn The connection in iSCSI login.\r
- @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.\r
-\r
- @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.\r
-**/\r
-EFI_STATUS\r
-IScsiFillOpParams (\r
- IN ISCSI_CONNECTION *Conn,\r
- IN OUT NET_BUF *Pdu\r
- )\r
-{\r
- ISCSI_SESSION *Session;\r
- CHAR8 Value[256];\r
-\r
- Session = Conn->Session;\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_HEADER_DIGEST, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%a", (Conn->DataDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_DIGEST, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->ErrorRecoveryLevel);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_ERROR_RECOVERY_LEVEL, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%a", Session->InitialR2T ? "Yes" : "No");\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_INITIAL_R2T, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxBurstLength);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_BURST_LENGTH, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->FirstBurstLength);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_FIRST_BURST_LENGTH, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxConnections);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_CONNECTIONS, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%a", Session->DataPDUInOrder ? "Yes" : "No");\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_PDU_IN_ORDER, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%a", Session->DataSequenceInOrder ? "Yes" : "No");\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Wait);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2WAIT, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Retain);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2RETAIN, Value);\r
-\r
- AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxOutstandingR2T);\r
- IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_OUTSTANDING_R2T, Value);\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r
-\r
- @param[in, out] Pdu The iSCSI pdu which contains segments to pad.\r
- @param[in] Len The length of the last semgnet in the PDU.\r
-\r
- @retval EFI_SUCCESS The segment is padded or no need to pad it.\r
- @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the\r
- padding bytes.\r
-**/\r
-EFI_STATUS\r
-IScsiPadSegment (\r
- IN OUT NET_BUF *Pdu,\r
- IN UINT32 Len\r
- )\r
-{\r
- UINT32 PadLen;\r
- UINT8 *Data;\r
-\r
- PadLen = ISCSI_GET_PAD_LEN (Len);\r
-\r
- if (PadLen != 0) {\r
- Data = NetbufAllocSpace (Pdu, PadLen, NET_BUF_TAIL);\r
- if (Data == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- ZeroMem (Data, PadLen);\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Build a key-value list from the data segment.\r
-\r
- @param[in] Data The data segment containing the key-value pairs.\r
- @param[in] Len Length of the data segment.\r
-\r
- @return The key-value list.\r
- @retval NULL Other errors as indicated.\r
-**/\r
-LIST_ENTRY *\r
-IScsiBuildKeyValueList (\r
- IN CHAR8 *Data,\r
- IN UINT32 Len\r
- )\r
-{\r
- LIST_ENTRY *ListHead;\r
- ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
-\r
- ListHead = AllocatePool (sizeof (LIST_ENTRY));\r
- if (ListHead == NULL) {\r
- return NULL;\r
- }\r
-\r
- InitializeListHead (ListHead);\r
-\r
- while (Len > 0) {\r
- KeyValuePair = AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR));\r
- if (KeyValuePair == NULL) {\r
- goto ON_ERROR;\r
- }\r
-\r
- InitializeListHead (&KeyValuePair->List);\r
-\r
- KeyValuePair->Key = Data;\r
-\r
- while ((Len > 0) && (*Data != '=')) {\r
- Len--;\r
- Data++;\r
- }\r
-\r
- if (*Data == '=') {\r
- *Data = '\0';\r
-\r
- Data++;\r
- Len--;\r
- } else {\r
- FreePool (KeyValuePair);\r
- goto ON_ERROR;\r
- }\r
-\r
- KeyValuePair->Value = Data;\r
-\r
- InsertTailList (ListHead, &KeyValuePair->List);;\r
-\r
- Data += AsciiStrLen (KeyValuePair->Value) + 1;\r
- Len -= (UINT32) AsciiStrLen (KeyValuePair->Value) + 1;\r
- }\r
-\r
- return ListHead;\r
-\r
-ON_ERROR:\r
-\r
- IScsiFreeKeyValueList (ListHead);\r
-\r
- return NULL;\r
-}\r
-\r
-/**\r
- Get the value string by the key name from the key-value list. If found,\r
- the key-value entry will be removed from the list.\r
-\r
- @param[in, out] KeyValueList The key-value list.\r
- @param[in] Key The key name to find.\r
-\r
- @return The value string.\r
-**/\r
-CHAR8 *\r
-IScsiGetValueByKeyFromList (\r
- IN OUT LIST_ENTRY *KeyValueList,\r
- IN CHAR8 *Key\r
- )\r
-{\r
- LIST_ENTRY *Entry;\r
- ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
- CHAR8 *Value;\r
-\r
- Value = NULL;\r
-\r
- NET_LIST_FOR_EACH (Entry, KeyValueList) {\r
- KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);\r
-\r
- if (AsciiStrCmp (KeyValuePair->Key, Key) == 0) {\r
- Value = KeyValuePair->Value;\r
-\r
- RemoveEntryList (&KeyValuePair->List);\r
- FreePool (KeyValuePair);\r
- break;\r
- }\r
- }\r
-\r
- return Value;\r
-}\r
-\r
-/**\r
- Free the key-value list.\r
-\r
- @param[in] KeyValueList The key-value list.\r
-**/\r
-VOID\r
-IScsiFreeKeyValueList (\r
- IN LIST_ENTRY *KeyValueList\r
- )\r
-{\r
- LIST_ENTRY *Entry;\r
- ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
-\r
- while (!IsListEmpty (KeyValueList)) {\r
- Entry = NetListRemoveHead (KeyValueList);\r
- KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);\r
-\r
- FreePool (KeyValuePair);\r
- }\r
-\r
- FreePool (KeyValueList);\r
-}\r
-\r
-/**\r
- Normalize the iSCSI name according to RFC.\r
-\r
- @param[in, out] Name The iSCSI name.\r
- @param[in] Len length of the iSCSI name.\r
-\r
- @retval EFI_SUCCESS The iSCSI name is valid and normalized.\r
- @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.\r
-**/\r
-EFI_STATUS\r
-IScsiNormalizeName (\r
- IN OUT CHAR8 *Name,\r
- IN UINTN Len\r
- )\r
-{\r
- UINTN Index;\r
-\r
- for (Index = 0; Index < Len; Index++) {\r
- if (NET_IS_UPPER_CASE_CHAR (Name[Index])) {\r
- //\r
- // Convert the upper-case characters to lower-case ones\r
- //\r
- Name[Index] = (CHAR8) (Name[Index] - 'A' + 'a');\r
- }\r
-\r
- if (!NET_IS_LOWER_CASE_CHAR (Name[Index]) &&\r
- !NET_IS_DIGIT (Name[Index]) &&\r
- (Name[Index] != '-') &&\r
- (Name[Index] != '.') &&\r
- (Name[Index] != ':')\r
- ) {\r
- //\r
- // ASCII dash, dot, colon lower-case characters and digit characters\r
- // are allowed.\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- }\r
-\r
- if ((Len < 4) || (CompareMem (Name, "iqn.", 4) != 0)) {\r
- //\r
- // Only IQN format is accepted now.\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Create an iSCSI task control block.\r
-\r
- @param[in] Conn The connection on which the task control block will be created.\r
- @param[out] Tcb The newly created task control block.\r
-\r
- @retval EFI_SUCCESS The task control block is created.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval EFI_NOT_READY The target can not accept new commands.\r
-**/\r
-EFI_STATUS\r
-IScsiNewTcb (\r
- IN ISCSI_CONNECTION *Conn,\r
- OUT ISCSI_TCB **Tcb\r
- )\r
-{\r
- ISCSI_SESSION *Session;\r
- ISCSI_TCB *NewTcb;\r
-\r
- ASSERT (Tcb != NULL);\r
-\r
- Session = Conn->Session;\r
-\r
- if (ISCSI_SEQ_GT (Session->CmdSN, Session->MaxCmdSN)) {\r
- return EFI_NOT_READY;\r
- }\r
-\r
- NewTcb = AllocateZeroPool (sizeof (ISCSI_TCB));\r
- if (NewTcb == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- InitializeListHead (&NewTcb->Link);\r
-\r
- NewTcb->SoFarInOrder = TRUE;\r
- NewTcb->InitiatorTaskTag = Session->InitiatorTaskTag;\r
- NewTcb->CmdSN = Session->CmdSN;\r
- NewTcb->Conn = Conn;\r
-\r
- InsertTailList (&Session->TcbList, &NewTcb->Link);\r
-\r
- //\r
- // Advance the initiator task tag.\r
- //\r
- Session->InitiatorTaskTag++;\r
- Session->CmdSN++;\r
-\r
- *Tcb = NewTcb;\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Delete the tcb from the connection and destroy it.\r
-\r
- @param[in] Tcb The tcb to delete.\r
-**/\r
-VOID\r
-IScsiDelTcb (\r
- IN ISCSI_TCB *Tcb\r
- )\r
-{\r
- RemoveEntryList (&Tcb->Link);\r
-\r
- FreePool (Tcb);\r
-}\r
-\r
-\r
-/**\r
- Create a data segment, pad it and calculate the CRC if needed.\r
-\r
- @param[in] Data The data to fill into the data segment.\r
- @param[in] Len Length of the data.\r
- @param[in] DataDigest Whether to calculate CRC for this data segment.\r
-\r
- @return The net buffer wrapping the data segment.\r
-**/\r
-NET_BUF *\r
-IScsiNewDataSegment (\r
- IN UINT8 *Data,\r
- IN UINT32 Len,\r
- IN BOOLEAN DataDigest\r
- )\r
-{\r
- NET_FRAGMENT Fragment[2];\r
- UINT32 FragmentCount;\r
- UINT32 PadLen;\r
- NET_BUF *DataSeg;\r
-\r
- Fragment[0].Len = Len;\r
- Fragment[0].Bulk = Data;\r
-\r
- PadLen = ISCSI_GET_PAD_LEN (Len);\r
- if (PadLen != 0) {\r
- Fragment[1].Len = PadLen;\r
- Fragment[1].Bulk = (UINT8 *) &mDataSegPad;\r
-\r
- FragmentCount = 2;\r
- } else {\r
- FragmentCount = 1;\r
- }\r
-\r
- DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);\r
-\r
- return DataSeg;\r
-}\r
-\r
-/**\r
- Create a iSCSI SCSI command PDU to encapsulate the command issued\r
- by SCSI through the EXT SCSI PASS THRU Protocol.\r
-\r
- @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.\r
- @param[in] Lun The LUN.\r
- @param[in] Tcb The tcb associated with this SCSI command.\r
-\r
- @return The created iSCSI SCSI command PDU.\r
- @retval NULL Other errors as indicated.\r
-**/\r
-NET_BUF *\r
-IScsiNewScsiCmdPdu (\r
- IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
- IN UINT64 Lun,\r
- IN ISCSI_TCB *Tcb\r
- )\r
-{\r
- LIST_ENTRY *NbufList;\r
- NET_BUF *Pdu;\r
- NET_BUF *PduHeader;\r
- NET_BUF *DataSeg;\r
- SCSI_COMMAND *ScsiCmd;\r
- UINT8 AHSLength;\r
- UINT32 Length;\r
- ISCSI_ADDITIONAL_HEADER *Header;\r
- ISCSI_BI_EXP_READ_DATA_LEN_AHS *BiExpReadDataLenAHS;\r
- ISCSI_SESSION *Session;\r
- UINT32 ImmediateDataLen;\r
-\r
- AHSLength = 0;\r
-\r
- if (Packet->DataDirection == DataBi) {\r
- //\r
- // Bi directional Read/Write command, the bidirectional expected\r
- // read data length AHS is required.\r
- //\r
- AHSLength += sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS);\r
- }\r
-\r
- if (Packet->CdbLength > 16) {\r
- //\r
- // The CDB exceeds 16 bytes, an extended CDB AHS is required.\r
- //\r
- AHSLength = (UINT8) (AHSLength + (ISCSI_ROUNDUP (Packet->CdbLength - 16) + sizeof (ISCSI_ADDITIONAL_HEADER)));\r
- }\r
-\r
- Length = sizeof (SCSI_COMMAND) + AHSLength;\r
- PduHeader = NetbufAlloc (Length);\r
- if (PduHeader == NULL) {\r
- return NULL;\r
- }\r
-\r
- ScsiCmd = (SCSI_COMMAND *) NetbufAllocSpace (PduHeader, Length, NET_BUF_TAIL);\r
- if (ScsiCmd == NULL) {\r
- NetbufFree (PduHeader);\r
- return NULL;\r
- }\r
- Header = (ISCSI_ADDITIONAL_HEADER *) (ScsiCmd + 1);\r
-\r
- ZeroMem (ScsiCmd, Length);\r
-\r
- ISCSI_SET_OPCODE (ScsiCmd, ISCSI_OPCODE_SCSI_CMD, 0);\r
- ISCSI_SET_FLAG (ScsiCmd, ISCSI_TASK_ATTR_SIMPLE);\r
-\r
- //\r
- // Set the READ/WRITE flags according to the IO type of this request.\r
- //\r
- switch (Packet->DataDirection) {\r
- case DataIn:\r
- ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ);\r
- ScsiCmd->ExpDataXferLength = NTOHL (Packet->InTransferLength);\r
- break;\r
-\r
- case DataOut:\r
- ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_WRITE);\r
- ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);\r
- break;\r
-\r
- case DataBi:\r
- ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ | SCSI_CMD_PDU_FLAG_WRITE);\r
- ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);\r
-\r
- //\r
- // Fill the bidirectional expected read data length AHS.\r
- //\r
- BiExpReadDataLenAHS = (ISCSI_BI_EXP_READ_DATA_LEN_AHS *) Header;\r
- Header = (ISCSI_ADDITIONAL_HEADER *) (BiExpReadDataLenAHS + 1);\r
-\r
- BiExpReadDataLenAHS->Length = NTOHS (5);\r
- BiExpReadDataLenAHS->Type = ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN;\r
- BiExpReadDataLenAHS->ExpReadDataLength = NTOHL (Packet->InTransferLength);\r
-\r
- break;\r
- }\r
-\r
- ScsiCmd->TotalAHSLength = AHSLength;\r
- CopyMem (ScsiCmd->Lun, &Lun, sizeof (ScsiCmd->Lun));\r
- ScsiCmd->InitiatorTaskTag = NTOHL (Tcb->InitiatorTaskTag);\r
- ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);\r
- ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);\r
-\r
- CopyMem (ScsiCmd->Cdb, Packet->Cdb, sizeof (ScsiCmd->Cdb));\r
-\r
- if (Packet->CdbLength > 16) {\r
- Header->Length = NTOHS ((UINT16) (Packet->CdbLength - 15));\r
- Header->Type = ISCSI_AHS_TYPE_EXT_CDB;\r
-\r
- CopyMem (Header + 1, (UINT8 *) Packet->Cdb + 16, Packet->CdbLength - 16);\r
- }\r
-\r
- Pdu = PduHeader;\r
- Session = Tcb->Conn->Session;\r
- ImmediateDataLen = 0;\r
-\r
- if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {\r
- //\r
- // Send immediate data in this SCSI Command PDU. The length of the immeidate\r
- // data is the minimum of FirstBurstLength, the data length to be xfered and\r
- // the MaxRecvdataSegmentLength on this connection.\r
- //\r
- ImmediateDataLen = MIN (Session->FirstBurstLength, Packet->OutTransferLength);\r
- ImmediateDataLen = MIN (ImmediateDataLen, Tcb->Conn->MaxRecvDataSegmentLength);\r
-\r
- //\r
- // Update the data segment length in the PDU header.\r
- //\r
- ISCSI_SET_DATASEG_LEN (ScsiCmd, ImmediateDataLen);\r
-\r
- //\r
- // Create the data segment.\r
- //\r
- DataSeg = IScsiNewDataSegment ((UINT8 *) Packet->OutDataBuffer, ImmediateDataLen, FALSE);\r
- if (DataSeg == NULL) {\r
- NetbufFree (PduHeader);\r
- Pdu = NULL;\r
- goto ON_EXIT;\r
- }\r
-\r
- NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
- if (NbufList == NULL) {\r
- NetbufFree (PduHeader);\r
- NetbufFree (DataSeg);\r
-\r
- Pdu = NULL;\r
- goto ON_EXIT;\r
- }\r
-\r
- InitializeListHead (NbufList);\r
- InsertTailList (NbufList, &PduHeader->List);\r
- InsertTailList (NbufList, &DataSeg->List);\r
-\r
- Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
- if (Pdu == NULL) {\r
- IScsiFreeNbufList (NbufList);\r
- }\r
- }\r
-\r
- if (Session->InitialR2T ||\r
- (ImmediateDataLen == Session->FirstBurstLength) ||\r
- (ImmediateDataLen == Packet->OutTransferLength)\r
- ) {\r
- //\r
- // Unsolicited data out sequence is not allowed,\r
- // or FirstBurstLength data is already sent out by immediate data\r
- // or all the OUT data accompany this SCSI packet is sent as\r
- // immediate data, the final flag should be set on this SCSI Command\r
- // PDU.\r
- //\r
- ISCSI_SET_FLAG (ScsiCmd, ISCSI_BHS_FLAG_FINAL);\r
- }\r
-\r
-ON_EXIT:\r
-\r
- return Pdu;\r
-}\r
-\r
-/**\r
- Create a new iSCSI SCSI Data Out PDU.\r
-\r
- @param[in] Data The data to put into the Data Out PDU.\r
- @param[in] Len Length of the data.\r
- @param[in] DataSN The DataSN of the Data Out PDU.\r
- @param[in] Tcb The task control block of this Data Out PDU.\r
- @param[in] Lun The LUN.\r
-\r
- @return The net buffer wrapping the Data Out PDU.\r
- @retval NULL Other errors as indicated.\r
-**/\r
-NET_BUF *\r
-IScsiNewDataOutPdu (\r
- IN UINT8 *Data,\r
- IN UINT32 Len,\r
- IN UINT32 DataSN,\r
- IN ISCSI_TCB *Tcb,\r
- IN UINT64 Lun\r
- )\r
-{\r
- LIST_ENTRY *NbufList;\r
- NET_BUF *PduHdr;\r
- NET_BUF *DataSeg;\r
- NET_BUF *Pdu;\r
- ISCSI_SCSI_DATA_OUT *DataOutHdr;\r
- ISCSI_XFER_CONTEXT *XferContext;\r
-\r
- NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
- if (NbufList == NULL) {\r
- return NULL;\r
- }\r
-\r
- InitializeListHead (NbufList);\r
-\r
- //\r
- // Allocate memory for the BHS.\r
- //\r
- PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));\r
- if (PduHdr == NULL) {\r
- FreePool (NbufList);\r
- return NULL;\r
- }\r
- //\r
- // Insert the BHS into the buffer list.\r
- //\r
- InsertTailList (NbufList, &PduHdr->List);\r
-\r
- DataOutHdr = (ISCSI_SCSI_DATA_OUT *) NetbufAllocSpace (PduHdr, sizeof (ISCSI_SCSI_DATA_OUT), NET_BUF_TAIL);\r
- ASSERT (DataOutHdr != NULL);\r
- XferContext = &Tcb->XferContext;\r
-\r
- ZeroMem (DataOutHdr, sizeof (ISCSI_SCSI_DATA_OUT));\r
-\r
- //\r
- // Set the flags and fields of the Data Out PDU BHS.\r
- //\r
- ISCSI_SET_OPCODE (DataOutHdr, ISCSI_OPCODE_SCSI_DATA_OUT, 0);\r
- ISCSI_SET_DATASEG_LEN (DataOutHdr, Len);\r
-\r
- DataOutHdr->InitiatorTaskTag = HTONL (Tcb->InitiatorTaskTag);\r
- DataOutHdr->TargetTransferTag = HTONL (XferContext->TargetTransferTag);\r
- DataOutHdr->ExpStatSN = HTONL (Tcb->Conn->ExpStatSN);\r
- DataOutHdr->DataSN = HTONL (DataSN);\r
- DataOutHdr->BufferOffset = HTONL (XferContext->Offset);\r
-\r
- if (XferContext->TargetTransferTag != ISCSI_RESERVED_TAG) {\r
- CopyMem (&DataOutHdr->Lun, &Lun, sizeof (DataOutHdr->Lun));\r
- }\r
- //\r
- // Build the data segment for this Data Out PDU.\r
- //\r
- DataSeg = IScsiNewDataSegment (Data, Len, FALSE);\r
- if (DataSeg == NULL) {\r
- IScsiFreeNbufList (NbufList);\r
- return NULL;\r
- }\r
- //\r
- // Put the data segment into the buffer list and combine it with the BHS\r
- // into a full Data Out PDU.\r
- //\r
- InsertTailList (NbufList, &DataSeg->List);\r
- Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
- if (Pdu == NULL) {\r
- IScsiFreeNbufList (NbufList);\r
- }\r
-\r
- return Pdu;\r
-}\r
-\r
-/**\r
- Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.\r
-\r
- @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.\r
- @param[in] Tcb The task control block of the data to send out.\r
- @param[in] Lun The LUN the data will be sent to.\r
-\r
- @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.\r
- @retval NULL Other errors as indicated.\r
-**/\r
-LIST_ENTRY *\r
-IScsiGenerateDataOutPduSequence (\r
- IN UINT8 *Data,\r
- IN ISCSI_TCB *Tcb,\r
- IN UINT64 Lun\r
- )\r
-{\r
- LIST_ENTRY *PduList;\r
- UINT32 DataSN;\r
- UINT32 DataLen;\r
- NET_BUF *DataOutPdu;\r
- ISCSI_CONNECTION *Conn;\r
- ISCSI_XFER_CONTEXT *XferContext;\r
- UINT8 *DataOutPacket;\r
-\r
- PduList = AllocatePool (sizeof (LIST_ENTRY));\r
- if (PduList == NULL) {\r
- return NULL;\r
- }\r
-\r
- InitializeListHead (PduList);\r
-\r
- DataSN = 0;\r
- Conn = Tcb->Conn;\r
- DataOutPdu = NULL;\r
- XferContext = &Tcb->XferContext;\r
-\r
- while (XferContext->DesiredLength > 0) {\r
- //\r
- // Determine the length of data this Data Out PDU can carry.\r
- //\r
- DataLen = MIN (XferContext->DesiredLength, Conn->MaxRecvDataSegmentLength);\r
-\r
- //\r
- // Create a Data Out PDU.\r
- //\r
- DataOutPdu = IScsiNewDataOutPdu (Data, DataLen, DataSN, Tcb, Lun);\r
- if (DataOutPdu == NULL) {\r
- IScsiFreeNbufList (PduList);\r
- PduList = NULL;\r
-\r
- goto ON_EXIT;\r
- }\r
-\r
- InsertTailList (PduList, &DataOutPdu->List);\r
-\r
- //\r
- // Update the context and DataSN.\r
- //\r
- XferContext->Offset += DataLen;\r
- XferContext->DesiredLength -= DataLen;\r
- DataSN++;\r
- Data += DataLen;\r
- }\r
- //\r
- // Set the F bit for the last data out PDU in this sequence.\r
- //\r
- DataOutPacket = NetbufGetByte (DataOutPdu, 0, NULL);\r
- if (DataOutPacket == NULL) {\r
- IScsiFreeNbufList (PduList);\r
- PduList = NULL;\r
- goto ON_EXIT;\r
- }\r
-\r
- ISCSI_SET_FLAG (DataOutPacket, ISCSI_BHS_FLAG_FINAL);\r
-\r
-ON_EXIT:\r
-\r
- return PduList;\r
-}\r
-\r
-/**\r
- Send the Data in a sequence of Data Out PDUs one by one.\r
-\r
- @param[in] Data The data to carry by Data Out PDUs.\r
- @param[in] Lun The LUN the data will be sent to.\r
- @param[in] Tcb The task control block.\r
-\r
- @retval EFI_SUCCES The data is sent out to the LUN.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiSendDataOutPduSequence (\r
- IN UINT8 *Data,\r
- IN UINT64 Lun,\r
- IN ISCSI_TCB *Tcb\r
- )\r
-{\r
- LIST_ENTRY *DataOutPduList;\r
- LIST_ENTRY *Entry;\r
- NET_BUF *Pdu;\r
- EFI_STATUS Status;\r
-\r
- //\r
- // Generate the Data Out PDU sequence.\r
- //\r
- DataOutPduList = IScsiGenerateDataOutPduSequence (Data, Tcb, Lun);\r
- if (DataOutPduList == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- Status = EFI_SUCCESS;\r
-\r
- //\r
- // Send the Data Out PDU's one by one.\r
- //\r
- NET_LIST_FOR_EACH (Entry, DataOutPduList) {\r
- Pdu = NET_LIST_USER_STRUCT (Entry, NET_BUF, List);\r
-\r
- Status = Tcp4IoTransmit (&Tcb->Conn->Tcp4Io, Pdu);\r
- if (EFI_ERROR (Status)) {\r
- break;\r
- }\r
- }\r
-\r
- IScsiFreeNbufList (DataOutPduList);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Process the received iSCSI SCSI Data In PDU.\r
-\r
- @param[in] Pdu The Data In PDU received.\r
- @param[in] Tcb The task control block.\r
- @param[in, out] Packet The EXT SCSI PASS THRU request packet.\r
-\r
- @retval EFI_SUCCES The check on the Data IN PDU is passed and some update\r
- actions are taken.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
- @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiOnDataInRcvd (\r
- IN NET_BUF *Pdu,\r
- IN ISCSI_TCB *Tcb,\r
- IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
- )\r
-{\r
- ISCSI_SCSI_DATA_IN *DataInHdr;\r
- EFI_STATUS Status;\r
-\r
- DataInHdr = (ISCSI_SCSI_DATA_IN *) NetbufGetByte (Pdu, 0, NULL);\r
- if (DataInHdr == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- DataInHdr->InitiatorTaskTag = NTOHL (DataInHdr->InitiatorTaskTag);\r
- DataInHdr->ExpCmdSN = NTOHL (DataInHdr->ExpCmdSN);\r
- DataInHdr->MaxCmdSN = NTOHL (DataInHdr->MaxCmdSN);\r
- DataInHdr->DataSN = NTOHL (DataInHdr->DataSN);\r
-\r
- //\r
- // Check the DataSN.\r
- //\r
- Status = IScsiCheckSN (&Tcb->ExpDataSN, DataInHdr->DataSN);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- if (DataInHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- //\r
- // Update the command related sequence numbers.\r
- //\r
- IScsiUpdateCmdSN (Tcb->Conn->Session, DataInHdr->MaxCmdSN, DataInHdr->ExpCmdSN);\r
-\r
- if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID)) {\r
- if (!ISCSI_FLAG_ON (DataInHdr, ISCSI_BHS_FLAG_FINAL)) {\r
- //\r
- // The S bit is on but the F bit is off.\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- Tcb->StatusXferd = TRUE;\r
-\r
- if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_OVERFLOW | SCSI_DATA_IN_PDU_FLAG_UNDERFLOW)) {\r
- //\r
- // Underflow and Overflow are mutual flags.\r
- //\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- //\r
- // S bit is on, the StatSN is valid.\r
- //\r
- Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NTOHL (DataInHdr->StatSN));\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Packet->HostAdapterStatus = 0;\r
- Packet->TargetStatus = DataInHdr->Status;\r
-\r
- if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {\r
- Packet->InTransferLength += NTOHL (DataInHdr->ResidualCount);\r
- Status = EFI_BAD_BUFFER_SIZE;\r
- }\r
-\r
- if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {\r
- Packet->InTransferLength -= NTOHL (DataInHdr->ResidualCount);\r
- }\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Process the received iSCSI R2T PDU.\r
-\r
- @param[in] Pdu The R2T PDU received.\r
- @param[in] Tcb The task control block.\r
- @param[in] Lun The Lun.\r
- @param[in, out] Packet The EXT SCSI PASS THRU request packet.\r
-\r
- @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiOnR2TRcvd (\r
- IN NET_BUF *Pdu,\r
- IN ISCSI_TCB *Tcb,\r
- IN UINT64 Lun,\r
- IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
- )\r
-{\r
- ISCSI_READY_TO_TRANSFER *R2THdr;\r
- EFI_STATUS Status;\r
- ISCSI_XFER_CONTEXT *XferContext;\r
- UINT8 *Data;\r
-\r
- R2THdr = (ISCSI_READY_TO_TRANSFER *) NetbufGetByte (Pdu, 0, NULL);\r
- if (R2THdr == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);\r
- R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);\r
- R2THdr->StatSN = NTOHL (R2THdr->StatSN);\r
- R2THdr->R2TSeqNum = NTOHL (R2THdr->R2TSeqNum);\r
- R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);\r
- R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);\r
-\r
- if ((R2THdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) || !ISCSI_SEQ_EQ (R2THdr->StatSN, Tcb->Conn->ExpStatSN)) {\r
- return EFI_PROTOCOL_ERROR;;\r
- }\r
- //\r
- // Check the sequence number.\r
- //\r
- Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSeqNum);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- XferContext = &Tcb->XferContext;\r
- XferContext->TargetTransferTag = R2THdr->TargetTransferTag;\r
- XferContext->Offset = R2THdr->BufferOffset;\r
- XferContext->DesiredLength = R2THdr->DesiredDataTransferLength;\r
-\r
- if (((XferContext->Offset + XferContext->DesiredLength) > Packet->OutTransferLength) ||\r
- (XferContext->DesiredLength > Tcb->Conn->Session->MaxBurstLength)\r
- ) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- //\r
- // Send the data solicited by this R2T.\r
- //\r
- Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;\r
- Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Process the received iSCSI SCSI Response PDU.\r
-\r
- @param[in] Pdu The Response PDU received.\r
- @param[in] Tcb The task control block.\r
- @param[in, out] Packet The EXT SCSI PASS THRU request packet.\r
-\r
- @retval EFI_SUCCES The Response PDU is processed.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
- @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiOnScsiRspRcvd (\r
- IN NET_BUF *Pdu,\r
- IN ISCSI_TCB *Tcb,\r
- IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
- )\r
-{\r
- SCSI_RESPONSE *ScsiRspHdr;\r
- ISCSI_SENSE_DATA *SenseData;\r
- EFI_STATUS Status;\r
- UINT32 DataSegLen;\r
-\r
- ScsiRspHdr = (SCSI_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);\r
- if (ScsiRspHdr == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- ScsiRspHdr->InitiatorTaskTag = NTOHL (ScsiRspHdr->InitiatorTaskTag);\r
- if (ScsiRspHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- ScsiRspHdr->StatSN = NTOHL (ScsiRspHdr->StatSN);\r
-\r
- Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, ScsiRspHdr->StatSN);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- ScsiRspHdr->MaxCmdSN = NTOHL (ScsiRspHdr->MaxCmdSN);\r
- ScsiRspHdr->ExpCmdSN = NTOHL (ScsiRspHdr->ExpCmdSN);\r
- IScsiUpdateCmdSN (Tcb->Conn->Session, ScsiRspHdr->MaxCmdSN, ScsiRspHdr->ExpCmdSN);\r
-\r
- Tcb->StatusXferd = TRUE;\r
-\r
- Packet->HostAdapterStatus = ScsiRspHdr->Response;\r
- if (Packet->HostAdapterStatus != ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- Packet->TargetStatus = ScsiRspHdr->Status;\r
-\r
- if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW | SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW) ||\r
- ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW | SCSI_RSP_PDU_FLAG_UNDERFLOW)\r
- ) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW)) {\r
- Packet->InTransferLength += NTOHL (ScsiRspHdr->BiReadResidualCount);\r
- Status = EFI_BAD_BUFFER_SIZE;\r
- }\r
-\r
- if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW)) {\r
- Packet->InTransferLength -= NTOHL (ScsiRspHdr->BiReadResidualCount);\r
- }\r
-\r
- if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {\r
- if (Packet->DataDirection == DataIn) {\r
- Packet->InTransferLength += NTOHL (ScsiRspHdr->ResidualCount);\r
- } else {\r
- Packet->OutTransferLength += NTOHL (ScsiRspHdr->ResidualCount);\r
- }\r
-\r
- Status = EFI_BAD_BUFFER_SIZE;\r
- }\r
-\r
- if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {\r
- if (Packet->DataDirection == DataIn) {\r
- Packet->InTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);\r
- } else {\r
- Packet->OutTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);\r
- }\r
- }\r
-\r
- DataSegLen = ISCSI_GET_DATASEG_LEN (ScsiRspHdr);\r
- if (DataSegLen != 0) {\r
- SenseData = (ISCSI_SENSE_DATA *) NetbufGetByte (Pdu, sizeof (SCSI_RESPONSE), NULL);\r
- if (SenseData == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- SenseData->Length = NTOHS (SenseData->Length);\r
-\r
- Packet->SenseDataLength = (UINT8) MIN (SenseData->Length, Packet->SenseDataLength);\r
- if (Packet->SenseDataLength != 0) {\r
- CopyMem (Packet->SenseData, &SenseData->Data[0], Packet->SenseDataLength);\r
- }\r
- } else {\r
- Packet->SenseDataLength = 0;\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Process the received NOP In PDU.\r
-\r
- @param[in] Pdu The NOP In PDU received.\r
- @param[in] Tcb The task control block.\r
-\r
- @retval EFI_SUCCES The NOP In PDU is processed and the related sequence\r
- numbers are updated.\r
- @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
-**/\r
-EFI_STATUS\r
-IScsiOnNopInRcvd (\r
- IN NET_BUF *Pdu,\r
- IN ISCSI_TCB *Tcb\r
- )\r
-{\r
- ISCSI_NOP_IN *NopInHdr;\r
- EFI_STATUS Status;\r
-\r
- NopInHdr = (ISCSI_NOP_IN *) NetbufGetByte (Pdu, 0, NULL);\r
- if (NopInHdr == NULL) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
-\r
- NopInHdr->StatSN = NTOHL (NopInHdr->StatSN);\r
- NopInHdr->ExpCmdSN = NTOHL (NopInHdr->ExpCmdSN);\r
- NopInHdr->MaxCmdSN = NTOHL (NopInHdr->MaxCmdSN);\r
-\r
- if (NopInHdr->InitiatorTaskTag == ISCSI_RESERVED_TAG) {\r
- if (NopInHdr->StatSN != Tcb->Conn->ExpStatSN) {\r
- return EFI_PROTOCOL_ERROR;\r
- }\r
- } else {\r
- Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NopInHdr->StatSN);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- }\r
-\r
- IScsiUpdateCmdSN (Tcb->Conn->Session, NopInHdr->MaxCmdSN, NopInHdr->ExpCmdSN);\r
-\r
- return EFI_SUCCESS;\r
-}\r
-\r
-/**\r
- Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.\r
-\r
- @param[in] PassThru The EXT SCSI PASS THRU protocol.\r
- @param[in] Target The target ID.\r
- @param[in] Lun The LUN.\r
- @param[in, out] Packet The request packet containing IO request, SCSI command\r
- buffer and buffers to read/write.\r
-\r
- @retval EFI_SUCCES The SCSI command is executed and the result is updated to\r
- the Packet.\r
- @retval EFI_DEVICE_ERROR Session state was not as required.\r
- @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval EFI_NOT_READY The target can not accept new commands.\r
- @retval Others Other errors as indicated.\r
-**/\r
-EFI_STATUS\r
-IScsiExecuteScsiCommand (\r
- IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,\r
- IN UINT8 *Target,\r
- IN UINT64 Lun,\r
- IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
- )\r
-{\r
- EFI_STATUS Status;\r
- ISCSI_DRIVER_DATA *Private;\r
- ISCSI_SESSION *Session;\r
- EFI_EVENT TimeoutEvent;\r
- ISCSI_CONNECTION *Conn;\r
- ISCSI_TCB *Tcb;\r
- NET_BUF *Pdu;\r
- ISCSI_XFER_CONTEXT *XferContext;\r
- UINT8 *Data;\r
- ISCSI_IN_BUFFER_CONTEXT InBufferContext;\r
- UINT64 Timeout;\r
- UINT8 *PduHdr;\r
-\r
- Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);\r
- Session = &Private->Session;\r
- Status = EFI_SUCCESS;\r
- Tcb = NULL;\r
- TimeoutEvent = NULL;\r
- Timeout = 0;\r
-\r
- if (Session->State != SESSION_STATE_LOGGED_IN) {\r
- Status = EFI_DEVICE_ERROR;\r
- goto ON_EXIT;\r
- }\r
-\r
- Conn = NET_LIST_USER_STRUCT_S (\r
- Session->Conns.ForwardLink,\r
- ISCSI_CONNECTION,\r
- Link,\r
- ISCSI_CONNECTION_SIGNATURE\r
- );\r
-\r
- if (Packet->Timeout != 0) {\r
- Timeout = MultU64x32 (Packet->Timeout, 2);\r
- }\r
-\r
- Status = IScsiNewTcb (Conn, &Tcb);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
- //\r
- // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.\r
- //\r
- Pdu = IScsiNewScsiCmdPdu (Packet, Lun, Tcb);\r
- if (Pdu == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto ON_EXIT;\r
- }\r
-\r
- XferContext = &Tcb->XferContext;\r
- PduHdr = NetbufGetByte (Pdu, 0, NULL);\r
- if (PduHdr == NULL) {\r
- Status = EFI_PROTOCOL_ERROR;\r
- NetbufFree (Pdu);\r
- goto ON_EXIT;\r
- }\r
- XferContext->Offset = ISCSI_GET_DATASEG_LEN (PduHdr);\r
-\r
- //\r
- // Transmit the SCSI Command PDU.\r
- //\r
- Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);\r
-\r
- NetbufFree (Pdu);\r
-\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
-\r
- if (!Session->InitialR2T &&\r
- (XferContext->Offset < Session->FirstBurstLength) &&\r
- (XferContext->Offset < Packet->OutTransferLength)\r
- ) {\r
- //\r
- // Unsolicited Data-Out sequence is allowed, there is remaining SCSI\r
- // OUT data and the limit of FirstBurstLength is not reached.\r
- //\r
- XferContext->TargetTransferTag = ISCSI_RESERVED_TAG;\r
- XferContext->DesiredLength = MIN (\r
- Session->FirstBurstLength,\r
- Packet->OutTransferLength - XferContext->Offset\r
- );\r
-\r
- Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;\r
- Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
- }\r
-\r
- InBufferContext.InData = (UINT8 *) Packet->InDataBuffer;\r
- InBufferContext.InDataLen = Packet->InTransferLength;\r
-\r
- while (!Tcb->StatusXferd) {\r
- //\r
- // Start the timeout timer.\r
- //\r
- if (Timeout != 0) {\r
- Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, Timeout);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
- TimeoutEvent = Conn->TimeoutEvent;\r
- }\r
- //\r
- // try to receive PDU from target.\r
- //\r
- Status = IScsiReceivePdu (Conn, &Pdu, &InBufferContext, FALSE, FALSE, TimeoutEvent);\r
- if (EFI_ERROR (Status)) {\r
- goto ON_EXIT;\r
- }\r
-\r
- PduHdr = NetbufGetByte (Pdu, 0, NULL);\r
- if (PduHdr == NULL) {\r
- Status = EFI_PROTOCOL_ERROR;\r
- NetbufFree (Pdu);\r
- goto ON_EXIT;\r
- }\r
- switch (ISCSI_GET_OPCODE (PduHdr)) {\r
- case ISCSI_OPCODE_SCSI_DATA_IN:\r
- Status = IScsiOnDataInRcvd (Pdu, Tcb, Packet);\r
- break;\r
-\r
- case ISCSI_OPCODE_R2T:\r
- Status = IScsiOnR2TRcvd (Pdu, Tcb, Lun, Packet);\r
- break;\r
-\r
- case ISCSI_OPCODE_SCSI_RSP:\r
- Status = IScsiOnScsiRspRcvd (Pdu, Tcb, Packet);\r
- break;\r
-\r
- case ISCSI_OPCODE_NOP_IN:\r
- Status = IScsiOnNopInRcvd (Pdu, Tcb);\r
- break;\r
-\r
- case ISCSI_OPCODE_VENDOR_T0:\r
- case ISCSI_OPCODE_VENDOR_T1:\r
- case ISCSI_OPCODE_VENDOR_T2:\r
- //\r
- // These messages are vendor specific, skip them.\r
- //\r
- break;\r
-\r
- default:\r
- Status = EFI_PROTOCOL_ERROR;\r
- break;\r
- }\r
-\r
- NetbufFree (Pdu);\r
-\r
- if (EFI_ERROR (Status)) {\r
- break;\r
- }\r
- }\r
-\r
-ON_EXIT:\r
-\r
- if (TimeoutEvent != NULL) {\r
- gBS->SetTimer (TimeoutEvent, TimerCancel, 0);\r
- }\r
-\r
- if (Tcb != NULL) {\r
- IScsiDelTcb (Tcb);\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Reinstate the session on some error.\r
-\r
- @param[in, out] Private The iSCSI driver data.\r
-\r
- @retval EFI_SUCCES The session is reinstated from some error.\r
- @retval Other Reinstatement failed.\r
-**/\r
-EFI_STATUS\r
-IScsiSessionReinstatement (\r
- IN OUT ISCSI_DRIVER_DATA *Private\r
- )\r
-{\r
- ISCSI_SESSION *Session;\r
- EFI_STATUS Status;\r
-\r
- Session = &Private->Session;\r
- ASSERT (Session->State != SESSION_STATE_FREE);\r
-\r
- //\r
- // Abort the session and re-init it.\r
- //\r
- IScsiSessionAbort (Session);\r
- IScsiSessionInit (Session, TRUE);\r
-\r
- //\r
- // Login again.\r
- //\r
- Status = IScsiSessionLogin (Private);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Initialize some session parameters before login.\r
-\r
- @param[in, out] Session The iSCSI session.\r
- @param[in] Recovery Whether the request is from a fresh new start or recovery.\r
-**/\r
-VOID\r
-IScsiSessionInit (\r
- IN OUT ISCSI_SESSION *Session,\r
- IN BOOLEAN Recovery\r
- )\r
-{\r
- if (!Recovery) {\r
- Session->Signature = ISCSI_SESSION_SIGNATURE;\r
- Session->State = SESSION_STATE_FREE;\r
-\r
- InitializeListHead (&Session->Conns);\r
- InitializeListHead (&Session->TcbList);\r
- }\r
-\r
- Session->Tsih = 0;\r
-\r
- Session->CmdSN = 1;\r
- Session->InitiatorTaskTag = 1;\r
- Session->NextCid = 1;\r
-\r
- Session->TargetPortalGroupTag = 0;\r
- Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;\r
- Session->InitialR2T = FALSE;\r
- Session->ImmediateData = TRUE;\r
- Session->MaxBurstLength = 262144;\r
- Session->FirstBurstLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;\r
- Session->DefaultTime2Wait = 2;\r
- Session->DefaultTime2Retain = 20;\r
- Session->MaxOutstandingR2T = DEFAULT_MAX_OUTSTANDING_R2T;\r
- Session->DataPDUInOrder = TRUE;\r
- Session->DataSequenceInOrder = TRUE;\r
- Session->ErrorRecoveryLevel = 0;\r
-}\r
-\r
-/**\r
- Abort the iSCSI session, that is, reset all the connection and free the\r
- resources.\r
-\r
- @param[in, out] Session The iSCSI session.\r
-\r
- @retval EFI_SUCCES The session is aborted.\r
-**/\r
-EFI_STATUS\r
-IScsiSessionAbort (\r
- IN OUT ISCSI_SESSION *Session\r
- )\r
-{\r
- ISCSI_DRIVER_DATA *Private;\r
- ISCSI_CONNECTION *Conn;\r
-\r
- if (Session->State != SESSION_STATE_LOGGED_IN) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- ASSERT (!IsListEmpty (&Session->Conns));\r
-\r
- Private = ISCSI_DRIVER_DATA_FROM_SESSION (Session);\r
-\r
- while (!IsListEmpty (&Session->Conns)) {\r
- Conn = NET_LIST_USER_STRUCT_S (\r
- Session->Conns.ForwardLink,\r
- ISCSI_CONNECTION,\r
- Link,\r
- ISCSI_CONNECTION_SIGNATURE\r
- );\r
-\r
- gBS->CloseProtocol (\r
- Conn->Tcp4Io.Handle,\r
- &gEfiTcp4ProtocolGuid,\r
- Private->Image,\r
- Private->ExtScsiPassThruHandle\r
- );\r
-\r
- IScsiConnReset (Conn);\r
-\r
- IScsiDetatchConnection (Conn);\r
- IScsiDestroyConnection (Conn);\r
- }\r
-\r
- Session->State = SESSION_STATE_FAILED;\r
-\r
- return EFI_SUCCESS;\r
-}\r
projects / mirror_edk2.git / blobdiff