]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Library/DxeNetLib/DxeNetLib.c
MdeModulePkg: Remove NetLib and Ip4Config Protocol dependency.
[mirror_edk2.git] / MdeModulePkg / Library / DxeNetLib / DxeNetLib.c
index f74dcdaeae860f94a2ab0133298934bb71cffc01..2a2bac127921da46642555dfc290d2669aec34ac 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Network library.\r
 \r
-Copyright (c) 2005 - 2012, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2015, 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
@@ -19,12 +19,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/ServiceBinding.h>\r
 #include <Protocol/SimpleNetwork.h>\r
 #include <Protocol/ManagedNetwork.h>\r
-#include <Protocol/HiiConfigRouting.h>\r
+#include <Protocol/Ip4Config2.h>\r
 #include <Protocol/ComponentName.h>\r
 #include <Protocol/ComponentName2.h>\r
-#include <Protocol/HiiConfigAccess.h>\r
 \r
-#include <Guid/NicIp4ConfigNvData.h>\r
 #include <Guid/SmBios.h>\r
 \r
 #include <Library/NetLib.h>\r
@@ -35,11 +33,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Library/UefiRuntimeServicesTableLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
 #include <Library/DevicePathLib.h>\r
-#include <Library/HiiLib.h>\r
 #include <Library/PrintLib.h>\r
 #include <Library/UefiLib.h>\r
 \r
 #define NIC_ITEM_CONFIG_SIZE   sizeof (NIC_IP4_CONFIG_INFO) + sizeof (EFI_IP4_ROUTE_TABLE) * MAX_IP4_CONFIG_IN_VARIABLE\r
+#define DEFAULT_ZERO_START     ((UINTN) ~0)\r
 \r
 //\r
 // All the supported IP4 maskes in host byte order.\r
@@ -1065,6 +1063,116 @@ NetListInsertBefore (
   PostEntry->BackLink               = NewEntry;\r
 }\r
 \r
