]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
Fix a K9 error.Result of GetVariable2() function that may return NULL will be derefer...
[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiMisc.c
index 2215fdaa2bc401198a291689d6bbaaabea31d684..2e43b415ec593b899d16426991d0aca73229805f 100644 (file)
@@ -1,8 +1,8 @@
 /** @file\r
-  Miscellaneous routines for IScsi driver.\r
+  Miscellaneous routines for iSCSI driver.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2013, 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
@@ -20,7 +20,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8  IScsiHexString[] = "0123456789ABCDEFa
   Removes (trims) specified leading and trailing characters from a string.\r
 \r
   @param[in, out]  Str  Pointer to the null-terminated string to be trimmed. On return, \r
-                        str will hold the trimmed string. \r
+                        Str will hold the trimmed string. \r
 \r
   @param[in]      CharC Character will be trimmed from str.\r
 **/\r
@@ -74,7 +74,7 @@ StrTrim (
   @param[in]  SubnetMask The IPv4 subnet mask.\r
 \r
   @return The prefix length of the subnet mask.\r
-  @return 0 Some unexpected error happened.\r
+  @retval 0 Other errors as indicated.\r
 **/\r
 UINT8\r
 IScsiGetSubnetMaskPrefixLength (\r
@@ -94,7 +94,7 @@ IScsiGetSubnetMaskPrefixLength (
   //\r
   ReverseMask = ~ReverseMask;\r
 \r
-  if ((ReverseMask != 0) & ((ReverseMask + 1) != 0)) {\r
+  if ((ReverseMask & (ReverseMask + 1)) != 0) {\r
     return 0;\r
   }\r
 \r
@@ -123,55 +123,64 @@ IScsiAsciiStrToLun (
   OUT UINT8  *Lun\r
   )\r
 {\r
-  UINT32  Index;\r
-  CHAR8   *LunUnitStr[4];\r
-  CHAR8   Digit;\r
-  UINTN   Temp;\r
-\r
+  UINTN   Index, IndexValue, IndexNum, SizeStr;\r
+  CHAR8   TemStr[2];\r
+  UINT8   TemValue;\r
+  UINT16  Value[4];\r
+  \r
   ZeroMem (Lun, 8);\r
-  ZeroMem (LunUnitStr, sizeof (LunUnitStr));\r
-\r
-  Index         = 0;\r
-  LunUnitStr[0] = Str;\r
-\r
-  if (!IsHexDigit ((UINT8 *) &Digit, *Str)) {\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
-\r
-  while (*Str != '\0') {\r
-    //\r
-    // Legal representations of LUN:\r
-    //   4752-3A4F-6b7e-2F99,\r
-    //   6734-9-156f-127,\r
-    //   4186-9\r
-    //\r
-    if (*Str == '-') {\r
-      *Str = '\0';\r
-      Index++;\r
-\r
-      if (*(Str + 1) != '\0') {\r
-        if (!IsHexDigit ((UINT8 *) &Digit, *(Str + 1))) {\r
-          return EFI_INVALID_PARAMETER;\r
-        }\r
-\r
-        LunUnitStr[Index] = Str + 1;\r
+  ZeroMem (TemStr, 2);\r
+  ZeroMem ((UINT8 *) Value, sizeof (Value));\r
+  SizeStr    = AsciiStrLen (Str);  \r
+  IndexValue = 0;\r
+  IndexNum   = 0;\r
+\r
+  for (Index = 0; Index < SizeStr; Index ++) {\r
+    TemStr[0] = Str[Index];\r
+    TemValue = (UINT8) AsciiStrHexToUint64 (TemStr);\r
+    if (TemValue == 0 && TemStr[0] != '0') {\r
+      if ((TemStr[0] != '-') || (IndexNum == 0)) {\r
+        //\r
+        // Invalid Lun Char\r
+        //\r
+        return EFI_INVALID_PARAMETER;\r
       }\r
-    } else if (!IsHexDigit ((UINT8 *) &Digit, *Str)) {\r
-      return EFI_INVALID_PARAMETER;\r
     }\r
-\r
-    Str++;\r
-  }\r
-\r
-  for (Index = 0; (Index < 4) && (LunUnitStr[Index] != NULL); Index++) {\r
-    if (AsciiStrLen (LunUnitStr[Index]) > 4) {\r
+    \r
+    if ((TemValue == 0) && (TemStr[0] == '-')) {\r
+      //\r
+      // Next Lun value\r
+      //\r
+      if (++IndexValue >= 4) {\r
+        //\r
+        // Max 4 Lun value\r
+        //\r
+        return EFI_INVALID_PARAMETER;\r
+      }\r
+      //\r
+      // Restart str index for the next lun value\r
+      //\r
+      IndexNum = 0;\r
+      continue;\r
+    }\r
+    \r
+    if (++IndexNum > 4) {\r
+      //     \r
+      // Each Lun Str can't exceed size 4, because it will be as UINT16 value\r
+      //\r
       return EFI_INVALID_PARAMETER;\r
     }\r
-\r
-    Temp = AsciiStrHexToUintn (LunUnitStr[Index]);\r
-    *((UINT16 *) &Lun[Index * 2]) = HTONS (Temp);\r
+    \r
+    //\r
+    // Combine UINT16 value\r
+    //\r
+    Value[IndexValue] = (UINT16) ((Value[IndexValue] << 4) + TemValue);\r
   }\r
-\r
\r
+  for (Index = 0; Index <= IndexValue; Index ++) {\r
+    *((UINT16 *) &Lun[Index * 2]) =  HTONS (Value[Index]);\r
+  }\r
+  \r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -298,7 +307,7 @@ IScsiAsciiStrToIp (
 \r
   Index = 0;\r
 \r
-  while (*Str) {\r
+  while (*Str != 0) {\r
 \r
     if (Index > 3) {\r
       return EFI_INVALID_PARAMETER;\r
@@ -344,18 +353,21 @@ IScsiAsciiStrToIp (
 /**\r
   Convert the mac address into a hexadecimal encoded "-" seperated string.\r
 \r
-  @param[in]  Mac The mac address.\r
-  @param[in]  Len  Length in bytes of the mac address.\r
-  @param[out] Str The storage to return the mac string.\r
+  @param[in]  Mac     The mac address.\r
+  @param[in]  Len     Length in bytes of the mac address.\r
+  @param[in]  VlanId  VLAN ID of the network device.\r
+  @param[out] Str     The storage to return the mac string.\r
 **/\r
 VOID\r
 IScsiMacAddrToStr (\r
   IN  EFI_MAC_ADDRESS  *Mac,\r
   IN  UINT32           Len,\r
+  IN  UINT16           VlanId,\r
   OUT CHAR16           *Str\r
   )\r
 {\r
   UINT32  Index;\r
+  CHAR16  *String;\r
 \r
   for (Index = 0; Index < Len; Index++) {\r
     Str[3 * Index]      = (CHAR16) IScsiHexString[(Mac->Addr[Index] >> 4) & 0x0F];\r
@@ -363,7 +375,12 @@ IScsiMacAddrToStr (
     Str[3 * Index + 2]  = L'-';\r
   }\r
 \r
-  Str[3 * Index - 1] = L'\0';\r
+  String = &Str[3 * Index - 1] ;\r
+  if (VlanId != 0) {\r
+    String += UnicodeSPrint (String, 6 * sizeof (CHAR16), L"\\%04x", (UINTN) VlanId);\r
+  }\r
+\r
+  *String = L'\0';\r
 }\r
 \r
 /**\r
@@ -424,7 +441,7 @@ IScsiBinToHex (
 \r
   @retval EFI_SUCCESS          The hexadecimal string is converted into a binary\r
                                encoded buffer.\r
-  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.s\r
+  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.\r
 **/\r
 EFI_STATUS\r
 IScsiHexToBin (\r
@@ -434,52 +451,38 @@ IScsiHexToBin (
   )\r
 {\r
   UINTN   Index;\r
-  UINT32  HexCount;\r
-  CHAR8   *HexBuf;\r
+  UINTN   Length;\r
   UINT8   Digit;\r
-  UINT8   Byte;\r
-\r
-  Digit = 0;\r
+  CHAR8   TemStr[2];\r
+  \r
+  ZeroMem (TemStr, sizeof (TemStr));\r
 \r
   //\r
   // Find out how many hex characters the string has.\r
   //\r
-  HexBuf = HexStr;\r
-  if ((HexBuf[0] == '0') && ((HexBuf[1] == 'x') || (HexBuf[1] == 'X'))) {\r
-    HexBuf += 2;\r
+  if ((HexStr[0] == '0') && ((HexStr[1] == 'x') || (HexStr[1] == 'X'))) {\r
+    HexStr += 2;\r
   }\r
+  \r
+  Length = AsciiStrLen (HexStr);\r
 \r
-  for (Index = 0, HexCount = 0; IsHexDigit (&Digit, HexBuf[Index]); Index++, HexCount++)\r
-    ;\r
-\r
-  if (HexCount == 0) {\r
-    *BinLength = 0;\r
-    return EFI_SUCCESS;\r
-  }\r
-  //\r
-  // Test if buffer is passed enough.\r
-  //\r
-  if (((HexCount + 1) / 2) > *BinLength) {\r
-    *BinLength = (HexCount + 1) / 2;\r
-    return EFI_BUFFER_TOO_SMALL;\r
-  }\r
-\r
-  *BinLength = (HexCount + 1) / 2;\r
-\r
-  for (Index = 0; Index < HexCount; Index++) {\r
-\r
-    IsHexDigit (&Digit, HexBuf[HexCount - 1 - Index]);\r
-\r
+  for (Index = 0; Index < Length; Index ++) {\r
+    TemStr[0] = HexStr[Index];\r
+    Digit = (UINT8) AsciiStrHexToUint64 (TemStr);\r
+    if (Digit == 0 && TemStr[0] != '0') {\r
+      //\r
+      // Invalid Lun Char\r
+      //\r
+      break;\r
+    }\r
     if ((Index & 1) == 0) {\r
-      Byte = Digit;\r
+      BinBuffer [Index/2] = Digit;\r
     } else {\r
-      Byte = BinBuffer[*BinLength - 1 - Index / 2];\r
-      Byte &= 0x0F;\r
-      Byte = (UINT8) (Byte | (Digit << 4));\r
+      BinBuffer [Index/2] = (UINT8) ((BinBuffer [Index/2] << 4) + Digit);\r
     }\r
-\r
-    BinBuffer[*BinLength - 1 - Index / 2] = Byte;\r
   }\r
+  \r
+  *BinLength = (UINT32) ((Index + 1)/2);\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -512,7 +515,7 @@ IScsiGenRandom (
   @param[in] Controller The handle of the controller.\r
 \r
   @return The iSCSI driver data created.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 ISCSI_DRIVER_DATA *\r
 IScsiCreateDriverData (\r
@@ -536,15 +539,16 @@ IScsiCreateDriverData (
   // Create an event to be signal when the BS to RT transition is triggerd so\r
   // as to abort the iSCSI session.\r
   //\r
-  Status = gBS->CreateEvent (\r
-                  EVT_SIGNAL_EXIT_BOOT_SERVICES,\r
+  Status = gBS->CreateEventEx (\r
+                  EVT_NOTIFY_SIGNAL,\r
                   TPL_CALLBACK,\r
                   IScsiOnExitBootService,\r
                   Private,\r
+                  &gEfiEventExitBootServicesGuid,\r
                   &Private->ExitBootServiceEvent\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    gBS->FreePool (Private);\r
+    FreePool (Private);\r
     return NULL;\r
   }\r
 \r
@@ -569,7 +573,7 @@ IScsiCreateDriverData (
                   );\r
   if (EFI_ERROR (Status)) {\r
     gBS->CloseEvent (Private->ExitBootServiceEvent);\r
-    gBS->FreePool (Private);\r
+    FreePool (Private);\r
 \r
     return NULL;\r
   }\r
@@ -596,7 +600,7 @@ IScsiCleanDriverData (
           Private->DevicePath\r
           );\r
 \r
-    gBS->FreePool (Private->DevicePath);\r
+    FreePool (Private->DevicePath);\r
   }\r
 \r
   if (Private->ExtScsiPassThruHandle != NULL) {\r
@@ -609,7 +613,60 @@ IScsiCleanDriverData (
 \r
   gBS->CloseEvent (Private->ExitBootServiceEvent);\r
 \r
-  gBS->FreePool (Private);\r
+  FreePool (Private);\r
+}\r
+\r
+/**\r
+  Check wheather the Controller is configured to use DHCP protocol.\r
+\r
+  @param[in]  Controller           The handle of the controller.\r
+  \r
+  @retval TRUE                     The handle of the controller need the Dhcp protocol.\r
+  @retval FALSE                    The handle of the controller does not need the Dhcp protocol.\r
+  \r
+**/\r
+BOOLEAN\r
+IScsiDhcpIsConfigured (\r
+  IN EFI_HANDLE  Controller\r
+  )\r
+{\r
+  EFI_STATUS                  Status;\r
+  EFI_MAC_ADDRESS             MacAddress;\r
+  UINTN                       HwAddressSize;\r
+  UINT16                      VlanId;\r
+  CHAR16                      MacString[70];\r
+  ISCSI_SESSION_CONFIG_NVDATA *ConfigDataTmp;\r
+\r
+  //\r
+  // Get the mac string, it's the name of various variable\r
+  //\r
+  Status = NetLibGetMacAddress (Controller, &MacAddress, &HwAddressSize);\r
+  if (EFI_ERROR (Status)) {\r
+    return FALSE;\r
+  }\r
+  VlanId = NetLibGetVlanId (Controller);\r
+  IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, MacString);\r
+\r
+  //\r
+  // Get the normal configuration.\r
+  //\r
+  Status = GetVariable2 (\r
+             MacString,\r
+             &gEfiIScsiInitiatorNameProtocolGuid,\r
+             (VOID**)&ConfigDataTmp,\r
+             NULL\r
+             );\r
+  if (ConfigDataTmp == NULL || EFI_ERROR (Status)) {\r
+    return FALSE;\r
+  }\r
+\r
+  if (ConfigDataTmp->Enabled && ConfigDataTmp->InitiatorInfoFromDhcp) {\r
+    FreePool (ConfigDataTmp);\r
+    return TRUE;\r
+  }\r
+\r
+  FreePool (ConfigDataTmp);\r
+  return FALSE;\r
 }\r
 \r
 /**\r
@@ -619,7 +676,7 @@ IScsiCleanDriverData (
 \r
   @retval EFI_SUCCESS   The configuration of this instance is got.\r
   @retval EFI_ABORTED   The operation was aborted.\r
-  @retval Others        Some unexpected error happened.\r
+  @retval Others        Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiGetConfigData (\r
@@ -629,9 +686,10 @@ IScsiGetConfigData (
   EFI_STATUS                  Status;\r
   ISCSI_SESSION               *Session;\r
   UINTN                       BufferSize;\r
-  EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r
-  EFI_SIMPLE_NETWORK_MODE     *Mode;\r
-  CHAR16                      MacString[65];\r
+  EFI_MAC_ADDRESS             MacAddress;\r
+  UINTN                       HwAddressSize;\r
+  UINT16                      VlanId;\r
+  CHAR16                      MacString[70];\r
 \r
   //\r
   // get the iSCSI Initiator Name\r
@@ -647,21 +705,13 @@ IScsiGetConfigData (
     return Status;\r
   }\r
 \r
-  Status = gBS->HandleProtocol (\r
-                  Private->Controller,\r
-                  &gEfiSimpleNetworkProtocolGuid,\r
-                  (VOID **)&Snp\r
-                  );\r
-  if (EFI_ERROR (Status)) {\r
-    return Status;\r
-  }\r
-\r
-  Mode = Snp->Mode;\r
-\r
   //\r
   // Get the mac string, it's the name of various variable\r
   //\r
-  IScsiMacAddrToStr (&Mode->PermanentAddress, Mode->HwAddressSize, MacString);\r
+  Status = NetLibGetMacAddress (Private->Controller, &MacAddress, &HwAddressSize);\r
+  ASSERT (Status == EFI_SUCCESS);\r
+  VlanId = NetLibGetVlanId (Private->Controller);\r
+  IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, MacString);\r
 \r
   //\r
   // Get the normal configuration.\r
@@ -687,7 +737,7 @@ IScsiGetConfigData (
   BufferSize = sizeof (Session->AuthData.AuthConfig);\r
   Status = gRT->GetVariable (\r
                   MacString,\r
-                  &mIScsiCHAPAuthInfoGuid,\r
+                  &gIScsiCHAPAuthInfoGuid,\r
                   NULL,\r
                   &BufferSize,\r
                   &Session->AuthData.AuthConfig\r
@@ -709,7 +759,7 @@ IScsiGetConfigData (
   @param[in]  Private The iSCSI driver data.\r
 \r
   @return The updated device path.\r
-  @return NULL Some unexpected error happened.\r
+  @retval NULL Other errors as indicated.\r
 **/\r
 EFI_DEVICE_PATH_PROTOCOL *\r
 IScsiGetTcpConnDevicePath (\r
@@ -748,6 +798,9 @@ IScsiGetTcpConnDevicePath (
   // Duplicate it.\r
   //\r
   DevicePath  = DuplicateDevicePath (DevicePath);\r
+  if (DevicePath == NULL) {\r
+    return NULL;\r
+  }\r
 \r
   DPathNode   = (EFI_DEV_PATH *) DevicePath;\r
 \r
@@ -757,7 +810,19 @@ IScsiGetTcpConnDevicePath (
         ) {\r
 \r
       DPathNode->Ipv4.LocalPort       = 0;\r
-      DPathNode->Ipv4.StaticIpAddress = (BOOLEAN) (!Session->ConfigData.NvData.InitiatorInfoFromDhcp);\r
+      DPathNode->Ipv4.StaticIpAddress = \r
+        (BOOLEAN) (!Session->ConfigData.NvData.InitiatorInfoFromDhcp);\r
+\r
+      IP4_COPY_ADDRESS (\r
+        &DPathNode->Ipv4.GatewayIpAddress,\r
+        &Session->ConfigData.NvData.Gateway\r
+        );\r
+\r
+      IP4_COPY_ADDRESS (\r
+        &DPathNode->Ipv4.SubnetMask,\r
+        &Session->ConfigData.NvData.SubnetMask\r
+        );\r
+\r
       break;\r
     }\r
 \r