1. Add EFI_COMPONENT_NAME2_PROTOCOL.GetControllerName() support.

[mirror_edk2.git] / NetworkPkg / Udp6Dxe / ComponentName.c

diff --git a/NetworkPkg/Udp6Dxe/ComponentName.c b/NetworkPkg/Udp6Dxe/ComponentName.c
index 25114651871dc352770f1e9ac3a1383f5422d594..93c2003f348e89eaaa31c286517b05571fac3827 100644 (file)
--- a/NetworkPkg/Udp6Dxe/ComponentName.c
+++ b/NetworkPkg/Udp6Dxe/ComponentName.c
@@ -1,7 +1,7 @@
 /** @file\r
   UEFI Component Name(2) protocol implementation for UDP6 driver.\r
 \r
 /** @file\r
   UEFI Component Name(2) protocol implementation for UDP6 driver.\r
 \r

-  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r

 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r


@@ -174,6 +174,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUdp6DriverNameTable[] =
   }\r
 };\r
 \r
   }\r
 };\r
 \r

+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  *gUdp6ControllerNameTable = NULL;\r
+\r

 /**\r
   Retrieves a Unicode string that is the user-readable name of the driver.\r
 \r
 /**\r
   Retrieves a Unicode string that is the user-readable name of the driver.\r
 \r


@@ -230,6 +232,70 @@ Udp6ComponentNameGetDriverName (
            );\r
 }\r
 \r
            );\r
 }\r
 \r

+/**\r
+  Update the component name for the Udp6 child handle.\r
+\r
+  @param  Udp6[in]                  A pointer to the EFI_UDP6_PROTOCOL.\r
+\r
+  \r
+  @retval EFI_SUCCESS               Update the ControllerNameTable of this instance successfully.\r
+  @retval EFI_INVALID_PARAMETER     The input parameter is invalid.\r
+  \r
+**/\r
+EFI_STATUS\r
+UpdateName (\r
+  IN    EFI_UDP6_PROTOCOL             *Udp6\r
+  )\r
+{\r
+  EFI_STATUS                       Status;\r
+  CHAR16                           HandleName[64];\r
+  EFI_UDP6_CONFIG_DATA             Udp6ConfigData;\r
+\r
+  if (Udp6 == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Format the child name into the string buffer.\r
+  //\r
+  Status = Udp6->GetModeData (Udp6, &Udp6ConfigData, NULL, NULL, NULL);\r
+  if (!EFI_ERROR (Status)) {\r
+    UnicodeSPrint (HandleName, sizeof (HandleName),\r
+      L"UDPv6 (SrcPort=%d, DestPort=%d)",\r
+      Udp6ConfigData.StationPort,\r
+      Udp6ConfigData.RemotePort\r
+      );\r
+  } else if (Status == EFI_NOT_STARTED) {\r
+    UnicodeSPrint (HandleName, sizeof (HandleName), L"UDPv6 (Not started)");\r
+  } else {\r
+    UnicodeSPrint (HandleName, sizeof (HandleName), L"UDPv6 (%r)", Status);\r
+  }\r
+\r
+  if (gUdp6ControllerNameTable != NULL) {\r
+    FreeUnicodeStringTable (gUdp6ControllerNameTable);\r
+    gUdp6ControllerNameTable = NULL;\r
+  }\r
+\r
+  Status = AddUnicodeString2 (\r
+             "eng",\r
+             gUdp6ComponentName.SupportedLanguages,\r
+             &gUdp6ControllerNameTable,\r
+             HandleName,\r
+             TRUE\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  return AddUnicodeString2 (\r
+           "en",\r
+           gUdp6ComponentName2.SupportedLanguages,\r
+           &gUdp6ControllerNameTable,\r
+           HandleName,\r
+           FALSE\r
+           );\r
+}\r
+\r

 /**\r
   Retrieves a Unicode string that is the user-readable name of the controller\r
   that is being managed by a driver.\r
 /**\r
   Retrieves a Unicode string that is the user-readable name of the controller\r
   that is being managed by a driver.\r


@@ -308,6 +374,56 @@ Udp6ComponentNameGetControllerName (
   OUT CHAR16                       **ControllerName\r
   )\r
 {\r
   OUT CHAR16                       **ControllerName\r
   )\r
 {\r

-  return EFI_UNSUPPORTED;\r
-}\r
+  EFI_STATUS                    Status;\r
+  EFI_UDP6_PROTOCOL             *Udp6;\r
+\r
+  //\r
+  // Only provide names for child handles.\r
+  //\r
+  if (ChildHandle == NULL) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
+  //\r
+  // Make sure this driver produced ChildHandle\r
+  //\r
+  Status = EfiTestChildHandle (\r
+             ControllerHandle,\r
+             ChildHandle,\r
+             &gEfiIp6ProtocolGuid\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Retrieve an instance of a produced protocol from ChildHandle\r
+  //\r
+  Status = gBS->OpenProtocol (\r
+                  ChildHandle,\r
+                  &gEfiUdp6ProtocolGuid,\r
+                  (VOID **)&Udp6,\r
+                  NULL,\r
+                  NULL,\r
+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Update the component name for this child handle.\r
+  //\r
+  Status = UpdateName (Udp6);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r

 \r
 \r

+  return LookupUnicodeString2 (\r
+           Language,\r
+           This->SupportedLanguages,\r
+           gUdp6ControllerNameTable,\r
+           ControllerName,\r
+           (BOOLEAN)(This == &gUdp6ComponentName)\r
+           );\r
+}\r