1. Add EFI_COMPONENT_NAME2_PROTOCOL.GetControllerName() support.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / ComponentName.c

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c
index d3fcf048fceaa6d34a86fbc54e2ef9dcaa07b781..2ccfb3cc1ce6edc49d3198db92d532ddb3c3abe3 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/ComponentName.c
@@ -1,6 +1,6 @@
 /** @file\r
   \r
-Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2005 - 2012, 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<BR>\r
@@ -173,6 +173,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIp4DriverNameTable[] = {
   }\r
 };\r
 \r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  *gIp4ControllerNameTable = NULL;\r
+\r
 /**\r
   Retrieves a Unicode string that is the user readable name of the driver.\r
 \r
@@ -230,6 +232,74 @@ Ip4ComponentNameGetDriverName (
 \r
 }\r
 \r
+/**\r
+  Update the component name for the IP4 child handle.\r
+\r
+  @param  Ip4[in]                 A pointer to the EFI_IP4_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_IP4_PROTOCOL         *Ip4\r
+  )\r
+{\r
+  EFI_STATUS                       Status;\r
+  CHAR16                           HandleName[80];\r
+  EFI_IP4_MODE_DATA                Ip4ModeData;\r
+\r
+  if (Ip4 == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Format the child name into the string buffer as:\r
+  // IPv4 (SrcIP=127.0.0.1, DestIP=127.0.0.1)\r
+  //\r
+  Status = Ip4->GetModeData (Ip4, &Ip4ModeData, NULL, NULL);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  if (!Ip4ModeData.IsStarted || !Ip4ModeData.IsConfigured) {\r
+    UnicodeSPrint (HandleName, sizeof (HandleName), L"IPv4 (Not started)");\r
+  } else {\r
+    UnicodeSPrint (HandleName, sizeof (HandleName),\r
+      L"IPv4 (SrcIP=%d.%d.%d.%d)",\r
+      Ip4ModeData.ConfigData.StationAddress.Addr[0],\r
+      Ip4ModeData.ConfigData.StationAddress.Addr[1],\r
+      Ip4ModeData.ConfigData.StationAddress.Addr[2],\r
+      Ip4ModeData.ConfigData.StationAddress.Addr[3]\r
+      );\r
+  }\r
+\r
+  if (gIp4ControllerNameTable != NULL) {\r
+    FreeUnicodeStringTable (gIp4ControllerNameTable);\r
+    gIp4ControllerNameTable = NULL;\r
+  }\r
+  Status = AddUnicodeString2 (\r
+             "eng",\r
+             gIp4ComponentName.SupportedLanguages,\r
+             &gIp4ControllerNameTable,\r
+             HandleName,\r
+             TRUE\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+  \r
+  return AddUnicodeString2 (\r
+           "en",\r
+           gIp4ComponentName2.SupportedLanguages,\r
+           &gIp4ControllerNameTable,\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
@@ -308,5 +378,57 @@ Ip4ComponentNameGetControllerName (
   OUT CHAR16                                          **ControllerName\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  EFI_STATUS                    Status;  \r
+  EFI_IP4_PROTOCOL              *Ip4;\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
+             &gEfiManagedNetworkProtocolGuid\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
+                  &gEfiIp4ProtocolGuid,\r
+                  (VOID **)&Ip4,\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 (Ip4);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  return LookupUnicodeString2 (\r
+           Language,\r
+           This->SupportedLanguages,\r
+           gIp4ControllerNameTable,\r
+           ControllerName,\r
+           (BOOLEAN)(This == &gIp4ComponentName)\r
+           );\r
 }\r
+\r