Update to support to produce Component Name and & Component Name 2 protocol based on Feature flag PcdComponentNameDisable & PcdComponentName2Disable.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4003 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8 2007-09-30 03:01:48 +00:00
parent 62b9bb55c9
commit d38a0f446f
6 changed files with 433 additions and 191 deletions

View File

@ -17,15 +17,25 @@
// //
// EFI Component Name Protocol // EFI Component Name Protocol
// //
EFI_COMPONENT_NAME_PROTOCOL gDiskIoComponentName = { EFI_COMPONENT_NAME_PROTOCOL gDiskIoComponentName = {
DiskIoComponentNameGetDriverName, DiskIoComponentNameGetDriverName,
DiskIoComponentNameGetControllerName, DiskIoComponentNameGetControllerName,
"eng" "eng"
}; };
//
// EFI Component Name 2 Protocol
//
EFI_COMPONENT_NAME2_PROTOCOL gDiskIoComponentName2 = {
(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) DiskIoComponentNameGetDriverName,
(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) DiskIoComponentNameGetControllerName,
"en"
};
static EFI_UNICODE_STRING_TABLE mDiskIoDriverNameTable[] = { static EFI_UNICODE_STRING_TABLE mDiskIoDriverNameTable[] = {
{ {
"eng", "eng;en",
(CHAR16 *)L"Generic Disk I/O Driver" (CHAR16 *)L"Generic Disk I/O Driver"
}, },
{ {
@ -37,40 +47,43 @@ static EFI_UNICODE_STRING_TABLE mDiskIoDriverNameTable[] = {
/** /**
Retrieves a Unicode string that is the user readable name of Retrieves a Unicode string that is the user readable name of the driver.
the EFI Driver.
@param This A pointer to the This function retrieves the user readable name of a driver in the form of a
EFI_COMPONENT_NAME_PROTOCOL instance. Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
@param Language A pointer to a Null-terminated ASCII string returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
array indicating the language. This is the by This does not support the language specified by Language,
language of the driver name that the caller then EFI_UNSUPPORTED is returned.
is requesting, and it must match one of the
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
format.
@param DriverName A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
Driver specified by This and the EFI_COMPONENT_NAME_PROTOCOL instance.
language specified by Language
was returned in DriverName. @param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
@retval EFI_INVALID_PARAMETER Language is NULL. language of the driver name that the caller is
requesting, and it must match one of the
@retval EFI_INVALID_PARAMETER DriverName is NULL. languages specified in SupportedLanguages. The
number of languages supported by a driver is up
@retval EFI_UNSUPPORTED The driver specified by This to the driver writer. Language is specified
does not support the language in RFC 3066 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language. specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
@ -80,84 +93,83 @@ DiskIoComponentNameGetDriverName (
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
) )
{ {
return LookupUnicodeString ( return LookupUnicodeString2 (
Language, Language,
gDiskIoComponentName.SupportedLanguages, This->SupportedLanguages,
mDiskIoDriverNameTable, mDiskIoDriverNameTable,
DriverName DriverName,
(BOOLEAN)(This == &gDiskIoComponentName)
); );
} }
/** /**
Retrieves a Unicode string that is the user readable name of Retrieves a Unicode string that is the user readable name of the controller
the controller that is being managed by an EFI Driver. that is being managed by a driver.
@param This A pointer to the This function retrieves the user readable name of the controller specified by
EFI_COMPONENT_NAME_PROTOCOL instance. ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param ControllerHandle The handle of a controller that the @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
driver specified by This is managing. EFI_COMPONENT_NAME_PROTOCOL instance.
This handle specifies the controller
whose name is to be returned.
@param ChildHandle The handle of the child controller to @param ControllerHandle[in] The handle of a controller that the driver
retrieve the name of. This is an specified by This is managing. This handle
optional parameter that may be NULL. specifies the controller whose name is to be
It will be NULL for device drivers. returned.
It will also be NULL for a bus
drivers that wish to retrieve the
name of the bus controller. It will
not be NULL for a bus driver that
wishes to retrieve the name of a
child controller.
@param Language A pointer to a Null-terminated ASCII @param ChildHandle[in] The handle of the child controller to retrieve
string array indicating the language. the name of. This is an optional parameter that
This is the language of the driver may be NULL. It will be NULL for device
name that the caller is requesting, drivers. It will also be NULL for a bus drivers
and it must match one of the that wish to retrieve the name of the bus
languages specified in controller. It will not be NULL for a bus
SupportedLanguages. The number of driver that wishes to retrieve the name of a
languages supported by a driver is up child controller.
to the driver writer. Language is
specified in RFC 3066 language code
format.
@param ControllerName A pointer to the Unicode string to @param Language[in] A pointer to a Null-terminated ASCII string
return. This Unicode string is the array indicating the language. This is the
name of the controller specified by language of the driver name that the caller is
ControllerHandle and ChildHandle in requesting, and it must match one of the
the language specified by Language languages specified in SupportedLanguages. The
from the point of view of the driver number of languages supported by a driver is up
specified by This. to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
@retval EFI_SUCCESS The Unicode string for the user @param ControllerName[out] A pointer to the Unicode string to return.
readable name in the language This Unicode string is the name of the
specified by Language for the controller specified by ControllerHandle and
driver specified by This was ChildHandle in the language specified by
returned in DriverName. Language from the point of view of the driver
specified by This.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid @retval EFI_SUCCESS The Unicode 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 ChildHandle is not NULL and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it
is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL. @retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is @retval EFI_UNSUPPORTED The driver specified by This is not currently
not currently managing the managing the controller specified by
controller specified by ControllerHandle and ChildHandle.
ControllerHandle and
ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This @retval EFI_UNSUPPORTED The driver specified by This does not support
does not support the language the language specified by Language.
specified by Language.
**/ **/
EFI_STATUS EFI_STATUS

View File

@ -720,14 +720,13 @@ InitializeDiskIo (
// //
// Install driver model protocol(s). // Install driver model protocol(s).
// //
Status = EfiLibInstallAllDriverProtocols ( Status = EfiLibInstallDriverBindingComponentName2 (
ImageHandle, ImageHandle,
SystemTable, SystemTable,
&gDiskIoDriverBinding, &gDiskIoDriverBinding,
ImageHandle, ImageHandle,
&gDiskIoComponentName, &gDiskIoComponentName,
NULL, &gDiskIoComponentName2
NULL
); );
ASSERT_EFI_ERROR (Status); ASSERT_EFI_ERROR (Status);

View File

@ -45,8 +45,9 @@ typedef struct {
// //
// Global Variables // Global Variables
// //
extern EFI_DRIVER_BINDING_PROTOCOL gDiskIoDriverBinding; extern EFI_DRIVER_BINDING_PROTOCOL gDiskIoDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL gDiskIoComponentName; extern EFI_COMPONENT_NAME_PROTOCOL gDiskIoComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gDiskIoComponentName2;
// //
// Prototypes // Prototypes
@ -103,6 +104,45 @@ DiskIoWriteDisk (
// //
// EFI Component Name Functions // EFI Component Name Functions
// //
/**
Retrieves a Unicode string that is the user readable name of the driver.
This function retrieves the user readable name of a driver in the form of a
Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 3066 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
DiskIoComponentNameGetDriverName ( DiskIoComponentNameGetDriverName (
@ -111,6 +151,75 @@ DiskIoComponentNameGetDriverName (
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
); );
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by a driver.
This function retrieves the user readable name of the controller specified by
ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
@param ChildHandle[in] 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 drivers
that wish to retrieve the name of the bus
controller. It will not be NULL for a bus
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
@param ControllerName[out] 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 from the point of view of the driver
specified by This.
@retval EFI_SUCCESS The Unicode 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 ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
DiskIoComponentNameGetControllerName ( DiskIoComponentNameGetControllerName (
@ -121,4 +230,5 @@ DiskIoComponentNameGetControllerName (
OUT CHAR16 **ControllerName OUT CHAR16 **ControllerName
); );
#endif #endif

View File

@ -17,15 +17,25 @@
// //
// EFI Component Name Protocol // EFI Component Name Protocol
// //
EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName = { EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName = {
PartitionComponentNameGetDriverName, PartitionComponentNameGetDriverName,
PartitionComponentNameGetControllerName, PartitionComponentNameGetControllerName,
"eng" "eng"
}; };
//
// EFI Component Name 2 Protocol
//
EFI_COMPONENT_NAME2_PROTOCOL gPartitionComponentName2 = {
(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) PartitionComponentNameGetDriverName,
(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) PartitionComponentNameGetControllerName,
"en"
};
static EFI_UNICODE_STRING_TABLE mPartitionDriverNameTable[] = { static EFI_UNICODE_STRING_TABLE mPartitionDriverNameTable[] = {
{ {
"eng", "eng;en",
(CHAR16 *)L"Partition Driver(MBR/GPT/El Torito)" (CHAR16 *)L"Partition Driver(MBR/GPT/El Torito)"
}, },
{ {
@ -37,40 +47,43 @@ static EFI_UNICODE_STRING_TABLE mPartitionDriverNameTable[] = {
/** /**
Retrieves a Unicode string that is the user readable name of Retrieves a Unicode string that is the user readable name of the driver.
the EFI Driver.
@param This A pointer to the This function retrieves the user readable name of a driver in the form of a
EFI_COMPONENT_NAME_PROTOCOL instance. Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
@param Language A pointer to a Null-terminated ASCII string returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
array indicating the language. This is the by This does not support the language specified by Language,
language of the driver name that the caller then EFI_UNSUPPORTED is returned.
is requesting, and it must match one of the
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
format.
@param DriverName A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
Driver specified by This and the EFI_COMPONENT_NAME_PROTOCOL instance.
language specified by Language
was returned in DriverName. @param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
@retval EFI_INVALID_PARAMETER Language is NULL. language of the driver name that the caller is
requesting, and it must match one of the
@retval EFI_INVALID_PARAMETER DriverName is NULL. languages specified in SupportedLanguages. The
number of languages supported by a driver is up
@retval EFI_UNSUPPORTED The driver specified by This to the driver writer. Language is specified
does not support the language in RFC 3066 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language. specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
@ -80,83 +93,82 @@ PartitionComponentNameGetDriverName (
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
) )
{ {
return LookupUnicodeString ( return LookupUnicodeString2 (
Language, Language,
gPartitionComponentName.SupportedLanguages, This->SupportedLanguages,
mPartitionDriverNameTable, mPartitionDriverNameTable,
DriverName DriverName,
); (BOOLEAN)(This == &gPartitionComponentName)
);
} }
/** /**
Retrieves a Unicode string that is the user readable name of Retrieves a Unicode string that is the user readable name of the controller
the controller that is being managed by an EFI Driver. that is being managed by a driver.
@param This A pointer to the This function retrieves the user readable name of the controller specified by
EFI_COMPONENT_NAME_PROTOCOL instance. ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param ControllerHandle The handle of a controller that the @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
driver specified by This is managing. EFI_COMPONENT_NAME_PROTOCOL instance.
This handle specifies the controller
whose name is to be returned.
@param ChildHandle The handle of the child controller to @param ControllerHandle[in] The handle of a controller that the driver
retrieve the name of. This is an specified by This is managing. This handle
optional parameter that may be NULL. specifies the controller whose name is to be
It will be NULL for device drivers. returned.
It will also be NULL for a bus
drivers that wish to retrieve the
name of the bus controller. It will
not be NULL for a bus driver that
wishes to retrieve the name of a
child controller.
@param Language A pointer to a Null-terminated ASCII @param ChildHandle[in] The handle of the child controller to retrieve
string array indicating the language. the name of. This is an optional parameter that
This is the language of the driver may be NULL. It will be NULL for device
name that the caller is requesting, drivers. It will also be NULL for a bus drivers
and it must match one of the that wish to retrieve the name of the bus
languages specified in controller. It will not be NULL for a bus
SupportedLanguages. The number of driver that wishes to retrieve the name of a
languages supported by a driver is up child controller.
to the driver writer. Language is
specified in RFC 3066 language code
format.
@param ControllerName A pointer to the Unicode string to @param Language[in] A pointer to a Null-terminated ASCII string
return. This Unicode string is the array indicating the language. This is the
name of the controller specified by language of the driver name that the caller is
ControllerHandle and ChildHandle in requesting, and it must match one of the
the language specified by Language languages specified in SupportedLanguages. The
from the point of view of the driver number of languages supported by a driver is up
specified by This. to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
@retval EFI_SUCCESS The Unicode string for the user @param ControllerName[out] A pointer to the Unicode string to return.
readable name in the language This Unicode string is the name of the
specified by Language for the controller specified by ControllerHandle and
driver specified by This was ChildHandle in the language specified by
returned in DriverName. Language from the point of view of the driver
specified by This.
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid @retval EFI_SUCCESS The Unicode 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 ChildHandle is not NULL and it is not a valid
EFI_HANDLE. EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it
is not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL. @retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is @retval EFI_UNSUPPORTED The driver specified by This is not currently
not currently managing the managing the controller specified by
controller specified by ControllerHandle and ChildHandle.
ControllerHandle and
ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This @retval EFI_UNSUPPORTED The driver specified by This does not support
does not support the language the language specified by Language.
specified by Language.
**/ **/
EFI_STATUS EFI_STATUS

View File

@ -695,14 +695,13 @@ InitializePartition (
// //
// Install driver model protocol(s). // Install driver model protocol(s).
// //
Status = EfiLibInstallAllDriverProtocols ( Status = EfiLibInstallDriverBindingComponentName2 (
ImageHandle, ImageHandle,
SystemTable, SystemTable,
&gPartitionDriverBinding, &gPartitionDriverBinding,
ImageHandle, ImageHandle,
&gPartitionComponentName, &gPartitionComponentName,
NULL, &gPartitionComponentName2
NULL
); );
ASSERT_EFI_ERROR (Status); ASSERT_EFI_ERROR (Status);

View File

@ -65,8 +65,9 @@ typedef struct {
// //
// Global Variables // Global Variables
// //
extern EFI_DRIVER_BINDING_PROTOCOL gPartitionDriverBinding; extern EFI_DRIVER_BINDING_PROTOCOL gPartitionDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName; extern EFI_COMPONENT_NAME_PROTOCOL gPartitionComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gPartitionComponentName2;
// //
// Extract INT32 from char array // Extract INT32 from char array
@ -115,6 +116,45 @@ PartitionDriverBindingStop (
// //
// EFI Component Name Functions // EFI Component Name Functions
// //
/**
Retrieves a Unicode string that is the user readable name of the driver.
This function retrieves the user readable name of a driver in the form of a
Unicode string. If the driver specified by This has a user readable name in
the language specified by Language, then a pointer to the driver name is
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
by This does not support the language specified by Language,
then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified
in RFC 3066 or ISO 639-2 language code format.
@param DriverName[out] A pointer to the Unicode string to return.
This Unicode string is the name of the
driver specified by This in the language
specified by Language.
@retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was
returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PartitionComponentNameGetDriverName ( PartitionComponentNameGetDriverName (
@ -123,6 +163,75 @@ PartitionComponentNameGetDriverName (
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
); );
/**
Retrieves a Unicode string that is the user readable name of the controller
that is being managed by a driver.
This function retrieves the user readable name of the controller specified by
ControllerHandle and ChildHandle in the form of a Unicode string. If the
driver specified by This has a user readable name in the language specified by
Language, then a pointer to the controller name is returned in ControllerName,
and EFI_SUCCESS is returned. If the driver specified by This is not currently
managing the controller specified by ControllerHandle and ChildHandle,
then EFI_UNSUPPORTED is returned. If the driver specified by This does not
support the language specified by Language, then EFI_UNSUPPORTED is returned.
@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
EFI_COMPONENT_NAME_PROTOCOL instance.
@param ControllerHandle[in] The handle of a controller that the driver
specified by This is managing. This handle
specifies the controller whose name is to be
returned.
@param ChildHandle[in] 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 drivers
that wish to retrieve the name of the bus
controller. It will not be NULL for a bus
driver that wishes to retrieve the name of a
child controller.
@param Language[in] A pointer to a Null-terminated ASCII string
array indicating the language. This is the
language of the driver name that the caller is
requesting, and it must match one of the
languages specified in SupportedLanguages. The
number of languages supported by a driver is up
to the driver writer. Language is specified in
RFC 3066 or ISO 639-2 language code format.
@param ControllerName[out] 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 from the point of view of the driver
specified by This.
@retval EFI_SUCCESS The Unicode 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 ChildHandle is not NULL and it is not a valid
EFI_HANDLE.
@retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
@retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by
ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
PartitionComponentNameGetControllerName ( PartitionComponentNameGetControllerName (
@ -133,6 +242,7 @@ PartitionComponentNameGetControllerName (
OUT CHAR16 **ControllerName OUT CHAR16 **ControllerName
); );
EFI_STATUS EFI_STATUS
PartitionInstallChildHandle ( PartitionInstallChildHandle (
IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_DRIVER_BINDING_PROTOCOL *This,