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@3991 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qhuang8
2007-09-29 11:22:46 +00:00
parent f766bd800a
commit e6e53c97c9
3 changed files with 248 additions and 80 deletions

View File

@ -48,6 +48,45 @@ Abstract:
// //
// 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
WinNtGopComponentNameGetDriverName ( WinNtGopComponentNameGetDriverName (
@ -56,6 +95,75 @@ WinNtGopComponentNameGetDriverName (
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
WinNtGopComponentNameGetControllerName ( WinNtGopComponentNameGetControllerName (
@ -66,6 +174,7 @@ WinNtGopComponentNameGetControllerName (
OUT CHAR16 **ControllerName OUT CHAR16 **ControllerName
); );
// //
// EFI Component Name Protocol // EFI Component Name Protocol
// //
@ -73,36 +182,61 @@ EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName = {
WinNtGopComponentNameGetDriverName, WinNtGopComponentNameGetDriverName,
WinNtGopComponentNameGetControllerName, WinNtGopComponentNameGetControllerName,
"eng" "eng"
}; };
//
// EFI Component Name 2 Protocol
//
EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2 = {
(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) WinNtGopComponentNameGetDriverName,
(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) WinNtGopComponentNameGetControllerName,
"en"
};
static EFI_UNICODE_STRING_TABLE mWinNtGopDriverNameTable[] = { static EFI_UNICODE_STRING_TABLE mWinNtGopDriverNameTable[] = {
{ "eng", L"Windows GOP Driver" }, { "eng;en", L"Windows GOP Driver" },
{ NULL , NULL } { NULL , NULL }
}; };
/** /**
Retrieves a Unicode string that is the user readable name of the EFI Driver. Retrieves a Unicode string that is the user readable name of the driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL This function retrieves the user readable name of a driver in the form of a
instance. Unicode string. If the driver specified by This has a user readable name in
@param Language A pointer to a three character ISO 639-2 language the language specified by Language, then a pointer to the driver name is
identifier. This is the language of the driver returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
name that that the caller is requesting, and it by This does not support the language specified by Language,
must match one of the languages specified in then EFI_UNSUPPORTED is returned.
SupportedLanguages. The number of languages
supported by a driver is up to the driver writer. @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
@param DriverName A pointer to the Unicode string to return. This EFI_COMPONENT_NAME_PROTOCOL instance.
Unicode string is the name of the driver specified
by This in the language specified by Language. @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 @retval EFI_SUCCESS The Unicode string for the Driver specified by
This and the language specified by Language was This and the language specified by Language was
returned in DriverName. returned in DriverName.
@retval EFI_INVALID_PARAMETER Language is NULL. @retval EFI_INVALID_PARAMETER Language is NULL.
@retval EFI_INVALID_PARAMETER DriverName 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. @retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/ **/
EFI_STATUS EFI_STATUS
@ -113,58 +247,82 @@ WinNtGopComponentNameGetDriverName (
OUT CHAR16 **DriverName OUT CHAR16 **DriverName
) )
{ {
return LookupUnicodeString ( return LookupUnicodeString2 (
Language, Language,
gWinNtGopComponentName.SupportedLanguages, This->SupportedLanguages,
mWinNtGopDriverNameTable, mWinNtGopDriverNameTable,
DriverName DriverName,
(BOOLEAN)(This == &gWinNtGopComponentName)
); );
} }
/** /**
Retrieves a Unicode string that is the user readable name of the controller Retrieves a Unicode string that is the user readable name of the controller
that is being managed by an EFI Driver. that is being managed by a driver.
@param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL This function retrieves the user readable name of the controller specified by
instance. ControllerHandle and ChildHandle in the form of a Unicode string. If the
@param ControllerHandle The handle of a controller that the driver 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 specified by This is managing. This handle
specifies the controller whose name is to be specifies the controller whose name is to be
returned. returned.
@param ChildHandle The handle of the child controller to retrieve the
name of. This is an optional parameter that may @param ChildHandle[in] The handle of the child controller to retrieve
be NULL. It will be NULL for device drivers. It the name of. This is an optional parameter that
will also be NULL for a bus drivers that wish to may be NULL. It will be NULL for device
retrieve the name of the bus controller. It will drivers. It will also be NULL for a bus drivers
not be NULL for a bus driver that wishes to that wish to retrieve the name of the bus
retrieve the name of a child controller. controller. It will not be NULL for a bus
@param Language A pointer to a three character ISO 639-2 language driver that wishes to retrieve the name of a
identifier. This is the language of the child controller.
controller name that that the caller is
requesting, and it must match one of the languages @param Language[in] A pointer to a Null-terminated ASCII string
specified in SupportedLanguages. The number of array indicating the language. This is the
languages supported by a driver is up to the language of the driver name that the caller is
driver writer. requesting, and it must match one of the
@param ControllerName A pointer to the Unicode string to return. This languages specified in SupportedLanguages. The
Unicode string is the name of the controller number of languages supported by a driver is up
specified by ControllerHandle and ChildHandle in to the driver writer. Language is specified in
the language specified by Language from the point RFC 3066 or ISO 639-2 language code format.
of view of the driver specified by This.
@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 @retval EFI_SUCCESS The Unicode string for the user readable name in
the language specified by Language for the driver the language specified by Language for the
specified by This was returned in DriverName. 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 not a valid EFI_HANDLE.
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
EFI_HANDLE. 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 not currently @retval EFI_UNSUPPORTED The driver specified by This is not currently
managing the controller specified by managing the controller specified by
ControllerHandle and ChildHandle. ControllerHandle and ChildHandle.
@retval EFI_UNSUPPORTED The driver specified by This does not support the
language specified by Language. @retval EFI_UNSUPPORTED The driver specified by This does not support
the language specified by Language.
**/ **/
EFI_STATUS EFI_STATUS
@ -215,10 +373,11 @@ WinNtGopComponentNameGetControllerName (
Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput); Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput);
return LookupUnicodeString ( return LookupUnicodeString2 (
Language, Language,
gWinNtGopComponentName.SupportedLanguages, This->SupportedLanguages,
Private->ControllerNameTable, Private->ControllerNameTable,
ControllerName ControllerName,
(BOOLEAN)(This == &gWinNtGopComponentName)
); );
} }

