X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdeModulePkg%2FUniversal%2FNetwork%2FIScsiDxe%2FIScsiMisc.c;h=2e43b415ec593b899d16426991d0aca73229805f;hb=25a516ab1a9dfccf2b71ec15771e99192c307418;hp=53de070a2a08da479bbdd08412569a5facd66f88;hpb=fe1e36e550c6ffcd2561903d434683d3939e1942;p=mirror_edk2.git diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c index 53de070a2a..2e43b415ec 100644 --- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c +++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c @@ -1,8 +1,8 @@ /** @file - Miscellaneous routines for IScsi driver. + Miscellaneous routines for iSCSI driver. -Copyright (c) 2004 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials +Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.
+This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php @@ -10,82 +10,71 @@ http://opensource.org/licenses/bsd-license.php THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. -Module Name: - - IScsiMisc.c - -Abstract: - - Miscellaneous routines for IScsi driver. - **/ #include "IScsiImpl.h" -CONST CHAR8 IScsiHexString[] = "0123456789ABCDEFabcdef"; +GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 IScsiHexString[] = "0123456789ABCDEFabcdef"; /** Removes (trims) specified leading and trailing characters from a string. - @param str[in][out] Pointer to the null-terminated string to be trimmed. On return, - str will hold the trimmed string. - - @param CharC[in] Character will be trimmed from str. - - @retval NONE. + @param[in, out] Str Pointer to the null-terminated string to be trimmed. On return, + Str will hold the trimmed string. + @param[in] CharC Character will be trimmed from str. **/ VOID StrTrim ( - IN OUT CHAR16 *str, + IN OUT CHAR16 *Str, IN CHAR16 CharC ) { - CHAR16 *p1; - CHAR16 *p2; + CHAR16 *Pointer1; + CHAR16 *Pointer2; - if (*str == 0) { + if (*Str == 0) { return; } // // Trim off the leading and trailing characters c // - for (p1 = str; *p1 && *p1 == CharC; p1++) { + for (Pointer1 = Str; (*Pointer1 != 0) && (*Pointer1 == CharC); Pointer1++) { ; } - p2 = str; - if (p2 == p1) { - while (*p1) { - p2++; - p1++; + Pointer2 = Str; + if (Pointer2 == Pointer1) { + while (*Pointer1 != 0) { + Pointer2++; + Pointer1++; } } else { - while (*p1) { - *p2 = *p1; - p1++; - p2++; + while (*Pointer1 != 0) { + *Pointer2 = *Pointer1; + Pointer1++; + Pointer2++; } - *p2 = 0; + *Pointer2 = 0; } - for (p1 = str + StrLen(str) - 1; p1 >= str && *p1 == CharC; p1--) { + for (Pointer1 = Str + StrLen(Str) - 1; Pointer1 >= Str && *Pointer1 == CharC; Pointer1--) { ; } - if (p1 != str + StrLen(str) - 1) { - *(p1 + 1) = 0; + if (Pointer1 != Str + StrLen(Str) - 1) { + *(Pointer1 + 1) = 0; } } /** Calculate the prefix length of the IPv4 subnet mask. - @param SubnetMask[in] The IPv4 subnet mask. - - @retval The prefix length of the subnet mask. + @param[in] SubnetMask The IPv4 subnet mask. + @return The prefix length of the subnet mask. + @retval 0 Other errors as indicated. **/ UINT8 IScsiGetSubnetMaskPrefixLength ( @@ -105,7 +94,7 @@ IScsiGetSubnetMaskPrefixLength ( // ReverseMask = ~ReverseMask; - if (ReverseMask & (ReverseMask + 1)) { + if ((ReverseMask & (ReverseMask + 1)) != 0) { return 0; } @@ -122,14 +111,11 @@ IScsiGetSubnetMaskPrefixLength ( /** Convert the hexadecimal encoded LUN string into the 64-bit LUN. - @param Str[in] The hexadecimal encoded LUN string. - - @param Lun[out] Storage to return the 64-bit LUN. + @param[in] Str The hexadecimal encoded LUN string. + @param[out] Lun Storage to return the 64-bit LUN. @retval EFI_SUCCESS The 64-bit LUN is stored in Lun. - @retval EFI_INVALID_PARAMETER The string is malformatted. - **/ EFI_STATUS IScsiAsciiStrToLun ( @@ -137,67 +123,72 @@ IScsiAsciiStrToLun ( OUT UINT8 *Lun ) { - UINT32 Index; - CHAR8 *LunUnitStr[4]; - CHAR8 Digit; - UINTN Temp; - + UINTN Index, IndexValue, IndexNum, SizeStr; + CHAR8 TemStr[2]; + UINT8 TemValue; + UINT16 Value[4]; + ZeroMem (Lun, 8); - ZeroMem (LunUnitStr, sizeof (LunUnitStr)); - - Index = 0; - LunUnitStr[0] = Str; - - if (!IsHexDigit ((UINT8 *) &Digit, *Str)) { - return EFI_INVALID_PARAMETER; - } - - while (*Str != '\0') { - // - // Legal representations of LUN: - // 4752-3A4F-6b7e-2F99, - // 6734-9-156f-127, - // 4186-9 - // - if (*Str == '-') { - *Str = '\0'; - Index++; - - if (*(Str + 1) != '\0') { - if (!IsHexDigit ((UINT8 *) &Digit, *(Str + 1))) { - return EFI_INVALID_PARAMETER; - } - - LunUnitStr[Index] = Str + 1; + ZeroMem (TemStr, 2); + ZeroMem ((UINT8 *) Value, sizeof (Value)); + SizeStr = AsciiStrLen (Str); + IndexValue = 0; + IndexNum = 0; + + for (Index = 0; Index < SizeStr; Index ++) { + TemStr[0] = Str[Index]; + TemValue = (UINT8) AsciiStrHexToUint64 (TemStr); + if (TemValue == 0 && TemStr[0] != '0') { + if ((TemStr[0] != '-') || (IndexNum == 0)) { + // + // Invalid Lun Char + // + return EFI_INVALID_PARAMETER; } - } else if (!IsHexDigit ((UINT8 *) &Digit, *Str)) { - return EFI_INVALID_PARAMETER; } - - Str++; - } - - for (Index = 0; (Index < 4) && (LunUnitStr[Index] != NULL); Index++) { - if (AsciiStrLen (LunUnitStr[Index]) > 4) { + + if ((TemValue == 0) && (TemStr[0] == '-')) { + // + // Next Lun value + // + if (++IndexValue >= 4) { + // + // Max 4 Lun value + // + return EFI_INVALID_PARAMETER; + } + // + // Restart str index for the next lun value + // + IndexNum = 0; + continue; + } + + if (++IndexNum > 4) { + // + // Each Lun Str can't exceed size 4, because it will be as UINT16 value + // return EFI_INVALID_PARAMETER; } - - Temp = AsciiStrHexToUintn (LunUnitStr[Index]); - *((UINT16 *) &Lun[Index * 2]) = HTONS (Temp); + + // + // Combine UINT16 value + // + Value[IndexValue] = (UINT16) ((Value[IndexValue] << 4) + TemValue); } - + + for (Index = 0; Index <= IndexValue; Index ++) { + *((UINT16 *) &Lun[Index * 2]) = HTONS (Value[Index]); + } + return EFI_SUCCESS; } /** Convert the 64-bit LUN into the hexadecimal encoded LUN string. - @param Lun[in] The 64-bit LUN. - - @param Str[out] The storage to return the hexadecimal encoded LUN string. - - @retval None. - + @param[in] Lun The 64-bit LUN. + @param[out] Str The storage to return the hexadecimal encoded LUN string. **/ VOID IScsiLunToUnicodeStr ( @@ -216,9 +207,9 @@ IScsiLunToUnicodeStr ( StrCpy (TempStr, L"0-"); } else { TempStr[0] = (CHAR16) IScsiHexString[Lun[2 * Index] >> 4]; - TempStr[1] = (CHAR16) IScsiHexString[Lun[2 * Index] & 0xf]; + TempStr[1] = (CHAR16) IScsiHexString[Lun[2 * Index] & 0x0F]; TempStr[2] = (CHAR16) IScsiHexString[Lun[2 * Index + 1] >> 4]; - TempStr[3] = (CHAR16) IScsiHexString[Lun[2 * Index + 1] & 0xf]; + TempStr[3] = (CHAR16) IScsiHexString[Lun[2 * Index + 1] & 0x0F]; TempStr[4] = L'-'; TempStr[5] = 0; @@ -242,12 +233,10 @@ IScsiLunToUnicodeStr ( /** Convert the ASCII string into a UNICODE string. - @param Source[out] The ASCII string. - - @param Destination[out] The storage to return the UNICODE string. - - @retval CHAR16 * Pointer to the UNICODE string. + @param[in] Source The ASCII string. + @param[out] Destination The storage to return the UNICODE string. + @return CHAR16 * Pointer to the UNICODE string. **/ CHAR16 * IScsiAsciiStrToUnicodeStr ( @@ -270,12 +259,10 @@ IScsiAsciiStrToUnicodeStr ( /** Convert the UNICODE string into an ASCII string. - @param Source[in] The UNICODE string. - - @param Destination[out] The storage to return the ASCII string. - - @retval CHAR8 * Pointer to the ASCII string. + @param[in] Source The UNICODE string. + @param[out] Destination The storage to return the ASCII string. + @return CHAR8 * Pointer to the ASCII string. **/ CHAR8 * IScsiUnicodeStrToAsciiStr ( @@ -303,14 +290,11 @@ IScsiUnicodeStrToAsciiStr ( /** Convert the decimal dotted IPv4 address into the binary IPv4 address. - @param Str[in] The UNICODE string. - - @param Ip[out] The storage to return the ASCII string. + @param[in] Str The UNICODE string. + @param[out] Ip The storage to return the ASCII string. @retval EFI_SUCCESS The binary IP address is returned in Ip. - @retval EFI_INVALID_PARAMETER The IP string is malformatted. - **/ EFI_STATUS IScsiAsciiStrToIp ( @@ -323,7 +307,7 @@ IScsiAsciiStrToIp ( Index = 0; - while (*Str) { + while (*Str != 0) { if (Index > 3) { return EFI_INVALID_PARAMETER; @@ -369,49 +353,48 @@ IScsiAsciiStrToIp ( /** Convert the mac address into a hexadecimal encoded "-" seperated string. - @param Mac[in] The mac address. - - @param Len[in] Length in bytes of the mac address. - - @param Str[out] The storage to return the mac string. - - @retval None. - + @param[in] Mac The mac address. + @param[in] Len Length in bytes of the mac address. + @param[in] VlanId VLAN ID of the network device. + @param[out] Str The storage to return the mac string. **/ VOID IScsiMacAddrToStr ( IN EFI_MAC_ADDRESS *Mac, IN UINT32 Len, + IN UINT16 VlanId, OUT CHAR16 *Str ) { UINT32 Index; + CHAR16 *String; for (Index = 0; Index < Len; Index++) { - Str[3 * Index] = NibbleToHexChar ((UINT8) (Mac->Addr[Index] >> 4)); - Str[3 * Index + 1] = NibbleToHexChar (Mac->Addr[Index]); + Str[3 * Index] = (CHAR16) IScsiHexString[(Mac->Addr[Index] >> 4) & 0x0F]; + Str[3 * Index + 1] = (CHAR16) IScsiHexString[Mac->Addr[Index] & 0x0F]; Str[3 * Index + 2] = L'-'; } - Str[3 * Index - 1] = L'\0'; + String = &Str[3 * Index - 1] ; + if (VlanId != 0) { + String += UnicodeSPrint (String, 6 * sizeof (CHAR16), L"\\%04x", (UINTN) VlanId); + } + + *String = L'\0'; } /** Convert the binary encoded buffer into a hexadecimal encoded string. - @param BinBuffer[in] The buffer containing the binary data. - - @param BinLength[in] Length of the binary buffer. - - @param HexStr[in][out] Pointer to the string. - - @param HexLength[in][out] The length of the string. + @param[in] BinBuffer The buffer containing the binary data. + @param[in] BinLength Length of the binary buffer. + @param[in, out] HexStr Pointer to the string. + @param[in, out] HexLength The length of the string. @retval EFI_SUCCESS The binary data is converted to the hexadecimal string and the length of the string is updated. - @retval EFI_BUFFER_TOO_SMALL The string is too small. - + @retval EFI_INVALID_PARAMETER The IP string is malformatted. **/ EFI_STATUS IScsiBinToHex ( @@ -441,7 +424,7 @@ IScsiBinToHex ( for (Index = 0; Index < BinLength; Index++) { HexStr[Index * 2 + 2] = IScsiHexString[BinBuffer[Index] >> 4]; - HexStr[Index * 2 + 3] = IScsiHexString[BinBuffer[Index] & 0xf]; + HexStr[Index * 2 + 3] = IScsiHexString[BinBuffer[Index] & 0x0F]; } HexStr[Index * 2 + 2] = '\0'; @@ -452,17 +435,13 @@ IScsiBinToHex ( /** Convert the hexadecimal string into a binary encoded buffer. - @param BinBuffer[in][out] The binary buffer. - - @param BinLength[in][out] Length of the binary buffer. - - @param HexStr[in] The hexadecimal string. + @param[in, out] BinBuffer The binary buffer. + @param[in, out] BinLength Length of the binary buffer. + @param[in] HexStr The hexadecimal string. @retval EFI_SUCCESS The hexadecimal string is converted into a binary encoded buffer. - - @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.s - + @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data. **/ EFI_STATUS IScsiHexToBin ( @@ -472,52 +451,38 @@ IScsiHexToBin ( ) { UINTN Index; - UINT32 HexCount; - CHAR8 *HexBuf; + UINTN Length; UINT8 Digit; - UINT8 Byte; - - Digit = 0; + CHAR8 TemStr[2]; + + ZeroMem (TemStr, sizeof (TemStr)); // // Find out how many hex characters the string has. // - HexBuf = HexStr; - if ((HexBuf[0] == '0') && ((HexBuf[1] == 'x') || (HexBuf[1] == 'X'))) { - HexBuf += 2; + if ((HexStr[0] == '0') && ((HexStr[1] == 'x') || (HexStr[1] == 'X'))) { + HexStr += 2; } + + Length = AsciiStrLen (HexStr); - for (Index = 0, HexCount = 0; IsHexDigit (&Digit, HexBuf[Index]); Index++, HexCount++) - ; - - if (HexCount == 0) { - *BinLength = 0; - return EFI_SUCCESS; - } - // - // Test if buffer is passed enough. - // - if (((HexCount + 1) / 2) > *BinLength) { - *BinLength = (HexCount + 1) / 2; - return EFI_BUFFER_TOO_SMALL; - } - - *BinLength = (HexCount + 1) / 2; - - for (Index = 0; Index < HexCount; Index++) { - - IsHexDigit (&Digit, HexBuf[HexCount - 1 - Index]); - + for (Index = 0; Index < Length; Index ++) { + TemStr[0] = HexStr[Index]; + Digit = (UINT8) AsciiStrHexToUint64 (TemStr); + if (Digit == 0 && TemStr[0] != '0') { + // + // Invalid Lun Char + // + break; + } if ((Index & 1) == 0) { - Byte = Digit; + BinBuffer [Index/2] = Digit; } else { - Byte = BinBuffer[*BinLength - 1 - Index / 2]; - Byte &= 0x0F; - Byte = (UINT8) (Byte | (Digit << 4)); + BinBuffer [Index/2] = (UINT8) ((BinBuffer [Index/2] << 4) + Digit); } - - BinBuffer[*BinLength - 1 - Index / 2] = Byte; } + + *BinLength = (UINT32) ((Index + 1)/2); return EFI_SUCCESS; } @@ -525,12 +490,8 @@ IScsiHexToBin ( /** Generate random numbers. - @param Rand[in][out] The buffer to contain random numbers. - - @param RandLength[in] The length of the Rand buffer. - - @retval None. - + @param[in, out] Rand The buffer to contain random numbers. + @param[in] RandLength The length of the Rand buffer. **/ VOID IScsiGenRandom ( @@ -550,12 +511,11 @@ IScsiGenRandom ( /** Create the iSCSI driver data.. - @param Image[in] The handle of the driver image. - - @param Controller[in] The handle of the controller. - - @retval The iSCSI driver data created. + @param[in] Image The handle of the driver image. + @param[in] Controller The handle of the controller. + @return The iSCSI driver data created. + @retval NULL Other errors as indicated. **/ ISCSI_DRIVER_DATA * IScsiCreateDriverData ( @@ -579,15 +539,16 @@ IScsiCreateDriverData ( // Create an event to be signal when the BS to RT transition is triggerd so // as to abort the iSCSI session. // - Status = gBS->CreateEvent ( - EVT_SIGNAL_EXIT_BOOT_SERVICES, + Status = gBS->CreateEventEx ( + EVT_NOTIFY_SIGNAL, TPL_CALLBACK, IScsiOnExitBootService, Private, + &gEfiEventExitBootServicesGuid, &Private->ExitBootServiceEvent ); if (EFI_ERROR (Status)) { - gBS->FreePool (Private); + FreePool (Private); return NULL; } @@ -612,7 +573,7 @@ IScsiCreateDriverData ( ); if (EFI_ERROR (Status)) { gBS->CloseEvent (Private->ExitBootServiceEvent); - gBS->FreePool (Private); + FreePool (Private); return NULL; } @@ -625,10 +586,7 @@ IScsiCreateDriverData ( /** Clean the iSCSI driver data. - @param Private[in] The iSCSI driver data. - - @retval None. - + @param[in] Private The iSCSI driver data. **/ VOID IScsiCleanDriverData ( @@ -642,7 +600,7 @@ IScsiCleanDriverData ( Private->DevicePath ); - gBS->FreePool (Private->DevicePath); + FreePool (Private->DevicePath); } if (Private->ExtScsiPassThruHandle != NULL) { @@ -655,19 +613,70 @@ IScsiCleanDriverData ( gBS->CloseEvent (Private->ExitBootServiceEvent); - gBS->FreePool (Private); + FreePool (Private); } /** + Check wheather the Controller is configured to use DHCP protocol. - Get the various configuration data of this iSCSI instance. + @param[in] Controller The handle of the controller. + + @retval TRUE The handle of the controller need the Dhcp protocol. + @retval FALSE The handle of the controller does not need the Dhcp protocol. + +**/ +BOOLEAN +IScsiDhcpIsConfigured ( + IN EFI_HANDLE Controller + ) +{ + EFI_STATUS Status; + EFI_MAC_ADDRESS MacAddress; + UINTN HwAddressSize; + UINT16 VlanId; + CHAR16 MacString[70]; + ISCSI_SESSION_CONFIG_NVDATA *ConfigDataTmp; - @param Private[in] The iSCSI driver data. + // + // Get the mac string, it's the name of various variable + // + Status = NetLibGetMacAddress (Controller, &MacAddress, &HwAddressSize); + if (EFI_ERROR (Status)) { + return FALSE; + } + VlanId = NetLibGetVlanId (Controller); + IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, MacString); - @retval EFI_SUCCESS The configuration of this instance is got. + // + // Get the normal configuration. + // + Status = GetVariable2 ( + MacString, + &gEfiIScsiInitiatorNameProtocolGuid, + (VOID**)&ConfigDataTmp, + NULL + ); + if (ConfigDataTmp == NULL || EFI_ERROR (Status)) { + return FALSE; + } - @retval EFI_NOT_FOUND This iSCSI instance is not configured yet. + if (ConfigDataTmp->Enabled && ConfigDataTmp->InitiatorInfoFromDhcp) { + FreePool (ConfigDataTmp); + return TRUE; + } + + FreePool (ConfigDataTmp); + return FALSE; +} + +/** + Get the various configuration data of this iSCSI instance. + @param[in] Private The iSCSI driver data. + + @retval EFI_SUCCESS The configuration of this instance is got. + @retval EFI_ABORTED The operation was aborted. + @retval Others Other errors as indicated. **/ EFI_STATUS IScsiGetConfigData ( @@ -677,9 +686,10 @@ IScsiGetConfigData ( EFI_STATUS Status; ISCSI_SESSION *Session; UINTN BufferSize; - EFI_SIMPLE_NETWORK_PROTOCOL *Snp; - EFI_SIMPLE_NETWORK_MODE *Mode; - CHAR16 MacString[65]; + EFI_MAC_ADDRESS MacAddress; + UINTN HwAddressSize; + UINT16 VlanId; + CHAR16 MacString[70]; // // get the iSCSI Initiator Name @@ -695,21 +705,13 @@ IScsiGetConfigData ( return Status; } - Status = gBS->HandleProtocol ( - Private->Controller, - &gEfiSimpleNetworkProtocolGuid, - (VOID **)&Snp - ); - if (EFI_ERROR (Status)) { - return Status; - } - - Mode = Snp->Mode; - // // Get the mac string, it's the name of various variable // - IScsiMacAddrToStr (&Mode->PermanentAddress, Mode->HwAddressSize, MacString); + Status = NetLibGetMacAddress (Private->Controller, &MacAddress, &HwAddressSize); + ASSERT (Status == EFI_SUCCESS); + VlanId = NetLibGetVlanId (Private->Controller); + IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, MacString); // // Get the normal configuration. @@ -735,7 +737,7 @@ IScsiGetConfigData ( BufferSize = sizeof (Session->AuthData.AuthConfig); Status = gRT->GetVariable ( MacString, - &mIScsiCHAPAuthInfoGuid, + &gIScsiCHAPAuthInfoGuid, NULL, &BufferSize, &Session->AuthData.AuthConfig @@ -754,10 +756,10 @@ IScsiGetConfigData ( /** Get the device path of the iSCSI tcp connection and update it. - @param Private[in] The iSCSI driver data. - - @retval The updated device path. + @param[in] Private The iSCSI driver data. + @return The updated device path. + @retval NULL Other errors as indicated. **/ EFI_DEVICE_PATH_PROTOCOL * IScsiGetTcpConnDevicePath ( @@ -796,6 +798,9 @@ IScsiGetTcpConnDevicePath ( // Duplicate it. // DevicePath = DuplicateDevicePath (DevicePath); + if (DevicePath == NULL) { + return NULL; + } DPathNode = (EFI_DEV_PATH *) DevicePath; @@ -805,7 +810,19 @@ IScsiGetTcpConnDevicePath ( ) { DPathNode->Ipv4.LocalPort = 0; - DPathNode->Ipv4.StaticIpAddress = (BOOLEAN) (!Session->ConfigData.NvData.InitiatorInfoFromDhcp); + DPathNode->Ipv4.StaticIpAddress = + (BOOLEAN) (!Session->ConfigData.NvData.InitiatorInfoFromDhcp); + + IP4_COPY_ADDRESS ( + &DPathNode->Ipv4.GatewayIpAddress, + &Session->ConfigData.NvData.Gateway + ); + + IP4_COPY_ADDRESS ( + &DPathNode->Ipv4.SubnetMask, + &Session->ConfigData.NvData.SubnetMask + ); + break; } @@ -818,12 +835,8 @@ IScsiGetTcpConnDevicePath ( /** Abort the session when the transition from BS to RT is initiated. - @param Event[in] The event signaled. - - @param Context[in] The iSCSI driver data. - - @retval None. - + @param[in] Event The event signaled. + @param[in] Context The iSCSI driver data. **/ VOID EFIAPI