X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FComponentName2.h;h=b4e8a4d9a4a5587af43d690c151ba765edc2bc37;hb=5ca4bb9f62376d81e05e6ed2ecc14a3c69a9536d;hp=7cec01699e0178955c4de48681b6ae7e5a2036ae;hpb=4ca9b6c4e7dbbcf94f21b54f41f761cefc6b1086;p=mirror_edk2.git
diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index 7cec01699e..b4e8a4d9a4 100644
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -3,8 +3,8 @@
This protocol is used to retrieve user readable names of drivers
and controllers managed by UEFI Drivers.
- Copyright (c) 2006 - 2008, Intel Corporation
- All rights reserved. This program and the accompanying materials
+ Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
+ This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
@@ -17,11 +17,9 @@
#ifndef __EFI_COMPONENT_NAME2_H__
#define __EFI_COMPONENT_NAME2_H__
-#include
-
-//
-// Global ID for the Component Name Protocol
-//
+///
+/// Global ID for the Component Name Protocol
+///
#define EFI_COMPONENT_NAME2_PROTOCOL_GUID \
{0x6a7a5cff, 0xe8d9, 0x4f70, { 0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14 } }
@@ -29,7 +27,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL;
/**
- Retrieves a Unicode string that is the user readable name of
+ Retrieves a string that is the user readable name of
the EFI Driver.
@param This A pointer to the
@@ -42,15 +40,15 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL;
languages specified in SupportedLanguages.
The number of languages supported by a
driver is up to the driver writer. Language
- is specified in RFC 3066 language code
+ is specified in RFC 4646 language code
format.
- @param DriverName A pointer to the Unicode string to return.
- This Unicode string is the name of the
+ @param DriverName A pointer to the string to return.
+ This string is the name of the
driver specified by This in the language
specified by Language.
- @retval EFI_SUCCESS The Unicode string for the
+ @retval EFI_SUCCESS The string for the
Driver specified by This and the
language specified by Language
was returned in DriverName.
@@ -74,7 +72,7 @@ EFI_STATUS
/**
- Retrieves a Unicode string that is the user readable name of
+ Retrieves a string that is the user readable name of
the controller that is being managed by an EFI Driver.
@param This A pointer to the
@@ -85,11 +83,11 @@ EFI_STATUS
This handle specifies the controller
whose name is to be returned.
- @param ChildHandle The handle of the child controller to
+ @param ChildHandle The handle of the child controller to
retrieve the name of. This is an
optional parameter that may be NULL.
It will be NULL for device drivers.
- It will also be NULL for a bus
+ It will also be NULL for bus
drivers that wish to retrieve the
name of the bus controller. It will
not be NULL for a bus driver that
@@ -105,25 +103,23 @@ EFI_STATUS
SupportedLanguages. The number of
languages supported by a driver is up
to the driver writer. Language is
- specified in RFC 3066 language code
+ specified in RFC 4646 language code
format.
- @param ControllerName A pointer to the Unicode string to
- return. This Unicode string is the
- name of the controller specified by
- ControllerHandle and ChildHandle in
- the language specified by Language
+ @param ControllerName A pointer to the string to return.
+ This string is the name of the controller
+ specified by ControllerHandle and ChildHandle
+ in the language specified by Language
from the point of view of the driver
specified by This.
- @retval EFI_SUCCESS The Unicode string for the user
+ @retval EFI_SUCCESS The string for the user
readable name in the language
specified by Language for the
driver specified by This was
returned in DriverName.
- @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid
- EFI_HANDLE.
+ @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it
is not a valid EFI_HANDLE.
@@ -153,32 +149,21 @@ EFI_STATUS
OUT CHAR16 **ControllerName
);
-//
-// Interface structure for the Component Name2 Protocol
-//
-/**
- @par Protocol Description:
- This protocol is used to retrieve user readable names of drivers
- and controllers managed by UEFI Drivers.
-
- @param GetDriverName
- Retrieves a Unicode string that is the user readable name of the driver.
-
- @param GetControllerName
- Retrieves a Unicode string that is the user readable name of a
- controller that is being managed by a driver.
-
- @param SupportedLanguages
- A Null-terminated ASCII string array that contains one or more
- supported language codes. This is the list of language codes that
- this protocol supports. The number of languages supported by a
- driver is up to the driver writer. SupportedLanguages is
- specified in RFC 3066 format.
-
-**/
+///
+/// This protocol is used to retrieve user readable names of drivers
+/// and controllers managed by UEFI Drivers.
+///
struct _EFI_COMPONENT_NAME2_PROTOCOL {
EFI_COMPONENT_NAME2_GET_DRIVER_NAME GetDriverName;
EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME GetControllerName;
+
+ ///
+ /// A Null-terminated ASCII string array that contains one or more
+ /// supported language codes. This is the list of language codes that
+ /// this protocol supports. The number of languages supported by a
+ /// driver is up to the driver writer. SupportedLanguages is
+ /// specified in RFC 4646 format.
+ ///
CHAR8 *SupportedLanguages;
};