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

3 files changed, 252 insertions, 84 deletions

diff --git a/Nt32Pkg/WinNtGopDxe/ComponentName.c b/Nt32Pkg/WinNtGopDxe/ComponentName.c
index 952db00dc2..a8a1f95a89 100644
--- a/Nt32Pkg/WinNtGopDxe/ComponentName.c
+++ b/Nt32Pkg/WinNtGopDxe/ComponentName.c
@@ -48,6 +48,45 @@ Abstract:
 //

 // 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

 EFIAPI

 WinNtGopComponentNameGetDriverName (

@@ -56,6 +95,75 @@ WinNtGopComponentNameGetDriverName (
   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

 EFIAPI

 WinNtGopComponentNameGetControllerName (

@@ -66,43 +174,69 @@ WinNtGopComponentNameGetControllerName (
   OUT CHAR16                                          **ControllerName

   );

 

+

 //

 // EFI Component Name Protocol

 //

-EFI_COMPONENT_NAME_PROTOCOL     gWinNtGopComponentName = {

+EFI_COMPONENT_NAME_PROTOCOL  gWinNtGopComponentName = {

   WinNtGopComponentNameGetDriverName,

   WinNtGopComponentNameGetControllerName,

   "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[] = {

-  { "eng", L"Windows GOP Driver" },

+  { "eng;en", L"Windows GOP Driver" },

   { NULL , NULL }

 };

 

 

 /**

-  Retrieves a Unicode string that is the user readable name of the EFI Driver.

-

-  @param  This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL

-                                 instance.

-  @param  Language               A pointer to a three character ISO 639-2 language

-                                 identifier. This is the language of the driver

-                                 name that 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.

-  @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 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.

+  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

@@ -113,58 +247,82 @@ WinNtGopComponentNameGetDriverName (
   OUT CHAR16                       **DriverName

   )

 {

-  return LookupUnicodeString (

-          Language,

-          gWinNtGopComponentName.SupportedLanguages,

-          mWinNtGopDriverNameTable,

-          DriverName

-          );

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           mWinNtGopDriverNameTable,

+           DriverName,

+           (BOOLEAN)(This == &gWinNtGopComponentName)

+           );

 }

 

 

 /**

   Retrieves a Unicode string that is the user readable name of the controller

-  that is being managed by an EFI Driver.

-

-  @param  This                   A pointer to the EFI_COMPONENT_NAME_PROTOCOL

-                                 instance.

-  @param  ControllerHandle       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            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               A pointer to a three character ISO 639-2 language

-                                 identifier.  This is the language of the

-                                 controller name  that 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.

-  @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 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.

+  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

@@ -215,10 +373,11 @@ WinNtGopComponentNameGetControllerName (
 

   Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput);

 

-  return LookupUnicodeString (

-          Language,

-          gWinNtGopComponentName.SupportedLanguages,

-          Private->ControllerNameTable,

-          ControllerName

-          );

+  return LookupUnicodeString2 (

+           Language,

+           This->SupportedLanguages,

+           Private->ControllerNameTable,

+           ControllerName,

+           (BOOLEAN)(This == &gWinNtGopComponentName)

+           );

 }

diff --git a/Nt32Pkg/WinNtGopDxe/WinNtGop.h b/Nt32Pkg/WinNtGopDxe/WinNtGop.h
index e9cf80c33f..077e68105d 100644
--- a/Nt32Pkg/WinNtGopDxe/WinNtGop.h
+++ b/Nt32Pkg/WinNtGopDxe/WinNtGop.h
@@ -121,8 +121,9 @@ typedef struct {
 //

 // Global Protocol Variables

 //

-extern EFI_DRIVER_BINDING_PROTOCOL  gWinNtGopDriverBinding;

-extern EFI_COMPONENT_NAME_PROTOCOL  gWinNtGopComponentName;

+extern EFI_DRIVER_BINDING_PROTOCOL   gWinNtGopDriverBinding;

+extern EFI_COMPONENT_NAME_PROTOCOL   gWinNtGopComponentName;

+extern EFI_COMPONENT_NAME2_PROTOCOL  gWinNtGopComponentName2;

 

 //

 // Gop Hardware abstraction internal worker functions

diff --git a/Nt32Pkg/WinNtGopDxe/WinNtGopDriver.c b/Nt32Pkg/WinNtGopDxe/WinNtGopDriver.c
index 5f41e29e19..5f1f2c1cf0 100644
--- a/Nt32Pkg/WinNtGopDxe/WinNtGopDriver.c
+++ b/Nt32Pkg/WinNtGopDxe/WinNtGopDriver.c
@@ -80,14 +80,13 @@ InitializeWinNtGop(
   //

   // Install driver model protocol(s).

   //

-  Status = EfiLibInstallAllDriverProtocols (

+  Status = EfiLibInstallDriverBindingComponentName2 (

              ImageHandle,

              SystemTable,

              &gWinNtGopDriverBinding,

              ImageHandle,

              &gWinNtGopComponentName,

-             NULL,

-             NULL

+             &gWinNtGopComponentName2

              );

   ASSERT_EFI_ERROR (Status);

 

@@ -200,12 +199,21 @@ WinNtGopDriverBindingStart (
 

   Private->ControllerNameTable  = NULL;

 

-  AddUnicodeString (

+  AddUnicodeString2 (

     "eng",

     gWinNtGopComponentName.SupportedLanguages,

     &Private->ControllerNameTable,

-    WinNtIo->EnvString

+    WinNtIo->EnvString,

+    TRUE

     );

+  AddUnicodeString2 (

+    "en",

+    gWinNtGopComponentName2.SupportedLanguages,

+    &Private->ControllerNameTable,

+    WinNtIo->EnvString,

+    FALSE

+    );

+

 

   Private->WindowName = WinNtIo->EnvString;