/** @file\r
UEFI Component Name(2) protocol implementation for UDP6 driver.\r
\r
- Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ Copyright (c) 2009 - 2018, 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
- which 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
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
driver specified by This was returned in\r
DriverName.\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
}\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
}\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
driver specified by This was returned in\r
DriverName.\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
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
+ return LookupUnicodeString2 (\r
+ Language,\r
+ This->SupportedLanguages,\r
+ gUdp6ControllerNameTable,\r
+ ControllerName,\r
+ (BOOLEAN)(This == &gUdp6ComponentName)\r
+ );\r
+}\r