View File

@ -123,6 +123,7 @@ typedef struct {
// //
extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding; extern EFI_DRIVER_BINDING_PROTOCOL gWinNtGopDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName; extern EFI_COMPONENT_NAME_PROTOCOL gWinNtGopComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL gWinNtGopComponentName2;
// //
// Gop Hardware abstraction internal worker functions // Gop Hardware abstraction internal worker functions

View File

@ -80,14 +80,13 @@ InitializeWinNtGop(
// //
// Install driver model protocol(s). // Install driver model protocol(s).
// //
Status = EfiLibInstallAllDriverProtocols ( Status = EfiLibInstallDriverBindingComponentName2 (
ImageHandle, ImageHandle,
SystemTable, SystemTable,
&gWinNtGopDriverBinding, &gWinNtGopDriverBinding,
ImageHandle, ImageHandle,
&gWinNtGopComponentName, &gWinNtGopComponentName,
NULL, &gWinNtGopComponentName2
NULL
); );
ASSERT_EFI_ERROR (Status); ASSERT_EFI_ERROR (Status);
@ -200,12 +199,21 @@ WinNtGopDriverBindingStart (
Private->ControllerNameTable = NULL; Private->ControllerNameTable = NULL;
AddUnicodeString ( AddUnicodeString2 (
"eng", "eng",
gWinNtGopComponentName.SupportedLanguages, gWinNtGopComponentName.SupportedLanguages,
&Private->ControllerNameTable, &Private->ControllerNameTable,
WinNtIo->EnvString WinNtIo->EnvString,
TRUE
); );
AddUnicodeString2 (
"en",
gWinNtGopComponentName2.SupportedLanguages,
&Private->ControllerNameTable,
WinNtIo->EnvString,
FALSE
);
Private->WindowName = WinNtIo->EnvString; Private->WindowName = WinNtIo->EnvString;