]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/Network/MnpDxe/ComponentName.c
BaseTools:Change the path of the file that Binary Cache
[mirror_edk2.git] / MdeModulePkg / Universal / Network / MnpDxe / ComponentName.c
index 2cd08413d1d6da632855860bd198fec37746e37e..fe85c3bc239b1d075a90b945470f97b9cefcb613 100644 (file)
@@ -1,25 +1,17 @@
 /** @file\r
   UEFI Component Name(2) protocol implementation for MnpDxe driver.\r
 \r
-Copyright (c) 2005 - 2007, Intel Corporation. <BR> \r
-All rights reserved. This program and the accompanying materials are licensed \r
-and made available under the terms and conditions of the BSD License which \r
-accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
-\r
-#include "MnpDriver.h"\r
-\r
+#include  "MnpImpl.h"\r
 \r
 //\r
 // EFI Component Name Protocol\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gMnpComponentName = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL   gMnpComponentName = {\r
   MnpComponentNameGetDriverName,\r
   MnpComponentNameGetControllerName,\r
   "eng"\r
@@ -28,14 +20,13 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gMnpComponentName = {
 //\r
 // EFI Component Name 2 Protocol\r
 //\r
-GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMnpComponentName2 = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL  gMnpComponentName2 = {\r
   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) MnpComponentNameGetDriverName,\r
   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) MnpComponentNameGetControllerName,\r
   "en"\r
 };\r
 \r
-\r
-GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE      mMnpDriverNameTable[] = {\r
   {\r
     "eng;en",\r
     L"MNP Network Service Driver"\r
@@ -46,6 +37,8 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = {
   }\r
 };\r
 \r
+GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE    *gMnpControllerNameTable = NULL;\r
+\r
 /**\r
   Retrieves a Unicode string that is the user readable name of the driver.\r
 \r
@@ -66,7 +59,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = {
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified\r
-                                in RFC 3066 or ISO 639-2 language code format.\r
+                                in RFC 4646 or ISO 639-2 language code format.\r
 \r
   @param[out]  DriverName       A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
@@ -88,9 +81,9 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMnpDriverNameTable[] = {
 EFI_STATUS\r
 EFIAPI\r
 MnpComponentNameGetDriverName (\r
-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
-  IN  CHAR8                        *Language,\r
-  OUT CHAR16                       **DriverName\r
+  IN     EFI_COMPONENT_NAME_PROTOCOL   *This,\r
+  IN     CHAR8                         *Language,\r
+     OUT CHAR16                        **DriverName\r
   )\r
 {\r
   return LookupUnicodeString2 (\r
@@ -102,6 +95,107 @@ MnpComponentNameGetDriverName (
            );\r
 }\r
 \r
+/**\r
+  Update the component name for the MNP child handle.\r
+\r
+  @param  Mnp[in]                 A pointer to the EFI_MANAGED_NETWORK_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_MANAGED_NETWORK_PROTOCOL     *Mnp\r
+  )\r
+{\r
+  EFI_STATUS                       Status;\r
+  MNP_INSTANCE_DATA                *Instance;\r
+  CHAR16                           HandleName[80];\r
+  EFI_MANAGED_NETWORK_CONFIG_DATA  MnpConfigData;\r
+  EFI_SIMPLE_NETWORK_MODE          SnpModeData;\r
+  UINTN                            OffSet;\r
+  UINTN                            Index;\r
+\r
+  if (Mnp == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Instance = MNP_INSTANCE_DATA_FROM_THIS (Mnp);\r
+  //\r
+  // Format the child name into the string buffer as:\r
+  // MNP (MAC=FF-FF-FF-FF-FF-FF, ProtocolType=0x0800, VlanId=0)\r
+  //\r
+  Status = Mnp->GetModeData (Mnp, &MnpConfigData, &SnpModeData);\r
+  if (!EFI_ERROR (Status)) {\r
+    OffSet = 0;\r
+    //\r
+    // Print the MAC address.\r
+    //\r
+    OffSet += UnicodeSPrint (\r
+                HandleName,\r
+                sizeof (HandleName),\r
+                L"MNP (MAC="\r
+                );\r
+    for (Index = 0; Index < SnpModeData.HwAddressSize; Index++) {\r
+      OffSet += UnicodeSPrint (\r
+                  HandleName + OffSet,\r
+                  sizeof (HandleName) - OffSet * sizeof (CHAR16),\r
+                  L"%02X-",\r
+                  SnpModeData.CurrentAddress.Addr[Index]\r
+                  );\r
+    }\r
+    ASSERT (OffSet > 0);\r
+    //\r
+    // Remove the last '-'\r
+    //\r
+    OffSet--;\r
+    //\r
+    // Print the ProtocolType and VLAN ID for this instance.\r
+    //\r
+    OffSet += UnicodeSPrint (\r
+                HandleName + OffSet,\r
+                sizeof (HandleName) - OffSet * sizeof (CHAR16),\r
+                L", ProtocolType=0x%X, VlanId=%d)",\r
+                MnpConfigData.ProtocolTypeFilter,\r
+                Instance->MnpServiceData->VlanId\r
+                );\r
+  } else if (Status == EFI_NOT_STARTED) {\r
+    UnicodeSPrint (\r
+      HandleName,\r
+      sizeof (HandleName),\r
+      L"MNP (Not started)"\r
+      );\r
+  } else {\r
+    return Status;\r
+  }\r
+\r
+  if (gMnpControllerNameTable != NULL) {\r
+    FreeUnicodeStringTable (gMnpControllerNameTable);\r
+    gMnpControllerNameTable = NULL;\r
+  }\r
+\r
+  Status = AddUnicodeString2 (\r
+             "eng",\r
+             gMnpComponentName.SupportedLanguages,\r
+             &gMnpControllerNameTable,\r
+             HandleName,\r
+             TRUE\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  return AddUnicodeString2 (\r
+           "en",\r
+           gMnpComponentName2.SupportedLanguages,\r
+           &gMnpControllerNameTable,\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
@@ -140,7 +234,7 @@ MnpComponentNameGetDriverName (
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified in\r
-                                RFC 3066 or ISO 639-2 language code format.\r
+                                RFC 4646 or ISO 639-2 language code format.\r
 \r
   @param[out]  ControllerName   A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
@@ -149,11 +243,11 @@ MnpComponentNameGetDriverName (
                                 Language from the point of view of the driver\r
                                 specified by This.\r
 \r
-  @retval EFI_SUCCESS           The Unicode string for the user readable name \r
+  @retval EFI_SUCCESS           The Unicode string for the user readable name\r
                                 specified by This, ControllerHandle, ChildHandle,\r
-                                                               and Language was returned in ControllerName.\r
+                                and Language was returned in ControllerName.\r
 \r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
 \r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
@@ -173,12 +267,75 @@ MnpComponentNameGetDriverName (
 EFI_STATUS\r
 EFIAPI\r
 MnpComponentNameGetControllerName (\r
-  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
-  IN  EFI_HANDLE                                      ControllerHandle,\r
-  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
-  IN  CHAR8                                           *Language,\r
-  OUT CHAR16                                          **ControllerName\r
+  IN     EFI_COMPONENT_NAME_PROTOCOL   *This,\r
+  IN     EFI_HANDLE                    ControllerHandle,\r
+  IN     EFI_HANDLE                    ChildHandle        OPTIONAL,\r
+  IN     CHAR8                         *Language,\r
+     OUT CHAR16                        **ControllerName\r
   )\r
 {\r
-  return EFI_UNSUPPORTED;\r
+  EFI_STATUS                    Status;\r
+  EFI_MANAGED_NETWORK_PROTOCOL  *Mnp;\r
+\r
+  //\r
+  // Only provide names for MNP child handles.\r
+  //\r
+  if (ChildHandle == NULL) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
+  //\r
+  // Make sure this driver is currently managing ControllerHandle\r
+  //\r
+  Status = EfiTestManagedDevice (\r
+             ControllerHandle,\r
+             gMnpDriverBinding.DriverBindingHandle,\r
+             &gEfiSimpleNetworkProtocolGuid\r
+             );\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  //\r
+  // Make sure this driver produced ChildHandle\r
+  //\r
+  Status = EfiTestChildHandle (\r
+             ControllerHandle,\r
+             ChildHandle,\r
+             &gEfiManagedNetworkServiceBindingProtocolGuid\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
+                  &gEfiManagedNetworkProtocolGuid,\r
+                  (VOID **)&Mnp,\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 (Mnp);\r
+  if (EFI_ERROR (Status)) {\r
+    return Status;\r
+  }\r
+\r
+  return LookupUnicodeString2 (\r
+           Language,\r
+           This->SupportedLanguages,\r
+           gMnpControllerNameTable,\r
+           ControllerName,\r
+           (BOOLEAN)(This == &gMnpComponentName)\r
+           );\r
 }\r