Filter
Top Products
Protocols — EFI Driver Model
Version 1.10 12/01/02 9-47
9.6 EFI Component Name Protocol
This section provides a detailed description of the EFI_COMPONENT_NAME_PROTOCOL. This is
a protocol that allows an EFI Driver to provide a user readable name of an EFI Driver, and a user
readable name for each of the controllers that the EFI Driver is managing. This protocol is used by
platform management utilities that wish to display names of components. These names may
include the names of expansion slots, external connectors, embedded devices, and add-in devices.
EFI_COMPONENT_NAME_PROTOCOL
Summary
Used to retrieve user readable names of EFI Drivers and controllers managed by EFI Drivers.
GUID
#define EFI_COMPONENT_NAME_PROTOCOL_GUID \
{ 0x107a772c,0xd5e1,0x11d4,0x9a,0x46,0x0,0x90,0x27,0x3f,0xc1,0x4d }
Protocol Interface Structure
typedef struct _EFI_COMPONENT_NAME_PROTOCOL {
EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName;
EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName;
CHAR8 *SupportedLanguages;
} EFI_COMPONENT_NAME_PROTOCOL;
Parameters
GetDriverName Retrieves a Unicode string that is the user readable name of the
EFI Driver. See the GetDriverName()
function description.
GetControllerName Retrieves a Unicode string that is the user readable name of a
controller that is being managed by an EFI Driver. See the
GetControllerName()
function description.
SupportedLanguages A Null-terminated ASCII string that contains one or more
ISO 639-2 language codes. This is the list of language codes
that this protocol supports.
Description
The EFI_COMPONENT_NAME_PROTOCOL is used retrieve a driver’s user readable name and the
names of all the controllers that a driver is managing from the driver’s point of view. Each of these
names is returned as a Null-terminated Unicode string. The caller is required to specify the
language in which the Unicode string is returned, and this language must be present in the list of
languages that this protocol supports specified by SupportedLanguages.