/** @file\r
- The implementation of IScsi protocol based on RFC3720.\r
+ The implementation of iSCSI protocol based on RFC3720.\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2010, 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
Attach the iSCSI connection to the iSCSI session. \r
\r
- @param[in] Session The iSCSI session.\r
- @param[in] Conn The iSCSI connection.\r
+ @param[in, out] Session The iSCSI session.\r
+ @param[in, out] Conn The iSCSI connection.\r
**/\r
VOID\r
IScsiAttatchConnection (\r
- IN ISCSI_SESSION *Session,\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_SESSION *Session,\r
+ IN OUT ISCSI_CONNECTION *Conn\r
)\r
{\r
InsertTailList (&Session->Conns, &Conn->Link);\r
/**\r
Detach the iSCSI connection from the session it belongs to. \r
\r
- @param[in] Conn The iSCSI connection.\r
+ @param[in, out] Conn The iSCSI connection.\r
**/\r
VOID\r
IScsiDetatchConnection (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
)\r
{\r
RemoveEntryList (&Conn->Link);\r
/**\r
Check the sequence number according to RFC3720. \r
\r
- @param[in] ExpSN The currently expected sequence number.\r
- @param[in] NewSN The sequence number to check.\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
**/\r
EFI_STATUS\r
IScsiCheckSN (\r
- IN UINT32 *ExpSN,\r
- IN UINT32 NewSN\r
+ IN OUT UINT32 *ExpSN,\r
+ IN UINT32 NewSN\r
)\r
{\r
if (!ISCSI_SEQ_EQ (NewSN, *ExpSN)) {\r
/**\r
Update the sequence numbers for the iSCSI command.\r
\r
- @param[in] Session The iSCSI session.\r
- @param[in] MaxCmdSN Maximum CmdSN from the target.\r
- @param[in] ExpCmdSN Next expected CmdSN from the target.\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 ISCSI_SESSION *Session,\r
- IN UINT32 MaxCmdSN,\r
- IN UINT32 ExpCmdSN\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
/**\r
This function does the iSCSI connection login.\r
\r
- @param[in] Conn The iSCSI connection to login.\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 Some unexpected error happened. \r
+ @retval Others Other errors as indicated. \r
**/\r
EFI_STATUS\r
IScsiConnLogin (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
)\r
{\r
EFI_STATUS Status;\r
/**\r
Reset the iSCSI connection.\r
\r
- @param[in] Conn The iSCSI connection to reset.\r
+ @param[in, out] Conn The iSCSI connection to reset.\r
**/\r
VOID\r
IScsiConnReset (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
)\r
{\r
Tcp4IoReset (&Conn->Tcp4Io);\r
Conn->ExpStatSN = 0;\r
Conn->PartialReqSent = FALSE;\r
Conn->PartialRspRcvd = FALSE;\r
- Conn->CID = Session->NextCID++;\r
+ Conn->Cid = Session->NextCid++;\r
\r
Status = gBS->CreateEvent (\r
EVT_TIMER,\r
&Conn->TimeoutEvent\r
);\r
if (EFI_ERROR (Status)) {\r
- gBS->FreePool (Conn);\r
+ FreePool (Conn);\r
return NULL;\r
}\r
\r
//\r
// set the default connection-only parameters\r
//\r
- Conn->MaxRecvDataSegmentLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;\r
- Conn->HeaderDigest = ISCSI_DIGEST_NONE;\r
- Conn->DataDigest = ISCSI_DIGEST_NONE;\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
);\r
if (EFI_ERROR (Status)) {\r
gBS->CloseEvent (Conn->TimeoutEvent);\r
- gBS->FreePool (Conn);\r
+ FreePool (Conn);\r
Conn = NULL;\r
}\r
\r
Tcp4IoDestroySocket (&Conn->Tcp4Io);\r
NetbufQueFlush (&Conn->RspQue);\r
gBS->CloseEvent (Conn->TimeoutEvent);\r
- gBS->FreePool (Conn);\r
+ FreePool (Conn);\r
}\r
\r
/**\r
\r
@retval EFI_SUCCESS The iSCSI session login procedure finished.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval Others Some unexpected error happened.\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
ISCSI_SESSION *Session;\r
ISCSI_CONNECTION *Conn;\r
EFI_TCP4_PROTOCOL *Tcp4;\r
+ BOOLEAN MediaPresent;\r
\r
Session = &Private->Session;\r
\r
+ //\r
+ // Check media status before session login\r
+ //\r
+ MediaPresent = TRUE;\r
+ NetLibDetectMedia (Private->Controller, &MediaPresent);\r
+ if (!MediaPresent) {\r
+ return EFI_NO_MEDIA;\r
+ }\r
+\r
//\r
// Create a connection for the session.\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiReceiveLoginRsp (\r
The DataSegmentLength and the actual size of the net buffer containing this PDU will be\r
updated.\r
\r
- @param[in] Pdu The iSCSI PDU whose data segment the key-value pair will\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
+ @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
**/\r
EFI_STATUS\r
IScsiAddKeyValuePair (\r
- IN NET_BUF *Pdu,\r
+ IN OUT NET_BUF *Pdu,\r
IN CHAR8 *Key,\r
IN CHAR8 *Value\r
)\r
/**\r
Prepare the iSCSI login request to be sent according to the current login status.\r
\r
- @param[in] Conn The connection in the iSCSI login phase.\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
NET_BUF *\r
IScsiPrepareLoginReq (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
)\r
{\r
ISCSI_SESSION *Session;\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
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->Tsih = HTONS (Session->Tsih);\r
LoginReq->InitiatorTaskTag = HTONL (Session->InitiatorTaskTag);\r
- LoginReq->CID = HTONS (Conn->CID);\r
+ LoginReq->Cid = HTONS (Conn->Cid);\r
LoginReq->CmdSN = HTONL (Session->CmdSN);\r
\r
//\r
// with their increasing StatSN values.\r
//\r
LoginReq->ExpStatSN = HTONL (Conn->ExpStatSN);\r
- CopyMem (LoginReq->ISID, Session->ISID, sizeof (LoginReq->ISID));\r
+ CopyMem (LoginReq->Isid, Session->Isid, sizeof (LoginReq->Isid));\r
\r
if (Conn->PartialRspRcvd) {\r
//\r
/**\r
Process the iSCSI Login Response.\r
\r
- @param[in] Conn The connection on which the iSCSI login response is received.\r
- @param[in] Pdu The iSCSI login response PDU.\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiProcessLoginRsp (\r
- IN ISCSI_CONNECTION *Conn,\r
- IN NET_BUF *Pdu\r
+ IN OUT ISCSI_CONNECTION *Conn,\r
+ IN OUT NET_BUF *Pdu\r
)\r
{\r
EFI_STATUS Status;\r
(CurrentStage != Conn->CurrentStage) ||\r
(!Conn->TransitInitiated && Transit) ||\r
(Transit && (NextStage != Conn->NextStage)) ||\r
- (CompareMem (Session->ISID, LoginRsp->ISID, sizeof (LoginRsp->ISID)) != 0) ||\r
+ (CompareMem (Session->Isid, LoginRsp->Isid, sizeof (LoginRsp->Isid)) != 0) ||\r
(LoginRsp->InitiatorTaskTag != Session->InitiatorTaskTag)\r
) {\r
//\r
//\r
// In security negotiation stage, let CHAP module handle it.\r
//\r
- Status = IScsiCHAPOnRspReceived (Conn, Transit);\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, Transit);\r
+ Status = IScsiCheckOpParams (Conn);\r
break;\r
\r
default:\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
+ Session->Tsih = NTOHS (LoginRsp->Tsih);\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] 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
+ @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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiUpdateTargetAddress (\r
- IN ISCSI_SESSION *Session,\r
- IN CHAR8 *Data,\r
- IN UINT32 Len\r
+ IN OUT ISCSI_SESSION *Session,\r
+ IN CHAR8 *Data,\r
+ IN UINT32 Len\r
)\r
{\r
LIST_ENTRY *KeyValueList;\r
@param[in] Arg The opaque parameter.\r
**/\r
VOID\r
+EFIAPI\r
IScsiFreeNbufList (\r
VOID *Arg\r
)\r
ASSERT (Arg != NULL);\r
\r
NetbufFreeList ((LIST_ENTRY *) Arg);\r
- gBS->FreePool (Arg);\r
+ FreePool (Arg);\r
}\r
\r
/**\r
@param[in] Arg The opaque parameter.\r
**/\r
VOID\r
+EFIAPI\r
IScsiNbufExtFree (\r
VOID *Arg\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiReceivePdu (\r
NET_BUF *DataSeg;\r
UINT32 PadAndCRC32[2];\r
\r
- NbufList = AllocatePool (sizeof (LIST_ENTRY ));\r
+ NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
if (NbufList == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
Len = sizeof (ISCSI_BASIC_HEADER) + (HeaderDigest ? sizeof (UINT32) : 0);\r
PduHdr = NetbufAlloc (Len);\r
if (PduHdr == NULL) {\r
- Status = EFI_OUT_OF_RESOURCES;\r
- goto ON_EXIT;\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
Len = ISCSI_GET_DATASEG_LEN (Header);\r
if (Len == 0) {\r
//\r
- // No data segment.\r
+ // No data segment.Form the pdu from a list of pdu segments.\r
//\r
- goto FORM_PDU;\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
// 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 *) ((UINTN) &PadAndCRC32[1] - PadLen);\r
-\r
+ Fragment[1].Bulk = (UINT8 *)PadAndCRC32 + (4 - PadLen);\r
FragmentCount = 2;\r
} else {\r
FragmentCount = 1;\r
NetbufTrim (DataSeg, PadLen, NET_BUF_TAIL);\r
}\r
\r
-FORM_PDU:\r
//\r
// Form the pdu from a list of pdu segments.\r
//\r
/**\r
Check and get the result of the prameter negotiation.\r
\r
- @param[in] Conn The connection in iSCSI login.\r
- @param[in] Transit Whether need transit.\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
**/\r
EFI_STATUS\r
IScsiCheckOpParams (\r
- IN ISCSI_CONNECTION *Conn,\r
- IN BOOLEAN Transit\r
+ IN OUT ISCSI_CONNECTION *Conn\r
)\r
{\r
EFI_STATUS Status;\r
//\r
KeyValueList = IScsiBuildKeyValueList (Data, Len);\r
if (KeyValueList == NULL) {\r
- gBS->FreePool (Data);\r
+ FreePool (Data);\r
return Status;\r
}\r
//\r
}\r
\r
if (AsciiStrCmp (Value, "CRC32") == 0) {\r
- if (Conn->HeaderDigest != ISCSI_DIGEST_CRC32) {\r
+ if (Conn->HeaderDigest != IScsiDigestCRC32) {\r
goto ON_ERROR;\r
}\r
} else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {\r
- Conn->HeaderDigest = ISCSI_DIGEST_NONE;\r
+ Conn->HeaderDigest = IScsiDigestNone;\r
} else {\r
goto ON_ERROR;\r
}\r
}\r
\r
if (AsciiStrCmp (Value, "CRC32") == 0) {\r
- if (Conn->DataDigest != ISCSI_DIGEST_CRC32) {\r
+ if (Conn->DataDigest != IScsiDigestCRC32) {\r
goto ON_ERROR;\r
}\r
} else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {\r
- Conn->DataDigest = ISCSI_DIGEST_NONE;\r
+ Conn->DataDigest = IScsiDigestNone;\r
} else {\r
goto ON_ERROR;\r
}\r
Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (AsciiStrCmp (Value, "Yes") == 0));\r
\r
//\r
- // MaxRecvDataSegmentLength, result function is Mininum.\r
+ // MaxRecvDataSegmentLength is declarative.\r
//\r
Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);\r
if (Value != NULL) {\r
- //\r
- // MaxRecvDataSegmentLength is declarative.\r
- //\r
- NumericValue = AsciiStrDecimalToUintn (Value);\r
-\r
- Conn->MaxRecvDataSegmentLength = (UINT32) MIN (Conn->MaxRecvDataSegmentLength, NumericValue);\r
+ Conn->MaxRecvDataSegmentLength = (UINT32) AsciiStrDecimalToUintn (Value);\r
}\r
//\r
// MaxBurstLength, result funtion is Mininum.\r
//\r
// FirstBurstLength, result function is Minimum. Irrelevant when InitialR2T=Yes and\r
// ImmediateData=No.\r
+ // This Key/Value is negotiation type.\r
//\r
Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);\r
- if ((Value == NULL) && !(Session->InitialR2T && !Session->ImmediateData)) {\r
+ if (Value == NULL) {\r
goto ON_ERROR;\r
}\r
\r
\r
IScsiFreeKeyValueList (KeyValueList);\r
\r
- gBS->FreePool (Data);\r
+ FreePool (Data);\r
\r
return Status;\r
}\r
/**\r
Fill the oprational prameters.\r
\r
- @param[in] Conn The connection in iSCSI login.\r
- @param[in] Pdu The iSCSI login request PDU to fill the parameters.\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 NET_BUF *Pdu\r
+ IN OUT NET_BUF *Pdu\r
)\r
{\r
ISCSI_SESSION *Session;\r
\r
Session = Conn->Session;\r
\r
- AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == ISCSI_DIGEST_CRC32) ? "None,CRC32" : "None");\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 == ISCSI_DIGEST_CRC32) ? "None,CRC32" : "None");\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
AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");\r
IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);\r
\r
- AsciiSPrint (Value, sizeof (Value), "%d", Conn->MaxRecvDataSegmentLength);\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
/**\r
Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r
\r
- @param[in] Pdu The iSCSI pdu which contains segments to pad.\r
- @param[in] Len The length of the last semgnet in the PDU.\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
**/\r
EFI_STATUS\r
IScsiPadSegment (\r
- IN NET_BUF *Pdu,\r
- IN UINT32 Len\r
+ IN OUT NET_BUF *Pdu,\r
+ IN UINT32 Len\r
)\r
{\r
UINT32 PadLen;\r
@param[in] Len Length of the data segment.\r
\r
@return The key-value list.\r
- @return NULL Some unexpected error happened.\r
+ @retval NULL Other errors as indicated.\r
**/\r
LIST_ENTRY *\r
IScsiBuildKeyValueList (\r
LIST_ENTRY *ListHead;\r
ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
\r
- ListHead = AllocatePool (sizeof (LIST_ENTRY ));\r
+ ListHead = AllocatePool (sizeof (LIST_ENTRY));\r
if (ListHead == NULL) {\r
return NULL;\r
}\r
Data++;\r
Len--;\r
} else {\r
- gBS->FreePool (KeyValuePair);\r
+ FreePool (KeyValuePair);\r
goto ON_ERROR;\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] KeyValueList The key-value list.\r
- @param[in] Key The key name to find.\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 LIST_ENTRY *KeyValueList,\r
+ IN OUT LIST_ENTRY *KeyValueList,\r
IN CHAR8 *Key\r
)\r
{\r
Value = KeyValuePair->Value;\r
\r
RemoveEntryList (&KeyValuePair->List);\r
- gBS->FreePool (KeyValuePair);\r
+ FreePool (KeyValuePair);\r
break;\r
}\r
}\r
Entry = NetListRemoveHead (KeyValueList);\r
KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);\r
\r
- gBS->FreePool (KeyValuePair);\r
+ FreePool (KeyValuePair);\r
}\r
\r
- gBS->FreePool (KeyValueList);\r
+ FreePool (KeyValueList);\r
}\r
\r
/**\r
Normalize the iSCSI name according to RFC.\r
\r
- @param[in] Name The iSCSI name.\r
- @param[in] Len length of the iSCSI name.\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 CHAR8 *Name,\r
- IN UINTN Len\r
+ IN OUT CHAR8 *Name,\r
+ IN UINTN Len\r
)\r
{\r
UINTN Index;\r
{\r
RemoveEntryList (&Tcb->Link);\r
\r
- gBS->FreePool (Tcb);\r
+ FreePool (Tcb);\r
}\r
\r
/**\r
@param[in] Tcb The tcb assocated with this SCSI command.\r
\r
@return The created iSCSI SCSI command PDU.\r
- @return NULL Some unexpected error happened.\r
+ @retval NULL Other errors as indicated.\r
**/\r
NET_BUF *\r
IScsiNewScsiCmdPdu (\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
ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);\r
ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);\r
\r
- CopyMem (ScsiCmd->CDB, Packet->Cdb, sizeof (ScsiCmd->CDB));\r
+ CopyMem (ScsiCmd->Cdb, Packet->Cdb, sizeof (ScsiCmd->Cdb));\r
\r
if (Packet->CdbLength > 16) {\r
- Header->Length = NTOHS (Packet->CdbLength - 15);\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
goto ON_EXIT;\r
}\r
\r
- NbufList = AllocatePool (sizeof (LIST_ENTRY ));\r
+ NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
if (NbufList == NULL) {\r
NetbufFree (PduHeader);\r
NetbufFree (DataSeg);\r
) {\r
//\r
// Unsolicited data out sequence is not allowed,\r
- // or FirstBustLength data is already sent out by immediate data\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
@param[in] Lun The LUN.\r
\r
@return The net buffer wrapping the Data Out PDU.\r
- @return NULL Some unexpected error happened.\r
+ @retval NULL Other errors as indicated.\r
**/\r
NET_BUF *\r
IScsiNewDataOutPdu (\r
ISCSI_SCSI_DATA_OUT *DataOutHdr;\r
ISCSI_XFER_CONTEXT *XferContext;\r
\r
- NbufList = AllocatePool (sizeof (LIST_ENTRY ));\r
+ NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
if (NbufList == NULL) {\r
return NULL;\r
}\r
//\r
PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));\r
if (PduHdr == NULL) {\r
- gBS->FreePool (NbufList);\r
+ FreePool (NbufList);\r
return NULL;\r
}\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
@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
- @return NULL Some unexpected error happened.\r
+ @retval NULL Other errors as indicated.\r
**/\r
LIST_ENTRY *\r
IScsiGenerateDataOutPduSequence (\r
ISCSI_CONNECTION *Conn;\r
ISCSI_XFER_CONTEXT *XferContext;\r
\r
- PduList = AllocatePool (sizeof (LIST_ENTRY ));\r
+ PduList = AllocatePool (sizeof (LIST_ENTRY));\r
if (PduList == NULL) {\r
return NULL;\r
}\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiSendDataOutPduSequence (\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiOnDataInRcvd (\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiOnR2TRcvd (\r
R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);\r
R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);\r
R2THdr->StatSN = NTOHL (R2THdr->StatSN);\r
- R2THdr->R2TSN = NTOHL (R2THdr->R2TSN);\r
+ R2THdr->R2TSeqNum = NTOHL (R2THdr->R2TSeqNum);\r
R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);\r
R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);\r
\r
//\r
// Check the sequence number.\r
//\r
- Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSN);\r
+ Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSeqNum);\r
if (EFI_ERROR (Status)) {\r
return Status;\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 Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiOnScsiRspRcvd (\r
\r
@retval EFI_SUCCES The SCSI command is executed and the result is updated to \r
the Packet.\r
- @retval EFI_DEVICE_ERROR Some unexpected error happened.\r
+ @retval EFI_DEVICE_ERROR Session state was not as required.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
- @retval Others Some unexpected error happened.\r
+ @retval Others Other errors as indicated.\r
**/\r
EFI_STATUS\r
IScsiExecuteScsiCommand (\r
/**\r
Reinstate the session on some error.\r
\r
- @param[in] Private The iSCSI driver data.\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 ISCSI_DRIVER_DATA *Private\r
+ IN OUT ISCSI_DRIVER_DATA *Private\r
)\r
{\r
ISCSI_SESSION *Session;\r
/**\r
Initialize some session parameters before login.\r
\r
- @param[in] Session The iSCSI session.\r
- @param[in] Recovery Whether the request is from a fresh new start or recovery.\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 ISCSI_SESSION *Session,\r
- IN BOOLEAN Recovery\r
+ IN OUT ISCSI_SESSION *Session,\r
+ IN BOOLEAN Recovery\r
)\r
{\r
UINT32 Random;\r
\r
Random = NET_RANDOM (NetRandomInitSeed ());\r
\r
- Session->ISID[0] = ISID_BYTE_0;\r
- Session->ISID[1] = ISID_BYTE_1;\r
- Session->ISID[2] = ISID_BYTE_2;\r
- Session->ISID[3] = ISID_BYTE_3;\r
- Session->ISID[4] = (UINT8) Random;\r
- Session->ISID[5] = (UINT8) (Random >> 8);\r
+ Session->Isid[0] = ISID_BYTE_0;\r
+ Session->Isid[1] = ISID_BYTE_1;\r
+ Session->Isid[2] = ISID_BYTE_2;\r
+ Session->Isid[3] = ISID_BYTE_3;\r
+ Session->Isid[4] = (UINT8) Random;\r
+ Session->Isid[5] = (UINT8) (Random >> 8);\r
\r
InitializeListHead (&Session->Conns);\r
InitializeListHead (&Session->TcbList);\r
}\r
\r
- Session->TSIH = 0;\r
+ Session->Tsih = 0;\r
\r
Session->CmdSN = 1;\r
Session->InitiatorTaskTag = 1;\r
- Session->NextCID = 1;\r
+ Session->NextCid = 1;\r
\r
Session->TargetPortalGroupTag = 0;\r
Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;\r
Abort the iSCSI session, that is, reset all the connection and free the\r
resources.\r
\r
- @param[in] Session The iSCSI session.\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 ISCSI_SESSION *Session\r
+ IN OUT ISCSI_SESSION *Session\r
)\r
{\r
ISCSI_DRIVER_DATA *Private;\r
projects / mirror_edk2.git / blobdiff