+/**\r
+  Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.\r
+\r
+  Destroy network child instance list by list traversals is not safe due to graph dependencies between nodes.\r
+  This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed\r
+  has been removed from the list or not.\r
+  If it has been removed, then restart the traversal from the head.\r
+  If it hasn't been removed, then continue with the next node directly.\r
+  This function will end the iterate and return the CallBack's last return value if error happens,\r
+  or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.  \r
+\r
+  @param[in]    List             The head of the list.\r
+  @param[in]    CallBack         Pointer to the callback function to destroy one node in the list.\r
+  @param[in]    Context          Pointer to the callback function's context: corresponds to the\r
+                                 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.\r
+  @param[out]   ListLength       The length of the link list if the function returns successfully.\r
+\r
+  @retval EFI_SUCCESS            Two complete passes are made with no changes in the number of children.\r
+  @retval EFI_INVALID_PARAMETER  The input parameter is invalid.\r
+  @retval Others                 Return the CallBack's last return value.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetDestroyLinkList (\r
+  IN   LIST_ENTRY                       *List,\r
+  IN   NET_DESTROY_LINK_LIST_CALLBACK   CallBack,\r
+  IN   VOID                             *Context,    OPTIONAL\r
+  OUT  UINTN                            *ListLength  OPTIONAL\r
+  )\r
+{\r
+  UINTN                         PreviousLength;\r
+  LIST_ENTRY                    *Entry;\r
+  LIST_ENTRY                    *Ptr;\r
+  UINTN                         Length;\r
+  EFI_STATUS                    Status;\r
+\r
+  if (List == NULL || CallBack == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Length = 0;\r
+  do {\r
+    PreviousLength = Length;\r
+    Entry = GetFirstNode (List);\r
+    while (!IsNull (List, Entry)) {\r
+      Status = CallBack (Entry, Context);\r
+      if (EFI_ERROR (Status)) {\r
+        return Status;\r
+      }\r
+      //\r
+      // Walk through the list to see whether the Entry has been removed or not.\r
+      // If the Entry still exists, just try to destroy the next one.\r
+      // If not, go back to the start point to iterate the list again.\r
+      //\r
+      for (Ptr = List->ForwardLink; Ptr != List; Ptr = Ptr->ForwardLink) {\r
+        if (Ptr == Entry) {\r
+          break;\r
+        }\r
+      }\r
+      if (Ptr == Entry) {\r
+        Entry = GetNextNode (List, Entry);\r
+      } else {\r
+        Entry = GetFirstNode (List);\r
+      }\r
+    }\r
+    for (Length = 0, Ptr = List->ForwardLink; Ptr != List; Length++, Ptr = Ptr->ForwardLink);\r
+  } while (Length != PreviousLength);\r
+\r
+  if (ListLength != NULL) {\r
+    *ListLength = Length;\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.\r
+\r
+  @param[in]  Handle             Handle to be checked.\r
+  @param[in]  NumberOfChildren   Number of Handles in ChildHandleBuffer.\r
+  @param[in]  ChildHandleBuffer  An array of child handles to be freed. May be NULL\r
+                                 if NumberOfChildren is 0.\r
+\r
+  @retval TURE                   Found the input Handle in ChildHandleBuffer.\r
+  @retval FALSE                  Can't find the input Handle in ChildHandleBuffer.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+NetIsInHandleBuffer (\r
+  IN  EFI_HANDLE          Handle,\r
+  IN  UINTN               NumberOfChildren,\r
+  IN  EFI_HANDLE          *ChildHandleBuffer OPTIONAL\r
+  )\r
+{\r
+  UINTN     Index;\r
+  \r
+  if (NumberOfChildren == 0 || ChildHandleBuffer == NULL) {\r
+    return FALSE;\r
+  }\r
+\r
+  for (Index = 0; Index < NumberOfChildren; Index++) {\r
+    if (Handle == ChildHandleBuffer[Index]) {\r
+      return TRUE;\r
+    }\r
+  }\r
+\r
+  return FALSE;\r
+}\r
+\r
 \r
 /**\r
   Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.\r
@@ -1575,86 +1683,6 @@ NetMapIterate (
 }\r
 \r
 \r
-/**\r
-  Internal function to get the child handle of the NIC handle.\r
-\r
-  @param[in]   Controller    NIC controller handle.\r
-  @param[out]  ChildHandle   Returned child handle.\r
-\r
-  @retval EFI_SUCCESS        Successfully to get child handle.\r
-  @retval Others             Failed to get child handle.\r
-\r
-**/\r
-EFI_STATUS\r
-NetGetChildHandle (\r
-  IN EFI_HANDLE         Controller,\r
-  OUT EFI_HANDLE        *ChildHandle\r
-  )\r
-{\r
-  EFI_STATUS                 Status;\r
-  EFI_HANDLE                 *Handles;\r
-  UINTN                      HandleCount;\r
-  UINTN                      Index;\r
-  EFI_DEVICE_PATH_PROTOCOL   *ChildDeviceDevicePath;\r
-  VENDOR_DEVICE_PATH         *VendorDeviceNode;\r
-\r
-  //\r
-  // Locate all EFI Hii Config Access protocols\r
-  //\r
-  Status = gBS->LocateHandleBuffer (\r
-                 ByProtocol,\r
-                 &gEfiHiiConfigAccessProtocolGuid,\r
-                 NULL,\r
-                 &HandleCount,\r
-                 &Handles\r
-                 );\r
-  if (EFI_ERROR (Status) || (HandleCount == 0)) {\r
-    return Status;\r
-  }\r
-\r
-  Status = EFI_NOT_FOUND;\r
-\r
-  for (Index = 0; Index < HandleCount; Index++) {\r
-\r
-    Status = EfiTestChildHandle (Controller, Handles[Index], &gEfiManagedNetworkServiceBindingProtocolGuid);\r
-    if (!EFI_ERROR (Status)) {\r
-      //\r
-      // Get device path on the child handle\r
-      //\r
-      Status = gBS->HandleProtocol (\r
-                     Handles[Index],\r
-                     &gEfiDevicePathProtocolGuid,\r
-                     (VOID **) &ChildDeviceDevicePath\r
-                     );\r
-\r
-      if (!EFI_ERROR (Status)) {\r
-        while (!IsDevicePathEnd (ChildDeviceDevicePath)) {\r
-          ChildDeviceDevicePath = NextDevicePathNode (ChildDeviceDevicePath);\r
-          //\r
-          // Parse one instance\r
-          //\r
-          if (ChildDeviceDevicePath->Type == HARDWARE_DEVICE_PATH &&\r
-              ChildDeviceDevicePath->SubType == HW_VENDOR_DP) {\r
-            VendorDeviceNode = (VENDOR_DEVICE_PATH *) ChildDeviceDevicePath;\r
-            if (CompareMem (&VendorDeviceNode->Guid, &gEfiNicIp4ConfigVariableGuid, sizeof (EFI_GUID)) == 0) {\r
-              //\r
-              // Found item matched gEfiNicIp4ConfigVariableGuid\r
-              //\r
-              *ChildHandle = Handles[Index];\r
-              FreePool (Handles);\r
-              return EFI_SUCCESS;\r
-            }\r
-          }\r
-        }\r
-      }\r
-    }\r
-  }\r
-\r
-  FreePool (Handles);\r
-  return Status;\r
-}\r
-\r
-\r
 /**\r
   This is the default unload handle for all the network drivers.\r
 \r
@@ -1677,6 +1705,7 @@ NetLibDefaultUnload (
   EFI_HANDLE                        *DeviceHandleBuffer;\r
   UINTN                             DeviceHandleCount;\r
   UINTN                             Index;\r
+  UINTN                             Index2;\r
   EFI_DRIVER_BINDING_PROTOCOL       *DriverBinding;\r
   EFI_COMPONENT_NAME_PROTOCOL       *ComponentName;\r
   EFI_COMPONENT_NAME2_PROTOCOL      *ComponentName2;\r
@@ -1698,28 +1727,12 @@ NetLibDefaultUnload (
     return Status;\r
   }\r
 \r
-  //\r
-  // Disconnect the driver specified by ImageHandle from all\r
-  // the devices in the handle database.\r
-  //\r
-  for (Index = 0; Index < DeviceHandleCount; Index++) {\r
-    Status = gBS->DisconnectController (\r
-                    DeviceHandleBuffer[Index],\r
-                    ImageHandle,\r
-                    NULL\r
-                    );\r
-  }\r
-\r
-  //\r
-  // Uninstall all the protocols installed in the driver entry point\r
-  //\r
   for (Index = 0; Index < DeviceHandleCount; Index++) {\r
     Status = gBS->HandleProtocol (\r
                     DeviceHandleBuffer[Index],\r
                     &gEfiDriverBindingProtocolGuid,\r
                     (VOID **) &DriverBinding\r
                     );\r
-\r
     if (EFI_ERROR (Status)) {\r
       continue;\r
     }\r
@@ -1727,12 +1740,28 @@ NetLibDefaultUnload (
     if (DriverBinding->ImageHandle != ImageHandle) {\r
       continue;\r
     }\r
-\r
+    \r
+    //\r
+    // Disconnect the driver specified by ImageHandle from all\r
+    // the devices in the handle database.\r
+    //\r
+    for (Index2 = 0; Index2 < DeviceHandleCount; Index2++) {\r
+      Status = gBS->DisconnectController (\r
+                      DeviceHandleBuffer[Index2],\r
+                      DriverBinding->DriverBindingHandle,\r
+                      NULL\r
+                      );\r
+    }\r
+    \r
+    //\r
+    // Uninstall all the protocols installed in the driver entry point\r
+    //    \r
     gBS->UninstallProtocolInterface (\r
-          ImageHandle,\r
+          DriverBinding->DriverBindingHandle,\r
           &gEfiDriverBindingProtocolGuid,\r
           DriverBinding\r
           );\r
+    \r
     Status = gBS->HandleProtocol (\r
                     DeviceHandleBuffer[Index],\r
                     &gEfiComponentNameProtocolGuid,\r
@@ -1740,7 +1769,7 @@ NetLibDefaultUnload (
                     );\r
     if (!EFI_ERROR (Status)) {\r
       gBS->UninstallProtocolInterface (\r
-             ImageHandle,\r
+             DriverBinding->DriverBindingHandle,\r
              &gEfiComponentNameProtocolGuid,\r
              ComponentName\r
              );\r
@@ -1753,7 +1782,7 @@ NetLibDefaultUnload (
                     );\r
     if (!EFI_ERROR (Status)) {\r
       gBS->UninstallProtocolInterface (\r
-             ImageHandle,\r
+             DriverBinding->DriverBindingHandle,\r
              &gEfiComponentName2ProtocolGuid,\r
              ComponentName2\r
              );\r
@@ -1829,7 +1858,7 @@ NetLibCreateServiceChild (
 \r
 \r
 /**\r
-  Destory a child of the service that is identified by ServiceBindingGuid.\r
+  Destroy a child of the service that is identified by ServiceBindingGuid.\r
 \r
   Get the ServiceBinding Protocol first, then use it to destroy a child.\r
 \r
@@ -1838,10 +1867,10 @@ NetLibCreateServiceChild (
   @param[in]   Controller            The controller which has the service installed.\r
   @param[in]   Image                 The image handle used to open service.\r
   @param[in]   ServiceBindingGuid    The service's Guid.\r
-  @param[in]   ChildHandle           The child to destory.\r
+  @param[in]   ChildHandle           The child to destroy.\r
 \r
-  @retval EFI_SUCCESS           The child is successfully destoried.\r
-  @retval Others                Failed to destory the child.\r
+  @retval EFI_SUCCESS           The child is successfully destroyed.\r
+  @retval Others                Failed to destroy the child.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1875,7 +1904,7 @@ NetLibDestroyServiceChild (
   }\r
 \r
   //\r
-  // destory the child\r
+  // destroy the child\r
   //\r
   Status = Service->DestroyChild (Service, ChildHandle);\r
   return Status;\r
@@ -2138,7 +2167,7 @@ NetLibGetMacAddress (
     // Try to get SNP mode from MNP\r
     //\r
     Status = Mnp->GetModeData (Mnp, NULL, &SnpModeData);\r
-    if (EFI_ERROR (Status)) {\r
+    if (EFI_ERROR (Status) && (Status != EFI_NOT_STARTED)) {\r
       MnpSb->DestroyChild (MnpSb, MnpChildHandle);\r
       return Status;\r
     }\r
@@ -2452,12 +2481,11 @@ Exit:
   Check the default address used by the IPv4 driver is static or dynamic (acquired\r
   from DHCP).\r
 \r
-  If the controller handle does not have the NIC Ip4 Config Protocol installed, the\r
-  default address is static. If the EFI variable to save the configuration is not found,\r
-  the default address is static. Otherwise, get the result from the EFI variable which\r
-  saving the configuration.\r
+  If the controller handle does not have the EFI_IP4_CONFIG2_PROTOCOL installed, the\r
+  default address is static. If failed to get the policy from Ip4 Config2 Protocol, \r
+  the default address is static. Otherwise, get the result from Ip4 Config2 Protocol.\r
 \r
-  @param[in]   Controller     The controller handle which has the NIC Ip4 Config Protocol\r
+  @param[in]   Controller     The controller handle which has the EFI_IP4_CONFIG2_PROTOCOL \r
                               relative with the default address to judge.\r
 \r
   @retval TRUE           If the default address is static.\r
@@ -2470,107 +2498,34 @@ NetLibDefaultAddressIsStatic (
   )\r
 {\r
   EFI_STATUS                       Status;\r
-  EFI_HII_CONFIG_ROUTING_PROTOCOL  *HiiConfigRouting;\r
-  UINTN                            Len;\r
-  NIC_IP4_CONFIG_INFO              *ConfigInfo;\r
+  EFI_IP4_CONFIG2_PROTOCOL         *Ip4Config2;\r
+  UINTN                            DataSize;  \r
+  EFI_IP4_CONFIG2_POLICY           Policy;\r
   BOOLEAN                          IsStatic;\r
-  EFI_STRING                       ConfigHdr;\r
-  EFI_STRING                       ConfigResp;\r
-  EFI_STRING                       AccessProgress;\r
-  EFI_STRING                       AccessResults;\r
-  EFI_STRING                       String;\r
-  EFI_HANDLE                       ChildHandle;\r
-\r
-  ConfigInfo       = NULL;\r
-  ConfigHdr        = NULL;\r
-  ConfigResp       = NULL;\r
-  AccessProgress   = NULL;\r
-  AccessResults    = NULL;\r
-  IsStatic         = TRUE;\r
-\r
-  Status = gBS->LocateProtocol (\r
-                  &gEfiHiiConfigRoutingProtocolGuid,\r
-                  NULL,\r
-                  (VOID **) &HiiConfigRouting\r
-                  );\r
-  if (EFI_ERROR (Status)) {\r
-    return TRUE;\r
-  }\r
 \r
-  Status = NetGetChildHandle (Controller, &ChildHandle);\r
-  if (EFI_ERROR (Status)) {\r
-    return TRUE;\r
-  }\r
+  Ip4Config2 = NULL;\r
+  \r
+  DataSize = sizeof (EFI_IP4_CONFIG2_POLICY);\r
+\r
+  IsStatic   = TRUE;\r
 \r
   //\r
-  // Construct config request string header\r
+  // Get Ip4Config2 policy.\r
   //\r
-  ConfigHdr = HiiConstructConfigHdr (&gEfiNicIp4ConfigVariableGuid, EFI_NIC_IP4_CONFIG_VARIABLE, ChildHandle);\r
-  if (ConfigHdr == NULL) {\r
-    return TRUE;\r
-  }\r
-\r
-  Len = StrLen (ConfigHdr);\r
-  ConfigResp = AllocateZeroPool ((Len + NIC_ITEM_CONFIG_SIZE * 2 + 100) * sizeof (CHAR16));\r
-  if (ConfigResp == NULL) {\r
-    goto ON_EXIT;\r
-  }\r
-  StrCpy (ConfigResp, ConfigHdr);\r
-\r
-  String = ConfigResp + Len;\r
-  UnicodeSPrint (\r
-    String,\r
-    (8 + 4 + 7 + 4 + 1) * sizeof (CHAR16),\r
-    L"&OFFSET=%04X&WIDTH=%04X",\r
-    OFFSET_OF (NIC_IP4_CONFIG_INFO, Source),\r
-    sizeof (UINT32)\r
-    );\r
-\r
-  Status = HiiConfigRouting->ExtractConfig (\r
-                               HiiConfigRouting,\r
-                               ConfigResp,\r
-                               &AccessProgress,\r
-                               &AccessResults\r
-                               );\r
+  Status = gBS->HandleProtocol (Controller, &gEfiIp4Config2ProtocolGuid, (VOID **) &Ip4Config2);\r
   if (EFI_ERROR (Status)) {\r
     goto ON_EXIT;\r
   }\r
 \r
-  ConfigInfo = AllocateZeroPool (NIC_ITEM_CONFIG_SIZE);\r
-  if (ConfigInfo == NULL) {\r
-    goto ON_EXIT;\r
-  }\r
-\r
-  ConfigInfo->Source = IP4_CONFIG_SOURCE_STATIC;\r
-  Len = NIC_ITEM_CONFIG_SIZE;\r
-  Status = HiiConfigRouting->ConfigToBlock (\r
-                               HiiConfigRouting,\r
-                               AccessResults,\r
-                               (UINT8 *) ConfigInfo,\r
-                               &Len,\r
-                               &AccessProgress\r
-                               );\r
+  Status = Ip4Config2->GetData (Ip4Config2, Ip4Config2DataTypePolicy, &DataSize, &Policy);\r
   if (EFI_ERROR (Status)) {\r
     goto ON_EXIT;\r
   }\r
-\r
-  IsStatic = (BOOLEAN) (ConfigInfo->Source == IP4_CONFIG_SOURCE_STATIC);\r
+  \r
+  IsStatic = (BOOLEAN) (Policy == Ip4Config2PolicyStatic);\r
 \r
 ON_EXIT:\r
-\r
-  if (AccessResults != NULL) {\r
-    FreePool (AccessResults);\r
-  }\r
-  if (ConfigInfo != NULL) {\r
-    FreePool (ConfigInfo);\r
-  }\r
-  if (ConfigResp != NULL) {\r
-    FreePool (ConfigResp);\r
-  }\r
-  if (ConfigHdr != NULL) {\r
-    FreePool (ConfigHdr);\r
-  }\r
-\r
+  \r
   return IsStatic;\r
 }\r
 \r
@@ -3175,7 +3130,110 @@ Exit:
   return Status;\r
 }\r
 \r
+/**\r
+\r
+  Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.\r
+  The text representation of address is defined in RFC 4291.\r
+  \r
+  @param[in]       Ip6Address     The pointer to the IPv6 address.\r
+  @param[out]      String         The buffer to return the converted string.\r
+  @param[in]       StringSize     The length in bytes of the input String.\r
+                                  \r
+  @retval EFI_SUCCESS             Convert to string successfully.\r
+  @retval EFI_INVALID_PARAMETER   The input parameter is invalid.\r
+  @retval EFI_BUFFER_TOO_SMALL    The BufferSize is too small for the result. BufferSize has been \r
+                                  updated with the size needed to complete the request.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibIp6ToStr (\r
+  IN         EFI_IPv6_ADDRESS      *Ip6Address,\r
+  OUT        CHAR16                *String,\r
+  IN         UINTN                 StringSize\r
+  )\r
+{\r
+  UINT16     Ip6Addr[8];\r
+  UINTN      Index;\r
+  UINTN      LongestZerosStart;\r
+  UINTN      LongestZerosLength;\r
+  UINTN      CurrentZerosStart;\r
+  UINTN      CurrentZerosLength;\r
+  CHAR16     Buffer[sizeof"ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff"];\r
+  CHAR16     *Ptr;\r
+\r
+  if (Ip6Address == NULL || String == NULL || StringSize == 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Convert the UINT8 array to an UINT16 array for easy handling.\r
+  // \r
+  ZeroMem (Ip6Addr, sizeof (Ip6Addr));\r
+  for (Index = 0; Index < 16; Index++) {\r
+    Ip6Addr[Index / 2] |= (Ip6Address->Addr[Index] << ((1 - (Index % 2)) << 3));\r
+  }\r
 \r
+  //\r
+  // Find the longest zeros and mark it.\r
+  //\r
+  CurrentZerosStart  = DEFAULT_ZERO_START;\r
+  CurrentZerosLength = 0;\r
+  LongestZerosStart  = DEFAULT_ZERO_START;\r
+  LongestZerosLength = 0;\r
+  for (Index = 0; Index < 8; Index++) {\r
+    if (Ip6Addr[Index] == 0) {\r
+      if (CurrentZerosStart == DEFAULT_ZERO_START) {\r
+        CurrentZerosStart = Index;\r
+        CurrentZerosLength = 1;\r
+      } else {\r
+        CurrentZerosLength++;\r
+      }\r
+    } else {\r
+      if (CurrentZerosStart != DEFAULT_ZERO_START) {\r
+        if (CurrentZerosLength > 2 && (LongestZerosStart == (DEFAULT_ZERO_START) || CurrentZerosLength > LongestZerosLength)) {\r
+          LongestZerosStart  = CurrentZerosStart;\r
+          LongestZerosLength = CurrentZerosLength;\r
+        }\r
+        CurrentZerosStart  = DEFAULT_ZERO_START;\r
+        CurrentZerosLength = 0;\r
+      }\r
+    }\r
+  }\r
+  \r
+  if (CurrentZerosStart != DEFAULT_ZERO_START && CurrentZerosLength > 2) {\r
+    if (LongestZerosStart == DEFAULT_ZERO_START || LongestZerosLength < CurrentZerosLength) {\r
+      LongestZerosStart  = CurrentZerosStart;\r
+      LongestZerosLength = CurrentZerosLength;\r
+    }\r
+  }\r
+\r
+  Ptr = Buffer;\r
+  for (Index = 0; Index < 8; Index++) {\r
+    if (LongestZerosStart != DEFAULT_ZERO_START && Index >= LongestZerosStart && Index < LongestZerosStart + LongestZerosLength) {\r
+      if (Index == LongestZerosStart) {\r
+        *Ptr++ = L':';\r
+      }\r
+      continue;\r
+    }\r
+    if (Index != 0) {\r
+      *Ptr++ = L':';\r
+    }\r
+    Ptr += UnicodeSPrint(Ptr, 10, L"%x", Ip6Addr[Index]);\r
+  }\r
+  \r
+  if (LongestZerosStart != DEFAULT_ZERO_START && LongestZerosStart + LongestZerosLength == 8) {\r
+    *Ptr++ = L':';\r
+  }\r
+  *Ptr = L'\0';\r
+\r
+  if ((UINTN)Ptr - (UINTN)Buffer > StringSize) {\r
+    return EFI_BUFFER_TOO_SMALL;\r
+  }\r
+\r
+  StrCpy (String, Buffer);\r
+\r
+  return EFI_SUCCESS;\r
+}\r
 \r
 /**\r
   This function obtains the system guid from the smbios table.\r